Mac OS X gui: Fix dead lock when exiting. As a side effect VLC.app exit is really...
[vlc.git] / modules / gui / macosx / intf.h
1 /*****************************************************************************
2  * intf.h: MacOS X interface module
3  *****************************************************************************
4  * Copyright (C) 2002-2006 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 K\9fhne <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 #include <vlc/vlc.h>
28 #include <vlc_interface.h>
29 #include <vlc_playlist.h>
30 #include <vlc_vout.h>
31 #include <vlc_aout.h>
32 #include <vlc_input.h>
33
34 #include <Cocoa/Cocoa.h>
35
36 /*****************************************************************************
37  * Local prototypes.
38  *****************************************************************************/
39 int ExecuteOnMainThread( id target, SEL sel, void * p_arg );
40 unsigned int CocoaKeyToVLC( unichar i_key );
41
42 #define VLCIntf [[VLCMain sharedInstance] getIntf]
43
44 #define _NS(s) [[VLCMain sharedInstance] localizedString: _(s)]
45 /* Get an alternate version of the string.
46  * This string is stored as '1:string' but when displayed it only displays
47  * the translated string. the translation should be '1:translatedstring' though */
48 #define _ANS(s) [[[VLCMain sharedInstance] localizedString: _(s)] substringFromIndex:2]
49
50 #define MACOS_VERSION [[[NSDictionary dictionaryWithContentsOfFile: \
51             @"/System/Library/CoreServices/SystemVersion.plist"] \
52             objectForKey: @"ProductVersion"] floatValue]
53
54 /* switch this to 1, if you want to use Obj-C with GC */
55 #define GC_ENABLED 0
56
57 /*****************************************************************************
58  * intf_sys_t: description and status of the interface
59  *****************************************************************************/
60 struct intf_sys_t
61 {
62     NSAutoreleasePool * o_pool;
63     NSPort * o_sendport;
64
65     /* the current input */
66     input_thread_t * p_input;
67
68     /* special actions */
69     vlc_bool_t b_mute;
70     int i_play_status;
71
72     /* interface update */
73     vlc_bool_t b_intf_update;
74     vlc_bool_t b_playlist_update;
75     vlc_bool_t b_playmode_update;
76     vlc_bool_t b_current_title_update;
77     vlc_bool_t b_fullscreen_update;
78     vlc_bool_t b_volume_update;
79     vlc_bool_t b_intf_show;
80
81     /* menus handlers */
82     vlc_bool_t b_input_update;
83     vlc_bool_t b_aout_update;
84     vlc_bool_t b_vout_update;
85
86     /* The messages window */
87     msg_subscription_t * p_sub;
88
89 };
90
91 /*****************************************************************************
92  * VLCMain interface
93  *****************************************************************************/
94 @class AppleRemote;
95 @interface VLCMain : NSObject
96 {
97     intf_thread_t *p_intf;      /* The main intf object */
98     id o_prefs;                 /* VLCPrefs       */
99     id o_about;                 /* VLAboutBox     */
100     id o_open;                  /* VLCOpen        */
101     id o_wizard;                /* VLCWizard      */
102     id o_extended;              /* VLCExtended    */
103     id o_bookmarks;             /* VLCBookmarks   */
104     id o_embedded_list;         /* VLCEmbeddedList*/
105     id o_interaction_list;      /* VLCInteractionList*/
106     id o_sfilters;              /* VLCsFilters    */
107     id o_update;                /* VLCUpdate      */
108     BOOL nib_main_loaded;       /* reference to the main-nib */
109     BOOL nib_open_loaded;       /* reference to the open-nib */
110     BOOL nib_about_loaded;      /* reference to the about-nib */
111     BOOL nib_wizard_loaded;     /* reference to the wizard-nib */
112     BOOL nib_extended_loaded;   /* reference to the extended-nib */
113     BOOL nib_bookmarks_loaded;  /* reference to the bookmarks-nib */
114     BOOL nib_sfilters_loaded;   /* reference to the sfilters-nib */
115     BOOL nib_update_loaded;     /* reference to the update-nib */
116
117     IBOutlet id o_window;       /* main window    */
118     IBOutlet id o_playlist_view;/* playlist view  */
119     IBOutlet id o_scrollfield;  /* info field     */
120     IBOutlet id o_timefield;    /* time field     */
121     IBOutlet id o_timeslider;   /* time slider    */
122     IBOutlet id o_embedded_window; /* Embedded Vout Window */
123     float f_slider;             /* slider value   */
124     float f_slider_old;         /* old slider val */
125     IBOutlet id o_volumeslider; /* volume slider  */
126
127     IBOutlet id o_main_pgbar;   /* main interface progress bar */
128     IBOutlet id o_btn_prev;     /* btn previous   */
129     IBOutlet id o_btn_rewind;   /* btn rewind     */
130     IBOutlet id o_btn_play;     /* btn play       */
131     IBOutlet id o_btn_stop;     /* btn stop       */
132     IBOutlet id o_btn_ff;       /* btn fast forward     */
133     IBOutlet id o_btn_next;     /* btn next       */
134     IBOutlet id o_btn_fullscreen;/* btn fullscreen      */
135     IBOutlet id o_btn_playlist; /* btn playlist   */
136
137     NSImage * o_img_play;       /* btn play img   */
138     NSImage * o_img_pause;      /* btn pause img  */
139     NSImage * o_img_play_pressed;       /* btn play img   */
140     NSImage * o_img_pause_pressed;      /* btn pause img  */
141
142     IBOutlet id o_controls;     /* VLCControls    */
143     IBOutlet id o_playlist;     /* VLCPlaylist    */
144     IBOutlet id o_info;         /* VLCInfo        */
145
146     IBOutlet id o_messages;     /* messages tv    */
147     IBOutlet id o_msgs_panel;   /* messages panel */
148     NSMutableArray * o_msg_arr; /* messages array */
149     NSLock * o_msg_lock;        /* messages lock  */
150     IBOutlet id o_msgs_btn_crashlog;    /* messages open crashlog */
151
152     IBOutlet id o_info_window;  /* Info panel     */
153
154     /* main menu */
155
156     IBOutlet id o_mi_about;
157     IBOutlet id o_mi_prefs;
158     IBOutlet id o_mi_checkForUpdate;
159     IBOutlet id o_mi_add_intf;
160     IBOutlet id o_mu_add_intf;
161     IBOutlet id o_mi_services;
162     IBOutlet id o_mi_hide;
163     IBOutlet id o_mi_hide_others;
164     IBOutlet id o_mi_show_all;
165     IBOutlet id o_mi_quit;
166
167     IBOutlet id o_mu_file;
168     IBOutlet id o_mi_open_file;
169     IBOutlet id o_mi_open_generic;
170     IBOutlet id o_mi_open_disc;
171     IBOutlet id o_mi_open_net;
172     IBOutlet id o_mi_open_recent;
173     IBOutlet id o_mi_open_recent_cm;
174     IBOutlet id o_mi_open_wizard;
175
176     IBOutlet id o_mu_edit;
177     IBOutlet id o_mi_cut;
178     IBOutlet id o_mi_copy;
179     IBOutlet id o_mi_paste;
180     IBOutlet id o_mi_clear;
181     IBOutlet id o_mi_select_all;
182
183     IBOutlet id o_mu_controls;
184     IBOutlet id o_mi_play;
185     IBOutlet id o_mi_stop;
186     IBOutlet id o_mi_faster;
187     IBOutlet id o_mi_slower;
188     IBOutlet id o_mi_previous;
189     IBOutlet id o_mi_next;
190     IBOutlet id o_mi_random;
191     IBOutlet id o_mi_repeat;
192     IBOutlet id o_mi_loop;
193     IBOutlet id o_mi_fwd;
194     IBOutlet id o_mi_bwd;
195     IBOutlet id o_mi_fwd1m;
196     IBOutlet id o_mi_bwd1m;
197     IBOutlet id o_mi_fwd5m;
198     IBOutlet id o_mi_bwd5m;
199     IBOutlet id o_mi_program;
200     IBOutlet id o_mu_program;
201     IBOutlet id o_mi_title;
202     IBOutlet id o_mu_title;
203     IBOutlet id o_mi_chapter;
204     IBOutlet id o_mu_chapter;
205
206     IBOutlet id o_mu_audio;
207     IBOutlet id o_mi_vol_up;
208     IBOutlet id o_mi_vol_down;
209     IBOutlet id o_mi_mute;
210     IBOutlet id o_mi_audiotrack;
211     IBOutlet id o_mu_audiotrack;
212     IBOutlet id o_mi_channels;
213     IBOutlet id o_mu_channels;
214     IBOutlet id o_mi_device;
215     IBOutlet id o_mu_device;
216     IBOutlet id o_mi_visual;
217     IBOutlet id o_mu_visual;
218
219     IBOutlet id o_mu_video;
220     IBOutlet id o_mi_half_window;
221     IBOutlet id o_mi_normal_window;
222     IBOutlet id o_mi_double_window;
223     IBOutlet id o_mi_fittoscreen;
224     IBOutlet id o_mi_fullscreen;
225     IBOutlet id o_mi_floatontop;
226     IBOutlet id o_mi_snapshot;
227     IBOutlet id o_mi_videotrack;
228     IBOutlet id o_mu_videotrack;
229     IBOutlet id o_mi_screen;
230     IBOutlet id o_mu_screen;
231     IBOutlet id o_mi_aspect_ratio;
232     IBOutlet id o_mu_aspect_ratio;
233     IBOutlet id o_mi_crop;
234     IBOutlet id o_mu_crop;
235     IBOutlet id o_mi_subtitle;
236     IBOutlet id o_mu_subtitle;
237     IBOutlet id o_mi_deinterlace;
238     IBOutlet id o_mu_deinterlace;
239     IBOutlet id o_mi_ffmpeg_pp;
240     IBOutlet id o_mu_ffmpeg_pp;
241
242     IBOutlet id o_mu_window;
243     IBOutlet id o_mi_minimize;
244     IBOutlet id o_mi_close_window;
245     IBOutlet id o_mi_controller;
246     IBOutlet id o_mi_equalizer;
247     IBOutlet id o_mi_extended;
248     IBOutlet id o_mi_bookmarks;
249     IBOutlet id o_mi_playlist;
250     IBOutlet id o_mi_info;
251     IBOutlet id o_mi_messages;
252     IBOutlet id o_mi_bring_atf;
253
254     IBOutlet id o_mu_help;
255     IBOutlet id o_mi_readme;
256     IBOutlet id o_mi_documentation;
257     IBOutlet id o_mi_reportabug;
258     IBOutlet id o_mi_website;
259     IBOutlet id o_mi_license;
260     IBOutlet id o_mi_donation;
261     IBOutlet id o_mi_forum;
262     IBOutlet id o_mi_errorsAndWarnings;
263
264     /* dock menu */
265     IBOutlet id o_dmi_play;
266     IBOutlet id o_dmi_stop;
267     IBOutlet id o_dmi_next;
268     IBOutlet id o_dmi_previous;
269     IBOutlet id o_dmi_mute;
270
271     /* vout menu */
272     IBOutlet id o_vout_menu;
273     IBOutlet id o_vmi_play;
274     IBOutlet id o_vmi_stop;
275     IBOutlet id o_vmi_prev;
276     IBOutlet id o_vmi_next;
277     IBOutlet id o_vmi_volup;
278     IBOutlet id o_vmi_voldown;
279     IBOutlet id o_vmi_mute;
280     IBOutlet id o_vmi_fullscreen;
281     IBOutlet id o_vmi_snapshot;
282
283     bool b_small_window;
284
285     mtime_t i_end_scroll;
286
287     NSSize o_size_with_playlist;
288
289     int     i_lastShownVolume;
290
291     AppleRemote * o_remote;
292     BOOL b_remote_button_hold; /* true as long as the user holds the left,right,plus or minus on the remote control */
293 }
294
295 + (VLCMain *)sharedInstance;
296
297 - (intf_thread_t *)getIntf;
298 - (void)setIntf:(intf_thread_t *)p_mainintf;
299
300 - (id)getControls;
301 - (id)getPlaylist;
302 - (id)getInfo;
303 - (id)getWizard;
304 - (id)getBookmarks;
305 - (id)getEmbeddedList;
306 - (id)getInteractionList;
307 - (id)getMainIntfPgbar;
308 - (id)getControllerWindow;
309 - (id)getVoutMenu;
310 - (void)applicationWillTerminate:(NSNotification *)notification;
311 - (NSString *)localizedString:(char *)psz;
312 - (char *)delocalizeString:(NSString *)psz;
313 - (NSString *)wrapString: (NSString *)o_in_string toWidth: (int)i_width;
314 - (BOOL)hasDefinedShortcutKey:(NSEvent *)o_event;
315
316 - (void)initStrings;
317
318 - (void)manage;
319 - (void)manageIntf:(NSTimer *)o_timer;
320 - (void)setupMenus;
321 - (void)refreshVoutDeviceMenu:(NSNotification *)o_notification;
322 - (void)setScrollField:(NSString *)o_string stopAfter:(int )timeout;
323 - (void)resetScrollField;
324
325 - (void)updateMessageArray;
326 - (void)playStatusUpdated:(int) i_status;
327 - (void)setSubmenusEnabled:(BOOL)b_enabled;
328 - (void)manageVolumeSlider;
329 - (IBAction)timesliderUpdate:(id)sender;
330
331 - (IBAction)clearRecentItems:(id)sender;
332 - (void)openRecentItem:(id)sender;
333
334 - (IBAction)intfOpenFile:(id)sender;
335 - (IBAction)intfOpenFileGeneric:(id)sender;
336 - (IBAction)intfOpenDisc:(id)sender;
337 - (IBAction)intfOpenNet:(id)sender;
338
339 - (IBAction)showWizard:(id)sender;
340 - (IBAction)showExtended:(id)sender;
341 - (IBAction)showBookmarks:(id)sender;
342 - (IBAction)showSFilters:(id)sender;
343
344 - (IBAction)viewAbout:(id)sender;
345 - (IBAction)viewPreferences:(id)sender;
346 - (IBAction)checkForUpdate:(id)sender;
347 - (IBAction)openReadMe:(id)sender;
348 - (IBAction)openDocumentation:(id)sender;
349 - (IBAction)reportABug:(id)sender;
350 - (IBAction)openWebsite:(id)sender;
351 - (IBAction)openLicense:(id)sender;
352 - (IBAction)openForum:(id)sender;
353 - (IBAction)openDonate:(id)sender;
354 - (IBAction)openCrashLog:(id)sender;
355 - (IBAction)viewErrorsAndWarnings:(id)sender;
356 - (IBAction)showMessagesPanel:(id)sender;
357
358 - (IBAction)togglePlaylist:(id)sender;
359 - (void)updateTogglePlaylistState;
360
361 - (void)windowDidBecomeKey:(NSNotification *)o_notification;
362
363 @end
364
365 @interface VLCMain (Internal)
366 - (void)handlePortMessage:(NSPortMessage *)o_msg;
367 @end