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 #include "modules/modules.h" // Gruik!
49 /*****************************************************************************
51 *****************************************************************************/
52 static void RunInterface( intf_thread_t *p_intf );
54 static void MonitorLibVLCDeath( intf_thread_t *p_intf );
56 static int AddIntfCallback( vlc_object_t *, char const *,
57 vlc_value_t , vlc_value_t , void * );
60 * \brief Destroy the interface after the main loop endeed.
62 * \param p_intf the interface thread
65 static void intf_Destroy( vlc_object_t *obj )
67 intf_thread_t *p_intf = (intf_thread_t *)obj;
69 /* Unlock module if present (a switch may have failed) */
70 if( p_intf->p_module )
71 module_Unneed( p_intf, p_intf->p_module );
73 free( p_intf->psz_intf );
74 vlc_mutex_destroy( &p_intf->change_lock );
77 /*****************************************************************************
78 * intf_Create: prepare interface before main loop
79 *****************************************************************************
80 * This function opens output devices and creates specific interfaces. It sends
81 * its own error messages.
82 *****************************************************************************/
84 * Create the interface, and prepare it for main loop.
86 * \param p_this the calling vlc_object_t
87 * \param psz_module a preferred interface module
88 * \return a pointer to the created interface thread, NULL on error
90 intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module )
92 intf_thread_t * p_intf;
94 /* Allocate structure */
95 p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
98 p_intf->b_interaction = false;
100 p_intf->b_should_run_on_first_thread = false;
103 /* Choose the best module */
104 p_intf->psz_intf = strdup( psz_module );
105 p_intf->p_module = module_Need( p_intf, "interface", psz_module, false );
107 if( p_intf->p_module == NULL )
109 msg_Err( p_intf, "no suitable interface module" );
110 free( p_intf->psz_intf );
111 vlc_object_release( p_intf );
115 /* Initialize structure */
116 p_intf->b_menu = false;
117 p_intf->b_menu_change = false;
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 );
129 /*****************************************************************************
130 * intf_RunThread: launch the interface thread
131 *****************************************************************************
132 * This function either creates a new thread and runs the interface in it.
133 *****************************************************************************/
135 * Starts and runs the interface thread.
137 * \param p_intf the interface thread
138 * \return VLC_SUCCESS on success, an error number else
140 int intf_RunThread( intf_thread_t *p_intf )
143 /* Hack to get Mac OS X Cocoa runtime running
144 * (it needs access to the main thread) */
145 if( p_intf->b_should_run_on_first_thread )
147 if( vlc_thread_create( p_intf, "interface", MonitorLibVLCDeath,
148 VLC_THREAD_PRIORITY_LOW, false ) )
150 msg_Err( p_intf, "cannot spawn libvlc death monitoring thread" );
153 RunInterface( p_intf );
155 /* Make sure our MonitorLibVLCDeath thread exit */
156 vlc_object_kill( p_intf );
157 /* It is monitoring libvlc, not the p_intf */
158 vlc_object_signal( p_intf->p_libvlc );
159 vlc_thread_join( p_intf );
161 vlc_object_detach( p_intf );
162 vlc_object_release( p_intf );
166 /* Run the interface in a separate thread */
167 if( vlc_thread_create( p_intf, "interface", RunInterface,
168 VLC_THREAD_PRIORITY_LOW, false ) )
170 msg_Err( p_intf, "cannot spawn interface thread" );
178 * Stops the interface thread
180 * This function asks the interface thread to stop
181 * \param p_intf the interface thread
184 void intf_StopThread( intf_thread_t *p_intf )
186 /* Tell the interface to die */
187 vlc_object_kill( p_intf );
188 vlc_thread_join( p_intf );
191 /* Following functions are local */
193 /*****************************************************************************
194 * RunInterface: setups necessary data and give control to the interface
195 *****************************************************************************/
196 static void RunInterface( intf_thread_t *p_intf )
198 vlc_value_t val, text;
201 /* Variable used for interface spawning */
202 var_Create( p_intf, "intf-add", VLC_VAR_STRING |
203 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
204 text.psz_string = _("Add Interface");
205 var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
207 val.psz_string = (char *)"rc";
208 text.psz_string = (char *)_("Console");
209 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
210 val.psz_string = (char *)"telnet";
211 text.psz_string = (char *)_("Telnet Interface");
212 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
213 val.psz_string = (char *)"http";
214 text.psz_string = (char *)_("Web Interface");
215 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
216 val.psz_string = (char *)"logger";
217 text.psz_string = (char *)_("Debug logging");
218 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
219 val.psz_string = (char *)"gestures";
220 text.psz_string = (char *)_("Mouse Gestures");
221 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
223 var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
227 /* Give control to the interface */
229 p_intf->pf_run( p_intf );
232 vlc_object_lock( p_intf );
233 while( vlc_object_alive( p_intf ) )
234 vlc_object_wait( p_intf );
235 vlc_object_unlock( p_intf );
238 if( !p_intf->psz_switch_intf )
243 /* Make sure the old interface is completely uninitialized */
244 module_Unneed( p_intf, p_intf->p_module );
246 /* Provide ability to switch the main interface on the fly */
247 psz_intf = p_intf->psz_switch_intf;
248 p_intf->psz_switch_intf = NULL;
250 vlc_object_lock( p_intf );
251 p_intf->b_die = false; /* FIXME */
252 p_intf->b_dead = false;
254 vlc_object_unlock( p_intf );
256 p_intf->psz_intf = psz_intf;
257 p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
259 while( p_intf->p_module );
263 /*****************************************************************************
264 * MonitorLibVLCDeath: Used when b_should_run_on_first_thread is set.
265 *****************************************************************************/
266 static void MonitorLibVLCDeath( intf_thread_t *p_intf )
268 libvlc_int_t * p_libvlc = p_intf->p_libvlc;
269 vlc_object_lock( p_libvlc );
270 while(vlc_object_alive( p_libvlc ) )
274 vlc_object_unlock( p_libvlc );
277 vlc_object_wait( p_libvlc );
279 vlc_object_unlock( p_libvlc );
281 /* Someone killed libvlc */
283 /* Make sure we kill all interface objects, especially
284 * those that are blocking libvlc (running on main thread) */
285 vlc_list_t * p_list = vlc_list_find( p_libvlc, VLC_OBJECT_INTF, FIND_CHILD );
286 for( int i = 0; i < p_list->i_count; i++ )
288 vlc_object_t * p_intf = p_list->p_values[i].p_object;
289 vlc_object_kill( p_intf );
291 vlc_list_release( p_list );
295 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
296 vlc_value_t oldval, vlc_value_t newval, void *p_data )
298 intf_thread_t *p_intf;
299 char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
301 (void)psz_cmd; (void)oldval; (void)p_data;
303 /* Try to create the interface */
304 sprintf( psz_intf, "%s,none", newval.psz_string );
305 p_intf = intf_Create( p_this->p_libvlc, psz_intf );
309 msg_Err( p_this, "interface \"%s\" initialization failed",
314 /* Try to run the interface */
315 if( intf_RunThread( p_intf ) != VLC_SUCCESS )
317 vlc_object_detach( p_intf );
318 vlc_object_release( p_intf );