* This library provides basic functions for threads to interact with user
* interface, such as command line.
*****************************************************************************
- * Copyright (C) 1998-2004 the VideoLAN team
+ * Copyright (C) 1998-2007 the VideoLAN team
* $Id$
*
* Authors: Vincent Seguin <seguin@via.ecp.fr>
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <stdlib.h> /* free(), strtol() */
-#include <stdio.h> /* FILE */
-#include <string.h> /* strerror() */
-#include <vlc/vlc.h>
-
-#include <vlc_aout.h>
-#include <vlc_vout.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
-#include "vlc_interface.h"
+#include <assert.h>
+#include <vlc_common.h>
+#include <vlc_modules.h>
+#include <vlc_interface.h>
-#ifdef __APPLE__
-# include <Cocoa/Cocoa.h>
+#if defined( __APPLE__ ) || defined( WIN32 )
+#include "../control/libvlc_internal.h"
#endif
+#include "libvlc.h"
/*****************************************************************************
* Local prototypes
*****************************************************************************/
-static void RunInterface( intf_thread_t *p_intf );
-
-static int SwitchIntfCallback( vlc_object_t *, char const *,
- vlc_value_t , vlc_value_t , void * );
+static void* RunInterface( vlc_object_t *p_this );
+#if defined( __APPLE__ )
+static void * MonitorLibVLCDeath( vlc_object_t *p_this );
+#endif
static int AddIntfCallback( vlc_object_t *, char const *,
vlc_value_t , vlc_value_t , void * );
-#ifdef __APPLE__
-static void Manager( intf_thread_t *p_intf );
-/*****************************************************************************
- * VLCApplication interface
- *****************************************************************************/
-@interface VLCApplication : NSApplication
-{
- libvlc_int_t *o_libvlc;
-}
-
-- (void)setVLC: (libvlc_int_t *)p_libvlc;
-
-@end
-#endif
+static vlc_mutex_t lock = VLC_STATIC_MUTEX;
-/*****************************************************************************
- * intf_Create: prepare interface before main loop
- *****************************************************************************
- * This function opens output devices and creates specific interfaces. It sends
- * its own error messages.
- *****************************************************************************/
+#undef intf_Create
/**
- * Create the interface, and prepare it for main loop.
- * You can give some additional options to be used for interface initialization
+ * Create and start an interface.
*
- * \param p_this the calling vlc_object_t
- * \param psz_module a preferred interface module
- * \param i_options number additional options
- * \param ppsz_options additional option strings
- * \return a pointer to the created interface thread, NULL on error
+ * @param p_this the calling vlc_object_t
+ * @param psz_module a preferred interface module
+ * @return VLC_SUCCESS or an error code
*/
-intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module,
- int i_options, const char *const *ppsz_options )
+int intf_Create( vlc_object_t *p_this, const char *psz_module )
{
+ libvlc_int_t *p_libvlc = p_this->p_libvlc;
intf_thread_t * p_intf;
- int i;
+ static const char psz_type[] = "interface";
/* Allocate structure */
- p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
+ p_intf = vlc_custom_create( p_libvlc, sizeof( *p_intf ),
+ VLC_OBJECT_GENERIC, psz_type );
if( !p_intf )
- {
- msg_Err( p_this, "out of memory" );
- return NULL;
- }
- p_intf->pf_request_window = NULL;
- p_intf->pf_release_window = NULL;
- p_intf->pf_control_window = NULL;
- p_intf->b_play = VLC_FALSE;
- p_intf->b_interaction = VLC_FALSE;
+ return VLC_ENOMEM;
- for( i = 0 ; i< i_options; i++ )
- {
- var_OptionParse( p_intf, ppsz_options[i] );
- }
+ /* Variable used for interface spawning */
+ vlc_value_t val, text;
+ var_Create( p_intf, "intf-add", VLC_VAR_STRING |
+ VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
+ text.psz_string = _("Add Interface");
+ var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
- /* Choose the best module */
- p_intf->p_module = module_Need( p_intf, "interface", psz_module, VLC_FALSE );
+ val.psz_string = (char *)"rc";
+ text.psz_string = (char *)_("Console");
+ var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
+ val.psz_string = (char *)"telnet";
+ text.psz_string = (char *)_("Telnet Interface");
+ var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
+ val.psz_string = (char *)"http";
+ text.psz_string = (char *)_("Web Interface");
+ var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
+ val.psz_string = (char *)"logger";
+ text.psz_string = (char *)_("Debug logging");
+ var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
+ val.psz_string = (char *)"gestures";
+ text.psz_string = (char *)_("Mouse Gestures");
+ var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
+
+ var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
+ /* Attach interface to LibVLC */
+ vlc_object_attach( p_intf, p_libvlc );
+#if defined( __APPLE__ )
+ p_intf->b_should_run_on_first_thread = false;
+#endif
+
+ /* Choose the best module */
+ p_intf->p_cfg = NULL;
+ char *psz_parser = *psz_module == '$'
+ ? var_CreateGetString(p_intf,psz_module+1)
+ : strdup( psz_module );
+ char *psz_tmp = config_ChainCreate( &p_intf->psz_intf, &p_intf->p_cfg,
+ psz_parser );
+ free( psz_tmp );
+ free( psz_parser );
+ p_intf->p_module = module_need( p_intf, "interface", p_intf->psz_intf, true );
if( p_intf->p_module == NULL )
{
msg_Err( p_intf, "no suitable interface module" );
- vlc_object_destroy( p_intf );
- return NULL;
+ goto error;
}
- /* Initialize structure */
- p_intf->b_menu = VLC_FALSE;
- p_intf->b_menu_change = VLC_FALSE;
-
- /* Initialize mutexes */
- vlc_mutex_init( p_intf, &p_intf->change_lock );
-
- /* Attach interface to its parent object */
- vlc_object_attach( p_intf, p_this );
-
- return p_intf;
-}
-
-/*****************************************************************************
- * intf_RunThread: launch the interface thread
- *****************************************************************************
- * This function either creates a new thread and runs the interface in it,
- * or runs the interface in the current thread, depending on b_block.
- *****************************************************************************/
-/**
- * Run the interface thread.
- *
- * If b_block is not set, runs the interface in the thread, else,
- * creates a new thread and runs the interface.
- * \param p_intf the interface thread
- * \return VLC_SUCCESS on success, an error number else
- */
-int intf_RunThread( intf_thread_t *p_intf )
-{
-#ifdef __APPLE__
- NSAutoreleasePool * o_pool;
-
- if( p_intf->b_block )
+ vlc_mutex_lock( &lock );
+#if defined( __APPLE__ )
+ /* Hack to get Mac OS X Cocoa runtime running
+ * (it needs access to the main thread) */
+ if( p_intf->b_should_run_on_first_thread )
{
- /* This is the primary intf */
- /* Run a manager thread, launch the interface, kill the manager */
- if( vlc_thread_create( p_intf, "manage", Manager,
- VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
+ if( vlc_thread_create( p_intf, "interface", MonitorLibVLCDeath,
+ VLC_THREAD_PRIORITY_LOW ) )
{
- msg_Err( p_intf, "cannot spawn manager thread" );
- return VLC_EGENERIC;
+ msg_Err( p_intf, "cannot spawn libvlc death monitoring thread" );
+ vlc_mutex_unlock( &lock );
+ goto error;
}
- }
-
- if( p_intf->b_block && strncmp( p_intf->p_libvlc->psz_object_name,
- "clivlc", 6) )
- {
- o_pool = [[NSAutoreleasePool alloc] init];
- [VLCApplication sharedApplication];
- [NSApp setVLC: p_intf->p_libvlc];
- }
+ assert( p_intf->pf_run );
+ p_intf->pf_run( p_intf );
- if( p_intf->b_block &&
- ( !strncmp( p_intf->p_module->psz_object_name, "macosx" , 6 ) ||
- !strncmp( p_intf->p_libvlc->psz_object_name, "clivlc", 6 ) ) )
- {
- /* VLC in normal primary interface mode */
- RunInterface( p_intf );
- p_intf->b_die = VLC_TRUE;
+ /* It is monitoring libvlc, not the p_intf */
+ vlc_object_kill( p_intf->p_libvlc );
}
else
+#endif
+ /* Run the interface in a separate thread */
+ if( p_intf->pf_run
+ && vlc_thread_create( p_intf, "interface", RunInterface,
+ VLC_THREAD_PRIORITY_LOW ) )
{
- /* This interface doesn't need to be run */
- if( !p_intf->pf_run )
- return VLC_SUCCESS;
-
- /* Run the interface in a separate thread */
- if( !strcmp( p_intf->p_module->psz_object_name, "macosx" ) )
- {
- msg_Err( p_intf, "You cannot run the MacOS X module as an "
- "extra interface. Please read the "
- "README.MacOSX.rtf file.");
- return VLC_EGENERIC;
- }
- if( vlc_thread_create( p_intf, "interface", RunInterface,
- VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
- {
- msg_Err( p_intf, "cannot spawn interface thread" );
- return VLC_EGENERIC;
- }
-
- if( p_intf->b_block )
- {
- /* VLC in primary interface mode with a working macosx vout */
- [NSApp run];
- p_intf->b_die = VLC_TRUE;
- }
+ msg_Err( p_intf, "cannot spawn interface thread" );
+ vlc_mutex_unlock( &lock );
+ goto error;
}
-#else
- if( p_intf->b_block )
- {
- /* If the main interface does not have a run function,
- * implement a waiting loop ourselves
- */
- if( p_intf->pf_run )
- RunInterface( p_intf );
- else
- {
- while( !intf_ShouldDie( p_intf ) )
- msleep( INTF_IDLE_SLEEP * 2);
- }
- p_intf->b_die = VLC_TRUE;
- }
- else
- {
- /* This interface doesn't need to be run */
- if( !p_intf->pf_run )
- return VLC_SUCCESS;
- /* Run the interface in a separate thread */
- if( vlc_thread_create( p_intf, "interface", RunInterface,
- VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
- {
- msg_Err( p_intf, "cannot spawn interface thread" );
- return VLC_EGENERIC;
- }
- }
-#endif
+ p_intf->p_next = libvlc_priv( p_libvlc )->p_intf;
+ libvlc_priv( p_libvlc )->p_intf = p_intf;
+ vlc_mutex_unlock( &lock );
return VLC_SUCCESS;
-}
-/**
- * Stops the interface thread
- *
- * This function asks the interface thread to stop
- * \param p_intf the interface thread
- * \return nothing
- */
-void intf_StopThread( intf_thread_t *p_intf )
-{
- /* Tell the interface to die */
- if( !p_intf->b_block )
- {
- p_intf->b_die = VLC_TRUE;
- if( p_intf->pf_run )
- {
- vlc_cond_signal( &p_intf->object_wait );
- vlc_thread_join( p_intf );
- }
- }
+error:
+ if( p_intf->p_module )
+ module_unneed( p_intf, p_intf->p_module );
+ config_ChainDestroy( p_intf->p_cfg );
+ free( p_intf->psz_intf );
+ vlc_object_release( p_intf );
+ return VLC_EGENERIC;
}
+
/**
- * \brief Destroy the interface after the main loop endeed.
- *
- * Destroys interfaces and closes output devices
- * \param p_intf the interface thread
- * \return nothing
+ * Stops and destroys all interfaces
+ * @param p_libvlc the LibVLC instance
*/
-void intf_Destroy( intf_thread_t *p_intf )
+void intf_DestroyAll( libvlc_int_t *p_libvlc )
{
- /* Unlock module if present (a switch may have failed) */
- if( p_intf->p_module )
- {
- module_Unneed( p_intf, p_intf->p_module );
- }
-
- vlc_mutex_destroy( &p_intf->change_lock );
-
- /* Free structure */
- vlc_object_destroy( p_intf );
-}
+ intf_thread_t *p_first;
+ vlc_mutex_lock( &lock );
+ p_first = libvlc_priv( p_libvlc )->p_intf;
+#ifndef NDEBUG
+ libvlc_priv( p_libvlc )->p_intf = NULL;
+#endif
+ vlc_mutex_unlock( &lock );
-/* Following functions are local */
+ /* Tell the interfaces to die */
+ for( intf_thread_t *p_intf = p_first; p_intf; p_intf = p_intf->p_next )
+ vlc_object_kill( p_intf );
-/*****************************************************************************
- * Manager: helper thread for blocking OS X
- *****************************************************************************/
-#ifdef __APPLE__
-static void Manager( intf_thread_t *p_intf )
-{
- while( !p_intf->b_die )
+ /* Cleanup the interfaces */
+ for( intf_thread_t *p_intf = p_first; p_intf != NULL; )
{
- msleep( INTF_IDLE_SLEEP );
+ intf_thread_t *p_next = p_intf->p_next;
- if( p_intf->p_libvlc->b_die )
- {
- p_intf->b_die = VLC_TRUE;
- if( strncmp( p_intf->p_libvlc->psz_object_name, "clivlc", 6 ) )
- {
- [NSApp stop: NULL];
- }
- return;
- }
+ if( p_intf->pf_run )
+ vlc_thread_join( p_intf );
+ module_unneed( p_intf, p_intf->p_module );
+ free( p_intf->psz_intf );
+ config_ChainDestroy( p_intf->p_cfg );
+ vlc_object_release( p_intf );
+
+ p_intf = p_next;
}
}
-#endif
-/*****************************************************************************
+/* Following functions are local */
+
+/**
* RunInterface: setups necessary data and give control to the interface
- *****************************************************************************/
-static void RunInterface( intf_thread_t *p_intf )
+ *
+ * @param p_this: interface object
+ */
+static void* RunInterface( vlc_object_t *p_this )
{
- static const char *ppsz_interfaces[] =
- {
- "skins2", "Skins 2",
-#ifndef WIN32
- "wxwidgets", "wxWidgets",
-#endif
- NULL, NULL
- };
- const char **ppsz_parser;
-
- vlc_list_t *p_list;
- int i;
- vlc_value_t val, text;
- char *psz_intf;
-
- /* Variable used for interface switching */
- p_intf->psz_switch_intf = NULL;
- var_Create( p_intf, "intf-switch", VLC_VAR_STRING |
- VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
- text.psz_string = _("Switch interface");
- var_Change( p_intf, "intf-switch", VLC_VAR_SETTEXT, &text, NULL );
-
- /* Only fill the list with available modules */
- p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
- for( ppsz_parser = ppsz_interfaces; *ppsz_parser; ppsz_parser += 2 )
- {
- for( i = 0; i < p_list->i_count; i++ )
- {
- module_t *p_module = (module_t *)p_list->p_values[i].p_object;
- if( !strcmp( p_module->psz_object_name, ppsz_parser[0] ) )
- {
- val.psz_string = (char *)ppsz_parser[0];
- text.psz_string = (char *)_(ppsz_parser[1]);
- var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE,
- &val, &text );
- break;
- }
- }
- }
- vlc_list_release( p_list );
-
- var_AddCallback( p_intf, "intf-switch", SwitchIntfCallback, NULL );
-
- /* Variable used for interface spawning */
- var_Create( p_intf, "intf-add", VLC_VAR_STRING |
- VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
- text.psz_string = _("Add Interface");
- var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
-
- val.psz_string = (char *)"rc"; text.psz_string = (char *)"Console";
- var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
- val.psz_string = (char *)"telnet";
- text.psz_string = (char *)_("Telnet Interface");
- var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
- val.psz_string = (char *)"http";
- text.psz_string = (char *)_("Web Interface");
- var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
- val.psz_string = (char *)"logger";
- text.psz_string = (char *)_("Debug logging");
- var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
- val.psz_string = (char *)"gestures";
- text.psz_string = (char *)_("Mouse Gestures");
- var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
-
- var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
-
- do
- {
- /* Give control to the interface */
- p_intf->pf_run( p_intf );
-
- /* Reset play on start status */
- p_intf->b_play = VLC_FALSE;
-
- if( !p_intf->psz_switch_intf )
- {
- break;
- }
-
- /* Make sure the old interface is completely uninitialized */
- module_Unneed( p_intf, p_intf->p_module );
-
- /* Provide ability to switch the main interface on the fly */
- psz_intf = p_intf->psz_switch_intf;
- p_intf->psz_switch_intf = NULL;
-
- vlc_mutex_lock( &p_intf->object_lock );
- p_intf->b_die = VLC_FALSE;
- p_intf->b_dead = VLC_FALSE;
- vlc_mutex_unlock( &p_intf->object_lock );
+ intf_thread_t *p_intf = (intf_thread_t *)p_this;
- p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
- free( psz_intf );
- }
- while( p_intf->p_module );
+ p_intf->pf_run( p_intf );
+ return NULL;
}
-static int SwitchIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
- vlc_value_t oldval, vlc_value_t newval, void *p_data )
+#if defined( __APPLE__ )
+#include "control/libvlc_internal.h" /* libvlc_InternalWait */
+/**
+ * MonitorLibVLCDeath: Used when b_should_run_on_first_thread is set.
+ *
+ * @param p_this: the interface object
+ */
+static void * MonitorLibVLCDeath( vlc_object_t * p_this )
{
intf_thread_t *p_intf = (intf_thread_t *)p_this;
+ libvlc_int_t * p_libvlc = p_intf->p_libvlc;
+ int canc = vlc_savecancel ();
- p_intf->psz_switch_intf =
- malloc( strlen(newval.psz_string) + sizeof(",none") );
- sprintf( p_intf->psz_switch_intf, "%s,none", newval.psz_string );
- p_intf->b_die = VLC_TRUE;
+ libvlc_InternalWait( p_libvlc );
- return VLC_SUCCESS;
+ vlc_object_kill( p_intf ); /* Kill the stupid first thread interface */
+ vlc_restorecancel (canc);
+ return NULL;
}
+#endif
static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
- intf_thread_t *p_intf;
- char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
+ (void)psz_cmd; (void)oldval; (void)p_data;
+ char* psz_intf;
/* Try to create the interface */
- sprintf( psz_intf, "%s,none", newval.psz_string );
- p_intf = intf_Create( p_this->p_libvlc, psz_intf, 0, NULL );
+ if( asprintf( &psz_intf, "%s,none", newval.psz_string ) == -1 )
+ return VLC_ENOMEM;
+
+ int ret = intf_Create( VLC_OBJECT(p_this->p_libvlc), psz_intf );
free( psz_intf );
- if( p_intf == NULL )
- {
+ if( ret )
msg_Err( p_this, "interface \"%s\" initialization failed",
newval.psz_string );
- return VLC_EGENERIC;
- }
-
- /* Try to run the interface */
- p_intf->b_block = VLC_FALSE;
- if( intf_RunThread( p_intf ) != VLC_SUCCESS )
- {
- vlc_object_detach( p_intf );
- intf_Destroy( p_intf );
- return VLC_EGENERIC;
- }
-
- return VLC_SUCCESS;
-}
-
-#ifdef __APPLE__
-/*****************************************************************************
- * VLCApplication implementation
- *****************************************************************************/
-@implementation VLCApplication
-
-- (void)setVLC: (libvlc_int_t *) p_libvlc
-{
- o_libvlc = p_libvlc;
-}
-
-- (void)stop: (id)sender
-{
- NSEvent *o_event;
- NSAutoreleasePool *o_pool;
- [super stop:sender];
-
- o_pool = [[NSAutoreleasePool alloc] init];
- /* send a dummy event to break out of the event loop */
- o_event = [NSEvent mouseEventWithType: NSLeftMouseDown
- location: NSMakePoint( 1, 1 ) modifierFlags: 0
- timestamp: 1 windowNumber: [[NSApp mainWindow] windowNumber]
- context: [NSGraphicsContext currentContext] eventNumber: 1
- clickCount: 1 pressure: 0.0];
- [NSApp postEvent: o_event atStart: YES];
- [o_pool release];
+ return ret;
}
-
-- (void)terminate: (id)sender
-{
- o_libvlc->b_die = VLC_TRUE;
-}
-
-@end
-#endif
-
projects / vlc / blobdiff