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