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 *****************************************************************************/
28 #include "variables.h"
31 # include <stdlib.h> /* realloc() */
35 /*****************************************************************************
37 *****************************************************************************/
38 struct callback_entry_t
40 vlc_callback_t pf_callback;
44 /*****************************************************************************
45 * Local comparison functions, returns 0 if v == w, < 0 if v < w, > 0 if v > w
46 *****************************************************************************/
47 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; }
48 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; }
49 static int CmpTime( vlc_value_t v, vlc_value_t w )
51 return v.i_time == w.i_time ? 0 : v.i_time > w.i_time ? 1 : -1;
53 static int CmpString( vlc_value_t v, vlc_value_t w ) { return strcmp( v.psz_string, w.psz_string ); }
54 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; }
55 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; }
57 /*****************************************************************************
58 * Local duplication functions, and local deallocation functions
59 *****************************************************************************/
60 static void DupDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
61 static void DupString( vlc_value_t *p_val ) { p_val->psz_string = strdup( p_val->psz_string ); }
63 static void DupList( vlc_value_t *p_val )
66 vlc_list_t *p_list = malloc( sizeof(vlc_list_t) );
68 p_list->i_count = p_val->p_list->i_count;
69 if( p_val->p_list->i_count )
71 p_list->p_values = malloc( p_list->i_count * sizeof(vlc_value_t) );
72 p_list->pi_types = malloc( p_list->i_count * sizeof(int) );
76 p_list->p_values = NULL;
77 p_list->pi_types = NULL;
80 for( i = 0; i < p_list->i_count; i++ )
82 p_list->p_values[i] = p_val->p_list->p_values[i];
83 p_list->pi_types[i] = p_val->p_list->pi_types[i];
84 switch( p_val->p_list->pi_types[i] & VLC_VAR_TYPE )
88 DupString( &p_list->p_values[i] );
95 p_val->p_list = p_list;
98 static void FreeDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
99 static void FreeString( vlc_value_t *p_val ) { free( p_val->psz_string ); }
100 static void FreeMutex( vlc_value_t *p_val ) { vlc_mutex_destroy( (vlc_mutex_t*)p_val->p_address ); free( p_val->p_address ); }
102 static void FreeList( vlc_value_t *p_val )
105 for( i = 0; i < p_val->p_list->i_count; i++ )
107 switch( p_val->p_list->pi_types[i] & VLC_VAR_TYPE )
110 FreeString( &p_val->p_list->p_values[i] );
113 FreeMutex( &p_val->p_list->p_values[i] );
120 if( p_val->p_list->i_count )
122 free( p_val->p_list->p_values );
123 free( p_val->p_list->pi_types );
125 free( p_val->p_list );
128 /*****************************************************************************
130 *****************************************************************************/
131 static int GetUnused ( vlc_object_t *, const char * );
132 static uint32_t HashString ( const char * );
133 static int Insert ( variable_t *, int, const char * );
134 static int InsertInner ( variable_t *, int, uint32_t );
135 static int Lookup ( variable_t *, int, const char * );
136 static int LookupInner ( variable_t *, int, uint32_t );
138 static void CheckValue ( variable_t *, vlc_value_t * );
140 static int InheritValue( vlc_object_t *, const char *, vlc_value_t *,
144 * Initialize a vlc variable
146 * We hash the given string and insert it into the sorted list. The insertion
147 * may require slow memory copies, but think about what we gain in the log(n)
148 * lookup phase when setting/getting the variable value!
150 * \param p_this The object in which to create the variable
151 * \param psz_name The name of the variable
152 * \param i_type The variables type. Must be one of \ref var_type combined with
153 * zero or more \ref var_flags
155 int __var_Create( vlc_object_t *p_this, const char *psz_name, int i_type )
159 static vlc_list_t dummy_null_list = {0, NULL, NULL};
161 vlc_mutex_lock( &p_this->var_lock );
163 /* FIXME: if the variable already exists, we don't duplicate it. But we
164 * duplicate the lookups. It's not that serious, but if anyone finds some
165 * time to rework Insert() so that only one lookup has to be done, feel
167 i_new = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
171 /* If the types differ, variable creation failed. */
172 if( (i_type & ~(VLC_VAR_DOINHERIT|VLC_VAR_ISCOMMAND)) != p_this->p_vars[i_new].i_type )
174 vlc_mutex_unlock( &p_this->var_lock );
178 p_this->p_vars[i_new].i_usage++;
179 if( i_type & VLC_VAR_ISCOMMAND )
180 p_this->p_vars[i_new].i_type |= VLC_VAR_ISCOMMAND;
181 vlc_mutex_unlock( &p_this->var_lock );
185 i_new = Insert( p_this->p_vars, p_this->i_vars, psz_name );
187 if( (p_this->i_vars & 15) == 15 )
189 p_this->p_vars = realloc( p_this->p_vars,
190 (p_this->i_vars+17) * sizeof(variable_t) );
193 memmove( p_this->p_vars + i_new + 1,
194 p_this->p_vars + i_new,
195 (p_this->i_vars - i_new) * sizeof(variable_t) );
199 p_var = &p_this->p_vars[i_new];
200 memset( p_var, 0, sizeof(*p_var) );
202 p_var->i_hash = HashString( psz_name );
203 p_var->psz_name = strdup( psz_name );
204 p_var->psz_text = NULL;
206 p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
207 memset( &p_var->val, 0, sizeof(vlc_value_t) );
209 p_var->pf_dup = DupDummy;
210 p_var->pf_free = FreeDummy;
214 p_var->i_default = -1;
215 p_var->choices.i_count = 0;
216 p_var->choices.p_values = NULL;
217 p_var->choices_text.i_count = 0;
218 p_var->choices_text.p_values = NULL;
220 p_var->b_incallback = VLC_FALSE;
221 p_var->i_entries = 0;
222 p_var->p_entries = NULL;
224 /* Always initialize the variable, even if it is a list variable; this
225 * will lead to errors if the variable is not initialized, but it will
226 * not cause crashes in the variable handling. */
227 switch( i_type & VLC_VAR_TYPE )
230 p_var->pf_cmp = CmpBool;
231 p_var->val.b_bool = VLC_FALSE;
233 case VLC_VAR_INTEGER:
235 p_var->pf_cmp = CmpInt;
236 p_var->val.i_int = 0;
241 case VLC_VAR_DIRECTORY:
242 case VLC_VAR_VARIABLE:
243 p_var->pf_cmp = CmpString;
244 p_var->pf_dup = DupString;
245 p_var->pf_free = FreeString;
246 p_var->val.psz_string = "";
249 p_var->pf_cmp = CmpFloat;
250 p_var->val.f_float = 0.0;
253 p_var->pf_cmp = CmpTime;
254 p_var->val.i_time = 0;
256 case VLC_VAR_ADDRESS:
257 p_var->pf_cmp = CmpAddress;
258 p_var->val.p_address = NULL;
261 p_var->pf_cmp = CmpAddress;
262 p_var->pf_free = FreeMutex;
263 p_var->val.p_address = malloc( sizeof(vlc_mutex_t) );
264 vlc_mutex_init( p_this, (vlc_mutex_t*)p_var->val.p_address );
267 p_var->pf_cmp = CmpAddress;
268 p_var->pf_dup = DupList;
269 p_var->pf_free = FreeList;
270 p_var->val.p_list = &dummy_null_list;
274 /* Duplicate the default data we stored. */
275 p_var->pf_dup( &p_var->val );
277 if( i_type & VLC_VAR_DOINHERIT )
281 if( InheritValue( p_this, psz_name, &val, p_var->i_type )
284 /* Free data if needed */
285 p_var->pf_free( &p_var->val );
286 /* Set the variable */
289 if( i_type & VLC_VAR_HASCHOICE )
291 /* We must add the inherited value to our choice list */
292 p_var->i_default = 0;
294 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
296 INSERT_ELEM( p_var->choices_text.p_values,
297 p_var->choices_text.i_count, 0, val );
298 p_var->pf_dup( &p_var->choices.p_values[0] );
299 p_var->choices_text.p_values[0].psz_string = NULL;
304 vlc_mutex_unlock( &p_this->var_lock );
310 * Destroy a vlc variable
312 * Look for the variable and destroy it if it is found. As in var_Create we
313 * do a call to memmove() but we have performance counterparts elsewhere.
315 * \param p_this The object that holds the variable
316 * \param psz_name The name of the variable
318 int __var_Destroy( vlc_object_t *p_this, const char *psz_name )
323 vlc_mutex_lock( &p_this->var_lock );
325 i_var = GetUnused( p_this, psz_name );
328 vlc_mutex_unlock( &p_this->var_lock );
332 p_var = &p_this->p_vars[i_var];
334 if( p_var->i_usage > 1 )
337 vlc_mutex_unlock( &p_this->var_lock );
341 /* Free value if needed */
342 p_var->pf_free( &p_var->val );
344 /* Free choice list if needed */
345 if( p_var->choices.i_count )
347 for( i = 0 ; i < p_var->choices.i_count ; i++ )
349 p_var->pf_free( &p_var->choices.p_values[i] );
350 if( p_var->choices_text.p_values[i].psz_string )
351 free( p_var->choices_text.p_values[i].psz_string );
353 free( p_var->choices.p_values );
354 free( p_var->choices_text.p_values );
357 /* Free callbacks if needed */
358 if( p_var->p_entries )
360 free( p_var->p_entries );
363 free( p_var->psz_name );
364 if( p_var->psz_text ) free( p_var->psz_text );
366 memmove( p_this->p_vars + i_var,
367 p_this->p_vars + i_var + 1,
368 (p_this->i_vars - i_var - 1) * sizeof(variable_t) );
370 if( (p_this->i_vars & 15) == 0 )
372 p_this->p_vars = realloc( p_this->p_vars,
373 (p_this->i_vars) * sizeof( variable_t ) );
378 vlc_mutex_unlock( &p_this->var_lock );
384 * Perform an action on a variable
386 * \param p_this The object that holds the variable
387 * \param psz_name The name of the variable
388 * \param i_action The action to perform. Must be one of \ref var_action
389 * \param p_val First action parameter
390 * \param p_val2 Second action parameter
392 int __var_Change( vlc_object_t *p_this, const char *psz_name,
393 int i_action, vlc_value_t *p_val, vlc_value_t *p_val2 )
399 vlc_mutex_lock( &p_this->var_lock );
401 i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
405 vlc_mutex_unlock( &p_this->var_lock );
409 p_var = &p_this->p_vars[i_var];
414 if( p_var->i_type & VLC_VAR_HASMIN )
416 p_var->pf_free( &p_var->min );
418 p_var->i_type |= VLC_VAR_HASMIN;
420 p_var->pf_dup( &p_var->min );
421 CheckValue( p_var, &p_var->val );
424 if( p_var->i_type & VLC_VAR_HASMAX )
426 p_var->pf_free( &p_var->max );
428 p_var->i_type |= VLC_VAR_HASMAX;
430 p_var->pf_dup( &p_var->max );
431 CheckValue( p_var, &p_var->val );
433 case VLC_VAR_SETSTEP:
434 if( p_var->i_type & VLC_VAR_HASSTEP )
436 p_var->pf_free( &p_var->step );
438 p_var->i_type |= VLC_VAR_HASSTEP;
439 p_var->step = *p_val;
440 p_var->pf_dup( &p_var->step );
441 CheckValue( p_var, &p_var->val );
443 case VLC_VAR_ADDCHOICE:
444 /* FIXME: the list is sorted, dude. Use something cleverer. */
445 for( i = p_var->choices.i_count ; i-- ; )
447 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) < 0 )
453 /* The new place is i+1 */
456 if( p_var->i_default >= i )
461 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
463 INSERT_ELEM( p_var->choices_text.p_values,
464 p_var->choices_text.i_count, i, *p_val );
465 p_var->pf_dup( &p_var->choices.p_values[i] );
466 p_var->choices_text.p_values[i].psz_string =
467 ( p_val2 && p_val2->psz_string ) ?
468 strdup( p_val2->psz_string ) : NULL;
470 CheckValue( p_var, &p_var->val );
472 case VLC_VAR_DELCHOICE:
473 /* FIXME: the list is sorted, dude. Use something cleverer. */
474 for( i = 0 ; i < p_var->choices.i_count ; i++ )
476 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
482 if( i == p_var->choices.i_count )
485 vlc_mutex_unlock( &p_this->var_lock );
489 if( p_var->i_default > i )
493 else if( p_var->i_default == i )
495 p_var->i_default = -1;
498 p_var->pf_free( &p_var->choices.p_values[i] );
499 if( p_var->choices_text.p_values[i].psz_string )
500 free( p_var->choices_text.p_values[i].psz_string );
501 REMOVE_ELEM( p_var->choices.p_values, p_var->choices.i_count, i );
502 REMOVE_ELEM( p_var->choices_text.p_values,
503 p_var->choices_text.i_count, i );
505 CheckValue( p_var, &p_var->val );
507 case VLC_VAR_CHOICESCOUNT:
508 p_val->i_int = p_var->choices.i_count;
510 case VLC_VAR_CLEARCHOICES:
511 for( i = 0 ; i < p_var->choices.i_count ; i++ )
513 p_var->pf_free( &p_var->choices.p_values[i] );
515 for( i = 0 ; i < p_var->choices_text.i_count ; i++ )
517 if( p_var->choices_text.p_values[i].psz_string )
518 free( p_var->choices_text.p_values[i].psz_string );
520 if( p_var->choices.i_count ) free( p_var->choices.p_values );
521 if( p_var->choices_text.i_count ) free( p_var->choices_text.p_values );
523 p_var->choices.i_count = 0;
524 p_var->choices.p_values = NULL;
525 p_var->choices_text.i_count = 0;
526 p_var->choices_text.p_values = NULL;
527 p_var->i_default = -1;
529 case VLC_VAR_SETDEFAULT:
530 /* FIXME: the list is sorted, dude. Use something cleverer. */
531 for( i = 0 ; i < p_var->choices.i_count ; i++ )
533 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
539 if( i == p_var->choices.i_count )
545 p_var->i_default = i;
546 CheckValue( p_var, &p_var->val );
548 case VLC_VAR_SETVALUE:
549 /* Duplicate data if needed */
550 p_var->pf_dup( p_val );
551 /* Backup needed stuff */
553 /* Check boundaries and list */
554 CheckValue( p_var, p_val );
555 /* Set the variable */
557 /* Free data if needed */
558 p_var->pf_free( &oldval );
560 case VLC_VAR_GETCHOICES:
561 case VLC_VAR_GETLIST:
562 p_val->p_list = malloc( sizeof(vlc_list_t) );
563 if( p_val2 ) p_val2->p_list = malloc( sizeof(vlc_list_t) );
564 if( p_var->choices.i_count )
566 p_val->p_list->p_values = malloc( p_var->choices.i_count
567 * sizeof(vlc_value_t) );
568 p_val->p_list->pi_types = malloc( p_var->choices.i_count
572 p_val2->p_list->p_values =
573 malloc( p_var->choices.i_count * sizeof(vlc_value_t) );
574 p_val2->p_list->pi_types =
575 malloc( p_var->choices.i_count * sizeof(int) );
578 p_val->p_list->i_count = p_var->choices.i_count;
579 if( p_val2 ) p_val2->p_list->i_count = p_var->choices.i_count;
580 for( i = 0 ; i < p_var->choices.i_count ; i++ )
582 p_val->p_list->p_values[i] = p_var->choices.p_values[i];
583 p_val->p_list->pi_types[i] = p_var->i_type;
584 p_var->pf_dup( &p_val->p_list->p_values[i] );
587 p_val2->p_list->p_values[i].psz_string =
588 p_var->choices_text.p_values[i].psz_string ?
589 strdup(p_var->choices_text.p_values[i].psz_string) : NULL;
590 p_val2->p_list->pi_types[i] = VLC_VAR_STRING;
594 case VLC_VAR_FREELIST:
596 if( p_val2 && p_val2->p_list )
598 for( i = 0; i < p_val2->p_list->i_count; i++ )
599 if( p_val2->p_list->p_values[i].psz_string )
600 free( p_val2->p_list->p_values[i].psz_string );
601 if( p_val2->p_list->i_count )
603 free( p_val2->p_list->p_values );
604 free( p_val2->p_list->pi_types );
606 free( p_val2->p_list );
609 case VLC_VAR_SETTEXT:
610 if( p_var->psz_text ) free( p_var->psz_text );
611 if( p_val && p_val->psz_string )
612 p_var->psz_text = strdup( p_val->psz_string );
614 case VLC_VAR_GETTEXT:
615 p_val->psz_string = NULL;
616 if( p_var->psz_text )
618 p_val->psz_string = strdup( p_var->psz_text );
621 case VLC_VAR_INHERITVALUE:
625 if( InheritValue( p_this, psz_name, &val, p_var->i_type )
628 /* Duplicate already done */
630 /* Backup needed stuff */
632 /* Check boundaries and list */
633 CheckValue( p_var, &val );
634 /* Set the variable */
636 /* Free data if needed */
637 p_var->pf_free( &oldval );
643 p_var->pf_dup( p_val );
647 case VLC_VAR_TRIGGER_CALLBACKS:
649 /* Deal with callbacks. Tell we're in a callback, release the lock,
650 * call stored functions, retake the lock. */
651 if( p_var->i_entries )
654 int i_entries = p_var->i_entries;
655 callback_entry_t *p_entries = p_var->p_entries;
657 p_var->b_incallback = VLC_TRUE;
658 vlc_mutex_unlock( &p_this->var_lock );
661 for( ; i_entries-- ; )
663 p_entries[i_entries].pf_callback( p_this, psz_name, p_var->val, p_var->val,
664 p_entries[i_entries].p_data );
667 vlc_mutex_lock( &p_this->var_lock );
669 i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
672 msg_Err( p_this, "variable %s has disappeared", psz_name );
673 vlc_mutex_unlock( &p_this->var_lock );
677 p_var = &p_this->p_vars[i_var];
678 p_var->b_incallback = VLC_FALSE;
687 vlc_mutex_unlock( &p_this->var_lock );
693 * Request a variable's type
695 * \return The variable type if it exists, or 0 if the
696 * variable could not be found.
699 int __var_Type( vlc_object_t *p_this, const char *psz_name )
703 vlc_mutex_lock( &p_this->var_lock );
705 i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
709 vlc_mutex_unlock( &p_this->var_lock );
713 i_type = p_this->p_vars[i_var].i_type;
715 vlc_mutex_unlock( &p_this->var_lock );
721 * Set a variable's value
723 * \param p_this The object that hold the variable
724 * \param psz_name The name of the variable
725 * \param val the value to set
727 int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val )
733 vlc_mutex_lock( &p_this->var_lock );
735 i_var = GetUnused( p_this, psz_name );
738 vlc_mutex_unlock( &p_this->var_lock );
742 p_var = &p_this->p_vars[i_var];
744 /* Duplicate data if needed */
745 p_var->pf_dup( &val );
747 /* Backup needed stuff */
750 /* Check boundaries and list */
751 CheckValue( p_var, &val );
753 /* Set the variable */
756 /* Deal with callbacks. Tell we're in a callback, release the lock,
757 * call stored functions, retake the lock. */
758 if( p_var->i_entries )
761 int i_entries = p_var->i_entries;
762 callback_entry_t *p_entries = p_var->p_entries;
764 p_var->b_incallback = VLC_TRUE;
765 vlc_mutex_unlock( &p_this->var_lock );
768 for( ; i_entries-- ; )
770 p_entries[i_entries].pf_callback( p_this, psz_name, oldval, val,
771 p_entries[i_entries].p_data );
774 vlc_mutex_lock( &p_this->var_lock );
776 i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
779 msg_Err( p_this, "variable %s has disappeared", psz_name );
780 vlc_mutex_unlock( &p_this->var_lock );
784 p_var = &p_this->p_vars[i_var];
785 p_var->b_incallback = VLC_FALSE;
788 /* Free data if needed */
789 p_var->pf_free( &oldval );
791 vlc_mutex_unlock( &p_this->var_lock );
797 * Get a variable's value
799 * \param p_this The object that holds the variable
800 * \param psz_name The name of the variable
801 * \param p_val Pointer to a vlc_value_t that will hold the variable's value
802 * after the function is finished
804 int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
809 vlc_mutex_lock( &p_this->var_lock );
811 i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
815 vlc_mutex_unlock( &p_this->var_lock );
819 p_var = &p_this->p_vars[i_var];
821 /* Really get the variable */
824 /* Duplicate value if needed */
825 p_var->pf_dup( p_val );
827 vlc_mutex_unlock( &p_this->var_lock );
834 * Gets a process-wide mutex, creates it if needed.
836 vlc_mutex_t *var_GetGlobalMutex( const char *name )
838 libvlc_global_data_t *p_global = vlc_global();
841 if( var_Create( p_global, name, VLC_VAR_MUTEX ) )
844 var_Get( p_global, name, &val );
845 return val.p_address;
850 * Register a callback in a variable
852 * We store a function pointer that will be called upon variable
855 * \param p_this The object that holds the variable
856 * \param psz_name The name of the variable
857 * \param pf_callback The function pointer
858 * \param p_data A generic pointer that will be passed as the last
859 * argument to the callback function.
861 * \warning The callback function is run in the thread that calls var_Set on
862 * the variable. Use proper locking. This thread may not have much
863 * time to spare, so keep callback functions short.
865 int __var_AddCallback( vlc_object_t *p_this, const char *psz_name,
866 vlc_callback_t pf_callback, void *p_data )
870 callback_entry_t entry;
872 entry.pf_callback = pf_callback;
873 entry.p_data = p_data;
875 vlc_mutex_lock( &p_this->var_lock );
877 i_var = GetUnused( p_this, psz_name );
880 vlc_mutex_unlock( &p_this->var_lock );
884 p_var = &p_this->p_vars[i_var];
886 INSERT_ELEM( p_var->p_entries,
891 vlc_mutex_unlock( &p_this->var_lock );
897 * Remove a callback from a variable
899 * pf_callback and p_data have to be given again, because different objects
900 * might have registered the same callback function.
902 int __var_DelCallback( vlc_object_t *p_this, const char *psz_name,
903 vlc_callback_t pf_callback, void *p_data )
908 vlc_mutex_lock( &p_this->var_lock );
910 i_var = GetUnused( p_this, psz_name );
913 vlc_mutex_unlock( &p_this->var_lock );
917 p_var = &p_this->p_vars[i_var];
919 for( i_entry = p_var->i_entries ; i_entry-- ; )
921 if( p_var->p_entries[i_entry].pf_callback == pf_callback
922 && p_var->p_entries[i_entry].p_data == p_data )
930 vlc_mutex_unlock( &p_this->var_lock );
934 REMOVE_ELEM( p_var->p_entries, p_var->i_entries, i_entry );
936 vlc_mutex_unlock( &p_this->var_lock );
942 * Trigger callback on a variable
944 * \param p_this The object that hold the variable
945 * \param psz_name The name of the variable
947 int __var_TriggerCallback( vlc_object_t *p_this, const char *psz_name )
953 vlc_mutex_lock( &p_this->var_lock );
955 i_var = GetUnused( p_this, psz_name );
958 vlc_mutex_unlock( &p_this->var_lock );
962 p_var = &p_this->p_vars[i_var];
964 /* Backup needed stuff */
967 /* Deal with callbacks. Tell we're in a callback, release the lock,
968 * call stored functions, retake the lock. */
969 if( p_var->i_entries )
972 int i_entries = p_var->i_entries;
973 callback_entry_t *p_entries = p_var->p_entries;
975 p_var->b_incallback = VLC_TRUE;
976 vlc_mutex_unlock( &p_this->var_lock );
979 for( ; i_entries-- ; )
981 p_entries[i_entries].pf_callback( p_this, psz_name, oldval, oldval,
982 p_entries[i_entries].p_data );
985 vlc_mutex_lock( &p_this->var_lock );
987 i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
990 msg_Err( p_this, "variable %s has disappeared", psz_name );
991 vlc_mutex_unlock( &p_this->var_lock );
995 p_var = &p_this->p_vars[i_var];
996 p_var->b_incallback = VLC_FALSE;
999 vlc_mutex_unlock( &p_this->var_lock );
1003 /** Parse a stringified option
1004 * This function parse a string option and create the associated object
1006 * The option must be of the form "[no[-]]foo[=bar]" where foo is the
1007 * option name and bar is the value of the option.
1008 * \param p_obj the object in which the variable must be created
1009 * \param psz_option the option to parse
1012 void __var_OptionParse( vlc_object_t *p_obj, const char *psz_option )
1014 char *psz_name, *psz_value = strchr( psz_option, '=' );
1015 int i_name_len, i_type;
1016 vlc_bool_t b_isno = VLC_FALSE;
1019 if( psz_value ) i_name_len = psz_value - psz_option;
1020 else i_name_len = strlen( psz_option );
1022 /* It's too much of a hassle to remove the ':' when we parse
1023 * the cmd line :) */
1024 if( i_name_len && *psz_option == ':' )
1030 if( i_name_len == 0 ) return;
1032 psz_name = strndup( psz_option, i_name_len );
1033 if( psz_value ) psz_value++;
1035 /* FIXME: :programs should be handled generically */
1036 if( !strcmp( psz_name, "programs" ) )
1037 i_type = VLC_VAR_LIST;
1039 i_type = config_GetType( p_obj, psz_name );
1041 if( !i_type && !psz_value )
1043 /* check for "no-foo" or "nofoo" */
1044 if( !strncmp( psz_name, "no-", 3 ) )
1046 memmove( psz_name, psz_name + 3, strlen(psz_name) + 1 - 3 );
1048 else if( !strncmp( psz_name, "no", 2 ) )
1050 memmove( psz_name, psz_name + 2, strlen(psz_name) + 1 - 2 );
1052 else goto cleanup; /* Option doesn't exist */
1055 i_type = config_GetType( p_obj, psz_name );
1057 if( !i_type ) goto cleanup; /* Option doesn't exist */
1059 else if( !i_type ) goto cleanup; /* Option doesn't exist */
1061 if( ( i_type != VLC_VAR_BOOL ) &&
1062 ( !psz_value || !*psz_value ) ) goto cleanup; /* Invalid value */
1064 /* Create the variable in the input object.
1065 * Children of the input object will be able to retreive this value
1066 * thanks to the inheritance property of the object variables. */
1067 var_Create( p_obj, psz_name, i_type );
1072 val.b_bool = !b_isno;
1075 case VLC_VAR_INTEGER:
1076 val.i_int = strtol( psz_value, NULL, 0 );
1080 val.f_float = atof( psz_value );
1083 case VLC_VAR_STRING:
1084 case VLC_VAR_MODULE:
1086 case VLC_VAR_DIRECTORY:
1087 val.psz_string = psz_value;
1092 char *psz_orig, *psz_var;
1093 vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1094 val.p_list = p_list;
1095 p_list->i_count = 0;
1097 psz_var = psz_orig = strdup(psz_value);
1098 while( psz_var && *psz_var )
1100 char *psz_item = psz_var;
1102 while( *psz_var && *psz_var != ',' ) psz_var++;
1103 if( *psz_var == ',' )
1108 val2.i_int = strtol( psz_item, NULL, 0 );
1109 INSERT_ELEM( p_list->p_values, p_list->i_count,
1110 p_list->i_count, val2 );
1111 /* p_list->i_count is incremented twice by INSERT_ELEM */
1113 INSERT_ELEM( p_list->pi_types, p_list->i_count,
1114 p_list->i_count, VLC_VAR_INTEGER );
1116 if( psz_orig ) free( psz_orig );
1125 var_Set( p_obj, psz_name, val );
1128 if( psz_name ) free( psz_name );
1133 /* Following functions are local */
1135 /*****************************************************************************
1136 * GetUnused: find an unused variable from its name
1137 *****************************************************************************
1138 * We do i_tries tries before giving up, just in case the variable is being
1139 * modified and called from a callback.
1140 *****************************************************************************/
1141 static int GetUnused( vlc_object_t *p_this, const char *psz_name )
1143 int i_var, i_tries = 0;
1147 i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
1153 if( ! p_this->p_vars[i_var].b_incallback )
1158 if( i_tries++ > 100 )
1160 msg_Err( p_this, "caught in a callback deadlock?" );
1161 return VLC_ETIMEOUT;
1164 vlc_mutex_unlock( &p_this->var_lock );
1165 msleep( THREAD_SLEEP );
1166 vlc_mutex_lock( &p_this->var_lock );
1170 /*****************************************************************************
1171 * HashString: our cool hash function
1172 *****************************************************************************
1173 * This function is not intended to be crypto-secure, we only want it to be
1174 * fast and not suck too much. This one is pretty fast and did 0 collisions
1175 * in wenglish's dictionary.
1176 *****************************************************************************/
1177 static uint32_t HashString( const char *psz_string )
1179 uint32_t i_hash = 0;
1181 while( *psz_string )
1183 i_hash += *psz_string++;
1184 i_hash += i_hash << 10;
1185 i_hash ^= i_hash >> 8;
1191 /*****************************************************************************
1192 * Insert: find an empty slot to insert a new variable
1193 *****************************************************************************
1194 * We use a recursive inner function indexed on the hash. This function does
1195 * nothing in the rare cases where a collision may occur, see Lookup()
1196 * to see how we handle them.
1197 * XXX: does this really need to be written recursively?
1198 *****************************************************************************/
1199 static int Insert( variable_t *p_vars, int i_count, const char *psz_name )
1206 return InsertInner( p_vars, i_count, HashString( psz_name ) );
1209 static int InsertInner( variable_t *p_vars, int i_count, uint32_t i_hash )
1213 if( i_hash <= p_vars[0].i_hash )
1218 if( i_hash >= p_vars[i_count - 1].i_hash )
1223 i_middle = i_count / 2;
1225 /* We know that 0 < i_middle */
1226 if( i_hash < p_vars[i_middle].i_hash )
1228 return InsertInner( p_vars, i_middle, i_hash );
1231 /* We know that i_middle + 1 < i_count */
1232 if( i_hash > p_vars[i_middle + 1].i_hash )
1234 return i_middle + 1 + InsertInner( p_vars + i_middle + 1,
1235 i_count - i_middle - 1,
1239 return i_middle + 1;
1242 /*****************************************************************************
1243 * Lookup: find an existing variable given its name
1244 *****************************************************************************
1245 * We use a recursive inner function indexed on the hash. Care is taken of
1246 * possible hash collisions.
1247 * XXX: does this really need to be written recursively?
1248 *****************************************************************************/
1249 static int Lookup( variable_t *p_vars, int i_count, const char *psz_name )
1259 i_hash = HashString( psz_name );
1261 i_pos = LookupInner( p_vars, i_count, i_hash );
1263 /* Hash not found */
1264 if( i_hash != p_vars[i_pos].i_hash )
1269 /* Hash found, entry found */
1270 if( !strcmp( psz_name, p_vars[i_pos].psz_name ) )
1275 /* Hash collision! This should be very rare, but we cannot guarantee
1276 * it will never happen. Just do an exhaustive search amongst all
1277 * entries with the same hash. */
1278 for( i = i_pos - 1 ; i > 0 && i_hash == p_vars[i].i_hash ; i-- )
1280 if( !strcmp( psz_name, p_vars[i].psz_name ) )
1286 for( i = i_pos + 1 ; i < i_count && i_hash == p_vars[i].i_hash ; i++ )
1288 if( !strcmp( psz_name, p_vars[i].psz_name ) )
1294 /* Hash found, but entry not found */
1298 static int LookupInner( variable_t *p_vars, int i_count, uint32_t i_hash )
1302 if( i_hash <= p_vars[0].i_hash )
1307 if( i_hash >= p_vars[i_count-1].i_hash )
1312 i_middle = i_count / 2;
1314 /* We know that 0 < i_middle */
1315 if( i_hash < p_vars[i_middle].i_hash )
1317 return LookupInner( p_vars, i_middle, i_hash );
1320 /* We know that i_middle + 1 < i_count */
1321 if( i_hash > p_vars[i_middle].i_hash )
1323 return i_middle + LookupInner( p_vars + i_middle,
1331 /*****************************************************************************
1332 * CheckValue: check that a value is valid wrt. a variable
1333 *****************************************************************************
1334 * This function checks p_val's value against p_var's limitations such as
1335 * minimal and maximal value, step, in-list position, and modifies p_val if
1337 ****************************************************************************/
1338 static void CheckValue ( variable_t *p_var, vlc_value_t *p_val )
1340 /* Check that our variable is in the list */
1341 if( p_var->i_type & VLC_VAR_HASCHOICE && p_var->choices.i_count )
1345 /* FIXME: the list is sorted, dude. Use something cleverer. */
1346 for( i = p_var->choices.i_count ; i-- ; )
1348 if( p_var->pf_cmp( *p_val, p_var->choices.p_values[i] ) == 0 )
1354 /* If not found, change it to anything vaguely valid */
1357 /* Free the old variable, get the new one, dup it */
1358 p_var->pf_free( p_val );
1359 *p_val = p_var->choices.p_values[p_var->i_default >= 0
1360 ? p_var->i_default : 0 ];
1361 p_var->pf_dup( p_val );
1365 /* Check that our variable is within the bounds */
1366 switch( p_var->i_type & VLC_VAR_TYPE )
1368 case VLC_VAR_INTEGER:
1369 if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.i_int
1370 && (p_val->i_int % p_var->step.i_int) )
1372 p_val->i_int = (p_val->i_int + (p_var->step.i_int / 2))
1373 / p_var->step.i_int * p_var->step.i_int;
1375 if( p_var->i_type & VLC_VAR_HASMIN
1376 && p_val->i_int < p_var->min.i_int )
1378 p_val->i_int = p_var->min.i_int;
1380 if( p_var->i_type & VLC_VAR_HASMAX
1381 && p_val->i_int > p_var->max.i_int )
1383 p_val->i_int = p_var->max.i_int;
1387 if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.f_float )
1389 float f_round = p_var->step.f_float * (float)(int)( 0.5 +
1390 p_val->f_float / p_var->step.f_float );
1391 if( p_val->f_float != f_round )
1393 p_val->f_float = f_round;
1396 if( p_var->i_type & VLC_VAR_HASMIN
1397 && p_val->f_float < p_var->min.f_float )
1399 p_val->f_float = p_var->min.f_float;
1401 if( p_var->i_type & VLC_VAR_HASMAX
1402 && p_val->f_float > p_var->max.f_float )
1404 p_val->f_float = p_var->max.f_float;
1413 /*****************************************************************************
1414 * InheritValue: try to inherit the value of this variable from the same one
1415 * in our closest parent.
1416 *****************************************************************************/
1417 static int InheritValue( vlc_object_t *p_this, const char *psz_name,
1418 vlc_value_t *p_val, int i_type )
1423 /* No need to take the structure lock,
1424 * we are only looking for our parents */
1426 if( !p_this->p_parent )
1428 switch( i_type & VLC_VAR_TYPE )
1431 case VLC_VAR_DIRECTORY:
1432 case VLC_VAR_STRING:
1433 case VLC_VAR_MODULE:
1434 p_val->psz_string = config_GetPsz( p_this, psz_name );
1435 if( !p_val->psz_string ) p_val->psz_string = strdup("");
1438 p_val->f_float = config_GetFloat( p_this, psz_name );
1440 case VLC_VAR_INTEGER:
1441 case VLC_VAR_HOTKEY:
1442 p_val->i_int = config_GetInt( p_this, psz_name );
1445 p_val->b_bool = config_GetInt( p_this, psz_name );
1449 char *psz_orig, *psz_var;
1450 vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1451 p_val->p_list = p_list;
1452 p_list->i_count = 0;
1454 psz_var = psz_orig = config_GetPsz( p_this, psz_name );
1455 while( psz_var && *psz_var )
1457 char *psz_item = psz_var;
1459 while( *psz_var && *psz_var != ',' ) psz_var++;
1460 if( *psz_var == ',' )
1465 val.i_int = strtol( psz_item, NULL, 0 );
1466 INSERT_ELEM( p_list->p_values, p_list->i_count,
1467 p_list->i_count, val );
1468 /* p_list->i_count is incremented twice by INSERT_ELEM */
1470 INSERT_ELEM( p_list->pi_types, p_list->i_count,
1471 p_list->i_count, VLC_VAR_INTEGER );
1473 if( psz_orig ) free( psz_orig );
1484 /* Look for the variable */
1485 vlc_mutex_lock( &p_this->p_parent->var_lock );
1487 i_var = Lookup( p_this->p_parent->p_vars, p_this->p_parent->i_vars,
1493 p_var = &p_this->p_parent->p_vars[i_var];
1495 /* Really get the variable */
1496 *p_val = p_var->val;
1498 /* Duplicate value if needed */
1499 p_var->pf_dup( p_val );
1501 vlc_mutex_unlock( &p_this->p_parent->var_lock );
1505 vlc_mutex_unlock( &p_this->p_parent->var_lock );
1507 /* We're still not there */
1509 return InheritValue( p_this->p_parent, psz_name, p_val, i_type );
1512 /**********************************************************************
1513 * Execute a var command on an object identified by its name
1514 **********************************************************************/
1515 int __var_Command( vlc_object_t *p_this, const char *psz_name,
1516 const char *psz_cmd, const char *psz_arg, char **psz_msg )
1518 vlc_object_t *p_obj = vlc_object_find_name( p_this->p_libvlc,
1519 psz_name, FIND_CHILD );
1525 *psz_msg = strdup( "Unknown destination object." );
1529 i_type = var_Type( p_obj, psz_cmd );
1530 if( !( i_type&VLC_VAR_ISCOMMAND ) )
1532 vlc_object_release( p_obj );
1534 *psz_msg = strdup( "Variable doesn't exist or isn't a command." );
1535 return VLC_EGENERIC;
1541 case VLC_VAR_INTEGER:
1542 i_ret = var_SetInteger( p_obj, psz_cmd, atoi( psz_arg ) );
1545 i_ret = var_SetFloat( p_obj, psz_cmd, atof( psz_arg ) );
1547 case VLC_VAR_STRING:
1548 i_ret = var_SetString( p_obj, psz_cmd, psz_arg );
1551 i_ret = var_SetBool( p_obj, psz_cmd, atoi( psz_arg ) );
1554 i_ret = VLC_EGENERIC;
1558 vlc_object_release( p_obj );
1562 *psz_msg = (char*)malloc( 80 );
1563 sprintf( *psz_msg, "%s on object %s returned %i (%s)",
1564 psz_cmd, psz_name, i_ret, vlc_error( i_ret ) );