* This library provides basic functions for threads to interact with user
* interface, such as command line.
*****************************************************************************
- * Copyright (C) 1998, 1999, 2000 VideoLAN
- * $Id: interface.c,v 1.73 2001/04/28 03:36:25 sam Exp $
+ * Copyright (C) 1998-2001 VideoLAN
+ * $Id: interface.c,v 1.102 2003/02/06 23:59:40 sam Exp $
*
* Authors: Vincent Seguin <seguin@via.ecp.fr>
*
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include "defs.h"
-
-#include <errno.h> /* ENOMEM */
#include <stdlib.h> /* free(), strtol() */
#include <stdio.h> /* FILE */
#include <string.h> /* strerror() */
-#include <sys/types.h> /* off_t */
-#include "config.h"
-#include "common.h"
-#include "threads.h"
-#include "mtime.h"
-#include "modules.h"
+#include <vlc/vlc.h>
#include "stream_control.h"
#include "input_ext-intf.h"
#include "audio_output.h"
-#include "intf_msg.h"
#include "interface.h"
-#include "intf_cmd.h"
-#include "intf_playlist.h"
-#include "intf_channels.h"
-#include "keystrokes.h"
#include "video.h"
#include "video_output.h"
-#include "main.h"
-
/*****************************************************************************
* Local prototypes
*****************************************************************************/
-static void intf_Manage( intf_thread_t *p_intf );
+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( void )
+intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module )
{
intf_thread_t * p_intf;
+ char *psz_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 );
+ msg_Err( p_this, "out of memory" );
+ return NULL;
+ }
+
+ /* XXX: workaround for a bug in VLC 0.5.0 where the dvdplay plugin was
+ * registering itself in $interface, which we do not want to happen. */
+ psz_intf = config_GetPsz( p_intf, "interface" );
+ if( psz_intf )
+ {
+ if( !strcasecmp( psz_intf, "dvdplay" ) )
+ {
+ config_PutPsz( p_intf, "interface", "" );
+ }
+ free( psz_intf );
}
/* Choose the best module */
- p_intf->p_module = module_Need( p_main->p_bank,
- MODULE_CAPABILITY_INTF, NULL );
+ p_intf->p_module = module_Need( p_intf, "interface", psz_module );
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 intf module" );
+ vlc_object_destroy( 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 = VLC_FALSE;
+ p_intf->b_menu_change = VLC_FALSE;
/* Initialize mutexes */
- vlc_mutex_init( &p_intf->change_lock );
+ vlc_mutex_init( p_intf, &p_intf->change_lock );
+
+ msg_Dbg( p_intf, "interface initialized" );
- /* 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 );
- 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,
+ * or runs the interface in the current thread, depending on b_block.
*****************************************************************************/
-static void intf_Manage( intf_thread_t *p_intf )
+int intf_RunThread( intf_thread_t *p_intf )
{
- /* Flush waiting messages */
- intf_FlushMsg();
+ if( p_intf->b_block )
+ {
+ /* Run a manager thread, launch the interface, kill the manager */
+ if( vlc_thread_create( p_intf, "manager", Manager,
+ VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
+ {
+ msg_Err( p_intf, "cannot spawn manager thread" );
+ return VLC_EGENERIC;
+ }
- /* Manage module bank */
- module_ManageBank( p_main->p_bank );
+ p_intf->pf_run( p_intf );
- if( ( p_intf->p_input != NULL ) &&
- ( p_intf->p_input->b_error || p_intf->p_input->b_eof ) )
- {
- input_DestroyThread( p_intf->p_input, NULL );
- p_intf->p_input = NULL;
- intf_DbgMsg("Input thread destroyed");
- }
+ p_intf->b_die = VLC_TRUE;
- /* If no stream is being played, try to find one */
- if( p_intf->p_input == NULL && !p_intf->b_die )
+ /* Do not join the thread... intf_StopThread will do it for us */
+ }
+ else
{
- /* Select the next playlist item */
- intf_PlaylistNext( p_main->p_playlist );
-
- if( p_main->p_playlist->i_index == -1 )
+ /* Run the interface in a separate thread */
+ if( vlc_thread_create( p_intf, "interface", p_intf->pf_run,
+ VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
{
- /* 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 );
+ msg_Err( p_intf, "cannot spawn interface thread" );
+ return VLC_EGENERIC;
}
}
+
+ return VLC_SUCCESS;
}
/*****************************************************************************
- * intf_Destroy: clean interface after main loop
+ * intf_StopThread: end the interface thread
*****************************************************************************
- * This function destroys specific interfaces and close output devices.
+ * This function asks the interface thread to stop.
*****************************************************************************/
-void intf_Destroy( intf_thread_t *p_intf )
+void intf_StopThread( intf_thread_t *p_intf )
{
- p_intf_key p_cur;
- p_intf_key p_next;
-
- /* Unload channels */
- intf_UnloadChannels( p_intf );
-
- /* Destroy interfaces */
- p_intf->pf_close( p_intf );
-
- /* Close input thread, if any (blocking) */
- if( p_intf->p_input )
- {
- input_DestroyThread( p_intf->p_input, NULL );
- }
-
- /* Destroy keymap */
- p_cur = p_intf->p_keys;
- while( p_cur != NULL)
+ /* Tell the interface to die */
+ if( !p_intf->b_block )
{
- p_next = p_cur->next;
- free(p_cur);
- p_cur = p_next;
+ p_intf->b_die = VLC_TRUE;
}
-
- /* Unlock module */
- module_Unneed( p_main->p_bank, p_intf->p_module );
- vlc_mutex_destroy( &p_intf->change_lock );
-
- /* Free structure */
- free( p_intf );
+ /* Wait for the thread to exit */
+ vlc_thread_join( p_intf );
}
/*****************************************************************************
- * intf_AssignKey: assign standartkeys *
+ * intf_Destroy: clean interface after main loop
*****************************************************************************
- * 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)
+ * This function destroys specific interfaces and close output devices.
+ *****************************************************************************/
+void intf_Destroy( 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
- {
- while( p_cur->next != NULL && p_cur ->received_key != r_key)
- {
- 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;
- }
- 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;
- }
- if(current == NULL)
- { /* didn't find any key in the array */
- reply.key = INTF_KEY_UNKNOWN;
- reply.param = 0;
- }
- else
- {
- reply.key = current->forwarded.key;
- reply.param = current->forwarded.param;
- }
- return reply;
-}
+ /* Unlock module */
+ module_Unneed( p_intf, p_intf->p_module );
-/*****************************************************************************
-* intf_AssignNormalKeys: used for normal interfaces.
-*****************************************************************************
-* This function assign the basic key to the normal keys.
-*****************************************************************************/
+ vlc_mutex_destroy( &p_intf->change_lock );
-void intf_AssignNormalKeys( intf_thread_t *p_intf)
-{
- p_intf->p_intf_get_key = intf_GetKey;
+ /* Free structure */
+ vlc_object_destroy( p_intf );
+}
- 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_AssignKey( p_intf , 'd', INTF_KEY_DUMP_STREAM, 0);
-}
+/* Following functions are local */
/*****************************************************************************
- * intf_ProcessKey: process standard keys
+ * Manager: helper thread for blocking interfaces
*****************************************************************************
- * This function will process standard keys and return non 0 if the key was
- * unknown.
+ * 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.
*****************************************************************************/
-int intf_ProcessKey( intf_thread_t *p_intf, int g_key )
+static void Manager( intf_thread_t *p_intf )
{
- static int i_volbackup;
- keyparm k_reply;
-
- k_reply = intf_GetKey( p_intf, g_key);
- switch( k_reply.key )
+ while( !p_intf->b_die )
{
- 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 ); */
-/* network_ChannelJoin() */
-/* FIXME : keyboard event is for the time being half handled by the interface
- * half handled directly by the plugins. We should decide what to do. */
- 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;
- case INTF_KEY_DUMP_STREAM:
- if( p_intf->p_input != NULL )
+ msleep( INTF_IDLE_SLEEP );
+
+ if( p_intf->p_vlc->b_die )
{
- vlc_mutex_lock( &p_intf->p_input->stream.stream_lock );
- input_DumpStream( p_intf->p_input );
- vlc_mutex_unlock( &p_intf->p_input->stream.stream_lock );
+ p_intf->b_die = VLC_TRUE;
+ return;
}
- break;
- default: /* unknown key */
- return( 1 );
}
-
- return( 0 );
}
+