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