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