X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Finterface%2Finteraction.c;h=91032368f85b6e532991d154cbfa867211e73118;hb=3230451120445d9f610e1749075a413c3e2dddc2;hp=293dc330e11aa65b6e39467d7e6d1c1d1b5ce759;hpb=99839e32157651fc9dcc1d6b0f6c2af60436b38d;p=vlc diff --git a/src/interface/interaction.c b/src/interface/interaction.c index 293dc330e1..91032368f8 100644 --- a/src/interface/interaction.c +++ b/src/interface/interaction.c @@ -46,23 +46,40 @@ /***************************************************************************** * 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 +}; + 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 interaction_dialog_t *DialogGetById( interaction_t* , int ); static void DialogDestroy( interaction_dialog_t * ); -static int DialogSend( vlc_object_t *, interaction_dialog_t * ); +static int DialogSend( interaction_dialog_t * ); -#define DIALOG_INIT( type ) \ - DECMALLOC_ERR( p_new, interaction_dialog_t ); \ - memset( p_new, 0, sizeof( 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 = NEW_DIALOG; \ - p_new->i_flags = 0; \ - p_new->i_type = INTERACT_DIALOG_##type; \ - p_new->psz_returned[0] = NULL; \ + 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 #define FORMAT_DESC \ @@ -85,7 +102,7 @@ int __intf_UserFatal( vlc_object_t *p_this, bool b_blocking, const char *psz_format, ... ) { va_list args; - DIALOG_INIT( ONEWAY ); + DIALOG_INIT( ONEWAY, VLC_EGENERIC ); p_new->psz_title = strdup( psz_title ); FORMAT_DESC; @@ -95,7 +112,7 @@ int __intf_UserFatal( vlc_object_t *p_this, bool b_blocking, else p_new->i_flags = DIALOG_NONBLOCKING_ERROR; - return DialogSend( p_this, p_new ); + return DialogSend( p_new ); } /** @@ -111,14 +128,14 @@ 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; p_new->i_flags = DIALOG_WARNING; - return DialogSend( p_this, p_new ); + return DialogSend( p_new ); } /** @@ -139,17 +156,16 @@ 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 ); 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 ); + p_new->psz_other_button = psz_other ? strdup( psz_other ) : NULL; - return DialogSend( p_this, p_new ); + return DialogSend( p_new ); } /** @@ -160,12 +176,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; @@ -179,38 +196,26 @@ int __intf_Progress( vlc_object_t *p_this, const char *psz_title, else p_new->i_flags = DIALOG_INTF_PROGRESS; - DialogSend( p_this, p_new ); - return p_new->i_id; + DialogSend( p_new ); + 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 ); @@ -219,7 +224,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 ); } @@ -228,27 +233,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 */ -bool __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; + interaction_t *p_interaction = InteractionGet( p_dialog->p_parent ); bool b_cancel; - if( !p_interaction ) return true; - + 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 true; - } - b_cancel = p_dialog->b_cancelled; vlc_object_unlock( p_interaction ); vlc_object_release( p_interaction ); @@ -272,7 +266,7 @@ 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 ); @@ -281,7 +275,7 @@ int __intf_UserLoginPassword( vlc_object_t *p_this, p_new->i_flags = DIALOG_LOGIN_PW_OK_CANCEL; - i_ret = DialogSend( p_this, p_new ); + i_ret = DialogSend( p_new ); if( i_ret != DIALOG_CANCELLED && i_ret != VLC_EGENERIC ) { @@ -308,14 +302,14 @@ 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 ); p_new->i_flags = DIALOG_PSZ_INPUT_OK_CANCEL; - i_ret = DialogSend( p_this, p_new ); + i_ret = DialogSend( p_new ); if( i_ret != DIALOG_CANCELLED ) { @@ -328,26 +322,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; - vlc_object_signal_unlocked( p_interaction ); - } - + p_dialog->i_status = ANSWERED_DIALOG; + vlc_cond_signal( &p_interaction->wait ); vlc_object_unlock( p_interaction ); vlc_object_release( p_interaction ); } @@ -375,11 +360,11 @@ interaction_t * interaction_Init( libvlc_int_t *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, - false ) ) + vlc_cond_init( &p_interaction->wait ); + + if( vlc_clone( &p_interaction->thread, InteractionLoop, p_interaction, + VLC_THREAD_PRIORITY_LOW ) ) { msg_Err( p_interaction, "Interaction control thread creation failed, " "interaction will not be displayed" ); @@ -396,64 +381,80 @@ void interaction_Destroy( interaction_t *p_interaction ) if( !p_interaction ) return; - vlc_object_kill( p_interaction ); - vlc_thread_join( p_interaction ); + vlc_cancel( p_interaction->thread ); + vlc_join( p_interaction->thread, NULL ); + vlc_cond_destroy( &p_interaction->wait ); + + /* 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; + +int interaction_Register( intf_thread_t *intf ) +{ + 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; +} + +int interaction_Unregister( intf_thread_t *intf ) +{ + libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc ); + int ret = VLC_EGENERIC; + + 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; +} + /********************************************************************** * The following functions are local **********************************************************************/ -/* Get the interaction object. Create it if needed */ +/* 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_yield( obj ); + vlc_object_hold( obj ); return obj; } -/* Look for an interface suitable for interaction */ -static void InteractionSearchInterface( interaction_t *p_interaction ) +/* Look for an interface suitable for interaction, and hold it. */ +static intf_thread_t *SearchInterface( interaction_t *p_interaction ) { - vlc_list_t *p_list; - int i_index; + libvlc_priv_t *priv = libvlc_priv( p_interaction->p_libvlc ); + intf_thread_t *intf; - p_interaction->p_intf = NULL; + vlc_mutex_lock( &intf_lock ); + intf = priv->p_interaction_intf; + if( intf != NULL ) + vlc_object_hold( intf ); + vlc_mutex_unlock( &intf_lock ); - 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; + return intf; } /* Destroy a dialog */ @@ -464,61 +465,57 @@ 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 ); } /* 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 ) +static int DialogSend( interaction_dialog_t *p_dialog ) { - interaction_t *p_interaction = InteractionGet( p_this ); + interaction_t *p_interaction; + intf_thread_t *p_intf; - if( !p_interaction ) + if( p_dialog->p_parent->i_flags & OBJECT_FLAGS_NOINTERACT ) return VLC_EGENERIC; - /* Get an id, if we don't already have one */ - vlc_object_lock( p_interaction ); - if( p_dialog->i_id == 0 ) - p_dialog->i_id = ++p_interaction->i_last_id; - vlc_object_unlock( p_interaction ); + p_interaction = InteractionGet( p_dialog->p_parent ); + if( !p_interaction ) + return VLC_EGENERIC; - if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT ) + p_intf = SearchInterface( p_interaction ); + if( p_intf == NULL ) { + p_dialog->i_return = DIALOG_DEFAULT; /* Give default answer */ + + /* Pretend we have hidden and destroyed it */ + p_dialog->i_status = HIDING_DIALOG; vlc_object_release( p_interaction ); - return VLC_EGENERIC; + return VLC_SUCCESS; } + p_dialog->p_interface = p_intf; - if( config_GetInt( p_this, "interact" ) || + if( config_GetInt( p_interaction, "interact" ) || p_dialog->i_flags & DIALOG_BLOCKING_ERROR || p_dialog->i_flags & DIALOG_NONBLOCKING_ERROR ) { - bool b_found = false; - int i; + vlc_value_t val; + p_dialog->p_interaction = p_interaction; - p_dialog->p_parent = p_this; + p_dialog->i_action = INTERACT_NEW; + val.p_address = p_dialog; + var_Set( p_dialog->p_interface, "interaction", val ); /* 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 = 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; + INSERT_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, + p_interaction->i_dialogs, 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 && @@ -534,7 +531,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; @@ -543,7 +540,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; @@ -556,27 +553,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; - vlc_object_lock( p_this ); - while( vlc_object_alive( p_this ) ) + vlc_object_lock( p_interaction ); + mutex_cleanup_push( &(vlc_internals(p_interaction)->lock) ); + for( ;; ) { + int canc = vlc_savecancel(); InteractionManage( p_interaction ); - vlc_object_wait( p_this ); - } - 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) ); } - return NULL; + vlc_cleanup_pop( ); + assert( 0 ); } /** @@ -591,28 +583,6 @@ static void InteractionManage( interaction_t *p_interaction ) 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]; @@ -622,23 +592,20 @@ static void InteractionManage( interaction_t *p_interaction ) /* 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 */ @@ -647,18 +614,6 @@ static void InteractionManage( interaction_t *p_interaction ) 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 ); }