intf.h 16.1 KB
Newer Older
1
/*****************************************************************************
2
 * intf.h: MacOS X interface module
3
 *****************************************************************************
4
 * Copyright (C) 2002-2011 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

#include <Cocoa/Cocoa.h>
39
#import "SPMediaKeyTap.h"                   /* for the media key support */
40

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

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

hartman's avatar
hartman committed
48
#define _NS(s) [[VLCMain sharedInstance] localizedString: _(s)]
hartman's avatar
ALL:  
hartman committed
49 50 51
/* 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
52
#define _ANS(s) [[[VLCMain sharedInstance] localizedString: _(s)] substringFromIndex:2]
53

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

58 59 60 61 62 63

// You need to release those objects after use
input_thread_t *getInput(void);
vout_thread_t *getVout(void);
aout_instance_t *getAout(void);

64 65 66 67 68 69
/*****************************************************************************
 * intf_sys_t: description and status of the interface
 *****************************************************************************/
struct intf_sys_t
{
    /* special actions */
70
    bool b_mute;
hartman's avatar
hartman committed
71
    int i_play_status;
72

73
    /* interface update */
74 75 76 77 78 79 80
    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;
81

82
    /* menus handlers */
83 84 85
    bool b_input_update;
    bool b_aout_update;
    bool b_vout_update;
86 87 88 89 90 91

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

/*****************************************************************************
92
 * VLCMain interface
93
 *****************************************************************************/
94
@class AppleRemote;
95
@class VLCInformation;
96
@class VLCControllerWindow;
97 98 99
@class VLCEmbeddedWindow;
@class VLCControls;
@class VLCPlaylist;
100 101
@interface VLCMain : NSObject
{
hartman's avatar
hartman committed
102
    intf_thread_t *p_intf;      /* The main intf object */
103
    id o_prefs;                 /* VLCPrefs       */
104
    id o_sprefs;                /* VLCSimplePrefs */
105 106
    id o_about;                 /* VLAboutBox     */
    id o_open;                  /* VLCOpen        */
107
    id o_wizard;                /* VLCWizard      */
108
    id o_extended;              /* VLCExtended    */
109
    id o_bookmarks;             /* VLCBookmarks   */
110
    id o_embedded_list;         /* VLCEmbeddedList*/
111
    id o_coredialogs;           /* VLCCoreDialogProvider */
112
    VLCInformation * o_info;    /* VLCInformation */
113
    id o_eyetv;                 /* VLCEyeTVController */
114 115 116 117 118 119
    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 */
120
    BOOL nib_prefs_loaded;      /* preferences nibfile */
121
    BOOL nib_info_loaded;       /* information panel nibfile */
122
    BOOL nib_coredialogs_loaded; /* CoreDialogs nibfile */
123

124
    IBOutlet VLCControllerWindow * o_window;                     /* main window */
125 126 127 128 129 130 131 132 133
    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 */
134 135 136 137 138 139 140 141 142 143 144 145 146

    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 */
147

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

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

156 157 158 159 160
    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? */
161 162
    IBOutlet NSButton * o_msgs_crashlog_btn;    /* messages open crashlog */
    IBOutlet NSButton * o_msgs_save_btn;        /* save the log as rtf */
163

164 165 166 167 168 169 170
    /* 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;
171 172
    IBOutlet NSButton * o_crashrep_includeEmail_ckb;
    IBOutlet NSTextField * o_crashrep_includeEmail_txt;
173 174 175

    /* main menu */

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
    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;

    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;
210
    IBOutlet NSMenuItem * o_mi_normalSpeed;
211 212 213 214 215
    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;
216
    IBOutlet NSMenuItem * o_mi_quitAfterPB;
217 218 219 220 221 222 223
    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
    IBOutlet NSMenuItem * o_mi_deinterlace;
    IBOutlet NSMenu * o_mu_deinterlace;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
264 265
    IBOutlet NSMenuItem * o_mi_deinterlace_mode;
    IBOutlet NSMenu * o_mu_deinterlace_mode;
266
    IBOutlet NSMenuItem * o_mi_ffmpeg_pp;
267
    IBOutlet NSMenu * o_mu_ffmpeg_pp;
hartman's avatar
hartman committed
268 269 270 271 272 273 274
    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;
275 276 277 278

    IBOutlet NSMenu * o_mu_window;
    IBOutlet NSMenuItem * o_mi_minimize;
    IBOutlet NSMenuItem * o_mi_close_window;
279
    IBOutlet NSMenuItem * o_mi_player;
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
    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;
298 299

    /* dock menu */
300 301 302 303 304
    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;
305

306
    /* vout menu */
307 308 309 310 311 312 313 314 315 316
    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;
317

318
    bool b_small_window;
319

320 321 322
    bool b_restore_size;
    NSRect o_restore_rect;

323
    mtime_t i_end_scroll;
324 325 326

    NSSize o_size_with_playlist;

327
    int     i_lastShownVolume;
328

329 330
    input_state_e cachedInputState;

331 332 333
    /* the manage thread */
    pthread_t manage_thread;

334 335 336
    /* The timer that update the interface */
    NSTimer * interfaceTimer;

337 338
    NSURLConnection * crashLogURLConnection;

339
    AppleRemote * o_remote;
340
    BOOL b_remote_button_hold; /* true as long as the user holds the left,right,plus or minus on the remote control */
341

342 343 344 345 346
    /* media key support */
    BOOL b_mediaKeySupport;
    BOOL b_mediakeyJustJumped;
    SPMediaKeyTap * o_mediaKeyController;

347
    NSArray *o_usedHotkeys;
348 349
}

hartman's avatar
hartman committed
350 351
+ (VLCMain *)sharedInstance;

352
- (intf_thread_t *)intf;
hartman's avatar
hartman committed
353 354
- (void)setIntf:(intf_thread_t *)p_mainintf;

355 356 357 358
- (id)controls;
- (id)simplePreferences;
- (id)preferences;
- (id)playlist;
359
- (BOOL)isPlaylistCollapsed;
360 361 362 363 364 365 366 367 368
- (id)info;
- (id)wizard;
- (id)bookmarks;
- (id)embeddedList;
- (id)coreDialogProvider;
- (id)mainIntfPgbar;
- (id)controllerWindow;
- (id)voutMenu;
- (id)eyeTVController;
369
- (id)appleRemoteController;
370
- (void)applicationWillTerminate:(NSNotification *)notification;
371
- (NSString *)localizedString:(const char *)psz;
hartman's avatar
hartman committed
372 373 374
- (char *)delocalizeString:(NSString *)psz;
- (NSString *)wrapString: (NSString *)o_in_string toWidth: (int)i_width;
- (BOOL)hasDefinedShortcutKey:(NSEvent *)o_event;
375 376
- (NSString *)VLCKeyToString:(NSString *)theString;
- (unsigned int)VLCModifiersToCocoa:(NSString *)theString;
377
- (void)updateCurrentlyUsedHotkeys;
378

379 380
- (void)initStrings;

381
- (void)manage;
382
- (void)manageIntf:(NSTimer *)o_timer;
hartman's avatar
* ALL:  
hartman committed
383
- (void)setupMenus;
384
- (void)refreshVoutDeviceMenu:(NSNotification *)o_notification;
385 386
- (void)setScrollField:(NSString *)o_string stopAfter:(int )timeout;
- (void)resetScrollField;
387

388
- (void)updateMessageDisplay;
hartman's avatar
hartman committed
389
- (void)playStatusUpdated:(int) i_status;
hartman's avatar
* ALL:  
hartman committed
390
- (void)setSubmenusEnabled:(BOOL)b_enabled;
391
- (void)manageVolumeSlider;
hartman's avatar
* ALL:  
hartman committed
392
- (IBAction)timesliderUpdate:(id)sender;
393
- (IBAction)timeFieldWasClicked:(id)sender;
394 395 396 397

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

398 399 400 401
- (IBAction)intfOpenFile:(id)sender;
- (IBAction)intfOpenFileGeneric:(id)sender;
- (IBAction)intfOpenDisc:(id)sender;
- (IBAction)intfOpenNet:(id)sender;
402
- (IBAction)intfOpenCapture:(id)sender;
403

404
- (IBAction)showWizard:(id)sender;
405
- (IBAction)showExtended:(id)sender;
406
- (IBAction)showBookmarks:(id)sender;
407

408
- (IBAction)viewAbout:(id)sender;
409
- (IBAction)showLicense:(id)sender;
410
- (IBAction)viewPreferences:(id)sender;
411
- (IBAction)viewHelp:(id)sender;
412
- (IBAction)openReadMe:(id)sender;
hartman's avatar
hartman committed
413
- (IBAction)openDocumentation:(id)sender;
414
- (IBAction)openWebsite:(id)sender;
hartman's avatar
hartman committed
415 416
- (IBAction)openForum:(id)sender;
- (IBAction)openDonate:(id)sender;
417
- (IBAction)openCrashLog:(id)sender;
418 419
- (IBAction)viewErrorsAndWarnings:(id)sender;
- (IBAction)showMessagesPanel:(id)sender;
420
- (IBAction)showInformationPanel:(id)sender;
421

422
- (IBAction)crashReporterAction:(id)sender;
423
- (IBAction)saveDebugLog:(id)sender;
424

425 426 427
- (IBAction)togglePlaylist:(id)sender;
- (void)updateTogglePlaylistState;

428 429
- (void)windowDidBecomeKey:(NSNotification *)o_notification;

430
- (void)mediaKeyTap:(SPMediaKeyTap*)keyTap receivedMediaKeyEvent:(NSEvent*)event;
431 432 433 434
@end

@interface VLCMain (Internal)
- (void)handlePortMessage:(NSPortMessage *)o_msg;
435 436
- (void)resetMediaKeyJump;
- (void)coreChangedMediaKeySupportSetting: (NSNotification *)o_notification;
437
@end
438 439 440 441 442 443 444 445 446

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

@interface VLCApplication : NSApplication
{
}
@end