# 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
*****************************************************************************/
-static interaction_t * InteractionInit( libvlc_int_t * );
-static interaction_t * InteractionGet( vlc_object_t * );
-static void InteractionSearchInterface( interaction_t * );
-static void InteractionLoop( vlc_object_t * );
-static void InteractionManage( interaction_t * );
-
-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; \
- p_new->psz_returned[1] = NULL
-
-#define FORMAT_DESC \
- va_start( args, psz_format ); \
- if( vasprintf( &p_new->psz_description, psz_format, args ) == -1 ) \
- return VLC_EGENERIC; \
- va_end( args )
-
-/**
- * Send an error message, both in a blocking and non-blocking way
- *
- * \param p_this Parent vlc_object
- * \param b_blocking Is this dialog blocking or not?
- * \param psz_title Title for the dialog
- * \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,
- const char *psz_title,
- const char *psz_format, ... )
-{
- va_list args;
- DIALOG_INIT( ONEWAY );
-
- p_new->psz_title = strdup( psz_title );
- FORMAT_DESC;
-
- if( b_blocking )
- p_new->i_flags = DIALOG_BLOCKING_ERROR;
- else
- p_new->i_flags = DIALOG_NONBLOCKING_ERROR;
-
- return DialogSend( p_this, p_new );
-}
/**
- * Helper function to send a warning, which is always shown non-blocking
- *
- * \param p_this Parent vlc_object
- * \param psz_title Title for the dialog
- * \param psz_format The message to display
- * \return VLC_SUCCESS or VLC_EGENERIC
+ * This structure contains the active interaction dialogs, and is
+ * used by the manager
*/
-int __intf_UserWarn( vlc_object_t *p_this,
- const char *psz_title,
- const char *psz_format, ... )
+struct interaction_t
{
- va_list args;
- DIALOG_INIT( ONEWAY );
-
- p_new->psz_title = strdup( psz_title );
- FORMAT_DESC;
+ VLC_COMMON_MEMBERS
- p_new->i_flags = DIALOG_WARNING;
+ vlc_thread_t thread;
+ vlc_mutex_t lock;
+ vlc_cond_t wait;
- return DialogSend( p_this, p_new );
-}
+ int i_dialogs; ///< Number of dialogs
+ interaction_dialog_t **pp_dialogs; ///< Dialogs
+ intf_thread_t *p_intf; ///< Interface to use
+};
-/**
- * Helper function to ask a yes-no-cancel question
- *
- * \param p_this Parent vlc_object
- * \param psz_title Title for the dialog
- * \param psz_description A description
- * \param psz_default caption for the default button
- * \param psz_alternate caption for the alternate button
- * \param psz_other caption for the optional 3rd button (== cancel)
- * \return Clicked button code
- */
-int __intf_UserYesNo( vlc_object_t *p_this,
- const char *psz_title,
- const char *psz_description,
- const char *psz_default,
- const char *psz_alternate,
- const char *psz_other )
-{
- DIALOG_INIT( TWOWAY );
+static void* InteractionLoop( void * );
+static void InteractionManage( interaction_t * );
- p_new->psz_title = strdup( psz_title );
- p_new->psz_description = strdup( psz_description );
- p_new->i_flags = DIALOG_YES_NO_CANCEL;
- p_new->psz_default_button = strdup( psz_default );
- p_new->psz_alternate_button = strdup( psz_alternate );
- if( psz_other )
- p_new->psz_other_button = strdup( psz_other );
+static void DialogDestroy( interaction_dialog_t * );
- return DialogSend( p_this, p_new );
-}
+#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
/**
- * Helper function to create a dialogue showing a progress-bar with some info
+ * Create the initial interaction object
+ * (should only be used in libvlc_InternalInit, LibVLC private)
*
- * \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 id, to give to UserProgressUpdate
+ * \return a vlc_object_t that should be freed when done.
*/
-int __intf_Progress( vlc_object_t *p_this, const char *psz_title,
- const char *psz_status, float f_pos, int i_time )
+interaction_t * interaction_Init( libvlc_int_t *p_libvlc )
{
- DIALOG_INIT( ONEWAY );
- 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" ) );
+ interaction_t *p_interaction;
- if( psz_title )
- {
- p_new->psz_title = strdup( psz_title );
- p_new->i_flags = DIALOG_USER_PROGRESS;
- }
- else
- p_new->i_flags = DIALOG_INTF_PROGRESS;
-
- DialogSend( p_this, p_new );
- return p_new->i_id;
-}
+ /* Make sure we haven't yet created an interaction object */
+ assert( libvlc_priv(p_libvlc)->p_interaction == NULL );
-/**
- * Update a progress bar in a dialogue
- *
- * \param p_this Parent vlc_object
- * \param i_id Identifier of the 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,
- const char *psz_status, float f_pos, int i_time )
-{
- interaction_t *p_interaction = InteractionGet( p_this );
- interaction_dialog_t *p_dialog;
+ p_interaction = vlc_custom_create( VLC_OBJECT(p_libvlc),
+ sizeof( *p_interaction ),
+ VLC_OBJECT_GENERIC, "interaction" );
+ if( !p_interaction )
+ return NULL;
- if( !p_interaction ) return;
+ vlc_object_attach( p_interaction, p_libvlc );
+ p_interaction->i_dialogs = 0;
+ p_interaction->pp_dialogs = NULL;
+ p_interaction->p_intf = NULL;
- vlc_object_lock( p_interaction );
- p_dialog = DialogGetById( p_interaction, i_id );
+ vlc_mutex_init( &p_interaction->lock );
+ vlc_cond_init( &p_interaction->wait );
- if( !p_dialog )
+ if( vlc_clone( &p_interaction->thread, InteractionLoop, p_interaction,
+ VLC_THREAD_PRIORITY_LOW ) )
{
- vlc_object_unlock( p_interaction );
+ 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;
+ return NULL;
}
- 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_object_signal_unlocked( p_interaction );
- vlc_object_unlock( p_interaction );
- vlc_object_release( p_interaction );
+ return p_interaction;
}
-/**
- * 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
- * \return Either true or false
- */
-vlc_bool_t __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id )
+void interaction_Destroy( interaction_t *p_interaction )
{
- interaction_t *p_interaction = InteractionGet( p_this );
- interaction_dialog_t *p_dialog;
- vlc_bool_t b_cancel;
+ if( !p_interaction )
+ return;
- if( !p_interaction ) return VLC_TRUE;
+ vlc_cancel( p_interaction->thread );
+ vlc_join( p_interaction->thread, NULL );
+ vlc_cond_destroy( &p_interaction->wait );
+ vlc_mutex_destroy( &p_interaction->lock );
- vlc_object_lock( p_interaction );
- p_dialog = DialogGetById( p_interaction, i_id );
- if( !p_dialog )
+ /* Remove all dialogs - Interfaces must be able to clean up their data */
+ for( int i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
{
- vlc_object_unlock( p_interaction ) ;
- vlc_object_release( p_interaction );
- return VLC_TRUE;
+ interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
+ DialogDestroy( p_dialog );
+ REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
}
-
- b_cancel = p_dialog->b_cancelled;
- vlc_object_unlock( p_interaction );
vlc_object_release( p_interaction );
- return b_cancel;
}
-/**
- * Helper function to make a login/password dialogue
- *
- * \param p_this Parent vlc_object
- * \param psz_title Title for the dialog
- * \param psz_description A description
- * \param ppsz_login Returned login
- * \param ppsz_password Returned password
- * \return Clicked button code
- */
-int __intf_UserLoginPassword( vlc_object_t *p_this,
- const char *psz_title,
- const char *psz_description,
- char **ppsz_login,
- char **ppsz_password )
-{
- int i_ret;
- DIALOG_INIT( TWOWAY );
- 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_alternate_button = strdup( _("Cancel" ) );
-
- p_new->i_flags = DIALOG_LOGIN_PW_OK_CANCEL;
+static vlc_mutex_t intf_lock = VLC_STATIC_MUTEX;
- i_ret = DialogSend( p_this, p_new );
+int interaction_Register( intf_thread_t *intf )
+{
+ libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc );
+ int ret = VLC_EGENERIC;
- if( i_ret != DIALOG_CANCELLED && i_ret != VLC_EGENERIC )
- {
- *ppsz_login = p_new->psz_returned[0]?
- strdup( p_new->psz_returned[0] ) : NULL;
- *ppsz_password = p_new->psz_returned[1]?
- strdup( p_new->psz_returned[1] ) : NULL;
+ 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;
}
- return i_ret;
+ vlc_mutex_unlock( &intf_lock );
+ return ret;
}
-/**
- * Helper function to make a dialogue asking the user for !password string
- *
- * \param p_this Parent vlc_object
- * \param psz_title Title for the dialog
- * \param psz_description A description
- * \param ppsz_usersString Returned login
- * \return Clicked button code
- */
-int __intf_UserStringInput( vlc_object_t *p_this,
- const char *psz_title,
- const char *psz_description,
- char **ppsz_usersString )
+int interaction_Unregister( intf_thread_t *intf )
{
- int i_ret;
- DIALOG_INIT( TWOWAY );
- p_new->i_type = INTERACT_DIALOG_TWOWAY;
- p_new->psz_title = strdup( psz_title );
- p_new->psz_description = strdup( psz_description );
+ libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc );
+ int ret = VLC_EGENERIC;
- p_new->i_flags = DIALOG_PSZ_INPUT_OK_CANCEL;
-
- i_ret = DialogSend( p_this, p_new );
-
- if( i_ret != DIALOG_CANCELLED )
+ vlc_mutex_lock( &intf_lock );
+ if( priv->p_interaction_intf == intf )
{
- *ppsz_usersString = p_new->psz_returned[0]?
- strdup( p_new->psz_returned[0] ) : NULL;
+ priv->p_interaction_intf = NULL;
+ ret = VLC_SUCCESS;
}
- return i_ret;
-}
-
-/**
- * Hide an interaction dialog
- *
- * \param p_this the parent vlc object
- * \param i_id the id of the item to hide
- * \return nothing
- */
-void __intf_UserHide( vlc_object_t *p_this, int i_id )
-{
- interaction_t *p_interaction = InteractionGet( p_this );
- interaction_dialog_t *p_dialog;
-
- if( !p_interaction ) return;
-
- vlc_object_lock( p_interaction );
- p_dialog = DialogGetById( p_interaction, i_id );
-
- if( p_dialog )
- p_dialog->i_status = ANSWERED_DIALOG;
-
- vlc_object_unlock( p_interaction );
- vlc_object_release( p_interaction );
+ vlc_mutex_unlock( &intf_lock );
+ return ret;
}
/**********************************************************************
* The following functions are local
**********************************************************************/
-/* Get the interaction object. Create it if needed */
-static interaction_t * InteractionGet( vlc_object_t *p_this )
-{
- interaction_t *p_interaction =
- vlc_object_find( p_this, VLC_OBJECT_INTERACTION, FIND_ANYWHERE );
-
- if( !p_interaction )
- p_interaction = InteractionInit( p_this->p_libvlc );
-
- return p_interaction;
-}
-
-/* Create the interaction object in the given playlist object */
-static interaction_t * InteractionInit( libvlc_int_t *p_libvlc )
-{
- interaction_t *p_interaction =
- vlc_object_create( p_libvlc, VLC_OBJECT_INTERACTION );
-
- if( p_interaction )
- {
- 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;
- }
- else
- vlc_object_yield( p_interaction );
- }
-
- return p_interaction;
-}
-
-/* Look for an interface suitable for interaction */
-static void InteractionSearchInterface( interaction_t *p_interaction )
-{
- vlc_list_t *p_list;
- int i_index;
-
- p_interaction->p_intf = NULL;
-
- 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;
- }
-
- 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 );
-}
-
-/* Find an interaction dialog by its id */
-static interaction_dialog_t *DialogGetById( interaction_t *p_interaction,
- int i_id )
-{
- 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;
-}
-
/* 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_default_button );
free( p_dialog->psz_alternate_button );
- free( p_dialog->psz_other_button );
+ vlc_object_release( p_dialog->p_parent );
free( p_dialog );
}
-/* Ask for the dialog to be sent to the user. Wait for answer
- * if required */
-static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
-{
- interaction_t *p_interaction = 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;
-
- if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT ) 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;
- int i;
- p_dialog->p_interaction = p_interaction;
- p_dialog->p_parent = p_this;
-
- /* Check if we have already added this 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;
- }
- /* Add it to the queue, the main loop will send the orders to the
- * interface */
- if( ! b_found )
- {
- INSERT_ELEM( p_interaction->pp_dialogs,
- p_interaction->i_dialogs,
- p_interaction->i_dialogs,
- p_dialog );
- }
- else
- p_dialog->i_status = UPDATED_DIALOG;
-
- if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY ) /* Wait for answer */
- {
- vlc_object_signal_unlocked( p_interaction );
- 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 )
- {
- vlc_object_unlock( p_interaction );
- msleep( 100000 );
- vlc_object_lock( p_interaction );
- }
- if( p_dialog->p_parent->b_die )
- {
- p_dialog->i_return = DIALOG_CANCELLED;
- p_dialog->i_status = ANSWERED_DIALOG;
- }
- p_dialog->i_flags |= DIALOG_GOT_ANSWER;
- vlc_object_signal_unlocked( p_interaction );
- vlc_object_unlock( p_interaction );
- vlc_object_release( p_interaction );
- return p_dialog->i_return;
- }
- else
- {
- /* Pretend we already retrieved the "answer" */
- p_dialog->i_flags |= DIALOG_GOT_ANSWER;
- vlc_object_signal_unlocked( p_interaction );
- vlc_object_unlock( p_interaction );
- vlc_object_release( p_interaction );
- return VLC_SUCCESS;
- }
- }
- else
- {
- vlc_object_release( p_interaction );
- return VLC_EGENERIC;
- }
-}
-
-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_mutex_lock( &p_interaction->lock );
+ mutex_cleanup_push( &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, &p_interaction->lock );
}
-
- vlc_object_detach( p_this );
- vlc_object_release( p_this );
+ vlc_cleanup_pop( );
+ assert( 0 );
}
/**
vlc_value_t val;
int i_index;
- /* Nothing to do */
- if( p_interaction->i_dialogs == 0 ) return;
-
- InteractionSearchInterface( p_interaction );
- if( !p_interaction->p_intf )
- {
- /* We mark all dialogs as answered with their "default" answer */
- for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
- {
- interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
- p_dialog->i_return = DIALOG_DEFAULT; /* Give default answer */
-
- /* Pretend we have hidden and destroyed it */
- if( p_dialog->i_status == HIDDEN_DIALOG )
- p_dialog->i_status = DESTROYED_DIALOG;
- else
- 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 ++ )
{
interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
/* Ask interface to hide it */
p_dialog->i_action = INTERACT_HIDE;
val.p_address = p_dialog;
- if( p_interaction->p_intf )
- var_Set( p_interaction->p_intf, "interaction", val );
+ 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;
- if( p_interaction->p_intf )
- var_Set( p_interaction->p_intf, "interaction", val );
+ 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;
- if( p_interaction->p_intf )
- var_Set( p_interaction->p_intf, "interaction", val );
+ var_Set( p_dialog->p_interface, "interaction", val );
break;
case DESTROYED_DIALOG:
/* Interface has now destroyed it, remove it */
i_index--;
DialogDestroy( p_dialog );
break;
- case NEW_DIALOG:
- /* This is truly a new dialog, send it. */
-
- p_dialog->i_action = INTERACT_NEW;
- val.p_address = p_dialog;
- if( p_interaction->p_intf )
- var_Set( p_interaction->p_intf, "interaction", val );
- p_dialog->i_status = SENT_DIALOG;
- break;
}
}
-
- if( p_interaction->p_intf )
- vlc_object_release( p_interaction->p_intf );
}
projects / vlc / blobdiff