* This library provides basic functions for threads to interact with user
* interface, such as command line.
*****************************************************************************
- * Copyright (C) 1998-2001 VideoLAN
- * $Id: interface.c,v 1.96 2002/06/04 00:11:12 sam Exp $
+ * Copyright (C) 1998-2007 the VideoLAN team
+ * $Id$
*
* Authors: Vincent Seguin <seguin@via.ecp.fr>
*
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
- *
+ *
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
+/**
+ * \file
+ * This file contains functions related to interface management
+ */
+
+
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <errno.h> /* ENOMEM */
-#include <stdlib.h> /* free(), strtol() */
-#include <stdio.h> /* FILE */
-#include <string.h> /* strerror() */
-#include <sys/types.h> /* off_t */
-
-#include <vlc/vlc.h>
-#include "stream_control.h"
-#include "input_ext-intf.h"
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
-#include "audio_output.h"
+#include <assert.h>
+#include <vlc_common.h>
-#include "interface.h"
+#include <vlc_aout.h>
+#include <vlc_vout.h>
-#include "video.h"
-#include "video_output.h"
+#include "vlc_interface.h"
+#if defined( __APPLE__ ) || defined( WIN32 )
+#include "../control/libvlc_internal.h"
+#endif
+#include "libvlc.h"
/*****************************************************************************
* Local prototypes
*****************************************************************************/
-static void Manager( intf_thread_t *p_intf );
-
-/*****************************************************************************
- * intf_Create: prepare interface before main loop
- *****************************************************************************
- * This function opens output devices and creates specific interfaces. It sends
- * its own error messages.
- *****************************************************************************/
-intf_thread_t* __intf_Create( vlc_object_t *p_this )
+static void* RunInterface( vlc_object_t *p_this );
+#if defined( __APPLE__ ) || defined( WIN32 )
+static void * MonitorLibVLCDeath( vlc_object_t *p_this );
+#endif
+static int AddIntfCallback( vlc_object_t *, char const *,
+ vlc_value_t , vlc_value_t , void * );
+
+static vlc_mutex_t lock = VLC_STATIC_MUTEX;
+
+#undef intf_Create
+/**
+ * Create and start an interface.
+ *
+ * @param p_this the calling vlc_object_t
+ * @param psz_module a preferred interface module
+ * @return VLC_SUCCESS or an error code
+ */
+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;
- char *psz_name;
+ 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;
- }
+ return VLC_ENOMEM;
+
+ /* 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 );
+
+ 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__ ) || defined( WIN32 )
+ p_intf->b_should_run_on_first_thread = false;
+#endif
/* Choose the best module */
- psz_name = config_GetPsz( p_intf, "intf" );
- p_intf->p_module = module_Need( p_intf, MODULE_CAPABILITY_INTF,
- psz_name, (void *)p_intf );
-
- if( psz_name ) free( psz_name );
+ 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 intf module" );
- vlc_object_destroy( p_intf );
- return NULL;
+ msg_Err( p_intf, "no suitable interface module" );
+ goto error;
}
-#define f p_intf->p_module->p_functions->intf.functions.intf
- p_intf->pf_open = f.pf_open;
- p_intf->pf_close = f.pf_close;
- p_intf->pf_run = f.pf_run;
-#undef f
-
- /* Initialize structure */
- p_intf->b_menu = 0;
- p_intf->b_menu_change = 0;
-
- /* Initialize mutexes */
- vlc_mutex_init( p_intf, &p_intf->change_lock );
-
- msg_Dbg( p_intf, "interface initialized" );
-
- /* 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.
- *****************************************************************************/
-vlc_error_t intf_RunThread( intf_thread_t *p_intf )
-{
- if( p_intf->b_block )
+ vlc_mutex_lock( &lock );
+ if( !vlc_object_alive( p_libvlc ) )
{
- /* Run a manager thread, launch the interface, kill the manager */
- if( vlc_thread_create( p_intf, "manager", Manager, 0 ) )
+ vlc_mutex_unlock( &lock );
+ goto error; /* Too late! */
+ }
+#if defined( __APPLE__ ) || defined( WIN32 )
+ /* 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 )
+ {
+ 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;
}
-
+ assert( p_intf->pf_run );
p_intf->pf_run( p_intf );
- p_intf->b_die = 1;
-
- /* Do not join the thread... intf_StopThread will do it for us */
+ /* 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 ) )
{
- /* Run the interface in a separate thread */
- if( vlc_thread_create( p_intf, "interface", p_intf->pf_run, 0 ) )
- {
- msg_Err( p_intf, "cannot spawn interface thread" );
- return VLC_EGENERIC;
- }
+ msg_Err( p_intf, "cannot spawn interface thread" );
+ vlc_mutex_unlock( &lock );
+ goto error;
}
+ 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;
+
+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;
}
-/*****************************************************************************
- * intf_StopThread: end the interface thread
- *****************************************************************************
- * This function asks the interface thread to stop.
- *****************************************************************************/
-void intf_StopThread( intf_thread_t *p_intf )
+
+/**
+ * Stops and destroys all interfaces
+ * @param p_libvlc the LibVLC instance
+ */
+void intf_DestroyAll( libvlc_int_t *p_libvlc )
{
- /* Tell the interface to die */
- if( !p_intf->b_block )
- {
- p_intf->b_die = 1;
- }
+ intf_thread_t *p_first;
- /* Wait for the thread to exit */
- vlc_thread_join( p_intf );
-}
+ assert( !vlc_object_alive( p_libvlc ) );
-/*****************************************************************************
- * intf_Destroy: clean interface after main loop
- *****************************************************************************
- * This function destroys specific interfaces and close output devices.
- *****************************************************************************/
-void intf_Destroy( intf_thread_t *p_intf )
-{
- /* Destroy interface */
- p_intf->pf_close( p_intf );
+ 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 );
- /* Unlock module */
- module_Unneed( p_intf->p_module );
+ /* 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 );
- vlc_mutex_destroy( &p_intf->change_lock );
+ /* Cleanup the interfaces */
+ for( intf_thread_t *p_intf = p_first; p_intf != NULL; )
+ {
+ intf_thread_t *p_next = p_intf->p_next;
- /* Free structure */
- vlc_object_destroy( p_intf );
+ 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;
+ }
}
/* Following functions are local */
-/*****************************************************************************
- * Manager: helper thread for blocking interfaces
- *****************************************************************************
- * If the interface is launched in the main thread, it will not listen to
- * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die.
- * This thread takes care of the matter.
- *****************************************************************************/
-static void Manager( intf_thread_t *p_intf )
+/**
+ * RunInterface: setups necessary data and give control to the interface
+ *
+ * @param p_this: interface object
+ */
+static void* RunInterface( vlc_object_t *p_this )
{
- while( !p_intf->b_die )
- {
- msleep( INTF_IDLE_SLEEP );
+ intf_thread_t *p_intf = (intf_thread_t *)p_this;
- if( p_intf->p_vlc->b_die )
- {
- p_intf->b_die = 1;
- return;
- }
- }
+ p_intf->pf_run( p_intf );
+ return NULL;
}
+#if defined( __APPLE__ ) || defined( WIN32 )
+#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 ();
+
+ libvlc_InternalWait( p_libvlc );
+
+ 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 )
+{
+ (void)psz_cmd; (void)oldval; (void)p_data;
+ char* psz_intf;
+
+ /* Try to create the interface */
+ 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( ret )
+ msg_Err( p_this, "interface \"%s\" initialization failed",
+ newval.psz_string );
+ return ret;
+}
projects / vlc / blobdiff