intf.h 15.7 KB
Newer Older
1
/*****************************************************************************
2
 * intf.h: MacOS X interface module
3
 *****************************************************************************
4
 * Copyright (C) 2002-2009 the VideoLAN team
5
 * $Id$
6
7
8
 *
 * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
 *          Christophe Massiot <massiot@via.ecp.fr>
9
 *          Derk-Jan Hartman <hartman at videolan dot org>
10
 *          Felix Paul Kühne <fkuehne at videolan dot org>
11
12
13
14
15
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
16
 *
17
18
19
20
21
22
23
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
dionoea's avatar
dionoea committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25
26
 *****************************************************************************/

Rafaël Carré's avatar
Rafaël Carré committed
27
28
29
30
#ifdef HAVE_CONFIG_H
#   include "config.h"
#endif

31
#include <vlc_common.h>
zorglub's avatar
zorglub committed
32
#include <vlc_interface.h>
33
#include <vlc_playlist.h>
zorglub's avatar
zorglub committed
34
35
36
#include <vlc_vout.h>
#include <vlc_aout.h>
#include <vlc_input.h>
37
38
39

#include <Cocoa/Cocoa.h>

40
/*****************************************************************************
hartman's avatar
hartman committed
41
 * Local prototypes.
42
 *****************************************************************************/
hartman's avatar
hartman committed
43
unsigned int CocoaKeyToVLC( unichar i_key );
44

45
#define VLCIntf [[VLCMain sharedInstance] intf]
46

hartman's avatar
hartman committed
47
#define _NS(s) [[VLCMain sharedInstance] localizedString: _(s)]
hartman's avatar
ALL:    
hartman committed
48
49
50
/* Get an alternate version of the string.
 * This string is stored as '1:string' but when displayed it only displays
 * the translated string. the translation should be '1:translatedstring' though */
hartman's avatar
hartman committed
51
#define _ANS(s) [[[VLCMain sharedInstance] localizedString: _(s)] substringFromIndex:2]
52

53
54
55
56
#define MACOS_VERSION [[[NSDictionary dictionaryWithContentsOfFile: \
            @"/System/Library/CoreServices/SystemVersion.plist"] \
            objectForKey: @"ProductVersion"] floatValue]

57
58
59
60
61
62
63
64
/*****************************************************************************
 * intf_sys_t: description and status of the interface
 *****************************************************************************/
struct intf_sys_t
{
    NSAutoreleasePool * o_pool;

    /* special actions */
65
    bool b_mute;
hartman's avatar
hartman committed
66
    int i_play_status;
67

68
    /* interface update */
69
70
71
72
73
74
75
    bool b_intf_update;
    bool b_playlist_update;
    bool b_playmode_update;
    bool b_current_title_update;
    bool b_fullscreen_update;
    bool b_volume_update;
    bool b_intf_show;
76

77
    /* menus handlers */
78
79
80
    bool b_input_update;
    bool b_aout_update;
    bool b_vout_update;
81
82
83
84
85
86

    /* The messages window */
    msg_subscription_t * p_sub;
};

/*****************************************************************************
87
 * VLCMain interface
88
 *****************************************************************************/
89
@class AppleRemote;
90
@class VLCInformation;
91
@class VLCControllerWindow;
92
93
94
@class VLCEmbeddedWindow;
@class VLCControls;
@class VLCPlaylist;
95
96
@interface VLCMain : NSObject
{
hartman's avatar
hartman committed
97
    intf_thread_t *p_intf;      /* The main intf object */
98
    id o_prefs;                 /* VLCPrefs       */
99
    id o_sprefs;                /* VLCSimplePrefs */
100
101
    id o_about;                 /* VLAboutBox     */
    id o_open;                  /* VLCOpen        */
102
    id o_wizard;                /* VLCWizard      */
103
    id o_extended;              /* VLCExtended    */
104
    id o_bookmarks;             /* VLCBookmarks   */
105
    id o_vlm;                   /* VLCVLMController */
106
    id o_embedded_list;         /* VLCEmbeddedList*/
107
    id o_coredialogs;           /* VLCCoreDialogProvider */
108
    VLCInformation * o_info;                  /* VLCInformation */
109
#ifdef UPDATE_CHECK
110
    id o_update;                /* VLCUpdate      */
111
#endif
112
    id o_eyetv;                 /* VLCEyeTVController */
113
114
115
116
117
118
    BOOL nib_main_loaded;       /* main nibfile */
    BOOL nib_open_loaded;       /* open nibfile */
    BOOL nib_about_loaded;      /* about nibfile */
    BOOL nib_wizard_loaded;     /* wizard nibfile */
    BOOL nib_extended_loaded;   /* extended nibfile */
    BOOL nib_bookmarks_loaded;  /* bookmarks nibfile */
119
    BOOL nib_prefs_loaded;      /* preferences nibfile */
120
    BOOL nib_update_loaded;     /* update nibfile */
121
    BOOL nib_info_loaded;       /* information panel nibfile */
122
    BOOL nib_vlm_loaded;        /* VLM Panel nibfile */
123
    BOOL nib_coredialogs_loaded; /* CoreDialogs nibfile */
124

125
    IBOutlet VLCControllerWindow * o_window;                     /* main window */
126
127
128
129
130
131
132
133
134
    IBOutlet NSView * o_playlist_view;                          /* playlist view  */
    IBOutlet id o_scrollfield;                                  /* info field */
    IBOutlet NSTextField * o_timefield;                         /* time field */
    IBOutlet NSSlider * o_timeslider;                           /* time slider */
    BOOL b_time_remaining;                                      /* show remaining time or playtime ? */
    IBOutlet VLCEmbeddedWindow * o_embedded_window;             /* Embedded Vout Window */
    float f_slider;                                             /* slider value */
    float f_slider_old;                                         /* old slider val */
    IBOutlet NSSlider * o_volumeslider;                         /* volume slider */
135
136
137
138
139
140
141
142
143
144
145
146
147

    IBOutlet NSView * toolbarMediaControl;   /* view with the controls */

    IBOutlet NSProgressIndicator * o_main_pgbar;   /* playlist window progress bar */
    IBOutlet NSButton * o_btn_prev;     /* btn previous   */
    IBOutlet NSButton * o_btn_rewind;   /* btn rewind     */
    IBOutlet NSButton * o_btn_play;     /* btn play       */
    IBOutlet NSButton * o_btn_stop;     /* btn stop       */
    IBOutlet NSButton * o_btn_ff;       /* btn fast forward     */
    IBOutlet NSButton * o_btn_next;     /* btn next       */
    IBOutlet NSButton * o_btn_fullscreen;/* btn fullscreen (embedded vout window) */
    IBOutlet NSButton * o_btn_playlist; /* btn playlist   */
    IBOutlet NSButton * o_btn_equalizer; /* eq btn */
148

149
150
    NSImage * o_img_play;       /* btn play img   */
    NSImage * o_img_pause;      /* btn pause img  */
hartman's avatar
hartman committed
151
152
    NSImage * o_img_play_pressed;       /* btn play img   */
    NSImage * o_img_pause_pressed;      /* btn pause img  */
153

154
155
    IBOutlet VLCControls * o_controls;     /* VLCControls    */
    IBOutlet VLCPlaylist * o_playlist;     /* VLCPlaylist    */
156

157
158
159
160
161
    IBOutlet NSTextView * o_messages;           /* messages tv    */
    IBOutlet NSWindow * o_msgs_panel;           /* messages panel */
    NSMutableArray * o_msg_arr;                 /* messages array */
    NSLock * o_msg_lock;                        /* messages lock */
    BOOL b_msg_arr_changed;                     /* did the array change? */
162
163
    IBOutlet NSButton * o_msgs_crashlog_btn;    /* messages open crashlog */
    IBOutlet NSButton * o_msgs_save_btn;        /* save the log as rtf */
164
165
166
167
168
169
170
171
    
    /* CrashReporter panel */
    IBOutlet NSButton * o_crashrep_dontSend_btn;
    IBOutlet NSButton * o_crashrep_send_btn;
    IBOutlet NSTextView * o_crashrep_fld;
    IBOutlet NSTextField * o_crashrep_title_txt;
    IBOutlet NSTextField * o_crashrep_desc_txt;
    IBOutlet NSWindow * o_crashrep_win;
172
173
    IBOutlet NSButton * o_crashrep_includeEmail_ckb;
    IBOutlet NSTextField * o_crashrep_includeEmail_txt;
174
175
176

    /* main menu */

177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
    IBOutlet NSMenuItem * o_mi_about;
    IBOutlet NSMenuItem * o_mi_prefs;
    IBOutlet NSMenuItem * o_mi_sprefs;
    IBOutlet NSMenuItem * o_mi_checkForUpdate;
    IBOutlet NSMenuItem * o_mi_add_intf;
    IBOutlet NSMenu * o_mu_add_intf;
    IBOutlet NSMenuItem * o_mi_services;
    IBOutlet NSMenuItem * o_mi_hide;
    IBOutlet NSMenuItem * o_mi_hide_others;
    IBOutlet NSMenuItem * o_mi_show_all;
    IBOutlet NSMenuItem * o_mi_quit;

    IBOutlet NSMenu * o_mu_file;
    IBOutlet NSMenuItem * o_mi_open_file;
    IBOutlet NSMenuItem * o_mi_open_generic;
    IBOutlet NSMenuItem * o_mi_open_disc;
    IBOutlet NSMenuItem * o_mi_open_net;
    IBOutlet NSMenuItem * o_mi_open_capture;
    IBOutlet NSMenuItem * o_mi_open_recent;
    IBOutlet NSMenuItem * o_mi_open_recent_cm;
    IBOutlet NSMenuItem * o_mi_open_wizard;
198
    IBOutlet NSMenuItem * o_mi_open_vlm;
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

    IBOutlet NSMenu * o_mu_edit;
    IBOutlet NSMenuItem * o_mi_cut;
    IBOutlet NSMenuItem * o_mi_copy;
    IBOutlet NSMenuItem * o_mi_paste;
    IBOutlet NSMenuItem * o_mi_clear;
    IBOutlet NSMenuItem * o_mi_select_all;

    IBOutlet NSMenu * o_mu_controls;
    IBOutlet NSMenuItem * o_mi_play;
    IBOutlet NSMenuItem * o_mi_stop;
    IBOutlet NSMenuItem * o_mi_faster;
    IBOutlet NSMenuItem * o_mi_slower;
    IBOutlet NSMenuItem * o_mi_previous;
    IBOutlet NSMenuItem * o_mi_next;
    IBOutlet NSMenuItem * o_mi_random;
    IBOutlet NSMenuItem * o_mi_repeat;
    IBOutlet NSMenuItem * o_mi_loop;
    IBOutlet NSMenuItem * o_mi_fwd;
    IBOutlet NSMenuItem * o_mi_bwd;
    IBOutlet NSMenuItem * o_mi_fwd1m;
    IBOutlet NSMenuItem * o_mi_bwd1m;
    IBOutlet NSMenuItem * o_mi_fwd5m;
    IBOutlet NSMenuItem * o_mi_bwd5m;
    IBOutlet NSMenuItem * o_mi_program;
224
    IBOutlet NSMenu * o_mu_program;
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
    IBOutlet NSMenuItem * o_mi_title;
    IBOutlet NSMenu * o_mu_title;
    IBOutlet NSMenuItem * o_mi_chapter;
    IBOutlet NSMenu * o_mu_chapter;

    IBOutlet NSMenu * o_mu_audio;
    IBOutlet NSMenuItem * o_mi_vol_up;
    IBOutlet NSMenuItem * o_mi_vol_down;
    IBOutlet NSMenuItem * o_mi_mute;
    IBOutlet NSMenuItem * o_mi_audiotrack;
    IBOutlet NSMenu * o_mu_audiotrack;
    IBOutlet NSMenuItem * o_mi_channels;
    IBOutlet NSMenu * o_mu_channels;
    IBOutlet NSMenuItem * o_mi_device;
    IBOutlet NSMenu * o_mu_device;
    IBOutlet NSMenuItem * o_mi_visual;
    IBOutlet NSMenu * o_mu_visual;

    IBOutlet NSMenu * o_mu_video;
    IBOutlet NSMenuItem * o_mi_half_window;
    IBOutlet NSMenuItem * o_mi_normal_window;
    IBOutlet NSMenuItem * o_mi_double_window;
    IBOutlet NSMenuItem * o_mi_fittoscreen;
    IBOutlet NSMenuItem * o_mi_fullscreen;
    IBOutlet NSMenuItem * o_mi_floatontop;
    IBOutlet NSMenuItem * o_mi_snapshot;
    IBOutlet NSMenuItem * o_mi_videotrack;
    IBOutlet NSMenu * o_mu_videotrack;
    IBOutlet NSMenuItem * o_mi_screen;
    IBOutlet NSMenu * o_mu_screen;
    IBOutlet NSMenuItem * o_mi_aspect_ratio;
    IBOutlet NSMenu * o_mu_aspect_ratio;
    IBOutlet NSMenuItem * o_mi_crop;
    IBOutlet NSMenu * o_mu_crop;
    IBOutlet NSMenuItem * o_mi_subtitle;
    IBOutlet NSMenu * o_mu_subtitle;
261
    IBOutlet NSMenuItem * o_mi_addSub;
262
263
264
    IBOutlet NSMenuItem * o_mi_deinterlace;
    IBOutlet NSMenu * o_mu_deinterlace;
    IBOutlet NSMenuItem * o_mi_ffmpeg_pp;
265
    IBOutlet NSMenu * o_mu_ffmpeg_pp;
hartman's avatar
hartman committed
266
267
268
269
270
271
272
    IBOutlet NSMenuItem * o_mi_teletext;
    IBOutlet NSMenuItem * o_mi_teletext_transparent;
    IBOutlet NSMenuItem * o_mi_teletext_index;
    IBOutlet NSMenuItem * o_mi_teletext_red;
    IBOutlet NSMenuItem * o_mi_teletext_green;
    IBOutlet NSMenuItem * o_mi_teletext_yellow;
    IBOutlet NSMenuItem * o_mi_teletext_blue;
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294

    IBOutlet NSMenu * o_mu_window;
    IBOutlet NSMenuItem * o_mi_minimize;
    IBOutlet NSMenuItem * o_mi_close_window;
    IBOutlet NSMenuItem * o_mi_controller;
    IBOutlet NSMenuItem * o_mi_equalizer;
    IBOutlet NSMenuItem * o_mi_extended;
    IBOutlet NSMenuItem * o_mi_bookmarks;
    IBOutlet NSMenuItem * o_mi_playlist;
    IBOutlet NSMenuItem * o_mi_info;
    IBOutlet NSMenuItem * o_mi_messages;
    IBOutlet NSMenuItem * o_mi_bring_atf;

    IBOutlet NSMenu * o_mu_help;
    IBOutlet NSMenuItem * o_mi_help;
    IBOutlet NSMenuItem * o_mi_readme;
    IBOutlet NSMenuItem * o_mi_documentation;
    IBOutlet NSMenuItem * o_mi_license;
    IBOutlet NSMenuItem * o_mi_website;
    IBOutlet NSMenuItem * o_mi_donation;
    IBOutlet NSMenuItem * o_mi_forum;
    IBOutlet NSMenuItem * o_mi_errorsAndWarnings;
295
296

    /* dock menu */
297
298
299
300
301
    IBOutlet NSMenuItem * o_dmi_play;
    IBOutlet NSMenuItem * o_dmi_stop;
    IBOutlet NSMenuItem * o_dmi_next;
    IBOutlet NSMenuItem * o_dmi_previous;
    IBOutlet NSMenuItem * o_dmi_mute;
302

303
    /* vout menu */
304
305
306
307
308
309
310
311
312
313
    IBOutlet NSMenu * o_vout_menu;
    IBOutlet NSMenuItem * o_vmi_play;
    IBOutlet NSMenuItem * o_vmi_stop;
    IBOutlet NSMenuItem * o_vmi_prev;
    IBOutlet NSMenuItem * o_vmi_next;
    IBOutlet NSMenuItem * o_vmi_volup;
    IBOutlet NSMenuItem * o_vmi_voldown;
    IBOutlet NSMenuItem * o_vmi_mute;
    IBOutlet NSMenuItem * o_vmi_fullscreen;
    IBOutlet NSMenuItem * o_vmi_snapshot;
314

315
    bool b_small_window;
316

317
318
319
    bool b_restore_size;
    NSRect o_restore_rect;

320
    mtime_t i_end_scroll;
321
322
323

    NSSize o_size_with_playlist;

324
    int     i_lastShownVolume;
325

326
327
    input_state_e cachedInputState;

328
329
330
    /* the manage thread */
    pthread_t manage_thread;

331
332
333
    /* The timer that update the interface */
    NSTimer * interfaceTimer;

334
335
    NSURLConnection * crashLogURLConnection;

336
    AppleRemote * o_remote;
337
    BOOL b_remote_button_hold; /* true as long as the user holds the left,right,plus or minus on the remote control */
338
339
}

hartman's avatar
hartman committed
340
341
+ (VLCMain *)sharedInstance;

342
- (intf_thread_t *)intf;
hartman's avatar
hartman committed
343
344
- (void)setIntf:(intf_thread_t *)p_mainintf;

345
346
- (void)controlTintChanged;

347
348
349
350
- (id)controls;
- (id)simplePreferences;
- (id)preferences;
- (id)playlist;
351
- (BOOL)isPlaylistCollapsed;
352
353
354
355
356
357
358
359
360
- (id)info;
- (id)wizard;
- (id)bookmarks;
- (id)embeddedList;
- (id)coreDialogProvider;
- (id)mainIntfPgbar;
- (id)controllerWindow;
- (id)voutMenu;
- (id)eyeTVController;
361
- (void)applicationWillTerminate:(NSNotification *)notification;
362
- (NSString *)localizedString:(const char *)psz;
hartman's avatar
hartman committed
363
364
365
- (char *)delocalizeString:(NSString *)psz;
- (NSString *)wrapString: (NSString *)o_in_string toWidth: (int)i_width;
- (BOOL)hasDefinedShortcutKey:(NSEvent *)o_event;
366

367
368
- (void)initStrings;

369
- (void)manage;
370
- (void)manageIntf:(NSTimer *)o_timer;
hartman's avatar
* ALL:    
hartman committed
371
- (void)setupMenus;
372
- (void)refreshVoutDeviceMenu:(NSNotification *)o_notification;
373
374
- (void)setScrollField:(NSString *)o_string stopAfter:(int )timeout;
- (void)resetScrollField;
375

376
- (void)updateMessageDisplay;
hartman's avatar
hartman committed
377
- (void)playStatusUpdated:(int) i_status;
hartman's avatar
* ALL:    
hartman committed
378
- (void)setSubmenusEnabled:(BOOL)b_enabled;
379
- (void)manageVolumeSlider;
hartman's avatar
* ALL:    
hartman committed
380
- (IBAction)timesliderUpdate:(id)sender;
381
- (IBAction)timeFieldWasClicked:(id)sender;
382
383
384
385

- (IBAction)clearRecentItems:(id)sender;
- (void)openRecentItem:(id)sender;

386
387
388
389
- (IBAction)intfOpenFile:(id)sender;
- (IBAction)intfOpenFileGeneric:(id)sender;
- (IBAction)intfOpenDisc:(id)sender;
- (IBAction)intfOpenNet:(id)sender;
390
- (IBAction)intfOpenCapture:(id)sender;
391

392
- (IBAction)showWizard:(id)sender;
393
- (IBAction)showVLM:(id)sender;
394
- (IBAction)showExtended:(id)sender;
395
- (IBAction)showBookmarks:(id)sender;
396

397
- (IBAction)viewAbout:(id)sender;
398
- (IBAction)showLicense:(id)sender;
399
- (IBAction)viewPreferences:(id)sender;
400
- (IBAction)checkForUpdate:(id)sender;
401
- (IBAction)viewHelp:(id)sender;
402
- (IBAction)openReadMe:(id)sender;
hartman's avatar
hartman committed
403
- (IBAction)openDocumentation:(id)sender;
404
- (IBAction)openWebsite:(id)sender;
hartman's avatar
hartman committed
405
406
- (IBAction)openForum:(id)sender;
- (IBAction)openDonate:(id)sender;
407
- (IBAction)openCrashLog:(id)sender;
408
409
- (IBAction)viewErrorsAndWarnings:(id)sender;
- (IBAction)showMessagesPanel:(id)sender;
410
- (IBAction)showInformationPanel:(id)sender;
411

412
- (IBAction)crashReporterAction:(id)sender;
413
- (IBAction)saveDebugLog:(id)sender;
414

415
416
417
- (IBAction)togglePlaylist:(id)sender;
- (void)updateTogglePlaylistState;

418
419
- (void)windowDidBecomeKey:(NSNotification *)o_notification;

420
421
422
423
424
@end

@interface VLCMain (Internal)
- (void)handlePortMessage:(NSPortMessage *)o_msg;
@end
425
426
427
428
429
430
431
432
433
434
435
436
437
438

/*****************************************************************************
 * VLCApplication interface
 *****************************************************************************/

@interface VLCApplication : NSApplication
{
    BOOL b_justJumped;
}

- (void)sendEvent: (NSEvent*)event;
- (void)resetJump;

@end