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-2007 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
28 * This file contains functions related to interface management
32 /*****************************************************************************
34 *****************************************************************************/
41 #include <vlc_common.h>
42 #include <vlc_modules.h>
43 #include <vlc_interface.h>
45 #if defined( __APPLE__ ) || defined( WIN32 )
46 #include "../control/libvlc_internal.h"
50 /*****************************************************************************
52 *****************************************************************************/
53 static void* RunInterface( void * );
54 #if defined( __APPLE__)
55 static void * MonitorLibVLCDeath( vlc_object_t *p_this );
57 static int AddIntfCallback( vlc_object_t *, char const *,
58 vlc_value_t , vlc_value_t , void * );
60 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
64 * Create and start an interface.
66 * @param p_this the calling vlc_object_t
67 * @param chain configuration chain string
68 * @return VLC_SUCCESS or an error code
70 int intf_Create( vlc_object_t *p_this, const char *chain )
72 libvlc_int_t *p_libvlc = p_this->p_libvlc;
73 intf_thread_t * p_intf;
74 static const char psz_type[] = "interface";
76 /* Allocate structure */
77 p_intf = vlc_custom_create( p_libvlc, sizeof( *p_intf ),
78 VLC_OBJECT_GENERIC, psz_type );
82 /* Variable used for interface spawning */
83 vlc_value_t val, text;
84 var_Create( p_intf, "intf-add", VLC_VAR_STRING |
85 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
86 text.psz_string = _("Add Interface");
87 var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
88 #if !defined(WIN32) && defined(HAVE_ISATTY)
92 val.psz_string = (char *)"rc";
93 text.psz_string = (char *)_("Console");
94 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
96 val.psz_string = (char *)"telnet";
97 text.psz_string = (char *)_("Telnet");
98 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
99 val.psz_string = (char *)"http";
100 text.psz_string = (char *)_("Web");
101 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
102 val.psz_string = (char *)"logger";
103 text.psz_string = (char *)_("Debug logging");
104 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
105 val.psz_string = (char *)"gestures";
106 text.psz_string = (char *)_("Mouse Gestures");
107 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
109 var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
111 /* Attach interface to LibVLC */
112 #if defined( __APPLE__ )
113 p_intf->b_should_run_on_first_thread = false;
116 /* Choose the best module */
117 p_intf->p_cfg = NULL;
118 char *psz_parser = *chain == '$'
119 ? var_CreateGetString(p_intf, chain+1)
122 char *psz_tmp = config_ChainCreate( &module, &p_intf->p_cfg,
126 p_intf->p_module = module_need( p_intf, "interface", module, true );
127 if( p_intf->p_module == NULL )
129 msg_Err( p_intf, "no suitable interface module" );
133 vlc_mutex_lock( &lock );
134 #if defined( __APPLE__ )
135 /* Hack to get Mac OS X Cocoa runtime running
136 * (it needs access to the main thread) */
137 if( p_intf->b_should_run_on_first_thread )
139 if( vlc_clone( &p_intf->thread,
140 MonitorLibVLCDeath, p_intf, VLC_THREAD_PRIORITY_LOW ) )
142 msg_Err( p_intf, "cannot spawn libvlc death monitoring thread" );
143 vlc_mutex_unlock( &lock );
146 assert( p_intf->pf_run );
147 p_intf->pf_run( p_intf );
149 /* It is monitoring libvlc, not the p_intf */
150 vlc_object_kill( p_intf->p_libvlc );
152 vlc_join( p_intf->thread, NULL );
156 /* Run the interface in a separate thread */
158 && vlc_clone( &p_intf->thread,
159 RunInterface, p_intf, VLC_THREAD_PRIORITY_LOW ) )
161 msg_Err( p_intf, "cannot spawn interface thread" );
162 vlc_mutex_unlock( &lock );
166 p_intf->p_next = libvlc_priv( p_libvlc )->p_intf;
167 libvlc_priv( p_libvlc )->p_intf = p_intf;
168 vlc_mutex_unlock( &lock );
173 if( p_intf->p_module )
174 module_unneed( p_intf, p_intf->p_module );
175 config_ChainDestroy( p_intf->p_cfg );
176 vlc_object_release( p_intf );
182 * Stops and destroys all interfaces
183 * @param p_libvlc the LibVLC instance
185 void intf_DestroyAll( libvlc_int_t *p_libvlc )
187 intf_thread_t *p_first;
189 vlc_mutex_lock( &lock );
190 p_first = libvlc_priv( p_libvlc )->p_intf;
192 libvlc_priv( p_libvlc )->p_intf = NULL;
194 vlc_mutex_unlock( &lock );
196 /* Tell the interfaces to die */
197 for( intf_thread_t *p_intf = p_first; p_intf; p_intf = p_intf->p_next )
198 vlc_object_kill( p_intf );
200 /* Cleanup the interfaces */
201 for( intf_thread_t *p_intf = p_first; p_intf != NULL; )
203 intf_thread_t *p_next = p_intf->p_next;
207 vlc_cancel( p_intf->thread );
208 vlc_join( p_intf->thread, NULL );
210 module_unneed( p_intf, p_intf->p_module );
211 config_ChainDestroy( p_intf->p_cfg );
212 vlc_object_release( p_intf );
218 /* Following functions are local */
221 * RunInterface: setups necessary data and give control to the interface
223 * @param p_this: interface object
225 static void* RunInterface( void *p_this )
227 intf_thread_t *p_intf = p_this;
229 p_intf->pf_run( p_intf );
233 #if defined( __APPLE__ )
234 #include "control/libvlc_internal.h" /* libvlc_InternalWait */
236 * MonitorLibVLCDeath: Used when b_should_run_on_first_thread is set.
238 * @param p_this: the interface object
240 static void * MonitorLibVLCDeath( vlc_object_t * p_this )
242 intf_thread_t *p_intf = (intf_thread_t *)p_this;
243 libvlc_int_t * p_libvlc = p_intf->p_libvlc;
244 int canc = vlc_savecancel ();
246 libvlc_InternalWait( p_libvlc );
248 vlc_object_kill( p_intf ); /* Kill the stupid first thread interface */
249 vlc_restorecancel (canc);
254 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
255 vlc_value_t oldval, vlc_value_t newval, void *p_data )
257 (void)psz_cmd; (void)oldval; (void)p_data;
260 /* Try to create the interface */
261 if( asprintf( &psz_intf, "%s,none", newval.psz_string ) == -1 )
264 int ret = intf_Create( VLC_OBJECT(p_this->p_libvlc), psz_intf );
267 msg_Err( p_this, "interface \"%s\" initialization failed",