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
62 int i_dialogs; ///< Number of dialogs
63 interaction_dialog_t **pp_dialogs; ///< Dialogs
64 intf_thread_t *p_intf; ///< Interface to use
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( 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->p_parent = vlc_object_hold( p_this ); \
79 p_new->b_cancelled = false; \
80 p_new->i_status = SENT_DIALOG; \
82 p_new->i_type = INTERACT_DIALOG_##type; \
83 p_new->psz_returned[0] = NULL; \
84 p_new->psz_returned[1] = NULL
87 va_start( args, psz_format ); \
88 if( vasprintf( &p_new->psz_description, psz_format, args ) == -1 ) \
89 return VLC_EGENERIC; \
92 static inline int DialogFireForget( interaction_dialog_t *d )
94 int ret = DialogSend( d );
95 if( ret == VLC_EGENERIC )
101 * Send an error message, both in a blocking and non-blocking way
103 * \param p_this Parent vlc_object
104 * \param b_blocking Is this dialog blocking or not?
105 * \param psz_title Title for the dialog
106 * \param psz_format The message to display
107 * \return VLC_SUCCESS or VLC_EGENERIC
109 int __intf_UserFatal( vlc_object_t *p_this, bool b_blocking,
110 const char *psz_title,
111 const char *psz_format, ... )
114 DIALOG_INIT( ONEWAY, VLC_EGENERIC );
116 p_new->psz_title = strdup( psz_title );
120 p_new->i_flags = DIALOG_BLOCKING_ERROR;
122 p_new->i_flags = DIALOG_NONBLOCKING_ERROR;
124 return DialogFireForget( p_new );
128 * Helper function to ask a yes-no-cancel question
130 * \param p_this Parent vlc_object
131 * \param psz_title Title for the dialog
132 * \param psz_description A description
133 * \param psz_default caption for the default button
134 * \param psz_alternate caption for the alternate button
135 * \param psz_other caption for the optional 3rd button (== cancel)
136 * \return Clicked button code
138 int __intf_UserYesNo( vlc_object_t *p_this,
139 const char *psz_title,
140 const char *psz_description,
141 const char *psz_default,
142 const char *psz_alternate,
143 const char *psz_other )
145 DIALOG_INIT( TWOWAY, VLC_EGENERIC );
147 p_new->psz_title = strdup( psz_title );
148 p_new->psz_description = strdup( psz_description );
149 p_new->i_flags = DIALOG_YES_NO_CANCEL;
150 p_new->psz_default_button = strdup( psz_default );
151 p_new->psz_alternate_button = strdup( psz_alternate );
152 p_new->psz_other_button = psz_other ? strdup( psz_other ) : NULL;
154 return DialogFireForget( p_new );
158 * Helper function to create a dialogue showing a progress-bar with some info
160 * \param p_this Parent vlc_object
161 * \param psz_title Title for the dialog (NULL implies main intf )
162 * \param psz_status Current status
163 * \param f_position Current position (0.0->100.0)
164 * \param i_timeToGo Time (in sec) to go until process is finished
165 * \return Dialog, for use with UserProgressUpdate
167 interaction_dialog_t *
168 __intf_Progress( vlc_object_t *p_this, const char *psz_title,
169 const char *psz_status, float f_pos, int i_time )
171 DIALOG_INIT( ONEWAY, NULL );
172 p_new->psz_description = strdup( psz_status );
173 p_new->val.f_float = f_pos;
174 p_new->i_timeToGo = i_time;
175 p_new->psz_alternate_button = strdup( _( "Cancel" ) );
179 p_new->psz_title = strdup( psz_title );
180 p_new->i_flags = DIALOG_USER_PROGRESS;
183 p_new->i_flags = DIALOG_INTF_PROGRESS;
190 * Update a progress bar in a dialogue
192 * \param p_dialog Dialog
193 * \param psz_status New status
194 * \param f_position New position (0.0->100.0)
195 * \param i_timeToGo Time (in sec) to go until process is finished
198 void intf_ProgressUpdate( interaction_dialog_t *p_dialog,
199 const char *psz_status, float f_pos, int i_time )
201 interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
202 assert( p_interaction );
204 vlc_mutex_lock( &p_interaction->lock );
205 free( p_dialog->psz_description );
206 p_dialog->psz_description = strdup( psz_status );
208 p_dialog->val.f_float = f_pos;
209 p_dialog->i_timeToGo = i_time;
211 p_dialog->i_status = UPDATED_DIALOG;
213 vlc_cond_signal( &p_interaction->wait );
214 vlc_mutex_unlock( &p_interaction->lock );
215 vlc_object_release( p_interaction );
219 * Helper function to communicate dialogue cancellations between the
220 * interface module and the caller
222 * \param p_dialog Dialog
223 * \return Either true or false
225 bool intf_ProgressIsCancelled( interaction_dialog_t *p_dialog )
227 interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
230 assert( p_interaction );
231 vlc_mutex_lock( &p_interaction->lock );
232 b_cancel = p_dialog->b_cancelled;
233 vlc_mutex_unlock( &p_interaction->lock );
234 vlc_object_release( p_interaction );
239 * Helper function to make a login/password dialogue
241 * \param p_this Parent vlc_object
242 * \param psz_title Title for the dialog
243 * \param psz_description A description
244 * \param ppsz_login Returned login
245 * \param ppsz_password Returned password
246 * \return Clicked button code
248 int __intf_UserLoginPassword( vlc_object_t *p_this,
249 const char *psz_title,
250 const char *psz_description,
252 char **ppsz_password )
255 DIALOG_INIT( TWOWAY, VLC_EGENERIC );
256 p_new->i_type = INTERACT_DIALOG_TWOWAY;
257 p_new->psz_title = strdup( psz_title );
258 p_new->psz_description = strdup( psz_description );
259 p_new->psz_default_button = strdup( _("OK" ) );
260 p_new->psz_alternate_button = strdup( _("Cancel" ) );
262 p_new->i_flags = DIALOG_LOGIN_PW_OK_CANCEL;
264 i_ret = DialogSend( p_new );
266 if( i_ret == VLC_EGENERIC )
267 DialogDestroy( p_new );
268 else if( i_ret != DIALOG_CANCELLED )
270 *ppsz_login = p_new->psz_returned[0]?
271 strdup( p_new->psz_returned[0] ) : NULL;
272 *ppsz_password = p_new->psz_returned[1]?
273 strdup( p_new->psz_returned[1] ) : NULL;
279 * Helper function to make a dialogue asking the user for !password string
281 * \param p_this Parent vlc_object
282 * \param psz_title Title for the dialog
283 * \param psz_description A description
284 * \param ppsz_usersString Returned login
285 * \return Clicked button code
287 int __intf_UserStringInput( vlc_object_t *p_this,
288 const char *psz_title,
289 const char *psz_description,
290 char **ppsz_usersString )
293 DIALOG_INIT( TWOWAY, VLC_EGENERIC );
294 p_new->i_type = INTERACT_DIALOG_TWOWAY;
295 p_new->psz_title = strdup( psz_title );
296 p_new->psz_description = strdup( psz_description );
298 p_new->i_flags = DIALOG_PSZ_INPUT_OK_CANCEL;
300 i_ret = DialogSend( p_new );
302 if( i_ret == VLC_EGENERIC )
303 DialogDestroy( p_new );
304 else if( i_ret != DIALOG_CANCELLED )
306 *ppsz_usersString = p_new->psz_returned[0]?
307 strdup( p_new->psz_returned[0] ) : NULL;
313 * Hide an interaction dialog
315 * \param p_dialog the dialog to hide
318 void intf_UserHide( interaction_dialog_t *p_dialog )
320 interaction_t *p_interaction = InteractionGet( p_dialog->p_parent );
321 assert( p_interaction );
323 vlc_mutex_lock( &p_interaction->lock );
324 p_dialog->i_status = ANSWERED_DIALOG;
325 vlc_cond_signal( &p_interaction->wait );
326 vlc_mutex_unlock( &p_interaction->lock );
327 vlc_object_release( p_interaction );
331 * Create the initial interaction object
332 * (should only be used in libvlc_InternalInit, LibVLC private)
334 * \return a vlc_object_t that should be freed when done.
336 interaction_t * interaction_Init( libvlc_int_t *p_libvlc )
338 interaction_t *p_interaction;
340 /* Make sure we haven't yet created an interaction object */
341 assert( libvlc_priv(p_libvlc)->p_interaction == NULL );
343 p_interaction = vlc_custom_create( VLC_OBJECT(p_libvlc),
344 sizeof( *p_interaction ),
345 VLC_OBJECT_GENERIC, "interaction" );
349 vlc_object_attach( p_interaction, p_libvlc );
350 p_interaction->i_dialogs = 0;
351 p_interaction->pp_dialogs = NULL;
352 p_interaction->p_intf = NULL;
354 vlc_mutex_init( &p_interaction->lock );
355 vlc_cond_init( &p_interaction->wait );
357 if( vlc_clone( &p_interaction->thread, InteractionLoop, p_interaction,
358 VLC_THREAD_PRIORITY_LOW ) )
360 msg_Err( p_interaction, "Interaction control thread creation failed, "
361 "interaction will not be displayed" );
362 vlc_object_detach( p_interaction );
363 vlc_object_release( p_interaction );
367 return p_interaction;
370 void interaction_Destroy( interaction_t *p_interaction )
375 vlc_cancel( p_interaction->thread );
376 vlc_join( p_interaction->thread, NULL );
377 vlc_cond_destroy( &p_interaction->wait );
378 vlc_mutex_destroy( &p_interaction->lock );
380 /* Remove all dialogs - Interfaces must be able to clean up their data */
381 for( int i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
383 interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
384 DialogDestroy( p_dialog );
385 REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
387 vlc_object_release( p_interaction );
390 static vlc_mutex_t intf_lock = VLC_STATIC_MUTEX;
392 int interaction_Register( intf_thread_t *intf )
394 libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc );
395 int ret = VLC_EGENERIC;
397 vlc_mutex_lock( &intf_lock );
398 if( priv->p_interaction_intf == NULL )
399 { /* Since the interface is responsible for unregistering itself before
400 * it terminates, an object reference is not needed. */
401 priv->p_interaction_intf = intf;
404 vlc_mutex_unlock( &intf_lock );
408 int interaction_Unregister( intf_thread_t *intf )
410 libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc );
411 int ret = VLC_EGENERIC;
413 vlc_mutex_lock( &intf_lock );
414 if( priv->p_interaction_intf == intf )
416 priv->p_interaction_intf = NULL;
419 vlc_mutex_unlock( &intf_lock );
423 /**********************************************************************
424 * The following functions are local
425 **********************************************************************/
427 /* Get the interaction object */
428 static interaction_t * InteractionGet( vlc_object_t *p_this )
430 interaction_t *obj = libvlc_priv(p_this->p_libvlc)->p_interaction;
432 vlc_object_hold( obj );
437 /* Look for an interface suitable for interaction, and hold it. */
438 static intf_thread_t *SearchInterface( interaction_t *p_interaction )
440 libvlc_priv_t *priv = libvlc_priv( p_interaction->p_libvlc );
443 vlc_mutex_lock( &intf_lock );
444 intf = priv->p_interaction_intf;
446 vlc_object_hold( intf );
447 vlc_mutex_unlock( &intf_lock );
452 /* Destroy a dialog */
453 static void DialogDestroy( interaction_dialog_t *p_dialog )
455 free( p_dialog->psz_title );
456 free( p_dialog->psz_description );
457 free( p_dialog->psz_default_button );
458 free( p_dialog->psz_alternate_button );
459 free( p_dialog->psz_other_button );
460 vlc_object_release( p_dialog->p_parent );
464 /* Ask for the dialog to be sent to the user. Wait for answer
466 static int DialogSend( interaction_dialog_t *p_dialog )
468 interaction_t *p_interaction;
469 intf_thread_t *p_intf;
471 if( p_dialog->p_parent->i_flags & OBJECT_FLAGS_NOINTERACT )
474 p_interaction = InteractionGet( p_dialog->p_parent );
478 p_dialog->p_lock = &p_interaction->lock;
480 p_intf = SearchInterface( p_interaction );
483 p_dialog->i_return = DIALOG_DEFAULT; /* Give default answer */
485 /* Pretend we have hidden and destroyed it */
486 p_dialog->i_status = HIDING_DIALOG;
487 vlc_object_release( p_interaction );
490 p_dialog->p_interface = p_intf;
492 if( config_GetInt( p_interaction, "interact" ) ||
493 p_dialog->i_flags & DIALOG_BLOCKING_ERROR ||
494 p_dialog->i_flags & DIALOG_NONBLOCKING_ERROR )
498 p_dialog->i_action = INTERACT_NEW;
499 val.p_address = p_dialog;
500 var_Set( p_dialog->p_interface, "interaction", val );
502 /* Check if we have already added this dialog */
503 vlc_mutex_lock( &p_interaction->lock );
504 /* Add it to the queue, the main loop will send the orders to the
506 INSERT_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs,
507 p_interaction->i_dialogs, p_dialog );
509 if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY ) /* Wait for answer */
511 vlc_cond_signal( &p_interaction->wait );
512 while( p_dialog->i_status != ANSWERED_DIALOG &&
513 p_dialog->i_status != HIDING_DIALOG &&
514 p_dialog->i_status != HIDDEN_DIALOG &&
515 !p_dialog->p_parent->b_die )
517 vlc_mutex_unlock( &p_interaction->lock );
519 vlc_mutex_lock( &p_interaction->lock );
521 if( p_dialog->p_parent->b_die )
523 p_dialog->i_return = DIALOG_CANCELLED;
524 p_dialog->i_status = ANSWERED_DIALOG;
526 p_dialog->i_flags |= DIALOG_GOT_ANSWER;
527 vlc_cond_signal( &p_interaction->wait );
528 vlc_mutex_unlock( &p_interaction->lock );
529 vlc_object_release( p_interaction );
530 return p_dialog->i_return;
534 /* Pretend we already retrieved the "answer" */
535 p_dialog->i_flags |= DIALOG_GOT_ANSWER;
536 vlc_cond_signal( &p_interaction->wait );
537 vlc_mutex_unlock( &p_interaction->lock );
538 vlc_object_release( p_interaction );
544 vlc_object_release( p_interaction );
549 static void* InteractionLoop( void *p_this )
551 interaction_t *p_interaction = p_this;
553 vlc_mutex_lock( &p_interaction->lock );
554 mutex_cleanup_push( &p_interaction->lock );
557 int canc = vlc_savecancel();
558 InteractionManage( p_interaction );
559 vlc_restorecancel( canc );
561 vlc_cond_wait( &p_interaction->wait, &p_interaction->lock );
568 * The main interaction processing loop
570 * \param p_interaction the interaction object
574 static void InteractionManage( interaction_t *p_interaction )
579 for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
581 interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
582 switch( p_dialog->i_status )
584 case ANSWERED_DIALOG:
585 /* Ask interface to hide it */
586 p_dialog->i_action = INTERACT_HIDE;
587 val.p_address = p_dialog;
588 var_Set( p_dialog->p_interface, "interaction", val );
589 p_dialog->i_status = HIDING_DIALOG;
592 p_dialog->i_action = INTERACT_UPDATE;
593 val.p_address = p_dialog;
594 var_Set( p_dialog->p_interface, "interaction", val );
595 p_dialog->i_status = SENT_DIALOG;
598 if( !(p_dialog->i_flags & DIALOG_GOT_ANSWER) ) break;
599 p_dialog->i_action = INTERACT_DESTROY;
600 val.p_address = p_dialog;
601 var_Set( p_dialog->p_interface, "interaction", val );
603 case DESTROYED_DIALOG:
604 /* Interface has now destroyed it, remove it */
605 REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs,
608 DialogDestroy( p_dialog );