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 *****************************************************************************/
45 #include "vlc_interface.h"
46 #include "modules/modules.h" // Gruik!
49 /*****************************************************************************
51 *****************************************************************************/
52 static void RunInterface( intf_thread_t *p_intf );
54 static int AddIntfCallback( vlc_object_t *, char const *,
55 vlc_value_t , vlc_value_t , void * );
58 * \brief Destroy the interface after the main loop endeed.
60 * \param p_intf the interface thread
63 static void intf_Destroy( vlc_object_t *obj )
65 intf_thread_t *p_intf = (intf_thread_t *)obj;
67 /* Unlock module if present (a switch may have failed) */
68 if( p_intf->p_module )
69 module_Unneed( p_intf, p_intf->p_module );
71 free( p_intf->psz_intf );
72 vlc_mutex_destroy( &p_intf->change_lock );
75 /*****************************************************************************
76 * intf_Create: prepare interface before main loop
77 *****************************************************************************
78 * This function opens output devices and creates specific interfaces. It sends
79 * its own error messages.
80 *****************************************************************************/
82 * Create the interface, and prepare it for main loop.
83 * You can give some additional options to be used for interface initialization
85 * \param p_this the calling vlc_object_t
86 * \param psz_module a preferred interface module
87 * \param i_options number additional options
88 * \param ppsz_options additional option strings
89 * \return a pointer to the created interface thread, NULL on error
91 intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module,
92 int i_options, const char *const *ppsz_options )
94 intf_thread_t * p_intf;
97 /* Allocate structure */
98 p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
101 msg_Err( p_this, "out of memory" );
104 p_intf->pf_request_window = NULL;
105 p_intf->pf_release_window = NULL;
106 p_intf->pf_control_window = NULL;
107 p_intf->b_play = false;
108 p_intf->b_interaction = false;
109 p_intf->b_should_run_on_first_thread = false;
111 for( i = 0 ; i< i_options; i++ )
112 var_OptionParse( p_this, ppsz_options[i], true );
114 /* Choose the best module */
115 p_intf->psz_intf = strdup( psz_module );
116 p_intf->p_module = module_Need( p_intf, "interface", psz_module, false );
118 if( p_intf->p_module == NULL )
120 msg_Err( p_intf, "no suitable interface module" );
121 free( p_intf->psz_intf );
122 vlc_object_release( p_intf );
126 /* Initialize structure */
127 p_intf->b_menu = false;
128 p_intf->b_menu_change = false;
130 /* Initialize mutexes */
131 vlc_mutex_init( &p_intf->change_lock );
133 /* Attach interface to its parent object */
134 vlc_object_attach( p_intf, p_this );
135 vlc_object_set_destructor( p_intf, intf_Destroy );
140 /*****************************************************************************
141 * intf_RunThread: launch the interface thread
142 *****************************************************************************
143 * This function either creates a new thread and runs the interface in it.
144 *****************************************************************************/
146 * Starts and runs the interface thread.
148 * \param p_intf the interface thread
149 * \return VLC_SUCCESS on success, an error number else
151 int intf_RunThread( intf_thread_t *p_intf )
153 /* Hack to get Mac OS X Cocoa runtime running
154 * (it needs access to the main thread) */
155 if( p_intf->b_should_run_on_first_thread )
157 RunInterface( p_intf );
158 vlc_object_detach( p_intf );
159 vlc_object_release( p_intf );
163 /* Run the interface in a separate thread */
164 if( vlc_thread_create( p_intf, "interface", RunInterface,
165 VLC_THREAD_PRIORITY_LOW, false ) )
167 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
181 void intf_StopThread( intf_thread_t *p_intf )
183 /* Tell the interface to die */
184 vlc_object_kill( p_intf );
185 vlc_cond_signal( &p_intf->object_wait );
186 vlc_thread_join( p_intf );
189 /* Following functions are local */
191 /*****************************************************************************
192 * RunInterface: setups necessary data and give control to the interface
193 *****************************************************************************/
194 static void RunInterface( intf_thread_t *p_intf )
196 vlc_value_t val, text;
199 /* Variable used for interface spawning */
200 var_Create( p_intf, "intf-add", VLC_VAR_STRING |
201 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
202 text.psz_string = _("Add Interface");
203 var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
205 val.psz_string = (char *)"rc"; text.psz_string = (char *)"Console";
206 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
207 val.psz_string = (char *)"telnet";
208 text.psz_string = (char *)_("Telnet Interface");
209 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
210 val.psz_string = (char *)"http";
211 text.psz_string = (char *)_("Web Interface");
212 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
213 val.psz_string = (char *)"logger";
214 text.psz_string = (char *)_("Debug logging");
215 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
216 val.psz_string = (char *)"gestures";
217 text.psz_string = (char *)_("Mouse Gestures");
218 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
220 var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
224 /* Give control to the interface */
226 p_intf->pf_run( p_intf );
228 while( vlc_object_lock_and_wait( p_intf ) == 0 );
230 /* Reset play on start status */
231 p_intf->b_play = false;
233 if( !p_intf->psz_switch_intf )
238 /* Make sure the old interface is completely uninitialized */
239 module_Unneed( p_intf, p_intf->p_module );
241 /* Provide ability to switch the main interface on the fly */
242 psz_intf = p_intf->psz_switch_intf;
243 p_intf->psz_switch_intf = NULL;
245 vlc_mutex_lock( &p_intf->object_lock );
246 p_intf->b_die = false; /* FIXME */
247 p_intf->b_dead = false;
249 vlc_mutex_unlock( &p_intf->object_lock );
251 p_intf->psz_intf = psz_intf;
252 p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
254 while( p_intf->p_module );
257 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
258 vlc_value_t oldval, vlc_value_t newval, void *p_data )
260 intf_thread_t *p_intf;
261 char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
263 (void)psz_cmd; (void)oldval; (void)p_data;
265 /* Try to create the interface */
266 sprintf( psz_intf, "%s,none", newval.psz_string );
267 p_intf = intf_Create( p_this->p_libvlc, psz_intf, 0, NULL );
271 msg_Err( p_this, "interface \"%s\" initialization failed",
276 /* Try to run the interface */
277 if( intf_RunThread( p_intf ) != VLC_SUCCESS )
279 vlc_object_detach( p_intf );
280 vlc_object_release( p_intf );