* This library provides basic functions for threads to interact with user
* interface, such as command line.
*****************************************************************************
- * Copyright (C) 1998, 1999, 2000 VideoLAN
+ * Copyright (C) 1998-2007 the VideoLAN team
+ * $Id$
*
- * Authors:
+ * Authors: Vincent Seguin <seguin@via.ecp.fr>
*
* This program is free software; you can redistribute it and/or modify
* 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 "defs.h"
-
-#include <errno.h> /* ENOMEM */
-#include <stdlib.h> /* free(), strtol() */
-#include <stdio.h> /* FILE */
-#include <string.h> /* strerror() */
-
-#include "config.h"
-#include "common.h"
-#include "threads.h"
-#include "mtime.h"
-#include "modules.h"
-
-#include "stream_control.h"
-#include "input_ext-intf.h"
-#include "audio_output.h"
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
-#include "intf_msg.h"
-#include "interface.h"
-#include "intf_cmd.h"
-#include "intf_plst.h"
-#include "intf_channels.h"
-#include "keystrokes.h"
+#include <vlc_common.h>
-#include "video.h"
-#include "video_output.h"
+#include <vlc_aout.h>
+#include <vlc_vout.h>
-#include "main.h"
+#include "vlc_interface.h"
+#include "modules/modules.h" // Gruik!
+#include "libvlc.h"
/*****************************************************************************
* Local prototypes
*****************************************************************************/
-static void intf_Manage( intf_thread_t *p_intf );
+static void RunInterface( intf_thread_t *p_intf );
+#ifdef __APPLE__
+static void MonitorLibVLCDeath( intf_thread_t *p_intf );
+#endif
+static int AddIntfCallback( vlc_object_t *, char const *,
+ vlc_value_t , vlc_value_t , void * );
+
+/**
+ * \brief Destroy the interface after the main loop endeed.
+ *
+ * \param p_intf the interface thread
+ * \return nothing
+ */
+static void intf_Destroy( vlc_object_t *obj )
+{
+ intf_thread_t *p_intf = (intf_thread_t *)obj;
+
+ /* Unlock module if present (a switch may have failed) */
+ if( p_intf->p_module )
+ module_Unneed( p_intf, p_intf->p_module );
+
+ free( p_intf->psz_intf );
+ vlc_mutex_destroy( &p_intf->change_lock );
+}
/*****************************************************************************
* 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 )
+/**
+ * Create the interface, and prepare it for main loop.
+ *
+ * \param p_this the calling vlc_object_t
+ * \param psz_module a preferred interface module
+ * \return a pointer to the created interface thread, NULL on error
+ */
+intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module )
{
intf_thread_t * p_intf;
/* 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 NULL;
+ p_intf->b_interaction = false;
+#ifdef __APPLE__
+ p_intf->b_should_run_on_first_thread = false;
+#endif
/* Choose the best module */
- p_intf->p_module = module_Need( p_main->p_bank,
- MODULE_CAPABILITY_INTF, NULL );
+ p_intf->psz_intf = strdup( psz_module );
+ p_intf->p_module = module_Need( p_intf, "interface", psz_module, false );
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" );
+ free( p_intf->psz_intf );
+ vlc_object_release( p_intf );
+ return NULL;
}
-#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;
-
- p_intf->p_input = NULL;
- p_intf->p_keys = NULL;
- p_intf->b_menu = 0;
- p_intf->b_menu_change = 0;
-
- if( p_intf->pf_open( p_intf ) )
- {
- intf_ErrMsg("intf error: cannot create interface");
- module_Unneed( p_main->p_bank, p_intf->p_module );
- free( p_intf );
- return( NULL );
- }
+ p_intf->b_menu = false;
+ p_intf->b_menu_change = false;
/* Initialize mutexes */
vlc_mutex_init( &p_intf->change_lock );
- /* Load channels - the pointer will be set to NULL on failure. The
- * return value is ignored since the program can work without
- * channels */
- intf_LoadChannels( p_intf, main_GetPszVariable( INTF_CHANNELS_VAR,
- INTF_CHANNELS_DEFAULT ));
+ /* Attach interface to its parent object */
+ vlc_object_attach( p_intf, p_this );
+ vlc_object_set_destructor( p_intf, intf_Destroy );
- intf_Msg("intf: interface initialized");
- return( p_intf );
+ return p_intf;
}
/*****************************************************************************
- * intf_Manage: manage interface
+ * intf_RunThread: launch the interface thread
*****************************************************************************
- * 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.
+ * This function either creates a new thread and runs the interface in it.
*****************************************************************************/
-static void intf_Manage( intf_thread_t *p_intf )
+/**
+ * Starts and runs the interface thread.
+ *
+ * \param p_intf the interface thread
+ * \return VLC_SUCCESS on success, an error number else
+ */
+int intf_RunThread( intf_thread_t *p_intf )
{
- /* Flush waiting messages */
- intf_FlushMsg();
+#ifdef __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 )
+ {
+ if( vlc_thread_create( p_intf, "interface", MonitorLibVLCDeath,
+ VLC_THREAD_PRIORITY_LOW, false ) )
+ {
+ msg_Err( p_intf, "cannot spawn libvlc death monitoring thread" );
+ return VLC_EGENERIC;
+ }
+ RunInterface( p_intf );
- /* Manage module bank */
- module_ManageBank( p_main->p_bank );
+ /* Make sure our MonitorLibVLCDeath thread exit */
+ vlc_object_kill( p_intf );
+ /* It is monitoring libvlc, not the p_intf */
+ vlc_object_signal( p_intf->p_libvlc );
+ vlc_thread_join( p_intf );
- if( ( p_intf->p_input != NULL ) &&
- ( p_intf->p_input->b_error || p_intf->p_input->b_eof ) )
+ 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, false ) )
{
- input_DestroyThread( p_intf->p_input, NULL );
- p_intf->p_input = NULL;
- intf_DbgMsg("Input thread destroyed");
+ msg_Err( p_intf, "cannot spawn interface thread" );
+ return VLC_EGENERIC;
}
- /* If no stream is being played, try to find one */
- if( p_intf->p_input == NULL && !p_intf->b_die )
- {
- /* Select the next playlist item */
- intf_PlstNext( p_main->p_playlist );
+ return VLC_SUCCESS;
+}
- if( p_main->p_playlist->i_index == -1 )
- {
- /* FIXME: wait for user to add stuff to playlist ? */
-#if 0
- p_intf->b_die = 1;
-#endif
- }
- else
- {
- p_intf->p_input =
- input_CreateThread( &p_main->p_playlist->current, NULL );
- }
- }
+/**
+ * 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 */
+ vlc_object_kill( p_intf );
+ vlc_thread_join( p_intf );
}
+/* Following functions are local */
+
/*****************************************************************************
- * intf_Destroy: clean interface after main loop
- *****************************************************************************
- * This function destroys specific interfaces and close output devices.
+ * RunInterface: setups necessary data and give control to the interface
*****************************************************************************/
-void intf_Destroy( intf_thread_t *p_intf )
+static void RunInterface( intf_thread_t *p_intf )
{
- p_intf_key p_cur;
- p_intf_key p_next;
+ vlc_value_t val, text;
+ char *psz_intf;
+
+ /* 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 */
+ if( p_intf->pf_run )
+ p_intf->pf_run( p_intf );
+ else
+ {
+ vlc_object_lock( p_intf );
+ while( vlc_object_alive( p_intf ) )
+ vlc_object_wait( p_intf );
+ vlc_object_unlock( p_intf );
+ }
- /* Unload channels */
- intf_UnloadChannels( p_intf );
+ if( !p_intf->psz_switch_intf )
+ {
+ break;
+ }
- /* Destroy interfaces */
- p_intf->pf_close( p_intf );
+ /* Make sure the old interface is completely uninitialized */
+ module_Unneed( p_intf, p_intf->p_module );
- /* Close input thread, if any (blocking) */
- if( p_intf->p_input )
- {
- input_DestroyThread( p_intf->p_input, NULL );
- }
+ /* Provide ability to switch the main interface on the fly */
+ psz_intf = p_intf->psz_switch_intf;
+ p_intf->psz_switch_intf = NULL;
- /* Destroy keymap */
- p_cur = p_intf->p_keys;
- while( p_cur != NULL)
- {
- p_next = p_cur->next;
- free(p_cur);
- p_cur = p_next;
- }
-
- /* Unlock module */
- module_Unneed( p_main->p_bank, p_intf->p_module );
+ vlc_object_lock( p_intf );
+ p_intf->b_die = false; /* FIXME */
+ p_intf->b_dead = false;
- vlc_mutex_destroy( &p_intf->change_lock );
+ vlc_object_unlock( p_intf );
- /* Free structure */
- free( p_intf );
+ p_intf->psz_intf = psz_intf;
+ p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
+ }
+ while( p_intf->p_module );
}
+#ifdef __APPLE__
/*****************************************************************************
- * intf_AssignKey: assign standartkeys *
- *****************************************************************************
- * This function fills in the associative array that links the key pressed *
- * and the key we use internally. Support one extra parameter. *
- ****************************************************************************/
-void intf_AssignKey( intf_thread_t *p_intf, int r_key, int f_key, int param)
+ * MonitorLibVLCDeath: Used when b_should_run_on_first_thread is set.
+ *****************************************************************************/
+static void MonitorLibVLCDeath( intf_thread_t *p_intf )
{
- p_intf_key p_cur = p_intf->p_keys;
- if( p_cur == NULL )
- {
- p_cur = (p_intf_key )(malloc ( sizeof( intf_key ) ) );
- p_cur->received_key = r_key;
- p_cur->forwarded.key = f_key;
- p_cur->forwarded.param = param;
- p_cur->next = NULL;
- p_intf->p_keys = p_cur;
- }
- else
+ libvlc_int_t * p_libvlc = p_intf->p_libvlc;
+ vlc_object_lock( p_libvlc );
+ while(vlc_object_alive( p_libvlc ) )
{
- while( p_cur->next != NULL && p_cur ->received_key != r_key)
+ if(p_intf->b_die)
{
- p_cur = p_cur->next;
- }
- if( p_cur->next == NULL )
- {
- p_cur->next = ( p_intf_key )( malloc( sizeof( intf_key ) ) );
- p_cur = p_cur->next;
- p_cur->next = NULL;
- p_cur->forwarded.param = param;
- p_cur->received_key = r_key;
+ vlc_object_unlock( p_libvlc );
+ return;
}
- p_cur->forwarded.key = f_key;
- }
-}
-
-/* Basic getKey function... */
-keyparm intf_GetKey( intf_thread_t *p_intf, int r_key)
-{
- keyparm reply;
-
- p_intf_key current = p_intf->p_keys;
- while(current != NULL && current->received_key != r_key)
- {
- current = current->next;
+ vlc_object_wait( p_libvlc );
}
- if(current == NULL)
- { /* didn't find any key in the array */
- reply.key = INTF_KEY_UNKNOWN;
- reply.param = 0;
- }
- else
+ vlc_object_unlock( p_libvlc );
+
+ /* Someone killed libvlc */
+
+ /* Make sure we kill all interface objects, especially
+ * those that are blocking libvlc (running on main thread) */
+ vlc_list_t * p_list = vlc_list_find( p_libvlc, VLC_OBJECT_INTF, FIND_CHILD );
+ for( int i = 0; i < p_list->i_count; i++ )
{
- reply.key = current->forwarded.key;
- reply.param = current->forwarded.param;
+ vlc_object_t * p_intf = p_list->p_values[i].p_object;
+ vlc_object_kill( p_intf );
}
- return reply;
+ vlc_list_release( p_list );
}
+#endif
-/*****************************************************************************
-* intf_AssignNormalKeys: used for normal interfaces.
-*****************************************************************************
-* This function assign the basic key to the normal keys.
-*****************************************************************************/
-
-void intf_AssignNormalKeys( intf_thread_t *p_intf)
+static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
+ vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
- p_intf->p_intf_get_key = intf_GetKey;
-
- intf_AssignKey( p_intf , 'Q', INTF_KEY_QUIT, 0);
- intf_AssignKey( p_intf , 'q', INTF_KEY_QUIT, 0);
- intf_AssignKey( p_intf , 27, INTF_KEY_QUIT, 0);
- intf_AssignKey( p_intf , 3, INTF_KEY_QUIT, 0);
- intf_AssignKey( p_intf , '0', INTF_KEY_SET_CHANNEL, 0);
- intf_AssignKey( p_intf , '1', INTF_KEY_SET_CHANNEL, 1);
- intf_AssignKey( p_intf , '2', INTF_KEY_SET_CHANNEL, 2);
- intf_AssignKey( p_intf , '3', INTF_KEY_SET_CHANNEL, 3);
- intf_AssignKey( p_intf , '4', INTF_KEY_SET_CHANNEL, 4);
- intf_AssignKey( p_intf , '5', INTF_KEY_SET_CHANNEL, 5);
- intf_AssignKey( p_intf , '6', INTF_KEY_SET_CHANNEL, 6);
- intf_AssignKey( p_intf , '7', INTF_KEY_SET_CHANNEL, 7);
- intf_AssignKey( p_intf , '8', INTF_KEY_SET_CHANNEL, 8);
- intf_AssignKey( p_intf , '9', INTF_KEY_SET_CHANNEL, 9);
- intf_AssignKey( p_intf , '0', INTF_KEY_SET_CHANNEL, 0);
- intf_AssignKey( p_intf , '+', INTF_KEY_INC_VOLUME, 0);
- intf_AssignKey( p_intf , '-', INTF_KEY_DEC_VOLUME, 0);
- intf_AssignKey( p_intf , 'm', INTF_KEY_TOGGLE_VOLUME, 0);
- intf_AssignKey( p_intf , 'M', INTF_KEY_TOGGLE_VOLUME, 0);
- intf_AssignKey( p_intf , 'g', INTF_KEY_DEC_GAMMA, 0);
- intf_AssignKey( p_intf , 'G', INTF_KEY_INC_GAMMA, 0);
- intf_AssignKey( p_intf , 'c', INTF_KEY_TOGGLE_GRAYSCALE, 0);
- intf_AssignKey( p_intf , ' ', INTF_KEY_TOGGLE_INTERFACE, 0);
- intf_AssignKey( p_intf , 'i', INTF_KEY_TOGGLE_INFO, 0);
- intf_AssignKey( p_intf , 's', INTF_KEY_TOGGLE_SCALING, 0);
-}
+ intf_thread_t *p_intf;
+ char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
-/*****************************************************************************
- * intf_ProcessKey: process standard keys
- *****************************************************************************
- * This function will process standard keys and return non 0 if the key was
- * unknown.
- *****************************************************************************/
-int intf_ProcessKey( intf_thread_t *p_intf, int g_key )
-{
- static int i_volbackup;
- keyparm k_reply;
-
- k_reply = intf_GetKey( p_intf, g_key);
-
- switch( k_reply.key )
+ (void)psz_cmd; (void)oldval; (void)p_data;
+
+ /* Try to create the interface */
+ sprintf( psz_intf, "%s,none", newval.psz_string );
+ p_intf = intf_Create( p_this->p_libvlc, psz_intf );
+ free( psz_intf );
+ if( p_intf == NULL )
{
- case INTF_KEY_QUIT: /* quit order */
- p_intf->b_die = 1;
- break;
- case INTF_KEY_SET_CHANNEL:
- /* Change channel - return code is ignored since SelectChannel displays
- * its own error messages */
- intf_SelectChannel( p_intf, k_reply.param );
- break;
- case INTF_KEY_INC_VOLUME: /* volume + */
- if( (p_main->p_aout != NULL) && (p_main->p_aout->vol < VOLUME_MAX) )
- p_main->p_aout->vol += VOLUME_STEP;
- break;
- case INTF_KEY_DEC_VOLUME: /* volume - */
- if( (p_main->p_aout != NULL) && (p_main->p_aout->vol > VOLUME_STEP) )
- p_main->p_aout->vol -= VOLUME_STEP;
- break;
- case INTF_KEY_TOGGLE_VOLUME: /* toggle mute */
- if( (p_main->p_aout != NULL) && (p_main->p_aout->vol))
- {
- i_volbackup = p_main->p_aout->vol;
- p_main->p_aout->vol = 0;
- }
- else if( (p_main->p_aout != NULL) && (!p_main->p_aout->vol))
- p_main->p_aout->vol = i_volbackup;
- break;
- case INTF_KEY_DEC_GAMMA: /* gamma - */
- if( (p_main->p_vout != NULL) && (p_main->p_vout->f_gamma > -INTF_GAMMA_LIMIT) )
- {
- /* FIXME: we should lock if called from the interface */
- p_main->p_vout->f_gamma -= INTF_GAMMA_STEP;
- p_main->p_vout->i_changes |= VOUT_GAMMA_CHANGE;
- }
- break;
- case INTF_KEY_INC_GAMMA: /* gamma + */
- if( (p_main->p_vout != NULL) && (p_main->p_vout->f_gamma < INTF_GAMMA_LIMIT) )
- {
- /* FIXME: we should lock if called from the interface */
- p_main->p_vout->f_gamma += INTF_GAMMA_STEP;
- p_main->p_vout->i_changes |= VOUT_GAMMA_CHANGE;
- }
- break;
- default: /* unknown key */
- return( 1 );
+ msg_Err( p_this, "interface \"%s\" initialization failed",
+ newval.psz_string );
+ return VLC_EGENERIC;
+ }
+
+ /* Try to run the interface */
+ if( intf_RunThread( p_intf ) != VLC_SUCCESS )
+ {
+ vlc_object_detach( p_intf );
+ vlc_object_release( p_intf );
+ return VLC_EGENERIC;
}
- return( 0 );
+ return VLC_SUCCESS;
}
projects / vlc / blobdiff