]> git.sesse.net Git - vlc/blobdiff - src/interface/interface.c
* ./modules/access/dvdplay/demux.c: the dvdplay plugin no longer sets the
[vlc] / src / interface / interface.c
index e56f03f80cd1421db60d2514d148f6a57336647c..57c6f88621a4dd981fea1cceeaa675b052d50ff6 100644 (file)
-/*******************************************************************************
+/*****************************************************************************
  * interface.c: interface access for other threads
- * (c)1998 VideoLAN
- *******************************************************************************
  * 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.102 2003/02/06 23:59:40 sam Exp $
+ *
+ * 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.
+ *
+ * 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.
+ *****************************************************************************/
 
-/*******************************************************************************
+/*****************************************************************************
  * Preamble
- *******************************************************************************/
-#include <errno.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <sys/types.h>
-#include <sys/uio.h>                                        /* for input.h */
+ *****************************************************************************/
+#include <stdlib.h>                                      /* free(), strtol() */
+#include <stdio.h>                                                   /* FILE */
+#include <string.h>                                            /* strerror() */
+
+#include <vlc/vlc.h>
+
+#include "stream_control.h"
+#include "input_ext-intf.h"
+
+#include "audio_output.h"
 
-#include "config.h"
-#include "common.h"
-#include "mtime.h"
-#include "vlc_thread.h"
-#include "input.h"
-#include "intf_msg.h"
 #include "interface.h"
-#include "intf_cmd.h"
-#include "intf_console.h"
-#include "main.h"
+
 #include "video.h"
 #include "video_output.h"
 
-#include "intf_sys.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 create specific interfaces. It send
- * it's own error messages.
- *******************************************************************************/
-intf_thread_t* intf_Create( void )
-{    
-    intf_thread_t *p_intf;                                        
+ *****************************************************************************
+ * 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, 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("error: %s\n", strerror( ENOMEM ) );        
-       return( NULL );
+        msg_Err( p_this, "out of memory" );
+        return NULL;
     }
 
-    /* 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 )
+    /* 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 )
     {
-        intf_ErrMsg("error: can't create control console\n");
-       free( p_intf );
-        return( NULL );
+        if( !strcasecmp( psz_intf, "dvdplay" ) )
+        {
+            config_PutPsz( p_intf, "interface", "" );
+        }
+        free( psz_intf );
     }
-    if( intf_SysCreate( p_intf ) )
-    {
-       intf_ErrMsg("error: can't create interface\n");
-       intf_ConsoleDestroy( p_intf->p_console );
-       free( p_intf );
-       return( NULL );
-    }   
 
-    intf_Msg("Interface initialized\n");    
-    return( p_intf );
-}
+    /* Choose the best module */
+    p_intf->p_module = module_Need( p_intf, "interface", psz_module );
 
-/*******************************************************************************
- * 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 )
+    if( p_intf->p_module == NULL )
     {
-       intf_ErrMsg("warning: error(s) during startup script\n");
+        msg_Err( p_intf, "no suitable intf module" );
+        vlc_object_destroy( p_intf );
+        return NULL;
     }
 
-    /* Main loop */
-    while(!p_intf->b_die)
-    {
-        /* Flush waiting messages */
-        intf_FlushMsg();
+    /* Initialize structure */
+    p_intf->b_menu        = VLC_FALSE;
+    p_intf->b_menu_change = VLC_FALSE;
 
-        /* Manage specific interface */
-        intf_SysManage( 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 )
-        {
-            //?? 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 );
-    }
-}
+    /* Attach interface to its parent object */
+    vlc_object_attach( p_intf, p_this );
 
-/*******************************************************************************
- * 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 */
-    intf_SysDestroy( p_intf );
-    intf_ConsoleDestroy( p_intf->p_console );
-        
-    /* Unload channels */
-    UnloadChannels( p_intf );    
-
-    /* Free structure */
-    free( p_intf );
-}
-
-/*******************************************************************************
- * intf_SelectChannel: change channel
- *******************************************************************************
- * Kill existing input, if any, and try to open a new one, using an input
- * configuration table.
- *******************************************************************************/
-int intf_SelectChannel( intf_thread_t * p_intf, int i_channel )
-{
-    intf_channel_t *    p_channel;                                  /* channel */
-    
-    /* Look for channel in array */
-    if( p_intf->p_channel != NULL )
-    {
-        for( p_channel = p_intf->p_channel; p_channel->i_channel != -1; p_channel++ )
-        {
-            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 );             
-            }            
-        }        
-    }
-
-    /* Channel does not exist */
-    intf_Msg("Channel %d does not exist\n", i_channel );
-    return( 1 );    
+    return p_intf;
 }
 
 /*****************************************************************************
- * intf_ProcessKey: process standard keys
+ * intf_RunThread: launch the interface thread
  *****************************************************************************
- * This function will process standard keys and return non 0 if the key was
- * unknown.
+ * 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_ProcessKey( intf_thread_t *p_intf, int i_key )
+int intf_RunThread( intf_thread_t *p_intf )
 {
-    switch( i_key )
+    if( p_intf->b_block )
     {
-    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 + */
-        // ??
-        break;
-    case '-':                                                    /* volume - */
-        // ??
-        break;
-    case 'M':                                                 /* toggle mute */
-    case 'm':                    
-        // ??
-        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 )
+        /* Run a manager thread, launch the interface, kill the manager */
+        if( vlc_thread_create( p_intf, "manager", Manager,
+                               VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
         {
-            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 manager thread" );
+            return VLC_EGENERIC;
         }
-        break;                                
-   default:                                                   /* unknown key */
-        return( 1 );        
-    }
 
-    return( 0 );    
-}
+        p_intf->pf_run( p_intf );
 
-/* following functions are local */
-                    
-/*******************************************************************************
- * LoadChannels: load channels description from a file
- *******************************************************************************
- * 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.
- *******************************************************************************/
-static int LoadChannels( intf_thread_t *p_intf, char *psz_filename )
-{
-    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 */        
+        p_intf->b_die = VLC_TRUE;
 
-    /* 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 );        
+        /* Do not join the thread... intf_StopThread will do it for us */
     }
-
-    /* First pass: count number of lines */
-    for( i_index = 0; fgets( psz_line, INTF_MAX_CMD_SIZE, p_file ) != NULL; i_index++ )
+    else
     {
-        ;        
-    }
-
-    if( i_index != 0 )
-    {        
-        /* 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 )
+        /* Run the interface in a separate thread */
+        if( vlc_thread_create( p_intf, "interface", p_intf->pf_run,
+                               VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
         {
-            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++;                
-            }
+            msg_Err( p_intf, "cannot spawn interface thread" );
+            return VLC_EGENERIC;
         }
-        
-        /* Add marker at the end of the array */
-        p_channel->i_channel = -1;
     }
 
-    /* Close file */
-    fclose( p_file );    
-    return( 0 );
+    return VLC_SUCCESS;
 }
 
-/******************************************************************************
- * UnloadChannels: unload channels description
- ******************************************************************************
- * This function free all resources allocated by LoadChannels, if any.
- ******************************************************************************/
-static void UnloadChannels( intf_thread_t *p_intf )
+/*****************************************************************************
+ * intf_StopThread: end the interface thread
+ *****************************************************************************
+ * This function asks the interface thread to stop.
+ *****************************************************************************/
+void intf_StopThread( intf_thread_t *p_intf )
 {
-    int i_channel;                                           /* channel index */    
-    
-    if( p_intf->p_channel != NULL )
+    /* Tell the interface to die */
+    if( !p_intf->b_block )
     {
-        /* 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 );            
-            }            
-        }        
+        p_intf->b_die = VLC_TRUE;
+    }
 
-        /* Free array */
-        free( p_intf->p_channel );        
-        p_intf->p_channel = NULL;        
-    }    
+    /* Wait for the thread to exit */
+    vlc_thread_join( p_intf );
 }
 
-
-/*******************************************************************************
- * ParseChannel: parse a channel description line
- *******************************************************************************
- * See LoadChannels. This function return non 0 on parsing error.
- *******************************************************************************/
-static int ParseChannel( intf_channel_t *p_channel, char *psz_str )
+/*****************************************************************************
+ * intf_Destroy: clean interface after main loop
+ *****************************************************************************
+ * This function destroys specific interfaces and close output devices.
+ *****************************************************************************/
+void intf_Destroy( 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 */
+    /* Unlock module */
+    module_Unneed( p_intf, p_intf->p_module );
 
-    /* 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;    
+    vlc_mutex_destroy( &p_intf->change_lock );
 
-    /* Parse string */
-    i_field = 0;
-    for( psz_index = psz_str; (i_field != -1) && (*psz_index != '\0'); psz_index++ )
-    {
-        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 */
-            }
+    /* Free structure */
+    vlc_object_destroy( p_intf );
+}
 
-            /* Set new beginning of field */
-            psz_str = psz_index + 1;
-        }
-    }      
+/* Following functions are local */
 
-    /* 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 )
+/*****************************************************************************
+ * 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 )
+{
+    while( !p_intf->b_die )
     {
-        /* Function fails. Free allocated strings */
-        if( p_channel->psz_description != NULL )
+        msleep( INTF_IDLE_SLEEP );
+
+        if( p_intf->p_vlc->b_die )
         {
-            free( p_channel->psz_description );            
+            p_intf->b_die = VLC_TRUE;
+            return;
         }
-        if( p_channel->psz_input_source != NULL )
-        {
-            free( p_channel->psz_input_source );            
-        }                
-        return( 1 );        
     }
-
-    /* Return success */
-    return( 0 );    
 }
+