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 <assert.h>
  41 #include <vlc_common.h>
  42 #include <vlc_modules.h>
  43 #include <vlc_interface.h>
  44
  45 #if defined( __APPLE__ ) || defined( WIN32 )
  46 #include "../control/libvlc_internal.h"
  47 #endif
  48 #include "libvlc.h"
  49
  50 /*****************************************************************************
  51  * Local prototypes
  52  *****************************************************************************/
  53 static void* RunInterface( void * );
  54 #if defined( __APPLE__)
  55 static void * MonitorLibVLCDeath( vlc_object_t *p_this );
  56 #endif
  57 static int AddIntfCallback( vlc_object_t *, char const *,
  58                             vlc_value_t , vlc_value_t , void * );
  59
  60 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
  61
  62 #undef intf_Create
  63 /**
  64  * Create and start an interface.
  65  *
  66  * @param p_this the calling vlc_object_t
  67  * @param chain configuration chain string
  68  * @return VLC_SUCCESS or an error code
  69  */
  70 int intf_Create( vlc_object_t *p_this, const char *chain )
  71 {
  72     libvlc_int_t *p_libvlc = p_this->p_libvlc;
  73     intf_thread_t * p_intf;
  74     static const char psz_type[] = "interface";
  75
  76     /* Allocate structure */
  77     p_intf = vlc_custom_create( p_libvlc, sizeof( *p_intf ),
  78                                 VLC_OBJECT_GENERIC, psz_type );
  79     if( !p_intf )
  80         return VLC_ENOMEM;
  81
  82     /* Variable used for interface spawning */
  83     vlc_value_t val, text;
  84     var_Create( p_intf, "intf-add", VLC_VAR_STRING |
  85                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
  86     text.psz_string = _("Add Interface");
  87     var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
  88 #if !defined(WIN32) && defined(HAVE_ISATTY)
  89     if( isatty( 0 ) )
  90 #endif
  91     {
  92         val.psz_string = (char *)"rc";
  93         text.psz_string = (char *)_("Console");
  94         var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
  95     }
  96     val.psz_string = (char *)"telnet";
  97     text.psz_string = (char *)_("Telnet");
  98     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
  99     val.psz_string = (char *)"http";
 100     text.psz_string = (char *)_("Web");
 101     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 102     val.psz_string = (char *)"logger";
 103     text.psz_string = (char *)_("Debug logging");
 104     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 105     val.psz_string = (char *)"gestures";
 106     text.psz_string = (char *)_("Mouse Gestures");
 107     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 108
 109     var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
 110
 111     /* Attach interface to LibVLC */
 112 #if defined( __APPLE__ )
 113     p_intf->b_should_run_on_first_thread = false;
 114 #endif
 115
 116     /* Choose the best module */
 117     p_intf->p_cfg = NULL;
 118     char *psz_parser = *chain == '$'
 119                      ? var_CreateGetString(p_intf, chain+1)
 120                      : strdup( chain );
 121     char *module;
 122     char *psz_tmp = config_ChainCreate( &module, &p_intf->p_cfg,
 123                                         psz_parser );
 124     free( psz_tmp );
 125     free( psz_parser );
 126     p_intf->p_module = module_need( p_intf, "interface", module, true );
 127     if( p_intf->p_module == NULL )
 128     {
 129         msg_Err( p_intf, "no suitable interface module" );
 130         goto error;
 131     }
 132
 133     vlc_mutex_lock( &lock );
 134 #if defined( __APPLE__ )
 135     /* Hack to get Mac OS X Cocoa runtime running
 136      * (it needs access to the main thread) */
 137     if( p_intf->b_should_run_on_first_thread )
 138     {
 139         if( vlc_clone( &p_intf->thread,
 140                        MonitorLibVLCDeath, p_intf, VLC_THREAD_PRIORITY_LOW ) )
 141         {
 142             msg_Err( p_intf, "cannot spawn libvlc death monitoring thread" );
 143             vlc_mutex_unlock( &lock );
 144             goto error;
 145         }
 146         assert( p_intf->pf_run );
 147         p_intf->pf_run( p_intf );
 148
 149         /* It is monitoring libvlc, not the p_intf */
 150         vlc_object_kill( p_intf->p_libvlc );
 151
 152         vlc_join( p_intf->thread, NULL );
 153     }
 154     else
 155 #endif
 156     /* Run the interface in a separate thread */
 157     if( p_intf->pf_run
 158      && vlc_clone( &p_intf->thread,
 159                    RunInterface, p_intf, VLC_THREAD_PRIORITY_LOW ) )
 160     {
 161         msg_Err( p_intf, "cannot spawn interface thread" );
 162         vlc_mutex_unlock( &lock );
 163         goto error;
 164     }
 165
 166     p_intf->p_next = libvlc_priv( p_libvlc )->p_intf;
 167     libvlc_priv( p_libvlc )->p_intf = p_intf;
 168     vlc_mutex_unlock( &lock );
 169
 170     return VLC_SUCCESS;
 171
 172 error:
 173     if( p_intf->p_module )
 174         module_unneed( p_intf, p_intf->p_module );
 175     config_ChainDestroy( p_intf->p_cfg );
 176     vlc_object_release( p_intf );
 177     return VLC_EGENERIC;
 178 }
 179
 180
 181 /**
 182  * Stops and destroys all interfaces
 183  * @param p_libvlc the LibVLC instance
 184  */
 185 void intf_DestroyAll( libvlc_int_t *p_libvlc )
 186 {
 187     intf_thread_t *p_first;
 188
 189     vlc_mutex_lock( &lock );
 190     p_first = libvlc_priv( p_libvlc )->p_intf;
 191 #ifndef NDEBUG
 192     libvlc_priv( p_libvlc )->p_intf = NULL;
 193 #endif
 194     vlc_mutex_unlock( &lock );
 195
 196     /* Tell the interfaces to die */
 197     for( intf_thread_t *p_intf = p_first; p_intf; p_intf = p_intf->p_next )
 198         vlc_object_kill( p_intf );
 199
 200     /* Cleanup the interfaces */
 201     for( intf_thread_t *p_intf = p_first; p_intf != NULL; )
 202     {
 203         intf_thread_t *p_next = p_intf->p_next;
 204
 205         if( p_intf->pf_run )
 206         {
 207             vlc_cancel( p_intf->thread );
 208             vlc_join( p_intf->thread, NULL );
 209         }
 210         module_unneed( p_intf, p_intf->p_module );
 211         config_ChainDestroy( p_intf->p_cfg );
 212         vlc_object_release( p_intf );
 213
 214         p_intf = p_next;
 215     }
 216 }
 217
 218 /* Following functions are local */
 219
 220 /**
 221  * RunInterface: setups necessary data and give control to the interface
 222  *
 223  * @param p_this: interface object
 224  */
 225 static void* RunInterface( void *p_this )
 226 {
 227     intf_thread_t *p_intf = p_this;
 228
 229     p_intf->pf_run( p_intf );
 230     return NULL;
 231 }
 232
 233 #if defined( __APPLE__ )
 234 #include "control/libvlc_internal.h" /* libvlc_InternalWait */
 235 /**
 236  * MonitorLibVLCDeath: Used when b_should_run_on_first_thread is set.
 237  *
 238  * @param p_this: the interface object
 239  */
 240 static void * MonitorLibVLCDeath( vlc_object_t * p_this )
 241 {
 242     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 243     libvlc_int_t * p_libvlc = p_intf->p_libvlc;
 244     int canc = vlc_savecancel ();
 245
 246     libvlc_InternalWait( p_libvlc );
 247
 248     vlc_object_kill( p_intf ); /* Kill the stupid first thread interface */
 249     vlc_restorecancel (canc);
 250     return NULL;
 251 }
 252 #endif
 253
 254 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 255                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 256 {
 257     (void)psz_cmd; (void)oldval; (void)p_data;
 258     char* psz_intf;
 259
 260     /* Try to create the interface */
 261     if( asprintf( &psz_intf, "%s,none", newval.psz_string ) == -1 )
 262         return VLC_ENOMEM;
 263
 264     int ret = intf_Create( VLC_OBJECT(p_this->p_libvlc), psz_intf );
 265     free( psz_intf );
 266     if( ret )
 267         msg_Err( p_this, "interface \"%s\" initialization failed",
 268                  newval.psz_string );
 269     return ret;
 270 }