c694ee0c26e8b2e676066badf4d29ecda9fb9fca
[vlc.git] / modules / gui / macosx / intf.h
1 /*****************************************************************************
2  * intf.h: MacOS X interface module
3  *****************************************************************************
4  * Copyright (C) 2002-2011 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  *          Felix Paul K├╝hne <fkuehne at videolan dot org>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 #   include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <vlc_interface.h>
33 #include <vlc_playlist.h>
34 #include <vlc_vout.h>
35 #include <vlc_aout.h>
36 #include <vlc_input.h>
37
38 #include <Cocoa/Cocoa.h>
39 #import "SPMediaKeyTap.h"                   /* for the media key support */
40
41 /*****************************************************************************
42  * Local prototypes.
43  *****************************************************************************/
44 unsigned int CocoaKeyToVLC( unichar i_key );
45
46 #define VLCIntf [[VLCMain sharedInstance] intf]
47
48 #define _NS(s) [[VLCMain sharedInstance] localizedString: _(s)]
49 /* Get an alternate version of the string.
50  * This string is stored as '1:string' but when displayed it only displays
51  * the translated string. the translation should be '1:translatedstring' though */
52 #define _ANS(s) [[[VLCMain sharedInstance] localizedString: _(s)] substringFromIndex:2]
53
54 #define MACOS_VERSION [[[NSDictionary dictionaryWithContentsOfFile: \
55             @"/System/Library/CoreServices/SystemVersion.plist"] \
56             objectForKey: @"ProductVersion"] floatValue]
57
58
59 // You need to release those objects after use
60 input_thread_t *getInput(void);
61 vout_thread_t *getVout(void);
62 audio_output_t *getAout(void);
63
64 /*****************************************************************************
65  * intf_sys_t: description and status of the interface
66  *****************************************************************************/
67 struct intf_sys_t
68 {
69     /* menus handlers */
70     bool b_input_update;
71     bool b_aout_update;
72     bool b_vout_update;
73
74     /* The messages window */
75     msg_subscription_t * p_sub;
76 };
77
78 /*****************************************************************************
79  * VLCMain interface
80  *****************************************************************************/
81 @class AppleRemote;
82 @class VLCInformation;
83 @class VLCEmbeddedWindow;
84 @class VLCControls;
85 @class VLCPlaylist;
86 @interface VLCMain : NSObject
87 {
88     intf_thread_t *p_intf;      /* The main intf object */
89     id o_mainmenu;              /* VLCMainMenu */
90     id o_prefs;                 /* VLCPrefs       */
91     id o_sprefs;                /* VLCSimplePrefs */
92     id o_open;                  /* VLCOpen        */
93     id o_wizard;                /* VLCWizard      */
94     id o_embedded_list;         /* VLCEmbeddedList*/
95     id o_coredialogs;           /* VLCCoreDialogProvider */
96     id o_info;                  /* VLCInformation */
97     id o_eyetv;                 /* VLCEyeTVController */
98     id o_bookmarks;             /* VLCBookmarks */
99     id o_coreinteraction;       /* VLCCoreInteraction */
100     BOOL nib_main_loaded;       /* main nibfile */
101     BOOL nib_open_loaded;       /* open nibfile */
102     BOOL nib_about_loaded;      /* about nibfile */
103     BOOL nib_wizard_loaded;     /* wizard nibfile */
104     BOOL nib_prefs_loaded;      /* preferences nibfile */
105     BOOL nib_info_loaded;       /* information panel nibfile */
106     BOOL nib_coredialogs_loaded; /* CoreDialogs nibfile */
107     BOOL nib_bookmarks_loaded;   /* Bookmarks nibfile */
108     BOOL b_active_videoplayback;
109
110     IBOutlet id o_mainwindow;            /* VLCMainWindow */
111
112     IBOutlet VLCControls * o_controls;     /* VLCControls    */
113     IBOutlet VLCPlaylist * o_playlist;     /* VLCPlaylist    */
114
115     IBOutlet NSTextView * o_messages;           /* messages tv    */
116     IBOutlet NSWindow * o_msgs_panel;           /* messages panel */
117     NSMutableArray * o_msg_arr;                 /* messages array */
118     NSLock * o_msg_lock;                        /* messages lock */
119     BOOL b_msg_arr_changed;                     /* did the array change? */
120     IBOutlet NSButton * o_msgs_crashlog_btn;    /* messages open crashlog */
121     IBOutlet NSButton * o_msgs_save_btn;        /* save the log as rtf */
122
123     /* CrashReporter panel */
124     IBOutlet NSButton * o_crashrep_dontSend_btn;
125     IBOutlet NSButton * o_crashrep_send_btn;
126     IBOutlet NSTextView * o_crashrep_fld;
127     IBOutlet NSTextField * o_crashrep_title_txt;
128     IBOutlet NSTextField * o_crashrep_desc_txt;
129     IBOutlet NSWindow * o_crashrep_win;
130     IBOutlet NSButton * o_crashrep_includeEmail_ckb;
131     IBOutlet NSTextField * o_crashrep_includeEmail_txt;
132
133     input_state_e cachedInputState;
134
135     NSURLConnection * crashLogURLConnection;
136
137     AppleRemote * o_remote;
138     BOOL b_remote_button_hold; /* true as long as the user holds the left,right,plus or minus on the remote control */
139
140     /* media key support */
141     BOOL b_mediaKeySupport;
142     BOOL b_mediakeyJustJumped;
143     SPMediaKeyTap * o_mediaKeyController;
144
145     NSArray *o_usedHotkeys;
146 }
147
148 + (VLCMain *)sharedInstance;
149
150 - (intf_thread_t *)intf;
151 - (void)setIntf:(intf_thread_t *)p_mainintf;
152
153 - (id)mainMenu;
154 - (id)controls;
155 - (id)bookmarks;
156 - (id)open;
157 - (id)simplePreferences;
158 - (id)preferences;
159 - (id)playlist;
160 - (id)info;
161 - (id)wizard;
162 - (id)embeddedList;
163 - (id)getVideoViewAtPositionX: (int *)pi_x Y: (int *)pi_y withWidth: (unsigned int*)pi_width andHeight: (unsigned int*)pi_height;
164 - (id)coreDialogProvider;
165 - (id)eyeTVController;
166 - (id)appleRemoteController;
167 - (void)setActiveVideoPlayback:(BOOL)b_value;
168 - (BOOL)activeVideoPlayback;
169 - (void)applicationWillTerminate:(NSNotification *)notification;
170 - (NSString *)localizedString:(const char *)psz;
171 - (char *)delocalizeString:(NSString *)psz;
172 - (NSString *)wrapString: (NSString *)o_in_string toWidth: (int)i_width;
173 - (BOOL)hasDefinedShortcutKey:(NSEvent *)o_event;
174 - (NSString *)VLCKeyToString:(NSString *)theString;
175 - (unsigned int)VLCModifiersToCocoa:(NSString *)theString;
176 - (void)updateCurrentlyUsedHotkeys;
177 - (void)PlaylistItemChanged;
178 - (void)playbackStatusUpdated;
179 - (void)playbackModeUpdated;
180 - (void)updateVolume;
181 - (void)updatePlaybackPosition;
182 - (void)updateName;
183 - (void)playlistUpdated;
184 - (void)updateInfoandMetaPanel;
185 - (void)updateMainWindow;
186 - (void)updateDelays;
187 - (void)initStrings;
188 - (BOOL)application:(NSApplication *)o_app openFile:(NSString *)o_filename;
189
190 - (void)updateMessageDisplay;
191
192 - (IBAction)crashReporterAction:(id)sender;
193 - (IBAction)openCrashLog:(id)sender;
194 - (IBAction)saveDebugLog:(id)sender;
195 - (IBAction)showMessagesPanel:(id)sender;
196
197 - (void)processReceivedlibvlcMessage:(const msg_item_t *)item;
198
199 - (void)updateTogglePlaylistState;
200
201 - (void)windowDidBecomeKey:(NSNotification *)o_notification;
202
203 - (void)mediaKeyTap:(SPMediaKeyTap*)keyTap receivedMediaKeyEvent:(NSEvent*)event;
204 @end
205
206 @interface VLCMain (Internal)
207 - (void)handlePortMessage:(NSPortMessage *)o_msg;
208 - (void)resetMediaKeyJump;
209 - (void)coreChangedMediaKeySupportSetting: (NSNotification *)o_notification;
210 @end
211
212 /*****************************************************************************
213  * VLCApplication interface
214  *****************************************************************************/
215
216 @interface VLCApplication : NSApplication
217 {
218 }
219 @end