git.sesse.net Git - vlc/blob - src/interface/interface.c

   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
   7  * $Id$
   8  *
   9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  10  *
  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.
  15  *
  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.
  20  *
  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  *****************************************************************************/
  25
  26 /**
  27  *   \file
  28  *   This file contains functions related to interface management
  29  */
  30
  31
  32 /*****************************************************************************
  33  * Preamble
  34  *****************************************************************************/
  35
  36 #include <vlc/vlc.h>
  37
  38 #include <vlc_aout.h>
  39 #include <vlc_vout.h>
  40
  41 #include "vlc_interface.h"
  42 #include "modules/modules.h" // Gruik!
  43
  44 /*****************************************************************************
  45  * Local prototypes
  46  *****************************************************************************/
  47 static void RunInterface( intf_thread_t *p_intf );
  48
  49 static int SwitchIntfCallback( vlc_object_t *, char const *,
  50                                vlc_value_t , vlc_value_t , void * );
  51 static int AddIntfCallback( vlc_object_t *, char const *,
  52                             vlc_value_t , vlc_value_t , void * );
  53
  54 /*****************************************************************************
  55  * intf_Create: prepare interface before main loop
  56  *****************************************************************************
  57  * This function opens output devices and creates specific interfaces. It sends
  58  * its own error messages.
  59  *****************************************************************************/
  60 /**
  61  * Create the interface, and prepare it for main loop.
  62  * You can give some additional options to be used for interface initialization
  63  *
  64  * \param p_this the calling vlc_object_t
  65  * \param psz_module a preferred interface module
  66  * \param i_options number additional options
  67  * \param ppsz_options additional option strings
  68  * \return a pointer to the created interface thread, NULL on error
  69  */
  70 intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module,
  71                               int i_options, const char *const *ppsz_options  )
  72 {
  73     intf_thread_t * p_intf;
  74     int i;
  75
  76     /* Allocate structure */
  77     p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
  78     if( !p_intf )
  79     {
  80         msg_Err( p_this, "out of memory" );
  81         return NULL;
  82     }
  83     p_intf->pf_request_window = NULL;
  84     p_intf->pf_release_window = NULL;
  85     p_intf->pf_control_window = NULL;
  86     p_intf->b_play = VLC_FALSE;
  87     p_intf->b_interaction = VLC_FALSE;
  88
  89     for( i = 0 ; i< i_options; i++ )
  90     {
  91         var_OptionParse( p_intf, ppsz_options[i] );
  92     }
  93
  94     /* Choose the best module */
  95     p_intf->p_module = module_Need( p_intf, "interface", psz_module, VLC_FALSE );
  96
  97     if( p_intf->p_module == NULL )
  98     {
  99         msg_Err( p_intf, "no suitable interface module" );
 100         vlc_object_destroy( p_intf );
 101         return NULL;
 102     }
 103
 104     /* Initialize structure */
 105     p_intf->b_menu        = VLC_FALSE;
 106     p_intf->b_menu_change = VLC_FALSE;
 107
 108     /* Initialize mutexes */
 109     vlc_mutex_init( p_intf, &p_intf->change_lock );
 110
 111     /* Attach interface to its parent object */
 112     vlc_object_attach( p_intf, p_this );
 113
 114     return p_intf;
 115 }
 116
 117 /*****************************************************************************
 118  * intf_RunThread: launch the interface thread
 119  *****************************************************************************
 120  * This function either creates a new thread and runs the interface in it.
 121  *****************************************************************************/
 122 /**
 123  * Starts and runs the interface thread.
 124  *
 125  * \param p_intf the interface thread
 126  * \return VLC_SUCCESS on success, an error number else
 127  */
 128 int intf_RunThread( intf_thread_t *p_intf )
 129 {
 130     /* This interface doesn't need to be run */
 131     if( p_intf->pf_run == NULL )
 132         return VLC_SUCCESS;
 133
 134     /* Hack to get Mac OS X Cocoa runtime running
 135      * (it needs access to the main thread) */
 136     if( p_intf->b_should_run_on_first_thread )
 137     {
 138         RunInterface( p_intf );
 139         return VLC_SUCCESS;
 140     }
 141
 142     /* Run the interface in a separate thread */
 143     if( vlc_thread_create( p_intf, "interface", RunInterface,
 144                            VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
 145     {
 146         msg_Err( p_intf, "cannot spawn interface thread" );
 147         return VLC_EGENERIC;
 148     }
 149
 150     return VLC_SUCCESS;
 151 }
 152
 153 /**
 154  * Stops the interface thread
 155  *
 156  * This function asks the interface thread to stop
 157  * \param p_intf the interface thread
 158  * \return nothing
 159  */
 160 void intf_StopThread( intf_thread_t *p_intf )
 161 {
 162     /* Tell the interface to die */
 163     vlc_object_kill( p_intf );
 164     if( p_intf->pf_run != NULL )
 165     {
 166         vlc_cond_signal( &p_intf->object_wait );
 167         vlc_thread_join( p_intf );
 168     }
 169 }
 170
 171 /**
 172  * \brief Destroy the interface after the main loop endeed.
 173  *
 174  * Destroys interfaces and closes output devices
 175  * \param p_intf the interface thread
 176  * \return nothing
 177  */
 178 void intf_Destroy( intf_thread_t *p_intf )
 179 {
 180     /* Unlock module if present (a switch may have failed) */
 181     if( p_intf->p_module )
 182     {
 183         module_Unneed( p_intf, p_intf->p_module );
 184     }
 185
 186     vlc_mutex_destroy( &p_intf->change_lock );
 187
 188     /* Free structure */
 189     vlc_object_destroy( p_intf );
 190 }
 191
 192
 193 /* Following functions are local */
 194
 195 /*****************************************************************************
 196  * RunInterface: setups necessary data and give control to the interface
 197  *****************************************************************************/
 198 static void RunInterface( intf_thread_t *p_intf )
 199 {
 200     static const char *ppsz_interfaces[] =
 201     {
 202         "skins2", "Skins 2",
 203 #ifndef WIN32
 204         "wxwidgets", "wxWidgets",
 205 #endif
 206         NULL, NULL
 207     };
 208     const char **ppsz_parser;
 209
 210     vlc_list_t *p_list;
 211     int i;
 212     vlc_value_t val, text;
 213     char *psz_intf;
 214
 215     /* Variable used for interface switching */
 216     p_intf->psz_switch_intf = NULL;
 217     var_Create( p_intf, "intf-switch", VLC_VAR_STRING |
 218                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 219     text.psz_string = _("Switch interface");
 220     var_Change( p_intf, "intf-switch", VLC_VAR_SETTEXT, &text, NULL );
 221
 222     /* Only fill the list with available modules */
 223     p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
 224     for( ppsz_parser = ppsz_interfaces; *ppsz_parser; ppsz_parser += 2 )
 225     {
 226         for( i = 0; i < p_list->i_count; i++ )
 227         {
 228             module_t *p_module = (module_t *)p_list->p_values[i].p_object;
 229             if( !strcmp( p_module->psz_object_name, ppsz_parser[0] ) )
 230             {
 231                 val.psz_string = (char *)ppsz_parser[0];
 232                 text.psz_string = (char *)_(ppsz_parser[1]);
 233                 var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE,
 234                             &val, &text );
 235                 break;
 236             }
 237         }
 238     }
 239     vlc_list_release( p_list );
 240
 241     var_AddCallback( p_intf, "intf-switch", SwitchIntfCallback, NULL );
 242
 243     /* Variable used for interface spawning */
 244     var_Create( p_intf, "intf-add", VLC_VAR_STRING |
 245                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 246     text.psz_string = _("Add Interface");
 247     var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
 248
 249     val.psz_string = (char *)"rc"; text.psz_string = (char *)"Console";
 250     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 251     val.psz_string = (char *)"telnet";
 252     text.psz_string = (char *)_("Telnet Interface");
 253     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 254     val.psz_string = (char *)"http";
 255     text.psz_string = (char *)_("Web Interface");
 256     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 257     val.psz_string = (char *)"logger";
 258     text.psz_string = (char *)_("Debug logging");
 259     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 260     val.psz_string = (char *)"gestures";
 261     text.psz_string = (char *)_("Mouse Gestures");
 262     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 263
 264     var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
 265
 266     do
 267     {
 268         /* Give control to the interface */
 269         p_intf->pf_run( p_intf );
 270
 271         /* Reset play on start status */
 272         p_intf->b_play = VLC_FALSE;
 273
 274         if( !p_intf->psz_switch_intf )
 275         {
 276             break;
 277         }
 278
 279         /* Make sure the old interface is completely uninitialized */
 280         module_Unneed( p_intf, p_intf->p_module );
 281
 282         /* Provide ability to switch the main interface on the fly */
 283         psz_intf = p_intf->psz_switch_intf;
 284         p_intf->psz_switch_intf = NULL;
 285
 286         vlc_mutex_lock( &p_intf->object_lock );
 287         p_intf->b_die = VLC_FALSE; /* FIXME */
 288         p_intf->b_dead = VLC_FALSE;
 289         p_intf->b_should_run_on_first_thread = VLC_FALSE;
 290
 291         vlc_mutex_unlock( &p_intf->object_lock );
 292
 293         p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
 294         free( psz_intf );
 295     }
 296     while( p_intf->p_module );
 297 }
 298
 299 static int SwitchIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 300                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 301 {
 302     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 303     (void)psz_cmd; (void)oldval; (void)p_data;
 304
 305     p_intf->psz_switch_intf =
 306         malloc( strlen(newval.psz_string) + sizeof(",none") );
 307     sprintf( p_intf->psz_switch_intf, "%s,none", newval.psz_string );
 308     vlc_object_kill( p_intf );
 309
 310     return VLC_SUCCESS;
 311 }
 312
 313 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 314                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 315 {
 316     intf_thread_t *p_intf;
 317     char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
 318
 319     (void)psz_cmd; (void)oldval; (void)p_data;
 320
 321     /* Try to create the interface */
 322     sprintf( psz_intf, "%s,none", newval.psz_string );
 323     p_intf = intf_Create( p_this->p_libvlc, psz_intf, 0, NULL );
 324     free( psz_intf );
 325     if( p_intf == NULL )
 326     {
 327         msg_Err( p_this, "interface \"%s\" initialization failed",
 328                  newval.psz_string );
 329         return VLC_EGENERIC;
 330     }
 331
 332     /* Try to run the interface */
 333     if( intf_RunThread( p_intf ) != VLC_SUCCESS )
 334     {
 335         vlc_object_detach( p_intf );
 336         intf_Destroy( p_intf );
 337         return VLC_EGENERIC;
 338     }
 339
 340     return VLC_SUCCESS;
 341 }
 342