intf.h 13.9 KB
Newer Older
1
/*****************************************************************************
2
 * intf.h: MacOS X interface module
3
 *****************************************************************************
4
 * Copyright (C) 2002-2008 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 41 42 43 44 45
/* this was introduced in Darwin 9. We need to declare it to prevent both
 * compilation warnings and errors */
#ifndef NSInteger
#define NSInteger int
#endif

46
/*****************************************************************************
hartman's avatar
hartman committed
47
 * Local prototypes.
48
 *****************************************************************************/
hartman's avatar
hartman committed
49
unsigned int CocoaKeyToVLC( unichar i_key );
50

hartman's avatar
hartman committed
51
#define VLCIntf [[VLCMain sharedInstance] getIntf]
52

hartman's avatar
hartman committed
53
#define _NS(s) [[VLCMain sharedInstance] localizedString: _(s)]
hartman's avatar
ALL:  
hartman committed
54 55 56
/* 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
57
#define _ANS(s) [[[VLCMain sharedInstance] localizedString: _(s)] substringFromIndex:2]
58

59 60 61 62
#define MACOS_VERSION [[[NSDictionary dictionaryWithContentsOfFile: \
            @"/System/Library/CoreServices/SystemVersion.plist"] \
            objectForKey: @"ProductVersion"] floatValue]

63 64 65 66 67 68 69 70
/*****************************************************************************
 * intf_sys_t: description and status of the interface
 *****************************************************************************/
struct intf_sys_t
{
    NSAutoreleasePool * o_pool;

    /* special actions */
71
    bool b_mute;
hartman's avatar
hartman committed
72
    int i_play_status;
73

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

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

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

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

128 129
    IBOutlet VLControllerWindow * o_window;       /* main window    */
    IBOutlet NSView * o_playlist_view;/* playlist view  */
hartman's avatar
hartman committed
130
    IBOutlet id o_scrollfield;  /* info field     */
131 132 133
    IBOutlet NSTextField * o_timefield;    /* time field     */
    IBOutlet NSSlider * o_timeslider;   /* time slider    */
    IBOutlet VLCEmbeddedWindow * o_embedded_window; /* Embedded Vout Window */
Jon Lech Johansen's avatar
Jon Lech Johansen committed
134
    float f_slider;             /* slider value   */
135
    float f_slider_old;         /* old slider val */
136 137 138 139 140 141 142 143 144 145 146 147 148 149
    IBOutlet NSSlider * o_volumeslider; /* volume slider  */

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

151 152
    NSImage * o_img_play;       /* btn play img   */
    NSImage * o_img_pause;      /* btn pause img  */
hartman's avatar
hartman committed
153 154
    NSImage * o_img_play_pressed;       /* btn play img   */
    NSImage * o_img_pause_pressed;      /* btn pause img  */
155

156 157
    IBOutlet VLCControls * o_controls;     /* VLCControls    */
    IBOutlet VLCPlaylist * o_playlist;     /* VLCPlaylist    */
158 159 160

    IBOutlet id o_messages;     /* messages tv    */
    IBOutlet id o_msgs_panel;   /* messages panel */
161 162
    NSMutableArray * o_msg_arr; /* messages array */
    NSLock * o_msg_lock;        /* messages lock  */
163
    IBOutlet NSButton * o_msgs_btn_crashlog;    /* messages open crashlog */
164 165 166

    /* main menu */

167 168 169 170 171 172 173 174 175 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 210 211 212 213 214 215 216 217 218 219 220 221 222 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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
    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;
    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;
    IBOutlet NSMenuItem * o_mu_program;
    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;
    IBOutlet NSMenuItem * o_mi_deinterlace;
    IBOutlet NSMenu * o_mu_deinterlace;
    IBOutlet NSMenuItem * o_mi_ffmpeg_pp;
    IBOutlet NSMenuItem * o_mu_ffmpeg_pp;

    IBOutlet NSMenu * o_mu_window;
    IBOutlet NSMenuItem * o_mi_minimize;
    IBOutlet NSMenuItem * o_mi_close_window;
    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;
276 277

    /* dock menu */
278 279 280 281 282
    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;
283

284
    /* vout menu */
285 286 287 288 289 290 291 292 293 294
    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;
295

296
    bool b_small_window;
297

298 299 300
    bool b_restore_size;
    NSRect o_restore_rect;

301
    mtime_t i_end_scroll;
302 303 304

    NSSize o_size_with_playlist;

305
    int     i_lastShownVolume;
306

307 308
    input_state_e cachedInputState;

309 310 311
    /* the manage thread */
    pthread_t manage_thread;

312 313 314
    /* The timer that update the interface */
    NSTimer * interfaceTimer;

315
    AppleRemote * o_remote;
316
    BOOL b_remote_button_hold; /* true as long as the user holds the left,right,plus or minus on the remote control */
317 318
}

hartman's avatar
hartman committed
319 320 321 322 323
+ (VLCMain *)sharedInstance;

- (intf_thread_t *)getIntf;
- (void)setIntf:(intf_thread_t *)p_mainintf;

324 325
- (void)controlTintChanged;

hartman's avatar
hartman committed
326
- (id)getControls;
327 328
- (id)getSimplePreferences;
- (id)getPreferences;
hartman's avatar
hartman committed
329
- (id)getPlaylist;
330
- (id)getInfo;
331
- (id)getWizard;
332
- (id)getBookmarks;
333
- (id)getEmbeddedList;
334
- (id)getInteractionList;
335 336
- (id)getMainIntfPgbar;
- (id)getControllerWindow;
337
- (id)getVoutMenu;
338
- (id)getEyeTVController;
339
- (void)applicationWillTerminate:(NSNotification *)notification;
340
- (NSString *)localizedString:(const char *)psz;
hartman's avatar
hartman committed
341 342 343
- (char *)delocalizeString:(NSString *)psz;
- (NSString *)wrapString: (NSString *)o_in_string toWidth: (int)i_width;
- (BOOL)hasDefinedShortcutKey:(NSEvent *)o_event;
344

345 346
- (void)initStrings;

347
- (void)manage;
348
- (void)manageIntf:(NSTimer *)o_timer;
hartman's avatar
* ALL:  
hartman committed
349
- (void)setupMenus;
350
- (void)refreshVoutDeviceMenu:(NSNotification *)o_notification;
351 352
- (void)setScrollField:(NSString *)o_string stopAfter:(int )timeout;
- (void)resetScrollField;
353 354

- (void)updateMessageArray;
hartman's avatar
hartman committed
355
- (void)playStatusUpdated:(int) i_status;
hartman's avatar
* ALL:  
hartman committed
356
- (void)setSubmenusEnabled:(BOOL)b_enabled;
357
- (void)manageVolumeSlider;
hartman's avatar
* ALL:  
hartman committed
358
- (IBAction)timesliderUpdate:(id)sender;
359 360 361 362

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

363 364 365 366
- (IBAction)intfOpenFile:(id)sender;
- (IBAction)intfOpenFileGeneric:(id)sender;
- (IBAction)intfOpenDisc:(id)sender;
- (IBAction)intfOpenNet:(id)sender;
367
- (IBAction)intfOpenCapture:(id)sender;
368

369
- (IBAction)showWizard:(id)sender;
370
- (IBAction)showExtended:(id)sender;
371
- (IBAction)showBookmarks:(id)sender;
372

373
- (IBAction)viewAbout:(id)sender;
374
- (IBAction)showLicense:(id)sender;
375
- (IBAction)viewPreferences:(id)sender;
376
- (IBAction)checkForUpdate:(id)sender;
377
- (IBAction)viewHelp:(id)sender;
378
- (IBAction)openReadMe:(id)sender;
hartman's avatar
hartman committed
379
- (IBAction)openDocumentation:(id)sender;
380
- (IBAction)openWebsite:(id)sender;
hartman's avatar
hartman committed
381 382
- (IBAction)openForum:(id)sender;
- (IBAction)openDonate:(id)sender;
383
- (IBAction)openCrashLog:(id)sender;
384 385
- (IBAction)viewErrorsAndWarnings:(id)sender;
- (IBAction)showMessagesPanel:(id)sender;
386
- (IBAction)showInformationPanel:(id)sender;
387

388 389 390
- (IBAction)togglePlaylist:(id)sender;
- (void)updateTogglePlaylistState;

391 392
- (void)windowDidBecomeKey:(NSNotification *)o_notification;

393 394 395 396 397
@end

@interface VLCMain (Internal)
- (void)handlePortMessage:(NSPortMessage *)o_msg;
@end