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