]> git.sesse.net Git - vlc/blobdiff - src/interface/interface.c
LGPL
[vlc] / src / interface / interface.c
index 2b412d67601b0822b3f6c8670d32b8f21d229af0..0d75fef0df819b6469902ea79fef635e688b42ae 100644 (file)
@@ -3,24 +3,24 @@
  * This library provides basic functions for threads to interact with user
  * interface, such as command line.
  *****************************************************************************
- * Copyright (C) 1998-2007 the VideoLAN team
+ * Copyright (C) 1998-2007 VLC authors and VideoLAN
  * $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
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 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 Lesser 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.
+ * You should have received a copy of the GNU Lesser 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.
  *****************************************************************************/
 
 /**
 # include "config.h"
 #endif
 
-#include <vlc_common.h>
-
-#include <vlc_aout.h>
-#include <vlc_vout.h>
+#include <assert.h>
+#ifdef HAVE_UNISTD_H
+# include <unistd.h>
+#endif
 
-#include "vlc_interface.h"
+#include <vlc_common.h>
+#include <vlc_modules.h>
+#include <vlc_interface.h>
 #include "libvlc.h"
 
 /*****************************************************************************
  * Local prototypes
  *****************************************************************************/
-static void* RunInterface( vlc_object_t *p_this );
-#ifdef __APPLE__
+static void* RunInterface( void * );
+#if defined( __APPLE__)
 static void * MonitorLibVLCDeath( vlc_object_t *p_this );
 #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 );
-}
+static vlc_mutex_t lock = VLC_STATIC_MUTEX;
 
-/*****************************************************************************
- * intf_Create: prepare interface before main loop
- *****************************************************************************
- * This function opens output devices and creates specific interfaces. It sends
- * its own error messages.
- *****************************************************************************/
+#undef intf_Create
 /**
- * Create the interface, and prepare it for main loop.
+ * Create and start an interface.
  *
- * \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
+ * @param p_this the calling vlc_object_t
+ * @param chain configuration chain string
+ * @return VLC_SUCCESS or an error code
  */
-intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module )
+int intf_Create( vlc_object_t *p_this, const char *chain )
 {
+    libvlc_int_t *p_libvlc = p_this->p_libvlc;
     intf_thread_t * p_intf;
 
     /* Allocate structure */
-    p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
+    p_intf = vlc_custom_create( p_libvlc, sizeof( *p_intf ), "interface" );
     if( !p_intf )
-        return NULL;
-    p_intf->b_interaction = false;
-#ifdef __APPLE__
+        return VLC_ENOMEM;
+
+    /* Variable used for interface spawning */
+    vlc_value_t val, text;
+    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 );
+#if !defined(WIN32) && defined(HAVE_ISATTY)
+    if( isatty( 0 ) )
+#endif
+    {
+        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");
+    var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
+    val.psz_string = (char *)"http";
+    text.psz_string = (char *)_("Web");
+    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 );
+
+    /* Attach interface to LibVLC */
+#if defined( __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 );
-
+    p_intf->p_cfg = NULL;
+    char *psz_parser = *chain == '$'
+                     ? var_CreateGetString(p_intf, chain+1)
+                     : strdup( chain );
+    char *module;
+    char *psz_tmp = config_ChainCreate( &module, &p_intf->p_cfg,
+                                        psz_parser );
+    free( psz_tmp );
+    free( psz_parser );
+    p_intf->p_module = module_need( p_intf, "interface", module, true );
+    free(module);
     if( p_intf->p_module == NULL )
     {
         msg_Err( p_intf, "no suitable interface module" );
-        free( p_intf->psz_intf );
-        vlc_object_release( p_intf );
-        return NULL;
+        goto error;
     }
 
-    /* Initialize structure */
-    p_intf->b_menu        = false;
-    p_intf->b_menu_change = false;
-
-    /* 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__
+#if defined( __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 )
     {
-        if( vlc_thread_create( p_intf, "interface", MonitorLibVLCDeath,
-                               VLC_THREAD_PRIORITY_LOW, false ) )
+        if( vlc_clone( &p_intf->thread,
+                       MonitorLibVLCDeath, p_intf, VLC_THREAD_PRIORITY_LOW ) )
         {
             msg_Err( p_intf, "cannot spawn libvlc death monitoring thread" );
-            return VLC_EGENERIC;
+            goto error;
         }
-        RunInterface( VLC_OBJECT(p_intf) );
+        assert( p_intf->pf_run );
+        p_intf->pf_run( 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_kill( p_intf->p_libvlc );
 
-        vlc_object_detach( p_intf );
-        vlc_object_release( p_intf );
-        return VLC_SUCCESS;
+        vlc_join( p_intf->thread, NULL );
     }
+    else
 #endif
     /* Run the interface in a separate thread */
-    if( vlc_thread_create( p_intf, "interface", RunInterface,
-                           VLC_THREAD_PRIORITY_LOW, false ) )
+    if( p_intf->pf_run
+     && vlc_clone( &p_intf->thread,
+                   RunInterface, p_intf, VLC_THREAD_PRIORITY_LOW ) )
     {
         msg_Err( p_intf, "cannot spawn interface thread" );
-        return VLC_EGENERIC;
+        goto error;
     }
 
+    vlc_mutex_lock( &lock );
+    p_intf->p_next = libvlc_priv( p_libvlc )->p_intf;
+    libvlc_priv( p_libvlc )->p_intf = p_intf;
+    vlc_mutex_unlock( &lock );
+
     return VLC_SUCCESS;
+
+error:
+    if( p_intf->p_module )
+        module_unneed( p_intf, p_intf->p_module );
+    config_ChainDestroy( p_intf->p_cfg );
+    vlc_object_release( p_intf );
+    return VLC_EGENERIC;
 }
 
+
 /**
- * Stops the interface thread
- *
- * This function asks the interface thread to stop
- * \param p_intf the interface thread
- * \return nothing
+ * Stops and destroys all interfaces
+ * @param p_libvlc the LibVLC instance
  */
-void intf_StopThread( intf_thread_t *p_intf )
+void intf_DestroyAll( libvlc_int_t *p_libvlc )
 {
-    /* Tell the interface to die */
-    vlc_object_kill( p_intf );
-    vlc_thread_join( p_intf );
-}
+    intf_thread_t *p_first;
 
-/* Following functions are local */
+    vlc_mutex_lock( &lock );
+    p_first = libvlc_priv( p_libvlc )->p_intf;
+#ifndef NDEBUG
+    libvlc_priv( p_libvlc )->p_intf = NULL;
+#endif
+    vlc_mutex_unlock( &lock );
 
-/*****************************************************************************
- * RunInterface: setups necessary data and give control to the interface
- *****************************************************************************/
-static void* RunInterface( vlc_object_t *p_this )
-{
-    intf_thread_t *p_intf = (intf_thread_t *)p_this;
-    vlc_value_t val, text;
-    int canc = vlc_savecancel ();
+    /* Tell the interfaces to die */
+    for( intf_thread_t *p_intf = p_first; p_intf; p_intf = p_intf->p_next )
+        vlc_object_kill( p_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 );
+    /* Cleanup the interfaces */
+    for( intf_thread_t *p_intf = p_first; p_intf != NULL; )
+    {
+        intf_thread_t *p_next = p_intf->p_next;
 
-    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 );
+        if( p_intf->pf_run )
+        {
+            vlc_cancel( p_intf->thread );
+            vlc_join( p_intf->thread, NULL );
+        }
+        module_unneed( p_intf, p_intf->p_module );
+        config_ChainDestroy( p_intf->p_cfg );
+        vlc_object_release( p_intf );
 
-    var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
+        p_intf = p_next;
+    }
+}
 
-    /* Give control to the interface */
-    if( p_intf->pf_run )
-        p_intf->pf_run( p_intf );
+/* Following functions are local */
 
-    vlc_restorecancel (canc);
+/**
+ * RunInterface: setups necessary data and give control to the interface
+ *
+ * @param p_this: interface object
+ */
+static void* RunInterface( void *p_this )
+{
+    intf_thread_t *p_intf = p_this;
+
+    p_intf->pf_run( p_intf );
     return NULL;
 }
 
-#ifdef __APPLE__
-/*****************************************************************************
+#if defined( __APPLE__ )
+#include "../lib/libvlc_internal.h" /* libvlc_InternalWait */
+/**
  * MonitorLibVLCDeath: Used when b_should_run_on_first_thread is set.
- *****************************************************************************/
+ *
+ * @param p_this: the interface object
+ */
 static void * MonitorLibVLCDeath( vlc_object_t * p_this )
 {
     intf_thread_t *p_intf = (intf_thread_t *)p_this;
     libvlc_int_t * p_libvlc = p_intf->p_libvlc;
     int canc = vlc_savecancel ();
 
-    vlc_object_lock( p_libvlc );
-    while(vlc_object_alive( p_libvlc ) )
-    {
-        if(p_intf->b_die)
-        {
-            vlc_object_unlock( p_libvlc );
-            return NULL;
-        }
-        vlc_object_wait( p_libvlc );
-    }
-    vlc_object_unlock( p_libvlc );
+    libvlc_InternalWait( 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 );
-    }
-    vlc_list_release( p_list );
+    vlc_object_kill( p_intf ); /* Kill the stupid first thread interface */
     vlc_restorecancel (canc);
     return NULL;
 }
@@ -271,30 +251,17 @@ static void * MonitorLibVLCDeath( vlc_object_t * p_this )
 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 {
-    intf_thread_t *p_intf;
-    char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
-
     (void)psz_cmd; (void)oldval; (void)p_data;
+    char* psz_intf;
 
     /* Try to create the interface */
-    sprintf( psz_intf, "%s,none", newval.psz_string );
-    p_intf = intf_Create( p_this->p_libvlc, psz_intf );
+    if( asprintf( &psz_intf, "%s,none", newval.psz_string ) == -1 )
+        return VLC_ENOMEM;
+
+    int ret = intf_Create( VLC_OBJECT(p_this->p_libvlc), psz_intf );
     free( psz_intf );
-    if( p_intf == NULL )
-    {
+    if( ret )
         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 VLC_SUCCESS;
+    return ret;
 }
-