variables: fix a segfault and memory leak when TriggerCallback is called (crash
[vlc.git] / src / misc / variables.c
1 /*****************************************************************************
2  * variables.c: routines for object variables handling
3  *****************************************************************************
4  * Copyright (C) 2002-2009 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include "variables.h"
33
34 #include "libvlc.h"
35
36 #include "vlc_interface.h"
37 #include <assert.h>
38
39 /*****************************************************************************
40  * Private types
41  *****************************************************************************/
42 struct callback_entry_t
43 {
44     vlc_callback_t pf_callback;
45     void *         p_data;
46 };
47
48 /*****************************************************************************
49  * Local comparison functions, returns 0 if v == w, < 0 if v < w, > 0 if v > w
50  *****************************************************************************/
51 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; }
52 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; }
53 static int CmpTime( vlc_value_t v, vlc_value_t w )
54 {
55     return v.i_time == w.i_time ? 0 : v.i_time > w.i_time ? 1 : -1;
56 }
57 static int CmpString( vlc_value_t v, vlc_value_t w )
58 {
59     if( !v.psz_string )
60         return !w.psz_string ? 0 : -1;
61     else
62         return !w.psz_string ? 1 : strcmp( v.psz_string, w.psz_string );
63 }
64 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; }
65 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 /*****************************************************************************
68  * Local duplication functions, and local deallocation functions
69  *****************************************************************************/
70 static void DupDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
71 static void DupString( vlc_value_t *p_val )
72 {
73     p_val->psz_string = strdup( p_val->psz_string ? p_val->psz_string :  "" );
74 }
75
76 static void DupList( vlc_value_t *p_val )
77 {
78     int i;
79     vlc_list_t *p_list = malloc( sizeof(vlc_list_t) );
80
81     p_list->i_count = p_val->p_list->i_count;
82     if( p_val->p_list->i_count )
83     {
84         p_list->p_values = malloc( p_list->i_count * sizeof(vlc_value_t) );
85         p_list->pi_types = malloc( p_list->i_count * sizeof(int) );
86     }
87     else
88     {
89         p_list->p_values = NULL;
90         p_list->pi_types = NULL;
91     }
92
93     for( i = 0; i < p_list->i_count; i++ )
94     {
95         p_list->p_values[i] = p_val->p_list->p_values[i];
96         p_list->pi_types[i] = p_val->p_list->pi_types[i];
97         switch( p_val->p_list->pi_types[i] & VLC_VAR_CLASS )
98         {
99         case VLC_VAR_STRING:
100
101             DupString( &p_list->p_values[i] );
102             break;
103         default:
104             break;
105         }
106     }
107
108     p_val->p_list = p_list;
109 }
110
111 static void FreeDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
112 static void FreeString( vlc_value_t *p_val ) { free( p_val->psz_string ); }
113 static void FreeMutex( vlc_value_t *p_val ) { vlc_mutex_destroy( (vlc_mutex_t*)p_val->p_address ); free( p_val->p_address ); }
114
115 static void FreeList( vlc_value_t *p_val )
116 {
117     int i;
118     for( i = 0; i < p_val->p_list->i_count; i++ )
119     {
120         switch( p_val->p_list->pi_types[i] & VLC_VAR_CLASS )
121         {
122         case VLC_VAR_STRING:
123             FreeString( &p_val->p_list->p_values[i] );
124             break;
125         case VLC_VAR_MUTEX:
126             FreeMutex( &p_val->p_list->p_values[i] );
127             break;
128         default:
129             break;
130         }
131     }
132
133     if( p_val->p_list->i_count )
134     {
135         free( p_val->p_list->p_values );
136         free( p_val->p_list->pi_types );
137     }
138     free( p_val->p_list );
139 }
140
141 static const struct variable_ops_t
142 void_ops   = { NULL,       DupDummy,  FreeDummy,  },
143 addr_ops   = { CmpAddress, DupDummy,  FreeDummy,  },
144 bool_ops   = { CmpBool,    DupDummy,  FreeDummy,  },
145 float_ops  = { CmpFloat,   DupDummy,  FreeDummy,  },
146 int_ops    = { CmpInt,     DupDummy,  FreeDummy,  },
147 list_ops   = { CmpAddress, DupList,   FreeList,   },
148 mutex_ops  = { CmpAddress, DupDummy,  FreeMutex,  },
149 string_ops = { CmpString,  DupString, FreeString, },
150 time_ops   = { CmpTime,    DupDummy,  FreeDummy,  };
151
152 /*****************************************************************************
153  * Local prototypes
154  *****************************************************************************/
155 static int      GetUnused   ( vlc_object_t *, const char * );
156 static uint32_t HashString  ( const char * );
157 static int      Insert      ( variable_t *, int, const char * );
158 static int      InsertInner ( variable_t *, int, uint32_t );
159 static int      Lookup      ( variable_t *, size_t, const char * );
160
161 static void     CheckValue  ( variable_t *, vlc_value_t * );
162
163 static int      InheritValue( vlc_object_t *, const char *, vlc_value_t *,
164                               int );
165 static int      TriggerCallback( vlc_object_t *, variable_t **, const char *,
166                                  vlc_value_t );
167
168 /**
169  * Initialize a vlc variable
170  *
171  * We hash the given string and insert it into the sorted list. The insertion
172  * may require slow memory copies, but think about what we gain in the log(n)
173  * lookup phase when setting/getting the variable value!
174  *
175  * \param p_this The object in which to create the variable
176  * \param psz_name The name of the variable
177  * \param i_type The variables type. Must be one of \ref var_type combined with
178  *               zero or more \ref var_flags
179  */
180 int __var_Create( vlc_object_t *p_this, const char *psz_name, int i_type )
181 {
182     int i_new;
183     variable_t *p_var;
184     static vlc_list_t dummy_null_list = {0, NULL, NULL};
185     vlc_object_internals_t *p_priv = vlc_internals( p_this );
186
187     vlc_mutex_lock( &p_priv->var_lock );
188
189     /* FIXME: if the variable already exists, we don't duplicate it. But we
190      * duplicate the lookups. It's not that serious, but if anyone finds some
191      * time to rework Insert() so that only one lookup has to be done, feel
192      * free to do so. */
193     i_new = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
194
195     if( i_new >= 0 )
196     {
197         /* If the types differ, variable creation failed. */
198         if( (i_type & VLC_VAR_TYPE) != (p_priv->p_vars[i_new].i_type & VLC_VAR_TYPE) )
199         {
200             vlc_mutex_unlock( &p_priv->var_lock );
201             return VLC_EBADVAR;
202         }
203
204         p_priv->p_vars[i_new].i_usage++;
205         p_priv->p_vars[i_new].i_type |= ( i_type & VLC_VAR_ISCOMMAND );
206         p_priv->p_vars[i_new].i_type |= ( i_type & VLC_VAR_HASCHOICE );
207         vlc_mutex_unlock( &p_priv->var_lock );
208         return VLC_SUCCESS;
209     }
210
211     i_new = Insert( p_priv->p_vars, p_priv->i_vars, psz_name );
212
213     if( (p_priv->i_vars & 15) == 15 )
214     {
215         p_priv->p_vars = realloc( p_priv->p_vars,
216                                   (p_priv->i_vars+17) * sizeof(variable_t) );
217     }
218
219     memmove( p_priv->p_vars + i_new + 1,
220              p_priv->p_vars + i_new,
221              (p_priv->i_vars - i_new) * sizeof(variable_t) );
222
223     p_priv->i_vars++;
224
225     p_var = &p_priv->p_vars[i_new];
226     memset( p_var, 0, sizeof(*p_var) );
227
228     p_var->i_hash = HashString( psz_name );
229     p_var->psz_name = strdup( psz_name );
230     p_var->psz_text = NULL;
231
232     p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
233
234     p_var->i_usage = 1;
235
236     p_var->i_default = -1;
237     p_var->choices.i_count = 0;
238     p_var->choices.p_values = NULL;
239     p_var->choices_text.i_count = 0;
240     p_var->choices_text.p_values = NULL;
241
242     p_var->b_incallback = false;
243     p_var->i_entries = 0;
244     p_var->p_entries = NULL;
245
246     /* Always initialize the variable, even if it is a list variable; this
247      * will lead to errors if the variable is not initialized, but it will
248      * not cause crashes in the variable handling. */
249     switch( i_type & VLC_VAR_CLASS )
250     {
251         case VLC_VAR_BOOL:
252             p_var->ops = &bool_ops;
253             p_var->val.b_bool = false;
254             break;
255         case VLC_VAR_INTEGER:
256             p_var->ops = &int_ops;
257             p_var->val.i_int = 0;
258             break;
259         case VLC_VAR_STRING:
260             p_var->ops = &string_ops;
261             p_var->val.psz_string = NULL;
262             break;
263         case VLC_VAR_FLOAT:
264             p_var->ops = &float_ops;
265             p_var->val.f_float = 0.0;
266             break;
267         case VLC_VAR_TIME:
268             p_var->ops = &time_ops;
269             p_var->val.i_time = 0;
270             break;
271         case VLC_VAR_ADDRESS:
272             p_var->ops = &addr_ops;
273             p_var->val.p_address = NULL;
274             break;
275         case VLC_VAR_MUTEX:
276             p_var->ops = &mutex_ops;
277             p_var->val.p_address = malloc( sizeof(vlc_mutex_t) );
278             vlc_mutex_init( (vlc_mutex_t*)p_var->val.p_address );
279             break;
280         case VLC_VAR_LIST:
281             p_var->ops = &list_ops;
282             p_var->val.p_list = &dummy_null_list;
283             break;
284         default:
285             p_var->ops = &void_ops;
286             break;
287     }
288
289     /* Duplicate the default data we stored. */
290     p_var->ops->pf_dup( &p_var->val );
291
292     if( i_type & VLC_VAR_DOINHERIT )
293     {
294         vlc_value_t val;
295
296         if( InheritValue( p_this, psz_name, &val, p_var->i_type )
297             == VLC_SUCCESS )
298         {
299             /* Free data if needed */
300             p_var->ops->pf_free( &p_var->val );
301             /* Set the variable */
302             p_var->val = val;
303
304             if( i_type & VLC_VAR_HASCHOICE )
305             {
306                 /* We must add the inherited value to our choice list */
307                 p_var->i_default = 0;
308
309                 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
310                              0, val );
311                 INSERT_ELEM( p_var->choices_text.p_values,
312                              p_var->choices_text.i_count, 0, val );
313                 p_var->ops->pf_dup( &p_var->choices.p_values[0] );
314                 p_var->choices_text.p_values[0].psz_string = NULL;
315             }
316         }
317     }
318
319     vlc_mutex_unlock( &p_priv->var_lock );
320
321     return VLC_SUCCESS;
322 }
323
324 /**
325  * Destroy a vlc variable
326  *
327  * Look for the variable and destroy it if it is found. As in var_Create we
328  * do a call to memmove() but we have performance counterparts elsewhere.
329  *
330  * \param p_this The object that holds the variable
331  * \param psz_name The name of the variable
332  */
333 int __var_Destroy( vlc_object_t *p_this, const char *psz_name )
334 {
335     int i_var, i;
336     variable_t *p_var;
337     vlc_object_internals_t *p_priv = vlc_internals( p_this );
338
339     vlc_mutex_lock( &p_priv->var_lock );
340
341     i_var = GetUnused( p_this, psz_name );
342     if( i_var < 0 )
343     {
344         vlc_mutex_unlock( &p_priv->var_lock );
345         return i_var;
346     }
347
348     p_var = &p_priv->p_vars[i_var];
349
350     if( p_var->i_usage > 1 )
351     {
352         p_var->i_usage--;
353         vlc_mutex_unlock( &p_priv->var_lock );
354         return VLC_SUCCESS;
355     }
356
357     /* Free value if needed */
358     p_var->ops->pf_free( &p_var->val );
359
360     /* Free choice list if needed */
361     if( p_var->choices.i_count )
362     {
363         for( i = 0 ; i < p_var->choices.i_count ; i++ )
364         {
365             p_var->ops->pf_free( &p_var->choices.p_values[i] );
366             free( p_var->choices_text.p_values[i].psz_string );
367         }
368         free( p_var->choices.p_values );
369         free( p_var->choices_text.p_values );
370     }
371
372     /* Free callbacks if needed */
373     if( p_var->p_entries )
374     {
375         free( p_var->p_entries );
376     }
377
378     free( p_var->psz_name );
379     free( p_var->psz_text );
380
381     memmove( p_priv->p_vars + i_var,
382              p_priv->p_vars + i_var + 1,
383              (p_priv->i_vars - i_var - 1) * sizeof(variable_t) );
384
385     if( (p_priv->i_vars & 15) == 0 )
386     {
387         p_priv->p_vars = realloc( p_priv->p_vars,
388                           (p_priv->i_vars) * sizeof( variable_t ) );
389     }
390
391     p_priv->i_vars--;
392
393     vlc_mutex_unlock( &p_priv->var_lock );
394
395     return VLC_SUCCESS;
396 }
397
398 /**
399  * Perform an action on a variable
400  *
401  * \param p_this The object that holds the variable
402  * \param psz_name The name of the variable
403  * \param i_action The action to perform. Must be one of \ref var_action
404  * \param p_val First action parameter
405  * \param p_val2 Second action parameter
406  */
407 int __var_Change( vlc_object_t *p_this, const char *psz_name,
408                   int i_action, vlc_value_t *p_val, vlc_value_t *p_val2 )
409 {
410     int i_var, i;
411     variable_t *p_var;
412     vlc_value_t oldval;
413     vlc_object_internals_t *p_priv = vlc_internals( p_this );
414
415     vlc_mutex_lock( &p_priv->var_lock );
416
417     i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
418
419     if( i_var < 0 )
420     {
421         vlc_mutex_unlock( &p_priv->var_lock );
422         return VLC_ENOVAR;
423     }
424
425     p_var = &p_priv->p_vars[i_var];
426
427     switch( i_action )
428     {
429         case VLC_VAR_SETMIN:
430             if( p_var->i_type & VLC_VAR_HASMIN )
431             {
432                 p_var->ops->pf_free( &p_var->min );
433             }
434             p_var->i_type |= VLC_VAR_HASMIN;
435             p_var->min = *p_val;
436             p_var->ops->pf_dup( &p_var->min );
437             CheckValue( p_var, &p_var->val );
438             break;
439         case VLC_VAR_GETMIN:
440             if( p_var->i_type & VLC_VAR_HASMIN )
441             {
442                 *p_val = p_var->min;
443             }
444             break;
445         case VLC_VAR_SETMAX:
446             if( p_var->i_type & VLC_VAR_HASMAX )
447             {
448                 p_var->ops->pf_free( &p_var->max );
449             }
450             p_var->i_type |= VLC_VAR_HASMAX;
451             p_var->max = *p_val;
452             p_var->ops->pf_dup( &p_var->max );
453             CheckValue( p_var, &p_var->val );
454             break;
455         case VLC_VAR_GETMAX:
456             if( p_var->i_type & VLC_VAR_HASMAX )
457             {
458                 *p_val = p_var->max;
459             }
460             break;
461         case VLC_VAR_SETSTEP:
462             if( p_var->i_type & VLC_VAR_HASSTEP )
463             {
464                 p_var->ops->pf_free( &p_var->step );
465             }
466             p_var->i_type |= VLC_VAR_HASSTEP;
467             p_var->step = *p_val;
468             p_var->ops->pf_dup( &p_var->step );
469             CheckValue( p_var, &p_var->val );
470             break;
471         case VLC_VAR_GETSTEP:
472             if( p_var->i_type & VLC_VAR_HASSTEP )
473             {
474                 *p_val = p_var->step;
475             }
476             break;
477         case VLC_VAR_ADDCHOICE:
478             i = p_var->choices.i_count;
479
480             INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
481                          i, *p_val );
482             INSERT_ELEM( p_var->choices_text.p_values,
483                          p_var->choices_text.i_count, i, *p_val );
484             p_var->ops->pf_dup( &p_var->choices.p_values[i] );
485             p_var->choices_text.p_values[i].psz_string =
486                 ( p_val2 && p_val2->psz_string ) ?
487                 strdup( p_val2->psz_string ) : NULL;
488
489             CheckValue( p_var, &p_var->val );
490             break;
491         case VLC_VAR_DELCHOICE:
492             for( i = 0 ; i < p_var->choices.i_count ; i++ )
493             {
494                 if( p_var->ops->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
495                 {
496                     break;
497                 }
498             }
499
500             if( i == p_var->choices.i_count )
501             {
502                 /* Not found */
503                 vlc_mutex_unlock( &p_priv->var_lock );
504                 return VLC_EGENERIC;
505             }
506
507             if( p_var->i_default > i )
508             {
509                 p_var->i_default--;
510             }
511             else if( p_var->i_default == i )
512             {
513                 p_var->i_default = -1;
514             }
515
516             p_var->ops->pf_free( &p_var->choices.p_values[i] );
517             free( p_var->choices_text.p_values[i].psz_string );
518             REMOVE_ELEM( p_var->choices.p_values, p_var->choices.i_count, i );
519             REMOVE_ELEM( p_var->choices_text.p_values,
520                          p_var->choices_text.i_count, i );
521
522             CheckValue( p_var, &p_var->val );
523             break;
524         case VLC_VAR_CHOICESCOUNT:
525             p_val->i_int = p_var->choices.i_count;
526             break;
527         case VLC_VAR_CLEARCHOICES:
528             for( i = 0 ; i < p_var->choices.i_count ; i++ )
529             {
530                 p_var->ops->pf_free( &p_var->choices.p_values[i] );
531             }
532             for( i = 0 ; i < p_var->choices_text.i_count ; i++ )
533                 free( p_var->choices_text.p_values[i].psz_string );
534
535             if( p_var->choices.i_count ) free( p_var->choices.p_values );
536             if( p_var->choices_text.i_count ) free( p_var->choices_text.p_values );
537
538             p_var->choices.i_count = 0;
539             p_var->choices.p_values = NULL;
540             p_var->choices_text.i_count = 0;
541             p_var->choices_text.p_values = NULL;
542             p_var->i_default = -1;
543             break;
544         case VLC_VAR_SETDEFAULT:
545             /* FIXME: the list is sorted, dude. Use something cleverer. */
546             for( i = 0 ; i < p_var->choices.i_count ; i++ )
547             {
548                 if( p_var->ops->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
549                 {
550                     break;
551                 }
552             }
553
554             if( i == p_var->choices.i_count )
555             {
556                 /* Not found */
557                 break;
558             }
559
560             p_var->i_default = i;
561             CheckValue( p_var, &p_var->val );
562             break;
563         case VLC_VAR_SETVALUE:
564             /* Duplicate data if needed */
565             p_var->ops->pf_dup( p_val );
566             /* Backup needed stuff */
567             oldval = p_var->val;
568             /* Check boundaries and list */
569             CheckValue( p_var, p_val );
570             /* Set the variable */
571             p_var->val = *p_val;
572             /* Free data if needed */
573             p_var->ops->pf_free( &oldval );
574             break;
575         case VLC_VAR_GETCHOICES:
576         case VLC_VAR_GETLIST:
577             p_val->p_list = malloc( sizeof(vlc_list_t) );
578             if( p_val2 ) p_val2->p_list = malloc( sizeof(vlc_list_t) );
579             if( p_var->choices.i_count )
580             {
581                 p_val->p_list->p_values = malloc( p_var->choices.i_count
582                                                   * sizeof(vlc_value_t) );
583                 p_val->p_list->pi_types = malloc( p_var->choices.i_count
584                                                   * sizeof(int) );
585                 if( p_val2 )
586                 {
587                     p_val2->p_list->p_values =
588                         malloc( p_var->choices.i_count * sizeof(vlc_value_t) );
589                     p_val2->p_list->pi_types =
590                         malloc( p_var->choices.i_count * sizeof(int) );
591                 }
592             }
593             p_val->p_list->i_count = p_var->choices.i_count;
594             if( p_val2 ) p_val2->p_list->i_count = p_var->choices.i_count;
595             for( i = 0 ; i < p_var->choices.i_count ; i++ )
596             {
597                 p_val->p_list->p_values[i] = p_var->choices.p_values[i];
598                 p_val->p_list->pi_types[i] = p_var->i_type;
599                 p_var->ops->pf_dup( &p_val->p_list->p_values[i] );
600                 if( p_val2 )
601                 {
602                     p_val2->p_list->p_values[i].psz_string =
603                         p_var->choices_text.p_values[i].psz_string ?
604                     strdup(p_var->choices_text.p_values[i].psz_string) : NULL;
605                     p_val2->p_list->pi_types[i] = VLC_VAR_STRING;
606                 }
607             }
608             break;
609         case VLC_VAR_SETTEXT:
610             free( p_var->psz_text );
611             if( p_val && p_val->psz_string )
612                 p_var->psz_text = strdup( p_val->psz_string );
613             else
614                 p_var->psz_text = NULL;
615             break;
616         case VLC_VAR_GETTEXT:
617             p_val->psz_string = NULL;
618             if( p_var->psz_text )
619             {
620                 p_val->psz_string = strdup( p_var->psz_text );
621             }
622             break;
623         case VLC_VAR_INHERITVALUE:
624             {
625                 vlc_value_t val;
626
627                 if( InheritValue( p_this,
628                                   p_val2 ? p_val2->psz_string :  psz_name,
629                                   &val, p_var->i_type )
630                     == VLC_SUCCESS )
631                 {
632                     /* Duplicate already done */
633
634                     /* Backup needed stuff */
635                     oldval = p_var->val;
636                     /* Check boundaries and list */
637                     CheckValue( p_var, &val );
638                     /* Set the variable */
639                     p_var->val = val;
640                     /* Free data if needed */
641                     p_var->ops->pf_free( &oldval );
642                 }
643
644                 if( p_val )
645                 {
646                     *p_val = p_var->val;
647                     p_var->ops->pf_dup( p_val );
648                 }
649             }
650             break;
651
652         case VLC_VAR_SETISCOMMAND:
653             p_var->i_type |= VLC_VAR_ISCOMMAND;
654             break;
655
656         default:
657             break;
658     }
659
660     vlc_mutex_unlock( &p_priv->var_lock );
661
662     return VLC_SUCCESS;
663 }
664
665
666 /**
667  * Perform a Get and Set on a variable
668  *
669  * \param p_this: The object that hold the variable
670  * \param psz_name: the name of the variable
671  * \param i_action: the action to perform
672  * \param p_val: The action parameter
673  * \return vlc error codes
674  */
675 int __var_GetAndSet( vlc_object_t *p_this, const char *psz_name, int i_action,
676                      vlc_value_t val )
677 {
678     int i_var;
679     int i_ret = VLC_SUCCESS;
680     variable_t *p_var;
681     vlc_value_t oldval;
682     vlc_object_internals_t *p_priv = vlc_internals( p_this );
683
684     vlc_mutex_lock( &p_priv->var_lock );
685     i_var = GetUnused( p_this, psz_name );
686     if( i_var < 0 )
687     {
688         vlc_mutex_unlock( &p_priv->var_lock );
689         return i_var;
690     }
691
692     p_var = &p_priv->p_vars[i_var];
693
694     /* Duplicated data if needed */
695     //p_var->ops->pf_dup( &val );
696
697     /* Backup needed stuff */
698     oldval = p_var->val;
699
700     /* depending of the action requiered */
701     switch( i_action )
702     {
703     case VLC_VAR_TOGGLE_BOOL:
704         assert( ( p_var->i_type & VLC_VAR_BOOL ) == VLC_VAR_BOOL );
705         p_var->val.b_bool = !p_var->val.b_bool;
706         break;
707     default:
708         vlc_mutex_unlock( &p_priv->var_lock );
709         return VLC_EGENERIC;
710     }
711
712     /*  Check boundaries */
713     CheckValue( p_var, &p_var->val );
714
715     /* Deal with callbacks.*/
716     if( p_var->i_entries )
717         i_ret = TriggerCallback( p_this, &p_var, psz_name, oldval );
718
719     vlc_mutex_unlock( &p_priv->var_lock );
720
721     return i_ret;
722 }
723
724
725 /**
726  * Request a variable's type
727  *
728  * \return The variable type if it exists, or 0 if the
729  * variable could not be found.
730  * \see \ref var_type
731  */
732 int __var_Type( vlc_object_t *p_this, const char *psz_name )
733 {
734     int i_var, i_type;
735     vlc_object_internals_t *p_priv = vlc_internals( p_this );
736
737     vlc_mutex_lock( &p_priv->var_lock );
738
739     i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
740
741     if( i_var < 0 )
742     {
743         vlc_mutex_unlock( &p_priv->var_lock );
744         return 0;
745     }
746
747     i_type = p_priv->p_vars[i_var].i_type;
748
749     vlc_mutex_unlock( &p_priv->var_lock );
750
751     return i_type;
752 }
753
754 int var_SetChecked( vlc_object_t *p_this, const char *psz_name,
755                     int expected_type, vlc_value_t val )
756 {
757     int i_var;
758     int i_ret = VLC_SUCCESS;
759     variable_t *p_var;
760     vlc_value_t oldval;
761     vlc_object_internals_t *p_priv = vlc_internals( p_this );
762
763     vlc_mutex_lock( &p_priv->var_lock );
764
765     i_var = GetUnused( p_this, psz_name );
766     if( i_var < 0 )
767     {
768         vlc_mutex_unlock( &p_priv->var_lock );
769         return i_var;
770     }
771
772     p_var = &p_priv->p_vars[i_var];
773     assert( (p_var->i_type & VLC_VAR_CLASS) == 0 || expected_type == 0 ||
774             (p_var->i_type & VLC_VAR_CLASS) == expected_type );
775
776     /* Duplicate data if needed */
777     p_var->ops->pf_dup( &val );
778
779     /* Backup needed stuff */
780     oldval = p_var->val;
781
782     /* Check boundaries and list */
783     CheckValue( p_var, &val );
784
785     /* Set the variable */
786     p_var->val = val;
787
788     /* Deal with callbacks */
789     if( p_var->i_entries )
790         i_ret = TriggerCallback( p_this, &p_var, psz_name, oldval );
791
792     /* Free data if needed */
793     p_var->ops->pf_free( &oldval );
794
795     vlc_mutex_unlock( &p_priv->var_lock );
796
797     return i_ret;
798 }
799
800
801 /**
802  * Set a variable's value
803  *
804  * \param p_this The object that hold the variable
805  * \param psz_name The name of the variable
806  * \param val the value to set
807  */
808 int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val )
809 {
810     return var_SetChecked( p_this, psz_name, 0, val );
811 }
812
813 int var_GetChecked( vlc_object_t *p_this, const char *psz_name,
814                     int expected_type, vlc_value_t *p_val )
815 {
816     vlc_object_internals_t *p_priv = vlc_internals( p_this );
817     int i_var, err = VLC_SUCCESS;
818
819     vlc_mutex_lock( &p_priv->var_lock );
820
821     i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
822     if( i_var >= 0 )
823     {
824         variable_t *p_var = &p_priv->p_vars[i_var];
825
826         assert( (p_var->i_type & VLC_VAR_CLASS) == 0 || expected_type == 0 ||
827                 (p_var->i_type & VLC_VAR_CLASS) == expected_type );
828
829         /* Really get the variable */
830         *p_val = p_var->val;
831
832         /* Duplicate value if needed */
833         p_var->ops->pf_dup( p_val );
834     }
835     else
836         err = VLC_ENOVAR;
837
838     vlc_mutex_unlock( &p_priv->var_lock );
839     return err;
840 }
841
842 /**
843  * Get a variable's value
844  *
845  * \param p_this The object that holds the variable
846  * \param psz_name The name of the variable
847  * \param p_val Pointer to a vlc_value_t that will hold the variable's value
848  *              after the function is finished
849  */
850 int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
851 {
852     return var_GetChecked( p_this, psz_name, 0, p_val );
853 }
854
855 /**
856  * Register a callback in a variable
857  *
858  * We store a function pointer that will be called upon variable
859  * modification.
860  *
861  * \param p_this The object that holds the variable
862  * \param psz_name The name of the variable
863  * \param pf_callback The function pointer
864  * \param p_data A generic pointer that will be passed as the last
865  *               argument to the callback function.
866  *
867  * \warning The callback function is run in the thread that calls var_Set on
868  *          the variable. Use proper locking. This thread may not have much
869  *          time to spare, so keep callback functions short.
870  */
871 int __var_AddCallback( vlc_object_t *p_this, const char *psz_name,
872                        vlc_callback_t pf_callback, void *p_data )
873 {
874     int i_var;
875     variable_t *p_var;
876     callback_entry_t entry;
877     vlc_object_internals_t *p_priv = vlc_internals( p_this );
878
879     entry.pf_callback = pf_callback;
880     entry.p_data = p_data;
881
882     vlc_mutex_lock( &p_priv->var_lock );
883
884     i_var = GetUnused( p_this, psz_name );
885     if( i_var < 0 )
886     {
887         vlc_mutex_unlock( &p_priv->var_lock );
888         return i_var;
889     }
890
891     p_var = &p_priv->p_vars[i_var];
892
893     INSERT_ELEM( p_var->p_entries,
894                  p_var->i_entries,
895                  p_var->i_entries,
896                  entry );
897
898     vlc_mutex_unlock( &p_priv->var_lock );
899
900     return VLC_SUCCESS;
901 }
902
903 /**
904  * Remove a callback from a variable
905  *
906  * pf_callback and p_data have to be given again, because different objects
907  * might have registered the same callback function.
908  */
909 int __var_DelCallback( vlc_object_t *p_this, const char *psz_name,
910                        vlc_callback_t pf_callback, void *p_data )
911 {
912     int i_entry, i_var;
913     variable_t *p_var;
914     vlc_object_internals_t *p_priv = vlc_internals( p_this );
915
916     vlc_mutex_lock( &p_priv->var_lock );
917
918     i_var = GetUnused( p_this, psz_name );
919     if( i_var < 0 )
920     {
921         vlc_mutex_unlock( &p_priv->var_lock );
922         return i_var;
923     }
924
925     p_var = &p_priv->p_vars[i_var];
926
927     for( i_entry = p_var->i_entries ; i_entry-- ; )
928     {
929         if( p_var->p_entries[i_entry].pf_callback == pf_callback
930             && p_var->p_entries[i_entry].p_data == p_data )
931         {
932             break;
933         }
934     }
935
936     if( i_entry < 0 )
937     {
938         vlc_mutex_unlock( &p_priv->var_lock );
939         return VLC_EGENERIC;
940     }
941
942     REMOVE_ELEM( p_var->p_entries, p_var->i_entries, i_entry );
943
944     vlc_mutex_unlock( &p_priv->var_lock );
945
946     return VLC_SUCCESS;
947 }
948
949 /**
950  * Trigger callback on a variable
951  *
952  * \param p_this The object that hold the variable
953  * \param psz_name The name of the variable
954  */
955 int __var_TriggerCallback( vlc_object_t *p_this, const char *psz_name )
956 {
957     int i_var;
958     int i_ret = VLC_SUCCESS;
959     variable_t *p_var;
960     vlc_object_internals_t *p_priv = vlc_internals( p_this );
961
962     vlc_mutex_lock( &p_priv->var_lock );
963
964     i_var = GetUnused( p_this, psz_name );
965     if( i_var < 0 )
966     {
967         vlc_mutex_unlock( &p_priv->var_lock );
968         return i_var;
969     }
970
971     p_var = &p_priv->p_vars[i_var];
972
973     /* Deal with callbacks. Tell we're in a callback, release the lock,
974      * call stored functions, retake the lock. */
975     if( p_var->i_entries )
976         i_ret = TriggerCallback( p_this, &p_var, psz_name, p_var->val );
977
978     vlc_mutex_unlock( &p_priv->var_lock );
979     return i_ret;
980 }
981
982 /** Parse a stringified option
983  * This function parse a string option and create the associated object
984  * variable
985  * The option must be of the form "[no[-]]foo[=bar]" where foo is the
986  * option name and bar is the value of the option.
987  * \param p_obj the object in which the variable must be created
988  * \param psz_option the option to parse
989  * \param trusted whether the option is set by a trusted input or not
990  * \return nothing
991  */
992 void var_OptionParse( vlc_object_t *p_obj, const char *psz_option,
993                       bool trusted )
994 {
995     char *psz_name, *psz_value;
996     int  i_type;
997     bool b_isno = false;
998     vlc_value_t val;
999
1000     val.psz_string = NULL;
1001
1002     /* It's too much of a hassle to remove the ':' when we parse
1003      * the cmd line :) */
1004     if( psz_option[0] == ':' )
1005         psz_option++;
1006
1007     if( !psz_option[0] )
1008         return;
1009
1010     psz_name = strdup( psz_option );
1011     if( psz_name == NULL )
1012         return;
1013
1014     psz_value = strchr( psz_name, '=' );
1015     if( psz_value != NULL )
1016         *psz_value++ = '\0';
1017
1018     /* FIXME: :programs should be handled generically */
1019     if( !strcmp( psz_name, "programs" ) )
1020         i_type = VLC_VAR_LIST;
1021     else
1022         i_type = config_GetType( p_obj, psz_name );
1023
1024     if( !i_type && !psz_value )
1025     {
1026         /* check for "no-foo" or "nofoo" */
1027         if( !strncmp( psz_name, "no-", 3 ) )
1028         {
1029             memmove( psz_name, psz_name + 3, strlen(psz_name) + 1 - 3 );
1030         }
1031         else if( !strncmp( psz_name, "no", 2 ) )
1032         {
1033             memmove( psz_name, psz_name + 2, strlen(psz_name) + 1 - 2 );
1034         }
1035         else goto cleanup;           /* Option doesn't exist */
1036
1037         b_isno = true;
1038         i_type = config_GetType( p_obj, psz_name );
1039     }
1040     if( !i_type ) goto cleanup; /* Option doesn't exist */
1041
1042     if( ( i_type != VLC_VAR_BOOL ) &&
1043         ( !psz_value || !*psz_value ) ) goto cleanup; /* Invalid value */
1044
1045     /* check if option is unsafe */
1046     if( !trusted )
1047     {
1048         module_config_t *p_config = config_FindConfig( p_obj, psz_name );
1049         if( !p_config || !p_config->b_safe )
1050         {
1051             msg_Err( p_obj, "unsafe option \"%s\" has been ignored for "
1052                             "security reasons", psz_name );
1053             free( psz_name );
1054             return;
1055         }
1056     }
1057
1058     /* Create the variable in the input object.
1059      * Children of the input object will be able to retreive this value
1060      * thanks to the inheritance property of the object variables. */
1061     var_Create( p_obj, psz_name, i_type );
1062
1063     switch( i_type )
1064     {
1065     case VLC_VAR_BOOL:
1066         val.b_bool = !b_isno;
1067         break;
1068
1069     case VLC_VAR_INTEGER:
1070         val.i_int = strtol( psz_value, NULL, 0 );
1071         break;
1072
1073     case VLC_VAR_FLOAT:
1074         val.f_float = atof( psz_value );
1075         break;
1076
1077     case VLC_VAR_STRING:
1078     case VLC_VAR_MODULE:
1079     case VLC_VAR_FILE:
1080     case VLC_VAR_DIRECTORY:
1081         val.psz_string = psz_value;
1082         break;
1083
1084     case VLC_VAR_LIST:
1085     {
1086         char *psz_orig, *psz_var;
1087         vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1088         val.p_list = p_list;
1089         p_list->i_count = 0;
1090
1091         psz_var = psz_orig = strdup(psz_value);
1092         while( psz_var && *psz_var )
1093         {
1094             char *psz_item = psz_var;
1095             vlc_value_t val2;
1096             while( *psz_var && *psz_var != ',' ) psz_var++;
1097             if( *psz_var == ',' )
1098             {
1099                 *psz_var = '\0';
1100                 psz_var++;
1101             }
1102             val2.i_int = strtol( psz_item, NULL, 0 );
1103             INSERT_ELEM( p_list->p_values, p_list->i_count,
1104                          p_list->i_count, val2 );
1105             /* p_list->i_count is incremented twice by INSERT_ELEM */
1106             p_list->i_count--;
1107             INSERT_ELEM( p_list->pi_types, p_list->i_count,
1108                          p_list->i_count, VLC_VAR_INTEGER );
1109         }
1110         free( psz_orig );
1111         break;
1112     }
1113
1114     default:
1115         goto cleanup;
1116     }
1117
1118     var_Set( p_obj, psz_name, val );
1119
1120     /* If that's a list, remove all elements allocated */
1121     if( i_type == VLC_VAR_LIST )
1122         FreeList( &val );
1123
1124 cleanup:
1125     free( psz_name );
1126 }
1127
1128
1129 /* Following functions are local */
1130
1131 /*****************************************************************************
1132  * GetUnused: find an unused (not in callback) variable from its name
1133  *****************************************************************************
1134  * We do i_tries tries before giving up, just in case the variable is being
1135  * modified and called from a callback.
1136  *****************************************************************************/
1137 static int GetUnused( vlc_object_t *p_this, const char *psz_name )
1138 {
1139     vlc_object_internals_t *p_priv = vlc_internals( p_this );
1140
1141     while( true )
1142     {
1143         int i_var;
1144
1145         i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1146         if( i_var < 0 )
1147         {
1148             return VLC_ENOVAR;
1149         }
1150
1151         if( ! p_priv->p_vars[i_var].b_incallback )
1152         {
1153             return i_var;
1154         }
1155
1156         mutex_cleanup_push( &p_priv->var_lock );
1157         vlc_cond_wait( &p_priv->var_wait, &p_priv->var_lock );
1158         vlc_cleanup_pop( );
1159     }
1160 }
1161
1162 /*****************************************************************************
1163  * HashString: our cool hash function
1164  *****************************************************************************
1165  * This function is not intended to be crypto-secure, we only want it to be
1166  * fast and not suck too much. This one is pretty fast and did 0 collisions
1167  * in wenglish's dictionary.
1168  *****************************************************************************/
1169 static uint32_t HashString( const char *psz_string )
1170 {
1171     uint32_t i_hash = 0;
1172
1173     while( *psz_string )
1174     {
1175         i_hash += *psz_string++;
1176         i_hash += i_hash << 10;
1177         i_hash ^= i_hash >> 8;
1178     }
1179
1180     return i_hash;
1181 }
1182
1183 /*****************************************************************************
1184  * Insert: find an empty slot to insert a new variable
1185  *****************************************************************************
1186  * We use a recursive inner function indexed on the hash. This function does
1187  * nothing in the rare cases where a collision may occur, see Lookup()
1188  * to see how we handle them.
1189  * XXX: does this really need to be written recursively?
1190  *****************************************************************************/
1191 static int Insert( variable_t *p_vars, int i_count, const char *psz_name )
1192 {
1193     if( i_count == 0 )
1194     {
1195         return 0;
1196     }
1197
1198     return InsertInner( p_vars, i_count, HashString( psz_name ) );
1199 }
1200
1201 static int InsertInner( variable_t *p_vars, int i_count, uint32_t i_hash )
1202 {
1203     int i_middle;
1204
1205     if( i_hash <= p_vars[0].i_hash )
1206     {
1207         return 0;
1208     }
1209
1210     if( i_hash >= p_vars[i_count - 1].i_hash )
1211     {
1212         return i_count;
1213     }
1214
1215     i_middle = i_count / 2;
1216
1217     /* We know that 0 < i_middle */
1218     if( i_hash < p_vars[i_middle].i_hash )
1219     {
1220         return InsertInner( p_vars, i_middle, i_hash );
1221     }
1222
1223     /* We know that i_middle + 1 < i_count */
1224     if( i_hash > p_vars[i_middle + 1].i_hash )
1225     {
1226         return i_middle + 1 + InsertInner( p_vars + i_middle + 1,
1227                                            i_count - i_middle - 1,
1228                                            i_hash );
1229     }
1230
1231     return i_middle + 1;
1232 }
1233
1234 static int u32cmp( const void *key, const void *data )
1235 {
1236     const variable_t *p_var = data;
1237     uint32_t hash = *(const uint32_t *)key ;
1238
1239     if( hash > p_var->i_hash )
1240         return 1;
1241     if( hash < p_var->i_hash )
1242         return -1;
1243     return 0;
1244 }
1245
1246 /*****************************************************************************
1247  * Lookup: find an existing variable given its name
1248  *****************************************************************************
1249  * We use a recursive inner function indexed on the hash. Care is taken of
1250  * possible hash collisions.
1251  *****************************************************************************/
1252 static int Lookup( variable_t *p_vars, size_t i_count, const char *psz_name )
1253 {
1254     variable_t *p_var;
1255     uint32_t i_hash;
1256
1257     i_hash = HashString( psz_name );
1258     p_var = bsearch( &i_hash, p_vars, i_count, sizeof( *p_var ), u32cmp );
1259
1260     /* Hash not found */
1261     if( p_var == NULL )
1262         return -1;
1263
1264     assert( i_count > 0 );
1265
1266     /* Find the first entry with the right hash */
1267     while( (p_var > p_vars) && (i_hash == p_var[-1].i_hash) )
1268         p_var--;
1269
1270     assert( p_var->i_hash == i_hash );
1271
1272     /* Hash collision should be very unlikely, but we cannot guarantee
1273      * it will never happen. So we do an exhaustive search amongst all
1274      * entries with the same hash. Typically, there is only one anyway. */
1275     for( variable_t *p_end = p_vars + i_count;
1276          (p_var < p_end) && (i_hash == p_var->i_hash);
1277          p_var++ )
1278     {
1279         if( !strcmp( psz_name, p_var->psz_name ) )
1280             return p_var - p_vars;
1281     }
1282
1283     /* Hash found, but entry not found */
1284     return -1;
1285 }
1286
1287 /*****************************************************************************
1288  * CheckValue: check that a value is valid wrt. a variable
1289  *****************************************************************************
1290  * This function checks p_val's value against p_var's limitations such as
1291  * minimal and maximal value, step, in-list position, and modifies p_val if
1292  * necessary.
1293  ****************************************************************************/
1294 static void CheckValue ( variable_t *p_var, vlc_value_t *p_val )
1295 {
1296     /* Check that our variable is in the list */
1297     if( p_var->i_type & VLC_VAR_HASCHOICE && p_var->choices.i_count )
1298     {
1299         int i;
1300
1301         /* FIXME: the list is sorted, dude. Use something cleverer. */
1302         for( i = p_var->choices.i_count ; i-- ; )
1303         {
1304             if( p_var->ops->pf_cmp( *p_val, p_var->choices.p_values[i] ) == 0 )
1305             {
1306                 break;
1307             }
1308         }
1309
1310         /* If not found, change it to anything vaguely valid */
1311         if( i < 0 )
1312         {
1313             /* Free the old variable, get the new one, dup it */
1314             p_var->ops->pf_free( p_val );
1315             *p_val = p_var->choices.p_values[p_var->i_default >= 0
1316                                           ? p_var->i_default : 0 ];
1317             p_var->ops->pf_dup( p_val );
1318         }
1319     }
1320
1321     /* Check that our variable is within the bounds */
1322     switch( p_var->i_type & VLC_VAR_TYPE )
1323     {
1324         case VLC_VAR_INTEGER:
1325             if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.i_int
1326                  && (p_val->i_int % p_var->step.i_int) )
1327             {
1328                 p_val->i_int = (p_val->i_int + (p_var->step.i_int / 2))
1329                                / p_var->step.i_int * p_var->step.i_int;
1330             }
1331             if( p_var->i_type & VLC_VAR_HASMIN
1332                  && p_val->i_int < p_var->min.i_int )
1333             {
1334                 p_val->i_int = p_var->min.i_int;
1335             }
1336             if( p_var->i_type & VLC_VAR_HASMAX
1337                  && p_val->i_int > p_var->max.i_int )
1338             {
1339                 p_val->i_int = p_var->max.i_int;
1340             }
1341             break;
1342         case VLC_VAR_FLOAT:
1343             if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.f_float )
1344             {
1345                 float f_round = p_var->step.f_float * (float)(int)( 0.5 +
1346                                         p_val->f_float / p_var->step.f_float );
1347                 if( p_val->f_float != f_round )
1348                 {
1349                     p_val->f_float = f_round;
1350                 }
1351             }
1352             if( p_var->i_type & VLC_VAR_HASMIN
1353                  && p_val->f_float < p_var->min.f_float )
1354             {
1355                 p_val->f_float = p_var->min.f_float;
1356             }
1357             if( p_var->i_type & VLC_VAR_HASMAX
1358                  && p_val->f_float > p_var->max.f_float )
1359             {
1360                 p_val->f_float = p_var->max.f_float;
1361             }
1362             break;
1363         case VLC_VAR_TIME:
1364             /* FIXME: TODO */
1365             break;
1366     }
1367 }
1368
1369 /*****************************************************************************
1370  * InheritValue: try to inherit the value of this variable from the same one
1371  * in our closest parent, libvlc or ultimately from the configuration.
1372  * The function should always be entered with the object var_lock locked.
1373  *****************************************************************************/
1374 static int InheritValue( vlc_object_t *p_this, const char *psz_name,
1375                          vlc_value_t *p_val, int i_type )
1376 {
1377     int i_var;
1378     variable_t *p_var;
1379
1380     if( p_this->p_parent || ( p_this->p_libvlc && p_this != (vlc_object_t*) p_this->p_libvlc ) )
1381     {
1382         vlc_object_internals_t *p_priv;
1383
1384         if( p_this->p_parent )
1385             p_priv = vlc_internals( p_this->p_parent );
1386         else
1387             p_priv = vlc_internals( p_this->p_libvlc );
1388
1389         i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1390
1391         if( i_var >= 0 )
1392         {
1393             /* We found it! */
1394             p_var = &p_priv->p_vars[i_var];
1395
1396             /* Really get the variable */
1397             *p_val = p_var->val;
1398
1399             /* Duplicate value if needed */
1400             p_var->ops->pf_dup( p_val );
1401
1402             /*msg_Dbg( p_this, "Inherited value for var %s from object %s",
1403                      psz_name ? psz_name : "(null)",
1404                      p_this->psz_object_name
1405                          ? p_this->psz_object_name : "(Unknown)" );*/
1406             return VLC_SUCCESS;
1407         }
1408         else if ( p_this->p_parent ) /* We are still not there */
1409             return InheritValue( p_this->p_parent, psz_name, p_val, i_type );
1410
1411         /* else take value from config */
1412     }
1413
1414
1415     switch( i_type & VLC_VAR_CLASS )
1416     {
1417         case VLC_VAR_STRING:
1418             p_val->psz_string = config_GetPsz( p_this, psz_name );
1419             if( !p_val->psz_string ) p_val->psz_string = strdup("");
1420             break;
1421         case VLC_VAR_FLOAT:
1422             p_val->f_float = config_GetFloat( p_this, psz_name );
1423             break;
1424         case VLC_VAR_INTEGER:
1425             p_val->i_int = config_GetInt( p_this, psz_name );
1426             break;
1427         case VLC_VAR_BOOL:
1428             p_val->b_bool = config_GetInt( p_this, psz_name );
1429             break;
1430         case VLC_VAR_LIST:
1431         {
1432             char *psz_orig, *psz_var;
1433             vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1434             p_val->p_list = p_list;
1435             p_list->i_count = 0;
1436
1437             psz_var = psz_orig = config_GetPsz( p_this, psz_name );
1438             while( psz_var && *psz_var )
1439             {
1440                 char *psz_item = psz_var;
1441                 vlc_value_t val;
1442                 while( *psz_var && *psz_var != ',' ) psz_var++;
1443                 if( *psz_var == ',' )
1444                 {
1445                     *psz_var = '\0';
1446                     psz_var++;
1447                 }
1448                 val.i_int = strtol( psz_item, NULL, 0 );
1449                 INSERT_ELEM( p_list->p_values, p_list->i_count,
1450                              p_list->i_count, val );
1451                 /* p_list->i_count is incremented twice by INSERT_ELEM */
1452                 p_list->i_count--;
1453                 INSERT_ELEM( p_list->pi_types, p_list->i_count,
1454                              p_list->i_count, VLC_VAR_INTEGER );
1455             }
1456             free( psz_orig );
1457             break;
1458         }
1459         default:
1460             msg_Warn( p_this, "Could not inherit value for var %s "
1461                               "from config. Invalid Type", psz_name );
1462             return VLC_ENOOBJ;
1463             break;
1464     }
1465     /*msg_Dbg( p_this, "Inherited value for var %s from config", psz_name );*/
1466     return VLC_SUCCESS;
1467 }
1468
1469
1470 /**********************************************************************
1471  * Trigger the callbacks.
1472  * Tell we're in a callback, release the lock, call stored functions,
1473  * retake the lock.
1474  **********************************************************************/
1475 static int TriggerCallback( vlc_object_t *p_this, variable_t **pp_var,
1476                             const char *psz_name, vlc_value_t oldval )
1477 {
1478     int i_var;
1479     int i_entries = (*pp_var)->i_entries;
1480     callback_entry_t *p_entries = (*pp_var)->p_entries;
1481     vlc_object_internals_t *p_priv = vlc_internals( p_this );
1482
1483     (*pp_var)->b_incallback = true;
1484     vlc_mutex_unlock( &p_priv->var_lock );
1485
1486     /* The real calls */
1487     for( ; i_entries-- ; )
1488     {
1489         p_entries[i_entries].pf_callback( p_this, psz_name, oldval, (*pp_var)->val,
1490                                           p_entries[i_entries].p_data );
1491     }
1492
1493     vlc_mutex_lock( &p_priv->var_lock );
1494
1495     i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1496     if( i_var < 0 )
1497     {
1498         msg_Err( p_this, "variable %s has disappeared", psz_name );
1499         return VLC_ENOVAR;
1500      }
1501
1502      *pp_var = &p_priv->p_vars[i_var];
1503      (*pp_var)->b_incallback = false;
1504      vlc_cond_broadcast( &p_priv->var_wait );
1505
1506      return VLC_SUCCESS;
1507 }
1508
1509
1510 /**********************************************************************
1511  * Execute a var command on an object identified by its name
1512  **********************************************************************/
1513 int __var_Command( vlc_object_t *p_this, const char *psz_name,
1514                    const char *psz_cmd, const char *psz_arg, char **psz_msg )
1515 {
1516     vlc_object_t *p_obj = vlc_object_find_name( p_this->p_libvlc,
1517                                                 psz_name, FIND_CHILD );
1518     int i_type, i_ret;
1519
1520     if( !p_obj )
1521     {
1522         if( psz_msg )
1523             *psz_msg = strdup( "Unknown destination object." );
1524         return VLC_ENOOBJ;
1525     }
1526
1527     i_type = var_Type( p_obj, psz_cmd );
1528     if( !( i_type&VLC_VAR_ISCOMMAND ) )
1529     {
1530         vlc_object_release( p_obj );
1531         if( psz_msg )
1532             *psz_msg = strdup( "Variable doesn't exist or isn't a command." );
1533         return VLC_EGENERIC;
1534     }
1535
1536     i_type &= VLC_VAR_CLASS;
1537     switch( i_type )
1538     {
1539         case VLC_VAR_INTEGER:
1540             i_ret = var_SetInteger( p_obj, psz_cmd, atoi( psz_arg ) );
1541             break;
1542         case VLC_VAR_FLOAT:
1543             i_ret = var_SetFloat( p_obj, psz_cmd, atof( psz_arg ) );
1544             break;
1545         case VLC_VAR_STRING:
1546             i_ret = var_SetString( p_obj, psz_cmd, psz_arg );
1547             break;
1548         case VLC_VAR_BOOL:
1549             i_ret = var_SetBool( p_obj, psz_cmd, atoi( psz_arg ) );
1550             break;
1551         default:
1552             i_ret = VLC_EGENERIC;
1553             break;
1554     }
1555
1556     vlc_object_release( p_obj );
1557
1558     if( psz_msg )
1559     {
1560         if( asprintf( psz_msg, "%s on object %s returned %i (%s)",
1561                   psz_cmd, psz_name, i_ret, vlc_error( i_ret ) ) == -1)
1562             *psz_msg = NULL;
1563     }
1564
1565     return i_ret;
1566 }
1567
1568
1569 /**
1570  * Free a list and the associated strings
1571  * @param p_val: the list variable
1572  * @param p_val2: the variable associated or NULL
1573  */
1574 void var_FreeList( vlc_value_t *p_val, vlc_value_t *p_val2 )
1575 {
1576     FreeList( p_val );
1577     if( p_val2 && p_val2->p_list )
1578     {
1579         for( int i = 0; i < p_val2->p_list->i_count; i++ )
1580             free( p_val2->p_list->p_values[i].psz_string );
1581         if( p_val2->p_list->i_count )
1582         {
1583             free( p_val2->p_list->p_values );
1584             free( p_val2->p_list->pi_types );
1585         }
1586         free( p_val2->p_list );
1587     }
1588 }