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 the VideoLAN team
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_object_name,
162 o_pool = [[NSAutoreleasePool alloc] init];
163 [VLCApplication sharedApplication];
166 if( p_intf->b_block &&
167 ( !strncmp( p_intf->p_module->psz_object_name, "macosx" , 6 ) ||
168 !strncmp( p_intf->p_vlc->psz_object_name, "clivlc", 6 ) ) )
170 /* VLC in normal primary interface mode */
171 RunInterface( p_intf );
172 p_intf->b_die = VLC_TRUE;
176 /* Run the interface in a separate thread */
177 if( vlc_thread_create( p_intf, "interface", RunInterface,
178 VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
180 msg_Err( p_intf, "cannot spawn interface thread" );
184 if( p_intf->b_block )
186 /* VLC in primary interface mode with a working macosx vout */
188 p_intf->b_die = VLC_TRUE;
192 if( p_intf->b_block )
194 /* Run a manager thread, launch the interface, kill the manager */
195 if( vlc_thread_create( p_intf, "manager", Manager,
196 VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
198 msg_Err( p_intf, "cannot spawn manager thread" );
202 RunInterface( p_intf );
204 p_intf->b_die = VLC_TRUE;
205 /* Do not join the thread... intf_StopThread will do it for us */
209 /* Run the interface in a separate thread */
210 if( vlc_thread_create( p_intf, "interface", RunInterface,
211 VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
213 msg_Err( p_intf, "cannot spawn interface thread" );
223 * Stops the interface thread
225 * This function asks the interface thread to stop
226 * \param p_intf the interface thread
229 void intf_StopThread( intf_thread_t *p_intf )
231 /* Tell the interface to die */
232 if( !p_intf->b_block )
234 p_intf->b_die = VLC_TRUE;
237 /* Wait for the thread to exit */
238 vlc_thread_join( p_intf );
242 * \brief Destroy the interface after the main loop endeed.
244 * Destroys interfaces and closes output devices
245 * \param p_intf the interface thread
248 void intf_Destroy( intf_thread_t *p_intf )
250 /* Unlock module if present (a switch may have failed) */
251 if( p_intf->p_module )
253 module_Unneed( p_intf, p_intf->p_module );
256 vlc_mutex_destroy( &p_intf->change_lock );
259 vlc_object_destroy( p_intf );
263 /* Following functions are local */
265 /*****************************************************************************
266 * Manager: helper thread for blocking interfaces
267 *****************************************************************************
268 * If the interface is launched in the main thread, it will not listen to
269 * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die.
270 * This thread takes care of the matter.
271 *****************************************************************************/
273 * \brief Helper thread for blocking interfaces.
274 * \ingroup vlc_interface
276 * This is a local function
277 * If the interface is launched in the main thread, it will not listen to
278 * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die.
279 * This thread takes care of the matter.
280 * \see intf_RunThread
281 * \param p_intf an interface thread
284 static void Manager( intf_thread_t *p_intf )
286 while( !p_intf->b_die )
288 msleep( INTF_IDLE_SLEEP );
290 if( p_intf->p_vlc->b_die )
292 p_intf->b_die = VLC_TRUE;
294 if( strncmp( p_intf->p_vlc->psz_object_name, "clivlc", 6 ) )
304 /*****************************************************************************
305 * RunInterface: setups necessary data and give control to the interface
306 *****************************************************************************/
307 static void RunInterface( intf_thread_t *p_intf )
309 static char *ppsz_interfaces[] =
312 "wxwidgets", "wxWidgets",
319 vlc_value_t val, text;
322 /* Variable used for interface switching */
323 p_intf->psz_switch_intf = NULL;
324 var_Create( p_intf, "intf-switch", VLC_VAR_STRING |
325 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
326 text.psz_string = _("Switch interface");
327 var_Change( p_intf, "intf-switch", VLC_VAR_SETTEXT, &text, NULL );
329 /* Only fill the list with available modules */
330 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
331 for( ppsz_parser = ppsz_interfaces; *ppsz_parser; ppsz_parser += 2 )
333 for( i = 0; i < p_list->i_count; i++ )
335 module_t *p_module = (module_t *)p_list->p_values[i].p_object;
336 if( !strcmp( p_module->psz_object_name, ppsz_parser[0] ) )
338 val.psz_string = ppsz_parser[0];
339 text.psz_string = ppsz_parser[1];
340 var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE,
346 vlc_list_release( p_list );
348 var_AddCallback( p_intf, "intf-switch", SwitchIntfCallback, NULL );
350 /* Variable used for interface spawning */
351 var_Create( p_intf, "intf-add", VLC_VAR_STRING |
352 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
353 text.psz_string = _("Add Interface");
354 var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
356 val.psz_string = "rc"; text.psz_string = "Console";
357 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
358 val.psz_string = "telnet"; text.psz_string = "Telnet Interface";
359 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
360 val.psz_string = "http"; text.psz_string = "Web Interface";
361 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
362 val.psz_string = "logger"; text.psz_string = "Debug logging";
363 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
364 val.psz_string = "gestures"; text.psz_string = "Mouse Gestures";
365 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
367 var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
371 /* Give control to the interface */
372 p_intf->pf_run( p_intf );
374 /* Reset play on start status */
375 p_intf->b_play = VLC_FALSE;
377 if( !p_intf->psz_switch_intf )
382 /* Make sure the old interface is completely uninitialized */
383 module_Unneed( p_intf, p_intf->p_module );
385 /* Provide ability to switch the main interface on the fly */
386 psz_intf = p_intf->psz_switch_intf;
387 p_intf->psz_switch_intf = NULL;
389 vlc_mutex_lock( &p_intf->object_lock );
390 p_intf->b_die = VLC_FALSE;
391 p_intf->b_dead = VLC_FALSE;
392 vlc_mutex_unlock( &p_intf->object_lock );
394 p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
397 while( p_intf->p_module );
400 static int SwitchIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
401 vlc_value_t oldval, vlc_value_t newval, void *p_data )
403 intf_thread_t *p_intf = (intf_thread_t *)p_this;
405 p_intf->psz_switch_intf =
406 malloc( strlen(newval.psz_string) + sizeof(",none") );
407 sprintf( p_intf->psz_switch_intf, "%s,none", newval.psz_string );
408 p_intf->b_die = VLC_TRUE;
413 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
414 vlc_value_t oldval, vlc_value_t newval, void *p_data )
416 intf_thread_t *p_intf;
417 char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
419 /* Try to create the interface */
420 sprintf( psz_intf, "%s,none", newval.psz_string );
421 p_intf = intf_Create( p_this->p_vlc, psz_intf );
425 msg_Err( p_this, "interface \"%s\" initialization failed",
430 /* Try to run the interface */
431 p_intf->b_block = VLC_FALSE;
432 if( intf_RunThread( p_intf ) != VLC_SUCCESS )
434 vlc_object_detach( p_intf );
435 intf_Destroy( p_intf );
443 /*****************************************************************************
444 * VLCApplication implementation
445 *****************************************************************************/
446 @implementation VLCApplication
448 - (void)stop: (id)sender
451 NSAutoreleasePool *o_pool;
454 o_pool = [[NSAutoreleasePool alloc] init];
455 /* send a dummy event to break out of the event loop */
456 o_event = [NSEvent mouseEventWithType: NSLeftMouseDown
457 location: NSMakePoint( 1, 1 ) modifierFlags: 0
458 timestamp: 1 windowNumber: [[NSApp mainWindow] windowNumber]
459 context: [NSGraphicsContext currentContext] eventNumber: 1
460 clickCount: 1 pressure: 0.0];
461 [NSApp postEvent: o_event atStart: YES];
465 - (void)terminate: (id)sender
467 if( [NSApp isRunning] )
469 [super terminate: sender];