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-2004 VideoLAN
   7  * $Id: interface.c,v 1.114 2004/03/03 20:39:53 gbazin Exp $
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /**
  27  *   \file
  28  *   This file contains functions related to interface management
  29  */
  30
  31
  32 /*****************************************************************************
  33  * Preamble
  34  *****************************************************************************/
  35 #include <stdlib.h>                                      /* free(), strtol() */
  36 #include <stdio.h>                                                   /* FILE */
  37 #include <string.h>                                            /* strerror() */
  38
  39 #include <vlc/vlc.h>
  40
  41 #include "stream_control.h"
  42 #include "input_ext-intf.h"
  43
  44 #include "audio_output.h"
  45
  46 #include "vlc_interface.h"
  47
  48 #include "vlc_video.h"
  49 #include "video_output.h"
  50
  51 /*****************************************************************************
  52  * Local prototypes
  53  *****************************************************************************/
  54 static void Manager( intf_thread_t *p_intf );
  55 static void RunInterface( intf_thread_t *p_intf );
  56
  57 static int SwitchIntfCallback( vlc_object_t *, char const *,
  58                                vlc_value_t , vlc_value_t , void * );
  59 static int AddIntfCallback( vlc_object_t *, char const *,
  60                             vlc_value_t , vlc_value_t , void * );
  61
  62 /*****************************************************************************
  63  * intf_Create: prepare interface before main loop
  64  *****************************************************************************
  65  * This function opens output devices and creates specific interfaces. It sends
  66  * its own error messages.
  67  *****************************************************************************/
  68 /**
  69  * Create the interface, and prepare it for main loop.
  70  *
  71  * \param p_this the calling vlc_object_t
  72  * \param psz_module a prefered interface module
  73  * \return a pointer to the created interface thread, NULL on error
  74  */
  75 intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module )
  76 {
  77     intf_thread_t * p_intf;
  78     char *psz_intf;
  79
  80     /* Allocate structure */
  81     p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
  82     if( !p_intf )
  83     {
  84         msg_Err( p_this, "out of memory" );
  85         return NULL;
  86     }
  87
  88     /* XXX: workaround for a bug in VLC 0.5.0 where the dvdplay plugin was
  89      * registering itself in $interface, which we do not want to happen. */
  90     psz_intf = config_GetPsz( p_intf, "intf" );
  91     if( psz_intf )
  92     {
  93         if( !strcasecmp( psz_intf, "dvdplay" ) )
  94         {
  95             config_PutPsz( p_intf, "intf", "" );
  96         }
  97         free( psz_intf );
  98     }
  99
 100     /* Choose the best module */
 101     p_intf->p_module = module_Need( p_intf, "interface", psz_module, 0 );
 102
 103     if( p_intf->p_module == NULL )
 104     {
 105         msg_Err( p_intf, "no suitable intf module" );
 106         vlc_object_destroy( p_intf );
 107         return NULL;
 108     }
 109
 110     /* Initialize structure */
 111     p_intf->b_menu        = VLC_FALSE;
 112     p_intf->b_menu_change = VLC_FALSE;
 113
 114     /* Initialize mutexes */
 115     vlc_mutex_init( p_intf, &p_intf->change_lock );
 116
 117     msg_Dbg( p_intf, "interface initialized" );
 118
 119     /* Attach interface to its parent object */
 120     vlc_object_attach( p_intf, p_this );
 121
 122     return p_intf;
 123 }
 124
 125 /*****************************************************************************
 126  * intf_RunThread: launch the interface thread
 127  *****************************************************************************
 128  * This function either creates a new thread and runs the interface in it,
 129  * or runs the interface in the current thread, depending on b_block.
 130  *****************************************************************************/
 131 /**
 132  * Run the interface thread.
 133  *
 134  * If b_block is not set, runs the interface in the thread, else,
 135  * creates a new thread and runs the interface.
 136  * \param p_intf the interface thread
 137  * \return VLC_SUCCESS on success, an error number else
 138  */
 139 int intf_RunThread( intf_thread_t *p_intf )
 140 {
 141     if( p_intf->b_block )
 142     {
 143         /* Run a manager thread, launch the interface, kill the manager */
 144         if( vlc_thread_create( p_intf, "manager", Manager,
 145                                VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
 146         {
 147             msg_Err( p_intf, "cannot spawn manager thread" );
 148             return VLC_EGENERIC;
 149         }
 150
 151         RunInterface( p_intf );
 152
 153         p_intf->b_die = VLC_TRUE;
 154
 155         /* Do not join the thread... intf_StopThread will do it for us */
 156     }
 157     else
 158     {
 159         /* Run the interface in a separate thread */
 160         if( vlc_thread_create( p_intf, "interface", RunInterface,
 161                                VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
 162         {
 163             msg_Err( p_intf, "cannot spawn interface thread" );
 164             return VLC_EGENERIC;
 165         }
 166     }
 167
 168     return VLC_SUCCESS;
 169 }
 170
 171 /**
 172  * Stops the interface thread
 173  *
 174  * This function asks the interface thread to stop
 175  * \param p_intf the interface thread
 176  * \return nothing
 177  */
 178 void intf_StopThread( intf_thread_t *p_intf )
 179 {
 180     /* Tell the interface to die */
 181     if( !p_intf->b_block )
 182     {
 183         p_intf->b_die = VLC_TRUE;
 184     }
 185
 186     /* Wait for the thread to exit */
 187     vlc_thread_join( p_intf );
 188 }
 189
 190 /**
 191  * \brief Destroy the interface after the main loop endeed.
 192  *
 193  * Destroys interfaces and closes output devices
 194  * \param p_intf the interface thread
 195  * \return nothing
 196  */
 197 void intf_Destroy( intf_thread_t *p_intf )
 198 {
 199     /* Unlock module */
 200     module_Unneed( p_intf, p_intf->p_module );
 201
 202     vlc_mutex_destroy( &p_intf->change_lock );
 203
 204     /* Free structure */
 205     vlc_object_destroy( p_intf );
 206 }
 207
 208
 209 /* Following functions are local */
 210
 211 /*****************************************************************************
 212  * Manager: helper thread for blocking interfaces
 213  *****************************************************************************
 214  * If the interface is launched in the main thread, it will not listen to
 215  * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die.
 216  * This thread takes care of the matter.
 217  *****************************************************************************/
 218 /**
 219  * \brief Helper thread for blocking interfaces.
 220  * \ingroup vlc_interface
 221  *
 222  * This is a local function
 223  * If the interface is launched in the main thread, it will not listen to
 224  * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die.
 225  * This thread takes care of the matter.
 226  * \see intf_RunThread
 227  * \param p_intf an interface thread
 228  * \return nothing
 229  */
 230 static void Manager( intf_thread_t *p_intf )
 231 {
 232     while( !p_intf->b_die )
 233     {
 234         msleep( INTF_IDLE_SLEEP );
 235
 236         if( p_intf->p_vlc->b_die )
 237         {
 238             p_intf->b_die = VLC_TRUE;
 239             return;
 240         }
 241     }
 242 }
 243
 244 /*****************************************************************************
 245  * RunInterface: setups necessary data and give control to the interface
 246  *****************************************************************************/
 247 static void RunInterface( intf_thread_t *p_intf )
 248 {
 249     vlc_value_t val, text;
 250
 251     /* Variable used for interface switching */
 252     p_intf->psz_switch_intf = NULL;
 253     var_Create( p_intf, "intf-switch", VLC_VAR_STRING |
 254                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 255     text.psz_string = _("Switch interface");
 256     var_Change( p_intf, "intf-switch", VLC_VAR_SETTEXT, &text, NULL );
 257
 258     val.psz_string = "skins"; text.psz_string = "Skins";
 259     var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE, &val, &text );
 260     val.psz_string = "skins2"; text.psz_string = "Skins 2";
 261     var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE, &val, &text );
 262     val.psz_string = "wxwin"; text.psz_string = "wxWindows";
 263     var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE, &val, &text );
 264
 265     var_AddCallback( p_intf, "intf-switch", SwitchIntfCallback, NULL );
 266
 267     /* Variable used for interface spawning */
 268     var_Create( p_intf, "intf-add", VLC_VAR_STRING |
 269                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 270     text.psz_string = _("Add interface");
 271     var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
 272
 273     val.psz_string = "rc"; text.psz_string = "Console";
 274     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 275     val.psz_string = "logger"; text.psz_string = "Debug logging";
 276     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 277     val.psz_string = "http"; text.psz_string = "HTTP remote control";
 278     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 279     val.psz_string = "sap"; text.psz_string = "SAP interface";
 280     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 281     val.psz_string = "gestures"; text.psz_string = "Mouse gestures control";
 282     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 283
 284     var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
 285
 286     /* Give control to the interface */
 287     p_intf->pf_run( p_intf );
 288
 289     /* Provide ability to switch the main interface on the fly */
 290     while( p_intf->psz_switch_intf )
 291     {
 292         char *psz_intf = p_intf->psz_switch_intf;
 293         p_intf->psz_switch_intf = NULL;
 294         p_intf->b_die = VLC_FALSE;
 295
 296         /* Make sure the old interface is completely uninitialised */
 297         module_Unneed( p_intf, p_intf->p_module );
 298
 299         p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
 300         free( psz_intf );
 301
 302         if( p_intf->p_module )
 303         {
 304             p_intf->pf_run( p_intf );
 305         }
 306         else break;
 307     }
 308 }
 309
 310 static int SwitchIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 311                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 312 {
 313     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 314
 315     p_intf->psz_switch_intf =
 316         malloc( strlen(newval.psz_string) + sizeof(",none") );
 317     sprintf( p_intf->psz_switch_intf, "%s,none", newval.psz_string );
 318     p_intf->b_die = VLC_TRUE;
 319
 320     return VLC_SUCCESS;
 321 }
 322
 323 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 324                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 325 {
 326     intf_thread_t *p_intf;
 327     char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
 328
 329     /* Try to create the interface */
 330     sprintf( psz_intf, "%s,none", newval.psz_string );
 331     p_intf = intf_Create( p_this->p_vlc, psz_intf );
 332     free( psz_intf );
 333     if( p_intf == NULL )
 334     {
 335         msg_Err( p_this, "interface \"%s\" initialization failed",
 336                  newval.psz_string );
 337         return VLC_EGENERIC;
 338     }
 339
 340     /* Try to run the interface */
 341     p_intf->b_block = VLC_FALSE;
 342     if( intf_RunThread( p_intf ) != VLC_SUCCESS )
 343     {
 344         vlc_object_detach( p_intf );
 345         intf_Destroy( p_intf );
 346         return VLC_EGENERIC;
 347     }
 348
 349     return VLC_SUCCESS;
 350 }