1 /*****************************************************************************
2 * interface.c: interface access for other threads
3 * This library provides basic functions for threads to interact with user
4 * interface, such as command line.
5 *****************************************************************************
6 * Copyright (C) 1998-2004 VideoLAN
9 * Authors: Vincent Seguin <seguin@via.ecp.fr>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
28 * This file contains functions related to interface management
32 /*****************************************************************************
34 *****************************************************************************/
35 #include <stdlib.h> /* free(), strtol() */
36 #include <stdio.h> /* FILE */
37 #include <string.h> /* strerror() */
40 #include <vlc/input.h>
42 #include "audio_output.h"
44 #include "vlc_interface.h"
45 #include "vlc_video.h"
46 #include "video_output.h"
49 # include "Cocoa/Cocoa.h"
50 #endif /* SYS_DARWIN */
52 /*****************************************************************************
54 *****************************************************************************/
55 static void Manager( intf_thread_t *p_intf );
56 static void RunInterface( intf_thread_t *p_intf );
58 static int SwitchIntfCallback( vlc_object_t *, char const *,
59 vlc_value_t , vlc_value_t , void * );
60 static int AddIntfCallback( vlc_object_t *, char const *,
61 vlc_value_t , vlc_value_t , void * );
64 /*****************************************************************************
65 * VLCApplication interface
66 *****************************************************************************/
67 @interface VLCApplication : NSApplication
74 /*****************************************************************************
75 * intf_Create: prepare interface before main loop
76 *****************************************************************************
77 * This function opens output devices and creates specific interfaces. It sends
78 * its own error messages.
79 *****************************************************************************/
81 * Create the interface, and prepare it for main loop.
83 * \param p_this the calling vlc_object_t
84 * \param psz_module a prefered interface module
85 * \return a pointer to the created interface thread, NULL on error
87 intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module )
89 intf_thread_t * p_intf;
91 /* Allocate structure */
92 p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
95 msg_Err( p_this, "out of memory" );
98 p_intf->pf_request_window = NULL;
99 p_intf->pf_release_window = NULL;
100 p_intf->pf_control_window = NULL;
101 p_intf->b_play = VLC_FALSE;
103 /* Choose the best module */
104 p_intf->p_module = module_Need( p_intf, "interface", psz_module, 0 );
106 if( p_intf->p_module == NULL )
108 msg_Err( p_intf, "no suitable intf module" );
109 vlc_object_destroy( p_intf );
113 /* Initialize structure */
114 p_intf->b_menu = VLC_FALSE;
115 p_intf->b_menu_change = VLC_FALSE;
117 /* Initialize mutexes */
118 vlc_mutex_init( p_intf, &p_intf->change_lock );
120 msg_Dbg( p_intf, "interface initialized" );
122 /* Attach interface to its parent object */
123 vlc_object_attach( p_intf, p_this );
128 /*****************************************************************************
129 * intf_RunThread: launch the interface thread
130 *****************************************************************************
131 * This function either creates a new thread and runs the interface in it,
132 * or runs the interface in the current thread, depending on b_block.
133 *****************************************************************************/
135 * Run the interface thread.
137 * If b_block is not set, runs the interface in the thread, else,
138 * creates a new thread and runs the interface.
139 * \param p_intf the interface thread
140 * \return VLC_SUCCESS on success, an error number else
142 int intf_RunThread( intf_thread_t *p_intf )
145 NSAutoreleasePool * o_pool;
147 if( p_intf->b_block )
149 /* This is the primary intf */
150 /* Run a manager thread, launch the interface, kill the manager */
151 if( vlc_thread_create( p_intf, "manager", Manager,
152 VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
154 msg_Err( p_intf, "cannot spawn manager thread" );
159 if( p_intf->b_block && strncmp( p_intf->p_module->psz_shortname, "clivlc", 6) )
161 o_pool = [[NSAutoreleasePool alloc] init];
162 [VLCApplication sharedApplication];
165 if( p_intf->b_block && ( !strncmp( p_intf->p_module->psz_shortname, "macosx" , 6 ) ||
166 !strncmp( p_intf->p_vlc->psz_object_name, "clivlc", 6 ) ) )
168 /* VLC in normal primary interface mode */
169 RunInterface( p_intf );
170 p_intf->b_die = VLC_TRUE;
174 /* Run the interface in a separate thread */
175 if( vlc_thread_create( p_intf, "interface", RunInterface,
176 VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
178 msg_Err( p_intf, "cannot spawn interface thread" );
182 if( p_intf->b_block )
184 /* VLC in primary interface mode with a working macosx vout */
186 p_intf->b_die = VLC_TRUE;
190 if( p_intf->b_block )
192 /* Run a manager thread, launch the interface, kill the manager */
193 if( vlc_thread_create( p_intf, "manager", Manager,
194 VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
196 msg_Err( p_intf, "cannot spawn manager thread" );
200 RunInterface( p_intf );
202 p_intf->b_die = VLC_TRUE;
203 /* Do not join the thread... intf_StopThread will do it for us */
207 /* Run the interface in a separate thread */
208 if( vlc_thread_create( p_intf, "interface", RunInterface,
209 VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
211 msg_Err( p_intf, "cannot spawn interface thread" );
221 * Stops the interface thread
223 * This function asks the interface thread to stop
224 * \param p_intf the interface thread
227 void intf_StopThread( intf_thread_t *p_intf )
229 /* Tell the interface to die */
230 if( !p_intf->b_block )
232 p_intf->b_die = VLC_TRUE;
235 /* Wait for the thread to exit */
236 vlc_thread_join( p_intf );
240 * \brief Destroy the interface after the main loop endeed.
242 * Destroys interfaces and closes output devices
243 * \param p_intf the interface thread
246 void intf_Destroy( intf_thread_t *p_intf )
248 /* Unlock module if present (a switch may have failed) */
249 if( p_intf->p_module )
251 module_Unneed( p_intf, p_intf->p_module );
254 vlc_mutex_destroy( &p_intf->change_lock );
257 vlc_object_destroy( p_intf );
261 /* Following functions are local */
263 /*****************************************************************************
264 * Manager: helper thread for blocking interfaces
265 *****************************************************************************
266 * If the interface is launched in the main thread, it will not listen to
267 * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die.
268 * This thread takes care of the matter.
269 *****************************************************************************/
271 * \brief Helper thread for blocking interfaces.
272 * \ingroup vlc_interface
274 * This is a local function
275 * If the interface is launched in the main thread, it will not listen to
276 * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die.
277 * This thread takes care of the matter.
278 * \see intf_RunThread
279 * \param p_intf an interface thread
282 static void Manager( intf_thread_t *p_intf )
284 while( !p_intf->b_die )
286 msleep( INTF_IDLE_SLEEP );
288 if( p_intf->p_vlc->b_die )
290 p_intf->b_die = VLC_TRUE;
292 if( strncmp( p_intf->p_vlc->psz_object_name, "clivlc", 6 ) )
302 /*****************************************************************************
303 * RunInterface: setups necessary data and give control to the interface
304 *****************************************************************************/
305 static void RunInterface( intf_thread_t *p_intf )
307 static char *ppsz_interfaces[] =
311 "wxwindows", "wxWindows",
318 vlc_value_t val, text;
321 /* Variable used for interface switching */
322 p_intf->psz_switch_intf = NULL;
323 var_Create( p_intf, "intf-switch", VLC_VAR_STRING |
324 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
325 text.psz_string = _("Switch interface");
326 var_Change( p_intf, "intf-switch", VLC_VAR_SETTEXT, &text, NULL );
328 /* Only fill the list with available modules */
329 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
330 for( ppsz_parser = ppsz_interfaces; *ppsz_parser; ppsz_parser += 2 )
332 for( i = 0; i < p_list->i_count; i++ )
334 module_t *p_module = (module_t *)p_list->p_values[i].p_object;
335 if( !strcmp( p_module->psz_object_name, ppsz_parser[0] ) )
337 val.psz_string = ppsz_parser[0];
338 text.psz_string = ppsz_parser[1];
339 var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE,
345 vlc_list_release( p_list );
347 var_AddCallback( p_intf, "intf-switch", SwitchIntfCallback, NULL );
349 /* Variable used for interface spawning */
350 var_Create( p_intf, "intf-add", VLC_VAR_STRING |
351 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
352 text.psz_string = _("Add Interface");
353 var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
355 val.psz_string = "rc"; text.psz_string = "Console";
356 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
357 val.psz_string = "telnet"; text.psz_string = "Telnet Interface";
358 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
359 val.psz_string = "http"; text.psz_string = "Web Interface";
360 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
361 val.psz_string = "logger"; text.psz_string = "Debug logging";
362 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
363 val.psz_string = "sap"; text.psz_string = "SAP Playlist";
364 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
365 val.psz_string = "gestures"; text.psz_string = "Mouse Gestures";
366 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
368 var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
372 /* Give control to the interface */
373 p_intf->pf_run( p_intf );
375 /* Reset play on start status */
376 p_intf->b_play = VLC_FALSE;
378 if( !p_intf->psz_switch_intf )
383 /* Make sure the old interface is completely uninitialized */
384 module_Unneed( p_intf, p_intf->p_module );
386 /* Provide ability to switch the main interface on the fly */
387 psz_intf = p_intf->psz_switch_intf;
388 p_intf->psz_switch_intf = NULL;
390 vlc_mutex_lock( &p_intf->object_lock );
391 p_intf->b_die = VLC_FALSE;
392 p_intf->b_dead = VLC_FALSE;
393 vlc_mutex_unlock( &p_intf->object_lock );
395 p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
398 while( p_intf->p_module );
401 static int SwitchIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
402 vlc_value_t oldval, vlc_value_t newval, void *p_data )
404 intf_thread_t *p_intf = (intf_thread_t *)p_this;
406 p_intf->psz_switch_intf =
407 malloc( strlen(newval.psz_string) + sizeof(",none") );
408 sprintf( p_intf->psz_switch_intf, "%s,none", newval.psz_string );
409 p_intf->b_die = VLC_TRUE;
414 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
415 vlc_value_t oldval, vlc_value_t newval, void *p_data )
417 intf_thread_t *p_intf;
418 char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
420 /* Try to create the interface */
421 sprintf( psz_intf, "%s,none", newval.psz_string );
422 p_intf = intf_Create( p_this->p_vlc, psz_intf );
426 msg_Err( p_this, "interface \"%s\" initialization failed",
431 /* Try to run the interface */
432 p_intf->b_block = VLC_FALSE;
433 if( intf_RunThread( p_intf ) != VLC_SUCCESS )
435 vlc_object_detach( p_intf );
436 intf_Destroy( p_intf );
444 /*****************************************************************************
445 * VLCApplication implementation
446 *****************************************************************************/
447 @implementation VLCApplication
449 - (void)stop: (id)sender
452 NSAutoreleasePool *o_pool;
455 o_pool = [[NSAutoreleasePool alloc] init];
456 /* send a dummy event to break out of the event loop */
457 o_event = [NSEvent mouseEventWithType: NSLeftMouseDown
458 location: NSMakePoint( 1, 1 ) modifierFlags: 0
459 timestamp: 1 windowNumber: [[NSApp mainWindow] windowNumber]
460 context: [NSGraphicsContext currentContext] eventNumber: 1
461 clickCount: 1 pressure: 0.0];
462 [NSApp postEvent: o_event atStart: YES];
466 - (void)terminate: (id)sender
468 if( [NSApp isRunning] )
470 [super terminate: sender];