macosx: implemented on-the-fly activation of the Media Key support
[vlc.git] / modules / gui / macosx / intf.h
1 /*****************************************************************************
2  * intf.h: MacOS X interface module
3  *****************************************************************************
4  * Copyright (C) 2002-2009 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
8  *          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  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 #   include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <vlc_interface.h>
33 #include <vlc_playlist.h>
34 #include <vlc_vout.h>
35 #include <vlc_aout.h>
36 #include <vlc_input.h>
37
38 #include <Cocoa/Cocoa.h>
39
40 /*****************************************************************************
41  * Local prototypes.
42  *****************************************************************************/
43 unsigned int CocoaKeyToVLC( unichar i_key );
44
45 #define VLCIntf [[VLCMain sharedInstance] intf]
46
47 #define _NS(s) [[VLCMain sharedInstance] localizedString: _(s)]
48 /* Get an alternate version of the string.
49  * This string is stored as '1:string' but when displayed it only displays
50  * the translated string. the translation should be '1:translatedstring' though */
51 #define _ANS(s) [[[VLCMain sharedInstance] localizedString: _(s)] substringFromIndex:2]
52
53 #define MACOS_VERSION [[[NSDictionary dictionaryWithContentsOfFile: \
54             @"/System/Library/CoreServices/SystemVersion.plist"] \
55             objectForKey: @"ProductVersion"] floatValue]
56
57 /*****************************************************************************
58  * intf_sys_t: description and status of the interface
59  *****************************************************************************/
60 struct intf_sys_t
61 {
62     /* special actions */
63     bool b_mute;
64     int i_play_status;
65
66     /* interface update */
67     bool b_intf_update;
68     bool b_playlist_update;
69     bool b_playmode_update;
70     bool b_current_title_update;
71     bool b_fullscreen_update;
72     bool b_volume_update;
73     bool b_intf_show;
74
75     /* menus handlers */
76     bool b_input_update;
77     bool b_aout_update;
78     bool b_vout_update;
79
80     /* The messages window */
81     msg_subscription_t * p_sub;
82 };
83
84 /*****************************************************************************
85  * VLCMain interface
86  *****************************************************************************/
87 @class AppleRemote;
88 @class VLCInformation;
89 @class VLCControllerWindow;
90 @class VLCEmbeddedWindow;
91 @class VLCControls;
92 @class VLCPlaylist;
93 @interface VLCMain : NSObject
94 {
95     intf_thread_t *p_intf;      /* The main intf object */
96     id o_prefs;                 /* VLCPrefs       */
97     id o_sprefs;                /* VLCSimplePrefs */
98     id o_about;                 /* VLAboutBox     */
99     id o_open;                  /* VLCOpen        */
100     id o_wizard;                /* VLCWizard      */
101     id o_extended;              /* VLCExtended    */
102     id o_bookmarks;             /* VLCBookmarks   */
103     id o_vlm;                   /* VLCVLMController */
104     id o_embedded_list;         /* VLCEmbeddedList*/
105     id o_coredialogs;           /* VLCCoreDialogProvider */
106     VLCInformation * o_info;                  /* VLCInformation */
107 #ifdef UPDATE_CHECK
108     id o_update;                /* VLCUpdate      */
109 #endif
110     id o_eyetv;                 /* VLCEyeTVController */
111     BOOL nib_main_loaded;       /* main nibfile */
112     BOOL nib_open_loaded;       /* open nibfile */
113     BOOL nib_about_loaded;      /* about nibfile */
114     BOOL nib_wizard_loaded;     /* wizard nibfile */
115     BOOL nib_extended_loaded;   /* extended nibfile */
116     BOOL nib_bookmarks_loaded;  /* bookmarks nibfile */
117     BOOL nib_prefs_loaded;      /* preferences nibfile */
118     BOOL nib_update_loaded;     /* update nibfile */
119     BOOL nib_info_loaded;       /* information panel nibfile */
120     BOOL nib_vlm_loaded;        /* VLM Panel nibfile */
121     BOOL nib_coredialogs_loaded; /* CoreDialogs nibfile */
122
123     IBOutlet VLCControllerWindow * o_window;                     /* main window */
124     IBOutlet NSView * o_playlist_view;                          /* playlist view  */
125     IBOutlet id o_scrollfield;                                  /* info field */
126     IBOutlet NSTextField * o_timefield;                         /* time field */
127     IBOutlet NSSlider * o_timeslider;                           /* time slider */
128     BOOL b_time_remaining;                                      /* show remaining time or playtime ? */
129     IBOutlet VLCEmbeddedWindow * o_embedded_window;             /* Embedded Vout Window */
130     float f_slider;                                             /* slider value */
131     float f_slider_old;                                         /* old slider val */
132     IBOutlet NSSlider * o_volumeslider;                         /* volume slider */
133
134     IBOutlet NSView * toolbarMediaControl;   /* view with the controls */
135
136     IBOutlet NSProgressIndicator * o_main_pgbar;   /* playlist window progress bar */
137     IBOutlet NSButton * o_btn_prev;     /* btn previous   */
138     IBOutlet NSButton * o_btn_rewind;   /* btn rewind     */
139     IBOutlet NSButton * o_btn_play;     /* btn play       */
140     IBOutlet NSButton * o_btn_stop;     /* btn stop       */
141     IBOutlet NSButton * o_btn_ff;       /* btn fast forward     */
142     IBOutlet NSButton * o_btn_next;     /* btn next       */
143     IBOutlet NSButton * o_btn_fullscreen;/* btn fullscreen (embedded vout window) */
144     IBOutlet NSButton * o_btn_playlist; /* btn playlist   */
145     IBOutlet NSButton * o_btn_equalizer; /* eq btn */
146
147     NSImage * o_img_play;       /* btn play img   */
148     NSImage * o_img_pause;      /* btn pause img  */
149     NSImage * o_img_play_pressed;       /* btn play img   */
150     NSImage * o_img_pause_pressed;      /* btn pause img  */
151
152     IBOutlet VLCControls * o_controls;     /* VLCControls    */
153     IBOutlet VLCPlaylist * o_playlist;     /* VLCPlaylist    */
154
155     IBOutlet NSTextView * o_messages;           /* messages tv    */
156     IBOutlet NSWindow * o_msgs_panel;           /* messages panel */
157     NSMutableArray * o_msg_arr;                 /* messages array */
158     NSLock * o_msg_lock;                        /* messages lock */
159     BOOL b_msg_arr_changed;                     /* did the array change? */
160     IBOutlet NSButton * o_msgs_crashlog_btn;    /* messages open crashlog */
161     IBOutlet NSButton * o_msgs_save_btn;        /* save the log as rtf */
162     
163     /* CrashReporter panel */
164     IBOutlet NSButton * o_crashrep_dontSend_btn;
165     IBOutlet NSButton * o_crashrep_send_btn;
166     IBOutlet NSTextView * o_crashrep_fld;
167     IBOutlet NSTextField * o_crashrep_title_txt;
168     IBOutlet NSTextField * o_crashrep_desc_txt;
169     IBOutlet NSWindow * o_crashrep_win;
170     IBOutlet NSButton * o_crashrep_includeEmail_ckb;
171     IBOutlet NSTextField * o_crashrep_includeEmail_txt;
172
173     /* main menu */
174
175     IBOutlet NSMenuItem * o_mi_about;
176     IBOutlet NSMenuItem * o_mi_prefs;
177     IBOutlet NSMenuItem * o_mi_sprefs;
178     IBOutlet NSMenuItem * o_mi_checkForUpdate;
179     IBOutlet NSMenuItem * o_mi_add_intf;
180     IBOutlet NSMenu * o_mu_add_intf;
181     IBOutlet NSMenuItem * o_mi_services;
182     IBOutlet NSMenuItem * o_mi_hide;
183     IBOutlet NSMenuItem * o_mi_hide_others;
184     IBOutlet NSMenuItem * o_mi_show_all;
185     IBOutlet NSMenuItem * o_mi_quit;
186
187     IBOutlet NSMenu * o_mu_file;
188     IBOutlet NSMenuItem * o_mi_open_file;
189     IBOutlet NSMenuItem * o_mi_open_generic;
190     IBOutlet NSMenuItem * o_mi_open_disc;
191     IBOutlet NSMenuItem * o_mi_open_net;
192     IBOutlet NSMenuItem * o_mi_open_capture;
193     IBOutlet NSMenuItem * o_mi_open_recent;
194     IBOutlet NSMenuItem * o_mi_open_recent_cm;
195     IBOutlet NSMenuItem * o_mi_open_wizard;
196     IBOutlet NSMenuItem * o_mi_open_vlm;
197
198     IBOutlet NSMenu * o_mu_edit;
199     IBOutlet NSMenuItem * o_mi_cut;
200     IBOutlet NSMenuItem * o_mi_copy;
201     IBOutlet NSMenuItem * o_mi_paste;
202     IBOutlet NSMenuItem * o_mi_clear;
203     IBOutlet NSMenuItem * o_mi_select_all;
204
205     IBOutlet NSMenu * o_mu_controls;
206     IBOutlet NSMenuItem * o_mi_play;
207     IBOutlet NSMenuItem * o_mi_stop;
208     IBOutlet NSMenuItem * o_mi_faster;
209     IBOutlet NSMenuItem * o_mi_slower;
210     IBOutlet NSMenuItem * o_mi_previous;
211     IBOutlet NSMenuItem * o_mi_next;
212     IBOutlet NSMenuItem * o_mi_random;
213     IBOutlet NSMenuItem * o_mi_repeat;
214     IBOutlet NSMenuItem * o_mi_loop;
215     IBOutlet NSMenuItem * o_mi_fwd;
216     IBOutlet NSMenuItem * o_mi_bwd;
217     IBOutlet NSMenuItem * o_mi_fwd1m;
218     IBOutlet NSMenuItem * o_mi_bwd1m;
219     IBOutlet NSMenuItem * o_mi_fwd5m;
220     IBOutlet NSMenuItem * o_mi_bwd5m;
221     IBOutlet NSMenuItem * o_mi_program;
222     IBOutlet NSMenu * o_mu_program;
223     IBOutlet NSMenuItem * o_mi_title;
224     IBOutlet NSMenu * o_mu_title;
225     IBOutlet NSMenuItem * o_mi_chapter;
226     IBOutlet NSMenu * o_mu_chapter;
227
228     IBOutlet NSMenu * o_mu_audio;
229     IBOutlet NSMenuItem * o_mi_vol_up;
230     IBOutlet NSMenuItem * o_mi_vol_down;
231     IBOutlet NSMenuItem * o_mi_mute;
232     IBOutlet NSMenuItem * o_mi_audiotrack;
233     IBOutlet NSMenu * o_mu_audiotrack;
234     IBOutlet NSMenuItem * o_mi_channels;
235     IBOutlet NSMenu * o_mu_channels;
236     IBOutlet NSMenuItem * o_mi_device;
237     IBOutlet NSMenu * o_mu_device;
238     IBOutlet NSMenuItem * o_mi_visual;
239     IBOutlet NSMenu * o_mu_visual;
240
241     IBOutlet NSMenu * o_mu_video;
242     IBOutlet NSMenuItem * o_mi_half_window;
243     IBOutlet NSMenuItem * o_mi_normal_window;
244     IBOutlet NSMenuItem * o_mi_double_window;
245     IBOutlet NSMenuItem * o_mi_fittoscreen;
246     IBOutlet NSMenuItem * o_mi_fullscreen;
247     IBOutlet NSMenuItem * o_mi_floatontop;
248     IBOutlet NSMenuItem * o_mi_snapshot;
249     IBOutlet NSMenuItem * o_mi_videotrack;
250     IBOutlet NSMenu * o_mu_videotrack;
251     IBOutlet NSMenuItem * o_mi_screen;
252     IBOutlet NSMenu * o_mu_screen;
253     IBOutlet NSMenuItem * o_mi_aspect_ratio;
254     IBOutlet NSMenu * o_mu_aspect_ratio;
255     IBOutlet NSMenuItem * o_mi_crop;
256     IBOutlet NSMenu * o_mu_crop;
257     IBOutlet NSMenuItem * o_mi_subtitle;
258     IBOutlet NSMenu * o_mu_subtitle;
259     IBOutlet NSMenuItem * o_mi_addSub;
260     IBOutlet NSMenuItem * o_mi_deinterlace;
261     IBOutlet NSMenu * o_mu_deinterlace;
262     IBOutlet NSMenuItem * o_mi_ffmpeg_pp;
263     IBOutlet NSMenu * o_mu_ffmpeg_pp;
264     IBOutlet NSMenuItem * o_mi_teletext;
265     IBOutlet NSMenuItem * o_mi_teletext_transparent;
266     IBOutlet NSMenuItem * o_mi_teletext_index;
267     IBOutlet NSMenuItem * o_mi_teletext_red;
268     IBOutlet NSMenuItem * o_mi_teletext_green;
269     IBOutlet NSMenuItem * o_mi_teletext_yellow;
270     IBOutlet NSMenuItem * o_mi_teletext_blue;
271
272     IBOutlet NSMenu * o_mu_window;
273     IBOutlet NSMenuItem * o_mi_minimize;
274     IBOutlet NSMenuItem * o_mi_close_window;
275     IBOutlet NSMenuItem * o_mi_player;
276     IBOutlet NSMenuItem * o_mi_controller;
277     IBOutlet NSMenuItem * o_mi_equalizer;
278     IBOutlet NSMenuItem * o_mi_extended;
279     IBOutlet NSMenuItem * o_mi_bookmarks;
280     IBOutlet NSMenuItem * o_mi_playlist;
281     IBOutlet NSMenuItem * o_mi_info;
282     IBOutlet NSMenuItem * o_mi_messages;
283     IBOutlet NSMenuItem * o_mi_bring_atf;
284
285     IBOutlet NSMenu * o_mu_help;
286     IBOutlet NSMenuItem * o_mi_help;
287     IBOutlet NSMenuItem * o_mi_readme;
288     IBOutlet NSMenuItem * o_mi_documentation;
289     IBOutlet NSMenuItem * o_mi_license;
290     IBOutlet NSMenuItem * o_mi_website;
291     IBOutlet NSMenuItem * o_mi_donation;
292     IBOutlet NSMenuItem * o_mi_forum;
293     IBOutlet NSMenuItem * o_mi_errorsAndWarnings;
294
295     /* dock menu */
296     IBOutlet NSMenuItem * o_dmi_play;
297     IBOutlet NSMenuItem * o_dmi_stop;
298     IBOutlet NSMenuItem * o_dmi_next;
299     IBOutlet NSMenuItem * o_dmi_previous;
300     IBOutlet NSMenuItem * o_dmi_mute;
301
302     /* vout menu */
303     IBOutlet NSMenu * o_vout_menu;
304     IBOutlet NSMenuItem * o_vmi_play;
305     IBOutlet NSMenuItem * o_vmi_stop;
306     IBOutlet NSMenuItem * o_vmi_prev;
307     IBOutlet NSMenuItem * o_vmi_next;
308     IBOutlet NSMenuItem * o_vmi_volup;
309     IBOutlet NSMenuItem * o_vmi_voldown;
310     IBOutlet NSMenuItem * o_vmi_mute;
311     IBOutlet NSMenuItem * o_vmi_fullscreen;
312     IBOutlet NSMenuItem * o_vmi_snapshot;
313
314     bool b_small_window;
315
316     bool b_restore_size;
317     NSRect o_restore_rect;
318
319     mtime_t i_end_scroll;
320
321     NSSize o_size_with_playlist;
322
323     int     i_lastShownVolume;
324
325     input_state_e cachedInputState;
326
327     /* the manage thread */
328     pthread_t manage_thread;
329
330     /* The timer that update the interface */
331     NSTimer * interfaceTimer;
332
333     NSURLConnection * crashLogURLConnection;
334
335     AppleRemote * o_remote;
336     BOOL b_remote_button_hold; /* true as long as the user holds the left,right,plus or minus on the remote control */
337 }
338
339 + (VLCMain *)sharedInstance;
340
341 - (intf_thread_t *)intf;
342 - (void)setIntf:(intf_thread_t *)p_mainintf;
343
344 - (void)controlTintChanged;
345
346 - (id)controls;
347 - (id)simplePreferences;
348 - (id)preferences;
349 - (id)playlist;
350 - (BOOL)isPlaylistCollapsed;
351 - (id)info;
352 - (id)wizard;
353 - (id)bookmarks;
354 - (id)embeddedList;
355 - (id)coreDialogProvider;
356 - (id)mainIntfPgbar;
357 - (id)controllerWindow;
358 - (id)voutMenu;
359 - (id)eyeTVController;
360 - (id)appleRemoteController;
361 - (void)applicationWillTerminate:(NSNotification *)notification;
362 - (NSString *)localizedString:(const char *)psz;
363 - (char *)delocalizeString:(NSString *)psz;
364 - (NSString *)wrapString: (NSString *)o_in_string toWidth: (int)i_width;
365 - (BOOL)hasDefinedShortcutKey:(NSEvent *)o_event;
366
367 - (void)initStrings;
368
369 - (void)manage;
370 - (void)manageIntf:(NSTimer *)o_timer;
371 - (void)setupMenus;
372 - (void)refreshVoutDeviceMenu:(NSNotification *)o_notification;
373 - (void)setScrollField:(NSString *)o_string stopAfter:(int )timeout;
374 - (void)resetScrollField;
375
376 - (void)updateMessageDisplay;
377 - (void)playStatusUpdated:(int) i_status;
378 - (void)setSubmenusEnabled:(BOOL)b_enabled;
379 - (void)manageVolumeSlider;
380 - (IBAction)timesliderUpdate:(id)sender;
381 - (IBAction)timeFieldWasClicked:(id)sender;
382
383 - (IBAction)clearRecentItems:(id)sender;
384 - (void)openRecentItem:(id)sender;
385
386 - (IBAction)intfOpenFile:(id)sender;
387 - (IBAction)intfOpenFileGeneric:(id)sender;
388 - (IBAction)intfOpenDisc:(id)sender;
389 - (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;
403 - (IBAction)openDocumentation:(id)sender;
404 - (IBAction)openWebsite:(id)sender;
405 - (IBAction)openForum:(id)sender;
406 - (IBAction)openDonate:(id)sender;
407 - (IBAction)openCrashLog:(id)sender;
408 - (IBAction)viewErrorsAndWarnings:(id)sender;
409 - (IBAction)showMessagesPanel:(id)sender;
410 - (IBAction)showInformationPanel:(id)sender;
411
412 - (IBAction)crashReporterAction:(id)sender;
413 - (IBAction)saveDebugLog:(id)sender;
414
415 - (IBAction)togglePlaylist:(id)sender;
416 - (void)updateTogglePlaylistState;
417
418 - (void)windowDidBecomeKey:(NSNotification *)o_notification;
419
420 @end
421
422 @interface VLCMain (Internal)
423 - (void)handlePortMessage:(NSPortMessage *)o_msg;
424 @end
425
426 /*****************************************************************************
427  * VLCApplication interface
428  *****************************************************************************/
429
430 @interface VLCApplication : NSApplication
431 {
432     BOOL b_justJumped;
433         BOOL b_mediaKeySupport;
434 }
435
436 - (void)coreChangedMediaKeySupportSetting: (NSNotification *)o_notification;
437 - (void)sendEvent: (NSEvent*)event;
438 - (void)resetJump;
439
440 @end