1 /*****************************************************************************
2 * variables.c: routines for object variables handling
3 *****************************************************************************
4 * Copyright (C) 2002-2006 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 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 General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_common.h>
32 #include "variables.h"
36 #include "vlc_interface.h"
38 /*****************************************************************************
40 *****************************************************************************/
41 struct callback_entry_t
43 vlc_callback_t pf_callback;
47 /*****************************************************************************
48 * Local comparison functions, returns 0 if v == w, < 0 if v < w, > 0 if v > w
49 *****************************************************************************/
50 static int CmpBool( vlc_value_t v, vlc_value_t w ) { return v.b_bool ? w.b_bool ? 0 : 1 : w.b_bool ? -1 : 0; }
51 static int CmpInt( vlc_value_t v, vlc_value_t w ) { return v.i_int == w.i_int ? 0 : v.i_int > w.i_int ? 1 : -1; }
52 static int CmpTime( vlc_value_t v, vlc_value_t w )
54 return v.i_time == w.i_time ? 0 : v.i_time > w.i_time ? 1 : -1;
56 static int CmpString( vlc_value_t v, vlc_value_t w )
59 return !w.psz_string ? 0 : -1;
61 return !w.psz_string ? 1 : strcmp( v.psz_string, w.psz_string );
63 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; }
64 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; }
66 /*****************************************************************************
67 * Local duplication functions, and local deallocation functions
68 *****************************************************************************/
69 static void DupDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
70 static void DupString( vlc_value_t *p_val ) { if( p_val->psz_string ) p_val->psz_string = strdup( p_val->psz_string ); }
72 static void DupList( vlc_value_t *p_val )
75 vlc_list_t *p_list = malloc( sizeof(vlc_list_t) );
77 p_list->i_count = p_val->p_list->i_count;
78 if( p_val->p_list->i_count )
80 p_list->p_values = malloc( p_list->i_count * sizeof(vlc_value_t) );
81 p_list->pi_types = malloc( p_list->i_count * sizeof(int) );
85 p_list->p_values = NULL;
86 p_list->pi_types = NULL;
89 for( i = 0; i < p_list->i_count; i++ )
91 p_list->p_values[i] = p_val->p_list->p_values[i];
92 p_list->pi_types[i] = p_val->p_list->pi_types[i];
93 switch( p_val->p_list->pi_types[i] & VLC_VAR_TYPE )
97 DupString( &p_list->p_values[i] );
104 p_val->p_list = p_list;
107 static void FreeDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
108 static void FreeString( vlc_value_t *p_val ) { free( p_val->psz_string ); }
109 static void FreeMutex( vlc_value_t *p_val ) { vlc_mutex_destroy( (vlc_mutex_t*)p_val->p_address ); free( p_val->p_address ); }
111 static void FreeList( vlc_value_t *p_val )
114 for( i = 0; i < p_val->p_list->i_count; i++ )
116 switch( p_val->p_list->pi_types[i] & VLC_VAR_TYPE )
119 FreeString( &p_val->p_list->p_values[i] );
122 FreeMutex( &p_val->p_list->p_values[i] );
129 if( p_val->p_list->i_count )
131 free( p_val->p_list->p_values );
132 free( p_val->p_list->pi_types );
134 free( p_val->p_list );
137 /*****************************************************************************
139 *****************************************************************************/
140 static int GetUnused ( vlc_object_t *, const char * );
141 static uint32_t HashString ( const char * );
142 static int Insert ( variable_t *, int, const char * );
143 static int InsertInner ( variable_t *, int, uint32_t );
144 static int Lookup ( variable_t *, int, const char * );
145 static int LookupInner ( variable_t *, int, uint32_t );
147 static void CheckValue ( variable_t *, vlc_value_t * );
149 static int InheritValue( vlc_object_t *, const char *, vlc_value_t *,
153 * Initialize a vlc variable
155 * We hash the given string and insert it into the sorted list. The insertion
156 * may require slow memory copies, but think about what we gain in the log(n)
157 * lookup phase when setting/getting the variable value!
159 * \param p_this The object in which to create the variable
160 * \param psz_name The name of the variable
161 * \param i_type The variables type. Must be one of \ref var_type combined with
162 * zero or more \ref var_flags
164 int __var_Create( vlc_object_t *p_this, const char *psz_name, int i_type )
168 static vlc_list_t dummy_null_list = {0, NULL, NULL};
169 vlc_object_internals_t *p_priv = vlc_internals( p_this );
171 vlc_refcheck( p_this );
172 vlc_mutex_lock( &p_priv->var_lock );
174 /* FIXME: if the variable already exists, we don't duplicate it. But we
175 * duplicate the lookups. It's not that serious, but if anyone finds some
176 * time to rework Insert() so that only one lookup has to be done, feel
178 i_new = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
182 /* If the types differ, variable creation failed. */
183 if( (i_type & ~(VLC_VAR_DOINHERIT|VLC_VAR_ISCOMMAND)) != p_priv->p_vars[i_new].i_type )
185 vlc_mutex_unlock( &p_priv->var_lock );
189 p_priv->p_vars[i_new].i_usage++;
190 if( i_type & VLC_VAR_ISCOMMAND )
191 p_priv->p_vars[i_new].i_type |= VLC_VAR_ISCOMMAND;
192 vlc_mutex_unlock( &p_priv->var_lock );
196 i_new = Insert( p_priv->p_vars, p_priv->i_vars, psz_name );
198 if( (p_priv->i_vars & 15) == 15 )
200 p_priv->p_vars = realloc( p_priv->p_vars,
201 (p_priv->i_vars+17) * sizeof(variable_t) );
204 memmove( p_priv->p_vars + i_new + 1,
205 p_priv->p_vars + i_new,
206 (p_priv->i_vars - i_new) * sizeof(variable_t) );
210 p_var = &p_priv->p_vars[i_new];
211 memset( p_var, 0, sizeof(*p_var) );
213 p_var->i_hash = HashString( psz_name );
214 p_var->psz_name = strdup( psz_name );
215 p_var->psz_text = NULL;
217 p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
218 memset( &p_var->val, 0, sizeof(vlc_value_t) );
220 p_var->pf_dup = DupDummy;
221 p_var->pf_free = FreeDummy;
225 p_var->i_default = -1;
226 p_var->choices.i_count = 0;
227 p_var->choices.p_values = NULL;
228 p_var->choices_text.i_count = 0;
229 p_var->choices_text.p_values = NULL;
231 p_var->b_incallback = false;
232 p_var->i_entries = 0;
233 p_var->p_entries = NULL;
235 /* Always initialize the variable, even if it is a list variable; this
236 * will lead to errors if the variable is not initialized, but it will
237 * not cause crashes in the variable handling. */
238 switch( i_type & VLC_VAR_TYPE )
241 p_var->pf_cmp = CmpBool;
242 p_var->val.b_bool = false;
244 case VLC_VAR_INTEGER:
246 p_var->pf_cmp = CmpInt;
247 p_var->val.i_int = 0;
252 case VLC_VAR_DIRECTORY:
253 case VLC_VAR_VARIABLE:
254 p_var->pf_cmp = CmpString;
255 p_var->pf_dup = DupString;
256 p_var->pf_free = FreeString;
257 p_var->val.psz_string = NULL;
260 p_var->pf_cmp = CmpFloat;
261 p_var->val.f_float = 0.0;
264 p_var->pf_cmp = CmpTime;
265 p_var->val.i_time = 0;
267 case VLC_VAR_ADDRESS:
268 p_var->pf_cmp = CmpAddress;
269 p_var->val.p_address = NULL;
272 p_var->pf_cmp = CmpAddress;
273 p_var->pf_free = FreeMutex;
274 p_var->val.p_address = malloc( sizeof(vlc_mutex_t) );
275 vlc_mutex_init( (vlc_mutex_t*)p_var->val.p_address );
278 p_var->pf_cmp = CmpAddress;
279 p_var->pf_dup = DupList;
280 p_var->pf_free = FreeList;
281 p_var->val.p_list = &dummy_null_list;
285 /* Duplicate the default data we stored. */
286 p_var->pf_dup( &p_var->val );
288 if( i_type & VLC_VAR_DOINHERIT )
292 if( InheritValue( p_this, psz_name, &val, p_var->i_type )
295 /* Free data if needed */
296 p_var->pf_free( &p_var->val );
297 /* Set the variable */
300 if( i_type & VLC_VAR_HASCHOICE )
302 /* We must add the inherited value to our choice list */
303 p_var->i_default = 0;
305 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
307 INSERT_ELEM( p_var->choices_text.p_values,
308 p_var->choices_text.i_count, 0, val );
309 p_var->pf_dup( &p_var->choices.p_values[0] );
310 p_var->choices_text.p_values[0].psz_string = NULL;
315 vlc_mutex_unlock( &p_priv->var_lock );
321 * Destroy a vlc variable
323 * Look for the variable and destroy it if it is found. As in var_Create we
324 * do a call to memmove() but we have performance counterparts elsewhere.
326 * \param p_this The object that holds the variable
327 * \param psz_name The name of the variable
329 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_refcheck( p_this );
336 vlc_mutex_lock( &p_priv->var_lock );
338 i_var = GetUnused( p_this, psz_name );
341 vlc_mutex_unlock( &p_priv->var_lock );
345 p_var = &p_priv->p_vars[i_var];
347 if( p_var->i_usage > 1 )
350 vlc_mutex_unlock( &p_priv->var_lock );
354 /* Free value if needed */
355 p_var->pf_free( &p_var->val );
357 /* Free choice list if needed */
358 if( p_var->choices.i_count )
360 for( i = 0 ; i < p_var->choices.i_count ; i++ )
362 p_var->pf_free( &p_var->choices.p_values[i] );
363 free( p_var->choices_text.p_values[i].psz_string );
365 free( p_var->choices.p_values );
366 free( p_var->choices_text.p_values );
369 /* Free callbacks if needed */
370 if( p_var->p_entries )
372 free( p_var->p_entries );
375 free( p_var->psz_name );
376 free( p_var->psz_text );
378 memmove( p_priv->p_vars + i_var,
379 p_priv->p_vars + i_var + 1,
380 (p_priv->i_vars - i_var - 1) * sizeof(variable_t) );
382 if( (p_priv->i_vars & 15) == 0 )
384 p_priv->p_vars = realloc( p_priv->p_vars,
385 (p_priv->i_vars) * sizeof( variable_t ) );
390 vlc_mutex_unlock( &p_priv->var_lock );
396 * Perform an action on a variable
398 * \param p_this The object that holds the variable
399 * \param psz_name The name of the variable
400 * \param i_action The action to perform. Must be one of \ref var_action
401 * \param p_val First action parameter
402 * \param p_val2 Second action parameter
404 int __var_Change( vlc_object_t *p_this, const char *psz_name,
405 int i_action, vlc_value_t *p_val, vlc_value_t *p_val2 )
410 vlc_object_internals_t *p_priv = vlc_internals( p_this );
412 vlc_refcheck( p_this );
413 vlc_mutex_lock( &p_priv->var_lock );
415 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
419 vlc_mutex_unlock( &p_priv->var_lock );
423 p_var = &p_priv->p_vars[i_var];
428 if( p_var->i_type & VLC_VAR_HASMIN )
430 p_var->pf_free( &p_var->min );
432 p_var->i_type |= VLC_VAR_HASMIN;
434 p_var->pf_dup( &p_var->min );
435 CheckValue( p_var, &p_var->val );
438 if( p_var->i_type & VLC_VAR_HASMIN )
444 if( p_var->i_type & VLC_VAR_HASMAX )
446 p_var->pf_free( &p_var->max );
448 p_var->i_type |= VLC_VAR_HASMAX;
450 p_var->pf_dup( &p_var->max );
451 CheckValue( p_var, &p_var->val );
454 if( p_var->i_type & VLC_VAR_HASMAX )
459 case VLC_VAR_SETSTEP:
460 if( p_var->i_type & VLC_VAR_HASSTEP )
462 p_var->pf_free( &p_var->step );
464 p_var->i_type |= VLC_VAR_HASSTEP;
465 p_var->step = *p_val;
466 p_var->pf_dup( &p_var->step );
467 CheckValue( p_var, &p_var->val );
469 case VLC_VAR_GETSTEP:
470 if( p_var->i_type & VLC_VAR_HASSTEP )
472 *p_val = p_var->step;
475 case VLC_VAR_ADDCHOICE:
476 /* FIXME: the list is sorted, dude. Use something cleverer. */
477 for( i = p_var->choices.i_count ; i-- ; )
479 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) < 0 )
485 /* The new place is i+1 */
488 if( p_var->i_default >= i )
493 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
495 INSERT_ELEM( p_var->choices_text.p_values,
496 p_var->choices_text.i_count, i, *p_val );
497 p_var->pf_dup( &p_var->choices.p_values[i] );
498 p_var->choices_text.p_values[i].psz_string =
499 ( p_val2 && p_val2->psz_string ) ?
500 strdup( p_val2->psz_string ) : NULL;
502 CheckValue( p_var, &p_var->val );
504 case VLC_VAR_DELCHOICE:
505 /* FIXME: the list is sorted, dude. Use something cleverer. */
506 for( i = 0 ; i < p_var->choices.i_count ; i++ )
508 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
514 if( i == p_var->choices.i_count )
517 vlc_mutex_unlock( &p_priv->var_lock );
521 if( p_var->i_default > i )
525 else if( p_var->i_default == i )
527 p_var->i_default = -1;
530 p_var->pf_free( &p_var->choices.p_values[i] );
531 free( p_var->choices_text.p_values[i].psz_string );
532 REMOVE_ELEM( p_var->choices.p_values, p_var->choices.i_count, i );
533 REMOVE_ELEM( p_var->choices_text.p_values,
534 p_var->choices_text.i_count, i );
536 CheckValue( p_var, &p_var->val );
538 case VLC_VAR_CHOICESCOUNT:
539 p_val->i_int = p_var->choices.i_count;
541 case VLC_VAR_CLEARCHOICES:
542 for( i = 0 ; i < p_var->choices.i_count ; i++ )
544 p_var->pf_free( &p_var->choices.p_values[i] );
546 for( i = 0 ; i < p_var->choices_text.i_count ; i++ )
547 free( p_var->choices_text.p_values[i].psz_string );
549 if( p_var->choices.i_count ) free( p_var->choices.p_values );
550 if( p_var->choices_text.i_count ) free( p_var->choices_text.p_values );
552 p_var->choices.i_count = 0;
553 p_var->choices.p_values = NULL;
554 p_var->choices_text.i_count = 0;
555 p_var->choices_text.p_values = NULL;
556 p_var->i_default = -1;
558 case VLC_VAR_SETDEFAULT:
559 /* FIXME: the list is sorted, dude. Use something cleverer. */
560 for( i = 0 ; i < p_var->choices.i_count ; i++ )
562 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
568 if( i == p_var->choices.i_count )
574 p_var->i_default = i;
575 CheckValue( p_var, &p_var->val );
577 case VLC_VAR_SETVALUE:
578 /* Duplicate data if needed */
579 p_var->pf_dup( p_val );
580 /* Backup needed stuff */
582 /* Check boundaries and list */
583 CheckValue( p_var, p_val );
584 /* Set the variable */
586 /* Free data if needed */
587 p_var->pf_free( &oldval );
589 case VLC_VAR_GETCHOICES:
590 case VLC_VAR_GETLIST:
591 p_val->p_list = malloc( sizeof(vlc_list_t) );
592 if( p_val2 ) p_val2->p_list = malloc( sizeof(vlc_list_t) );
593 if( p_var->choices.i_count )
595 p_val->p_list->p_values = malloc( p_var->choices.i_count
596 * sizeof(vlc_value_t) );
597 p_val->p_list->pi_types = malloc( p_var->choices.i_count
601 p_val2->p_list->p_values =
602 malloc( p_var->choices.i_count * sizeof(vlc_value_t) );
603 p_val2->p_list->pi_types =
604 malloc( p_var->choices.i_count * sizeof(int) );
607 p_val->p_list->i_count = p_var->choices.i_count;
608 if( p_val2 ) p_val2->p_list->i_count = p_var->choices.i_count;
609 for( i = 0 ; i < p_var->choices.i_count ; i++ )
611 p_val->p_list->p_values[i] = p_var->choices.p_values[i];
612 p_val->p_list->pi_types[i] = p_var->i_type;
613 p_var->pf_dup( &p_val->p_list->p_values[i] );
616 p_val2->p_list->p_values[i].psz_string =
617 p_var->choices_text.p_values[i].psz_string ?
618 strdup(p_var->choices_text.p_values[i].psz_string) : NULL;
619 p_val2->p_list->pi_types[i] = VLC_VAR_STRING;
623 case VLC_VAR_FREELIST:
625 if( p_val2 && p_val2->p_list )
627 for( i = 0; i < p_val2->p_list->i_count; i++ )
628 free( p_val2->p_list->p_values[i].psz_string );
629 if( p_val2->p_list->i_count )
631 free( p_val2->p_list->p_values );
632 free( p_val2->p_list->pi_types );
634 free( p_val2->p_list );
637 case VLC_VAR_SETTEXT:
638 free( p_var->psz_text );
639 if( p_val && p_val->psz_string )
640 p_var->psz_text = strdup( p_val->psz_string );
642 case VLC_VAR_GETTEXT:
643 p_val->psz_string = NULL;
644 if( p_var->psz_text )
646 p_val->psz_string = strdup( p_var->psz_text );
649 case VLC_VAR_INHERITVALUE:
653 if( InheritValue( p_this,
654 p_val2 ? p_val2->psz_string : psz_name,
655 &val, p_var->i_type )
658 /* Duplicate already done */
660 /* Backup needed stuff */
662 /* Check boundaries and list */
663 CheckValue( p_var, &val );
664 /* Set the variable */
666 /* Free data if needed */
667 p_var->pf_free( &oldval );
673 p_var->pf_dup( p_val );
677 case VLC_VAR_TRIGGER_CALLBACKS:
679 /* Deal with callbacks. Tell we're in a callback, release the lock,
680 * call stored functions, retake the lock. */
681 if( p_var->i_entries )
684 int i_entries = p_var->i_entries;
685 callback_entry_t *p_entries = p_var->p_entries;
687 p_var->b_incallback = true;
688 vlc_mutex_unlock( &p_priv->var_lock );
691 for( ; i_entries-- ; )
693 p_entries[i_entries].pf_callback( p_this, psz_name, p_var->val, p_var->val,
694 p_entries[i_entries].p_data );
697 vlc_mutex_lock( &p_priv->var_lock );
699 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
702 msg_Err( p_this, "variable %s has disappeared", psz_name );
703 vlc_mutex_unlock( &p_priv->var_lock );
707 p_var = &p_priv->p_vars[i_var];
708 p_var->b_incallback = false;
713 case VLC_VAR_SETISCOMMAND:
714 p_var->i_type |= VLC_VAR_ISCOMMAND;
721 vlc_mutex_unlock( &p_priv->var_lock );
727 * Request a variable's type
729 * \return The variable type if it exists, or 0 if the
730 * variable could not be found.
733 int __var_Type( vlc_object_t *p_this, const char *psz_name )
736 vlc_object_internals_t *p_priv = vlc_internals( p_this );
738 vlc_mutex_lock( &p_priv->var_lock );
740 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
744 vlc_mutex_unlock( &p_priv->var_lock );
748 i_type = p_priv->p_vars[i_var].i_type;
750 vlc_mutex_unlock( &p_priv->var_lock );
756 * Set a variable's value
758 * \param p_this The object that hold the variable
759 * \param psz_name The name of the variable
760 * \param val the value to set
762 int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val )
767 vlc_object_internals_t *p_priv = vlc_internals( p_this );
769 vlc_refcheck( p_this );
770 vlc_mutex_lock( &p_priv->var_lock );
772 i_var = GetUnused( p_this, psz_name );
775 vlc_mutex_unlock( &p_priv->var_lock );
779 p_var = &p_priv->p_vars[i_var];
781 /* Duplicate data if needed */
782 p_var->pf_dup( &val );
784 /* Backup needed stuff */
787 /* Check boundaries and list */
788 CheckValue( p_var, &val );
790 /* Set the variable */
793 /* Deal with callbacks. Tell we're in a callback, release the lock,
794 * call stored functions, retake the lock. */
795 if( p_var->i_entries )
798 int i_entries = p_var->i_entries;
799 callback_entry_t *p_entries = p_var->p_entries;
801 p_var->b_incallback = true;
802 vlc_mutex_unlock( &p_priv->var_lock );
805 for( ; i_entries-- ; )
807 p_entries[i_entries].pf_callback( p_this, psz_name, oldval, val,
808 p_entries[i_entries].p_data );
811 vlc_mutex_lock( &p_priv->var_lock );
813 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
816 msg_Err( p_this, "variable %s has disappeared", psz_name );
817 vlc_mutex_unlock( &p_priv->var_lock );
821 p_var = &p_priv->p_vars[i_var];
822 p_var->b_incallback = false;
825 /* Free data if needed */
826 p_var->pf_free( &oldval );
828 vlc_mutex_unlock( &p_priv->var_lock );
834 * Get a variable's value
836 * \param p_this The object that holds the variable
837 * \param psz_name The name of the variable
838 * \param p_val Pointer to a vlc_value_t that will hold the variable's value
839 * after the function is finished
841 int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
845 vlc_object_internals_t *p_priv = vlc_internals( p_this );
847 vlc_refcheck( p_this );
848 vlc_mutex_lock( &p_priv->var_lock );
850 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
854 vlc_mutex_unlock( &p_priv->var_lock );
858 p_var = &p_priv->p_vars[i_var];
860 /* Really get the variable */
863 /* Duplicate value if needed */
864 p_var->pf_dup( p_val );
866 vlc_mutex_unlock( &p_priv->var_lock );
873 * Finds a process-wide mutex, creates it if needed, and locks it.
874 * Unlock with vlc_mutex_unlock().
876 vlc_mutex_t *var_AcquireMutex( const char *name )
878 libvlc_global_data_t *p_global = vlc_global();
881 if( var_Create( p_global, name, VLC_VAR_MUTEX ) )
884 var_Get( p_global, name, &val );
885 vlc_mutex_lock( val.p_address );
886 return val.p_address;
891 * Register a callback in a variable
893 * We store a function pointer that will be called upon variable
896 * \param p_this The object that holds the variable
897 * \param psz_name The name of the variable
898 * \param pf_callback The function pointer
899 * \param p_data A generic pointer that will be passed as the last
900 * argument to the callback function.
902 * \warning The callback function is run in the thread that calls var_Set on
903 * the variable. Use proper locking. This thread may not have much
904 * time to spare, so keep callback functions short.
906 int __var_AddCallback( vlc_object_t *p_this, const char *psz_name,
907 vlc_callback_t pf_callback, void *p_data )
911 callback_entry_t entry;
912 vlc_object_internals_t *p_priv = vlc_internals( p_this );
914 vlc_refcheck( p_this );
915 entry.pf_callback = pf_callback;
916 entry.p_data = p_data;
918 vlc_mutex_lock( &p_priv->var_lock );
920 i_var = GetUnused( p_this, psz_name );
923 vlc_mutex_unlock( &p_priv->var_lock );
927 p_var = &p_priv->p_vars[i_var];
929 INSERT_ELEM( p_var->p_entries,
934 vlc_mutex_unlock( &p_priv->var_lock );
940 * Remove a callback from a variable
942 * pf_callback and p_data have to be given again, because different objects
943 * might have registered the same callback function.
945 int __var_DelCallback( vlc_object_t *p_this, const char *psz_name,
946 vlc_callback_t pf_callback, void *p_data )
950 vlc_object_internals_t *p_priv = vlc_internals( p_this );
952 vlc_refcheck( p_this );
953 vlc_mutex_lock( &p_priv->var_lock );
955 i_var = GetUnused( p_this, psz_name );
958 vlc_mutex_unlock( &p_priv->var_lock );
962 p_var = &p_priv->p_vars[i_var];
964 for( i_entry = p_var->i_entries ; i_entry-- ; )
966 if( p_var->p_entries[i_entry].pf_callback == pf_callback
967 && p_var->p_entries[i_entry].p_data == p_data )
975 vlc_mutex_unlock( &p_priv->var_lock );
979 REMOVE_ELEM( p_var->p_entries, p_var->i_entries, i_entry );
981 vlc_mutex_unlock( &p_priv->var_lock );
987 * Trigger callback on a variable
989 * \param p_this The object that hold the variable
990 * \param psz_name The name of the variable
992 int __var_TriggerCallback( vlc_object_t *p_this, const char *psz_name )
997 vlc_object_internals_t *p_priv = vlc_internals( p_this );
999 vlc_mutex_lock( &p_priv->var_lock );
1001 i_var = GetUnused( p_this, psz_name );
1004 vlc_mutex_unlock( &p_priv->var_lock );
1008 p_var = &p_priv->p_vars[i_var];
1010 /* Backup needed stuff */
1011 oldval = p_var->val;
1013 /* Deal with callbacks. Tell we're in a callback, release the lock,
1014 * call stored functions, retake the lock. */
1015 if( p_var->i_entries )
1018 int i_entries = p_var->i_entries;
1019 callback_entry_t *p_entries = p_var->p_entries;
1021 p_var->b_incallback = true;
1022 vlc_mutex_unlock( &p_priv->var_lock );
1024 /* The real calls */
1025 for( ; i_entries-- ; )
1027 p_entries[i_entries].pf_callback( p_this, psz_name, oldval, oldval,
1028 p_entries[i_entries].p_data );
1031 vlc_mutex_lock( &p_priv->var_lock );
1033 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1036 msg_Err( p_this, "variable %s has disappeared", psz_name );
1037 vlc_mutex_unlock( &p_priv->var_lock );
1041 p_var = &p_priv->p_vars[i_var];
1042 p_var->b_incallback = false;
1045 vlc_mutex_unlock( &p_priv->var_lock );
1049 /** Parse a stringified option
1050 * This function parse a string option and create the associated object
1052 * The option must be of the form "[no[-]]foo[=bar]" where foo is the
1053 * option name and bar is the value of the option.
1054 * \param p_obj the object in which the variable must be created
1055 * \param psz_option the option to parse
1056 * \param trusted whether the option is set by a trusted input or not
1059 void var_OptionParse( vlc_object_t *p_obj, const char *psz_option,
1062 char *psz_name, *psz_value;
1064 bool b_isno = false;
1067 val.psz_string = NULL;
1069 /* It's too much of a hassle to remove the ':' when we parse
1070 * the cmd line :) */
1071 if( psz_option[0] == ':' )
1074 if( !psz_option[0] )
1077 psz_name = strdup( psz_option );
1078 if( psz_name == NULL )
1081 psz_value = strchr( psz_name, '=' );
1082 if( psz_value != NULL )
1083 *psz_value++ = '\0';
1085 /* FIXME: :programs should be handled generically */
1086 if( !strcmp( psz_name, "programs" ) )
1087 i_type = VLC_VAR_LIST;
1089 i_type = config_GetType( p_obj, psz_name );
1091 if( !i_type && !psz_value )
1093 /* check for "no-foo" or "nofoo" */
1094 if( !strncmp( psz_name, "no-", 3 ) )
1096 memmove( psz_name, psz_name + 3, strlen(psz_name) + 1 - 3 );
1098 else if( !strncmp( psz_name, "no", 2 ) )
1100 memmove( psz_name, psz_name + 2, strlen(psz_name) + 1 - 2 );
1102 else goto cleanup; /* Option doesn't exist */
1105 i_type = config_GetType( p_obj, psz_name );
1107 if( !i_type ) goto cleanup; /* Option doesn't exist */
1109 if( ( i_type != VLC_VAR_BOOL ) &&
1110 ( !psz_value || !*psz_value ) ) goto cleanup; /* Invalid value */
1112 /* check if option is unsafe */
1115 module_config_t *p_config = config_FindConfig( p_obj, psz_name );
1116 if( !p_config->b_safe )
1118 msg_Err( p_obj, "unsafe option \"%s\" has been ignored for "
1119 "security reasons", psz_name );
1124 /* Create the variable in the input object.
1125 * Children of the input object will be able to retreive this value
1126 * thanks to the inheritance property of the object variables. */
1127 var_Create( p_obj, psz_name, i_type );
1132 val.b_bool = !b_isno;
1135 case VLC_VAR_INTEGER:
1136 val.i_int = strtol( psz_value, NULL, 0 );
1140 val.f_float = atof( psz_value );
1143 case VLC_VAR_STRING:
1144 case VLC_VAR_MODULE:
1146 case VLC_VAR_DIRECTORY:
1147 val.psz_string = psz_value;
1152 char *psz_orig, *psz_var;
1153 vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1154 val.p_list = p_list;
1155 p_list->i_count = 0;
1157 psz_var = psz_orig = strdup(psz_value);
1158 while( psz_var && *psz_var )
1160 char *psz_item = psz_var;
1162 while( *psz_var && *psz_var != ',' ) psz_var++;
1163 if( *psz_var == ',' )
1168 val2.i_int = strtol( psz_item, NULL, 0 );
1169 INSERT_ELEM( p_list->p_values, p_list->i_count,
1170 p_list->i_count, val2 );
1171 /* p_list->i_count is incremented twice by INSERT_ELEM */
1173 INSERT_ELEM( p_list->pi_types, p_list->i_count,
1174 p_list->i_count, VLC_VAR_INTEGER );
1184 var_Set( p_obj, psz_name, val );
1191 /* Following functions are local */
1193 /*****************************************************************************
1194 * GetUnused: find an unused variable from its name
1195 *****************************************************************************
1196 * We do i_tries tries before giving up, just in case the variable is being
1197 * modified and called from a callback.
1198 *****************************************************************************/
1199 static int GetUnused( vlc_object_t *p_this, const char *psz_name )
1201 int i_var, i_tries = 0;
1202 vlc_object_internals_t *p_priv = vlc_internals( p_this );
1206 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1212 if( ! p_priv->p_vars[i_var].b_incallback )
1217 if( i_tries++ > 100 )
1219 msg_Err( p_this, "caught in a callback deadlock?" );
1220 return VLC_ETIMEOUT;
1223 vlc_mutex_unlock( &p_priv->var_lock );
1224 msleep( THREAD_SLEEP );
1225 vlc_mutex_lock( &p_priv->var_lock );
1229 /*****************************************************************************
1230 * HashString: our cool hash function
1231 *****************************************************************************
1232 * This function is not intended to be crypto-secure, we only want it to be
1233 * fast and not suck too much. This one is pretty fast and did 0 collisions
1234 * in wenglish's dictionary.
1235 *****************************************************************************/
1236 static uint32_t HashString( const char *psz_string )
1238 uint32_t i_hash = 0;
1240 while( *psz_string )
1242 i_hash += *psz_string++;
1243 i_hash += i_hash << 10;
1244 i_hash ^= i_hash >> 8;
1250 /*****************************************************************************
1251 * Insert: find an empty slot to insert a new variable
1252 *****************************************************************************
1253 * We use a recursive inner function indexed on the hash. This function does
1254 * nothing in the rare cases where a collision may occur, see Lookup()
1255 * to see how we handle them.
1256 * XXX: does this really need to be written recursively?
1257 *****************************************************************************/
1258 static int Insert( variable_t *p_vars, int i_count, const char *psz_name )
1265 return InsertInner( p_vars, i_count, HashString( psz_name ) );
1268 static int InsertInner( variable_t *p_vars, int i_count, uint32_t i_hash )
1272 if( i_hash <= p_vars[0].i_hash )
1277 if( i_hash >= p_vars[i_count - 1].i_hash )
1282 i_middle = i_count / 2;
1284 /* We know that 0 < i_middle */
1285 if( i_hash < p_vars[i_middle].i_hash )
1287 return InsertInner( p_vars, i_middle, i_hash );
1290 /* We know that i_middle + 1 < i_count */
1291 if( i_hash > p_vars[i_middle + 1].i_hash )
1293 return i_middle + 1 + InsertInner( p_vars + i_middle + 1,
1294 i_count - i_middle - 1,
1298 return i_middle + 1;
1301 /*****************************************************************************
1302 * Lookup: find an existing variable given its name
1303 *****************************************************************************
1304 * We use a recursive inner function indexed on the hash. Care is taken of
1305 * possible hash collisions.
1306 * XXX: does this really need to be written recursively?
1307 *****************************************************************************/
1308 static int Lookup( variable_t *p_vars, int i_count, const char *psz_name )
1318 i_hash = HashString( psz_name );
1320 i_pos = LookupInner( p_vars, i_count, i_hash );
1322 /* Hash not found */
1323 if( i_hash != p_vars[i_pos].i_hash )
1328 /* Hash found, entry found */
1329 if( !strcmp( psz_name, p_vars[i_pos].psz_name ) )
1334 /* Hash collision! This should be very rare, but we cannot guarantee
1335 * it will never happen. Just do an exhaustive search amongst all
1336 * entries with the same hash. */
1337 for( i = i_pos - 1 ; i > 0 && i_hash == p_vars[i].i_hash ; i-- )
1339 if( !strcmp( psz_name, p_vars[i].psz_name ) )
1345 for( i = i_pos + 1 ; i < i_count && i_hash == p_vars[i].i_hash ; i++ )
1347 if( !strcmp( psz_name, p_vars[i].psz_name ) )
1353 /* Hash found, but entry not found */
1357 static int LookupInner( variable_t *p_vars, int i_count, uint32_t i_hash )
1361 if( i_hash <= p_vars[0].i_hash )
1366 if( i_hash >= p_vars[i_count-1].i_hash )
1371 i_middle = i_count / 2;
1373 /* We know that 0 < i_middle */
1374 if( i_hash < p_vars[i_middle].i_hash )
1376 return LookupInner( p_vars, i_middle, i_hash );
1379 /* We know that i_middle + 1 < i_count */
1380 if( i_hash > p_vars[i_middle].i_hash )
1382 return i_middle + LookupInner( p_vars + i_middle,
1390 /*****************************************************************************
1391 * CheckValue: check that a value is valid wrt. a variable
1392 *****************************************************************************
1393 * This function checks p_val's value against p_var's limitations such as
1394 * minimal and maximal value, step, in-list position, and modifies p_val if
1396 ****************************************************************************/
1397 static void CheckValue ( variable_t *p_var, vlc_value_t *p_val )
1399 /* Check that our variable is in the list */
1400 if( p_var->i_type & VLC_VAR_HASCHOICE && p_var->choices.i_count )
1404 /* FIXME: the list is sorted, dude. Use something cleverer. */
1405 for( i = p_var->choices.i_count ; i-- ; )
1407 if( p_var->pf_cmp( *p_val, p_var->choices.p_values[i] ) == 0 )
1413 /* If not found, change it to anything vaguely valid */
1416 /* Free the old variable, get the new one, dup it */
1417 p_var->pf_free( p_val );
1418 *p_val = p_var->choices.p_values[p_var->i_default >= 0
1419 ? p_var->i_default : 0 ];
1420 p_var->pf_dup( p_val );
1424 /* Check that our variable is within the bounds */
1425 switch( p_var->i_type & VLC_VAR_TYPE )
1427 case VLC_VAR_INTEGER:
1428 if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.i_int
1429 && (p_val->i_int % p_var->step.i_int) )
1431 p_val->i_int = (p_val->i_int + (p_var->step.i_int / 2))
1432 / p_var->step.i_int * p_var->step.i_int;
1434 if( p_var->i_type & VLC_VAR_HASMIN
1435 && p_val->i_int < p_var->min.i_int )
1437 p_val->i_int = p_var->min.i_int;
1439 if( p_var->i_type & VLC_VAR_HASMAX
1440 && p_val->i_int > p_var->max.i_int )
1442 p_val->i_int = p_var->max.i_int;
1446 if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.f_float )
1448 float f_round = p_var->step.f_float * (float)(int)( 0.5 +
1449 p_val->f_float / p_var->step.f_float );
1450 if( p_val->f_float != f_round )
1452 p_val->f_float = f_round;
1455 if( p_var->i_type & VLC_VAR_HASMIN
1456 && p_val->f_float < p_var->min.f_float )
1458 p_val->f_float = p_var->min.f_float;
1460 if( p_var->i_type & VLC_VAR_HASMAX
1461 && p_val->f_float > p_var->max.f_float )
1463 p_val->f_float = p_var->max.f_float;
1472 /*****************************************************************************
1473 * InheritValue: try to inherit the value of this variable from the same one
1474 * in our closest parent.
1475 *****************************************************************************/
1476 static int InheritValue( vlc_object_t *p_this, const char *psz_name,
1477 vlc_value_t *p_val, int i_type )
1482 /* No need to take the structure lock,
1483 * we are only looking for our parents */
1485 if( !p_this->p_parent )
1487 switch( i_type & VLC_VAR_TYPE )
1490 case VLC_VAR_DIRECTORY:
1491 case VLC_VAR_STRING:
1492 case VLC_VAR_MODULE:
1493 p_val->psz_string = config_GetPsz( p_this, psz_name );
1494 if( !p_val->psz_string ) p_val->psz_string = strdup("");
1497 p_val->f_float = config_GetFloat( p_this, psz_name );
1499 case VLC_VAR_INTEGER:
1500 case VLC_VAR_HOTKEY:
1501 p_val->i_int = config_GetInt( p_this, psz_name );
1504 p_val->b_bool = config_GetInt( p_this, psz_name );
1508 char *psz_orig, *psz_var;
1509 vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1510 p_val->p_list = p_list;
1511 p_list->i_count = 0;
1513 psz_var = psz_orig = config_GetPsz( p_this, psz_name );
1514 while( psz_var && *psz_var )
1516 char *psz_item = psz_var;
1518 while( *psz_var && *psz_var != ',' ) psz_var++;
1519 if( *psz_var == ',' )
1524 val.i_int = strtol( psz_item, NULL, 0 );
1525 INSERT_ELEM( p_list->p_values, p_list->i_count,
1526 p_list->i_count, val );
1527 /* p_list->i_count is incremented twice by INSERT_ELEM */
1529 INSERT_ELEM( p_list->pi_types, p_list->i_count,
1530 p_list->i_count, VLC_VAR_INTEGER );
1543 vlc_object_internals_t *p_priv = vlc_internals( p_this->p_parent );
1545 /* Look for the variable */
1546 vlc_mutex_lock( &p_priv->var_lock );
1548 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1553 p_var = &p_priv->p_vars[i_var];
1555 /* Really get the variable */
1556 *p_val = p_var->val;
1558 /* Duplicate value if needed */
1559 p_var->pf_dup( p_val );
1561 vlc_mutex_unlock( &p_priv->var_lock );
1565 vlc_mutex_unlock( &p_priv->var_lock );
1567 /* We're still not there */
1569 return InheritValue( p_this->p_parent, psz_name, p_val, i_type );
1572 /**********************************************************************
1573 * Execute a var command on an object identified by its name
1574 **********************************************************************/
1575 int __var_Command( vlc_object_t *p_this, const char *psz_name,
1576 const char *psz_cmd, const char *psz_arg, char **psz_msg )
1578 vlc_object_t *p_obj = vlc_object_find_name( p_this->p_libvlc,
1579 psz_name, FIND_CHILD );
1585 *psz_msg = strdup( "Unknown destination object." );
1589 vlc_refcheck( p_this );
1590 i_type = var_Type( p_obj, psz_cmd );
1591 if( !( i_type&VLC_VAR_ISCOMMAND ) )
1593 vlc_object_release( p_obj );
1595 *psz_msg = strdup( "Variable doesn't exist or isn't a command." );
1596 return VLC_EGENERIC;
1602 case VLC_VAR_INTEGER:
1603 i_ret = var_SetInteger( p_obj, psz_cmd, atoi( psz_arg ) );
1606 i_ret = var_SetFloat( p_obj, psz_cmd, atof( psz_arg ) );
1608 case VLC_VAR_STRING:
1609 i_ret = var_SetString( p_obj, psz_cmd, psz_arg );
1612 i_ret = var_SetBool( p_obj, psz_cmd, atoi( psz_arg ) );
1615 i_ret = VLC_EGENERIC;
1619 vlc_object_release( p_obj );
1623 *psz_msg = (char*)malloc( 80 );
1624 sprintf( *psz_msg, "%s on object %s returned %i (%s)",
1625 psz_cmd, psz_name, i_ret, vlc_error( i_ret ) );