]> git.sesse.net Git - vlc/blobdiff - src/interface/interface.c
Prefer setenv to putenv (evenmore with local variables).
[vlc] / src / interface / interface.c
index 16e702d12cf014054c507a8a251d0907b3e178ff..e6349841b568db19c93ca4c365fdab7a64e85b5d 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-2007 the VideoLAN team
+ * $Id$
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
 
-/*******************************************************************************
+/**
+ *   \file
+ *   This file contains functions related to interface management
+ */
+
+
+/*****************************************************************************
  * 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 "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"
-
-
-/*******************************************************************************
+ *****************************************************************************/
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+
+#include <vlc_aout.h>
+#include <vlc_vout.h>
+
+#include "vlc_interface.h"
+#include "modules/modules.h" // Gruik!
+#include "libvlc.h"
+
+/*****************************************************************************
+ * Local prototypes
+ *****************************************************************************/
+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 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.
+ *****************************************************************************/
+/**
+ * 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 )
+        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->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("error: %s\n", strerror( ENOMEM ) );        
-       return( NULL );
+        msg_Err( p_intf, "no suitable interface module" );
+        free( p_intf->psz_intf );
+        vlc_object_release( p_intf );
+        return NULL;
     }
 
     /* Initialize structure */
-    p_intf->b_die =     0;    
-    p_intf->p_vout =    NULL;
-    p_intf->p_input =   NULL;   
+    p_intf->b_menu        = false;
+    p_intf->b_menu_change = false;
 
-    /* Start interfaces */
-    p_intf->p_console = intf_ConsoleCreate();
-    if( p_intf->p_console == NULL )
+    /* Initialize mutexes */
+    vlc_mutex_init( &p_intf->change_lock );
+
+    /* Attach interface to its parent object */
+    vlc_object_attach( p_intf, p_this );
+    vlc_object_set_destructor( p_intf, intf_Destroy );
+
+    return p_intf;
+}
+
+/*****************************************************************************
+ * intf_RunThread: launch the interface thread
+ *****************************************************************************
+ * This function either creates a new thread and runs the interface in it.
+ *****************************************************************************/
+/**
+ * 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 )
+{
+#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 )
     {
-        intf_ErrMsg("error: can't create control console\n");
-       free( p_intf );
-        return( NULL );
+        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 );
+
+        /* 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 );
+
+        vlc_object_detach( p_intf );
+        vlc_object_release( p_intf );
+        return VLC_SUCCESS;
     }
-    if( intf_SysCreate( p_intf ) )
+#endif
+    /* Run the interface in a separate thread */
+    if( vlc_thread_create( p_intf, "interface", RunInterface,
+                           VLC_THREAD_PRIORITY_LOW, false ) )
     {
-       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 );
+        msg_Err( p_intf, "cannot spawn interface thread" );
+        return VLC_EGENERIC;
+    }
+
+    return VLC_SUCCESS;
 }
 
-/*******************************************************************************
- * 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");
-    }
+/**
+ * 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 );
+}
 
-    /* Main loop */
-    while(!p_intf->b_die)
-    {
-        /* Flush waiting messages */
-        intf_FlushMsg();
+/* Following functions are local */
 
-        /* Manage specific interface */
-        intf_SysManage( p_intf );
+/*****************************************************************************
+ * RunInterface: setups necessary data and give control to the interface
+ *****************************************************************************/
+static void RunInterface( intf_thread_t *p_intf )
+{
+    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 );
 
-        /* Check attached threads status */
-        if( (p_intf->p_vout != NULL) && p_intf->p_vout->b_error )
+    do
+    {
+        /* Give control to the interface */
+        if( p_intf->pf_run )
+            p_intf->pf_run( p_intf );
+        else
         {
-            //?? add aout error detection
-            p_intf->b_die = 1;            
-        }    
-        if( (p_intf->p_input != NULL) && p_intf->p_input->b_error )
+            vlc_object_lock( p_intf );
+            while( vlc_object_alive( p_intf ) )
+                vlc_object_wait( p_intf );
+            vlc_object_unlock( p_intf );
+        }
+
+        if( !p_intf->psz_switch_intf )
         {
-            input_DestroyThread( p_intf->p_input /*, NULL */ );            
-            p_intf->p_input = NULL;            
-            intf_DbgMsg("Input thread destroyed\n");            
+            break;
         }
 
-        /* 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 );
-    }
-}
+        /* Make sure the old interface is completely uninitialized */
+        module_Unneed( p_intf, p_intf->p_module );
 
-/*******************************************************************************
- * 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 );
+        /* Provide ability to switch the main interface on the fly */
+        psz_intf = p_intf->psz_switch_intf;
+        p_intf->psz_switch_intf = NULL;
+
+        vlc_object_lock( p_intf );
+        p_intf->b_die = false; /* FIXME */
+        p_intf->b_dead = false;
+
+        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 );
 }
 
-/*******************************************************************************
- * intf_SelectInput: change input stream
- *******************************************************************************
- * Kill existing input, if any, and try to open a new one. If p_cfg is NULL,
- * no new input will be openned.
- *******************************************************************************/
-int intf_SelectInput( intf_thread_t * p_intf, input_cfg_t *p_cfg )
+#ifdef __APPLE__
+/*****************************************************************************
+ * MonitorLibVLCDeath: Used when b_should_run_on_first_thread is set.
+ *****************************************************************************/
+static void MonitorLibVLCDeath( intf_thread_t *p_intf )
 {
-    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->p_input = NULL;        
+    libvlc_int_t * p_libvlc = p_intf->p_libvlc;
+    vlc_object_lock( p_libvlc );
+    while(vlc_object_alive( p_libvlc ) )
+    {
+        if(p_intf->b_die)
+        {
+            vlc_object_unlock( p_libvlc );
+            return;
+        }
+        vlc_object_wait( p_libvlc );
     }
-    
-    /* Open new one */
-    if( p_cfg != NULL )
-    {        
-        p_intf->p_input = input_CreateThread( p_cfg /*??, NULL*/ );    
+    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++ )
+    {
+        vlc_object_t * p_intf = p_list->p_values[i].p_object;
+        vlc_object_kill( p_intf );
     }
-    
-    return( (p_cfg != NULL) && (p_intf->p_input == NULL) );    
+    vlc_list_release( p_list );
 }
+#endif
 
-/*******************************************************************************
- * 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 )
+static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
+                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 {
-    switch( i_key )
+    intf_thread_t *p_intf;
+    char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
+
+    (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 'Q':                                                    /* quit order */
-    case 'q':
-    case 27:
-        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':                    
-        // ??
-        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_MAX) )
-        {
-            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_MAX) )
-        {       
-            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 'x':                                     /* horizontal aspect ratio - */
-        if( (p_intf->p_vout != NULL) && (p_intf->p_vout->f_x_ratio > INTF_RATIO_MIN) )
-        {
-            vlc_mutex_lock( &p_intf->p_vout->change_lock );
-            p_intf->p_vout->f_x_ratio /= INTF_RATIO_FACTOR;                        
-            p_intf->p_vout->i_changes |= VOUT_RATIO_CHANGE;
-            vlc_mutex_unlock( &p_intf->p_vout->change_lock );
-        }                    
-        break;                                        
-    case 'X':                                     /* horizontal aspect ratio + */
-        if( (p_intf->p_vout != NULL) && (p_intf->p_vout->f_x_ratio < INTF_RATIO_MAX) )
-        {       
-            vlc_mutex_lock( &p_intf->p_vout->change_lock );
-            p_intf->p_vout->f_x_ratio *= INTF_RATIO_FACTOR;
-            p_intf->p_vout->i_changes |= VOUT_RATIO_CHANGE;
-            vlc_mutex_unlock( &p_intf->p_vout->change_lock );
-        }                    
-        break;  
-    case 'y':                                       /* vertical aspect ratio - */
-        if( (p_intf->p_vout != NULL) && (p_intf->p_vout->f_y_ratio > INTF_RATIO_MIN) )
-        {
-            vlc_mutex_lock( &p_intf->p_vout->change_lock );
-            p_intf->p_vout->f_y_ratio /= INTF_RATIO_FACTOR;                        
-            p_intf->p_vout->i_changes |= VOUT_RATIO_CHANGE;
-            vlc_mutex_unlock( &p_intf->p_vout->change_lock );
-        }                    
-        break;                                        
-    case 'Y':                                     /* horizontal aspect ratio + */
-        if( (p_intf->p_vout != NULL) && (p_intf->p_vout->f_y_ratio < INTF_RATIO_MAX) )
-        {       
-            vlc_mutex_lock( &p_intf->p_vout->change_lock );
-            p_intf->p_vout->f_y_ratio *= INTF_RATIO_FACTOR;
-            p_intf->p_vout->i_changes |= VOUT_RATIO_CHANGE;
-            vlc_mutex_unlock( &p_intf->p_vout->change_lock );
-        }
-        break;        
-    case 'f':                                             /* toggle fullscreen */
-        //??
-        break;                                        
-    case ' ':                                                   /* 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;                                
-    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;
 }
 
-    
-