* 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-2001 VideoLAN
+ * $Id: interface.c,v 1.94 2002/06/01 12:32:01 sam Exp $
*
- * 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 GNU
- * General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
*
- * 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-1307, USA.
+ * 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.
*****************************************************************************/
/*****************************************************************************
#include <stdlib.h> /* free(), strtol() */
#include <stdio.h> /* FILE */
#include <string.h> /* strerror() */
-#include <sys/types.h> /* on BSD, uio.h needs types.h */
-#include <sys/uio.h> /* for input.h */
+#include <sys/types.h> /* off_t */
+
+#include <vlc/vlc.h>
-#include "config.h"
-#include "common.h"
-#include "mtime.h"
-#include "threads.h"
-#include "plugins.h"
-#include "input.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_console.h"
#include "video.h"
#include "video_output.h"
-#include "main.h"
-
-/*****************************************************************************
- * intf_channel_t: channel description
- *****************************************************************************
- * A 'channel' is a descriptor of an input method. It is used to switch easily
- * from source to source without having to specify the whole input thread
- * configuration. The channels array, stored in the interface thread object, is
- * loaded in intf_Create, and unloaded in intf_Destroy.
- *****************************************************************************/
-typedef struct intf_channel_s
-{
- /* Channel description */
- int i_channel; /* channel number, -1 for end of array */
- char * psz_description; /* channel description (owned) */
-
- /* Input configuration */
- int i_input_method; /* input method descriptor */
- char * psz_input_source; /* source string (owned) */
- int i_input_port; /* port */
- int i_input_vlan; /* vlan */
-} intf_channel_t;
-
/*****************************************************************************
* Local prototypes
*****************************************************************************/
-static int LoadChannels ( intf_thread_t *p_intf, char *psz_filename );
-static void UnloadChannels ( intf_thread_t *p_intf );
-static int ParseChannel ( intf_channel_t *p_channel, char *psz_str );
+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 )
{
- intf_thread_t *p_intf;
- char * psz_method;
+ 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("error: %s\n", strerror( ENOMEM ) );
- return( NULL );
+ msg_Err( p_this, "out of memory" );
+ return NULL;
}
- /* Request an interface plugin */
- psz_method = main_GetPszVariable( VOUT_METHOD_VAR, VOUT_DEFAULT_METHOD );
- p_intf->p_intf_plugin = RequestPlugin( "intf", psz_method );
+ /* 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( !p_intf->p_intf_plugin )
+ if( psz_name ) free( psz_name );
+ if( p_intf->p_module == NULL )
{
- intf_ErrMsg( "error: could not open interface plugin intf_%s.so\n", psz_method );
- free( p_intf );
- return( NULL );
+ msg_Err( p_intf, "no suitable intf module" );
+ vlc_object_destroy( p_intf );
+ return NULL;
}
- /* Get plugins */
- p_intf->p_sys_create = GetPluginFunction( p_intf->p_intf_plugin, "intf_SysCreate" );
- p_intf->p_sys_manage = GetPluginFunction( p_intf->p_intf_plugin, "intf_SysManage" );
- p_intf->p_sys_destroy = GetPluginFunction( p_intf->p_intf_plugin, "intf_SysDestroy" );
+#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_die = 0;
- p_intf->p_vout = NULL;
- p_intf->p_input = NULL;
-
- /* Load channels - the pointer will be set to NULL on failure. The
- * return value is ignored since the program can work without
- * channels */
- LoadChannels( p_intf, main_GetPszVariable( INTF_CHANNELS_VAR, INTF_CHANNELS_DEFAULT ));
-
- /* Start interfaces */
- p_intf->p_console = intf_ConsoleCreate();
- if( p_intf->p_console == NULL )
- {
- intf_ErrMsg("error: can't create control console\n");
- TrashPlugin( p_intf->p_intf_plugin );
- free( p_intf );
- return( NULL );
- }
- if( p_intf->p_sys_create( p_intf ) )
- {
- intf_ErrMsg("error: can't create interface\n");
- intf_ConsoleDestroy( p_intf->p_console );
- TrashPlugin( p_intf->p_intf_plugin );
- free( p_intf );
- return( NULL );
- }
-
- intf_Msg("Interface initialized\n");
- return( p_intf );
-}
-
-/*****************************************************************************
- * intf_Run
- *****************************************************************************
- * Initialization script and main interface loop.
- *****************************************************************************/
-void intf_Run( intf_thread_t *p_intf )
-{
- /* Execute the initialization script - if a positive number is returned,
- * the script could be executed but failed */
- if( intf_ExecScript( main_GetPszVariable( INTF_INIT_SCRIPT_VAR, INTF_INIT_SCRIPT_DEFAULT ) ) > 0 )
- {
- intf_ErrMsg("warning: error(s) during startup script\n");
- }
-
- /* Main loop */
- while(!p_intf->b_die)
- {
- /* Flush waiting messages */
- intf_FlushMsg();
+ p_intf->b_menu = 0;
+ p_intf->b_menu_change = 0;
- /* Manage specific interface */
- p_intf->p_sys_manage( p_intf );
+ /* Initialize mutexes */
+ vlc_mutex_init( p_intf, &p_intf->change_lock );
- /* Check attached threads status */
- if( (p_intf->p_vout != NULL) && p_intf->p_vout->b_error )
- {
- /* FIXME: add aout error detection ?? */
- p_intf->b_die = 1;
- }
- if( (p_intf->p_input != NULL) && p_intf->p_input->b_error )
- {
- input_DestroyThread( p_intf->p_input, NULL );
- p_intf->p_input = NULL;
- intf_DbgMsg("Input thread destroyed\n");
- }
+ msg_Dbg( p_intf, "interface initialized" );
- /* Sleep to avoid using all CPU - since some interfaces needs to access
- * keyboard events, a 100ms delay is a good compromise */
- msleep( INTF_IDLE_SLEEP );
- }
-}
+ /* An interface's parent is always the root */
+ vlc_object_attach( p_intf, p_intf->p_vlc );
-/*****************************************************************************
- * 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 interfaces */
- p_intf->p_sys_destroy( p_intf );
- intf_ConsoleDestroy( p_intf->p_console );
-
- /* Unload channels */
- UnloadChannels( p_intf );
-
- /* Close plugin */
- TrashPlugin( p_intf->p_intf_plugin );
-
- /* Free structure */
- free( p_intf );
+ return p_intf;
}
/*****************************************************************************
- * intf_SelectChannel: change channel
+ * intf_RunThread: launch the interface thread
*****************************************************************************
- * Kill existing input, if any, and try to open a new one, using an input
- * configuration table.
+ * 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.
*****************************************************************************/
-int intf_SelectChannel( intf_thread_t * p_intf, int i_channel )
+vlc_error_t intf_RunThread( intf_thread_t *p_intf )
{
- intf_channel_t * p_channel; /* channel */
-
- /* Look for channel in array */
- if( p_intf->p_channel != NULL )
+ if( p_intf->b_block )
{
- for( p_channel = p_intf->p_channel; p_channel->i_channel != -1; p_channel++ )
+ /* Run a manager thread, launch the interface, kill the manager */
+ if( vlc_thread_create( p_intf, "manager", Manager, 0 ) )
{
- if( p_channel->i_channel == i_channel )
- {
- /*
- * Change channel
- */
-
- /* Kill existing input, if any */
- if( p_intf->p_input != NULL )
- {
- input_DestroyThread( p_intf->p_input, NULL );
- }
-
- intf_Msg("Channel %d: %s\n", i_channel, p_channel->psz_description );
-
- /* Open a new input */
- p_intf->p_input = input_CreateThread( p_channel->i_input_method, p_channel->psz_input_source,
- p_channel->i_input_port, p_channel->i_input_vlan,
- p_intf->p_vout, p_main->p_aout, NULL );
- return( p_intf->p_input == NULL );
- }
+ msg_Err( p_intf, "cannot spawn manager thread" );
+ return VLC_EGENERIC;
}
- }
- /* Channel does not exist */
- intf_Msg("Channel %d does not exist\n", i_channel );
- return( 1 );
-}
+ p_intf->pf_run( p_intf );
-/*****************************************************************************
- * 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 i_key )
-{
- switch( i_key )
- {
- case 'Q': /* quit order */
- case 'q':
- case 27: /* escape key */
- case 3: /* ^C */
p_intf->b_die = 1;
- break;
- case '0': /* source change */
- case '1':
- case '2':
- case '3':
- case '4':
- case '5':
- case '6':
- case '7':
- case '8':
- case '9':
- /* Change channel - return code is ignored since SelectChannel displays
- * its own error messages */
- intf_SelectChannel( p_intf, i_key - '0' );
- break;
- case '+': /* volume + */
- /* XXX?? */
- break;
- case '-': /* volume - */
- /* XXX?? */
- break;
- case 'M': /* toggle mute */
- case 'm':
- /* XXX?? */
- break;
- case 'g': /* gamma - */
- if( (p_intf->p_vout != NULL) && (p_intf->p_vout->f_gamma > -INTF_GAMMA_LIMIT) )
- {
- vlc_mutex_lock( &p_intf->p_vout->change_lock );
- p_intf->p_vout->f_gamma -= INTF_GAMMA_STEP;
- p_intf->p_vout->i_changes |= VOUT_GAMMA_CHANGE;
- vlc_mutex_unlock( &p_intf->p_vout->change_lock );
- }
- break;
- case 'G': /* gamma + */
- if( (p_intf->p_vout != NULL) && (p_intf->p_vout->f_gamma < INTF_GAMMA_LIMIT) )
- {
- vlc_mutex_lock( &p_intf->p_vout->change_lock );
- p_intf->p_vout->f_gamma += INTF_GAMMA_STEP;
- p_intf->p_vout->i_changes |= VOUT_GAMMA_CHANGE;
- vlc_mutex_unlock( &p_intf->p_vout->change_lock );
- }
- break;
- case 'c': /* toggle grayscale */
- if( p_intf->p_vout != NULL )
- {
- vlc_mutex_lock( &p_intf->p_vout->change_lock );
- p_intf->p_vout->b_grayscale = !p_intf->p_vout->b_grayscale;
- p_intf->p_vout->i_changes |= VOUT_GRAYSCALE_CHANGE;
- vlc_mutex_unlock( &p_intf->p_vout->change_lock );
- }
- break;
- case ' ': /* toggle interface */
- if( p_intf->p_vout != NULL )
- {
- vlc_mutex_lock( &p_intf->p_vout->change_lock );
- p_intf->p_vout->b_interface = !p_intf->p_vout->b_interface;
- p_intf->p_vout->i_changes |= VOUT_INTF_CHANGE;
- vlc_mutex_unlock( &p_intf->p_vout->change_lock );
- }
- break;
- case 'i': /* toggle info */
- if( p_intf->p_vout != NULL )
- {
- vlc_mutex_lock( &p_intf->p_vout->change_lock );
- p_intf->p_vout->b_info = !p_intf->p_vout->b_info;
- p_intf->p_vout->i_changes |= VOUT_INFO_CHANGE;
- vlc_mutex_unlock( &p_intf->p_vout->change_lock );
- }
- break;
- case 's': /* toggle scaling */
- if( p_intf->p_vout != NULL )
+
+ /* Do not join the thread... intf_StopThread will do it for us */
+ }
+ else
+ {
+ /* Run the interface in a separate thread */
+ if( vlc_thread_create( p_intf, "interface", p_intf->pf_run, 0 ) )
{
- vlc_mutex_lock( &p_intf->p_vout->change_lock );
- p_intf->p_vout->b_scale = !p_intf->p_vout->b_scale;
- p_intf->p_vout->i_changes |= VOUT_SCALE_CHANGE;
- vlc_mutex_unlock( &p_intf->p_vout->change_lock );
+ msg_Err( p_intf, "cannot spawn interface thread" );
+ return VLC_EGENERIC;
}
- break;
- default: /* unknown key */
- return( 1 );
}
- return( 0 );
+ return VLC_SUCCESS;
}
-/* following functions are local */
-
/*****************************************************************************
- * LoadChannels: load channels description from a file
+ * intf_StopThread: end the interface thread
*****************************************************************************
- * This structe describes all interface-specific data of the main (interface)
- * thread.
- * Each line of the file is a semicolon separated list of the following
- * fields :
- * integer channel number
- * string channel description
- * integer input method (see input.h)
- * string input source
- * integer input port
- * integer input vlan
- * The last field must end with a semicolon.
- * Comments and empty lines are not explicitely allowed, but lines with parsing
- * errors are ignored without warning.
+ * This function asks the interface thread to stop.
*****************************************************************************/
-static int LoadChannels( intf_thread_t *p_intf, char *psz_filename )
+void intf_StopThread( intf_thread_t *p_intf )
{
- FILE * p_file; /* file */
- intf_channel_t * p_channel; /* current channel */
- char psz_line[INTF_MAX_CMD_SIZE]; /* line buffer */
- int i_index; /* channel or field index */
-
- /* Set default value */
- p_intf->p_channel = NULL;
-
- /* Open file */
- p_file = fopen( psz_filename, "r" );
- if( p_file == NULL )
- {
- intf_ErrMsg("error: can't open %s (%s)\n", psz_filename, strerror(errno));
- return( 1 );
- }
-
- /* First pass: count number of lines */
- for( i_index = 0; fgets( psz_line, INTF_MAX_CMD_SIZE, p_file ) != NULL; i_index++ )
- {
- ;
- }
-
- if( i_index != 0 )
+ /* Tell the interface to die */
+ if( !p_intf->b_block )
{
- /* Allocate array and rewind - some of the lines may be invalid, and the
- * array will probably be larger than the actual number of channels, but
- * it has no consequence. */
- p_intf->p_channel = malloc( sizeof( intf_channel_t ) * i_index );
- if( p_intf->p_channel == NULL )
- {
- intf_ErrMsg("error: %s\n", strerror(ENOMEM));
- fclose( p_file );
- return( 1 );
- }
- p_channel = p_intf->p_channel;
- rewind( p_file );
-
- /* Second pass: read channels descriptions */
- while( fgets( psz_line, INTF_MAX_CMD_SIZE, p_file ) != NULL )
- {
- if( !ParseChannel( p_channel, psz_line ) )
- {
- intf_DbgMsg("channel [%d] %s : method %d (%s:%d vlan %d)\n",
- p_channel->i_channel, p_channel->psz_description,
- p_channel->i_input_method, p_channel->psz_input_source,
- p_channel->i_input_port, p_channel->i_input_vlan );
- p_channel++;
- }
- }
-
- /* Add marker at the end of the array */
- p_channel->i_channel = -1;
+ p_intf->b_die = 1;
}
- /* Close file */
- fclose( p_file );
- return( 0 );
+ /* Wait for the thread to exit */
+ vlc_thread_join( p_intf );
}
/*****************************************************************************
- * UnloadChannels: unload channels description
+ * intf_Destroy: clean interface after main loop
*****************************************************************************
- * This function free all resources allocated by LoadChannels, if any.
+ * This function destroys specific interfaces and close output devices.
*****************************************************************************/
-static void UnloadChannels( intf_thread_t *p_intf )
+void intf_Destroy( intf_thread_t *p_intf )
{
- int i_channel; /* channel index */
+ /* Destroy interface */
+ p_intf->pf_close( p_intf );
- if( p_intf->p_channel != NULL )
- {
- /* Free allocated strings */
- for( i_channel = 0;
- p_intf->p_channel[ i_channel ].i_channel != -1;
- i_channel++ )
- {
- if( p_intf->p_channel[ i_channel ].psz_description != NULL )
- {
- free( p_intf->p_channel[ i_channel ].psz_description );
- }
- if( p_intf->p_channel[ i_channel ].psz_input_source != NULL )
- {
- free( p_intf->p_channel[ i_channel ].psz_input_source );
- }
- }
+ /* Unlock module */
+ module_Unneed( p_intf->p_module );
- /* Free array */
- free( p_intf->p_channel );
- p_intf->p_channel = NULL;
- }
+ vlc_mutex_destroy( &p_intf->change_lock );
+
+ /* Free structure */
+ vlc_object_destroy( p_intf );
}
+/* Following functions are local */
/*****************************************************************************
- * ParseChannel: parse a channel description line
+ * Manager: helper thread for blocking interfaces
*****************************************************************************
- * See LoadChannels. This function return non 0 on parsing error.
+ * 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 int ParseChannel( intf_channel_t *p_channel, char *psz_str )
+static void Manager( intf_thread_t *p_intf )
{
- char * psz_index; /* current character */
- char * psz_end; /* end pointer for strtol */
- int i_field; /* field number, -1 on error */
- int i_field_length; /* field length, for text fields */
-
- /* Set some default fields */
- p_channel->i_channel = 0;
- p_channel->psz_description = NULL;
- p_channel->i_input_method = 0;
- p_channel->psz_input_source = NULL;
- p_channel->i_input_port = 0;
- p_channel->i_input_vlan = 0;
-
- /* Parse string */
- i_field = 0;
- for( psz_index = psz_str; (i_field != -1) && (*psz_index != '\0'); psz_index++ )
+ while( !p_intf->b_die )
{
- if( *psz_index == ';' )
- {
- /* Mark end of field */
- *psz_index = '\0';
-
- /* Parse field */
- switch( i_field++ )
- {
- case 0: /* channel number */
- p_channel->i_channel = strtol( psz_str, &psz_end, 0);
- if( (*psz_str == '\0') || (*psz_end != '\0') )
- {
- i_field = -1;
- }
- break;
- case 1: /* channel description */
- i_field_length = strlen( psz_str );
- if( i_field_length != 0 )
- {
- p_channel->psz_description = malloc( i_field_length + 1 );
- if( p_channel->psz_description == NULL )
- {
- intf_ErrMsg("error: %s\n", strerror( ENOMEM ));
- i_field = -1;
- }
- else
- {
- strcpy( p_channel->psz_description, psz_str );
- }
- }
- break;
- case 2: /* input method */
- p_channel->i_input_method = strtol( psz_str, &psz_end, 0);
- if( (*psz_str == '\0') || (*psz_end != '\0') )
- {
- i_field = -1;
- }
- break;
- case 3: /* input source */
- i_field_length = strlen( psz_str );
- if( i_field_length != 0 )
- {
- p_channel->psz_input_source = malloc( i_field_length + 1 );
- if( p_channel->psz_input_source == NULL )
- {
- intf_ErrMsg("error: %s\n", strerror( ENOMEM ));
- i_field = -1;
- }
- else
- {
- strcpy( p_channel->psz_input_source, psz_str );
- }
- }
- break;
- case 4: /* input port */
- p_channel->i_input_port = strtol( psz_str, &psz_end, 0);
- if( (*psz_str == '\0') || (*psz_end != '\0') )
- {
- i_field = -1;
- }
- break;
- case 5: /* input vlan */
- p_channel->i_channel = strtol( psz_str, &psz_end, 0);
- if( (*psz_str == '\0') || (*psz_end != '\0') )
- {
- i_field = -1;
- }
- break;
- /* ... following fields are ignored */
- }
-
- /* Set new beginning of field */
- psz_str = psz_index + 1;
- }
- }
+ msleep( INTF_IDLE_SLEEP );
- /* At least the first three fields must be parsed sucessfully for function
- * success. Other parsing errors are returned using i_field = -1. */
- if( i_field < 3 )
- {
- /* Function fails. Free allocated strings */
- if( p_channel->psz_description != NULL )
- {
- free( p_channel->psz_description );
- }
- if( p_channel->psz_input_source != NULL )
+ if( p_intf->p_vlc->b_die )
{
- free( p_channel->psz_input_source );
+ p_intf->b_die = 1;
+ return;
}
- return( 1 );
}
-
- /* Return success */
- return( 0 );
}
+
projects / vlc / blobdiff