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 *****************************************************************************/
40 #include <vlc_common.h>
45 #include "vlc_interface.h"
46 #if defined( __APPLE__ ) || defined( WIN32 )
47 #include "../control/libvlc_internal.h"
51 /*****************************************************************************
53 *****************************************************************************/
54 static void* RunInterface( vlc_object_t *p_this );
55 #if defined( __APPLE__ ) || defined( WIN32 )
56 static void * MonitorLibVLCDeath( vlc_object_t *p_this );
58 static int AddIntfCallback( vlc_object_t *, char const *,
59 vlc_value_t , vlc_value_t , void * );
62 * Destroy the interface after the main loop endeed.
64 * @param p_obj: the interface thread
66 static void intf_Destroy( vlc_object_t *obj )
68 intf_thread_t *p_intf = (intf_thread_t *)obj;
70 /* Unlock module if present (a switch may have failed) */
71 if( p_intf->p_module )
72 module_unneed( p_intf, p_intf->p_module );
74 free( p_intf->psz_intf );
75 config_ChainDestroy( p_intf->p_cfg );
76 vlc_mutex_destroy( &p_intf->change_lock );
81 * Create the interface, and prepare it for main loop. It opens ouput device
82 * and creates specific interfaces. Sends its own error messages.
84 * @param p_this the calling vlc_object_t
85 * @param psz_module a preferred interface module
86 * @return a pointer to the created interface thread, NULL on error
88 intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module )
90 intf_thread_t * p_intf;
92 /* Allocate structure */
93 p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
96 #if defined( __APPLE__ ) || defined( WIN32 )
97 p_intf->b_should_run_on_first_thread = false;
100 /* Choose the best module */
101 p_intf->p_cfg = NULL;
102 char *psz_parser = *psz_module == '$'
103 ? var_CreateGetString(p_intf,psz_module+1)
104 : strdup( psz_module );
105 char *psz_tmp = config_ChainCreate( &p_intf->psz_intf, &p_intf->p_cfg,
109 p_intf->p_module = module_need( p_intf, "interface", p_intf->psz_intf, true );
111 if( p_intf->p_module == NULL )
113 msg_Err( p_intf, "no suitable interface module" );
114 free( p_intf->psz_intf );
115 vlc_object_release( p_intf );
119 /* Initialize mutexes */
120 vlc_mutex_init( &p_intf->change_lock );
122 /* Attach interface to its parent object */
123 vlc_object_attach( p_intf, p_this );
124 vlc_object_set_destructor( p_intf, intf_Destroy );
131 * Starts and runs the interface thread.
133 * @param p_intf the interface thread
134 * @return VLC_SUCCESS on success, an error number else
136 int intf_RunThread( intf_thread_t *p_intf )
138 #if defined( __APPLE__ ) || defined( WIN32 )
139 /* Hack to get Mac OS X Cocoa runtime running
140 * (it needs access to the main thread) */
141 if( p_intf->b_should_run_on_first_thread )
143 if( vlc_thread_create( p_intf, "interface", MonitorLibVLCDeath,
144 VLC_THREAD_PRIORITY_LOW ) )
146 msg_Err( p_intf, "cannot spawn libvlc death monitoring thread" );
149 RunInterface( VLC_OBJECT(p_intf) );
151 /* Make sure our MonitorLibVLCDeath thread exit */
152 vlc_object_kill( p_intf );
153 /* It is monitoring libvlc, not the p_intf */
154 vlc_object_kill( p_intf->p_libvlc );
155 vlc_thread_join( p_intf );
157 vlc_object_detach( p_intf );
158 vlc_object_release( p_intf );
162 /* Run the interface in a separate thread */
163 if( vlc_thread_create( p_intf, "interface", RunInterface,
164 VLC_THREAD_PRIORITY_LOW ) )
166 msg_Err( p_intf, "cannot spawn interface thread" );
175 * Stops the interface thread
177 * This function asks the interface thread to stop
178 * @param p_intf the interface thread
180 void intf_StopThread( intf_thread_t *p_intf )
182 /* Tell the interface to die */
183 vlc_object_kill( p_intf );
184 vlc_thread_join( p_intf );
189 /* Following functions are local */
192 * RunInterface: setups necessary data and give control to the interface
194 * @param p_this: interface object
196 static void* RunInterface( vlc_object_t *p_this )
198 intf_thread_t *p_intf = (intf_thread_t *)p_this;
199 vlc_value_t val, text;
200 int canc = vlc_savecancel ();
202 /* Variable used for interface spawning */
203 var_Create( p_intf, "intf-add", VLC_VAR_STRING |
204 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
205 text.psz_string = _("Add Interface");
206 var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
208 val.psz_string = (char *)"rc";
209 text.psz_string = (char *)_("Console");
210 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
211 val.psz_string = (char *)"telnet";
212 text.psz_string = (char *)_("Telnet Interface");
213 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
214 val.psz_string = (char *)"http";
215 text.psz_string = (char *)_("Web Interface");
216 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
217 val.psz_string = (char *)"logger";
218 text.psz_string = (char *)_("Debug logging");
219 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
220 val.psz_string = (char *)"gestures";
221 text.psz_string = (char *)_("Mouse Gestures");
222 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
224 var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
225 vlc_restorecancel (canc);
227 /* Give control to the interface */
229 p_intf->pf_run( p_intf );
234 #if defined( __APPLE__ ) || defined( WIN32 )
235 #include "control/libvlc_internal.h" /* libvlc_InternalWait */
237 * MonitorLibVLCDeath: Used when b_should_run_on_first_thread is set.
239 * @param p_this: the interface object
241 static void * MonitorLibVLCDeath( vlc_object_t * p_this )
243 intf_thread_t *p_intf = (intf_thread_t *)p_this;
244 libvlc_int_t * p_libvlc = p_intf->p_libvlc;
245 int canc = vlc_savecancel ();
247 libvlc_InternalWait( p_libvlc );
249 vlc_object_kill( p_intf ); /* Kill the stupid first thread interface */
250 vlc_restorecancel (canc);
255 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
256 vlc_value_t oldval, vlc_value_t newval, void *p_data )
258 (void)psz_cmd; (void)oldval; (void)p_data;
259 intf_thread_t *p_intf;
262 /* Try to create the interface */
263 if( asprintf( &psz_intf, "%s,none", newval.psz_string ) == -1 )
266 p_intf = intf_Create( p_this->p_libvlc, psz_intf );
270 msg_Err( p_this, "interface \"%s\" initialization failed",
275 /* Try to run the interface */
276 if( intf_RunThread( p_intf ) != VLC_SUCCESS )
278 vlc_object_detach( p_intf );
279 vlc_object_release( p_intf );