1 /*****************************************************************************
2 * variables.c: routines for object variables handling
3 *****************************************************************************
4 * Copyright (C) 2002-2009 VLC authors and VideoLAN
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
41 #include <vlc_common.h>
42 #include <vlc_charset.h>
44 #include "variables.h"
45 #include "config/configuration.h"
47 /*****************************************************************************
49 *****************************************************************************/
50 struct callback_entry_t
52 vlc_callback_t pf_callback;
56 /*****************************************************************************
57 * Local comparison functions, returns 0 if v == w, < 0 if v < w, > 0 if v > w
58 *****************************************************************************/
59 static int CmpBool( vlc_value_t v, vlc_value_t w )
61 return v.b_bool ? w.b_bool ? 0 : 1 : w.b_bool ? -1 : 0;
64 static int CmpInt( vlc_value_t v, vlc_value_t w )
66 return v.i_int == w.i_int ? 0 : v.i_int > w.i_int ? 1 : -1;
69 static int CmpTime( vlc_value_t v, vlc_value_t w )
71 return v.i_time == w.i_time ? 0 : v.i_time > w.i_time ? 1 : -1;
74 static int CmpString( vlc_value_t v, vlc_value_t w )
77 return !w.psz_string ? 0 : -1;
79 return !w.psz_string ? 1 : strcmp( v.psz_string, w.psz_string );
81 static int CmpFloat( vlc_value_t v, vlc_value_t w ) { return v.f_float == w.f_float ? 0 : v.f_float > w.f_float ? 1 : -1; }
82 static int CmpAddress( vlc_value_t v, vlc_value_t w ) { return v.p_address == w.p_address ? 0 : v.p_address > w.p_address ? 1 : -1; }
84 /*****************************************************************************
85 * Local duplication functions, and local deallocation functions
86 *****************************************************************************/
87 static void DupDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
88 static void DupString( vlc_value_t *p_val )
90 p_val->psz_string = strdup( p_val->psz_string ? p_val->psz_string : "" );
93 static void FreeDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
94 static void FreeString( vlc_value_t *p_val ) { free( p_val->psz_string ); }
96 static void FreeList( vlc_value_t *p_val )
99 for( i = 0; i < p_val->p_list->i_count; i++ )
101 switch( p_val->p_list->pi_types[i] & VLC_VAR_CLASS )
104 FreeString( &p_val->p_list->p_values[i] );
111 if( p_val->p_list->i_count )
113 free( p_val->p_list->p_values );
114 free( p_val->p_list->pi_types );
116 free( p_val->p_list );
119 static const struct variable_ops_t
120 void_ops = { NULL, DupDummy, FreeDummy, },
121 addr_ops = { CmpAddress, DupDummy, FreeDummy, },
122 bool_ops = { CmpBool, DupDummy, FreeDummy, },
123 float_ops = { CmpFloat, DupDummy, FreeDummy, },
124 int_ops = { CmpInt, DupDummy, FreeDummy, },
125 string_ops = { CmpString, DupString, FreeString, },
126 time_ops = { CmpTime, DupDummy, FreeDummy, },
127 coords_ops = { NULL, DupDummy, FreeDummy, };
129 /*****************************************************************************
131 *****************************************************************************/
132 static void WaitUnused ( vlc_object_t *, variable_t * );
134 static void CheckValue ( variable_t *, vlc_value_t * );
136 static int TriggerCallback( vlc_object_t *, variable_t *, const char *,
139 static int varcmp( const void *a, const void *b )
141 const variable_t *va = a, *vb = b;
143 /* psz_name must be first */
144 assert( va == (const void *)&va->psz_name );
145 return strcmp( va->psz_name, vb->psz_name );
148 static variable_t *Lookup( vlc_object_t *obj, const char *psz_name )
150 vlc_object_internals_t *priv = vlc_internals( obj );
153 vlc_assert_locked( &priv->var_lock );
154 pp_var = tfind( &psz_name, &priv->var_root, varcmp );
155 return (pp_var != NULL) ? *pp_var : NULL;
158 static void Destroy( variable_t *p_var )
160 p_var->ops->pf_free( &p_var->val );
161 if( p_var->choices.i_count )
163 for( int i = 0 ; i < p_var->choices.i_count ; i++ )
165 p_var->ops->pf_free( &p_var->choices.p_values[i] );
166 free( p_var->choices_text.p_values[i].psz_string );
168 free( p_var->choices.p_values );
169 free( p_var->choices_text.p_values );
172 for (int i = 0; i < p_var->i_entries; i++)
174 const char *file = "?", *symbol = "?";
175 const void *addr = p_var->p_entries[i].pf_callback;
179 if (dladdr (addr, &info))
181 if (info.dli_fname) file = info.dli_fname;
182 if (info.dli_sname) symbol = info.dli_sname;
185 fprintf (stderr, "Error: callback on \"%s\" dangling %s(%s)[%p]\n",
186 p_var->psz_name, file, symbol, addr);
190 free( p_var->psz_name );
191 free( p_var->psz_text );
192 free( p_var->p_entries );
198 * Initialize a vlc variable
200 * We hash the given string and insert it into the sorted list. The insertion
201 * may require slow memory copies, but think about what we gain in the log(n)
202 * lookup phase when setting/getting the variable value!
204 * \param p_this The object in which to create the variable
205 * \param psz_name The name of the variable
206 * \param i_type The variables type. Must be one of \ref var_type combined with
207 * zero or more \ref var_flags
209 int var_Create( vlc_object_t *p_this, const char *psz_name, int i_type )
213 variable_t *p_var = calloc( 1, sizeof( *p_var ) );
217 p_var->psz_name = strdup( psz_name );
218 p_var->psz_text = NULL;
220 p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
224 p_var->i_default = -1;
225 p_var->choices.i_count = 0;
226 p_var->choices.p_values = NULL;
227 p_var->choices_text.i_count = 0;
228 p_var->choices_text.p_values = NULL;
230 p_var->b_incallback = false;
231 p_var->i_entries = 0;
232 p_var->p_entries = NULL;
234 /* Always initialize the variable, even if it is a list variable; this
235 * will lead to errors if the variable is not initialized, but it will
236 * not cause crashes in the variable handling. */
237 switch( i_type & VLC_VAR_CLASS )
240 p_var->ops = &bool_ops;
241 p_var->val.b_bool = false;
243 case VLC_VAR_INTEGER:
244 p_var->ops = &int_ops;
245 p_var->val.i_int = 0;
248 p_var->ops = &string_ops;
249 p_var->val.psz_string = NULL;
252 p_var->ops = &float_ops;
253 p_var->val.f_float = 0.0;
256 p_var->ops = &time_ops;
257 p_var->val.i_time = 0;
260 p_var->ops = &coords_ops;
261 p_var->val.coords.x = p_var->val.coords.y = 0;
263 case VLC_VAR_ADDRESS:
264 p_var->ops = &addr_ops;
265 p_var->val.p_address = NULL;
268 p_var->ops = &void_ops;
274 if( i_type & VLC_VAR_DOINHERIT )
276 if( var_Inherit( p_this, psz_name, i_type, &p_var->val ) )
277 msg_Err( p_this, "cannot inherit value for %s", psz_name );
278 else if( i_type & VLC_VAR_HASCHOICE )
280 /* We must add the inherited value to our choice list */
281 p_var->i_default = 0;
283 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
285 INSERT_ELEM( p_var->choices_text.p_values,
286 p_var->choices_text.i_count, 0, p_var->val );
287 p_var->ops->pf_dup( &p_var->choices.p_values[0] );
288 p_var->choices_text.p_values[0].psz_string = NULL;
292 vlc_object_internals_t *p_priv = vlc_internals( p_this );
293 variable_t **pp_var, *p_oldvar;
294 int ret = VLC_SUCCESS;
296 vlc_mutex_lock( &p_priv->var_lock );
298 pp_var = tsearch( p_var, &p_priv->var_root, varcmp );
299 if( unlikely(pp_var == NULL) )
301 else if( (p_oldvar = *pp_var) == p_var ) /* Variable create */
302 p_var = NULL; /* Variable created */
303 else /* Variable already exists */
305 assert (((i_type ^ p_oldvar->i_type) & VLC_VAR_CLASS) == 0);
307 p_oldvar->i_type |= i_type & (VLC_VAR_ISCOMMAND|VLC_VAR_HASCHOICE);
309 vlc_mutex_unlock( &p_priv->var_lock );
311 /* If we did not need to create a new variable, free everything... */
319 * Destroy a vlc variable
321 * Look for the variable and destroy it if it is found. As in var_Create we
322 * do a call to memmove() but we have performance counterparts elsewhere.
324 * \param p_this The object that holds the variable
325 * \param psz_name The name of the variable
327 int var_Destroy( vlc_object_t *p_this, const char *psz_name )
333 vlc_object_internals_t *p_priv = vlc_internals( p_this );
335 vlc_mutex_lock( &p_priv->var_lock );
337 p_var = Lookup( p_this, psz_name );
340 vlc_mutex_unlock( &p_priv->var_lock );
344 WaitUnused( p_this, p_var );
346 if( --p_var->i_usage == 0 )
347 tdelete( p_var, &p_priv->var_root, varcmp );
350 vlc_mutex_unlock( &p_priv->var_lock );
357 static void CleanupVar( void *var )
362 void var_DestroyAll( vlc_object_t *obj )
364 vlc_object_internals_t *priv = vlc_internals( obj );
366 tdestroy( priv->var_root, CleanupVar );
367 priv->var_root = NULL;
372 * Perform an action on a variable
374 * \param p_this The object that holds the variable
375 * \param psz_name The name of the variable
376 * \param i_action The action to perform. Must be one of \ref var_action
377 * \param p_val First action parameter
378 * \param p_val2 Second action parameter
380 int var_Change( vlc_object_t *p_this, const char *psz_name,
381 int i_action, vlc_value_t *p_val, vlc_value_t *p_val2 )
383 int ret = VLC_SUCCESS;
390 vlc_object_internals_t *p_priv = vlc_internals( p_this );
392 vlc_mutex_lock( &p_priv->var_lock );
394 p_var = Lookup( p_this, psz_name );
397 vlc_mutex_unlock( &p_priv->var_lock );
404 if( p_var->i_type & VLC_VAR_HASMIN )
406 p_var->ops->pf_free( &p_var->min );
408 p_var->i_type |= VLC_VAR_HASMIN;
410 p_var->ops->pf_dup( &p_var->min );
411 CheckValue( p_var, &p_var->val );
414 if( p_var->i_type & VLC_VAR_HASMIN )
420 if( p_var->i_type & VLC_VAR_HASMAX )
422 p_var->ops->pf_free( &p_var->max );
424 p_var->i_type |= VLC_VAR_HASMAX;
426 p_var->ops->pf_dup( &p_var->max );
427 CheckValue( p_var, &p_var->val );
430 if( p_var->i_type & VLC_VAR_HASMAX )
435 case VLC_VAR_SETSTEP:
436 if( p_var->i_type & VLC_VAR_HASSTEP )
438 p_var->ops->pf_free( &p_var->step );
440 p_var->i_type |= VLC_VAR_HASSTEP;
441 p_var->step = *p_val;
442 p_var->ops->pf_dup( &p_var->step );
443 CheckValue( p_var, &p_var->val );
445 case VLC_VAR_GETSTEP:
446 if( p_var->i_type & VLC_VAR_HASSTEP )
447 *p_val = p_var->step;
451 case VLC_VAR_ADDCHOICE:
453 int i = p_var->choices.i_count;
455 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
457 INSERT_ELEM( p_var->choices_text.p_values,
458 p_var->choices_text.i_count, i, *p_val );
459 p_var->ops->pf_dup( &p_var->choices.p_values[i] );
460 p_var->choices_text.p_values[i].psz_string =
461 ( p_val2 && p_val2->psz_string ) ?
462 strdup( p_val2->psz_string ) : NULL;
464 CheckValue( p_var, &p_var->val );
467 case VLC_VAR_DELCHOICE:
471 for( i = 0 ; i < p_var->choices.i_count ; i++ )
472 if( p_var->ops->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
475 if( i == p_var->choices.i_count )
478 vlc_mutex_unlock( &p_priv->var_lock );
482 if( p_var->i_default > i )
484 else if( p_var->i_default == i )
485 p_var->i_default = -1;
487 p_var->ops->pf_free( &p_var->choices.p_values[i] );
488 free( p_var->choices_text.p_values[i].psz_string );
489 REMOVE_ELEM( p_var->choices.p_values, p_var->choices.i_count, i );
490 REMOVE_ELEM( p_var->choices_text.p_values,
491 p_var->choices_text.i_count, i );
493 CheckValue( p_var, &p_var->val );
496 case VLC_VAR_CHOICESCOUNT:
497 p_val->i_int = p_var->choices.i_count;
499 case VLC_VAR_CLEARCHOICES:
500 for( int i = 0 ; i < p_var->choices.i_count ; i++ )
501 p_var->ops->pf_free( &p_var->choices.p_values[i] );
502 for( int i = 0 ; i < p_var->choices_text.i_count ; i++ )
503 free( p_var->choices_text.p_values[i].psz_string );
505 if( p_var->choices.i_count ) free( p_var->choices.p_values );
506 if( p_var->choices_text.i_count ) free( p_var->choices_text.p_values );
508 p_var->choices.i_count = 0;
509 p_var->choices.p_values = NULL;
510 p_var->choices_text.i_count = 0;
511 p_var->choices_text.p_values = NULL;
512 p_var->i_default = -1;
514 case VLC_VAR_SETDEFAULT:
517 /* FIXME: the list is sorted, dude. Use something cleverer. */
518 for( i = 0 ; i < p_var->choices.i_count ; i++ )
519 if( p_var->ops->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
522 if( i == p_var->choices.i_count )
526 p_var->i_default = i;
527 CheckValue( p_var, &p_var->val );
530 case VLC_VAR_SETVALUE:
531 /* Duplicate data if needed */
533 p_var->ops->pf_dup( &newval );
534 /* Backup needed stuff */
536 /* Check boundaries and list */
537 CheckValue( p_var, &newval );
538 /* Set the variable */
540 /* Free data if needed */
541 p_var->ops->pf_free( &oldval );
543 case VLC_VAR_GETCHOICES:
544 case VLC_VAR_GETLIST:
545 p_val->p_list = malloc( sizeof(vlc_list_t) );
546 if( p_val2 ) p_val2->p_list = malloc( sizeof(vlc_list_t) );
547 if( p_var->choices.i_count )
549 p_val->p_list->p_values = malloc( p_var->choices.i_count
550 * sizeof(vlc_value_t) );
551 p_val->p_list->pi_types = malloc( p_var->choices.i_count
555 p_val2->p_list->p_values =
556 malloc( p_var->choices.i_count * sizeof(vlc_value_t) );
557 p_val2->p_list->pi_types =
558 malloc( p_var->choices.i_count * sizeof(int) );
561 p_val->p_list->i_count = p_var->choices.i_count;
562 if( p_val2 ) p_val2->p_list->i_count = p_var->choices.i_count;
563 for( int i = 0 ; i < p_var->choices.i_count ; i++ )
565 p_val->p_list->p_values[i] = p_var->choices.p_values[i];
566 p_val->p_list->pi_types[i] = p_var->i_type;
567 p_var->ops->pf_dup( &p_val->p_list->p_values[i] );
570 p_val2->p_list->p_values[i].psz_string =
571 p_var->choices_text.p_values[i].psz_string ?
572 strdup(p_var->choices_text.p_values[i].psz_string) : NULL;
573 p_val2->p_list->pi_types[i] = VLC_VAR_STRING;
577 case VLC_VAR_SETTEXT:
578 free( p_var->psz_text );
579 if( p_val && p_val->psz_string )
580 p_var->psz_text = strdup( p_val->psz_string );
582 p_var->psz_text = NULL;
584 case VLC_VAR_GETTEXT:
585 p_val->psz_string = p_var->psz_text ? strdup( p_var->psz_text )
588 case VLC_VAR_SETISCOMMAND:
589 p_var->i_type |= VLC_VAR_ISCOMMAND;
596 vlc_mutex_unlock( &p_priv->var_lock );
603 * Perform a Get and Set on a variable
605 * \param p_this: The object that hold the variable
606 * \param psz_name: the name of the variable
607 * \param i_action: the action to perform
608 * \param p_val: The action parameter
609 * \return vlc error codes
611 int var_GetAndSet( vlc_object_t *p_this, const char *psz_name, int i_action,
621 vlc_object_internals_t *p_priv = vlc_internals( p_this );
623 vlc_mutex_lock( &p_priv->var_lock );
624 p_var = Lookup( p_this, psz_name );
627 vlc_mutex_unlock( &p_priv->var_lock );
631 WaitUnused( p_this, p_var );
633 /* Duplicated data if needed */
634 //p_var->ops->pf_dup( &val );
636 /* Backup needed stuff */
639 /* depending of the action requiered */
642 case VLC_VAR_BOOL_TOGGLE:
643 assert( ( p_var->i_type & VLC_VAR_BOOL ) == VLC_VAR_BOOL );
644 p_var->val.b_bool = !p_var->val.b_bool;
646 case VLC_VAR_INTEGER_ADD:
647 assert( ( p_var->i_type & VLC_VAR_INTEGER ) == VLC_VAR_INTEGER );
648 p_var->val.i_int += p_val->i_int;
650 case VLC_VAR_INTEGER_OR:
651 assert( ( p_var->i_type & VLC_VAR_INTEGER ) == VLC_VAR_INTEGER );
652 p_var->val.i_int |= p_val->i_int;
654 case VLC_VAR_INTEGER_NAND:
655 assert( ( p_var->i_type & VLC_VAR_INTEGER ) == VLC_VAR_INTEGER );
656 p_var->val.i_int &= ~p_val->i_int;
659 vlc_mutex_unlock( &p_priv->var_lock );
663 /* Check boundaries */
664 CheckValue( p_var, &p_var->val );
667 /* Deal with callbacks.*/
668 i_ret = TriggerCallback( p_this, p_var, psz_name, oldval );
670 vlc_mutex_unlock( &p_priv->var_lock );
677 * Request a variable's type
679 * \return The variable type if it exists, or 0 if the
680 * variable could not be found.
683 int var_Type( vlc_object_t *p_this, const char *psz_name )
690 vlc_object_internals_t *p_priv = vlc_internals( p_this );
692 vlc_mutex_lock( &p_priv->var_lock );
694 p_var = Lookup( p_this, psz_name );
696 i_type = p_var->i_type;
698 vlc_mutex_unlock( &p_priv->var_lock );
703 #undef var_SetChecked
704 int var_SetChecked( vlc_object_t *p_this, const char *psz_name,
705 int expected_type, vlc_value_t val )
707 int i_ret = VLC_SUCCESS;
713 vlc_object_internals_t *p_priv = vlc_internals( p_this );
715 vlc_mutex_lock( &p_priv->var_lock );
717 p_var = Lookup( p_this, psz_name );
720 vlc_mutex_unlock( &p_priv->var_lock );
724 assert( expected_type == 0 ||
725 (p_var->i_type & VLC_VAR_CLASS) == expected_type );
726 assert ((p_var->i_type & VLC_VAR_CLASS) != VLC_VAR_VOID);
728 WaitUnused( p_this, p_var );
730 /* Duplicate data if needed */
731 p_var->ops->pf_dup( &val );
733 /* Backup needed stuff */
736 /* Check boundaries and list */
737 CheckValue( p_var, &val );
739 /* Set the variable */
742 /* Deal with callbacks */
743 i_ret = TriggerCallback( p_this, p_var, psz_name, oldval );
745 /* Free data if needed */
746 p_var->ops->pf_free( &oldval );
748 vlc_mutex_unlock( &p_priv->var_lock );
755 * Set a variable's value
757 * \param p_this The object that hold the variable
758 * \param psz_name The name of the variable
759 * \param val the value to set
761 int var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val )
763 return var_SetChecked( p_this, psz_name, 0, val );
766 #undef var_GetChecked
767 int var_GetChecked( vlc_object_t *p_this, const char *psz_name,
768 int expected_type, vlc_value_t *p_val )
772 vlc_object_internals_t *p_priv = vlc_internals( p_this );
774 int err = VLC_SUCCESS;
776 vlc_mutex_lock( &p_priv->var_lock );
778 p_var = Lookup( p_this, psz_name );
781 assert( expected_type == 0 ||
782 (p_var->i_type & VLC_VAR_CLASS) == expected_type );
783 assert ((p_var->i_type & VLC_VAR_CLASS) != VLC_VAR_VOID);
785 /* Really get the variable */
788 /* Duplicate value if needed */
789 p_var->ops->pf_dup( p_val );
794 vlc_mutex_unlock( &p_priv->var_lock );
800 * Get a variable's value
802 * \param p_this The object that holds the variable
803 * \param psz_name The name of the variable
804 * \param p_val Pointer to a vlc_value_t that will hold the variable's value
805 * after the function is finished
807 int var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
809 return var_GetChecked( p_this, psz_name, 0, p_val );
812 #undef var_AddCallback
814 * Register a callback in a variable
816 * We store a function pointer that will be called upon variable
819 * \param p_this The object that holds the variable
820 * \param psz_name The name of the variable
821 * \param pf_callback The function pointer
822 * \param p_data A generic pointer that will be passed as the last
823 * argument to the callback function.
825 * \warning The callback function is run in the thread that calls var_Set on
826 * the variable. Use proper locking. This thread may not have much
827 * time to spare, so keep callback functions short.
829 int var_AddCallback( vlc_object_t *p_this, const char *psz_name,
830 vlc_callback_t pf_callback, void *p_data )
833 callback_entry_t entry;
837 vlc_object_internals_t *p_priv = vlc_internals( p_this );
839 entry.pf_callback = pf_callback;
840 entry.p_data = p_data;
842 vlc_mutex_lock( &p_priv->var_lock );
844 p_var = Lookup( p_this, psz_name );
847 vlc_mutex_unlock( &p_priv->var_lock );
848 msg_Err( p_this, "cannot add callback %p to nonexistent "
849 "variable '%s'", pf_callback, psz_name );
853 WaitUnused( p_this, p_var );
854 INSERT_ELEM( p_var->p_entries,
859 vlc_mutex_unlock( &p_priv->var_lock );
864 #undef var_DelCallback
866 * Remove a callback from a variable
868 * pf_callback and p_data have to be given again, because different objects
869 * might have registered the same callback function.
871 int var_DelCallback( vlc_object_t *p_this, const char *psz_name,
872 vlc_callback_t pf_callback, void *p_data )
877 bool b_found_similar = false;
882 vlc_object_internals_t *p_priv = vlc_internals( p_this );
884 vlc_mutex_lock( &p_priv->var_lock );
886 p_var = Lookup( p_this, psz_name );
889 vlc_mutex_unlock( &p_priv->var_lock );
893 WaitUnused( p_this, p_var );
895 for( i_entry = p_var->i_entries ; i_entry-- ; )
897 if( p_var->p_entries[i_entry].pf_callback == pf_callback
898 && p_var->p_entries[i_entry].p_data == p_data )
903 else if( p_var->p_entries[i_entry].pf_callback == pf_callback )
904 b_found_similar = true;
911 if( b_found_similar )
912 fprintf( stderr, "Calling var_DelCallback for '%s' with the same "
913 "function but not the same data.", psz_name );
916 vlc_mutex_unlock( &p_priv->var_lock );
920 REMOVE_ELEM( p_var->p_entries, p_var->i_entries, i_entry );
922 vlc_mutex_unlock( &p_priv->var_lock );
927 #undef var_TriggerCallback
929 * Trigger callback on a variable
931 * \param p_this The object that hold the variable
932 * \param psz_name The name of the variable
934 int var_TriggerCallback( vlc_object_t *p_this, const char *psz_name )
941 vlc_object_internals_t *p_priv = vlc_internals( p_this );
943 vlc_mutex_lock( &p_priv->var_lock );
945 p_var = Lookup( p_this, psz_name );
948 vlc_mutex_unlock( &p_priv->var_lock );
952 WaitUnused( p_this, p_var );
954 /* Deal with callbacks. Tell we're in a callback, release the lock,
955 * call stored functions, retake the lock. */
956 i_ret = TriggerCallback( p_this, p_var, psz_name, p_var->val );
958 vlc_mutex_unlock( &p_priv->var_lock );
962 /** Parse a stringified option
963 * This function parse a string option and create the associated object
965 * The option must be of the form "[no[-]]foo[=bar]" where foo is the
966 * option name and bar is the value of the option.
967 * \param p_obj the object in which the variable must be created
968 * \param psz_option the option to parse
969 * \param trusted whether the option is set by a trusted input or not
972 void var_OptionParse( vlc_object_t *p_obj, const char *psz_option,
975 char *psz_name, *psz_value;
980 val.psz_string = NULL;
982 /* It's too much of a hassle to remove the ':' when we parse
984 if( psz_option[0] == ':' )
990 psz_name = strdup( psz_option );
991 if( psz_name == NULL )
994 psz_value = strchr( psz_name, '=' );
995 if( psz_value != NULL )
998 i_type = config_GetType( p_obj, psz_name );
999 if( !i_type && !psz_value )
1001 /* check for "no-foo" or "nofoo" */
1002 if( !strncmp( psz_name, "no-", 3 ) )
1004 memmove( psz_name, psz_name + 3, strlen(psz_name) + 1 - 3 );
1006 else if( !strncmp( psz_name, "no", 2 ) )
1008 memmove( psz_name, psz_name + 2, strlen(psz_name) + 1 - 2 );
1010 else goto cleanup; /* Option doesn't exist */
1013 i_type = config_GetType( p_obj, psz_name );
1015 if( !i_type ) goto cleanup; /* Option doesn't exist */
1017 if( ( i_type != VLC_VAR_BOOL ) &&
1018 ( !psz_value || !*psz_value ) ) goto cleanup; /* Invalid value */
1020 /* check if option is unsafe */
1021 if( !trusted && !config_IsSafe( psz_name ) )
1023 msg_Err( p_obj, "unsafe option \"%s\" has been ignored for "
1024 "security reasons", psz_name );
1029 /* Create the variable in the input object.
1030 * Children of the input object will be able to retreive this value
1031 * thanks to the inheritance property of the object variables. */
1032 var_Create( p_obj, psz_name, i_type );
1037 val.b_bool = !b_isno;
1040 case VLC_VAR_INTEGER:
1041 val.i_int = strtoll( psz_value, NULL, 0 );
1045 val.f_float = us_atof( psz_value );
1048 case VLC_VAR_STRING:
1049 val.psz_string = psz_value;
1056 var_Set( p_obj, psz_name, val );
1062 #undef var_LocationParse
1064 * Parses a set of colon-separated or semicolon-separated
1065 * <variable name>=<value> pairs.
1066 * Some access (or access_demux) plugins uses this scheme
1067 * in media resource location.
1068 * @note Only trusted/safe variables are allowed. This is intended.
1070 * @warning Only use this for plugins implementing VLC-specific resource
1071 * location schemes. This would not make any sense for standardized ones.
1073 * @param obj VLC object on which to set variables (and emit error messages)
1074 * @param mrl string to parse
1075 * @param pref prefix to prepend to option names in the string
1077 * @return VLC_ENOMEM on error, VLC_SUCCESS on success.
1079 int var_LocationParse (vlc_object_t *obj, const char *mrl, const char *pref)
1081 int ret = VLC_SUCCESS;
1082 size_t preflen = strlen (pref) + 1;
1084 assert(mrl != NULL);
1085 while (*mrl != '\0')
1087 mrl += strspn (mrl, ":;"); /* skip leading colon(s) */
1089 size_t len = strcspn (mrl, ":;");
1090 char *buf = malloc (preflen + len);
1092 if (likely(buf != NULL))
1094 /* NOTE: this does not support the "no-<varname>" bool syntax. */
1095 /* DO NOT use asprintf() here; it won't work! Think again. */
1096 snprintf (buf, preflen + len, "%s%s", pref, mrl);
1097 var_OptionParse (obj, buf, false);
1109 * Waits until the variable is inactive (i.e. not executing a callback)
1111 static void WaitUnused( vlc_object_t *p_this, variable_t *p_var )
1113 vlc_object_internals_t *p_priv = vlc_internals( p_this );
1115 mutex_cleanup_push( &p_priv->var_lock );
1116 while( p_var->b_incallback )
1117 vlc_cond_wait( &p_priv->var_wait, &p_priv->var_lock );
1121 /*****************************************************************************
1122 * CheckValue: check that a value is valid wrt. a variable
1123 *****************************************************************************
1124 * This function checks p_val's value against p_var's limitations such as
1125 * minimal and maximal value, step, in-list position, and modifies p_val if
1127 ****************************************************************************/
1128 static void CheckValue ( variable_t *p_var, vlc_value_t *p_val )
1130 /* Check that our variable is in the list */
1131 if( p_var->i_type & VLC_VAR_HASCHOICE && p_var->choices.i_count )
1135 /* This list is not sorted so go throug it (this is a small list) */
1136 for( i = p_var->choices.i_count ; i-- ; )
1138 if( p_var->ops->pf_cmp( *p_val, p_var->choices.p_values[i] ) == 0 )
1144 /* If not found, change it to anything vaguely valid */
1147 /* Free the old variable, get the new one, dup it */
1148 p_var->ops->pf_free( p_val );
1149 *p_val = p_var->choices.p_values[p_var->i_default >= 0
1150 ? p_var->i_default : 0 ];
1151 p_var->ops->pf_dup( p_val );
1155 /* Check that our variable is within the bounds */
1156 switch( p_var->i_type & VLC_VAR_TYPE )
1158 case VLC_VAR_INTEGER:
1159 if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.i_int
1160 && (p_val->i_int % p_var->step.i_int) )
1162 p_val->i_int = (p_val->i_int + (p_var->step.i_int / 2))
1163 / p_var->step.i_int * p_var->step.i_int;
1165 if( p_var->i_type & VLC_VAR_HASMIN
1166 && p_val->i_int < p_var->min.i_int )
1168 p_val->i_int = p_var->min.i_int;
1170 if( p_var->i_type & VLC_VAR_HASMAX
1171 && p_val->i_int > p_var->max.i_int )
1173 p_val->i_int = p_var->max.i_int;
1177 if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.f_float )
1179 float f_round = p_var->step.f_float * (float)(int)( 0.5 +
1180 p_val->f_float / p_var->step.f_float );
1181 if( p_val->f_float != f_round )
1183 p_val->f_float = f_round;
1186 if( p_var->i_type & VLC_VAR_HASMIN
1187 && p_val->f_float < p_var->min.f_float )
1189 p_val->f_float = p_var->min.f_float;
1191 if( p_var->i_type & VLC_VAR_HASMAX
1192 && p_val->f_float > p_var->max.f_float )
1194 p_val->f_float = p_var->max.f_float;
1204 * Finds the value of a variable. If the specified object does not hold a
1205 * variable with the specified name, try the parent object, and iterate until
1206 * the top of the tree. If no match is found, the value is read from the
1209 int var_Inherit( vlc_object_t *p_this, const char *psz_name, int i_type,
1210 vlc_value_t *p_val )
1212 i_type &= VLC_VAR_CLASS;
1213 for( vlc_object_t *obj = p_this; obj != NULL; obj = obj->p_parent )
1215 if( var_GetChecked( obj, psz_name, i_type, p_val ) == VLC_SUCCESS )
1219 /* else take value from config */
1220 switch( i_type & VLC_VAR_CLASS )
1222 case VLC_VAR_STRING:
1223 p_val->psz_string = config_GetPsz( p_this, psz_name );
1224 if( !p_val->psz_string ) p_val->psz_string = strdup("");
1227 p_val->f_float = config_GetFloat( p_this, psz_name );
1229 case VLC_VAR_INTEGER:
1230 p_val->i_int = config_GetInt( p_this, psz_name );
1233 p_val->b_bool = config_GetInt( p_this, psz_name );
1235 case VLC_VAR_ADDRESS:
1238 msg_Warn( p_this, "Could not inherit value for var %s "
1239 "from config. Invalid Type", psz_name );
1242 /*msg_Dbg( p_this, "Inherited value for var %s from config", psz_name );*/
1248 * It inherits a string as an unsigned rational number (it also accepts basic
1251 * It returns an error if the rational number cannot be parsed (0/0 is valid).
1252 * The rational is already reduced.
1254 int (var_InheritURational)(vlc_object_t *object,
1255 unsigned *num, unsigned *den,
1263 char *tmp = var_InheritString(object, var);
1268 unsigned n = strtol(tmp, &next, 0);
1269 unsigned d = strtol(*next ? &next[1] : "0", NULL, 0);
1272 /* Interpret as a float number */
1273 double r = us_atof(tmp);
1288 vlc_ureduce(num, den, n, d, 0);
1295 return VLC_EGENERIC;
1298 /**********************************************************************
1299 * Trigger the callbacks.
1300 * Tell we're in a callback, release the lock, call stored functions,
1302 **********************************************************************/
1303 static int TriggerCallback( vlc_object_t *p_this, variable_t *p_var,
1304 const char *psz_name, vlc_value_t oldval )
1308 int i_entries = p_var->i_entries;
1309 if( i_entries == 0 )
1312 callback_entry_t *p_entries = p_var->p_entries;
1313 vlc_object_internals_t *p_priv = vlc_internals( p_this );
1315 assert( !p_var->b_incallback );
1316 p_var->b_incallback = true;
1317 vlc_mutex_unlock( &p_priv->var_lock );
1319 /* The real calls */
1320 for( ; i_entries-- ; )
1322 p_entries[i_entries].pf_callback( p_this, psz_name, oldval, p_var->val,
1323 p_entries[i_entries].p_data );
1326 vlc_mutex_lock( &p_priv->var_lock );
1327 p_var->b_incallback = false;
1328 vlc_cond_broadcast( &p_priv->var_wait );
1334 /**********************************************************************
1335 * Execute a var command on an object identified by its name
1336 **********************************************************************/
1337 int var_Command( vlc_object_t *p_this, const char *psz_name,
1338 const char *psz_cmd, const char *psz_arg, char **psz_msg )
1340 vlc_object_t *p_obj = vlc_object_find_name( p_this->p_libvlc,
1347 *psz_msg = strdup( "Unknown destination object." );
1351 i_type = var_Type( p_obj, psz_cmd );
1352 if( !( i_type&VLC_VAR_ISCOMMAND ) )
1354 vlc_object_release( p_obj );
1356 *psz_msg = strdup( "Variable doesn't exist or isn't a command." );
1357 return VLC_EGENERIC;
1360 i_type &= VLC_VAR_CLASS;
1363 case VLC_VAR_INTEGER:
1364 i_ret = var_SetInteger( p_obj, psz_cmd, atoi( psz_arg ) );
1367 i_ret = var_SetFloat( p_obj, psz_cmd, us_atof( psz_arg ) );
1369 case VLC_VAR_STRING:
1370 i_ret = var_SetString( p_obj, psz_cmd, psz_arg );
1373 i_ret = var_SetBool( p_obj, psz_cmd, atoi( psz_arg ) );
1376 i_ret = VLC_EGENERIC;
1380 vlc_object_release( p_obj );
1384 if( asprintf( psz_msg, "%s on object %s returned %i (%s)",
1385 psz_cmd, psz_name, i_ret, vlc_error( i_ret ) ) == -1)
1394 * Free a list and the associated strings
1395 * @param p_val: the list variable
1396 * @param p_val2: the variable associated or NULL
1398 void var_FreeList( vlc_value_t *p_val, vlc_value_t *p_val2 )
1401 if( p_val2 && p_val2->p_list )
1403 for( int i = 0; i < p_val2->p_list->i_count; i++ )
1404 free( p_val2->p_list->p_values[i].psz_string );
1405 if( p_val2->p_list->i_count )
1407 free( p_val2->p_list->p_values );
1408 free( p_val2->p_list->pi_types );
1410 free( p_val2->p_list );