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 "libvlc.h"
  47
  48 /*****************************************************************************
  49  * Local prototypes
  50  *****************************************************************************/
  51 static void* RunInterface( vlc_object_t *p_this );
  52 #if defined( __APPLE__ ) || defined( WIN32 )
  53 static void * MonitorLibVLCDeath( vlc_object_t *p_this );
  54 #endif
  55 static int AddIntfCallback( vlc_object_t *, char const *,
  56                             vlc_value_t , vlc_value_t , void * );
  57
  58 /**
  59  * Destroy the interface after the main loop endeed.
  60  *
  61  * @param p_obj: the interface thread
  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 /**
  77  * Create the interface, and prepare it for main loop. It opens ouput device
  78  * and creates specific interfaces. Sends its own error messages.
  79  *
  80  * @param p_this the calling vlc_object_t
  81  * @param psz_module a preferred interface module
  82  * @return a pointer to the created interface thread, NULL on error
  83  */
  84 intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module )
  85 {
  86     intf_thread_t * p_intf;
  87
  88     /* Allocate structure */
  89     p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
  90     if( !p_intf )
  91         return NULL;
  92     p_intf->b_interaction = false;
  93 #if defined( __APPLE__ ) || defined( WIN32 )
  94     p_intf->b_should_run_on_first_thread = false;
  95 #endif
  96
  97     /* Choose the best module */
  98     p_intf->psz_intf = strdup( psz_module );
  99     p_intf->p_module = module_need( p_intf, "interface", psz_module, true );
 100
 101     if( p_intf->p_module == NULL )
 102     {
 103         msg_Err( p_intf, "no suitable interface module" );
 104         free( p_intf->psz_intf );
 105         vlc_object_release( p_intf );
 106         return NULL;
 107     }
 108
 109     /* Initialize mutexes */
 110     vlc_mutex_init( &p_intf->change_lock );
 111
 112     /* Attach interface to its parent object */
 113     vlc_object_attach( p_intf, p_this );
 114     vlc_object_set_destructor( p_intf, intf_Destroy );
 115
 116     return p_intf;
 117 }
 118
 119
 120 /**
 121  * Starts and runs the interface thread.
 122  *
 123  * @param p_intf the interface thread
 124  * @return VLC_SUCCESS on success, an error number else
 125  */
 126 int intf_RunThread( intf_thread_t *p_intf )
 127 {
 128 #if defined( __APPLE__ ) || defined( WIN32 )
 129     /* Hack to get Mac OS X Cocoa runtime running
 130      * (it needs access to the main thread) */
 131     if( p_intf->b_should_run_on_first_thread )
 132     {
 133         if( vlc_thread_create( p_intf, "interface", MonitorLibVLCDeath,
 134                                VLC_THREAD_PRIORITY_LOW, false ) )
 135         {
 136             msg_Err( p_intf, "cannot spawn libvlc death monitoring thread" );
 137             return VLC_EGENERIC;
 138         }
 139         RunInterface( VLC_OBJECT(p_intf) );
 140
 141         /* Make sure our MonitorLibVLCDeath thread exit */
 142         vlc_object_kill( p_intf );
 143         /* It is monitoring libvlc, not the p_intf */
 144         vlc_object_kill( p_intf->p_libvlc );
 145         vlc_thread_join( p_intf );
 146
 147         vlc_object_detach( p_intf );
 148         vlc_object_release( p_intf );
 149         return VLC_SUCCESS;
 150     }
 151 #endif
 152     /* Run the interface in a separate thread */
 153     if( vlc_thread_create( p_intf, "interface", RunInterface,
 154                            VLC_THREAD_PRIORITY_LOW, false ) )
 155     {
 156         msg_Err( p_intf, "cannot spawn interface thread" );
 157         return VLC_EGENERIC;
 158     }
 159
 160     return VLC_SUCCESS;
 161 }
 162
 163
 164 /**
 165  * Stops the interface thread
 166  *
 167  * This function asks the interface thread to stop
 168  * @param p_intf the interface thread
 169  */
 170 void intf_StopThread( intf_thread_t *p_intf )
 171 {
 172     /* Tell the interface to die */
 173     vlc_object_kill( p_intf );
 174     vlc_thread_join( p_intf );
 175 }
 176
 177
 178
 179 /* Following functions are local */
 180
 181 /**
 182  * RunInterface: setups necessary data and give control to the interface
 183  *
 184  * @param p_this: interface object
 185  */
 186 static void* RunInterface( vlc_object_t *p_this )
 187 {
 188     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 189     vlc_value_t val, text;
 190     int canc = vlc_savecancel ();
 191
 192     /* Variable used for interface spawning */
 193     var_Create( p_intf, "intf-add", VLC_VAR_STRING |
 194                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 195     text.psz_string = _("Add Interface");
 196     var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
 197
 198     val.psz_string = (char *)"rc";
 199     text.psz_string = (char *)_("Console");
 200     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 201     val.psz_string = (char *)"telnet";
 202     text.psz_string = (char *)_("Telnet Interface");
 203     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 204     val.psz_string = (char *)"http";
 205     text.psz_string = (char *)_("Web Interface");
 206     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 207     val.psz_string = (char *)"logger";
 208     text.psz_string = (char *)_("Debug logging");
 209     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 210     val.psz_string = (char *)"gestures";
 211     text.psz_string = (char *)_("Mouse Gestures");
 212     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 213
 214     var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
 215     vlc_restorecancel (canc);
 216
 217     /* Give control to the interface */
 218     if( p_intf->pf_run )
 219         p_intf->pf_run( p_intf );
 220
 221     return NULL;
 222 }
 223
 224 #if defined( __APPLE__ ) || defined( WIN32 )
 225 /**
 226  * MonitorLibVLCDeath: Used when b_should_run_on_first_thread is set.
 227  *
 228  * @param p_this: the interface object
 229  */
 230 static void * MonitorLibVLCDeath( vlc_object_t * p_this )
 231 {
 232     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 233     libvlc_int_t * p_libvlc = p_intf->p_libvlc;
 234     int canc = vlc_savecancel ();
 235
 236     vlc_object_lock( p_libvlc );
 237     while(vlc_object_alive( p_libvlc ) )
 238     {
 239         if(p_intf->b_die)
 240         {
 241             vlc_object_unlock( p_libvlc );
 242             return NULL;
 243         }
 244         vlc_object_wait( p_libvlc );
 245     }
 246     vlc_object_unlock( p_libvlc );
 247
 248     /* Someone killed libvlc */
 249
 250     /* Make sure we kill all interface objects, especially
 251      * those that are blocking libvlc (running on main thread) */
 252     vlc_list_t * p_list = vlc_list_find( p_libvlc, VLC_OBJECT_INTF, FIND_CHILD );
 253     for( int i = 0; i < p_list->i_count; i++ )
 254     {
 255         vlc_object_t * p_intf = p_list->p_values[i].p_object;
 256         vlc_object_kill( p_intf );
 257     }
 258     vlc_list_release( p_list );
 259     vlc_restorecancel (canc);
 260     return NULL;
 261 }
 262 #endif
 263
 264 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 265                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 266 {
 267     (void)psz_cmd; (void)oldval; (void)p_data;
 268     intf_thread_t *p_intf;
 269     char* psz_intf;
 270
 271     /* Try to create the interface */
 272     if( asprintf( &psz_intf, "%s,none", newval.psz_string ) == -1 )
 273         return VLC_ENOMEM;
 274
 275     p_intf = intf_Create( p_this->p_libvlc, psz_intf );
 276     free( psz_intf );
 277     if( p_intf == NULL )
 278     {
 279         msg_Err( p_this, "interface \"%s\" initialization failed",
 280                  newval.psz_string );
 281         return VLC_EGENERIC;
 282     }
 283
 284     /* Try to run the interface */
 285     if( intf_RunThread( p_intf ) != VLC_SUCCESS )
 286     {
 287         vlc_object_detach( p_intf );
 288         vlc_object_release( p_intf );
 289         return VLC_EGENERIC;
 290     }
 291
 292     return VLC_SUCCESS;
 293 }
 294