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 *****************************************************************************/
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 ) { return strcmp( v.psz_string, w.psz_string ); }
57 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; }
58 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; }
60 /*****************************************************************************
61 * Local duplication functions, and local deallocation functions
62 *****************************************************************************/
63 static void DupDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
64 static void DupString( vlc_value_t *p_val ) { p_val->psz_string = strdup( p_val->psz_string ); }
66 static void DupList( vlc_value_t *p_val )
69 vlc_list_t *p_list = malloc( sizeof(vlc_list_t) );
71 p_list->i_count = p_val->p_list->i_count;
72 if( p_val->p_list->i_count )
74 p_list->p_values = malloc( p_list->i_count * sizeof(vlc_value_t) );
75 p_list->pi_types = malloc( p_list->i_count * sizeof(int) );
79 p_list->p_values = NULL;
80 p_list->pi_types = NULL;
83 for( i = 0; i < p_list->i_count; i++ )
85 p_list->p_values[i] = p_val->p_list->p_values[i];
86 p_list->pi_types[i] = p_val->p_list->pi_types[i];
87 switch( p_val->p_list->pi_types[i] & VLC_VAR_TYPE )
91 DupString( &p_list->p_values[i] );
98 p_val->p_list = p_list;
101 static void FreeDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
102 static void FreeString( vlc_value_t *p_val ) { free( p_val->psz_string ); }
103 static void FreeMutex( vlc_value_t *p_val ) { vlc_mutex_destroy( (vlc_mutex_t*)p_val->p_address ); free( p_val->p_address ); }
105 static void FreeList( vlc_value_t *p_val )
108 for( i = 0; i < p_val->p_list->i_count; i++ )
110 switch( p_val->p_list->pi_types[i] & VLC_VAR_TYPE )
113 FreeString( &p_val->p_list->p_values[i] );
116 FreeMutex( &p_val->p_list->p_values[i] );
123 if( p_val->p_list->i_count )
125 free( p_val->p_list->p_values );
126 free( p_val->p_list->pi_types );
128 free( p_val->p_list );
131 /*****************************************************************************
133 *****************************************************************************/
134 static int GetUnused ( vlc_object_t *, const char * );
135 static uint32_t HashString ( const char * );
136 static int Insert ( variable_t *, int, const char * );
137 static int InsertInner ( variable_t *, int, uint32_t );
138 static int Lookup ( variable_t *, int, const char * );
139 static int LookupInner ( variable_t *, int, uint32_t );
141 static void CheckValue ( variable_t *, vlc_value_t * );
143 static int InheritValue( vlc_object_t *, const char *, vlc_value_t *,
147 * Initialize a vlc variable
149 * We hash the given string and insert it into the sorted list. The insertion
150 * may require slow memory copies, but think about what we gain in the log(n)
151 * lookup phase when setting/getting the variable value!
153 * \param p_this The object in which to create the variable
154 * \param psz_name The name of the variable
155 * \param i_type The variables type. Must be one of \ref var_type combined with
156 * zero or more \ref var_flags
158 int __var_Create( vlc_object_t *p_this, const char *psz_name, int i_type )
162 static vlc_list_t dummy_null_list = {0, NULL, NULL};
163 vlc_object_internals_t *p_priv = p_this->p_internals;
165 vlc_mutex_lock( &p_priv->var_lock );
167 /* FIXME: if the variable already exists, we don't duplicate it. But we
168 * duplicate the lookups. It's not that serious, but if anyone finds some
169 * time to rework Insert() so that only one lookup has to be done, feel
171 i_new = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
175 /* If the types differ, variable creation failed. */
176 if( (i_type & ~(VLC_VAR_DOINHERIT|VLC_VAR_ISCOMMAND)) != p_priv->p_vars[i_new].i_type )
178 vlc_mutex_unlock( &p_priv->var_lock );
182 p_priv->p_vars[i_new].i_usage++;
183 if( i_type & VLC_VAR_ISCOMMAND )
184 p_priv->p_vars[i_new].i_type |= VLC_VAR_ISCOMMAND;
185 vlc_mutex_unlock( &p_priv->var_lock );
189 i_new = Insert( p_priv->p_vars, p_priv->i_vars, psz_name );
191 if( (p_priv->i_vars & 15) == 15 )
193 p_priv->p_vars = realloc( p_priv->p_vars,
194 (p_priv->i_vars+17) * sizeof(variable_t) );
197 memmove( p_priv->p_vars + i_new + 1,
198 p_priv->p_vars + i_new,
199 (p_priv->i_vars - i_new) * sizeof(variable_t) );
203 p_var = &p_priv->p_vars[i_new];
204 memset( p_var, 0, sizeof(*p_var) );
206 p_var->i_hash = HashString( psz_name );
207 p_var->psz_name = strdup( psz_name );
208 p_var->psz_text = NULL;
210 p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
211 memset( &p_var->val, 0, sizeof(vlc_value_t) );
213 p_var->pf_dup = DupDummy;
214 p_var->pf_free = FreeDummy;
218 p_var->i_default = -1;
219 p_var->choices.i_count = 0;
220 p_var->choices.p_values = NULL;
221 p_var->choices_text.i_count = 0;
222 p_var->choices_text.p_values = NULL;
224 p_var->b_incallback = VLC_FALSE;
225 p_var->i_entries = 0;
226 p_var->p_entries = NULL;
228 /* Always initialize the variable, even if it is a list variable; this
229 * will lead to errors if the variable is not initialized, but it will
230 * not cause crashes in the variable handling. */
231 switch( i_type & VLC_VAR_TYPE )
234 p_var->pf_cmp = CmpBool;
235 p_var->val.b_bool = VLC_FALSE;
237 case VLC_VAR_INTEGER:
239 p_var->pf_cmp = CmpInt;
240 p_var->val.i_int = 0;
245 case VLC_VAR_DIRECTORY:
246 case VLC_VAR_VARIABLE:
247 p_var->pf_cmp = CmpString;
248 p_var->pf_dup = DupString;
249 p_var->pf_free = FreeString;
250 p_var->val.psz_string = strdup( "" );
253 p_var->pf_cmp = CmpFloat;
254 p_var->val.f_float = 0.0;
257 p_var->pf_cmp = CmpTime;
258 p_var->val.i_time = 0;
260 case VLC_VAR_ADDRESS:
261 p_var->pf_cmp = CmpAddress;
262 p_var->val.p_address = NULL;
265 p_var->pf_cmp = CmpAddress;
266 p_var->pf_free = FreeMutex;
267 p_var->val.p_address = malloc( sizeof(vlc_mutex_t) );
268 vlc_mutex_init( p_this, (vlc_mutex_t*)p_var->val.p_address );
271 p_var->pf_cmp = CmpAddress;
272 p_var->pf_dup = DupList;
273 p_var->pf_free = FreeList;
274 p_var->val.p_list = &dummy_null_list;
278 /* Duplicate the default data we stored. */
279 p_var->pf_dup( &p_var->val );
281 if( i_type & VLC_VAR_DOINHERIT )
285 if( InheritValue( p_this, psz_name, &val, p_var->i_type )
288 /* Free data if needed */
289 p_var->pf_free( &p_var->val );
290 /* Set the variable */
293 if( i_type & VLC_VAR_HASCHOICE )
295 /* We must add the inherited value to our choice list */
296 p_var->i_default = 0;
298 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
300 INSERT_ELEM( p_var->choices_text.p_values,
301 p_var->choices_text.i_count, 0, val );
302 p_var->pf_dup( &p_var->choices.p_values[0] );
303 p_var->choices_text.p_values[0].psz_string = NULL;
308 vlc_mutex_unlock( &p_priv->var_lock );
314 * Destroy a vlc variable
316 * Look for the variable and destroy it if it is found. As in var_Create we
317 * do a call to memmove() but we have performance counterparts elsewhere.
319 * \param p_this The object that holds the variable
320 * \param psz_name The name of the variable
322 int __var_Destroy( vlc_object_t *p_this, const char *psz_name )
326 vlc_object_internals_t *p_priv = p_this->p_internals;
328 vlc_mutex_lock( &p_priv->var_lock );
330 i_var = GetUnused( p_this, psz_name );
333 vlc_mutex_unlock( &p_priv->var_lock );
337 p_var = &p_priv->p_vars[i_var];
339 if( p_var->i_usage > 1 )
342 vlc_mutex_unlock( &p_priv->var_lock );
346 /* Free value if needed */
347 p_var->pf_free( &p_var->val );
349 /* Free choice list if needed */
350 if( p_var->choices.i_count )
352 for( i = 0 ; i < p_var->choices.i_count ; i++ )
354 p_var->pf_free( &p_var->choices.p_values[i] );
355 if( p_var->choices_text.p_values[i].psz_string )
356 free( p_var->choices_text.p_values[i].psz_string );
358 free( p_var->choices.p_values );
359 free( p_var->choices_text.p_values );
362 /* Free callbacks if needed */
363 if( p_var->p_entries )
365 free( p_var->p_entries );
368 free( p_var->psz_name );
369 if( p_var->psz_text ) free( p_var->psz_text );
371 memmove( p_priv->p_vars + i_var,
372 p_priv->p_vars + i_var + 1,
373 (p_priv->i_vars - i_var - 1) * sizeof(variable_t) );
375 if( (p_priv->i_vars & 15) == 0 )
377 p_priv->p_vars = realloc( p_priv->p_vars,
378 (p_priv->i_vars) * sizeof( variable_t ) );
383 vlc_mutex_unlock( &p_priv->var_lock );
389 * Perform an action on a variable
391 * \param p_this The object that holds the variable
392 * \param psz_name The name of the variable
393 * \param i_action The action to perform. Must be one of \ref var_action
394 * \param p_val First action parameter
395 * \param p_val2 Second action parameter
397 int __var_Change( vlc_object_t *p_this, const char *psz_name,
398 int i_action, vlc_value_t *p_val, vlc_value_t *p_val2 )
403 vlc_object_internals_t *p_priv = p_this->p_internals;
405 vlc_mutex_lock( &p_priv->var_lock );
407 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
411 vlc_mutex_unlock( &p_priv->var_lock );
415 p_var = &p_priv->p_vars[i_var];
420 if( p_var->i_type & VLC_VAR_HASMIN )
422 p_var->pf_free( &p_var->min );
424 p_var->i_type |= VLC_VAR_HASMIN;
426 p_var->pf_dup( &p_var->min );
427 CheckValue( p_var, &p_var->val );
430 if( p_var->i_type & VLC_VAR_HASMIN )
436 if( p_var->i_type & VLC_VAR_HASMAX )
438 p_var->pf_free( &p_var->max );
440 p_var->i_type |= VLC_VAR_HASMAX;
442 p_var->pf_dup( &p_var->max );
443 CheckValue( p_var, &p_var->val );
446 if( p_var->i_type & VLC_VAR_HASMAX )
451 case VLC_VAR_SETSTEP:
452 if( p_var->i_type & VLC_VAR_HASSTEP )
454 p_var->pf_free( &p_var->step );
456 p_var->i_type |= VLC_VAR_HASSTEP;
457 p_var->step = *p_val;
458 p_var->pf_dup( &p_var->step );
459 CheckValue( p_var, &p_var->val );
461 case VLC_VAR_GETSTEP:
462 if( p_var->i_type & VLC_VAR_HASSTEP )
464 *p_val = p_var->step;
467 case VLC_VAR_ADDCHOICE:
468 /* FIXME: the list is sorted, dude. Use something cleverer. */
469 for( i = p_var->choices.i_count ; i-- ; )
471 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) < 0 )
477 /* The new place is i+1 */
480 if( p_var->i_default >= i )
485 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
487 INSERT_ELEM( p_var->choices_text.p_values,
488 p_var->choices_text.i_count, i, *p_val );
489 p_var->pf_dup( &p_var->choices.p_values[i] );
490 p_var->choices_text.p_values[i].psz_string =
491 ( p_val2 && p_val2->psz_string ) ?
492 strdup( p_val2->psz_string ) : NULL;
494 CheckValue( p_var, &p_var->val );
496 case VLC_VAR_DELCHOICE:
497 /* FIXME: the list is sorted, dude. Use something cleverer. */
498 for( i = 0 ; i < p_var->choices.i_count ; i++ )
500 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
506 if( i == p_var->choices.i_count )
509 vlc_mutex_unlock( &p_priv->var_lock );
513 if( p_var->i_default > i )
517 else if( p_var->i_default == i )
519 p_var->i_default = -1;
522 p_var->pf_free( &p_var->choices.p_values[i] );
523 if( p_var->choices_text.p_values[i].psz_string )
524 free( p_var->choices_text.p_values[i].psz_string );
525 REMOVE_ELEM( p_var->choices.p_values, p_var->choices.i_count, i );
526 REMOVE_ELEM( p_var->choices_text.p_values,
527 p_var->choices_text.i_count, i );
529 CheckValue( p_var, &p_var->val );
531 case VLC_VAR_CHOICESCOUNT:
532 p_val->i_int = p_var->choices.i_count;
534 case VLC_VAR_CLEARCHOICES:
535 for( i = 0 ; i < p_var->choices.i_count ; i++ )
537 p_var->pf_free( &p_var->choices.p_values[i] );
539 for( i = 0 ; i < p_var->choices_text.i_count ; i++ )
541 if( p_var->choices_text.p_values[i].psz_string )
542 free( p_var->choices_text.p_values[i].psz_string );
544 if( p_var->choices.i_count ) free( p_var->choices.p_values );
545 if( p_var->choices_text.i_count ) free( p_var->choices_text.p_values );
547 p_var->choices.i_count = 0;
548 p_var->choices.p_values = NULL;
549 p_var->choices_text.i_count = 0;
550 p_var->choices_text.p_values = NULL;
551 p_var->i_default = -1;
553 case VLC_VAR_SETDEFAULT:
554 /* FIXME: the list is sorted, dude. Use something cleverer. */
555 for( i = 0 ; i < p_var->choices.i_count ; i++ )
557 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
563 if( i == p_var->choices.i_count )
569 p_var->i_default = i;
570 CheckValue( p_var, &p_var->val );
572 case VLC_VAR_SETVALUE:
573 /* Duplicate data if needed */
574 p_var->pf_dup( p_val );
575 /* Backup needed stuff */
577 /* Check boundaries and list */
578 CheckValue( p_var, p_val );
579 /* Set the variable */
581 /* Free data if needed */
582 p_var->pf_free( &oldval );
584 case VLC_VAR_GETCHOICES:
585 case VLC_VAR_GETLIST:
586 p_val->p_list = malloc( sizeof(vlc_list_t) );
587 if( p_val2 ) p_val2->p_list = malloc( sizeof(vlc_list_t) );
588 if( p_var->choices.i_count )
590 p_val->p_list->p_values = malloc( p_var->choices.i_count
591 * sizeof(vlc_value_t) );
592 p_val->p_list->pi_types = malloc( p_var->choices.i_count
596 p_val2->p_list->p_values =
597 malloc( p_var->choices.i_count * sizeof(vlc_value_t) );
598 p_val2->p_list->pi_types =
599 malloc( p_var->choices.i_count * sizeof(int) );
602 p_val->p_list->i_count = p_var->choices.i_count;
603 if( p_val2 ) p_val2->p_list->i_count = p_var->choices.i_count;
604 for( i = 0 ; i < p_var->choices.i_count ; i++ )
606 p_val->p_list->p_values[i] = p_var->choices.p_values[i];
607 p_val->p_list->pi_types[i] = p_var->i_type;
608 p_var->pf_dup( &p_val->p_list->p_values[i] );
611 p_val2->p_list->p_values[i].psz_string =
612 p_var->choices_text.p_values[i].psz_string ?
613 strdup(p_var->choices_text.p_values[i].psz_string) : NULL;
614 p_val2->p_list->pi_types[i] = VLC_VAR_STRING;
618 case VLC_VAR_FREELIST:
620 if( p_val2 && p_val2->p_list )
622 for( i = 0; i < p_val2->p_list->i_count; i++ )
623 if( p_val2->p_list->p_values[i].psz_string )
624 free( p_val2->p_list->p_values[i].psz_string );
625 if( p_val2->p_list->i_count )
627 free( p_val2->p_list->p_values );
628 free( p_val2->p_list->pi_types );
630 free( p_val2->p_list );
633 case VLC_VAR_SETTEXT:
634 if( p_var->psz_text ) free( p_var->psz_text );
635 if( p_val && p_val->psz_string )
636 p_var->psz_text = strdup( p_val->psz_string );
638 case VLC_VAR_GETTEXT:
639 p_val->psz_string = NULL;
640 if( p_var->psz_text )
642 p_val->psz_string = strdup( p_var->psz_text );
645 case VLC_VAR_INHERITVALUE:
649 if( InheritValue( p_this,
650 p_val2 ? p_val2->psz_string : psz_name,
651 &val, p_var->i_type )
654 /* Duplicate already done */
656 /* Backup needed stuff */
658 /* Check boundaries and list */
659 CheckValue( p_var, &val );
660 /* Set the variable */
662 /* Free data if needed */
663 p_var->pf_free( &oldval );
669 p_var->pf_dup( p_val );
673 case VLC_VAR_TRIGGER_CALLBACKS:
675 /* Deal with callbacks. Tell we're in a callback, release the lock,
676 * call stored functions, retake the lock. */
677 if( p_var->i_entries )
680 int i_entries = p_var->i_entries;
681 callback_entry_t *p_entries = p_var->p_entries;
683 p_var->b_incallback = VLC_TRUE;
684 vlc_mutex_unlock( &p_priv->var_lock );
687 for( ; i_entries-- ; )
689 p_entries[i_entries].pf_callback( p_this, psz_name, p_var->val, p_var->val,
690 p_entries[i_entries].p_data );
693 vlc_mutex_lock( &p_priv->var_lock );
695 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
698 msg_Err( p_this, "variable %s has disappeared", psz_name );
699 vlc_mutex_unlock( &p_priv->var_lock );
703 p_var = &p_priv->p_vars[i_var];
704 p_var->b_incallback = VLC_FALSE;
713 vlc_mutex_unlock( &p_priv->var_lock );
719 * Request a variable's type
721 * \return The variable type if it exists, or 0 if the
722 * variable could not be found.
725 int __var_Type( vlc_object_t *p_this, const char *psz_name )
728 vlc_object_internals_t *p_priv = p_this->p_internals;
730 vlc_mutex_lock( &p_priv->var_lock );
732 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
736 vlc_mutex_unlock( &p_priv->var_lock );
740 i_type = p_priv->p_vars[i_var].i_type;
742 vlc_mutex_unlock( &p_priv->var_lock );
748 * Set a variable's value
750 * \param p_this The object that hold the variable
751 * \param psz_name The name of the variable
752 * \param val the value to set
754 int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val )
759 vlc_object_internals_t *p_priv = p_this->p_internals;
761 vlc_mutex_lock( &p_priv->var_lock );
763 i_var = GetUnused( p_this, psz_name );
766 vlc_mutex_unlock( &p_priv->var_lock );
770 p_var = &p_priv->p_vars[i_var];
772 /* Duplicate data if needed */
773 p_var->pf_dup( &val );
775 /* Backup needed stuff */
778 /* Check boundaries and list */
779 CheckValue( p_var, &val );
781 /* Set the variable */
784 /* Deal with callbacks. Tell we're in a callback, release the lock,
785 * call stored functions, retake the lock. */
786 if( p_var->i_entries )
789 int i_entries = p_var->i_entries;
790 callback_entry_t *p_entries = p_var->p_entries;
792 p_var->b_incallback = VLC_TRUE;
793 vlc_mutex_unlock( &p_priv->var_lock );
796 for( ; i_entries-- ; )
798 p_entries[i_entries].pf_callback( p_this, psz_name, oldval, val,
799 p_entries[i_entries].p_data );
802 vlc_mutex_lock( &p_priv->var_lock );
804 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
807 msg_Err( p_this, "variable %s has disappeared", psz_name );
808 vlc_mutex_unlock( &p_priv->var_lock );
812 p_var = &p_priv->p_vars[i_var];
813 p_var->b_incallback = VLC_FALSE;
816 /* Free data if needed */
817 p_var->pf_free( &oldval );
819 vlc_mutex_unlock( &p_priv->var_lock );
825 * Get a variable's value
827 * \param p_this The object that holds the variable
828 * \param psz_name The name of the variable
829 * \param p_val Pointer to a vlc_value_t that will hold the variable's value
830 * after the function is finished
832 int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
836 vlc_object_internals_t *p_priv = p_this->p_internals;
838 vlc_mutex_lock( &p_priv->var_lock );
840 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
844 vlc_mutex_unlock( &p_priv->var_lock );
848 p_var = &p_priv->p_vars[i_var];
850 /* Really get the variable */
853 /* Duplicate value if needed */
854 p_var->pf_dup( p_val );
856 vlc_mutex_unlock( &p_priv->var_lock );
863 * Finds a process-wide mutex, creates it if needed, and locks it.
864 * Unlock with vlc_mutex_unlock().
866 vlc_mutex_t *var_AcquireMutex( const char *name )
868 libvlc_global_data_t *p_global = vlc_global();
871 if( var_Create( p_global, name, VLC_VAR_MUTEX ) )
874 var_Get( p_global, name, &val );
875 vlc_mutex_lock( val.p_address );
876 return val.p_address;
881 * Register a callback in a variable
883 * We store a function pointer that will be called upon variable
886 * \param p_this The object that holds the variable
887 * \param psz_name The name of the variable
888 * \param pf_callback The function pointer
889 * \param p_data A generic pointer that will be passed as the last
890 * argument to the callback function.
892 * \warning The callback function is run in the thread that calls var_Set on
893 * the variable. Use proper locking. This thread may not have much
894 * time to spare, so keep callback functions short.
896 int __var_AddCallback( vlc_object_t *p_this, const char *psz_name,
897 vlc_callback_t pf_callback, void *p_data )
901 callback_entry_t entry;
902 vlc_object_internals_t *p_priv = p_this->p_internals;
904 entry.pf_callback = pf_callback;
905 entry.p_data = p_data;
907 vlc_mutex_lock( &p_priv->var_lock );
909 i_var = GetUnused( p_this, psz_name );
912 vlc_mutex_unlock( &p_priv->var_lock );
916 p_var = &p_priv->p_vars[i_var];
918 INSERT_ELEM( p_var->p_entries,
923 vlc_mutex_unlock( &p_priv->var_lock );
929 * Remove a callback from a variable
931 * pf_callback and p_data have to be given again, because different objects
932 * might have registered the same callback function.
934 int __var_DelCallback( vlc_object_t *p_this, const char *psz_name,
935 vlc_callback_t pf_callback, void *p_data )
939 vlc_object_internals_t *p_priv = p_this->p_internals;
941 vlc_mutex_lock( &p_priv->var_lock );
943 i_var = GetUnused( p_this, psz_name );
946 vlc_mutex_unlock( &p_priv->var_lock );
950 p_var = &p_priv->p_vars[i_var];
952 for( i_entry = p_var->i_entries ; i_entry-- ; )
954 if( p_var->p_entries[i_entry].pf_callback == pf_callback
955 && p_var->p_entries[i_entry].p_data == p_data )
963 vlc_mutex_unlock( &p_priv->var_lock );
967 REMOVE_ELEM( p_var->p_entries, p_var->i_entries, i_entry );
969 vlc_mutex_unlock( &p_priv->var_lock );
975 * Trigger callback on a variable
977 * \param p_this The object that hold the variable
978 * \param psz_name The name of the variable
980 int __var_TriggerCallback( vlc_object_t *p_this, const char *psz_name )
985 vlc_object_internals_t *p_priv = p_this->p_internals;
987 vlc_mutex_lock( &p_priv->var_lock );
989 i_var = GetUnused( p_this, psz_name );
992 vlc_mutex_unlock( &p_priv->var_lock );
996 p_var = &p_priv->p_vars[i_var];
998 /* Backup needed stuff */
1001 /* Deal with callbacks. Tell we're in a callback, release the lock,
1002 * call stored functions, retake the lock. */
1003 if( p_var->i_entries )
1006 int i_entries = p_var->i_entries;
1007 callback_entry_t *p_entries = p_var->p_entries;
1009 p_var->b_incallback = VLC_TRUE;
1010 vlc_mutex_unlock( &p_priv->var_lock );
1012 /* The real calls */
1013 for( ; i_entries-- ; )
1015 p_entries[i_entries].pf_callback( p_this, psz_name, oldval, oldval,
1016 p_entries[i_entries].p_data );
1019 vlc_mutex_lock( &p_priv->var_lock );
1021 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1024 msg_Err( p_this, "variable %s has disappeared", psz_name );
1025 vlc_mutex_unlock( &p_priv->var_lock );
1029 p_var = &p_priv->p_vars[i_var];
1030 p_var->b_incallback = VLC_FALSE;
1033 vlc_mutex_unlock( &p_priv->var_lock );
1037 /** Parse a stringified option
1038 * This function parse a string option and create the associated object
1040 * The option must be of the form "[no[-]]foo[=bar]" where foo is the
1041 * option name and bar is the value of the option.
1042 * \param p_obj the object in which the variable must be created
1043 * \param psz_option the option to parse
1046 void var_OptionParse( vlc_object_t *p_obj, const char *psz_option )
1048 char *psz_name, *psz_value;
1050 vlc_bool_t b_isno = VLC_FALSE;
1053 val.psz_string = NULL;
1055 /* It's too much of a hassle to remove the ':' when we parse
1056 * the cmd line :) */
1057 if( psz_option[0] == ':' )
1060 if( !psz_option[0] )
1063 psz_name = strdup( psz_option );
1064 if( psz_name == NULL )
1067 psz_value = strchr( psz_name, '=' );
1068 if( psz_value != NULL )
1069 *psz_value++ = '\0';
1071 /* FIXME: :programs should be handled generically */
1072 if( !strcmp( psz_name, "programs" ) )
1073 i_type = VLC_VAR_LIST;
1075 i_type = config_GetType( p_obj, psz_name );
1077 if( !i_type && !psz_value )
1079 /* check for "no-foo" or "nofoo" */
1080 if( !strncmp( psz_name, "no-", 3 ) )
1082 memmove( psz_name, psz_name + 3, strlen(psz_name) + 1 - 3 );
1084 else if( !strncmp( psz_name, "no", 2 ) )
1086 memmove( psz_name, psz_name + 2, strlen(psz_name) + 1 - 2 );
1088 else goto cleanup; /* Option doesn't exist */
1091 i_type = config_GetType( p_obj, psz_name );
1093 if( !i_type ) goto cleanup; /* Option doesn't exist */
1095 if( ( i_type != VLC_VAR_BOOL ) &&
1096 ( !psz_value || !*psz_value ) ) goto cleanup; /* Invalid value */
1098 /* check if option is unsafe */
1100 module_config_t *p_config = config_FindConfig( p_obj, psz_name );
1101 if( !p_config->b_safe )
1103 int policy = config_GetInt( p_obj, "security-policy" );
1107 msg_Err( p_obj, "option %s is unsafe and is blocked by security policy", psz_name );
1111 case 2: /* prompt */
1113 char description[256];
1114 snprintf(description, sizeof(description), _("playlist item is making use of the following unsafe option '%s', which may be harmful if used in a malicious way, authorize it ?"), psz_name);
1115 if( DIALOG_OK_YES != intf_UserYesNo( p_obj, _("WARNING: Unsafe Playlist"), description, _("Yes"), _("No"), NULL) )
1117 msg_Err( p_obj, "option %s is unsafe and is blocked by security policy", psz_name );
1127 /* Create the variable in the input object.
1128 * Children of the input object will be able to retreive this value
1129 * thanks to the inheritance property of the object variables. */
1130 var_Create( p_obj, psz_name, i_type );
1135 val.b_bool = !b_isno;
1138 case VLC_VAR_INTEGER:
1139 val.i_int = strtol( psz_value, NULL, 0 );
1143 val.f_float = atof( psz_value );
1146 case VLC_VAR_STRING:
1147 case VLC_VAR_MODULE:
1149 case VLC_VAR_DIRECTORY:
1150 val.psz_string = psz_value;
1155 char *psz_orig, *psz_var;
1156 vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1157 val.p_list = p_list;
1158 p_list->i_count = 0;
1160 psz_var = psz_orig = strdup(psz_value);
1161 while( psz_var && *psz_var )
1163 char *psz_item = psz_var;
1165 while( *psz_var && *psz_var != ',' ) psz_var++;
1166 if( *psz_var == ',' )
1171 val2.i_int = strtol( psz_item, NULL, 0 );
1172 INSERT_ELEM( p_list->p_values, p_list->i_count,
1173 p_list->i_count, val2 );
1174 /* p_list->i_count is incremented twice by INSERT_ELEM */
1176 INSERT_ELEM( p_list->pi_types, p_list->i_count,
1177 p_list->i_count, VLC_VAR_INTEGER );
1179 if( psz_orig ) free( psz_orig );
1187 var_Set( p_obj, psz_name, val );
1194 /* Following functions are local */
1196 /*****************************************************************************
1197 * GetUnused: find an unused variable from its name
1198 *****************************************************************************
1199 * We do i_tries tries before giving up, just in case the variable is being
1200 * modified and called from a callback.
1201 *****************************************************************************/
1202 static int GetUnused( vlc_object_t *p_this, const char *psz_name )
1204 int i_var, i_tries = 0;
1205 vlc_object_internals_t *p_priv = p_this->p_internals;
1209 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1215 if( ! p_priv->p_vars[i_var].b_incallback )
1220 if( i_tries++ > 100 )
1222 msg_Err( p_this, "caught in a callback deadlock?" );
1223 return VLC_ETIMEOUT;
1226 vlc_mutex_unlock( &p_priv->var_lock );
1227 msleep( THREAD_SLEEP );
1228 vlc_mutex_lock( &p_priv->var_lock );
1232 /*****************************************************************************
1233 * HashString: our cool hash function
1234 *****************************************************************************
1235 * This function is not intended to be crypto-secure, we only want it to be
1236 * fast and not suck too much. This one is pretty fast and did 0 collisions
1237 * in wenglish's dictionary.
1238 *****************************************************************************/
1239 static uint32_t HashString( const char *psz_string )
1241 uint32_t i_hash = 0;
1243 while( *psz_string )
1245 i_hash += *psz_string++;
1246 i_hash += i_hash << 10;
1247 i_hash ^= i_hash >> 8;
1253 /*****************************************************************************
1254 * Insert: find an empty slot to insert a new variable
1255 *****************************************************************************
1256 * We use a recursive inner function indexed on the hash. This function does
1257 * nothing in the rare cases where a collision may occur, see Lookup()
1258 * to see how we handle them.
1259 * XXX: does this really need to be written recursively?
1260 *****************************************************************************/
1261 static int Insert( variable_t *p_vars, int i_count, const char *psz_name )
1268 return InsertInner( p_vars, i_count, HashString( psz_name ) );
1271 static int InsertInner( variable_t *p_vars, int i_count, uint32_t i_hash )
1275 if( i_hash <= p_vars[0].i_hash )
1280 if( i_hash >= p_vars[i_count - 1].i_hash )
1285 i_middle = i_count / 2;
1287 /* We know that 0 < i_middle */
1288 if( i_hash < p_vars[i_middle].i_hash )
1290 return InsertInner( p_vars, i_middle, i_hash );
1293 /* We know that i_middle + 1 < i_count */
1294 if( i_hash > p_vars[i_middle + 1].i_hash )
1296 return i_middle + 1 + InsertInner( p_vars + i_middle + 1,
1297 i_count - i_middle - 1,
1301 return i_middle + 1;
1304 /*****************************************************************************
1305 * Lookup: find an existing variable given its name
1306 *****************************************************************************
1307 * We use a recursive inner function indexed on the hash. Care is taken of
1308 * possible hash collisions.
1309 * XXX: does this really need to be written recursively?
1310 *****************************************************************************/
1311 static int Lookup( variable_t *p_vars, int i_count, const char *psz_name )
1321 i_hash = HashString( psz_name );
1323 i_pos = LookupInner( p_vars, i_count, i_hash );
1325 /* Hash not found */
1326 if( i_hash != p_vars[i_pos].i_hash )
1331 /* Hash found, entry found */
1332 if( !strcmp( psz_name, p_vars[i_pos].psz_name ) )
1337 /* Hash collision! This should be very rare, but we cannot guarantee
1338 * it will never happen. Just do an exhaustive search amongst all
1339 * entries with the same hash. */
1340 for( i = i_pos - 1 ; i > 0 && i_hash == p_vars[i].i_hash ; i-- )
1342 if( !strcmp( psz_name, p_vars[i].psz_name ) )
1348 for( i = i_pos + 1 ; i < i_count && i_hash == p_vars[i].i_hash ; i++ )
1350 if( !strcmp( psz_name, p_vars[i].psz_name ) )
1356 /* Hash found, but entry not found */
1360 static int LookupInner( variable_t *p_vars, int i_count, uint32_t i_hash )
1364 if( i_hash <= p_vars[0].i_hash )
1369 if( i_hash >= p_vars[i_count-1].i_hash )
1374 i_middle = i_count / 2;
1376 /* We know that 0 < i_middle */
1377 if( i_hash < p_vars[i_middle].i_hash )
1379 return LookupInner( p_vars, i_middle, i_hash );
1382 /* We know that i_middle + 1 < i_count */
1383 if( i_hash > p_vars[i_middle].i_hash )
1385 return i_middle + LookupInner( p_vars + i_middle,
1393 /*****************************************************************************
1394 * CheckValue: check that a value is valid wrt. a variable
1395 *****************************************************************************
1396 * This function checks p_val's value against p_var's limitations such as
1397 * minimal and maximal value, step, in-list position, and modifies p_val if
1399 ****************************************************************************/
1400 static void CheckValue ( variable_t *p_var, vlc_value_t *p_val )
1402 /* Check that our variable is in the list */
1403 if( p_var->i_type & VLC_VAR_HASCHOICE && p_var->choices.i_count )
1407 /* FIXME: the list is sorted, dude. Use something cleverer. */
1408 for( i = p_var->choices.i_count ; i-- ; )
1410 if( p_var->pf_cmp( *p_val, p_var->choices.p_values[i] ) == 0 )
1416 /* If not found, change it to anything vaguely valid */
1419 /* Free the old variable, get the new one, dup it */
1420 p_var->pf_free( p_val );
1421 *p_val = p_var->choices.p_values[p_var->i_default >= 0
1422 ? p_var->i_default : 0 ];
1423 p_var->pf_dup( p_val );
1427 /* Check that our variable is within the bounds */
1428 switch( p_var->i_type & VLC_VAR_TYPE )
1430 case VLC_VAR_INTEGER:
1431 if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.i_int
1432 && (p_val->i_int % p_var->step.i_int) )
1434 p_val->i_int = (p_val->i_int + (p_var->step.i_int / 2))
1435 / p_var->step.i_int * p_var->step.i_int;
1437 if( p_var->i_type & VLC_VAR_HASMIN
1438 && p_val->i_int < p_var->min.i_int )
1440 p_val->i_int = p_var->min.i_int;
1442 if( p_var->i_type & VLC_VAR_HASMAX
1443 && p_val->i_int > p_var->max.i_int )
1445 p_val->i_int = p_var->max.i_int;
1449 if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.f_float )
1451 float f_round = p_var->step.f_float * (float)(int)( 0.5 +
1452 p_val->f_float / p_var->step.f_float );
1453 if( p_val->f_float != f_round )
1455 p_val->f_float = f_round;
1458 if( p_var->i_type & VLC_VAR_HASMIN
1459 && p_val->f_float < p_var->min.f_float )
1461 p_val->f_float = p_var->min.f_float;
1463 if( p_var->i_type & VLC_VAR_HASMAX
1464 && p_val->f_float > p_var->max.f_float )
1466 p_val->f_float = p_var->max.f_float;
1475 /*****************************************************************************
1476 * InheritValue: try to inherit the value of this variable from the same one
1477 * in our closest parent.
1478 *****************************************************************************/
1479 static int InheritValue( vlc_object_t *p_this, const char *psz_name,
1480 vlc_value_t *p_val, int i_type )
1485 /* No need to take the structure lock,
1486 * we are only looking for our parents */
1488 if( !p_this->p_parent )
1490 switch( i_type & VLC_VAR_TYPE )
1493 case VLC_VAR_DIRECTORY:
1494 case VLC_VAR_STRING:
1495 case VLC_VAR_MODULE:
1496 p_val->psz_string = config_GetPsz( p_this, psz_name );
1497 if( !p_val->psz_string ) p_val->psz_string = strdup("");
1500 p_val->f_float = config_GetFloat( p_this, psz_name );
1502 case VLC_VAR_INTEGER:
1503 case VLC_VAR_HOTKEY:
1504 p_val->i_int = config_GetInt( p_this, psz_name );
1507 p_val->b_bool = config_GetInt( p_this, psz_name );
1511 char *psz_orig, *psz_var;
1512 vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1513 p_val->p_list = p_list;
1514 p_list->i_count = 0;
1516 psz_var = psz_orig = config_GetPsz( p_this, psz_name );
1517 while( psz_var && *psz_var )
1519 char *psz_item = psz_var;
1521 while( *psz_var && *psz_var != ',' ) psz_var++;
1522 if( *psz_var == ',' )
1527 val.i_int = strtol( psz_item, NULL, 0 );
1528 INSERT_ELEM( p_list->p_values, p_list->i_count,
1529 p_list->i_count, val );
1530 /* p_list->i_count is incremented twice by INSERT_ELEM */
1532 INSERT_ELEM( p_list->pi_types, p_list->i_count,
1533 p_list->i_count, VLC_VAR_INTEGER );
1535 if( psz_orig ) free( psz_orig );
1546 vlc_object_internals_t *p_priv = p_this->p_parent->p_internals;
1548 /* Look for the variable */
1549 vlc_mutex_lock( &p_priv->var_lock );
1551 i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1556 p_var = &p_priv->p_vars[i_var];
1558 /* Really get the variable */
1559 *p_val = p_var->val;
1561 /* Duplicate value if needed */
1562 p_var->pf_dup( p_val );
1564 vlc_mutex_unlock( &p_priv->var_lock );
1568 vlc_mutex_unlock( &p_priv->var_lock );
1570 /* We're still not there */
1572 return InheritValue( p_this->p_parent, psz_name, p_val, i_type );
1575 /**********************************************************************
1576 * Execute a var command on an object identified by its name
1577 **********************************************************************/
1578 int __var_Command( vlc_object_t *p_this, const char *psz_name,
1579 const char *psz_cmd, const char *psz_arg, char **psz_msg )
1581 vlc_object_t *p_obj = vlc_object_find_name( p_this->p_libvlc,
1582 psz_name, FIND_CHILD );
1588 *psz_msg = strdup( "Unknown destination object." );
1592 i_type = var_Type( p_obj, psz_cmd );
1593 if( !( i_type&VLC_VAR_ISCOMMAND ) )
1595 vlc_object_release( p_obj );
1597 *psz_msg = strdup( "Variable doesn't exist or isn't a command." );
1598 return VLC_EGENERIC;
1604 case VLC_VAR_INTEGER:
1605 i_ret = var_SetInteger( p_obj, psz_cmd, atoi( psz_arg ) );
1608 i_ret = var_SetFloat( p_obj, psz_cmd, atof( psz_arg ) );
1610 case VLC_VAR_STRING:
1611 i_ret = var_SetString( p_obj, psz_cmd, psz_arg );
1614 i_ret = var_SetBool( p_obj, psz_cmd, atoi( psz_arg ) );
1617 i_ret = VLC_EGENERIC;
1621 vlc_object_release( p_obj );
1625 *psz_msg = (char*)malloc( 80 );
1626 sprintf( *psz_msg, "%s on object %s returned %i (%s)",
1627 psz_cmd, psz_name, i_ret, vlc_error( i_ret ) );