macosx: create new classes for all controls bar related code
[vlc.git] / modules / gui / macosx / intf.h
index ded1405..7c3df90 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * intf.h: MacOS X interface module
  *****************************************************************************
- * Copyright (C) 2002-2008 the VideoLAN team
+ * Copyright (C) 2002-2012 VLC authors and VideoLAN
  * $Id$
  *
  * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
 #   include "config.h"
 #endif
 
-#include <vlc_common.h>
-#include <vlc_interface.h>
-#include <vlc_playlist.h>
-#include <vlc_vout.h>
-#include <vlc_aout.h>
-#include <vlc_input.h>
+#import <vlc_common.h>
+#import <vlc_interface.h>
+#import <vlc_playlist.h>
+#import <vlc_vout.h>
+#import <vlc_aout.h>
+#import <vlc_input.h>
 
-#include <Cocoa/Cocoa.h>
+#import <Cocoa/Cocoa.h>
+#import "CompatibilityFixes.h"
+#import "SPMediaKeyTap.h"                   /* for the media key support */
+#import "misc.h"
+#import "MainWindow.h"
+#import "StringUtility.h"
 
-/* this was introduced in Darwin 9. We need to declare it to prevent both
- * compilation warnings and errors */
-#ifndef NSInteger
-#define NSInteger int
-#endif
+#import <IOKit/pwr_mgt/IOPMLib.h>           /* for sleep prevention */
 
 /*****************************************************************************
  * Local prototypes.
  *****************************************************************************/
-unsigned int CocoaKeyToVLC( unichar i_key );
-
-#define VLCIntf [[VLCMain sharedInstance] getIntf]
+#define VLCIntf [[VLCMain sharedInstance] intf]
 
-#define _NS(s) [[VLCMain sharedInstance] localizedString: _(s)]
-/* 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 */
-#define _ANS(s) [[[VLCMain sharedInstance] localizedString: _(s)] substringFromIndex:2]
-
-#define MACOS_VERSION [[[NSDictionary dictionaryWithContentsOfFile: \
-            @"/System/Library/CoreServices/SystemVersion.plist"] \
-            objectForKey: @"ProductVersion"] floatValue]
+// You need to release those objects after use
+input_thread_t *getInput(void);
+vout_thread_t *getVout(void);
+audio_output_t *getAout(void);
 
 /*****************************************************************************
  * intf_sys_t: description and status of the interface
  *****************************************************************************/
 struct intf_sys_t
 {
-    NSAutoreleasePool * o_pool;
-
-    /* special actions */
-    bool b_mute;
-    int i_play_status;
-
-    /* interface update */
-    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;
-
     /* menus handlers */
     bool b_input_update;
     bool b_aout_update;
     bool b_vout_update;
 
     /* The messages window */
-    msg_subscription_t * p_sub;
+    msg_subscription_t sub;
 };
 
 /*****************************************************************************
@@ -94,74 +73,49 @@ struct intf_sys_t
  *****************************************************************************/
 @class AppleRemote;
 @class VLCInformation;
-@class VLControllerWindow;
 @class VLCEmbeddedWindow;
 @class VLCControls;
 @class VLCPlaylist;
-@interface VLCMain : NSObject
+@interface VLCMain : NSObject <NSWindowDelegate, NSApplicationDelegate>
 {
     intf_thread_t *p_intf;      /* The main intf object */
+    input_thread_t *p_current_input;
+    id o_mainmenu;              /* VLCMainMenu */
     id o_prefs;                 /* VLCPrefs       */
     id o_sprefs;                /* VLCSimplePrefs */
-    id o_about;                 /* VLAboutBox     */
     id o_open;                  /* VLCOpen        */
     id o_wizard;                /* VLCWizard      */
-    id o_extended;              /* VLCExtended    */
-    id o_bookmarks;             /* VLCBookmarks   */
-    id o_embedded_list;         /* VLCEmbeddedList*/
-    id o_interaction_list;      /* VLCInteractionList*/
-    VLCInformation * o_info;                  /* VLCInformation */
-#ifdef UPDATE_CHECK
-    id o_update;                /* VLCUpdate      */
-#endif
+    id o_coredialogs;           /* VLCCoreDialogProvider */
+    id o_info;                  /* VLCInformation */
     id o_eyetv;                 /* VLCEyeTVController */
+    id o_bookmarks;             /* VLCBookmarks */
+    id o_coreinteraction;       /* VLCCoreInteraction */
     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 */
     BOOL nib_prefs_loaded;      /* preferences nibfile */
-    BOOL nib_update_loaded;     /* update nibfile */
     BOOL nib_info_loaded;       /* information panel nibfile */
+    BOOL nib_coredialogs_loaded; /* CoreDialogs nibfile */
+    BOOL nib_bookmarks_loaded;   /* Bookmarks nibfile */
+    BOOL b_active_videoplayback;
+    BOOL b_nativeFullscreenMode;
 
-    IBOutlet VLControllerWindow * o_window;       /* main window    */
-    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    */
-    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  */
-
-    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 */
-
-    NSImage * o_img_play;       /* btn play img   */
-    NSImage * o_img_pause;      /* btn pause img  */
-    NSImage * o_img_play_pressed;       /* btn play img   */
-    NSImage * o_img_pause_pressed;      /* btn pause img  */
+    VLCMainWindow *o_mainwindow;            /* VLCMainWindow */
 
     IBOutlet VLCControls * o_controls;     /* VLCControls    */
     IBOutlet VLCPlaylist * o_playlist;     /* VLCPlaylist    */
 
-    IBOutlet id o_messages;     /* messages tv    */
-    IBOutlet id o_msgs_panel;   /* messages panel */
-    NSMutableArray * o_msg_arr; /* messages array */
-    NSLock * o_msg_lock;        /* messages lock  */
-    IBOutlet NSButton * o_msgs_btn_crashlog;    /* messages open crashlog */
-    
+    /* messages panel */
+    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? */
+    IBOutlet NSButton * o_msgs_crashlog_btn;    /* messages open crashlog */
+    IBOutlet NSButton * o_msgs_save_btn;        /* save the log as rtf */
+    IBOutlet NSButton * o_msgs_refresh_btn;     /* update the panel */
+    IBOutlet id o_msgs_table;
+
     /* CrashReporter panel */
     IBOutlet NSButton * o_crashrep_dontSend_btn;
     IBOutlet NSButton * o_crashrep_send_btn;
@@ -169,241 +123,94 @@ struct intf_sys_t
     IBOutlet NSTextField * o_crashrep_title_txt;
     IBOutlet NSTextField * o_crashrep_desc_txt;
     IBOutlet NSWindow * o_crashrep_win;
-
-    /* main menu */
-
-    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;
-
-    /* dock menu */
-    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;
-
-    /* vout menu */
-    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;
-
-    bool b_small_window;
-
-    bool b_restore_size;
-    NSRect o_restore_rect;
-
-    mtime_t i_end_scroll;
-
-    NSSize o_size_with_playlist;
-
-    int     i_lastShownVolume;
-
-    input_state_e cachedInputState;
-
-    /* the manage thread */
-    pthread_t manage_thread;
-
-    /* The timer that update the interface */
-    NSTimer * interfaceTimer;
-
+    IBOutlet NSButton * o_crashrep_includeEmail_ckb;
+    IBOutlet NSButton * o_crashrep_dontaskagain_ckb;
+    IBOutlet NSTextField * o_crashrep_includeEmail_txt;
     NSURLConnection * crashLogURLConnection;
 
     AppleRemote * o_remote;
     BOOL b_remote_button_hold; /* true as long as the user holds the left,right,plus or minus on the remote control */
+
+    /* media key support */
+    BOOL b_mediaKeySupport;
+    BOOL b_mediakeyJustJumped;
+    SPMediaKeyTap * o_mediaKeyController;
+
+    NSArray *o_usedHotkeys;
+
+    /* sleep management */
+    IOPMAssertionID systemSleepAssertionID;
 }
 
 + (VLCMain *)sharedInstance;
 
-- (intf_thread_t *)getIntf;
+- (intf_thread_t *)intf;
 - (void)setIntf:(intf_thread_t *)p_mainintf;
 
-- (void)controlTintChanged;
-
-- (id)getControls;
-- (id)getSimplePreferences;
-- (id)getPreferences;
-- (id)getPlaylist;
-- (id)getInfo;
-- (id)getWizard;
-- (id)getBookmarks;
-- (id)getEmbeddedList;
-- (id)getInteractionList;
-- (id)getMainIntfPgbar;
-- (id)getControllerWindow;
-- (id)getVoutMenu;
-- (id)getEyeTVController;
+- (id)mainMenu;
+- (VLCMainWindow *)mainWindow;
+- (id)controls;
+- (id)bookmarks;
+- (id)open;
+- (id)simplePreferences;
+- (id)preferences;
+- (id)playlist;
+- (id)info;
+- (id)wizard;
+- (id)getVideoViewAtPositionX: (int *)pi_x Y: (int *)pi_y withWidth: (unsigned int*)pi_width andHeight: (unsigned int*)pi_height;
+- (void)setNativeVideoSize:(NSSize)size;
+- (id)coreDialogProvider;
+- (id)eyeTVController;
+- (id)appleRemoteController;
+- (void)setActiveVideoPlayback:(BOOL)b_value;
+- (BOOL)activeVideoPlayback;
 - (void)applicationWillTerminate:(NSNotification *)notification;
-- (NSString *)localizedString:(const char *)psz;
-- (char *)delocalizeString:(NSString *)psz;
-- (NSString *)wrapString: (NSString *)o_in_string toWidth: (int)i_width;
-- (BOOL)hasDefinedShortcutKey:(NSEvent *)o_event;
-
+- (void)updateCurrentlyUsedHotkeys;
+- (void)fullscreenChanged;
+- (BOOL)hasDefinedShortcutKey:(NSEvent *)o_event force:(BOOL)b_force;
+- (void)checkFullscreenChange:(NSNumber *)o_full;
+- (void)PlaylistItemChanged;
+- (void)playbackStatusUpdated;
+- (void)sendDistributedNotificationWithUpdatedPlaybackStatus;
+- (void)playbackModeUpdated;
+- (void)updateVolume;
+- (void)updatePlaybackPosition;
+- (void)updateName;
+- (void)playlistUpdated;
+- (void)updateRecordState: (BOOL)b_value;
+- (void)updateInfoandMetaPanel;
+- (void)updateMainMenu;
+- (void)updateMainWindow;
+- (void)showMainWindow;
+- (void)showFullscreenController;
+- (void)updateDelays;
 - (void)initStrings;
 
-- (void)manage;
-- (void)manageIntf:(NSTimer *)o_timer;
-- (void)setupMenus;
-- (void)refreshVoutDeviceMenu:(NSNotification *)o_notification;
-- (void)setScrollField:(NSString *)o_string stopAfter:(int )timeout;
-- (void)resetScrollField;
-
-- (void)updateMessageArray;
-- (void)playStatusUpdated:(int) i_status;
-- (void)setSubmenusEnabled:(BOOL)b_enabled;
-- (void)manageVolumeSlider;
-- (IBAction)timesliderUpdate:(id)sender;
-
-- (IBAction)clearRecentItems:(id)sender;
-- (void)openRecentItem:(id)sender;
-
-- (IBAction)intfOpenFile:(id)sender;
-- (IBAction)intfOpenFileGeneric:(id)sender;
-- (IBAction)intfOpenDisc:(id)sender;
-- (IBAction)intfOpenNet:(id)sender;
-- (IBAction)intfOpenCapture:(id)sender;
-
-- (IBAction)showWizard:(id)sender;
-- (IBAction)showExtended:(id)sender;
-- (IBAction)showBookmarks:(id)sender;
-
-- (IBAction)viewAbout:(id)sender;
-- (IBAction)showLicense:(id)sender;
-- (IBAction)viewPreferences:(id)sender;
-- (IBAction)checkForUpdate:(id)sender;
-- (IBAction)viewHelp:(id)sender;
-- (IBAction)openReadMe:(id)sender;
-- (IBAction)openDocumentation:(id)sender;
-- (IBAction)openWebsite:(id)sender;
-- (IBAction)openForum:(id)sender;
-- (IBAction)openDonate:(id)sender;
+- (IBAction)crashReporterAction:(id)sender;
 - (IBAction)openCrashLog:(id)sender;
-- (IBAction)viewErrorsAndWarnings:(id)sender;
+- (IBAction)saveDebugLog:(id)sender;
 - (IBAction)showMessagesPanel:(id)sender;
-- (IBAction)showInformationPanel:(id)sender;
+- (IBAction)updateMessagesPanel:(id)sender;
 
-- (IBAction)crashReporterAction:(id)sender;
+- (void)processReceivedlibvlcMessage:(const msg_item_t *) item ofType: (int)type withStr: (char *)str;
 
-- (IBAction)togglePlaylist:(id)sender;
 - (void)updateTogglePlaylistState;
 
 - (void)windowDidBecomeKey:(NSNotification *)o_notification;
 
+- (void)mediaKeyTap:(SPMediaKeyTap*)keyTap receivedMediaKeyEvent:(NSEvent*)event;
 @end
 
 @interface VLCMain (Internal)
 - (void)handlePortMessage:(NSPortMessage *)o_msg;
+- (void)resetMediaKeyJump;
+- (void)coreChangedMediaKeySupportSetting: (NSNotification *)o_notification;
+@end
+
+/*****************************************************************************
+ * VLCApplication interface
+ *****************************************************************************/
+
+@interface VLCApplication : NSApplication
+
 @end