1 /*****************************************************************************
2 * interaction.c: User interaction functions
3 *****************************************************************************
4 * Copyright © 2005-2008 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Felix Kühne <fkuehne@videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
27 * This file contains functions related to user interaction management
30 /*****************************************************************************
32 *****************************************************************************/
38 #include <vlc_common.h>
40 #include <vlc_interface.h>
41 #include "interface.h"
46 /*****************************************************************************
48 *****************************************************************************/
51 * This structure contains the active interaction dialogs, and is
61 int i_dialogs; ///< Number of dialogs
62 interaction_dialog_t **pp_dialogs; ///< Dialogs
63 intf_thread_t *p_intf; ///< Interface to use
64 int i_last_id; ///< Last attributed ID
67 static interaction_t * InteractionGet( vlc_object_t * );
68 static intf_thread_t * SearchInterface( interaction_t * );
69 static void* InteractionLoop( void * );
70 static void InteractionManage( interaction_t * );
72 static void DialogDestroy( interaction_dialog_t * );
73 static int DialogSend( vlc_object_t *, interaction_dialog_t * );
75 #define DIALOG_INIT( type, err ) \
76 interaction_dialog_t* p_new = calloc( 1, sizeof( interaction_dialog_t ) ); \
77 if( !p_new ) return err; \
78 p_new->b_cancelled = false; \
79 p_new->i_status = NEW_DIALOG; \
81 p_new->i_type = INTERACT_DIALOG_##type; \
82 p_new->psz_returned[0] = NULL; \
83 p_new->psz_returned[1] = NULL
86 va_start( args, psz_format ); \
87 if( vasprintf( &p_new->psz_description, psz_format, args ) == -1 ) \
88 return VLC_EGENERIC; \
92 * Send an error message, both in a blocking and non-blocking way
94 * \param p_this Parent vlc_object
95 * \param b_blocking Is this dialog blocking or not?
96 * \param psz_title Title for the dialog
97 * \param psz_format The message to display
98 * \return VLC_SUCCESS or VLC_EGENERIC
100 int __intf_UserFatal( vlc_object_t *p_this, bool b_blocking,
101 const char *psz_title,
102 const char *psz_format, ... )
105 DIALOG_INIT( ONEWAY, VLC_EGENERIC );
107 p_new->psz_title = strdup( psz_title );
111 p_new->i_flags = DIALOG_BLOCKING_ERROR;
113 p_new->i_flags = DIALOG_NONBLOCKING_ERROR;
115 return DialogSend( p_this, p_new );
119 * Helper function to send a warning, which is always shown non-blocking
121 * \param p_this Parent vlc_object
122 * \param psz_title Title for the dialog
123 * \param psz_format The message to display
124 * \return VLC_SUCCESS or VLC_EGENERIC
126 int __intf_UserWarn( vlc_object_t *p_this,
127 const char *psz_title,
128 const char *psz_format, ... )
131 DIALOG_INIT( ONEWAY, VLC_EGENERIC );
133 p_new->psz_title = strdup( psz_title );
136 p_new->i_flags = DIALOG_WARNING;
138 return DialogSend( p_this, p_new );
142 * Helper function to ask a yes-no-cancel question
144 * \param p_this Parent vlc_object
145 * \param psz_title Title for the dialog
146 * \param psz_description A description
147 * \param psz_default caption for the default button
148 * \param psz_alternate caption for the alternate button
149 * \param psz_other caption for the optional 3rd button (== cancel)
150 * \return Clicked button code
152 int __intf_UserYesNo( vlc_object_t *p_this,
153 const char *psz_title,
154 const char *psz_description,
155 const char *psz_default,
156 const char *psz_alternate,
157 const char *psz_other )
159 DIALOG_INIT( TWOWAY, VLC_EGENERIC );
161 p_new->psz_title = strdup( psz_title );
162 p_new->psz_description = strdup( psz_description );
163 p_new->i_flags = DIALOG_YES_NO_CANCEL;
164 p_new->psz_default_button = strdup( psz_default );
165 p_new->psz_alternate_button = strdup( psz_alternate );
167 p_new->psz_other_button = strdup( psz_other );
169 return DialogSend( p_this, p_new );
173 * Helper function to create a dialogue showing a progress-bar with some info
175 * \param p_this Parent vlc_object
176 * \param psz_title Title for the dialog (NULL implies main intf )
177 * \param psz_status Current status
178 * \param f_position Current position (0.0->100.0)
179 * \param i_timeToGo Time (in sec) to go until process is finished
180 * \return Dialog, for use with UserProgressUpdate
182 interaction_dialog_t *
183 __intf_Progress( vlc_object_t *p_this, const char *psz_title,
184 const char *psz_status, float f_pos, int i_time )
186 DIALOG_INIT( ONEWAY, NULL );
187 p_new->psz_description = strdup( psz_status );
188 p_new->val.f_float = f_pos;
189 p_new->i_timeToGo = i_time;
190 p_new->psz_alternate_button = strdup( _( "Cancel" ) );
194 p_new->psz_title = strdup( psz_title );
195 p_new->i_flags = DIALOG_USER_PROGRESS;
198 p_new->i_flags = DIALOG_INTF_PROGRESS;
200 DialogSend( p_this, p_new );
205 * Update a progress bar in a dialogue
207 * \param p_dialog Dialog
208 * \param psz_status New status
209 * \param f_position New position (0.0->100.0)
210 * \param i_timeToGo Time (in sec) to go until process is finished
213 void intf_ProgressUpdate( interaction_dialog_t *p_dialog,
214 const char *psz_status, float f_pos, int i_time )
216 interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
217 assert( p_interaction );
219 vlc_object_lock( p_interaction );
220 free( p_dialog->psz_description );
221 p_dialog->psz_description = strdup( psz_status );
223 p_dialog->val.f_float = f_pos;
224 p_dialog->i_timeToGo = i_time;
226 p_dialog->i_status = UPDATED_DIALOG;
228 vlc_cond_signal( &p_interaction->wait );
229 vlc_object_unlock( p_interaction );
230 vlc_object_release( p_interaction );
234 * Helper function to communicate dialogue cancellations between the
235 * interface module and the caller
237 * \param p_dialog Dialog
238 * \return Either true or false
240 bool intf_ProgressIsCancelled( interaction_dialog_t *p_dialog )
242 interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
245 assert( p_interaction );
246 vlc_object_lock( p_interaction );
247 b_cancel = p_dialog->b_cancelled;
248 vlc_object_unlock( p_interaction );
249 vlc_object_release( p_interaction );
254 * Helper function to make a login/password dialogue
256 * \param p_this Parent vlc_object
257 * \param psz_title Title for the dialog
258 * \param psz_description A description
259 * \param ppsz_login Returned login
260 * \param ppsz_password Returned password
261 * \return Clicked button code
263 int __intf_UserLoginPassword( vlc_object_t *p_this,
264 const char *psz_title,
265 const char *psz_description,
267 char **ppsz_password )
270 DIALOG_INIT( TWOWAY, VLC_EGENERIC );
271 p_new->i_type = INTERACT_DIALOG_TWOWAY;
272 p_new->psz_title = strdup( psz_title );
273 p_new->psz_description = strdup( psz_description );
274 p_new->psz_default_button = strdup( _("OK" ) );
275 p_new->psz_alternate_button = strdup( _("Cancel" ) );
277 p_new->i_flags = DIALOG_LOGIN_PW_OK_CANCEL;
279 i_ret = DialogSend( p_this, p_new );
281 if( i_ret != DIALOG_CANCELLED && i_ret != VLC_EGENERIC )
283 *ppsz_login = p_new->psz_returned[0]?
284 strdup( p_new->psz_returned[0] ) : NULL;
285 *ppsz_password = p_new->psz_returned[1]?
286 strdup( p_new->psz_returned[1] ) : NULL;
292 * Helper function to make a dialogue asking the user for !password string
294 * \param p_this Parent vlc_object
295 * \param psz_title Title for the dialog
296 * \param psz_description A description
297 * \param ppsz_usersString Returned login
298 * \return Clicked button code
300 int __intf_UserStringInput( vlc_object_t *p_this,
301 const char *psz_title,
302 const char *psz_description,
303 char **ppsz_usersString )
306 DIALOG_INIT( TWOWAY, VLC_EGENERIC );
307 p_new->i_type = INTERACT_DIALOG_TWOWAY;
308 p_new->psz_title = strdup( psz_title );
309 p_new->psz_description = strdup( psz_description );
311 p_new->i_flags = DIALOG_PSZ_INPUT_OK_CANCEL;
313 i_ret = DialogSend( p_this, p_new );
315 if( i_ret != DIALOG_CANCELLED )
317 *ppsz_usersString = p_new->psz_returned[0]?
318 strdup( p_new->psz_returned[0] ) : NULL;
324 * Hide an interaction dialog
326 * \param p_dialog the dialog to hide
329 void intf_UserHide( interaction_dialog_t *p_dialog )
331 interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
332 assert( p_interaction );
334 vlc_object_lock( p_interaction );
335 p_dialog->i_status = ANSWERED_DIALOG;
336 vlc_cond_signal( &p_interaction->wait );
337 vlc_object_unlock( p_interaction );
338 vlc_object_release( p_interaction );
342 * Create the initial interaction object
343 * (should only be used in libvlc_InternalInit, LibVLC private)
345 * \return a vlc_object_t that should be freed when done.
347 interaction_t * interaction_Init( libvlc_int_t *p_libvlc )
349 interaction_t *p_interaction;
351 /* Make sure we haven't yet created an interaction object */
352 assert( libvlc_priv(p_libvlc)->p_interaction == NULL );
354 p_interaction = vlc_custom_create( VLC_OBJECT(p_libvlc),
355 sizeof( *p_interaction ),
356 VLC_OBJECT_GENERIC, "interaction" );
360 vlc_object_attach( p_interaction, p_libvlc );
361 p_interaction->i_dialogs = 0;
362 p_interaction->pp_dialogs = NULL;
363 p_interaction->p_intf = NULL;
364 p_interaction->i_last_id = 0;
366 vlc_cond_init( &p_interaction->wait );
368 if( vlc_clone( &p_interaction->thread, InteractionLoop, p_interaction,
369 VLC_THREAD_PRIORITY_LOW ) )
371 msg_Err( p_interaction, "Interaction control thread creation failed, "
372 "interaction will not be displayed" );
373 vlc_object_detach( p_interaction );
374 vlc_object_release( p_interaction );
378 return p_interaction;
381 void interaction_Destroy( interaction_t *p_interaction )
386 vlc_cancel( p_interaction->thread );
387 vlc_join( p_interaction->thread, NULL );
388 vlc_cond_destroy( &p_interaction->wait );
390 /* Remove all dialogs - Interfaces must be able to clean up their data */
391 for( int i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
393 interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
394 DialogDestroy( p_dialog );
395 REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
397 vlc_object_release( p_interaction );
400 static vlc_mutex_t intf_lock = VLC_STATIC_MUTEX;
402 int interaction_Register( intf_thread_t *intf )
404 libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc );
405 int ret = VLC_EGENERIC;
407 vlc_mutex_lock( &intf_lock );
408 if( priv->p_interaction_intf == NULL )
409 { /* Since the interface is responsible for unregistering itself before
410 * it terminates, an object reference is not needed. */
411 priv->p_interaction_intf = intf;
414 vlc_mutex_unlock( &intf_lock );
418 int interaction_Unregister( intf_thread_t *intf )
420 libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc );
421 int ret = VLC_EGENERIC;
423 vlc_mutex_lock( &intf_lock );
424 if( priv->p_interaction_intf == intf )
426 priv->p_interaction_intf = NULL;
429 vlc_mutex_unlock( &intf_lock );
433 /**********************************************************************
434 * The following functions are local
435 **********************************************************************/
437 /* Get the interaction object */
438 static interaction_t * InteractionGet( vlc_object_t *p_this )
440 interaction_t *obj = libvlc_priv(p_this->p_libvlc)->p_interaction;
442 vlc_object_hold( obj );
447 /* Look for an interface suitable for interaction, and hold it. */
448 static intf_thread_t *SearchInterface( interaction_t *p_interaction )
450 libvlc_priv_t *priv = libvlc_priv( p_interaction->p_libvlc );
453 vlc_mutex_lock( &intf_lock );
454 intf = priv->p_interaction_intf;
456 vlc_object_hold( intf );
457 vlc_mutex_unlock( &intf_lock );
462 /* Destroy a dialog */
463 static void DialogDestroy( interaction_dialog_t *p_dialog )
465 free( p_dialog->psz_title );
466 free( p_dialog->psz_description );
467 free( p_dialog->psz_default_button );
468 free( p_dialog->psz_alternate_button );
469 free( p_dialog->psz_other_button );
473 /* Ask for the dialog to be sent to the user. Wait for answer
475 static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
477 interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
482 if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
484 vlc_object_release( p_interaction );
488 if( config_GetInt( p_this, "interact" ) ||
489 p_dialog->i_flags & DIALOG_BLOCKING_ERROR ||
490 p_dialog->i_flags & DIALOG_NONBLOCKING_ERROR )
492 bool b_found = false;
494 p_dialog->p_interaction = p_interaction;
495 p_dialog->p_parent = p_this;
497 /* Check if we have already added this dialog */
498 vlc_object_lock( p_interaction );
499 for( i = 0 ; i< p_interaction->i_dialogs; i++ )
501 if( p_interaction->pp_dialogs[i] == p_dialog )
504 /* Add it to the queue, the main loop will send the orders to the
508 INSERT_ELEM( p_interaction->pp_dialogs,
509 p_interaction->i_dialogs,
510 p_interaction->i_dialogs,
514 p_dialog->i_status = UPDATED_DIALOG;
516 if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY ) /* Wait for answer */
518 vlc_cond_signal( &p_interaction->wait );
519 while( p_dialog->i_status != ANSWERED_DIALOG &&
520 p_dialog->i_status != HIDING_DIALOG &&
521 p_dialog->i_status != HIDDEN_DIALOG &&
522 !p_dialog->p_parent->b_die )
524 vlc_object_unlock( p_interaction );
526 vlc_object_lock( p_interaction );
528 if( p_dialog->p_parent->b_die )
530 p_dialog->i_return = DIALOG_CANCELLED;
531 p_dialog->i_status = ANSWERED_DIALOG;
533 p_dialog->i_flags |= DIALOG_GOT_ANSWER;
534 vlc_cond_signal( &p_interaction->wait );
535 vlc_object_unlock( p_interaction );
536 vlc_object_release( p_interaction );
537 return p_dialog->i_return;
541 /* Pretend we already retrieved the "answer" */
542 p_dialog->i_flags |= DIALOG_GOT_ANSWER;
543 vlc_cond_signal( &p_interaction->wait );
544 vlc_object_unlock( p_interaction );
545 vlc_object_release( p_interaction );
551 vlc_object_release( p_interaction );
556 static void* InteractionLoop( void *p_this )
558 interaction_t *p_interaction = p_this;
560 vlc_object_lock( p_interaction );
561 mutex_cleanup_push( &(vlc_internals(p_interaction)->lock) );
564 int canc = vlc_savecancel();
565 InteractionManage( p_interaction );
566 vlc_restorecancel( canc );
568 vlc_cond_wait( &p_interaction->wait, &(vlc_internals(p_interaction)->lock) );
575 * The main interaction processing loop
577 * \param p_interaction the interaction object
581 static void InteractionManage( interaction_t *p_interaction )
587 if( p_interaction->i_dialogs == 0 ) return;
589 p_interaction->p_intf = SearchInterface( p_interaction );
590 if( !p_interaction->p_intf )
592 /* We mark all dialogs as answered with their "default" answer */
593 for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
595 interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
596 p_dialog->i_return = DIALOG_DEFAULT; /* Give default answer */
598 /* Pretend we have hidden and destroyed it */
599 if( p_dialog->i_status == HIDDEN_DIALOG )
600 p_dialog->i_status = DESTROYED_DIALOG;
602 p_dialog->i_status = HIDING_DIALOG;
606 for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
608 interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
609 switch( p_dialog->i_status )
611 case ANSWERED_DIALOG:
612 /* Ask interface to hide it */
613 p_dialog->i_action = INTERACT_HIDE;
614 val.p_address = p_dialog;
615 if( p_interaction->p_intf )
616 var_Set( p_interaction->p_intf, "interaction", val );
617 p_dialog->i_status = HIDING_DIALOG;
620 p_dialog->i_action = INTERACT_UPDATE;
621 val.p_address = p_dialog;
622 if( p_interaction->p_intf )
623 var_Set( p_interaction->p_intf, "interaction", val );
624 p_dialog->i_status = SENT_DIALOG;
627 if( !(p_dialog->i_flags & DIALOG_GOT_ANSWER) ) break;
628 p_dialog->i_action = INTERACT_DESTROY;
629 val.p_address = p_dialog;
630 if( p_interaction->p_intf )
631 var_Set( p_interaction->p_intf, "interaction", val );
633 case DESTROYED_DIALOG:
634 /* Interface has now destroyed it, remove it */
635 REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs,
638 DialogDestroy( p_dialog );
641 /* This is truly a new dialog, send it. */
643 p_dialog->i_action = INTERACT_NEW;
644 val.p_address = p_dialog;
645 if( p_interaction->p_intf )
646 var_Set( p_interaction->p_intf, "interaction", val );
647 p_dialog->i_status = SENT_DIALOG;
652 if( p_interaction->p_intf )
653 vlc_object_release( p_interaction->p_intf );