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->pf_request_window = NULL;
  97     p_intf->pf_release_window = NULL;
  98     p_intf->pf_control_window = NULL;
  99     p_intf->b_interaction = false;
 100     p_intf->b_should_run_on_first_thread = false;
 101
 102     /* Choose the best module */
 103     p_intf->psz_intf = strdup( psz_module );
 104     p_intf->p_module = module_Need( p_intf, "interface", psz_module, false );
 105
 106     if( p_intf->p_module == NULL )
 107     {
 108         msg_Err( p_intf, "no suitable interface module" );
 109         free( p_intf->psz_intf );
 110         vlc_object_release( p_intf );
 111         return NULL;
 112     }
 113
 114     /* Initialize structure */
 115     p_intf->b_menu        = false;
 116     p_intf->b_menu_change = false;
 117
 118     /* Initialize mutexes */
 119     vlc_mutex_init( &p_intf->change_lock );
 120
 121     /* Attach interface to its parent object */
 122     vlc_object_attach( p_intf, p_this );
 123     vlc_object_set_destructor( p_intf, intf_Destroy );
 124
 125     return p_intf;
 126 }
 127
 128 /*****************************************************************************
 129  * intf_RunThread: launch the interface thread
 130  *****************************************************************************
 131  * This function either creates a new thread and runs the interface in it.
 132  *****************************************************************************/
 133 /**
 134  * Starts and runs the interface thread.
 135  *
 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     /* Hack to get Mac OS X Cocoa runtime running
 142      * (it needs access to the main thread) */
 143     if( p_intf->b_should_run_on_first_thread )
 144     {
 145         RunInterface( p_intf );
 146         vlc_object_detach( p_intf );
 147         vlc_object_release( p_intf );
 148         return VLC_SUCCESS;
 149     }
 150
 151     /* Run the interface in a separate thread */
 152     if( vlc_thread_create( p_intf, "interface", RunInterface,
 153                            VLC_THREAD_PRIORITY_LOW, false ) )
 154     {
 155         msg_Err( p_intf, "cannot spawn interface thread" );
 156         return VLC_EGENERIC;
 157     }
 158
 159     return VLC_SUCCESS;
 160 }
 161
 162 /**
 163  * Stops the interface thread
 164  *
 165  * This function asks the interface thread to stop
 166  * \param p_intf the interface thread
 167  * \return nothing
 168  */
 169 void intf_StopThread( intf_thread_t *p_intf )
 170 {
 171     /* Tell the interface to die */
 172     vlc_object_kill( p_intf );
 173     vlc_object_signal( p_intf );
 174     vlc_thread_join( p_intf );
 175 }
 176
 177 /* Following functions are local */
 178
 179 /*****************************************************************************
 180  * RunInterface: setups necessary data and give control to the interface
 181  *****************************************************************************/
 182 static void RunInterface( intf_thread_t *p_intf )
 183 {
 184     vlc_value_t val, text;
 185     char *psz_intf;
 186
 187     /* Variable used for interface spawning */
 188     var_Create( p_intf, "intf-add", VLC_VAR_STRING |
 189                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 190     text.psz_string = _("Add Interface");
 191     var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
 192
 193     val.psz_string = (char *)"rc"; text.psz_string = (char *)"Console";
 194     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 195     val.psz_string = (char *)"telnet";
 196     text.psz_string = (char *)_("Telnet Interface");
 197     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 198     val.psz_string = (char *)"http";
 199     text.psz_string = (char *)_("Web Interface");
 200     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 201     val.psz_string = (char *)"logger";
 202     text.psz_string = (char *)_("Debug logging");
 203     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 204     val.psz_string = (char *)"gestures";
 205     text.psz_string = (char *)_("Mouse Gestures");
 206     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 207
 208     var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
 209
 210     do
 211     {
 212         /* Give control to the interface */
 213         if( p_intf->pf_run )
 214             p_intf->pf_run( p_intf );
 215         else
 216         {
 217             vlc_object_lock( p_intf );
 218             while( vlc_object_alive( p_intf ) )
 219                 vlc_object_wait( p_intf );
 220             vlc_object_unlock( p_intf );
 221         }
 222
 223         if( !p_intf->psz_switch_intf )
 224         {
 225             break;
 226         }
 227
 228         /* Make sure the old interface is completely uninitialized */
 229         module_Unneed( p_intf, p_intf->p_module );
 230
 231         /* Provide ability to switch the main interface on the fly */
 232         psz_intf = p_intf->psz_switch_intf;
 233         p_intf->psz_switch_intf = NULL;
 234
 235         vlc_object_lock( p_intf );
 236         p_intf->b_die = false; /* FIXME */
 237         p_intf->b_dead = false;
 238
 239         vlc_object_unlock( p_intf );
 240
 241         p_intf->psz_intf = psz_intf;
 242         p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
 243     }
 244     while( p_intf->p_module );
 245 }
 246
 247 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 248                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 249 {
 250     intf_thread_t *p_intf;
 251     char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
 252
 253     (void)psz_cmd; (void)oldval; (void)p_data;
 254
 255     /* Try to create the interface */
 256     sprintf( psz_intf, "%s,none", newval.psz_string );
 257     p_intf = intf_Create( p_this->p_libvlc, psz_intf );
 258     free( psz_intf );
 259     if( p_intf == NULL )
 260     {
 261         msg_Err( p_this, "interface \"%s\" initialization failed",
 262                  newval.psz_string );
 263         return VLC_EGENERIC;
 264     }
 265
 266     /* Try to run the interface */
 267     if( intf_RunThread( p_intf ) != VLC_SUCCESS )
 268     {
 269         vlc_object_detach( p_intf );
 270         vlc_object_release( p_intf );
 271         return VLC_EGENERIC;
 272     }
 273
 274     return VLC_SUCCESS;
 275 }
 276