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_mutex_lock( &p_priv->var_lock );
173 /* FIXME: if the variable already exists, we don't duplicate it. But we
174 * duplicate the lookups. It's not that serious, but if anyone finds some
175 * time to rework Insert() so that only one lookup has to be done, feel
177 i_new = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
181 /* If the types differ, variable creation failed. */
182 if( (i_type & ~(VLC_VAR_DOINHERIT|VLC_VAR_ISCOMMAND)) != p_priv->p_vars[i_new].i_type )
184 vlc_mutex_unlock( &p_priv->var_lock );
188 p_priv->p_vars[i_new].i_usage++;
189 if( i_type & VLC_VAR_ISCOMMAND )
190 p_priv->p_vars[i_new].i_type |= VLC_VAR_ISCOMMAND;
191 vlc_mutex_unlock( &p_priv->var_lock );
195 i_new = Insert( p_priv->p_vars, p_priv->i_vars, psz_name );
197 if( (p_priv->i_vars & 15) == 15 )
199 p_priv->p_vars = realloc( p_priv->p_vars,
200 (p_priv->i_vars+17) * sizeof(variable_t) );
203 memmove( p_priv->p_vars + i_new + 1,
204 p_priv->p_vars + i_new,
205 (p_priv->i_vars - i_new) * sizeof(variable_t) );
209 p_var = &p_priv->p_vars[i_new];
210 memset( p_var, 0, sizeof(*p_var) );
212 p_var->i_hash = HashString( psz_name );
213 p_var->psz_name = strdup( psz_name );
214 p_var->psz_text = NULL;
216 p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
217 memset( &p_var->val, 0, sizeof(vlc_value_t) );
219 p_var->pf_dup = DupDummy;
220 p_var->pf_free = FreeDummy;
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_TYPE )
240 p_var->pf_cmp = CmpBool;
241 p_var->val.b_bool = false;
243 case VLC_VAR_INTEGER:
245 p_var->pf_cmp = CmpInt;
246 p_var->val.i_int = 0;
251 case VLC_VAR_DIRECTORY:
252 case VLC_VAR_VARIABLE:
253 p_var->pf_cmp = CmpString;
254 p_var->pf_dup = DupString;
255 p_var->pf_free = FreeString;
256 p_var->val.psz_string = NULL;
259 p_var->pf_cmp = CmpFloat;
260 p_var->val.f_float = 0.0;
263 p_var->pf_cmp = CmpTime;
264 p_var->val.i_time = 0;
266 case VLC_VAR_ADDRESS:
267 p_var->pf_cmp = CmpAddress;
268 p_var->val.p_address = NULL;
271 p_var->pf_cmp = CmpAddress;
272 p_var->pf_free = FreeMutex;
273 p_var->val.p_address = malloc( sizeof(vlc_mutex_t) );
274 vlc_mutex_init( (vlc_mutex_t*)p_var->val.p_address );
277 p_var->pf_cmp = CmpAddress;
278 p_var->pf_dup = DupList;
279 p_var->pf_free = FreeList;
280 p_var->val.p_list = &dummy_null_list;
284 /* Duplicate the default data we stored. */
285 p_var->pf_dup( &p_var->val );
287 if( i_type & VLC_VAR_DOINHERIT )
291 if( InheritValue( p_this, psz_name, &val, p_var->i_type )
294 /* Free data if needed */
295 p_var->pf_free( &p_var->val );
296 /* Set the variable */
299 if( i_type & VLC_VAR_HASCHOICE )
301 /* We must add the inherited value to our choice list */
302 p_var->i_default = 0;
304 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
306 INSERT_ELEM( p_var->choices_text.p_values,
307 p_var->choices_text.i_count, 0, val );
308 p_var->pf_dup( &p_var->choices.p_values[0] );
309 p_var->choices_text.p_values[0].psz_string = NULL;
314 vlc_mutex_unlock( &p_priv->var_lock );
320 * Destroy a vlc variable
322 * Look for the variable and destroy it if it is found. As in var_Create we
323 * do a call to memmove() but we have performance counterparts elsewhere.
325 * \param p_this The object that holds the variable
326 * \param psz_name The name of the variable
328 int __var_Destroy( vlc_object_t *p_this, const char *psz_name )
332 vlc_object_internals_t *p_priv = vlc_internals( p_this );
334 vlc_mutex_lock( &p_priv->var_lock );
336 i_var = GetUnused( p_this, psz_name );
339 vlc_mutex_unlock( &p_priv->var_lock );
343 p_var = &p_priv->p_vars[i_var];
345 if( p_var->i_usage > 1 )
348 vlc_mutex_unlock( &p_priv->var_lock );
352 /* Free value if needed */
353 p_var->pf_free( &p_var->val );
355 /* Free choice list if needed */
356 if( p_var->choices.i_count )
358 for( i = 0 ; i < p_var->choices.i_count ; i++ )
360 p_var->pf_free( &p_var->choices.p_values[i] );
361 free( p_var->choices_text.p_values[i].psz_string );
363 free( p_var->choices.p_values );
364 free( p_var->choices_text.p_values );
367 /* Free callbacks if needed */
368 if( p_var->p_entries )
370 free( p_var->p_entries );
373 free( p_var->psz_name );
374 free( p_var->psz_text );
376 memmove( p_priv->p_vars + i_var,
377 p_priv->p_vars + i_var + 1,
378 (p_priv->i_vars - i_var - 1) * sizeof(variable_t) );
380 if( (p_priv->i_vars & 15) == 0 )
382 p_priv->p_vars = realloc( p_priv->p_vars,
383 (p_priv->i_vars) * sizeof( variable_t ) );
388 vlc_mutex_unlock( &p_priv->var_lock );
394 * Perform an action on a variable
396 * \param p_this The object that holds the variable
397 * \param psz_name The name of the variable
398 * \param i_action The action to perform. Must be one of \ref var_action
399 * \param p_val First action parameter
400 * \param p_val2 Second action parameter
402 int __var_Change( vlc_object_t *p_this, const char *psz_name,
403 int i_action, vlc_value_t *p_val, vlc_value_t *p_val2 )
408 vlc_object_internals_t *p_priv = vlc_internals( p_this );
410 vlc_mutex_lock( &p_priv->var_lock );
412 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
416 vlc_mutex_unlock( &p_priv->var_lock );
420 p_var = &p_priv->p_vars[i_var];
425 if( p_var->i_type & VLC_VAR_HASMIN )
427 p_var->pf_free( &p_var->min );
429 p_var->i_type |= VLC_VAR_HASMIN;
431 p_var->pf_dup( &p_var->min );
432 CheckValue( p_var, &p_var->val );
435 if( p_var->i_type & VLC_VAR_HASMIN )
441 if( p_var->i_type & VLC_VAR_HASMAX )
443 p_var->pf_free( &p_var->max );
445 p_var->i_type |= VLC_VAR_HASMAX;
447 p_var->pf_dup( &p_var->max );
448 CheckValue( p_var, &p_var->val );
451 if( p_var->i_type & VLC_VAR_HASMAX )
456 case VLC_VAR_SETSTEP:
457 if( p_var->i_type & VLC_VAR_HASSTEP )
459 p_var->pf_free( &p_var->step );
461 p_var->i_type |= VLC_VAR_HASSTEP;
462 p_var->step = *p_val;
463 p_var->pf_dup( &p_var->step );
464 CheckValue( p_var, &p_var->val );
466 case VLC_VAR_GETSTEP:
467 if( p_var->i_type & VLC_VAR_HASSTEP )
469 *p_val = p_var->step;
472 case VLC_VAR_ADDCHOICE:
473 i = p_var->choices.i_count;
475 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
477 INSERT_ELEM( p_var->choices_text.p_values,
478 p_var->choices_text.i_count, i, *p_val );
479 p_var->pf_dup( &p_var->choices.p_values[i] );
480 p_var->choices_text.p_values[i].psz_string =
481 ( p_val2 && p_val2->psz_string ) ?
482 strdup( p_val2->psz_string ) : NULL;
484 CheckValue( p_var, &p_var->val );
486 case VLC_VAR_DELCHOICE:
487 for( i = 0 ; i < p_var->choices.i_count ; i++ )
489 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
495 if( i == p_var->choices.i_count )
498 vlc_mutex_unlock( &p_priv->var_lock );
502 if( p_var->i_default > i )
506 else if( p_var->i_default == i )
508 p_var->i_default = -1;
511 p_var->pf_free( &p_var->choices.p_values[i] );
512 free( p_var->choices_text.p_values[i].psz_string );
513 REMOVE_ELEM( p_var->choices.p_values, p_var->choices.i_count, i );
514 REMOVE_ELEM( p_var->choices_text.p_values,
515 p_var->choices_text.i_count, i );
517 CheckValue( p_var, &p_var->val );
519 case VLC_VAR_CHOICESCOUNT:
520 p_val->i_int = p_var->choices.i_count;
522 case VLC_VAR_CLEARCHOICES:
523 for( i = 0 ; i < p_var->choices.i_count ; i++ )
525 p_var->pf_free( &p_var->choices.p_values[i] );
527 for( i = 0 ; i < p_var->choices_text.i_count ; i++ )
528 free( p_var->choices_text.p_values[i].psz_string );
530 if( p_var->choices.i_count ) free( p_var->choices.p_values );
531 if( p_var->choices_text.i_count ) free( p_var->choices_text.p_values );
533 p_var->choices.i_count = 0;
534 p_var->choices.p_values = NULL;
535 p_var->choices_text.i_count = 0;
536 p_var->choices_text.p_values = NULL;
537 p_var->i_default = -1;
539 case VLC_VAR_SETDEFAULT:
540 /* FIXME: the list is sorted, dude. Use something cleverer. */
541 for( i = 0 ; i < p_var->choices.i_count ; i++ )
543 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
549 if( i == p_var->choices.i_count )
555 p_var->i_default = i;
556 CheckValue( p_var, &p_var->val );
558 case VLC_VAR_SETVALUE:
559 /* Duplicate data if needed */
560 p_var->pf_dup( p_val );
561 /* Backup needed stuff */
563 /* Check boundaries and list */
564 CheckValue( p_var, p_val );
565 /* Set the variable */
567 /* Free data if needed */
568 p_var->pf_free( &oldval );
570 case VLC_VAR_GETCHOICES:
571 case VLC_VAR_GETLIST:
572 p_val->p_list = malloc( sizeof(vlc_list_t) );
573 if( p_val2 ) p_val2->p_list = malloc( sizeof(vlc_list_t) );
574 if( p_var->choices.i_count )
576 p_val->p_list->p_values = malloc( p_var->choices.i_count
577 * sizeof(vlc_value_t) );
578 p_val->p_list->pi_types = malloc( p_var->choices.i_count
582 p_val2->p_list->p_values =
583 malloc( p_var->choices.i_count * sizeof(vlc_value_t) );
584 p_val2->p_list->pi_types =
585 malloc( p_var->choices.i_count * sizeof(int) );
588 p_val->p_list->i_count = p_var->choices.i_count;
589 if( p_val2 ) p_val2->p_list->i_count = p_var->choices.i_count;
590 for( i = 0 ; i < p_var->choices.i_count ; i++ )
592 p_val->p_list->p_values[i] = p_var->choices.p_values[i];
593 p_val->p_list->pi_types[i] = p_var->i_type;
594 p_var->pf_dup( &p_val->p_list->p_values[i] );
597 p_val2->p_list->p_values[i].psz_string =
598 p_var->choices_text.p_values[i].psz_string ?
599 strdup(p_var->choices_text.p_values[i].psz_string) : NULL;
600 p_val2->p_list->pi_types[i] = VLC_VAR_STRING;
604 case VLC_VAR_FREELIST:
606 if( p_val2 && p_val2->p_list )
608 for( i = 0; i < p_val2->p_list->i_count; i++ )
609 free( p_val2->p_list->p_values[i].psz_string );
610 if( p_val2->p_list->i_count )
612 free( p_val2->p_list->p_values );
613 free( p_val2->p_list->pi_types );
615 free( p_val2->p_list );
618 case VLC_VAR_SETTEXT:
619 free( p_var->psz_text );
620 if( p_val && p_val->psz_string )
621 p_var->psz_text = strdup( p_val->psz_string );
623 case VLC_VAR_GETTEXT:
624 p_val->psz_string = NULL;
625 if( p_var->psz_text )
627 p_val->psz_string = strdup( p_var->psz_text );
630 case VLC_VAR_INHERITVALUE:
634 if( InheritValue( p_this,
635 p_val2 ? p_val2->psz_string : psz_name,
636 &val, p_var->i_type )
639 /* Duplicate already done */
641 /* Backup needed stuff */
643 /* Check boundaries and list */
644 CheckValue( p_var, &val );
645 /* Set the variable */
647 /* Free data if needed */
648 p_var->pf_free( &oldval );
654 p_var->pf_dup( p_val );
658 case VLC_VAR_TRIGGER_CALLBACKS:
660 /* Deal with callbacks. Tell we're in a callback, release the lock,
661 * call stored functions, retake the lock. */
662 if( p_var->i_entries )
665 int i_entries = p_var->i_entries;
666 callback_entry_t *p_entries = p_var->p_entries;
668 p_var->b_incallback = true;
669 vlc_mutex_unlock( &p_priv->var_lock );
672 for( ; i_entries-- ; )
674 p_entries[i_entries].pf_callback( p_this, psz_name, p_var->val, p_var->val,
675 p_entries[i_entries].p_data );
678 vlc_mutex_lock( &p_priv->var_lock );
680 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
683 msg_Err( p_this, "variable %s has disappeared", psz_name );
684 vlc_mutex_unlock( &p_priv->var_lock );
688 p_var = &p_priv->p_vars[i_var];
689 p_var->b_incallback = false;
694 case VLC_VAR_SETISCOMMAND:
695 p_var->i_type |= VLC_VAR_ISCOMMAND;
702 vlc_mutex_unlock( &p_priv->var_lock );
708 * Request a variable's type
710 * \return The variable type if it exists, or 0 if the
711 * variable could not be found.
714 int __var_Type( vlc_object_t *p_this, const char *psz_name )
717 vlc_object_internals_t *p_priv = vlc_internals( p_this );
719 vlc_mutex_lock( &p_priv->var_lock );
721 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
725 vlc_mutex_unlock( &p_priv->var_lock );
729 i_type = p_priv->p_vars[i_var].i_type;
731 vlc_mutex_unlock( &p_priv->var_lock );
737 * Set a variable's value
739 * \param p_this The object that hold the variable
740 * \param psz_name The name of the variable
741 * \param val the value to set
743 int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val )
748 vlc_object_internals_t *p_priv = vlc_internals( p_this );
750 vlc_mutex_lock( &p_priv->var_lock );
752 i_var = GetUnused( p_this, psz_name );
755 vlc_mutex_unlock( &p_priv->var_lock );
759 p_var = &p_priv->p_vars[i_var];
761 /* Duplicate data if needed */
762 p_var->pf_dup( &val );
764 /* Backup needed stuff */
767 /* Check boundaries and list */
768 CheckValue( p_var, &val );
770 /* Set the variable */
773 /* Deal with callbacks. Tell we're in a callback, release the lock,
774 * call stored functions, retake the lock. */
775 if( p_var->i_entries )
778 int i_entries = p_var->i_entries;
779 callback_entry_t *p_entries = p_var->p_entries;
781 p_var->b_incallback = true;
782 vlc_mutex_unlock( &p_priv->var_lock );
785 for( ; i_entries-- ; )
787 p_entries[i_entries].pf_callback( p_this, psz_name, oldval, val,
788 p_entries[i_entries].p_data );
791 vlc_mutex_lock( &p_priv->var_lock );
793 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
796 msg_Err( p_this, "variable %s has disappeared", psz_name );
797 vlc_mutex_unlock( &p_priv->var_lock );
801 p_var = &p_priv->p_vars[i_var];
802 p_var->b_incallback = false;
805 /* Free data if needed */
806 p_var->pf_free( &oldval );
808 vlc_mutex_unlock( &p_priv->var_lock );
814 * Get a variable's value
816 * \param p_this The object that holds the variable
817 * \param psz_name The name of the variable
818 * \param p_val Pointer to a vlc_value_t that will hold the variable's value
819 * after the function is finished
821 int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
825 vlc_object_internals_t *p_priv = vlc_internals( p_this );
827 vlc_mutex_lock( &p_priv->var_lock );
829 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
833 vlc_mutex_unlock( &p_priv->var_lock );
837 p_var = &p_priv->p_vars[i_var];
839 /* Really get the variable */
842 /* Duplicate value if needed */
843 p_var->pf_dup( p_val );
845 vlc_mutex_unlock( &p_priv->var_lock );
851 #undef var_AcquireMutex
853 * Finds a process-wide mutex, creates it if needed, and locks it.
854 * Unlock with vlc_mutex_unlock().
856 vlc_mutex_t *var_AcquireMutex( const char *name )
858 libvlc_global_data_t *p_global = vlc_global();
861 if( var_Create( p_global, name, VLC_VAR_MUTEX ) )
864 var_Get( p_global, name, &val );
865 vlc_mutex_lock( val.p_address );
866 return val.p_address;
871 * Register a callback in a variable
873 * We store a function pointer that will be called upon variable
876 * \param p_this The object that holds the variable
877 * \param psz_name The name of the variable
878 * \param pf_callback The function pointer
879 * \param p_data A generic pointer that will be passed as the last
880 * argument to the callback function.
882 * \warning The callback function is run in the thread that calls var_Set on
883 * the variable. Use proper locking. This thread may not have much
884 * time to spare, so keep callback functions short.
886 int __var_AddCallback( vlc_object_t *p_this, const char *psz_name,
887 vlc_callback_t pf_callback, void *p_data )
891 callback_entry_t entry;
892 vlc_object_internals_t *p_priv = vlc_internals( p_this );
894 entry.pf_callback = pf_callback;
895 entry.p_data = p_data;
897 vlc_mutex_lock( &p_priv->var_lock );
899 i_var = GetUnused( p_this, psz_name );
902 vlc_mutex_unlock( &p_priv->var_lock );
906 p_var = &p_priv->p_vars[i_var];
908 INSERT_ELEM( p_var->p_entries,
913 vlc_mutex_unlock( &p_priv->var_lock );
919 * Remove a callback from a variable
921 * pf_callback and p_data have to be given again, because different objects
922 * might have registered the same callback function.
924 int __var_DelCallback( vlc_object_t *p_this, const char *psz_name,
925 vlc_callback_t pf_callback, void *p_data )
929 vlc_object_internals_t *p_priv = vlc_internals( p_this );
931 vlc_mutex_lock( &p_priv->var_lock );
933 i_var = GetUnused( p_this, psz_name );
936 vlc_mutex_unlock( &p_priv->var_lock );
940 p_var = &p_priv->p_vars[i_var];
942 for( i_entry = p_var->i_entries ; i_entry-- ; )
944 if( p_var->p_entries[i_entry].pf_callback == pf_callback
945 && p_var->p_entries[i_entry].p_data == p_data )
953 vlc_mutex_unlock( &p_priv->var_lock );
957 REMOVE_ELEM( p_var->p_entries, p_var->i_entries, i_entry );
959 vlc_mutex_unlock( &p_priv->var_lock );
965 * Trigger callback on a variable
967 * \param p_this The object that hold the variable
968 * \param psz_name The name of the variable
970 int __var_TriggerCallback( vlc_object_t *p_this, const char *psz_name )
975 vlc_object_internals_t *p_priv = vlc_internals( p_this );
977 vlc_mutex_lock( &p_priv->var_lock );
979 i_var = GetUnused( p_this, psz_name );
982 vlc_mutex_unlock( &p_priv->var_lock );
986 p_var = &p_priv->p_vars[i_var];
988 /* Backup needed stuff */
991 /* Deal with callbacks. Tell we're in a callback, release the lock,
992 * call stored functions, retake the lock. */
993 if( p_var->i_entries )
996 int i_entries = p_var->i_entries;
997 callback_entry_t *p_entries = p_var->p_entries;
999 p_var->b_incallback = true;
1000 vlc_mutex_unlock( &p_priv->var_lock );
1002 /* The real calls */
1003 for( ; i_entries-- ; )
1005 p_entries[i_entries].pf_callback( p_this, psz_name, oldval, oldval,
1006 p_entries[i_entries].p_data );
1009 vlc_mutex_lock( &p_priv->var_lock );
1011 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1014 msg_Err( p_this, "variable %s has disappeared", psz_name );
1015 vlc_mutex_unlock( &p_priv->var_lock );
1019 p_var = &p_priv->p_vars[i_var];
1020 p_var->b_incallback = false;
1023 vlc_mutex_unlock( &p_priv->var_lock );
1027 /** Parse a stringified option
1028 * This function parse a string option and create the associated object
1030 * The option must be of the form "[no[-]]foo[=bar]" where foo is the
1031 * option name and bar is the value of the option.
1032 * \param p_obj the object in which the variable must be created
1033 * \param psz_option the option to parse
1034 * \param trusted whether the option is set by a trusted input or not
1037 void var_OptionParse( vlc_object_t *p_obj, const char *psz_option,
1040 char *psz_name, *psz_value;
1042 bool b_isno = false;
1045 val.psz_string = NULL;
1047 /* It's too much of a hassle to remove the ':' when we parse
1048 * the cmd line :) */
1049 if( psz_option[0] == ':' )
1052 if( !psz_option[0] )
1055 psz_name = strdup( psz_option );
1056 if( psz_name == NULL )
1059 psz_value = strchr( psz_name, '=' );
1060 if( psz_value != NULL )
1061 *psz_value++ = '\0';
1063 /* FIXME: :programs should be handled generically */
1064 if( !strcmp( psz_name, "programs" ) )
1065 i_type = VLC_VAR_LIST;
1067 i_type = config_GetType( p_obj, psz_name );
1069 if( !i_type && !psz_value )
1071 /* check for "no-foo" or "nofoo" */
1072 if( !strncmp( psz_name, "no-", 3 ) )
1074 memmove( psz_name, psz_name + 3, strlen(psz_name) + 1 - 3 );
1076 else if( !strncmp( psz_name, "no", 2 ) )
1078 memmove( psz_name, psz_name + 2, strlen(psz_name) + 1 - 2 );
1080 else goto cleanup; /* Option doesn't exist */
1083 i_type = config_GetType( p_obj, psz_name );
1085 if( !i_type ) goto cleanup; /* Option doesn't exist */
1087 if( ( i_type != VLC_VAR_BOOL ) &&
1088 ( !psz_value || !*psz_value ) ) goto cleanup; /* Invalid value */
1090 /* check if option is unsafe */
1093 module_config_t *p_config = config_FindConfig( p_obj, psz_name );
1094 if( !p_config->b_safe )
1096 msg_Err( p_obj, "unsafe option \"%s\" has been ignored for "
1097 "security reasons", psz_name );
1102 /* Create the variable in the input object.
1103 * Children of the input object will be able to retreive this value
1104 * thanks to the inheritance property of the object variables. */
1105 var_Create( p_obj, psz_name, i_type );
1110 val.b_bool = !b_isno;
1113 case VLC_VAR_INTEGER:
1114 val.i_int = strtol( psz_value, NULL, 0 );
1118 val.f_float = atof( psz_value );
1121 case VLC_VAR_STRING:
1122 case VLC_VAR_MODULE:
1124 case VLC_VAR_DIRECTORY:
1125 val.psz_string = psz_value;
1130 char *psz_orig, *psz_var;
1131 vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1132 val.p_list = p_list;
1133 p_list->i_count = 0;
1135 psz_var = psz_orig = strdup(psz_value);
1136 while( psz_var && *psz_var )
1138 char *psz_item = psz_var;
1140 while( *psz_var && *psz_var != ',' ) psz_var++;
1141 if( *psz_var == ',' )
1146 val2.i_int = strtol( psz_item, NULL, 0 );
1147 INSERT_ELEM( p_list->p_values, p_list->i_count,
1148 p_list->i_count, val2 );
1149 /* p_list->i_count is incremented twice by INSERT_ELEM */
1151 INSERT_ELEM( p_list->pi_types, p_list->i_count,
1152 p_list->i_count, VLC_VAR_INTEGER );
1162 var_Set( p_obj, psz_name, val );
1169 /* Following functions are local */
1171 /*****************************************************************************
1172 * GetUnused: find an unused variable from its name
1173 *****************************************************************************
1174 * We do i_tries tries before giving up, just in case the variable is being
1175 * modified and called from a callback.
1176 *****************************************************************************/
1177 static int GetUnused( vlc_object_t *p_this, const char *psz_name )
1179 int i_var, i_tries = 0;
1180 vlc_object_internals_t *p_priv = vlc_internals( p_this );
1184 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1190 if( ! p_priv->p_vars[i_var].b_incallback )
1195 if( i_tries++ > 100 )
1197 msg_Err( p_this, "caught in a callback deadlock? ('%s')", psz_name );
1198 return VLC_ETIMEOUT;
1201 vlc_mutex_unlock( &p_priv->var_lock );
1202 msleep( THREAD_SLEEP );
1203 vlc_mutex_lock( &p_priv->var_lock );
1207 /*****************************************************************************
1208 * HashString: our cool hash function
1209 *****************************************************************************
1210 * This function is not intended to be crypto-secure, we only want it to be
1211 * fast and not suck too much. This one is pretty fast and did 0 collisions
1212 * in wenglish's dictionary.
1213 *****************************************************************************/
1214 static uint32_t HashString( const char *psz_string )
1216 uint32_t i_hash = 0;
1218 while( *psz_string )
1220 i_hash += *psz_string++;
1221 i_hash += i_hash << 10;
1222 i_hash ^= i_hash >> 8;
1228 /*****************************************************************************
1229 * Insert: find an empty slot to insert a new variable
1230 *****************************************************************************
1231 * We use a recursive inner function indexed on the hash. This function does
1232 * nothing in the rare cases where a collision may occur, see Lookup()
1233 * to see how we handle them.
1234 * XXX: does this really need to be written recursively?
1235 *****************************************************************************/
1236 static int Insert( variable_t *p_vars, int i_count, const char *psz_name )
1243 return InsertInner( p_vars, i_count, HashString( psz_name ) );
1246 static int InsertInner( variable_t *p_vars, int i_count, uint32_t i_hash )
1250 if( i_hash <= p_vars[0].i_hash )
1255 if( i_hash >= p_vars[i_count - 1].i_hash )
1260 i_middle = i_count / 2;
1262 /* We know that 0 < i_middle */
1263 if( i_hash < p_vars[i_middle].i_hash )
1265 return InsertInner( p_vars, i_middle, i_hash );
1268 /* We know that i_middle + 1 < i_count */
1269 if( i_hash > p_vars[i_middle + 1].i_hash )
1271 return i_middle + 1 + InsertInner( p_vars + i_middle + 1,
1272 i_count - i_middle - 1,
1276 return i_middle + 1;
1279 /*****************************************************************************
1280 * Lookup: find an existing variable given its name
1281 *****************************************************************************
1282 * We use a recursive inner function indexed on the hash. Care is taken of
1283 * possible hash collisions.
1284 * XXX: does this really need to be written recursively?
1285 *****************************************************************************/
1286 static int Lookup( variable_t *p_vars, int i_count, const char *psz_name )
1296 i_hash = HashString( psz_name );
1298 i_pos = LookupInner( p_vars, i_count, i_hash );
1300 /* Hash not found */
1301 if( i_hash != p_vars[i_pos].i_hash )
1306 /* Hash found, entry found */
1307 if( !strcmp( psz_name, p_vars[i_pos].psz_name ) )
1312 /* Hash collision! This should be very rare, but we cannot guarantee
1313 * it will never happen. Just do an exhaustive search amongst all
1314 * entries with the same hash. */
1315 for( i = i_pos - 1 ; i > 0 && i_hash == p_vars[i].i_hash ; i-- )
1317 if( !strcmp( psz_name, p_vars[i].psz_name ) )
1323 for( i = i_pos + 1 ; i < i_count && i_hash == p_vars[i].i_hash ; i++ )
1325 if( !strcmp( psz_name, p_vars[i].psz_name ) )
1331 /* Hash found, but entry not found */
1335 static int LookupInner( variable_t *p_vars, int i_count, uint32_t i_hash )
1339 if( i_hash <= p_vars[0].i_hash )
1344 if( i_hash >= p_vars[i_count-1].i_hash )
1349 i_middle = i_count / 2;
1351 /* We know that 0 < i_middle */
1352 if( i_hash < p_vars[i_middle].i_hash )
1354 return LookupInner( p_vars, i_middle, i_hash );
1357 /* We know that i_middle + 1 < i_count */
1358 if( i_hash > p_vars[i_middle].i_hash )
1360 return i_middle + LookupInner( p_vars + i_middle,
1368 /*****************************************************************************
1369 * CheckValue: check that a value is valid wrt. a variable
1370 *****************************************************************************
1371 * This function checks p_val's value against p_var's limitations such as
1372 * minimal and maximal value, step, in-list position, and modifies p_val if
1374 ****************************************************************************/
1375 static void CheckValue ( variable_t *p_var, vlc_value_t *p_val )
1377 /* Check that our variable is in the list */
1378 if( p_var->i_type & VLC_VAR_HASCHOICE && p_var->choices.i_count )
1382 /* FIXME: the list is sorted, dude. Use something cleverer. */
1383 for( i = p_var->choices.i_count ; i-- ; )
1385 if( p_var->pf_cmp( *p_val, p_var->choices.p_values[i] ) == 0 )
1391 /* If not found, change it to anything vaguely valid */
1394 /* Free the old variable, get the new one, dup it */
1395 p_var->pf_free( p_val );
1396 *p_val = p_var->choices.p_values[p_var->i_default >= 0
1397 ? p_var->i_default : 0 ];
1398 p_var->pf_dup( p_val );
1402 /* Check that our variable is within the bounds */
1403 switch( p_var->i_type & VLC_VAR_TYPE )
1405 case VLC_VAR_INTEGER:
1406 if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.i_int
1407 && (p_val->i_int % p_var->step.i_int) )
1409 p_val->i_int = (p_val->i_int + (p_var->step.i_int / 2))
1410 / p_var->step.i_int * p_var->step.i_int;
1412 if( p_var->i_type & VLC_VAR_HASMIN
1413 && p_val->i_int < p_var->min.i_int )
1415 p_val->i_int = p_var->min.i_int;
1417 if( p_var->i_type & VLC_VAR_HASMAX
1418 && p_val->i_int > p_var->max.i_int )
1420 p_val->i_int = p_var->max.i_int;
1424 if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.f_float )
1426 float f_round = p_var->step.f_float * (float)(int)( 0.5 +
1427 p_val->f_float / p_var->step.f_float );
1428 if( p_val->f_float != f_round )
1430 p_val->f_float = f_round;
1433 if( p_var->i_type & VLC_VAR_HASMIN
1434 && p_val->f_float < p_var->min.f_float )
1436 p_val->f_float = p_var->min.f_float;
1438 if( p_var->i_type & VLC_VAR_HASMAX
1439 && p_val->f_float > p_var->max.f_float )
1441 p_val->f_float = p_var->max.f_float;
1450 /*****************************************************************************
1451 * InheritValue: try to inherit the value of this variable from the same one
1452 * in our closest parent.
1453 *****************************************************************************/
1454 static int InheritValue( vlc_object_t *p_this, const char *psz_name,
1455 vlc_value_t *p_val, int i_type )
1460 /* No need to take the structure lock,
1461 * we are only looking for our parents */
1463 if( !p_this->p_parent )
1465 switch( i_type & VLC_VAR_TYPE )
1468 case VLC_VAR_DIRECTORY:
1469 case VLC_VAR_STRING:
1470 case VLC_VAR_MODULE:
1471 p_val->psz_string = config_GetPsz( p_this, psz_name );
1472 if( !p_val->psz_string ) p_val->psz_string = strdup("");
1475 p_val->f_float = config_GetFloat( p_this, psz_name );
1477 case VLC_VAR_INTEGER:
1478 case VLC_VAR_HOTKEY:
1479 p_val->i_int = config_GetInt( p_this, psz_name );
1482 p_val->b_bool = config_GetInt( p_this, psz_name );
1486 char *psz_orig, *psz_var;
1487 vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1488 p_val->p_list = p_list;
1489 p_list->i_count = 0;
1491 psz_var = psz_orig = config_GetPsz( p_this, psz_name );
1492 while( psz_var && *psz_var )
1494 char *psz_item = psz_var;
1496 while( *psz_var && *psz_var != ',' ) psz_var++;
1497 if( *psz_var == ',' )
1502 val.i_int = strtol( psz_item, NULL, 0 );
1503 INSERT_ELEM( p_list->p_values, p_list->i_count,
1504 p_list->i_count, val );
1505 /* p_list->i_count is incremented twice by INSERT_ELEM */
1507 INSERT_ELEM( p_list->pi_types, p_list->i_count,
1508 p_list->i_count, VLC_VAR_INTEGER );
1521 vlc_object_internals_t *p_priv = vlc_internals( p_this->p_parent );
1523 /* Look for the variable */
1524 vlc_mutex_lock( &p_priv->var_lock );
1526 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1531 p_var = &p_priv->p_vars[i_var];
1533 /* Really get the variable */
1534 *p_val = p_var->val;
1536 /* Duplicate value if needed */
1537 p_var->pf_dup( p_val );
1539 vlc_mutex_unlock( &p_priv->var_lock );
1543 vlc_mutex_unlock( &p_priv->var_lock );
1545 /* We're still not there */
1547 return InheritValue( p_this->p_parent, psz_name, p_val, i_type );
1550 /**********************************************************************
1551 * Execute a var command on an object identified by its name
1552 **********************************************************************/
1553 int __var_Command( vlc_object_t *p_this, const char *psz_name,
1554 const char *psz_cmd, const char *psz_arg, char **psz_msg )
1556 vlc_object_t *p_obj = vlc_object_find_name( p_this->p_libvlc,
1557 psz_name, FIND_CHILD );
1563 *psz_msg = strdup( "Unknown destination object." );
1567 i_type = var_Type( p_obj, psz_cmd );
1568 if( !( i_type&VLC_VAR_ISCOMMAND ) )
1570 vlc_object_release( p_obj );
1572 *psz_msg = strdup( "Variable doesn't exist or isn't a command." );
1573 return VLC_EGENERIC;
1576 i_type &= VLC_VAR_CLASS;
1579 case VLC_VAR_INTEGER:
1580 i_ret = var_SetInteger( p_obj, psz_cmd, atoi( psz_arg ) );
1583 i_ret = var_SetFloat( p_obj, psz_cmd, atof( psz_arg ) );
1585 case VLC_VAR_STRING:
1586 i_ret = var_SetString( p_obj, psz_cmd, psz_arg );
1589 i_ret = var_SetBool( p_obj, psz_cmd, atoi( psz_arg ) );
1592 i_ret = VLC_EGENERIC;
1596 vlc_object_release( p_obj );
1600 *psz_msg = (char*)malloc( 80 );
1601 sprintf( *psz_msg, "%s on object %s returned %i (%s)",
1602 psz_cmd, psz_name, i_ret, vlc_error( i_ret ) );