]> git.sesse.net Git - vlc/blobdiff - src/interface/interface.c
* Mandatory step for video output IV and the audio output quality
[vlc] / src / interface / interface.c
index 14925e8235a88ed87be1e819011356a96253859b..b627e8c2a367bb12d46b25860240a24936e853d5 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, 1999, 2000 VideoLAN
+ * $Id: interface.c,v 1.75 2001/05/01 04:18:18 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 "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 "vlc_thread.h"
-#include "input.h"
+#include "modules.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 "main.h"
+#include "intf_playlist.h"
+#include "intf_channels.h"
+#include "keystrokes.h"
+
 #include "video.h"
 #include "video_output.h"
 
-#include "intf_sys.h"
+#include "main.h"
 
-/*******************************************************************************
- * Constants
- *******************************************************************************/
+/*****************************************************************************
+ * Local prototypes
+ *****************************************************************************/
+static void intf_Manage( intf_thread_t *p_intf );
 
-/* INTF_INPUT_CFG: pre-configured inputs */
-#define INTF_MAX_INPUT_CFG              10
-static const input_cfg_t INTF_INPUT_CFG[] = 
-{
-    /*  properties                              method  
-     *  file    host    ip              port    vlan */
-    
-    /* Local input (unicast) */
-    {   INPUT_CFG_METHOD | INPUT_CFG_IP,        INPUT_METHOD_TS_UCAST,     
-        NULL,   NULL,   "127.0.0.1",    0,      0       },
-
-    /* Broadcasts */
-    {  INPUT_CFG_METHOD | INPUT_CFG_VLAN,       INPUT_METHOD_TS_VLAN_BCAST,
-       NULL,    NULL,   NULL,           0,      0       },
-    {  INPUT_CFG_METHOD | INPUT_CFG_VLAN,       INPUT_METHOD_TS_VLAN_BCAST,
-       NULL,    NULL,   NULL,           0,      1       },
-    {  INPUT_CFG_METHOD | INPUT_CFG_VLAN,       INPUT_METHOD_TS_VLAN_BCAST,
-       NULL,    NULL,   NULL,           0,      2       },
-    {  INPUT_CFG_METHOD | INPUT_CFG_VLAN,       INPUT_METHOD_TS_VLAN_BCAST,
-       NULL,    NULL,   NULL,           0,      3       },
-    {  INPUT_CFG_METHOD | INPUT_CFG_VLAN,       INPUT_METHOD_TS_VLAN_BCAST,
-       NULL,    NULL,   NULL,           0,      4       },
-    {  INPUT_CFG_METHOD | INPUT_CFG_VLAN,       INPUT_METHOD_TS_VLAN_BCAST,
-       NULL,    NULL,   NULL,           0,      5       },
-    {  INPUT_CFG_METHOD | INPUT_CFG_VLAN,       INPUT_METHOD_TS_VLAN_BCAST,
-       NULL,    NULL,   NULL,           0,      6       },
-    {  INPUT_CFG_METHOD | INPUT_CFG_VLAN,       INPUT_METHOD_TS_VLAN_BCAST,
-       NULL,    NULL,   NULL,           0,      7       },
-    {  INPUT_CFG_METHOD | INPUT_CFG_VLAN,       INPUT_METHOD_TS_VLAN_BCAST,
-       NULL,    NULL,   NULL,           0,      8       }
-};
-
-/*******************************************************************************
+/*****************************************************************************
  * intf_Create: prepare interface before main loop
- *******************************************************************************
- * This function opens output devices and create specific interfaces. It send
- * it's own error messages.
- *******************************************************************************/
+ *****************************************************************************
+ * This function opens output devices and creates specific interfaces. It sends
+ * its own error messages.
+ *****************************************************************************/
 intf_thread_t* intf_Create( void )
-{    
-    intf_thread_t *p_intf;                                        
+{
+    intf_thread_t * p_intf;
 
     /* Allocate structure */
     p_intf = malloc( sizeof( intf_thread_t ) );
     if( !p_intf )
     {
-        intf_ErrMsg("error: %s\n", strerror( ENOMEM ) );        
-       return( NULL );
+        intf_ErrMsg( "intf error: cannot create interface thread (%s)",
+                     strerror( ENOMEM ) );
+        return( NULL );
     }
 
-    /* Initialize structure */
-    p_intf->b_die =     0;    
-    p_intf->p_vout =    NULL;
-    p_intf->p_input =   NULL;   
+    /* Choose the best module */
+    p_intf->p_module = module_Need( MODULE_CAPABILITY_INTF, NULL );
 
-    /* Start interfaces */
-    p_intf->p_console = intf_ConsoleCreate();
-    if( p_intf->p_console == NULL )
+    if( p_intf->p_module == NULL )
     {
-        intf_ErrMsg("error: can't create control console\n");
-       free( p_intf );
+        intf_ErrMsg( "intf error: no suitable intf module" );
+        free( p_intf );
         return( NULL );
     }
-    if( intf_SysCreate( p_intf ) )
+
+#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("error: can't create interface\n");
-       intf_ConsoleDestroy( p_intf->p_console );
-       free( p_intf );
-       return( NULL );
-    }   
+        intf_ErrMsg("intf error: cannot create interface");
+        module_Unneed( p_intf->p_module );
+        free( p_intf );
+        return( NULL );
+    }
 
-    intf_Msg("Interface initialized\n");    
+    /* 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 ));
+
+    intf_Msg("intf: interface initialized");
     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_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 )
+{
+    /* Flush waiting messages */
+    intf_FlushMsg();
+
+    /* Manage module bank */
+    module_ManageBank( );
+
+    if( ( p_intf->p_input != NULL ) &&
+            ( p_intf->p_input->b_error || p_intf->p_input->b_eof ) )
     {
-       intf_ErrMsg("warning: error(s) during startup script\n");
+        input_DestroyThread( p_intf->p_input, NULL );
+        p_intf->p_input = NULL;
+        intf_DbgMsg("Input thread destroyed");
     }
 
-    /* Main loop */
-    while(!p_intf->b_die)
+    /* If no stream is being played, try to find one */
+    if( p_intf->p_input == NULL && !p_intf->b_die )
     {
-        /* Flush waiting messages */
-        intf_FlushMsg();
-
-        /* Manage specific interface */
-        intf_SysManage( p_intf );
+        /* Select the next playlist item */
+        intf_PlaylistNext( p_main->p_playlist );
 
-        /* Check attached threads status */
-        if( (p_intf->p_vout != NULL) && p_intf->p_vout->b_error )
+        if( p_main->p_playlist->i_index == -1 )
         {
-            //?? add aout error detection
-            p_intf->b_die = 1;            
-        }    
-        if( (p_intf->p_input != NULL) && p_intf->p_input->b_error )
+            /*    FIXME: wait for user to add stuff to playlist ? */
+#if 0
+            p_intf->b_die = 1;
+#endif
+        }
+        else
         {
-            input_DestroyThread( p_intf->p_input /*, NULL */ );            
-            p_intf->p_input = NULL;            
-            intf_DbgMsg("Input thread destroyed\n");            
+            p_intf->p_input =
+                input_CreateThread( &p_main->p_playlist->current, NULL );
         }
-
-        /* 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 );
     }
 }
 
-/*******************************************************************************
+/*****************************************************************************
  * intf_Destroy: clean interface after main loop
- *******************************************************************************
+ *****************************************************************************
  * This function destroys specific interfaces and close output devices.
- *******************************************************************************/
+ *****************************************************************************/
 void intf_Destroy( intf_thread_t *p_intf )
 {
+    p_intf_key  p_cur;
+    p_intf_key  p_next;
+
+    /* Unload channels */
+    intf_UnloadChannels( p_intf );
+
     /* Destroy interfaces */
-    intf_SysDestroy( p_intf );
-    intf_ConsoleDestroy( p_intf->p_console );
+    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)
+    {
+        p_next = p_cur->next;
+        free(p_cur);
+        p_cur = p_next;
+    }
+         
+    /* Unlock module */
+    module_Unneed( p_intf->p_module );
+
+    vlc_mutex_destroy( &p_intf->change_lock );
 
     /* Free structure */
     free( p_intf );
 }
 
-/*******************************************************************************
- * intf_SelectInput: change input stream
- *******************************************************************************
- * Kill existing input, if any, and try to open a new one, using an input
- * configuration table.
- *******************************************************************************/
-int intf_SelectInput( intf_thread_t * p_intf, int i_index )
+/*****************************************************************************
+ * 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)
 {
-    intf_DbgMsg("0x%x\n", p_intf );
-    
-    /* Kill existing input, if any */
-    if( p_intf->p_input != NULL )
-    {        
-        input_DestroyThread( p_intf->p_input /*??, NULL*/ );
-    }
+    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;
+    }        
+}
 
-    /* Check that input index is valid */
-    if( (i_index < 0)  || (INTF_MAX_INPUT_CFG < i_index) )
-    {        
-        p_intf->p_input = NULL;     
-        return( 1 );        
-    }    
+/* Basic getKey function... */
+keyparm intf_GetKey( intf_thread_t *p_intf, int r_key)
+{   
+    keyparm reply;
     
-    /* Open a new input */
-    p_intf->p_input = input_CreateThread( &INTF_INPUT_CFG[ i_index ] /*??, NULL*/ );        
-    return( p_intf->p_input == NULL );    
+    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;
 }
 
-/*******************************************************************************
+/*****************************************************************************
+* intf_AssignNormalKeys: used for normal interfaces.
+*****************************************************************************
+* This function assign the basic key to the normal keys.
+*****************************************************************************/
+
+void intf_AssignNormalKeys( intf_thread_t *p_intf)
+{
+    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_AssignKey( p_intf , 'd', INTF_KEY_DUMP_STREAM, 0);
+}   
+
+/*****************************************************************************
  * 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 )
+ *****************************************************************************/
+int intf_ProcessKey( intf_thread_t *p_intf, int g_key )
 {
-    switch( i_key )
+    static int i_volbackup;
+    keyparm k_reply;
+    
+    k_reply = intf_GetKey( p_intf, g_key); 
+    switch( k_reply.key )
     {
-    case 'Q':                                                    /* quit order */
-    case 'q':
-    case 27:
+    case INTF_KEY_QUIT:                                        /* quit order */
         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':                    
-        if( intf_SelectInput( p_intf, i_key - '0' ) )
-        {
-            intf_ErrMsg("error: can not open channel %d\n", i_key - '0');            
-        }        
         break;
-    case '+':                                                      /* volume + */
-        // ??
+    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->i_vol < VOLUME_MAX) )
+            p_main->p_aout->i_vol += VOLUME_STEP;
+        break;
+    case INTF_KEY_DEC_VOLUME:                                    /* volume - */
+        if( (p_main->p_aout != NULL) && (p_main->p_aout->i_vol > VOLUME_STEP) )
+            p_main->p_aout->i_vol -= VOLUME_STEP;
         break;
-    case '-':                                                      /* volume - */
-        // ??
+    case INTF_KEY_TOGGLE_VOLUME:                              /* toggle mute */
+        if( (p_main->p_aout != NULL) && (p_main->p_aout->i_vol))
+        {
+            i_volbackup = p_main->p_aout->i_vol;
+            p_main->p_aout->i_vol = 0;
+        }
+        else if( (p_main->p_aout != NULL) && (!p_main->p_aout->i_vol))
+            p_main->p_aout->i_vol = i_volbackup;
         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) )
+    case INTF_KEY_DEC_GAMMA:                                      /* gamma - */
+        if( (p_main->p_vout != NULL) && (p_main->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 )
+            /* 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) )
         {
-            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 );      
+            /* 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 ' ':                                                   /* toggle info */
-        if( p_intf->p_vout != NULL )
+        break;
+   case INTF_KEY_DUMP_STREAM:
+        if( p_intf->p_input != 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 );      
+            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 );
         }
-        break;                                
-    default:                                                    /* unknown key */
-        return( 1 );        
+        break;
+   default:                                                   /* unknown key */
+        return( 1 );
     }
 
-    return( 0 );    
+    return( 0 );
 }
-
-    
-