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$
   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
  79     /* Allocate structure */
  80     p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
  81     if( !p_intf )
  82     {
  83         msg_Err( p_this, "out of memory" );
  84         return NULL;
  85     }
  86     p_intf->pf_request_window = NULL;
  87     p_intf->pf_release_window = NULL;
  88
  89     /* Choose the best module */
  90     p_intf->p_module = module_Need( p_intf, "interface", psz_module, 0 );
  91
  92     if( p_intf->p_module == NULL )
  93     {
  94         msg_Err( p_intf, "no suitable intf module" );
  95         vlc_object_destroy( p_intf );
  96         return NULL;
  97     }
  98
  99     /* Initialize structure */
 100     p_intf->b_menu        = VLC_FALSE;
 101     p_intf->b_menu_change = VLC_FALSE;
 102
 103     /* Initialize mutexes */
 104     vlc_mutex_init( p_intf, &p_intf->change_lock );
 105
 106     msg_Dbg( p_intf, "interface initialized" );
 107
 108     /* Attach interface to its parent object */
 109     vlc_object_attach( p_intf, p_this );
 110
 111     return p_intf;
 112 }
 113
 114 /*****************************************************************************
 115  * intf_RunThread: launch the interface thread
 116  *****************************************************************************
 117  * This function either creates a new thread and runs the interface in it,
 118  * or runs the interface in the current thread, depending on b_block.
 119  *****************************************************************************/
 120 /**
 121  * Run the interface thread.
 122  *
 123  * If b_block is not set, runs the interface in the thread, else,
 124  * creates a new thread and runs the interface.
 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     if( p_intf->b_block )
 131     {
 132         /* Run a manager thread, launch the interface, kill the manager */
 133         if( vlc_thread_create( p_intf, "manager", Manager,
 134                                VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
 135         {
 136             msg_Err( p_intf, "cannot spawn manager thread" );
 137             return VLC_EGENERIC;
 138         }
 139
 140         RunInterface( p_intf );
 141
 142         p_intf->b_die = VLC_TRUE;
 143
 144         /* Do not join the thread... intf_StopThread will do it for us */
 145     }
 146     else
 147     {
 148         /* Run the interface in a separate thread */
 149         if( vlc_thread_create( p_intf, "interface", RunInterface,
 150                                VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
 151         {
 152             msg_Err( p_intf, "cannot spawn interface thread" );
 153             return VLC_EGENERIC;
 154         }
 155     }
 156
 157     return VLC_SUCCESS;
 158 }
 159
 160 /**
 161  * Stops the interface thread
 162  *
 163  * This function asks the interface thread to stop
 164  * \param p_intf the interface thread
 165  * \return nothing
 166  */
 167 void intf_StopThread( intf_thread_t *p_intf )
 168 {
 169     /* Tell the interface to die */
 170     if( !p_intf->b_block )
 171     {
 172         p_intf->b_die = VLC_TRUE;
 173     }
 174
 175     /* Wait for the thread to exit */
 176     vlc_thread_join( p_intf );
 177 }
 178
 179 /**
 180  * \brief Destroy the interface after the main loop endeed.
 181  *
 182  * Destroys interfaces and closes output devices
 183  * \param p_intf the interface thread
 184  * \return nothing
 185  */
 186 void intf_Destroy( intf_thread_t *p_intf )
 187 {
 188     /* Unlock module */
 189     module_Unneed( p_intf, p_intf->p_module );
 190
 191     vlc_mutex_destroy( &p_intf->change_lock );
 192
 193     /* Free structure */
 194     vlc_object_destroy( p_intf );
 195 }
 196
 197
 198 /* Following functions are local */
 199
 200 /*****************************************************************************
 201  * Manager: helper thread for blocking interfaces
 202  *****************************************************************************
 203  * If the interface is launched in the main thread, it will not listen to
 204  * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die.
 205  * This thread takes care of the matter.
 206  *****************************************************************************/
 207 /**
 208  * \brief Helper thread for blocking interfaces.
 209  * \ingroup vlc_interface
 210  *
 211  * This is a local function
 212  * If the interface is launched in the main thread, it will not listen to
 213  * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die.
 214  * This thread takes care of the matter.
 215  * \see intf_RunThread
 216  * \param p_intf an interface thread
 217  * \return nothing
 218  */
 219 static void Manager( intf_thread_t *p_intf )
 220 {
 221     while( !p_intf->b_die )
 222     {
 223         msleep( INTF_IDLE_SLEEP );
 224
 225         if( p_intf->p_vlc->b_die )
 226         {
 227             p_intf->b_die = VLC_TRUE;
 228             return;
 229         }
 230     }
 231 }
 232
 233 /*****************************************************************************
 234  * RunInterface: setups necessary data and give control to the interface
 235  *****************************************************************************/
 236 static void RunInterface( intf_thread_t *p_intf )
 237 {
 238     vlc_value_t val, text;
 239
 240     /* Variable used for interface switching */
 241     p_intf->psz_switch_intf = NULL;
 242     var_Create( p_intf, "intf-switch", VLC_VAR_STRING |
 243                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 244     text.psz_string = _("Switch interface");
 245     var_Change( p_intf, "intf-switch", VLC_VAR_SETTEXT, &text, NULL );
 246
 247     val.psz_string = "skins"; text.psz_string = "Skins";
 248     var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE, &val, &text );
 249     val.psz_string = "skins2"; text.psz_string = "Skins 2";
 250     var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE, &val, &text );
 251     val.psz_string = "wxwin"; text.psz_string = "wxWindows";
 252     var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE, &val, &text );
 253
 254     var_AddCallback( p_intf, "intf-switch", SwitchIntfCallback, NULL );
 255
 256     /* Variable used for interface spawning */
 257     var_Create( p_intf, "intf-add", VLC_VAR_STRING |
 258                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 259     text.psz_string = _("Add Interface");
 260     var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
 261
 262     val.psz_string = "rc"; text.psz_string = "Console";
 263     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 264     val.psz_string = "telnet"; text.psz_string = "Telnet Interface";
 265     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 266     val.psz_string = "http"; text.psz_string = "Web Interface";
 267     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 268     val.psz_string = "logger"; text.psz_string = "Debug logging";
 269     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 270     val.psz_string = "sap"; text.psz_string = "SAP Playlist";
 271     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 272     val.psz_string = "gestures"; text.psz_string = "Mouse Gestures";
 273     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 274
 275     var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
 276
 277     /* Give control to the interface */
 278     p_intf->pf_run( p_intf );
 279
 280     /* Provide ability to switch the main interface on the fly */
 281     while( p_intf->psz_switch_intf )
 282     {
 283         char *psz_intf = p_intf->psz_switch_intf;
 284         p_intf->psz_switch_intf = NULL;
 285         p_intf->b_die = VLC_FALSE;
 286
 287         /* Make sure the old interface is completely uninitialised */
 288         module_Unneed( p_intf, p_intf->p_module );
 289
 290         p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
 291         free( psz_intf );
 292
 293         if( p_intf->p_module )
 294         {
 295             p_intf->pf_run( p_intf );
 296         }
 297         else break;
 298     }
 299 }
 300
 301 static int SwitchIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 302                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 303 {
 304     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 305
 306     p_intf->psz_switch_intf =
 307         malloc( strlen(newval.psz_string) + sizeof(",none") );
 308     sprintf( p_intf->psz_switch_intf, "%s,none", newval.psz_string );
 309     p_intf->b_die = VLC_TRUE;
 310
 311     return VLC_SUCCESS;
 312 }
 313
 314 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 315                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 316 {
 317     intf_thread_t *p_intf;
 318     char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
 319
 320     /* Try to create the interface */
 321     sprintf( psz_intf, "%s,none", newval.psz_string );
 322     p_intf = intf_Create( p_this->p_vlc, psz_intf );
 323     free( psz_intf );
 324     if( p_intf == NULL )
 325     {
 326         msg_Err( p_this, "interface \"%s\" initialization failed",
 327                  newval.psz_string );
 328         return VLC_EGENERIC;
 329     }
 330
 331     /* Try to run the interface */
 332     p_intf->b_block = VLC_FALSE;
 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 }