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 #include <vlc/vlc.h>
  37
  38 #include <vlc_aout.h>
  39 #include <vlc_vout.h>
  40
  41 #include "vlc_interface.h"
  42 #include "modules/modules.h" // Gruik!
  43
  44 #ifdef __APPLE__
  45 #    include <Cocoa/Cocoa.h>
  46 #endif
  47
  48 /*****************************************************************************
  49  * Local prototypes
  50  *****************************************************************************/
  51 static void RunInterface( intf_thread_t *p_intf );
  52
  53 static int SwitchIntfCallback( vlc_object_t *, char const *,
  54                                vlc_value_t , vlc_value_t , void * );
  55 static int AddIntfCallback( vlc_object_t *, char const *,
  56                             vlc_value_t , vlc_value_t , void * );
  57
  58 #ifdef __APPLE__
  59 static void Manager( intf_thread_t *p_intf );
  60 /*****************************************************************************
  61  * VLCApplication interface
  62  *****************************************************************************/
  63 @interface VLCApplication : NSApplication
  64 {
  65    libvlc_int_t *o_libvlc;
  66 }
  67
  68 - (void)setVLC: (libvlc_int_t *)p_libvlc;
  69
  70 @end
  71 #endif
  72
  73 /*****************************************************************************
  74  * intf_Create: prepare interface before main loop
  75  *****************************************************************************
  76  * This function opens output devices and creates specific interfaces. It sends
  77  * its own error messages.
  78  *****************************************************************************/
  79 /**
  80  * Create the interface, and prepare it for main loop.
  81  * You can give some additional options to be used for interface initialization
  82  *
  83  * \param p_this the calling vlc_object_t
  84  * \param psz_module a preferred interface module
  85  * \param i_options number additional options
  86  * \param ppsz_options additional option strings
  87  * \return a pointer to the created interface thread, NULL on error
  88  */
  89 intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module,
  90                               int i_options, const char *const *ppsz_options  )
  91 {
  92     intf_thread_t * p_intf;
  93     int i;
  94
  95     /* Allocate structure */
  96     p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
  97     if( !p_intf )
  98     {
  99         msg_Err( p_this, "out of memory" );
 100         return NULL;
 101     }
 102     p_intf->pf_request_window = NULL;
 103     p_intf->pf_release_window = NULL;
 104     p_intf->pf_control_window = NULL;
 105     p_intf->b_play = VLC_FALSE;
 106     p_intf->b_interaction = VLC_FALSE;
 107
 108     for( i = 0 ; i< i_options; i++ )
 109     {
 110         var_OptionParse( p_intf, ppsz_options[i] );
 111     }
 112
 113     /* Choose the best module */
 114     p_intf->p_module = module_Need( p_intf, "interface", psz_module, VLC_FALSE );
 115
 116     if( p_intf->p_module == NULL )
 117     {
 118         msg_Err( p_intf, "no suitable interface module" );
 119         vlc_object_destroy( p_intf );
 120         return NULL;
 121     }
 122
 123     /* Initialize structure */
 124     p_intf->b_menu        = VLC_FALSE;
 125     p_intf->b_menu_change = VLC_FALSE;
 126
 127     /* Initialize mutexes */
 128     vlc_mutex_init( p_intf, &p_intf->change_lock );
 129
 130     /* Attach interface to its parent object */
 131     vlc_object_attach( p_intf, p_this );
 132
 133     return p_intf;
 134 }
 135
 136 /*****************************************************************************
 137  * intf_RunThread: launch the interface thread
 138  *****************************************************************************
 139  * This function either creates a new thread and runs the interface in it,
 140  * or runs the interface in the current thread, depending on b_block.
 141  *****************************************************************************/
 142 /**
 143  * Run the interface thread.
 144  *
 145  * If b_block is not set, runs the interface in the thread, else,
 146  * creates a new thread and runs the interface.
 147  * \param p_intf the interface thread
 148  * \return VLC_SUCCESS on success, an error number else
 149  */
 150 int intf_RunThread( intf_thread_t *p_intf )
 151 {
 152 #ifdef __APPLE__
 153     NSAutoreleasePool * o_pool;
 154
 155     /* If !clivlc, then run as a OS X application */
 156     if( p_intf->b_block && strncmp( p_intf->p_libvlc->psz_object_name,
 157                                     "clivlc", 6) )
 158     {
 159         o_pool = [[NSAutoreleasePool alloc] init];
 160         [VLCApplication sharedApplication];
 161         [NSApp setVLC: p_intf->p_libvlc];
 162
 163         if( p_intf->pf_run )
 164             RunInterface( p_intf );
 165         else
 166         {
 167             [NSApp run];
 168             while( !intf_ShouldDie( p_intf ) )
 169                 msleep( INTF_IDLE_SLEEP * 2);
 170         }
 171         vlc_object_kill( p_intf );
 172     }
 173     else
 174 #endif
 175     if( p_intf->b_block )
 176     {
 177         /* If we are clivlc+macosx, don't run the macosx GUI */
 178         if( !strcmp( p_intf->p_module->psz_object_name, "macosx" ) )
 179         {
 180             msg_Err( p_intf, "You cannot run the MacOS X module as an "
 181                              "interface in clivlc mode. Please read the "
 182                              "README.MacOSX.rtf file.");
 183             return VLC_EGENERIC;
 184         }
 185
 186         /* If the main interface does not have a run function,
 187          * implement a waiting loop ourselves
 188          */
 189         if( p_intf->pf_run )
 190             RunInterface( p_intf );
 191         else
 192         {
 193             while( !intf_ShouldDie( p_intf ) )
 194                 msleep( INTF_IDLE_SLEEP * 2);
 195         }
 196         vlc_object_kill( p_intf );
 197     }
 198     else
 199     {
 200         /* This interface doesn't need to be run */
 201         if( !p_intf->pf_run )
 202             return VLC_SUCCESS;
 203
 204         /* Run the interface in a separate thread */
 205         if( !strcmp( p_intf->p_module->psz_object_name, "macosx" ) )
 206         {
 207             msg_Err( p_intf, "You cannot run the MacOS X module as an "
 208                              "extra interface. Please read the "
 209                              "README.MacOSX.rtf file.");
 210             return VLC_EGENERIC;
 211         }
 212
 213         /* Run the interface in a separate thread */
 214         if( vlc_thread_create( p_intf, "interface", RunInterface,
 215                                VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
 216         {
 217             msg_Err( p_intf, "cannot spawn interface thread" );
 218             return VLC_EGENERIC;
 219         }
 220     }
 221
 222     return VLC_SUCCESS;
 223 }
 224
 225 /**
 226  * Stops the interface thread
 227  *
 228  * This function asks the interface thread to stop
 229  * \param p_intf the interface thread
 230  * \return nothing
 231  */
 232 void intf_StopThread( intf_thread_t *p_intf )
 233 {
 234     /* Tell the interface to die */
 235     if( !p_intf->b_block )
 236     {
 237         vlc_object_kill( p_intf );
 238         if( p_intf->pf_run )
 239         {
 240             vlc_cond_signal( &p_intf->object_wait );
 241             vlc_thread_join( p_intf );
 242         }
 243     }
 244 }
 245
 246 /**
 247  * \brief Destroy the interface after the main loop endeed.
 248  *
 249  * Destroys interfaces and closes output devices
 250  * \param p_intf the interface thread
 251  * \return nothing
 252  */
 253 void intf_Destroy( intf_thread_t *p_intf )
 254 {
 255     /* Unlock module if present (a switch may have failed) */
 256     if( p_intf->p_module )
 257     {
 258         module_Unneed( p_intf, p_intf->p_module );
 259     }
 260
 261     vlc_mutex_destroy( &p_intf->change_lock );
 262
 263     /* Free structure */
 264     vlc_object_destroy( p_intf );
 265 }
 266
 267
 268 /* Following functions are local */
 269
 270 /*****************************************************************************
 271  * Manager: helper thread for blocking OS X
 272  *****************************************************************************/
 273 #ifdef __APPLE__
 274 static void Manager( intf_thread_t *p_intf )
 275 {
 276     while( !p_intf->b_die )
 277     {
 278         msleep( INTF_IDLE_SLEEP );
 279
 280         if( p_intf->p_libvlc->b_die )
 281         {
 282             p_intf->b_die = VLC_TRUE;
 283             if( strncmp( p_intf->p_libvlc->psz_object_name, "clivlc", 6 ) )
 284             {
 285                 [NSApp stop: NULL];
 286             }
 287             return;
 288         }
 289     }
 290 }
 291 #endif
 292
 293 /*****************************************************************************
 294  * RunInterface: setups necessary data and give control to the interface
 295  *****************************************************************************/
 296 static void RunInterface( intf_thread_t *p_intf )
 297 {
 298     static const char *ppsz_interfaces[] =
 299     {
 300         "skins2", "Skins 2",
 301 #ifndef WIN32
 302         "wxwidgets", "wxWidgets",
 303 #endif
 304         NULL, NULL
 305     };
 306     const char **ppsz_parser;
 307
 308     vlc_list_t *p_list;
 309     int i;
 310     vlc_value_t val, text;
 311     char *psz_intf;
 312
 313     /* Variable used for interface switching */
 314     p_intf->psz_switch_intf = NULL;
 315     var_Create( p_intf, "intf-switch", VLC_VAR_STRING |
 316                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 317     text.psz_string = _("Switch interface");
 318     var_Change( p_intf, "intf-switch", VLC_VAR_SETTEXT, &text, NULL );
 319
 320     /* Only fill the list with available modules */
 321     p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
 322     for( ppsz_parser = ppsz_interfaces; *ppsz_parser; ppsz_parser += 2 )
 323     {
 324         for( i = 0; i < p_list->i_count; i++ )
 325         {
 326             module_t *p_module = (module_t *)p_list->p_values[i].p_object;
 327             if( !strcmp( p_module->psz_object_name, ppsz_parser[0] ) )
 328             {
 329                 val.psz_string = (char *)ppsz_parser[0];
 330                 text.psz_string = (char *)_(ppsz_parser[1]);
 331                 var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE,
 332                             &val, &text );
 333                 break;
 334             }
 335         }
 336     }
 337     vlc_list_release( p_list );
 338
 339     var_AddCallback( p_intf, "intf-switch", SwitchIntfCallback, NULL );
 340
 341     /* Variable used for interface spawning */
 342     var_Create( p_intf, "intf-add", VLC_VAR_STRING |
 343                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 344     text.psz_string = _("Add Interface");
 345     var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
 346
 347     val.psz_string = (char *)"rc"; text.psz_string = (char *)"Console";
 348     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 349     val.psz_string = (char *)"telnet";
 350     text.psz_string = (char *)_("Telnet Interface");
 351     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 352     val.psz_string = (char *)"http";
 353     text.psz_string = (char *)_("Web Interface");
 354     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 355     val.psz_string = (char *)"logger";
 356     text.psz_string = (char *)_("Debug logging");
 357     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 358     val.psz_string = (char *)"gestures";
 359     text.psz_string = (char *)_("Mouse Gestures");
 360     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 361
 362     var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
 363
 364     do
 365     {
 366         /* Give control to the interface */
 367         p_intf->pf_run( p_intf );
 368
 369         /* Reset play on start status */
 370         p_intf->b_play = VLC_FALSE;
 371
 372         if( !p_intf->psz_switch_intf )
 373         {
 374             break;
 375         }
 376
 377         /* Make sure the old interface is completely uninitialized */
 378         module_Unneed( p_intf, p_intf->p_module );
 379
 380         /* Provide ability to switch the main interface on the fly */
 381         psz_intf = p_intf->psz_switch_intf;
 382         p_intf->psz_switch_intf = NULL;
 383
 384         vlc_mutex_lock( &p_intf->object_lock );
 385         p_intf->b_die = VLC_FALSE; /* FIXME */
 386         p_intf->b_dead = VLC_FALSE;
 387         vlc_mutex_unlock( &p_intf->object_lock );
 388
 389         p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
 390         free( psz_intf );
 391     }
 392     while( p_intf->p_module );
 393 }
 394
 395 static int SwitchIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 396                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 397 {
 398     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 399     (void)psz_cmd; (void)oldval; (void)p_data;
 400
 401     p_intf->psz_switch_intf =
 402         malloc( strlen(newval.psz_string) + sizeof(",none") );
 403     sprintf( p_intf->psz_switch_intf, "%s,none", newval.psz_string );
 404     vlc_object_kill( p_intf );
 405
 406     return VLC_SUCCESS;
 407 }
 408
 409 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 410                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 411 {
 412     intf_thread_t *p_intf;
 413     char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
 414
 415     (void)psz_cmd; (void)oldval; (void)p_data;
 416
 417     /* Try to create the interface */
 418     sprintf( psz_intf, "%s,none", newval.psz_string );
 419     p_intf = intf_Create( p_this->p_libvlc, psz_intf, 0, NULL );
 420     free( psz_intf );
 421     if( p_intf == NULL )
 422     {
 423         msg_Err( p_this, "interface \"%s\" initialization failed",
 424                  newval.psz_string );
 425         return VLC_EGENERIC;
 426     }
 427
 428     /* Try to run the interface */
 429     p_intf->b_block = VLC_FALSE;
 430     if( intf_RunThread( p_intf ) != VLC_SUCCESS )
 431     {
 432         vlc_object_detach( p_intf );
 433         intf_Destroy( p_intf );
 434         return VLC_EGENERIC;
 435     }
 436
 437     return VLC_SUCCESS;
 438 }
 439
 440 #ifdef __APPLE__
 441 /*****************************************************************************
 442  * VLCApplication implementation
 443  *****************************************************************************/
 444 @implementation VLCApplication
 445
 446 - (void)setVLC: (libvlc_int_t *) p_libvlc
 447 {
 448     o_libvlc = p_libvlc;
 449 }
 450
 451 - (void)terminate: (id)sender
 452 {
 453     vlc_object_kill( o_libvlc );
 454     [super terminate: sender];
 455 }
 456
 457 @end
 458 #endif
 459