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"
48 /*****************************************************************************
50 *****************************************************************************/
51 static void* RunInterface( vlc_object_t *p_this );
52 #if defined( __APPLE__ ) || defined( WIN32 )
53 static void * MonitorLibVLCDeath( vlc_object_t *p_this );
55 static int AddIntfCallback( vlc_object_t *, char const *,
56 vlc_value_t , vlc_value_t , void * );
59 * \brief Destroy the interface after the main loop endeed.
61 * \param p_intf the interface thread
64 static void intf_Destroy( vlc_object_t *obj )
66 intf_thread_t *p_intf = (intf_thread_t *)obj;
68 /* Unlock module if present (a switch may have failed) */
69 if( p_intf->p_module )
70 module_Unneed( p_intf, p_intf->p_module );
72 free( p_intf->psz_intf );
73 vlc_mutex_destroy( &p_intf->change_lock );
76 /*****************************************************************************
77 * intf_Create: prepare interface before main loop
78 *****************************************************************************
79 * This function opens output devices and creates specific interfaces. It sends
80 * its own error messages.
81 *****************************************************************************/
83 * Create the interface, and prepare it for main loop.
85 * \param p_this the calling vlc_object_t
86 * \param psz_module a preferred interface module
87 * \return a pointer to the created interface thread, NULL on error
89 intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module )
91 intf_thread_t * p_intf;
93 /* Allocate structure */
94 p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
97 p_intf->b_interaction = false;
98 #if defined( __APPLE__ ) || defined( WIN32 )
99 p_intf->b_should_run_on_first_thread = false;
102 /* Choose the best module */
103 p_intf->psz_intf = strdup( psz_module );
104 p_intf->p_module = module_Need( p_intf, "interface", psz_module, false );
106 if( p_intf->p_module == NULL )
108 msg_Err( p_intf, "no suitable interface module" );
109 free( p_intf->psz_intf );
110 vlc_object_release( p_intf );
114 /* Initialize structure */
115 p_intf->b_menu = false;
116 p_intf->b_menu_change = false;
118 /* Initialize mutexes */
119 vlc_mutex_init( &p_intf->change_lock );
121 /* Attach interface to its parent object */
122 vlc_object_attach( p_intf, p_this );
123 vlc_object_set_destructor( p_intf, intf_Destroy );
128 /*****************************************************************************
129 * intf_RunThread: launch the interface thread
130 *****************************************************************************
131 * This function either creates a new thread and runs the interface in it.
132 *****************************************************************************/
134 * Starts and runs the interface thread.
136 * \param p_intf the interface thread
137 * \return VLC_SUCCESS on success, an error number else
139 int intf_RunThread( intf_thread_t *p_intf )
141 #if defined( __APPLE__ ) || defined( WIN32 )
142 /* Hack to get Mac OS X Cocoa runtime running
143 * (it needs access to the main thread) */
144 if( p_intf->b_should_run_on_first_thread )
146 if( vlc_thread_create( p_intf, "interface", MonitorLibVLCDeath,
147 VLC_THREAD_PRIORITY_LOW, false ) )
149 msg_Err( p_intf, "cannot spawn libvlc death monitoring thread" );
152 RunInterface( VLC_OBJECT(p_intf) );
154 /* Make sure our MonitorLibVLCDeath thread exit */
155 vlc_object_kill( p_intf );
156 /* It is monitoring libvlc, not the p_intf */
157 vlc_object_signal( p_intf->p_libvlc );
158 vlc_thread_join( p_intf );
160 vlc_object_detach( p_intf );
161 vlc_object_release( p_intf );
165 /* Run the interface in a separate thread */
166 if( vlc_thread_create( p_intf, "interface", RunInterface,
167 VLC_THREAD_PRIORITY_LOW, false ) )
169 msg_Err( p_intf, "cannot spawn interface thread" );
177 * Stops the interface thread
179 * This function asks the interface thread to stop
180 * \param p_intf the interface thread
183 void intf_StopThread( intf_thread_t *p_intf )
185 /* Tell the interface to die */
186 vlc_object_kill( p_intf );
187 vlc_thread_join( p_intf );
190 /* Following functions are local */
192 /*****************************************************************************
193 * RunInterface: setups necessary data and give control to the interface
194 *****************************************************************************/
195 static void* RunInterface( vlc_object_t *p_this )
197 intf_thread_t *p_intf = (intf_thread_t *)p_this;
198 vlc_value_t val, text;
199 int canc = vlc_savecancel ();
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 );
224 vlc_restorecancel (canc);
226 /* Give control to the interface */
228 p_intf->pf_run( p_intf );
233 #if defined( __APPLE__ ) || defined( WIN32 )
234 /*****************************************************************************
235 * MonitorLibVLCDeath: Used when b_should_run_on_first_thread is set.
236 *****************************************************************************/
237 static void * MonitorLibVLCDeath( vlc_object_t * p_this )
239 intf_thread_t *p_intf = (intf_thread_t *)p_this;
240 libvlc_int_t * p_libvlc = p_intf->p_libvlc;
241 int canc = vlc_savecancel ();
243 vlc_object_lock( p_libvlc );
244 while(vlc_object_alive( p_libvlc ) )
248 vlc_object_unlock( p_libvlc );
251 vlc_object_wait( p_libvlc );
253 vlc_object_unlock( p_libvlc );
255 /* Someone killed libvlc */
257 /* Make sure we kill all interface objects, especially
258 * those that are blocking libvlc (running on main thread) */
259 vlc_list_t * p_list = vlc_list_find( p_libvlc, VLC_OBJECT_INTF, FIND_CHILD );
260 for( int i = 0; i < p_list->i_count; i++ )
262 vlc_object_t * p_intf = p_list->p_values[i].p_object;
263 vlc_object_kill( p_intf );
265 vlc_list_release( p_list );
266 vlc_restorecancel (canc);
271 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
272 vlc_value_t oldval, vlc_value_t newval, void *p_data )
274 intf_thread_t *p_intf;
275 char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
277 (void)psz_cmd; (void)oldval; (void)p_data;
279 /* Try to create the interface */
280 sprintf( psz_intf, "%s,none", newval.psz_string );
281 p_intf = intf_Create( p_this->p_libvlc, psz_intf );
285 msg_Err( p_this, "interface \"%s\" initialization failed",
290 /* Try to run the interface */
291 if( intf_RunThread( p_intf ) != VLC_SUCCESS )
293 vlc_object_detach( p_intf );
294 vlc_object_release( p_intf );