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