/*****************************************************************************
* interaction.c: User interaction functions
*****************************************************************************
- * Copyright (C) 1998-2004 VideoLAN
- * $Id: interface.c 10147 2005-03-05 17:18:30Z gbazin $
+ * Copyright © 2005-2008 the VideoLAN team
+ * $Id$
*
- * Authors: Clément Stenac <zorglub@videolan.org>
+ * Authors: Clément Stenac <zorglub@videolan.org>
+ * Felix Kühne <fkuehne@videolan.org>
*
* 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
*
* 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.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/**
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <stdlib.h> /* free(), strtol() */
-#include <stdio.h> /* FILE */
-#include <string.h> /* strerror() */
-#include <vlc/vlc.h>
-#include <vlc/input.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+
+#include <vlc_interface.h>
+#include "interface.h"
+#include "libvlc.h"
-#include "vlc_interaction.h"
-#include "vlc_interface.h"
-#include "vlc_playlist.h"
+#include <assert.h>
/*****************************************************************************
* Local prototypes
*****************************************************************************/
-static void intf_InteractionInit( playlist_t *p_playlist );
-static interaction_t * intf_InteractionGet( vlc_object_t *p_this );
-static void intf_InteractionSearchInterface( interaction_t *
- p_interaction );
-static int intf_WaitAnswer( interaction_t *p_interact,
- interaction_dialog_t *p_dialog );
-static int intf_Send( interaction_t *p_interact,
- interaction_dialog_t *p_dialog );
-static interaction_dialog_t *intf_InteractionGetById( vlc_object_t* , int );
/**
- * Send an interaction element to the user
- *
- * \param p_this the calling vlc_object_t
- * \param p_interact the interaction element
- * \return VLC_SUCCESS or an error code
+ * This structure contains the active interaction dialogs, and is
+ * used by the manager
*/
-int __intf_Interact( vlc_object_t *p_this, interaction_dialog_t *
- p_dialog )
+struct interaction_t
{
+ VLC_COMMON_MEMBERS
+
+ vlc_thread_t thread;
+ vlc_mutex_t lock;
+ vlc_cond_t wait;
+
+ int i_dialogs; ///< Number of dialogs
+ interaction_dialog_t **pp_dialogs; ///< Dialogs
+ intf_thread_t *p_intf; ///< Interface to use
+};
+
+static interaction_t * InteractionGet( vlc_object_t * );
+static intf_thread_t * SearchInterface( interaction_t * );
+static void* InteractionLoop( void * );
+static void InteractionManage( interaction_t * );
+
+static void DialogDestroy( interaction_dialog_t * );
+static int DialogSend( interaction_dialog_t * );
+
+#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 = SENT_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
- interaction_t *p_interaction = intf_InteractionGet( p_this );
-
- /* 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;
- }
+/**
+ * Helper function to create a dialogue showing a progress-bar with some info
+ *
+ * \param p_this Parent vlc_object
+ * \param psz_title Title for the dialog (NULL implies main intf )
+ * \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, for use with UserProgressUpdate
+ */
+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, NULL );
+ p_new->psz_description = strdup( psz_status );
+ p_new->val.f_float = f_pos;
+ p_new->i_timeToGo = i_time;
+ p_new->psz_alternate_button = strdup( _( "Cancel" ) );
- if( p_dialog->i_type == INTERACT_ASK )
+ if( psz_title )
{
- return intf_WaitAnswer( p_interaction, p_dialog );
+ p_new->psz_title = strdup( psz_title );
+ p_new->i_flags = DIALOG_USER_PROGRESS;
}
else
+ p_new->i_flags = DIALOG_INTF_PROGRESS;
+
+ if( DialogSend( p_new ) == VLC_EGENERIC )
{
- return intf_Send( p_interaction, p_dialog );
+ DialogDestroy( p_new );
+ return NULL;
}
+ return p_new;
+}
+
+/**
+ * Update a progress bar in a dialogue
+ *
+ * \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( interaction_dialog_t *p_dialog,
+ const char *psz_status, float f_pos, int i_time )
+{
+ interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
+ assert( p_interaction );
+
+ vlc_mutex_lock( &p_interaction->lock );
+ free( p_dialog->psz_description );
+ p_dialog->psz_description = strdup( psz_status );
+
+ p_dialog->val.f_float = f_pos;
+ p_dialog->i_timeToGo = i_time;
+
+ p_dialog->i_status = UPDATED_DIALOG;
+
+ vlc_cond_signal( &p_interaction->wait );
+ vlc_mutex_unlock( &p_interaction->lock );
+ vlc_object_release( p_interaction );
}
/**
- * Destroy the interaction system
+ * Helper function to communicate dialogue cancellations between the
+ * interface module and the caller
+ *
+ * \param p_dialog Dialog
+ * \return Either true or false
*/
-void intf_InteractionDestroy( interaction_t *p_interaction )
+bool intf_ProgressIsCancelled( interaction_dialog_t *p_dialog )
{
- /// \todo Code this, and call it
+ interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
+ bool b_cancel;
+
+ assert( p_interaction );
+ vlc_mutex_lock( &p_interaction->lock );
+ b_cancel = p_dialog->b_cancelled;
+ vlc_mutex_unlock( &p_interaction->lock );
+ vlc_object_release( p_interaction );
+ return b_cancel;
}
/**
- * The main interaction processing loop
- * This function is called from the playlist loop
+ * Hide an interaction dialog
*
- * \param p_playlist the parent playlist
+ * \param p_dialog the dialog to hide
* \return nothing
*/
-void intf_InteractionManage( playlist_t *p_playlist )
+void intf_UserHide( interaction_dialog_t *p_dialog )
+{
+ interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
+ assert( p_interaction );
+
+ vlc_mutex_lock( &p_interaction->lock );
+ p_dialog->i_status = ANSWERED_DIALOG;
+ vlc_cond_signal( &p_interaction->wait );
+ vlc_mutex_unlock( &p_interaction->lock );
+ vlc_object_release( p_interaction );
+}
+
+/**
+ * Create the initial interaction object
+ * (should only be used in libvlc_InternalInit, LibVLC private)
+ *
+ * \return a vlc_object_t that should be freed when done.
+ */
+interaction_t * interaction_Init( libvlc_int_t *p_libvlc )
{
- int i_index;
interaction_t *p_interaction;
- p_interaction = p_playlist->p_interaction;
+ /* Make sure we haven't yet created an interaction object */
+ assert( libvlc_priv(p_libvlc)->p_interaction == NULL );
- // Nothing to do
- if( p_interaction->i_dialogs == 0 ) return;
+ p_interaction = vlc_custom_create( VLC_OBJECT(p_libvlc),
+ sizeof( *p_interaction ),
+ VLC_OBJECT_GENERIC, "interaction" );
+ if( !p_interaction )
+ return NULL;
- vlc_mutex_lock( &p_interaction->object_lock );
+ vlc_object_attach( p_interaction, p_libvlc );
+ p_interaction->i_dialogs = 0;
+ p_interaction->pp_dialogs = NULL;
+ p_interaction->p_intf = NULL;
- intf_InteractionSearchInterface( p_interaction );
+ vlc_mutex_init( &p_interaction->lock );
+ vlc_cond_init( &p_interaction->wait );
- if( !p_interaction->p_intf )
+ if( vlc_clone( &p_interaction->thread, InteractionLoop, p_interaction,
+ VLC_THREAD_PRIORITY_LOW ) )
{
- vlc_mutex_unlock( &p_interaction->object_lock );
+ 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;
+ }
- /// \todo Remove all dialogs as we can't display them
+ return p_interaction;
+}
+
+void interaction_Destroy( interaction_t *p_interaction )
+{
+ if( !p_interaction )
return;
- }
- vlc_object_yield( p_interaction->p_intf );
+ vlc_cancel( p_interaction->thread );
+ vlc_join( p_interaction->thread, NULL );
+ vlc_cond_destroy( &p_interaction->wait );
+ vlc_mutex_destroy( &p_interaction->lock );
- for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
+ /* 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_index];
-
- switch( p_dialog->i_status )
- {
- case ANSWERED_DIALOG:
- /// \todo Signal we have an answer
- // - If have answer, signal what is waiting
- // (vlc_cond ? dangerous in case of pb ?)
-
- // Ask interface to hide it
- msg_Dbg( p_interaction, "Hiding dialog %i", p_dialog->i_id );
- p_interaction->p_intf->pf_interact( p_interaction->p_intf,
- p_dialog, INTERACT_HIDE );
- p_dialog->i_status = HIDING_DIALOG;
- break;
- case UPDATED_DIALOG:
- p_interaction->p_intf->pf_interact( p_interaction->p_intf,
- p_dialog, INTERACT_UPDATE );
- p_dialog->i_status = SENT_DIALOG;
- msg_Dbg( p_interaction, "Updating dialog %i, %i widgets",
- p_dialog->i_id, p_dialog->i_widgets );
- break;
- case HIDDEN_DIALOG:
- if( !p_dialog->b_reusable )
- {
- /// \todo Destroy the dialog
- }
- break;
- case NEW_DIALOG:
- // This is truly a new dialog, send it.
- p_interaction->p_intf->pf_interact( p_interaction->p_intf,
- p_dialog, INTERACT_NEW );
- msg_Dbg( p_interaction, "Creating dialog %i, %i widgets",
- p_dialog->i_id, p_dialog->i_widgets );
- p_dialog->i_status = SENT_DIALOG;
- break;
- }
+ 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->p_intf );
-
- vlc_mutex_unlock( &p_playlist->p_interaction->object_lock );
+ vlc_object_release( p_interaction );
}
+static vlc_mutex_t intf_lock = VLC_STATIC_MUTEX;
-
-#define INTERACT_INIT( new ) \
- new = (interaction_dialog_t*)malloc( \
- sizeof( interaction_dialog_t ) ); \
- new->i_widgets = 0; \
- new->pp_widgets = NULL; \
- new->psz_title = NULL; \
- new->psz_description = NULL; \
- new->i_id = 0; \
- new->i_status = NEW_DIALOG;
-
-#define INTERACT_FREE( new ) \
- if( new->psz_title ) free( new->psz_title ); \
- if( new->psz_description ) free( new->psz_description );
-
-/** Helper function to send a fatal message
- * \param p_this Parent vlc_object
- * \param i_id A predefined ID, 0 if not applicable
- * \param psz_title Title for the dialog
- * \param psz_format The message to display
- * */
-void __intf_UserFatal( vlc_object_t *p_this, int i_id,
- const char *psz_title,
- const char *psz_format, ... )
+int interaction_Register( intf_thread_t *intf )
{
- va_list args;
- interaction_dialog_t *p_new = NULL;
- user_widget_t *p_widget = NULL;
-
- if( i_id > 0 )
- {
- p_new = intf_InteractionGetById( p_this, i_id );
+ 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;
}
- if( !p_new )
- {
- INTERACT_INIT( p_new );
- if( i_id > 0 ) p_new->i_id = i_id ;
- }
- else
- {
- p_new->i_status = UPDATED_DIALOG;
- }
-
- p_new->i_type = INTERACT_FATAL;
- p_new->psz_title = strdup( psz_title );
-
- p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
-
- p_widget->i_type = WIDGET_TEXT;
-
- va_start( args, psz_format );
- vasprintf( &p_widget->psz_text, psz_format, args );
- va_end( args );
-
- INSERT_ELEM ( p_new->pp_widgets,
- p_new->i_widgets,
- p_new->i_widgets,
- p_widget );
-
- intf_Interact( p_this, p_new );
+ vlc_mutex_unlock( &intf_lock );
+ return ret;
}
-#if 0
-/** Helper function to build a progress bar
- * \param p_this Parent vlc object
- */
-interaction_dialog_t *__intf_ProgressBuild( vlc_object_t *p_this,
- const char *psz_text )
+int interaction_Unregister( intf_thread_t *intf )
{
- interaction_dialog_t *p_new = (interaction_dialog_t *)malloc(
- sizeof( interaction_dialog_t ) );
-
+ libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc );
+ int ret = VLC_EGENERIC;
- return p_new;
+ vlc_mutex_lock( &intf_lock );
+ if( priv->p_interaction_intf == intf )
+ {
+ priv->p_interaction_intf = NULL;
+ ret = VLC_SUCCESS;
+ }
+ vlc_mutex_unlock( &intf_lock );
+ return ret;
}
-#endif
-
-
/**********************************************************************
* The following functions are local
**********************************************************************/
-/* Get the interaction object. Create it if needed */
-static interaction_t * intf_InteractionGet( vlc_object_t *p_this )
+/* Get the interaction object */
+static interaction_t * InteractionGet( vlc_object_t *p_this )
{
- playlist_t *p_playlist;
- interaction_t *p_interaction;
+ interaction_t *obj = libvlc_priv(p_this->p_libvlc)->p_interaction;
+ if( obj )
+ vlc_object_hold( obj );
+ return obj;
+}
- p_playlist = (playlist_t*) vlc_object_find( p_this, VLC_OBJECT_PLAYLIST,
- FIND_ANYWHERE );
- if( !p_playlist )
- {
- return NULL;
- }
-
- if( p_playlist->p_interaction == NULL )
- {
- intf_InteractionInit( p_playlist );
- }
+/* Look for an interface suitable for interaction, and hold it. */
+static intf_thread_t *SearchInterface( interaction_t *p_interaction )
+{
+ libvlc_priv_t *priv = libvlc_priv( p_interaction->p_libvlc );
+ intf_thread_t *intf;
- p_interaction = p_playlist->p_interaction;
+ vlc_mutex_lock( &intf_lock );
+ intf = priv->p_interaction_intf;
+ if( intf != NULL )
+ vlc_object_hold( intf );
+ vlc_mutex_unlock( &intf_lock );
- vlc_object_release( p_playlist );
+ return intf;
+}
- return p_interaction;
+/* Destroy a dialog */
+static void DialogDestroy( interaction_dialog_t *p_dialog )
+{
+ free( p_dialog->psz_title );
+ free( p_dialog->psz_description );
+ free( p_dialog->psz_alternate_button );
+ vlc_object_release( p_dialog->p_parent );
+ free( p_dialog );
}
-/* Create the interaction object in the given playlist object */
-static void intf_InteractionInit( playlist_t *p_playlist )
+/* Ask for the dialog to be sent to the user. Wait for answer
+ * if required */
+static int DialogSend( interaction_dialog_t *p_dialog )
{
interaction_t *p_interaction;
+ intf_thread_t *p_intf;
- msg_Dbg( p_playlist, "initializing interaction system" );
+ if( ( p_dialog->p_parent->i_flags & OBJECT_FLAGS_NOINTERACT )
+ || !config_GetInt( p_dialog->p_parent, "interact" ) )
+ return VLC_EGENERIC;
- p_interaction = vlc_object_create( VLC_OBJECT( p_playlist ),
- sizeof( interaction_t ) );
+ p_interaction = InteractionGet( p_dialog->p_parent );
if( !p_interaction )
- {
- msg_Err( p_playlist,"out of memory" );
- return;
- }
-
- p_interaction->i_dialogs = 0;
- p_interaction->pp_dialogs = NULL;
- p_interaction->p_intf = NULL;
- p_interaction->i_last_id = DIALOG_LAST_PREDEFINED + 1;
+ return VLC_EGENERIC;
- vlc_mutex_init( p_interaction , &p_interaction->object_lock );
+ p_dialog->p_lock = &p_interaction->lock;
- p_playlist->p_interaction = p_interaction;
-}
+ p_intf = SearchInterface( p_interaction );
+ if( p_intf == NULL )
+ {
+ p_dialog->i_return = DIALOG_DEFAULT; /* Give default answer */
-/* Look for an interface suitable for interaction */
-static void intf_InteractionSearchInterface( interaction_t *p_interaction )
-{
- vlc_list_t *p_list;
- int i_index;
+ /* Pretend we have hidden and destroyed it */
+ p_dialog->i_status = HIDING_DIALOG;
+ vlc_object_release( p_interaction );
+ return VLC_SUCCESS;
+ }
+ p_dialog->p_interface = p_intf;
- p_interaction->p_intf = NULL;
+ p_dialog->i_action = INTERACT_NEW;
+ var_SetAddress( p_dialog->p_interface, "interaction", p_dialog );
- p_list = vlc_list_find( p_interaction, VLC_OBJECT_INTF, FIND_ANYWHERE );
- if( !p_list )
- {
- msg_Err( p_interaction, "Unable to create module list" );
- return;
- }
+ /* Check if we have already added this dialog */
+ vlc_mutex_lock( &p_interaction->lock );
+ /* Add it to the queue, the main loop will send the orders to the
+ * interface */
+ INSERT_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs,
+ p_interaction->i_dialogs, p_dialog );
- for( i_index = 0; i_index < p_list->i_count; i_index ++ )
+ if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY ) /* Wait for answer */
{
- intf_thread_t *p_intf = (intf_thread_t *)
- p_list->p_values[i_index].p_object;
- if( p_intf->pf_interact != NULL )
+ 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 &&
+ !p_dialog->p_parent->b_die )
{
- p_interaction->p_intf = p_intf;
- break;
+ vlc_mutex_unlock( &p_interaction->lock );
+ msleep( 100000 );
+ vlc_mutex_lock( &p_interaction->lock );
+ }
+ if( p_dialog->p_parent->b_die )
+ {
+ p_dialog->i_return = DIALOG_CANCELLED;
+ p_dialog->i_status = ANSWERED_DIALOG;
}
}
- vlc_list_release ( p_list );
+ p_dialog->i_flags |= DIALOG_GOT_ANSWER;
+ vlc_cond_signal( &p_interaction->wait );
+ vlc_mutex_unlock( &p_interaction->lock );
+ vlc_object_release( p_interaction );
+ if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY )
+ return p_dialog->i_return;
+ else
+ return VLC_SUCCESS;
}
-/* Add a dialog to the queue and wait for answer */
-static int intf_WaitAnswer( interaction_t *p_interact, interaction_dialog_t *p_dialog )
+static void* InteractionLoop( void *p_this )
{
- // TODO: Add to queue, wait for answer
- return VLC_SUCCESS;
-}
+ interaction_t *p_interaction = p_this;
-/* Add a dialog to the queue and return */
-static int intf_Send( interaction_t *p_interact, interaction_dialog_t *p_dialog )
-{
- vlc_mutex_lock( &p_interact->object_lock );
-
- /// \todo Check first it does not exist !!!
- INSERT_ELEM( p_interact->pp_dialogs,
- p_interact->i_dialogs,
- p_interact->i_dialogs,
- p_dialog );
- vlc_mutex_unlock( &p_interact->object_lock );
- return VLC_SUCCESS;
+ vlc_mutex_lock( &p_interaction->lock );
+ mutex_cleanup_push( &p_interaction->lock );
+ for( ;; )
+ {
+ int canc = vlc_savecancel();
+ InteractionManage( p_interaction );
+ vlc_restorecancel( canc );
+
+ vlc_cond_wait( &p_interaction->wait, &p_interaction->lock );
+ }
+ vlc_cleanup_pop( );
+ assert( 0 );
}
-/* Find an interaction dialog by its id */
-static interaction_dialog_t *intf_InteractionGetById( vlc_object_t* p_this,
- int i_id )
+/**
+ * The main interaction processing loop
+ *
+ * \param p_interaction the interaction object
+ * \return nothing
+ */
+
+static void InteractionManage( interaction_t *p_interaction )
{
- interaction_t *p_interaction = intf_InteractionGet( p_this );
- int i;
+ vlc_value_t val;
+ int i_index;
- for( i = 0 ; i< p_interaction->i_dialogs; i++ )
+ for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
{
- if( p_interaction->pp_dialogs[i]->i_id == i_id )
+ interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
+ switch( p_dialog->i_status )
{
- return p_interaction->pp_dialogs[i];
+ case ANSWERED_DIALOG:
+ /* Ask interface to hide it */
+ p_dialog->i_action = INTERACT_HIDE;
+ val.p_address = p_dialog;
+ var_Set( p_dialog->p_interface, "interaction", val );
+ p_dialog->i_status = HIDING_DIALOG;
+ break;
+ case UPDATED_DIALOG:
+ p_dialog->i_action = INTERACT_UPDATE;
+ val.p_address = p_dialog;
+ var_Set( p_dialog->p_interface, "interaction", val );
+ p_dialog->i_status = SENT_DIALOG;
+ break;
+ case HIDDEN_DIALOG:
+ if( !(p_dialog->i_flags & DIALOG_GOT_ANSWER) ) break;
+ p_dialog->i_action = INTERACT_DESTROY;
+ val.p_address = p_dialog;
+ var_Set( p_dialog->p_interface, "interaction", val );
+ break;
+ case DESTROYED_DIALOG:
+ /* Interface has now destroyed it, remove it */
+ REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs,
+ i_index);
+ i_index--;
+ DialogDestroy( p_dialog );
+ break;
}
}
- return NULL;
}
projects / vlc / blobdiff