macosx/StringUtility: move lost declaration
[vlc.git] / modules / gui / macosx / intf.h
1 /*****************************************************************************
2  * intf.h: MacOS X interface module
3  *****************************************************************************
4  * Copyright (C) 2002-2012 VLC authors and VideoLAN
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 #import <vlc_common.h>
32 #import <vlc_interface.h>
33 #import <vlc_playlist.h>
34 #import <vlc_vout.h>
35 #import <vlc_aout.h>
36 #import <vlc_input.h>
37
38 #import <Cocoa/Cocoa.h>
39 #import "CompatibilityFixes.h"
40 #import "SPMediaKeyTap.h"                   /* for the media key support */
41 #import "misc.h"
42 #import "MainWindow.h"
43 #import "StringUtility.h"
44
45 #import <IOKit/pwr_mgt/IOPMLib.h>           /* for sleep prevention */
46
47 /*****************************************************************************
48  * Local prototypes.
49  *****************************************************************************/
50 #define VLCIntf [[VLCMain sharedInstance] intf]
51
52 // You need to release those objects after use
53 input_thread_t *getInput(void);
54 vout_thread_t *getVout(void);
55 audio_output_t *getAout(void);
56
57 /*****************************************************************************
58  * intf_sys_t: description and status of the interface
59  *****************************************************************************/
60 struct intf_sys_t
61 {
62     /* menus handlers */
63     bool b_input_update;
64     bool b_aout_update;
65     bool b_vout_update;
66
67     /* The messages window */
68     msg_subscription_t sub;
69 };
70
71 /*****************************************************************************
72  * VLCMain interface
73  *****************************************************************************/
74 @class AppleRemote;
75 @class VLCInformation;
76 @class VLCEmbeddedWindow;
77 @class VLCControls;
78 @class VLCPlaylist;
79 @interface VLCMain : NSObject <NSWindowDelegate, NSApplicationDelegate>
80 {
81     intf_thread_t *p_intf;      /* The main intf object */
82     input_thread_t *p_current_input;
83     id o_mainmenu;              /* VLCMainMenu */
84     id o_prefs;                 /* VLCPrefs       */
85     id o_sprefs;                /* VLCSimplePrefs */
86     id o_open;                  /* VLCOpen        */
87     id o_wizard;                /* VLCWizard      */
88     id o_embedded_list;         /* VLCEmbeddedList*/
89     id o_coredialogs;           /* VLCCoreDialogProvider */
90     id o_info;                  /* VLCInformation */
91     id o_eyetv;                 /* VLCEyeTVController */
92     id o_bookmarks;             /* VLCBookmarks */
93     id o_coreinteraction;       /* VLCCoreInteraction */
94     BOOL nib_main_loaded;       /* main nibfile */
95     BOOL nib_open_loaded;       /* open nibfile */
96     BOOL nib_about_loaded;      /* about nibfile */
97     BOOL nib_wizard_loaded;     /* wizard nibfile */
98     BOOL nib_prefs_loaded;      /* preferences nibfile */
99     BOOL nib_info_loaded;       /* information panel nibfile */
100     BOOL nib_coredialogs_loaded; /* CoreDialogs nibfile */
101     BOOL nib_bookmarks_loaded;   /* Bookmarks nibfile */
102     BOOL b_active_videoplayback;
103     BOOL b_nativeFullscreenMode;
104
105     VLCMainWindow *o_mainwindow;            /* VLCMainWindow */
106
107     IBOutlet VLCControls * o_controls;     /* VLCControls    */
108     IBOutlet VLCPlaylist * o_playlist;     /* VLCPlaylist    */
109
110     /* messages panel */
111     IBOutlet NSWindow * o_msgs_panel;           /* messages panel */
112     NSMutableArray * o_msg_arr;                 /* messages array */
113     NSLock * o_msg_lock;                        /* messages lock */
114     BOOL b_msg_arr_changed;                     /* did the array change? */
115     IBOutlet NSButton * o_msgs_crashlog_btn;    /* messages open crashlog */
116     IBOutlet NSButton * o_msgs_save_btn;        /* save the log as rtf */
117     IBOutlet NSButton * o_msgs_refresh_btn;     /* update the panel */
118     IBOutlet id o_msgs_table;
119
120     /* CrashReporter panel */
121     IBOutlet NSButton * o_crashrep_dontSend_btn;
122     IBOutlet NSButton * o_crashrep_send_btn;
123     IBOutlet NSTextView * o_crashrep_fld;
124     IBOutlet NSTextField * o_crashrep_title_txt;
125     IBOutlet NSTextField * o_crashrep_desc_txt;
126     IBOutlet NSWindow * o_crashrep_win;
127     IBOutlet NSButton * o_crashrep_includeEmail_ckb;
128     IBOutlet NSButton * o_crashrep_dontaskagain_ckb;
129     IBOutlet NSTextField * o_crashrep_includeEmail_txt;
130     NSURLConnection * crashLogURLConnection;
131
132     AppleRemote * o_remote;
133     BOOL b_remote_button_hold; /* true as long as the user holds the left,right,plus or minus on the remote control */
134
135     /* media key support */
136     BOOL b_mediaKeySupport;
137     BOOL b_mediakeyJustJumped;
138     SPMediaKeyTap * o_mediaKeyController;
139
140     NSArray *o_usedHotkeys;
141
142     /* sleep management */
143     IOPMAssertionID systemSleepAssertionID;
144 }
145
146 + (VLCMain *)sharedInstance;
147
148 - (intf_thread_t *)intf;
149 - (void)setIntf:(intf_thread_t *)p_mainintf;
150
151 - (id)mainMenu;
152 - (id)mainWindow;
153 - (id)controls;
154 - (id)bookmarks;
155 - (id)open;
156 - (id)simplePreferences;
157 - (id)preferences;
158 - (id)playlist;
159 - (id)info;
160 - (id)wizard;
161 - (id)embeddedList;
162 - (id)getVideoViewAtPositionX: (int *)pi_x Y: (int *)pi_y withWidth: (unsigned int*)pi_width andHeight: (unsigned int*)pi_height;
163 - (void)setNativeVideoSize:(NSSize)size;
164 - (id)coreDialogProvider;
165 - (id)eyeTVController;
166 - (id)appleRemoteController;
167 - (void)setActiveVideoPlayback:(BOOL)b_value;
168 - (BOOL)activeVideoPlayback;
169 - (void)applicationWillTerminate:(NSNotification *)notification;
170 - (void)updateCurrentlyUsedHotkeys;
171 - (void)fullscreenChanged;
172 - (BOOL)hasDefinedShortcutKey:(NSEvent *)o_event force:(BOOL)b_force;
173 - (void)checkFullscreenChange:(NSNumber *)o_full;
174 - (void)PlaylistItemChanged;
175 - (void)playbackStatusUpdated;
176 - (void)sendDistributedNotificationWithUpdatedPlaybackStatus;
177 - (void)playbackModeUpdated;
178 - (void)updateVolume;
179 - (void)updatePlaybackPosition;
180 - (void)updateName;
181 - (void)playlistUpdated;
182 - (void)updateRecordState: (BOOL)b_value;
183 - (void)updateInfoandMetaPanel;
184 - (void)updateMainMenu;
185 - (void)updateMainWindow;
186 - (void)showMainWindow;
187 - (void)showFullscreenController;
188 - (void)updateDelays;
189 - (void)initStrings;
190
191 - (IBAction)crashReporterAction:(id)sender;
192 - (IBAction)openCrashLog:(id)sender;
193 - (IBAction)saveDebugLog:(id)sender;
194 - (IBAction)showMessagesPanel:(id)sender;
195 - (IBAction)updateMessagesPanel:(id)sender;
196
197 - (void)processReceivedlibvlcMessage:(const msg_item_t *) item ofType: (int)type withStr: (char *)str;
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