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 RunInterface( intf_thread_t *p_intf );
  56
  57 static int SwitchIntfCallback( vlc_object_t *, char const *,
  58                                vlc_value_t , vlc_value_t , void * );
  59 static int AddIntfCallback( vlc_object_t *, char const *,
  60                             vlc_value_t , vlc_value_t , void * );
  61
  62 #ifdef __APPLE__
  63 static void Manager( intf_thread_t *p_intf );
  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 preferred 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, const char *const *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             return VLC_SUCCESS;
 192
 193         /* Run the interface in a separate thread */
 194         if( !strcmp( p_intf->p_module->psz_object_name, "macosx" ) )
 195         {
 196             msg_Err( p_intf, "You cannot run the MacOS X module as an "
 197                              "extra interface. Please read the "
 198                              "README.MacOSX.rtf file.");
 199             return VLC_EGENERIC;
 200         }
 201         if( vlc_thread_create( p_intf, "interface", RunInterface,
 202                                VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
 203         {
 204             msg_Err( p_intf, "cannot spawn interface thread" );
 205             return VLC_EGENERIC;
 206         }
 207
 208         if( p_intf->b_block )
 209         {
 210             /* VLC in primary interface mode with a working macosx vout */
 211             [NSApp run];
 212             p_intf->b_die = VLC_TRUE;
 213         }
 214     }
 215 #else
 216     if( p_intf->b_block )
 217     {
 218         /* If the main interface does not have a run function,
 219          * implement a waiting loop ourselves
 220          */
 221         if( p_intf->pf_run )
 222             RunInterface( p_intf );
 223         else
 224         {
 225             while( !intf_ShouldDie( p_intf ) )
 226                 msleep( INTF_IDLE_SLEEP * 2);
 227         }
 228         p_intf->b_die = VLC_TRUE;
 229         /* Do not join the thread... intf_StopThread will do it for us */
 230     }
 231     else
 232     {
 233         /* This interface doesn't need to be run */
 234         if( !p_intf->pf_run )
 235             return VLC_SUCCESS;
 236
 237         /* Run the interface in a separate thread */
 238         if( vlc_thread_create( p_intf, "interface", RunInterface,
 239                                VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
 240         {
 241             msg_Err( p_intf, "cannot spawn interface thread" );
 242             return VLC_EGENERIC;
 243         }
 244     }
 245 #endif
 246
 247     return VLC_SUCCESS;
 248 }
 249
 250 /**
 251  * Stops the interface thread
 252  *
 253  * This function asks the interface thread to stop
 254  * \param p_intf the interface thread
 255  * \return nothing
 256  */
 257 void intf_StopThread( intf_thread_t *p_intf )
 258 {
 259     /* Tell the interface to die */
 260     if( !p_intf->b_block )
 261     {
 262         p_intf->b_die = VLC_TRUE;
 263         if( p_intf->pf_run )
 264         {
 265             vlc_cond_signal( &p_intf->object_wait );
 266             vlc_thread_join( p_intf );
 267         }
 268     }
 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 OS X
 297  *****************************************************************************/
 298 #ifdef __APPLE__
 299 static void Manager( intf_thread_t *p_intf )
 300 {
 301     while( !p_intf->b_die )
 302     {
 303         msleep( INTF_IDLE_SLEEP );
 304
 305         if( p_intf->p_libvlc->b_die )
 306         {
 307             p_intf->b_die = VLC_TRUE;
 308             if( strncmp( p_intf->p_libvlc->psz_object_name, "clivlc", 6 ) )
 309             {
 310                 [NSApp stop: NULL];
 311             }
 312             return;
 313         }
 314     }
 315 }
 316 #endif
 317
 318 /*****************************************************************************
 319  * RunInterface: setups necessary data and give control to the interface
 320  *****************************************************************************/
 321 static void RunInterface( intf_thread_t *p_intf )
 322 {
 323     static const char *ppsz_interfaces[] =
 324     {
 325         "skins2", "Skins 2",
 326 #ifndef WIN32
 327         "wxwidgets", "wxWidgets",
 328 #endif
 329         NULL, NULL
 330     };
 331     const char **ppsz_parser;
 332
 333     vlc_list_t *p_list;
 334     int i;
 335     vlc_value_t val, text;
 336     char *psz_intf;
 337
 338     /* Variable used for interface switching */
 339     p_intf->psz_switch_intf = NULL;
 340     var_Create( p_intf, "intf-switch", VLC_VAR_STRING |
 341                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 342     text.psz_string = _("Switch interface");
 343     var_Change( p_intf, "intf-switch", VLC_VAR_SETTEXT, &text, NULL );
 344
 345     /* Only fill the list with available modules */
 346     p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
 347     for( ppsz_parser = ppsz_interfaces; *ppsz_parser; ppsz_parser += 2 )
 348     {
 349         for( i = 0; i < p_list->i_count; i++ )
 350         {
 351             module_t *p_module = (module_t *)p_list->p_values[i].p_object;
 352             if( !strcmp( p_module->psz_object_name, ppsz_parser[0] ) )
 353             {
 354                 val.psz_string = (char *)ppsz_parser[0];
 355                 text.psz_string = (char *)_(ppsz_parser[1]);
 356                 var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE,
 357                             &val, &text );
 358                 break;
 359             }
 360         }
 361     }
 362     vlc_list_release( p_list );
 363
 364     var_AddCallback( p_intf, "intf-switch", SwitchIntfCallback, NULL );
 365
 366     /* Variable used for interface spawning */
 367     var_Create( p_intf, "intf-add", VLC_VAR_STRING |
 368                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
 369     text.psz_string = _("Add Interface");
 370     var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
 371
 372     val.psz_string = (char *)"rc"; text.psz_string = (char *)"Console";
 373     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 374     val.psz_string = (char *)"telnet";
 375     text.psz_string = (char *)_("Telnet Interface");
 376     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 377     val.psz_string = (char *)"http";
 378     text.psz_string = (char *)_("Web Interface");
 379     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 380     val.psz_string = (char *)"logger";
 381     text.psz_string = (char *)_("Debug logging");
 382     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 383     val.psz_string = (char *)"gestures";
 384     text.psz_string = (char *)_("Mouse Gestures");
 385     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
 386
 387     var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
 388
 389     do
 390     {
 391         /* Give control to the interface */
 392         p_intf->pf_run( p_intf );
 393
 394         /* Reset play on start status */
 395         p_intf->b_play = VLC_FALSE;
 396
 397         if( !p_intf->psz_switch_intf )
 398         {
 399             break;
 400         }
 401
 402         /* Make sure the old interface is completely uninitialized */
 403         module_Unneed( p_intf, p_intf->p_module );
 404
 405         /* Provide ability to switch the main interface on the fly */
 406         psz_intf = p_intf->psz_switch_intf;
 407         p_intf->psz_switch_intf = NULL;
 408
 409         vlc_mutex_lock( &p_intf->object_lock );
 410         p_intf->b_die = VLC_FALSE;
 411         p_intf->b_dead = VLC_FALSE;
 412         vlc_mutex_unlock( &p_intf->object_lock );
 413
 414         p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
 415         free( psz_intf );
 416     }
 417     while( p_intf->p_module );
 418 }
 419
 420 static int SwitchIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 421                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 422 {
 423     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 424
 425     p_intf->psz_switch_intf =
 426         malloc( strlen(newval.psz_string) + sizeof(",none") );
 427     sprintf( p_intf->psz_switch_intf, "%s,none", newval.psz_string );
 428     p_intf->b_die = VLC_TRUE;
 429
 430     return VLC_SUCCESS;
 431 }
 432
 433 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
 434                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 435 {
 436     intf_thread_t *p_intf;
 437     char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
 438
 439     /* Try to create the interface */
 440     sprintf( psz_intf, "%s,none", newval.psz_string );
 441     p_intf = intf_Create( p_this->p_libvlc, psz_intf, 0, NULL );
 442     free( psz_intf );
 443     if( p_intf == NULL )
 444     {
 445         msg_Err( p_this, "interface \"%s\" initialization failed",
 446                  newval.psz_string );
 447         return VLC_EGENERIC;
 448     }
 449
 450     /* Try to run the interface */
 451     p_intf->b_block = VLC_FALSE;
 452     if( intf_RunThread( p_intf ) != VLC_SUCCESS )
 453     {
 454         vlc_object_detach( p_intf );
 455         intf_Destroy( p_intf );
 456         return VLC_EGENERIC;
 457     }
 458
 459     return VLC_SUCCESS;
 460 }
 461
 462 #ifdef __APPLE__
 463 /*****************************************************************************
 464  * VLCApplication implementation
 465  *****************************************************************************/
 466 @implementation VLCApplication
 467
 468 - (void)setVLC: (libvlc_int_t *) p_libvlc
 469 {
 470     o_libvlc = p_libvlc;
 471 }
 472
 473 - (void)stop: (id)sender
 474 {
 475     NSEvent *o_event;
 476     NSAutoreleasePool *o_pool;
 477     [super stop:sender];
 478
 479     o_pool = [[NSAutoreleasePool alloc] init];
 480     /* send a dummy event to break out of the event loop */
 481     o_event = [NSEvent mouseEventWithType: NSLeftMouseDown
 482                 location: NSMakePoint( 1, 1 ) modifierFlags: 0
 483                 timestamp: 1 windowNumber: [[NSApp mainWindow] windowNumber]
 484                 context: [NSGraphicsContext currentContext] eventNumber: 1
 485                 clickCount: 1 pressure: 0.0];
 486     [NSApp postEvent: o_event atStart: YES];
 487     [o_pool release];
 488 }
 489
 490 - (void)terminate: (id)sender
 491 {
 492     o_libvlc->b_die = VLC_TRUE;
 493 }
 494
 495 @end
 496 #endif
 497