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