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 #ifdef HAVE_CONFIG_H
  37 # include "config.h"
  38 #endif
  39
  40 #include <vlc_common.h>
  41
  42 #include <vlc_aout.h>
  43 #include <vlc_vout.h>
  44
  45 #include "vlc_interface.h"
  46 #include "modules/modules.h" // Gruik!
  47 #include "libvlc.h"
  48
  49 /*****************************************************************************
  50  * Local prototypes
  51  *****************************************************************************/
  52 static void RunInterface( intf_thread_t *p_intf );
  53
  54 static int AddIntfCallback( vlc_object_t *, char const *,
  55                             vlc_value_t , vlc_value_t , void * );
  56
  57 /**
  58  * \brief Destroy the interface after the main loop endeed.
  59  *
  60  * \param p_intf the interface thread
  61  * \return nothing
  62  */
  63 static void intf_Destroy( vlc_object_t *obj )
  64 {
  65     intf_thread_t *p_intf = (intf_thread_t *)obj;
  66
  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 );
  70
  71     free( p_intf->psz_intf );
  72     vlc_mutex_destroy( &p_intf->change_lock );
  73 }
  74
  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  *****************************************************************************/
  81 /**
  82  * Create the interface, and prepare it for main loop.
  83  *
  84  * \param p_this the calling vlc_object_t
  85  * \param psz_module a preferred interface module
  86  * \return a pointer to the created interface thread, NULL on error
  87  */
  88 intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module )
  89 {
  90     intf_thread_t * p_intf;
  91
  92     /* Allocate structure */
  93     p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
  94     if( !p_intf )
  95         return NULL;
  96     p_intf->b_interaction = false;
  97     p_intf->b_should_run_on_first_thread = false;
  98
  99     /* Choose the best module */
 100     p_intf->psz_intf = strdup( psz_module );
 101     p_intf->p_module = module_Need( p_intf, "interface", psz_module, false );
 102
 103     if( p_intf->p_module == NULL )
 104     {
 105         msg_Err( p_intf, "no suitable interface module" );
 106         free( p_intf->psz_intf );
 107         vlc_object_release( p_intf );
 108         return NULL;
 109     }
 110
 111     /* Initialize structure */
 112     p_intf->b_menu        = false;
 113     p_intf->b_menu_change = false;
 114
 115     /* Initialize mutexes */
 116     vlc_mutex_init( &p_intf->change_lock );
 117
 118     /* Attach interface to its parent object */
 119     vlc_object_attach( p_intf, p_this );
 120     vlc_object_set_destructor( p_intf, intf_Destroy );
 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  *****************************************************************************/
 130 /**
 131  * Starts and runs the interface thread.
 132  *
 133  * \param p_intf the interface thread
 134  * \return VLC_SUCCESS on success, an error number else
 135  */
 136 int intf_RunThread( intf_thread_t *p_intf )
 137 {
 138     /* Hack to get Mac OS X Cocoa runtime running
 139      * (it needs access to the main thread) */
 140     if( p_intf->b_should_run_on_first_thread )
 141     {
 142         RunInterface( p_intf );
 143         vlc_object_detach( p_intf );
 144         vlc_object_release( p_intf );
 145         return VLC_SUCCESS;
 146     }
 147
 148     /* Run the interface in a separate thread */
 149     if( vlc_thread_create( p_intf, "interface", RunInterface,
 150                            VLC_THREAD_PRIORITY_LOW, false ) )
 151     {
 152         msg_Err( p_intf, "cannot spawn interface thread" );
 153         return VLC_EGENERIC;
 154     }
 155
 156     return VLC_SUCCESS;
 157 }
 158
 159 /**
 160  * Stops the interface thread
 161  *
 162  * This function asks the interface thread to stop
 163  * \param p_intf the interface thread
 164  * \return nothing
 165  */
 166 void intf_StopThread( intf_thread_t *p_intf )
 167 {
 168     /* Tell the interface to die */
 169     vlc_object_kill( p_intf );
 170     vlc_object_signal( p_intf );
 171     vlc_thread_join( p_intf );
 172 }
 173
 174 /* Following functions are local */
 175
 176 /*****************************************************************************
 177  * RunInterface: setups necessary data and give control to the interface
 178  *****************************************************************************/
 179 static void RunInterface( intf_thread_t *p_intf )
 180 {
 181     vlc_value_t val, text;
 182     char *psz_intf;
 183
 184     /* Variable used for interface spawning */
 185     var_Create( p_intf, "intf-add", VLC_VAR_STRING |
 186                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 187     text.psz_string = _("Add Interface");
 188     var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
 189
 190     val.psz_string = (char *)"rc"; text.psz_string = (char *)"Console";
 191     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 192     val.psz_string = (char *)"telnet";
 193     text.psz_string = (char *)_("Telnet Interface");
 194     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 195     val.psz_string = (char *)"http";
 196     text.psz_string = (char *)_("Web Interface");
 197     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 198     val.psz_string = (char *)"logger";
 199     text.psz_string = (char *)_("Debug logging");
 200     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 201     val.psz_string = (char *)"gestures";
 202     text.psz_string = (char *)_("Mouse Gestures");
 203     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 204
 205     var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
 206
 207     do
 208     {
 209         /* Give control to the interface */
 210         if( p_intf->pf_run )
 211             p_intf->pf_run( p_intf );
 212         else
 213         {
 214             vlc_object_lock( p_intf );
 215             while( vlc_object_alive( p_intf ) )
 216                 vlc_object_wait( p_intf );
 217             vlc_object_unlock( p_intf );
 218         }
 219
 220         if( !p_intf->psz_switch_intf )
 221         {
 222             break;
 223         }
 224
 225         /* Make sure the old interface is completely uninitialized */
 226         module_Unneed( p_intf, p_intf->p_module );
 227
 228         /* Provide ability to switch the main interface on the fly */
 229         psz_intf = p_intf->psz_switch_intf;
 230         p_intf->psz_switch_intf = NULL;
 231
 232         vlc_object_lock( p_intf );
 233         p_intf->b_die = false; /* FIXME */
 234         p_intf->b_dead = false;
 235
 236         vlc_object_unlock( p_intf );
 237
 238         p_intf->psz_intf = psz_intf;
 239         p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
 240     }
 241     while( p_intf->p_module );
 242 }
 243
 244 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 245                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 246 {
 247     intf_thread_t *p_intf;
 248     char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
 249
 250     (void)psz_cmd; (void)oldval; (void)p_data;
 251
 252     /* Try to create the interface */
 253     sprintf( psz_intf, "%s,none", newval.psz_string );
 254     p_intf = intf_Create( p_this->p_libvlc, psz_intf );
 255     free( psz_intf );
 256     if( p_intf == NULL )
 257     {
 258         msg_Err( p_this, "interface \"%s\" initialization failed",
 259                  newval.psz_string );
 260         return VLC_EGENERIC;
 261     }
 262
 263     /* Try to run the interface */
 264     if( intf_RunThread( p_intf ) != VLC_SUCCESS )
 265     {
 266         vlc_object_detach( p_intf );
 267         vlc_object_release( p_intf );
 268         return VLC_EGENERIC;
 269     }
 270
 271     return VLC_SUCCESS;
 272 }
 273