]> git.sesse.net Git - vlc/blobdiff - src/interface/interaction.c
Interaction: set the p_parent field
[vlc] / src / interface / interaction.c
index fab49f7f27e02f266db8bfe3eaf47c7059a2c549..c3322c11d4655689a4cb1350699ca639e18617e6 100644 (file)
 # include "config.h"
 #endif
 
-#include <vlc/vlc.h>
+#include <vlc_common.h>
 
 #include <vlc_interface.h>
 #include "interface.h"
+#include "libvlc.h"
+
+#include <assert.h>
 
 /*****************************************************************************
  * Local prototypes
  *****************************************************************************/
+
+/**
+ * This structure contains the active interaction dialogs, and is
+ * used by the manager
+ */
+struct interaction_t
+{
+    VLC_COMMON_MEMBERS
+
+    vlc_thread_t thread;
+    vlc_cond_t wait;
+
+    int                         i_dialogs;      ///< Number of dialogs
+    interaction_dialog_t      **pp_dialogs;     ///< Dialogs
+    intf_thread_t              *p_intf;         ///< Interface to use
+    int                         i_last_id;      ///< Last attributed ID
+};
+
 static interaction_t *          InteractionGet( vlc_object_t * );
-static void                     InteractionSearchInterface( interaction_t * );
-static void                     InteractionLoop( vlc_object_t * );
+static intf_thread_t *          SearchInterface( interaction_t * );
+static void*                    InteractionLoop( void * );
 static void                     InteractionManage( interaction_t * );
-static void interaction_Destructor( vlc_object_t *p_interaction );
 
-static interaction_dialog_t    *DialogGetById( interaction_t* , int );
 static void                     DialogDestroy( interaction_dialog_t * );
 static int DialogSend( vlc_object_t *, interaction_dialog_t * );
 
-#define DIALOG_INIT( type ) \
-        DECMALLOC_ERR( p_new, interaction_dialog_t );       \
-        memset( p_new, 0, sizeof( interaction_dialog_t ) ); \
-        p_new->b_cancelled = VLC_FALSE;                     \
-        p_new->i_status = NEW_DIALOG;                       \
-        p_new->i_flags = 0;                                 \
-        p_new->i_type = INTERACT_DIALOG_##type;             \
-        p_new->psz_returned[0] = NULL;                      \
+#define DIALOG_INIT( type, err ) \
+        interaction_dialog_t* p_new = calloc( 1, sizeof( interaction_dialog_t ) ); \
+        if( !p_new ) return err;                        \
+        p_new->p_parent = vlc_object_hold( p_this );    \
+        p_new->b_cancelled = false;                     \
+        p_new->i_status = NEW_DIALOG;                   \
+        p_new->i_flags = 0;                             \
+        p_new->i_type = INTERACT_DIALOG_##type;         \
+        p_new->psz_returned[0] = NULL;                  \
         p_new->psz_returned[1] = NULL
 
 #define FORMAT_DESC \
@@ -78,12 +98,12 @@ static int DialogSend( vlc_object_t *, interaction_dialog_t * );
  * \param psz_format The message to display
  * \return           VLC_SUCCESS or VLC_EGENERIC
  */
-int __intf_UserFatal( vlc_object_t *p_this, vlc_bool_t b_blocking,
+int __intf_UserFatal( vlc_object_t *p_this, bool b_blocking,
                        const char *psz_title,
                        const char *psz_format, ... )
 {
     va_list args;
-    DIALOG_INIT( ONEWAY );
+    DIALOG_INIT( ONEWAY, VLC_EGENERIC );
 
     p_new->psz_title = strdup( psz_title );
     FORMAT_DESC;
@@ -109,7 +129,7 @@ int __intf_UserWarn( vlc_object_t *p_this,
                      const char *psz_format, ... )
 {
     va_list args;
-    DIALOG_INIT( ONEWAY );
+    DIALOG_INIT( ONEWAY, VLC_EGENERIC );
 
     p_new->psz_title = strdup( psz_title );
     FORMAT_DESC;
@@ -137,7 +157,7 @@ int __intf_UserYesNo( vlc_object_t *p_this,
                       const char *psz_alternate,
                       const char *psz_other )
 {
-    DIALOG_INIT( TWOWAY );
+    DIALOG_INIT( TWOWAY, VLC_EGENERIC );
 
     p_new->psz_title = strdup( psz_title );
     p_new->psz_description = strdup( psz_description );
@@ -158,12 +178,13 @@ int __intf_UserYesNo( vlc_object_t *p_this,
  * \param psz_status       Current status
  * \param f_position       Current position (0.0->100.0)
  * \param i_timeToGo       Time (in sec) to go until process is finished
- * \return                 Dialog id, to give to UserProgressUpdate
+ * \return                 Dialog, for use with UserProgressUpdate
  */
-int __intf_Progress( vlc_object_t *p_this, const char *psz_title,
+interaction_dialog_t *
+__intf_Progress( vlc_object_t *p_this, const char *psz_title,
                      const char *psz_status, float f_pos, int i_time )
 {
-    DIALOG_INIT( ONEWAY );
+    DIALOG_INIT( ONEWAY, NULL );
     p_new->psz_description = strdup( psz_status );
     p_new->val.f_float = f_pos;
     p_new->i_timeToGo = i_time;
@@ -178,37 +199,25 @@ int __intf_Progress( vlc_object_t *p_this, const char *psz_title,
         p_new->i_flags = DIALOG_INTF_PROGRESS;
 
     DialogSend( p_this, p_new );
-    return p_new->i_id;
+    return p_new;
 }
 
 /**
  * Update a progress bar in a dialogue
  *
- * \param p_this           Parent vlc_object
- * \param i_id             Identifier of the dialog
+ * \param p_dialog         Dialog
  * \param psz_status       New status
  * \param f_position       New position (0.0->100.0)
  * \param i_timeToGo       Time (in sec) to go until process is finished
  * \return                 nothing
  */
-void __intf_ProgressUpdate( vlc_object_t *p_this, int i_id,
+void intf_ProgressUpdate( interaction_dialog_t *p_dialog,
                             const char *psz_status, float f_pos, int i_time )
 {
-    interaction_t *p_interaction = InteractionGet( p_this );
-    interaction_dialog_t *p_dialog;
-
-    if( !p_interaction ) return;
+    interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
+    assert( p_interaction );
 
     vlc_object_lock( p_interaction );
-    p_dialog  =  DialogGetById( p_interaction, i_id );
-
-    if( !p_dialog )
-    {
-        vlc_object_unlock( p_interaction );
-        vlc_object_release( p_interaction );
-        return;
-    }
-
     free( p_dialog->psz_description );
     p_dialog->psz_description = strdup( psz_status );
 
@@ -217,7 +226,7 @@ void __intf_ProgressUpdate( vlc_object_t *p_this, int i_id,
 
     p_dialog->i_status = UPDATED_DIALOG;
 
-    vlc_object_signal_unlocked( p_interaction );
+    vlc_cond_signal( &p_interaction->wait );
     vlc_object_unlock( p_interaction );
     vlc_object_release( p_interaction );
 }
@@ -226,27 +235,16 @@ void __intf_ProgressUpdate( vlc_object_t *p_this, int i_id,
  * Helper function to communicate dialogue cancellations between the
  * interface module and the caller
  *
- * \param p_this           Parent vlc_object
- * \param i_id             Identifier of the dialogue
+ * \param p_dialog         Dialog
  * \return                 Either true or false
  */
-vlc_bool_t __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id )
+bool intf_ProgressIsCancelled( interaction_dialog_t *p_dialog )
 {
-    interaction_t *p_interaction = InteractionGet( p_this );
-    interaction_dialog_t *p_dialog;
-    vlc_bool_t b_cancel;
-
-    if( !p_interaction ) return VLC_TRUE;
+    interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
+    bool b_cancel;
 
+    assert( p_interaction );
     vlc_object_lock( p_interaction );
-    p_dialog  =  DialogGetById( p_interaction, i_id );
-    if( !p_dialog )
-    {
-        vlc_object_unlock( p_interaction ) ;
-        vlc_object_release( p_interaction );
-        return VLC_TRUE;
-    }
-
     b_cancel = p_dialog->b_cancelled;
     vlc_object_unlock( p_interaction );
     vlc_object_release( p_interaction );
@@ -270,11 +268,11 @@ int __intf_UserLoginPassword( vlc_object_t *p_this,
         char **ppsz_password )
 {
     int i_ret;
-    DIALOG_INIT( TWOWAY );
+    DIALOG_INIT( TWOWAY, VLC_EGENERIC );
     p_new->i_type = INTERACT_DIALOG_TWOWAY;
     p_new->psz_title = strdup( psz_title );
     p_new->psz_description = strdup( psz_description );
-    p_new->psz_default_button = strdup( _("Ok" ) );
+    p_new->psz_default_button = strdup( _("OK" ) );
     p_new->psz_alternate_button = strdup( _("Cancel" ) );
 
     p_new->i_flags = DIALOG_LOGIN_PW_OK_CANCEL;
@@ -306,7 +304,7 @@ int __intf_UserStringInput( vlc_object_t *p_this,
         char **ppsz_usersString )
 {
     int i_ret;
-    DIALOG_INIT( TWOWAY );
+    DIALOG_INIT( TWOWAY, VLC_EGENERIC );
     p_new->i_type = INTERACT_DIALOG_TWOWAY;
     p_new->psz_title = strdup( psz_title );
     p_new->psz_description = strdup( psz_description );
@@ -326,23 +324,17 @@ int __intf_UserStringInput( vlc_object_t *p_this,
 /**
  * Hide an interaction dialog
  *
- * \param p_this the parent vlc object
- * \param i_id the id of the item to hide
+ * \param p_dialog the dialog to hide
  * \return nothing
  */
-void __intf_UserHide( vlc_object_t *p_this, int i_id )
+void intf_UserHide( interaction_dialog_t *p_dialog )
 {
-    interaction_t *p_interaction = InteractionGet( p_this );
-    interaction_dialog_t *p_dialog;
-
-    if( !p_interaction ) return;
+    interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
+    assert( p_interaction );
 
     vlc_object_lock( p_interaction );
-    p_dialog = DialogGetById( p_interaction, i_id );
-
-    if( p_dialog )
-        p_dialog->i_status = ANSWERED_DIALOG;
-
+    p_dialog->i_status = ANSWERED_DIALOG;
+    vlc_cond_signal( &p_interaction->wait );
     vlc_object_unlock( p_interaction );
     vlc_object_release( p_interaction );
 }
@@ -353,96 +345,119 @@ void __intf_UserHide( vlc_object_t *p_this, int i_id )
  *
  * \return a vlc_object_t that should be freed when done.
  */
-vlc_object_t * interaction_Init( libvlc_int_t *p_libvlc )
+interaction_t * interaction_Init( libvlc_int_t *p_libvlc )
 {
     interaction_t *p_interaction;
 
     /* Make sure we haven't yet created an interaction object */
-    assert( vlc_object_find( p_libvlc, VLC_OBJECT_INTERACTION, FIND_ANYWHERE ) == NULL );
-    
-    p_interaction = vlc_object_create( p_libvlc, VLC_OBJECT_INTERACTION );
+    assert( libvlc_priv(p_libvlc)->p_interaction == NULL );
+
+    p_interaction = vlc_custom_create( VLC_OBJECT(p_libvlc),
+                                       sizeof( *p_interaction ),
+                                       VLC_OBJECT_GENERIC, "interaction" );
+    if( !p_interaction )
+        return NULL;
+
+    vlc_object_attach( p_interaction, p_libvlc );
+    p_interaction->i_dialogs = 0;
+    p_interaction->pp_dialogs = NULL;
+    p_interaction->p_intf = NULL;
+    p_interaction->i_last_id = 0;
 
-    if( p_interaction )
+    vlc_cond_init( &p_interaction->wait );
+
+    if( vlc_clone( &p_interaction->thread, InteractionLoop, p_interaction,
+                   VLC_THREAD_PRIORITY_LOW ) )
     {
-        vlc_object_attach( p_interaction, p_libvlc );
-        
-        p_interaction->i_dialogs = 0;
-        p_interaction->pp_dialogs = NULL;
-        p_interaction->p_intf = NULL;
-        p_interaction->i_last_id = 0;
-
-        if( vlc_thread_create( p_interaction, "Interaction control",
-                                InteractionLoop, VLC_THREAD_PRIORITY_LOW,
-                                VLC_FALSE ) )
-        {
-            msg_Err( p_interaction, "Interaction control thread creation failed"
-                    ", interaction will not be displayed" );
-            vlc_object_detach( p_interaction );
-            vlc_object_release( p_interaction );
-            p_interaction = NULL;
-        }
+        msg_Err( p_interaction, "Interaction control thread creation failed, "
+                 "interaction will not be displayed" );
+        vlc_object_detach( p_interaction );
+        vlc_object_release( p_interaction );
+        return NULL;
     }
-    
-    vlc_object_set_destructor( p_interaction, interaction_Destructor );
 
-    return VLC_OBJECT( p_interaction );
+    return p_interaction;
 }
 
-static void interaction_Destructor( vlc_object_t *p_interaction )
+void interaction_Destroy( interaction_t *p_interaction )
 {
-    vlc_thread_join( p_interaction );
-}
+    if( !p_interaction )
+        return;
 
-/**********************************************************************
- * The following functions are local
- **********************************************************************/
+    vlc_cancel( p_interaction->thread );
+    vlc_join( p_interaction->thread, NULL );
+    vlc_cond_destroy( &p_interaction->wait );
 
-/* Get the interaction object. Create it if needed */
-static interaction_t * InteractionGet( vlc_object_t *p_this )
-{
-    return vlc_object_find( p_this, VLC_OBJECT_INTERACTION, FIND_ANYWHERE );
+    /* Remove all dialogs - Interfaces must be able to clean up their data */
+    for( int i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
+    {
+        interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
+        DialogDestroy( p_dialog );
+        REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
+    }
+    vlc_object_release( p_interaction );
 }
 
+static vlc_mutex_t intf_lock = VLC_STATIC_MUTEX;
 
-/* Look for an interface suitable for interaction */
-static void InteractionSearchInterface( interaction_t *p_interaction )
+int interaction_Register( intf_thread_t *intf )
 {
-    vlc_list_t  *p_list;
-    int          i_index;
+    libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc );
+    int ret = VLC_EGENERIC;
+
+    vlc_mutex_lock( &intf_lock );
+    if( priv->p_interaction_intf == NULL )
+    {   /* Since the interface is responsible for unregistering itself before
+         * it terminates, an object reference is not needed. */
+        priv->p_interaction_intf = intf;
+        ret = VLC_SUCCESS;
+    }
+    vlc_mutex_unlock( &intf_lock );
+    return ret;
+}
 
-    p_interaction->p_intf = NULL;
+int interaction_Unregister( intf_thread_t *intf )
+{
+    libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc );
+    int ret = VLC_EGENERIC;
 
-    p_list = vlc_list_find( p_interaction, VLC_OBJECT_INTF, FIND_ANYWHERE );
-    if( !p_list )
+    vlc_mutex_lock( &intf_lock );
+    if( priv->p_interaction_intf == intf )
     {
-        msg_Err( p_interaction, "unable to create module list" );
-        return;
+        priv->p_interaction_intf = NULL;
+        ret = VLC_SUCCESS;
     }
+    vlc_mutex_unlock( &intf_lock );
+    return ret;
+}
 
-    for( i_index = 0; i_index < p_list->i_count; i_index ++ )
-    {
-        intf_thread_t *p_intf = (intf_thread_t *)
-                                        p_list->p_values[i_index].p_object;
-        if( p_intf->b_interaction )
-        {
-            p_interaction->p_intf = p_intf;
-            break;
-        }
-    }
-    vlc_list_release ( p_list );
+/**********************************************************************
+ * The following functions are local
+ **********************************************************************/
+
+/* Get the interaction object */
+static interaction_t * InteractionGet( vlc_object_t *p_this )
+{
+    interaction_t *obj = libvlc_priv(p_this->p_libvlc)->p_interaction;
+    if( obj )
+        vlc_object_hold( obj );
+    return obj;
 }
 
-/* Find an interaction dialog by its id */
-static interaction_dialog_t *DialogGetById( interaction_t *p_interaction,
-                                            int i_id )
+
+/* Look for an interface suitable for interaction, and hold it. */
+static intf_thread_t *SearchInterface( interaction_t *p_interaction )
 {
-    int i;
-    for( i = 0 ; i< p_interaction->i_dialogs; i++ )
-    {
-        if( p_interaction->pp_dialogs[i]->i_id == i_id )
-            return p_interaction->pp_dialogs[i];
-    }
-    return NULL;
+    libvlc_priv_t *priv = libvlc_priv( p_interaction->p_libvlc );
+    intf_thread_t *intf;
+
+    vlc_mutex_lock( &intf_lock );
+    intf = priv->p_interaction_intf;
+    if( intf != NULL )
+        vlc_object_hold( intf );
+    vlc_mutex_unlock( &intf_lock );
+
+    return intf;
 }
 
 /* Destroy a dialog */
@@ -453,6 +468,7 @@ static void DialogDestroy( interaction_dialog_t *p_dialog )
     free( p_dialog->psz_default_button );
     free( p_dialog->psz_alternate_button );
     free( p_dialog->psz_other_button );
+    vlc_object_release( p_dialog->p_parent );
     free( p_dialog );
 }
 
@@ -460,19 +476,22 @@ static void DialogDestroy( interaction_dialog_t *p_dialog )
  * if required */
 static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
 {
-    interaction_t *p_interaction = InteractionGet( p_this );
+    interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
 
-    /* Get an id, if we don't already have one */
-    if( p_dialog->i_id == 0 )
-        p_dialog->i_id = ++p_interaction->i_last_id;
+    if( !p_interaction )
+        return VLC_EGENERIC;
 
-    if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT ) return VLC_EGENERIC;
+    if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
+    {
+        vlc_object_release( p_interaction );
+        return VLC_EGENERIC;
+    }
 
     if( config_GetInt( p_this, "interact" ) ||
         p_dialog->i_flags & DIALOG_BLOCKING_ERROR ||
         p_dialog->i_flags & DIALOG_NONBLOCKING_ERROR )
     {
-        vlc_bool_t b_found = VLC_FALSE;
+        bool b_found = false;
         int i;
         p_dialog->p_interaction = p_interaction;
         p_dialog->p_parent = p_this;
@@ -481,8 +500,8 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
         vlc_object_lock( p_interaction );
         for( i = 0 ; i< p_interaction->i_dialogs; i++ )
         {
-            if( p_interaction->pp_dialogs[i]->i_id == p_dialog->i_id )
-                b_found = VLC_TRUE;
+            if( p_interaction->pp_dialogs[i] == p_dialog )
+                b_found = true;
         }
         /* Add it to the queue, the main loop will send the orders to the
          * interface */
@@ -498,7 +517,7 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
 
         if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY ) /* Wait for answer */
         {
-            vlc_object_signal_unlocked( p_interaction );
+            vlc_cond_signal( &p_interaction->wait );
             while( p_dialog->i_status != ANSWERED_DIALOG &&
                    p_dialog->i_status != HIDING_DIALOG &&
                    p_dialog->i_status != HIDDEN_DIALOG &&
@@ -514,7 +533,7 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
                 p_dialog->i_status = ANSWERED_DIALOG;
             }
             p_dialog->i_flags |= DIALOG_GOT_ANSWER;
-            vlc_object_signal_unlocked( p_interaction );
+            vlc_cond_signal( &p_interaction->wait );
             vlc_object_unlock( p_interaction );
             vlc_object_release( p_interaction );
             return p_dialog->i_return;
@@ -523,7 +542,7 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
         {
             /* Pretend we already retrieved the "answer" */
             p_dialog->i_flags |=  DIALOG_GOT_ANSWER;
-            vlc_object_signal_unlocked( p_interaction );
+            vlc_cond_signal( &p_interaction->wait );
             vlc_object_unlock( p_interaction );
             vlc_object_release( p_interaction );
             return VLC_SUCCESS;
@@ -536,30 +555,22 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
     }
 }
 
-static void InteractionLoop( vlc_object_t *p_this )
+static void* InteractionLoop( void *p_this )
 {
-    int i;
-    interaction_t *p_interaction = (interaction_t*) p_this;
+    interaction_t *p_interaction = p_this;
 
-    while( !p_this->b_die )
+    vlc_object_lock( p_interaction );
+    mutex_cleanup_push( &(vlc_internals(p_interaction)->lock) );
+    for( ;; )
     {
-        vlc_object_lock( p_this );
-        if( vlc_object_wait( p_this ) )
-        {
-            vlc_object_unlock( p_this );
-            break;
-        }
+        int canc = vlc_savecancel();
         InteractionManage( p_interaction );
-        vlc_object_unlock( p_this );
-    }
+        vlc_restorecancel( canc );
 
-    /* Remove all dialogs - Interfaces must be able to clean up their data */
-    for( i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
-    {
-        interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
-        DialogDestroy( p_dialog );
-        REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
+        vlc_cond_wait( &p_interaction->wait, &(vlc_internals(p_interaction)->lock) );
     }
+    vlc_cleanup_pop( );
+    assert( 0 );
 }
 
 /**
@@ -577,7 +588,7 @@ static void InteractionManage( interaction_t *p_interaction )
     /* Nothing to do */
     if( p_interaction->i_dialogs == 0 ) return;
 
-    InteractionSearchInterface( p_interaction );
+    p_interaction->p_intf = SearchInterface( p_interaction );
     if( !p_interaction->p_intf )
     {
         /* We mark all dialogs as answered with their "default" answer */
@@ -593,8 +604,6 @@ static void InteractionManage( interaction_t *p_interaction )
                 p_dialog->i_status = HIDING_DIALOG;
         }
     }
-    else
-        vlc_object_yield( p_interaction->p_intf );
 
     for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
     {