* 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.90 2002/02/24 20:51:10 gbazin 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 <videolan/vlc.h>
-#include "stream_control.h"
-#include "input_ext-intf.h"
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
-#include "audio_output.h"
+#include <vlc_common.h>
-#include "interface.h"
-#include "intf_playlist.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 intf_Manage( intf_thread_t *p_intf );
+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 * );
-/*****************************************************************************
- * 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( void )
+/**
+ * Destroy the interface after the main loop endeed.
+ *
+ * @param p_obj: the interface thread
+ */
+static void intf_Destroy( vlc_object_t *obj )
+{
+ intf_thread_t *p_intf = (intf_thread_t *)obj;
+
+ free( p_intf->psz_intf );
+ config_ChainDestroy( p_intf->p_cfg );
+}
+
+
+#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 )
{
intf_thread_t * p_intf;
- char *psz_name;
/* Allocate structure */
- p_intf = malloc( sizeof( intf_thread_t ) );
+ p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
if( !p_intf )
- {
- intf_ErrMsg( "intf error: cannot create interface thread (%s)",
- strerror( ENOMEM ) );
- return( NULL );
- }
+ return VLC_ENOMEM;
- /* Choose the best module */
- psz_name = config_GetPszVariable( INTF_METHOD_VAR );
- p_intf->p_module = module_Need( MODULE_CAPABILITY_INTF, psz_name,
- (void *)p_intf );
+ /* Attach interface to its parent object */
+ vlc_object_attach( p_intf, p_this );
+ vlc_object_set_destructor( p_intf, intf_Destroy );
+#if defined( __APPLE__ ) || defined( WIN32 )
+ p_intf->b_should_run_on_first_thread = false;
+#endif
- if( psz_name ) free( psz_name );
+ /* 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 )
{
- intf_ErrMsg( "intf error: no suitable intf module" );
- free( p_intf );
- return( NULL );
+ msg_Err( p_intf, "no suitable interface module" );
+ vlc_object_release( p_intf );
+ return VLC_EGENERIC;
}
-#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 callbacks */
- p_intf->pf_manage = intf_Manage;
-
- /* Initialize structure */
- p_intf->b_die = 0;
+#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 libvlc death monitoring thread" );
+ vlc_object_release( p_intf );
+ return VLC_ENOMEM;
+ }
+ RunInterface( VLC_OBJECT(p_intf) );
- p_intf->b_menu = 0;
- p_intf->b_menu_change = 0;
+ /* Make sure our MonitorLibVLCDeath thread exit */
+ vlc_object_kill( p_intf );
+ /* It is monitoring libvlc, not the p_intf */
+ vlc_object_kill( p_intf->p_libvlc );
+ vlc_thread_join( p_intf );
- /* Initialize mutexes */
- vlc_mutex_init( &p_intf->change_lock );
+ vlc_object_detach( p_intf );
+ vlc_object_release( p_intf );
+ return VLC_SUCCESS;
+ }
+#endif
+ /* Run the interface in a separate thread */
+ if( vlc_thread_create( p_intf, "interface", RunInterface,
+ VLC_THREAD_PRIORITY_LOW ) )
+ {
+ msg_Err( p_intf, "cannot spawn interface thread" );
+ vlc_object_release( p_intf );
+ return VLC_EGENERIC;
+ }
- intf_WarnMsg( 1, "intf: interface initialized");
- return( p_intf );
+ return VLC_SUCCESS;
}
-/*****************************************************************************
- * intf_Manage: manage interface
- *****************************************************************************
- * This function has to be called regularly by the interface plugin. It
- * checks for playlist end, module expiration, message flushing, and a few
- * other useful things.
- *****************************************************************************/
-static void intf_Manage( intf_thread_t *p_intf )
-{
- /* Manage module bank */
- module_ManageBank( );
- vlc_mutex_lock( &p_input_bank->lock );
-
- if( p_input_bank->i_count )
- {
- int i_input;
- input_thread_t *p_input;
+/**
+ * Stops the interface thread
+ *
+ * This function asks the interface thread to stop
+ * @param p_intf the interface thread
+ */
+void intf_StopThread( intf_thread_t *p_intf )
+{
+ /* Tell the interface to die */
+ vlc_object_kill( p_intf );
+ vlc_thread_join( p_intf );
- for( i_input = 0; i_input < p_input_bank->i_count; i_input++ )
- {
- p_input = p_input_bank->pp_input[i_input];
-
- if( p_input->i_status == THREAD_OVER )
- {
- /* XXX: completely stupid ! */
- input_DestroyThread( p_input );
- p_input_bank->pp_input[i_input] = NULL;
- p_input_bank->i_count--;
- }
- else if( ( p_input->i_status == THREAD_READY
- || p_input->i_status == THREAD_ERROR )
- && ( p_input->b_error || p_input->b_eof ) )
- {
- input_StopThread( p_input, NULL );
- }
+ module_unneed( p_intf, p_intf->p_module );
+}
- }
- }
- /* If no stream is being played, try to find one */
- else
- {
-// vlc_mutex_lock( &p_main->p_playlist->change_lock );
- if( !p_main->p_playlist->b_stopped )
- {
- /* Select the next playlist item */
- intf_PlaylistNext( p_main->p_playlist );
-
- /* don't loop by default: stop at playlist end */
- if( p_main->p_playlist->i_index == -1 )
- {
- p_main->p_playlist->b_stopped = 1;
- }
- else
- {
- input_thread_t *p_input;
-
- p_main->p_playlist->b_stopped = 0;
- p_main->p_playlist->i_mode = PLAYLIST_FORWARD +
- config_GetIntVariable( PLAYLIST_LOOP_VAR );
- intf_WarnMsg( 3, "intf: creating new input thread" );
- p_input = input_CreateThread( &p_main->p_playlist->current,
- NULL );
- if( p_input != NULL )
- {
- p_input_bank->pp_input[ p_input_bank->i_count ] = p_input;
- p_input_bank->i_count++;
- }
- }
- }
- else
- {
- /* playing has been stopped: we no longer need outputs */
- if( p_aout_bank->i_count )
- {
- /* FIXME kludge that does not work with several outputs */
- aout_DestroyThread( p_aout_bank->pp_aout[0], NULL );
- p_aout_bank->i_count--;
- }
- if( p_vout_bank->i_count )
- {
- vout_DestroyThread( p_vout_bank->pp_vout[0], NULL );
- p_vout_bank->i_count--;
- }
- }
-// vlc_mutex_unlock( &p_main->p_playlist->change_lock );
- }
+/* Following functions are local */
- vlc_mutex_unlock( &p_input_bank->lock );
+/**
+ * RunInterface: setups necessary data and give control to the interface
+ *
+ * @param p_this: interface object
+ */
+static void* RunInterface( vlc_object_t *p_this )
+{
+ intf_thread_t *p_intf = (intf_thread_t *)p_this;
+ vlc_value_t val, text;
+ int canc = vlc_savecancel ();
+
+ /* 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 );
+ vlc_restorecancel (canc);
+
+ /* Give control to the interface */
+ if( p_intf->pf_run )
+ p_intf->pf_run( p_intf );
+
+ return NULL;
}
-/*****************************************************************************
- * intf_Destroy: clean interface after main loop
- *****************************************************************************
- * This function destroys specific interfaces and close output devices.
- *****************************************************************************/
-void intf_Destroy( intf_thread_t *p_intf )
+#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 )
{
- /* Destroy interfaces */
- p_intf->pf_close( p_intf );
-
-#if 0
- /* Close input thread, if any (blocking) */
- if( p_intf->p_input )
- {
- input_DestroyThread( p_intf->p_input, NULL );
- }
-#endif
-
- /* Unlock module */
- module_Unneed( p_intf->p_module );
+ intf_thread_t *p_intf = (intf_thread_t *)p_this;
+ libvlc_int_t * p_libvlc = p_intf->p_libvlc;
+ int canc = vlc_savecancel ();
- vlc_mutex_destroy( &p_intf->change_lock );
+ libvlc_InternalWait( p_libvlc );
- /* Free structure */
- free( p_intf );
+ 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( p_this->p_libvlc, psz_intf );
+ free( psz_intf );
+ if( ret )
+ msg_Err( p_this, "interface \"%s\" initialization failed",
+ newval.psz_string );
+ return ret;
+}