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

#include <Cocoa/Cocoa.h>

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

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

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

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

57 58 59 60 61 62
/*****************************************************************************
 * intf_sys_t: description and status of the interface
 *****************************************************************************/
struct intf_sys_t
{
    /* special actions */
63
    bool b_mute;
hartman's avatar
hartman committed
64
    int i_play_status;
65

66
    /* interface update */
67 68 69 70 71 72 73
    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;
74

75
    /* menus handlers */
76 77 78
    bool b_input_update;
    bool b_aout_update;
    bool b_vout_update;
79 80 81 82 83 84

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

/*****************************************************************************
85
 * VLCMain interface
86
 *****************************************************************************/
87
@class AppleRemote;
88
@class VLCInformation;
89
@class VLCControllerWindow;
90 91 92
@class VLCEmbeddedWindow;
@class VLCControls;
@class VLCPlaylist;
93 94
@interface VLCMain : NSObject
{
hartman's avatar
hartman committed
95
    intf_thread_t *p_intf;      /* The main intf object */
96
    id o_prefs;                 /* VLCPrefs       */
97
    id o_sprefs;                /* VLCSimplePrefs */
98 99
    id o_about;                 /* VLAboutBox     */
    id o_open;                  /* VLCOpen        */
100
    id o_wizard;                /* VLCWizard      */
101
    id o_extended;              /* VLCExtended    */
102
    id o_bookmarks;             /* VLCBookmarks   */
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
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 112 113 114 115 116
    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 */
117
    BOOL nib_prefs_loaded;      /* preferences nibfile */
118
    BOOL nib_update_loaded;     /* update nibfile */
119
    BOOL nib_info_loaded;       /* information panel nibfile */
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
120
    BOOL nib_vlm_loaded;        /* VLM Panel nibfile */
121
    BOOL nib_coredialogs_loaded; /* CoreDialogs nibfile */
122

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

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

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

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

155 156 157 158 159
    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? */
160 161
    IBOutlet NSButton * o_msgs_crashlog_btn;    /* messages open crashlog */
    IBOutlet NSButton * o_msgs_save_btn;        /* save the log as rtf */
162 163 164 165 166 167 168 169
    
    /* 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;
170 171
    IBOutlet NSButton * o_crashrep_includeEmail_ckb;
    IBOutlet NSTextField * o_crashrep_includeEmail_txt;
172 173 174

    /* main menu */

175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    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;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
196
    IBOutlet NSMenuItem * o_mi_open_vlm;
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221

    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;
    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;
    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;
222
    IBOutlet NSMenu * o_mu_program;
223 224 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
    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;
259
    IBOutlet NSMenuItem * o_mi_addSub;
260 261 262
    IBOutlet NSMenuItem * o_mi_deinterlace;
    IBOutlet NSMenu * o_mu_deinterlace;
    IBOutlet NSMenuItem * o_mi_ffmpeg_pp;
263
    IBOutlet NSMenu * o_mu_ffmpeg_pp;
hartman's avatar
hartman committed
264 265 266 267 268 269 270
    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;
271 272 273 274

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

    /* dock menu */
296 297 298 299 300
    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;
301

302
    /* vout menu */
303 304 305 306 307 308 309 310 311 312
    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;
313

314
    bool b_small_window;
315

316 317 318
    bool b_restore_size;
    NSRect o_restore_rect;

319
    mtime_t i_end_scroll;
320 321 322

    NSSize o_size_with_playlist;

323
    int     i_lastShownVolume;
324

325 326
    input_state_e cachedInputState;

327 328 329
    /* the manage thread */
    pthread_t manage_thread;

330 331 332
    /* The timer that update the interface */
    NSTimer * interfaceTimer;

333 334
    NSURLConnection * crashLogURLConnection;

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
}

hartman's avatar
hartman committed
339 340
+ (VLCMain *)sharedInstance;

341
- (intf_thread_t *)intf;
hartman's avatar
hartman committed
342 343
- (void)setIntf:(intf_thread_t *)p_mainintf;

344 345
- (void)controlTintChanged;

346 347 348 349
- (id)controls;
- (id)simplePreferences;
- (id)preferences;
- (id)playlist;
350
- (BOOL)isPlaylistCollapsed;
351 352 353 354 355 356 357 358 359
- (id)info;
- (id)wizard;
- (id)bookmarks;
- (id)embeddedList;
- (id)coreDialogProvider;
- (id)mainIntfPgbar;
- (id)controllerWindow;
- (id)voutMenu;
- (id)eyeTVController;
360
- (id)appleRemoteController;
361
- (void)applicationWillTerminate:(NSNotification *)notification;
362
- (NSString *)localizedString:(const char *)psz;
hartman's avatar
hartman committed
363 364 365
- (char *)delocalizeString:(NSString *)psz;
- (NSString *)wrapString: (NSString *)o_in_string toWidth: (int)i_width;
- (BOOL)hasDefinedShortcutKey:(NSEvent *)o_event;
366

367 368
- (void)initStrings;

369
- (void)manage;
370
- (void)manageIntf:(NSTimer *)o_timer;
hartman's avatar
* ALL:  
hartman committed
371
- (void)setupMenus;
372
- (void)refreshVoutDeviceMenu:(NSNotification *)o_notification;
373 374
- (void)setScrollField:(NSString *)o_string stopAfter:(int )timeout;
- (void)resetScrollField;
375

376
- (void)updateMessageDisplay;
hartman's avatar
hartman committed
377
- (void)playStatusUpdated:(int) i_status;
hartman's avatar
* ALL:  
hartman committed
378
- (void)setSubmenusEnabled:(BOOL)b_enabled;
379
- (void)manageVolumeSlider;
hartman's avatar
* ALL:  
hartman committed
380
- (IBAction)timesliderUpdate:(id)sender;
381
- (IBAction)timeFieldWasClicked:(id)sender;
382 383 384 385

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

386 387 388 389
- (IBAction)intfOpenFile:(id)sender;
- (IBAction)intfOpenFileGeneric:(id)sender;
- (IBAction)intfOpenDisc:(id)sender;
- (IBAction)intfOpenNet:(id)sender;
390
- (IBAction)intfOpenCapture:(id)sender;
391

392
- (IBAction)showWizard:(id)sender;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
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;
hartman's avatar
hartman committed
403
- (IBAction)openDocumentation:(id)sender;
404
- (IBAction)openWebsite:(id)sender;
hartman's avatar
hartman committed
405 406
- (IBAction)openForum:(id)sender;
- (IBAction)openDonate:(id)sender;
407
- (IBAction)openCrashLog:(id)sender;
408 409
- (IBAction)viewErrorsAndWarnings:(id)sender;
- (IBAction)showMessagesPanel:(id)sender;
410
- (IBAction)showInformationPanel:(id)sender;
411

412
- (IBAction)crashReporterAction:(id)sender;
413
- (IBAction)saveDebugLog:(id)sender;
414

415 416 417
- (IBAction)togglePlaylist:(id)sender;
- (void)updateTogglePlaylistState;

418 419
- (void)windowDidBecomeKey:(NSNotification *)o_notification;

420 421 422 423 424
@end

@interface VLCMain (Internal)
- (void)handlePortMessage:(NSPortMessage *)o_msg;
@end
425 426 427 428 429 430 431 432

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

@interface VLCApplication : NSApplication
{
    BOOL b_justJumped;
433
	BOOL b_mediaKeySupport;
434 435
}

436
- (void)coreChangedMediaKeySupportSetting: (NSNotification *)o_notification;
437 438 439 440
- (void)sendEvent: (NSEvent*)event;
- (void)resetJump;

@end