git.sesse.net Git - vlc/blob - 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 <vlc_charset.h>
  33 #include "variables.h"
  34
  35 #include "libvlc.h"
  36
  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      ( vlc_object_t *, const char * );
 160
 161 static void     CheckValue  ( variable_t *, vlc_value_t * );
 162
 163 static int      TriggerCallback( vlc_object_t *, variable_t *, const char *,
 164                                  vlc_value_t );
 165
 166 static void Destroy( variable_t *p_var )
 167 {
 168     p_var->ops->pf_free( &p_var->val );
 169     if( p_var->choices.i_count )
 170     {
 171         for( int i = 0 ; i < p_var->choices.i_count ; i++ )
 172         {
 173             p_var->ops->pf_free( &p_var->choices.p_values[i] );
 174             free( p_var->choices_text.p_values[i].psz_string );
 175         }
 176         free( p_var->choices.p_values );
 177         free( p_var->choices_text.p_values );
 178     }
 179     free( p_var->psz_name );
 180     free( p_var->psz_text );
 181     free( p_var->p_entries );
 182     free( p_var );
 183 }
 184
 185 /**
 186  * Initialize a vlc variable
 187  *
 188  * We hash the given string and insert it into the sorted list. The insertion
 189  * may require slow memory copies, but think about what we gain in the log(n)
 190  * lookup phase when setting/getting the variable value!
 191  *
 192  * \param p_this The object in which to create the variable
 193  * \param psz_name The name of the variable
 194  * \param i_type The variables type. Must be one of \ref var_type combined with
 195  *               zero or more \ref var_flags
 196  */
 197 int __var_Create( vlc_object_t *p_this, const char *psz_name, int i_type )
 198 {
 199     static vlc_list_t dummy_null_list = {0, NULL, NULL};
 200     assert( p_this );
 201
 202     variable_t *p_var = calloc( 1, sizeof( *p_var ) );
 203     if( p_var == NULL )
 204         return VLC_ENOMEM;
 205
 206     p_var->i_hash = HashString( psz_name );
 207     p_var->psz_name = strdup( psz_name );
 208     p_var->psz_text = NULL;
 209
 210     p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
 211
 212     p_var->i_usage = 1;
 213
 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;
 219
 220     p_var->b_incallback = false;
 221     p_var->i_entries = 0;
 222     p_var->p_entries = NULL;
 223
 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_CLASS )
 228     {
 229         case VLC_VAR_BOOL:
 230             p_var->ops = &bool_ops;
 231             p_var->val.b_bool = false;
 232             break;
 233         case VLC_VAR_INTEGER:
 234             p_var->ops = &int_ops;
 235             p_var->val.i_int = 0;
 236             break;
 237         case VLC_VAR_STRING:
 238             p_var->ops = &string_ops;
 239             p_var->val.psz_string = NULL;
 240             break;
 241         case VLC_VAR_FLOAT:
 242             p_var->ops = &float_ops;
 243             p_var->val.f_float = 0.0;
 244             break;
 245         case VLC_VAR_TIME:
 246             p_var->ops = &time_ops;
 247             p_var->val.i_time = 0;
 248             break;
 249         case VLC_VAR_ADDRESS:
 250             p_var->ops = &addr_ops;
 251             p_var->val.p_address = NULL;
 252             break;
 253         case VLC_VAR_MUTEX:
 254             p_var->ops = &mutex_ops;
 255             p_var->val.p_address = malloc( sizeof(vlc_mutex_t) );
 256             vlc_mutex_init( (vlc_mutex_t*)p_var->val.p_address );
 257             break;
 258         case VLC_VAR_LIST:
 259             p_var->ops = &list_ops;
 260             p_var->val.p_list = &dummy_null_list;
 261             break;
 262         default:
 263             p_var->ops = &void_ops;
 264             break;
 265     }
 266
 267     if( i_type & VLC_VAR_DOINHERIT )
 268     {
 269         if( var_Inherit( p_this, psz_name, i_type, &p_var->val ) )
 270             msg_Err( p_this, "cannot inherit value for %s", psz_name );
 271         else if( i_type & VLC_VAR_HASCHOICE )
 272         {
 273             /* We must add the inherited value to our choice list */
 274             p_var->i_default = 0;
 275
 276             INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
 277                          0, p_var->val );
 278             INSERT_ELEM( p_var->choices_text.p_values,
 279                          p_var->choices_text.i_count, 0, p_var->val );
 280             p_var->ops->pf_dup( &p_var->choices.p_values[0] );
 281             p_var->choices_text.p_values[0].psz_string = NULL;
 282         }
 283     }
 284
 285     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 286     int i_new;
 287
 288     vlc_mutex_lock( &p_priv->var_lock );
 289
 290     /* FIXME: if the variable already exists, we don't duplicate it. But we
 291      * duplicate the lookups. It's not that serious, but if anyone finds some
 292      * time to rework Insert() so that only one lookup has to be done, feel
 293      * free to do so. */
 294     i_new = Lookup( p_this, psz_name );
 295
 296     if( i_new >= 0 )
 297     {
 298         /* If the types differ, variable creation failed. */
 299         if( (i_type & VLC_VAR_CLASS) != (p_priv->pp_vars[i_new]->i_type & VLC_VAR_CLASS) )
 300         {
 301             msg_Err( p_this, "Variable '%s' (0x%04x) already exist but with a different type (0x%04x)",
 302                      psz_name, p_priv->pp_vars[i_new]->i_type, i_type );
 303             vlc_mutex_unlock( &p_priv->var_lock );
 304             return VLC_EBADVAR;
 305         }
 306
 307         p_priv->pp_vars[i_new]->i_usage++;
 308         p_priv->pp_vars[i_new]->i_type |= ( i_type & VLC_VAR_ISCOMMAND );
 309         p_priv->pp_vars[i_new]->i_type |= ( i_type & VLC_VAR_HASCHOICE );
 310         vlc_mutex_unlock( &p_priv->var_lock );
 311
 312         /* We did not need to create a new variable, free everything... */
 313         Destroy( p_var );
 314         return VLC_SUCCESS;
 315     }
 316
 317     i_new = Insert( p_priv->pp_vars, p_priv->i_vars, psz_name );
 318
 319     if( (p_priv->i_vars & 15) == 0 )
 320         p_priv->pp_vars = xrealloc( p_priv->pp_vars,
 321                                  (p_priv->i_vars+16) * sizeof(variable_t *) );
 322
 323     memmove( p_priv->pp_vars + i_new + 1,
 324              p_priv->pp_vars + i_new,
 325              (p_priv->i_vars - i_new) * sizeof(variable_t *) );
 326
 327     p_priv->i_vars++;
 328
 329     p_priv->pp_vars[i_new] = p_var;
 330     vlc_mutex_unlock( &p_priv->var_lock );
 331
 332     return VLC_SUCCESS;
 333 }
 334
 335 /**
 336  * Destroy a vlc variable
 337  *
 338  * Look for the variable and destroy it if it is found. As in var_Create we
 339  * do a call to memmove() but we have performance counterparts elsewhere.
 340  *
 341  * \param p_this The object that holds the variable
 342  * \param psz_name The name of the variable
 343  */
 344 int __var_Destroy( vlc_object_t *p_this, const char *psz_name )
 345 {
 346     int i_var;
 347     variable_t *p_var;
 348
 349     assert( p_this );
 350
 351     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 352
 353     vlc_mutex_lock( &p_priv->var_lock );
 354
 355     i_var = GetUnused( p_this, psz_name );
 356     if( i_var < 0 )
 357     {
 358         vlc_mutex_unlock( &p_priv->var_lock );
 359         return i_var;
 360     }
 361
 362     p_var = p_priv->pp_vars[i_var];
 363
 364     if( p_var->i_usage > 1 )
 365     {
 366         p_var->i_usage--;
 367         vlc_mutex_unlock( &p_priv->var_lock );
 368         return VLC_SUCCESS;
 369     }
 370
 371     p_priv->i_vars--;
 372     memmove( p_priv->pp_vars + i_var,
 373              p_priv->pp_vars + i_var + 1,
 374              (p_priv->i_vars - i_var) * sizeof(variable_t *) );
 375
 376     if( p_priv->i_vars == 0 )
 377     {
 378         free( p_priv->pp_vars );
 379         p_priv->pp_vars = NULL;
 380     }
 381     else
 382     if( (p_priv->i_vars & 15) == 0 )
 383     {
 384         variable_t **pp_vars = realloc( p_priv->pp_vars,
 385                                     (p_priv->i_vars) * sizeof(variable_t *) );
 386         if( pp_vars != NULL )
 387             p_priv->pp_vars = pp_vars;
 388     }
 389     vlc_mutex_unlock( &p_priv->var_lock );
 390
 391     Destroy( p_var );
 392     return VLC_SUCCESS;
 393 }
 394
 395 /**
 396  * Perform an action on a variable
 397  *
 398  * \param p_this The object that holds the variable
 399  * \param psz_name The name of the variable
 400  * \param i_action The action to perform. Must be one of \ref var_action
 401  * \param p_val First action parameter
 402  * \param p_val2 Second action parameter
 403  */
 404 int __var_Change( vlc_object_t *p_this, const char *psz_name,
 405                   int i_action, vlc_value_t *p_val, vlc_value_t *p_val2 )
 406 {
 407     int i_var, i;
 408     variable_t *p_var;
 409     vlc_value_t oldval;
 410
 411     assert( p_this );
 412
 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_this, 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->pp_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 = p_var->psz_text ? strdup( p_var->psz_text )
 618                                                 : NULL;
 619             break;
 620         case VLC_VAR_SETISCOMMAND:
 621             p_var->i_type |= VLC_VAR_ISCOMMAND;
 622             break;
 623
 624         default:
 625             break;
 626     }
 627
 628     vlc_mutex_unlock( &p_priv->var_lock );
 629
 630     return VLC_SUCCESS;
 631 }
 632
 633
 634 /**
 635  * Perform a Get and Set on a variable
 636  *
 637  * \param p_this: The object that hold the variable
 638  * \param psz_name: the name of the variable
 639  * \param i_action: the action to perform
 640  * \param p_val: The action parameter
 641  * \return vlc error codes
 642  */
 643 int __var_GetAndSet( vlc_object_t *p_this, const char *psz_name, int i_action,
 644                      vlc_value_t val )
 645 {
 646     int i_var;
 647     int i_ret;
 648     variable_t *p_var;
 649     vlc_value_t oldval;
 650
 651     assert( p_this );
 652
 653     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 654
 655     vlc_mutex_lock( &p_priv->var_lock );
 656     i_var = GetUnused( p_this, psz_name );
 657     if( i_var < 0 )
 658     {
 659         vlc_mutex_unlock( &p_priv->var_lock );
 660         return i_var;
 661     }
 662
 663     p_var = p_priv->pp_vars[i_var];
 664
 665     /* Duplicated data if needed */
 666     //p_var->ops->pf_dup( &val );
 667
 668     /* Backup needed stuff */
 669     oldval = p_var->val;
 670
 671     /* depending of the action requiered */
 672     switch( i_action )
 673     {
 674     case VLC_VAR_TOGGLE_BOOL:
 675         assert( ( p_var->i_type & VLC_VAR_BOOL ) == VLC_VAR_BOOL );
 676         p_var->val.b_bool = !p_var->val.b_bool;
 677         break;
 678     case VLC_VAR_INTEGER_INCDEC:
 679         assert( ( p_var->i_type & VLC_VAR_INTEGER ) == VLC_VAR_INTEGER );
 680         p_var->val.i_int += val.i_int;
 681         break;
 682     default:
 683         vlc_mutex_unlock( &p_priv->var_lock );
 684         return VLC_EGENERIC;
 685     }
 686
 687     /*  Check boundaries */
 688     CheckValue( p_var, &p_var->val );
 689
 690     /* Deal with callbacks.*/
 691     i_ret = TriggerCallback( p_this, p_var, psz_name, oldval );
 692
 693     vlc_mutex_unlock( &p_priv->var_lock );
 694
 695     return i_ret;
 696 }
 697
 698
 699 /**
 700  * Request a variable's type
 701  *
 702  * \return The variable type if it exists, or 0 if the
 703  * variable could not be found.
 704  * \see \ref var_type
 705  */
 706 int __var_Type( vlc_object_t *p_this, const char *psz_name )
 707 {
 708     int i_var, i_type;
 709
 710     assert( p_this );
 711
 712     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 713
 714     vlc_mutex_lock( &p_priv->var_lock );
 715
 716     i_var = Lookup( p_this, psz_name );
 717
 718     if( i_var < 0 )
 719     {
 720         vlc_mutex_unlock( &p_priv->var_lock );
 721         return 0;
 722     }
 723
 724     i_type = p_priv->pp_vars[i_var]->i_type;
 725
 726     vlc_mutex_unlock( &p_priv->var_lock );
 727
 728     return i_type;
 729 }
 730
 731 int var_SetChecked( vlc_object_t *p_this, const char *psz_name,
 732                     int expected_type, vlc_value_t val )
 733 {
 734     int i_var;
 735     int i_ret = VLC_SUCCESS;
 736     variable_t *p_var;
 737     vlc_value_t oldval;
 738
 739     assert( p_this );
 740
 741     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 742
 743     vlc_mutex_lock( &p_priv->var_lock );
 744
 745     i_var = GetUnused( p_this, psz_name );
 746     if( i_var < 0 )
 747     {
 748         vlc_mutex_unlock( &p_priv->var_lock );
 749         return i_var;
 750     }
 751
 752     p_var = p_priv->pp_vars[i_var];
 753     assert( expected_type == 0 ||
 754             (p_var->i_type & VLC_VAR_CLASS) == expected_type );
 755
 756     /* Duplicate data if needed */
 757     p_var->ops->pf_dup( &val );
 758
 759     /* Backup needed stuff */
 760     oldval = p_var->val;
 761
 762     /* Check boundaries and list */
 763     CheckValue( p_var, &val );
 764
 765     /* Set the variable */
 766     p_var->val = val;
 767
 768     /* Deal with callbacks */
 769     i_ret = TriggerCallback( p_this, p_var, psz_name, oldval );
 770
 771     /* Free data if needed */
 772     p_var->ops->pf_free( &oldval );
 773
 774     vlc_mutex_unlock( &p_priv->var_lock );
 775
 776     return i_ret;
 777 }
 778
 779
 780 /**
 781  * Set a variable's value
 782  *
 783  * \param p_this The object that hold the variable
 784  * \param psz_name The name of the variable
 785  * \param val the value to set
 786  */
 787 int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val )
 788 {
 789     return var_SetChecked( p_this, psz_name, 0, val );
 790 }
 791
 792 int var_GetChecked( vlc_object_t *p_this, const char *psz_name,
 793                     int expected_type, vlc_value_t *p_val )
 794 {
 795     assert( p_this );
 796
 797     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 798     int i_var, err = VLC_SUCCESS;
 799
 800     vlc_mutex_lock( &p_priv->var_lock );
 801
 802     i_var = Lookup( p_this, psz_name );
 803     if( i_var >= 0 )
 804     {
 805         variable_t *p_var = p_priv->pp_vars[i_var];
 806
 807         assert( expected_type == 0 ||
 808                 (p_var->i_type & VLC_VAR_CLASS) == expected_type );
 809
 810         /* Really get the variable */
 811         *p_val = p_var->val;
 812
 813 #ifndef NDEBUG
 814         /* Alert if the type is VLC_VAR_VOID */
 815         if( ( p_var->i_type & VLC_VAR_TYPE ) == VLC_VAR_VOID )
 816             msg_Warn( p_this, "Calling var_GetVoid on the void variable '%s' (0x%04x)", psz_name, p_var->i_type );
 817 #endif
 818
 819         /* Duplicate value if needed */
 820         p_var->ops->pf_dup( p_val );
 821     }
 822     else
 823         err = VLC_ENOVAR;
 824
 825     vlc_mutex_unlock( &p_priv->var_lock );
 826     return err;
 827 }
 828
 829 /**
 830  * Get a variable's value
 831  *
 832  * \param p_this The object that holds the variable
 833  * \param psz_name The name of the variable
 834  * \param p_val Pointer to a vlc_value_t that will hold the variable's value
 835  *              after the function is finished
 836  */
 837 int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
 838 {
 839     return var_GetChecked( p_this, psz_name, 0, p_val );
 840 }
 841
 842 /**
 843  * Register a callback in a variable
 844  *
 845  * We store a function pointer that will be called upon variable
 846  * modification.
 847  *
 848  * \param p_this The object that holds the variable
 849  * \param psz_name The name of the variable
 850  * \param pf_callback The function pointer
 851  * \param p_data A generic pointer that will be passed as the last
 852  *               argument to the callback function.
 853  *
 854  * \warning The callback function is run in the thread that calls var_Set on
 855  *          the variable. Use proper locking. This thread may not have much
 856  *          time to spare, so keep callback functions short.
 857  */
 858 int __var_AddCallback( vlc_object_t *p_this, const char *psz_name,
 859                        vlc_callback_t pf_callback, void *p_data )
 860 {
 861     int i_var;
 862     variable_t *p_var;
 863     callback_entry_t entry;
 864
 865     assert( p_this );
 866
 867     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 868
 869     entry.pf_callback = pf_callback;
 870     entry.p_data = p_data;
 871
 872     vlc_mutex_lock( &p_priv->var_lock );
 873
 874     i_var = GetUnused( p_this, psz_name );
 875     if( i_var < 0 )
 876     {
 877 #ifndef NDEBUG
 878         msg_Warn( p_this, "Failed to add a callback to the non-existing "
 879                           "variable '%s'", psz_name );
 880 #endif
 881         vlc_mutex_unlock( &p_priv->var_lock );
 882         return i_var;
 883     }
 884
 885     p_var = p_priv->pp_vars[i_var];
 886
 887     INSERT_ELEM( p_var->p_entries,
 888                  p_var->i_entries,
 889                  p_var->i_entries,
 890                  entry );
 891
 892     vlc_mutex_unlock( &p_priv->var_lock );
 893
 894     return VLC_SUCCESS;
 895 }
 896
 897 /**
 898  * Remove a callback from a variable
 899  *
 900  * pf_callback and p_data have to be given again, because different objects
 901  * might have registered the same callback function.
 902  */
 903 int __var_DelCallback( vlc_object_t *p_this, const char *psz_name,
 904                        vlc_callback_t pf_callback, void *p_data )
 905 {
 906     int i_entry, i_var;
 907     variable_t *p_var;
 908 #ifndef NDEBUG
 909     bool b_found_similar = false;
 910 #endif
 911
 912     assert( p_this );
 913
 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->pp_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 #ifndef NDEBUG
 935         else if( p_var->p_entries[i_entry].pf_callback == pf_callback )
 936             b_found_similar = true;
 937 #endif
 938     }
 939
 940     if( i_entry < 0 )
 941     {
 942 #ifndef NDEBUG
 943         if( b_found_similar )
 944             fprintf( stderr, "Calling var_DelCallback for '%s' with the same "
 945                              "function but not the same data.", psz_name );
 946         assert( 0 );
 947 #endif
 948         vlc_mutex_unlock( &p_priv->var_lock );
 949         return VLC_EGENERIC;
 950     }
 951
 952     REMOVE_ELEM( p_var->p_entries, p_var->i_entries, i_entry );
 953
 954     vlc_mutex_unlock( &p_priv->var_lock );
 955
 956     return VLC_SUCCESS;
 957 }
 958
 959 /**
 960  * Trigger callback on a variable
 961  *
 962  * \param p_this The object that hold the variable
 963  * \param psz_name The name of the variable
 964  */
 965 int __var_TriggerCallback( vlc_object_t *p_this, const char *psz_name )
 966 {
 967     int i_var;
 968     int i_ret;
 969     variable_t *p_var;
 970
 971     assert( p_this );
 972
 973     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 974
 975     vlc_mutex_lock( &p_priv->var_lock );
 976
 977     i_var = GetUnused( p_this, psz_name );
 978     if( i_var < 0 )
 979     {
 980         vlc_mutex_unlock( &p_priv->var_lock );
 981         return i_var;
 982     }
 983
 984     p_var = p_priv->pp_vars[i_var];
 985
 986     /* Deal with callbacks. Tell we're in a callback, release the lock,
 987      * call stored functions, retake the lock. */
 988     i_ret = TriggerCallback( p_this, p_var, psz_name, p_var->val );
 989
 990     vlc_mutex_unlock( &p_priv->var_lock );
 991     return i_ret;
 992 }
 993
 994 /** Parse a stringified option
 995  * This function parse a string option and create the associated object
 996  * variable
 997  * The option must be of the form "[no[-]]foo[=bar]" where foo is the
 998  * option name and bar is the value of the option.
 999  * \param p_obj the object in which the variable must be created
1000  * \param psz_option the option to parse
1001  * \param trusted whether the option is set by a trusted input or not
1002  * \return nothing
1003  */
1004 void var_OptionParse( vlc_object_t *p_obj, const char *psz_option,
1005                       bool trusted )
1006 {
1007     char *psz_name, *psz_value;
1008     int  i_type;
1009     bool b_isno = false;
1010     vlc_value_t val;
1011
1012     val.psz_string = NULL;
1013
1014     /* It's too much of a hassle to remove the ':' when we parse
1015      * the cmd line :) */
1016     if( psz_option[0] == ':' )
1017         psz_option++;
1018
1019     if( !psz_option[0] )
1020         return;
1021
1022     psz_name = strdup( psz_option );
1023     if( psz_name == NULL )
1024         return;
1025
1026     psz_value = strchr( psz_name, '=' );
1027     if( psz_value != NULL )
1028         *psz_value++ = '\0';
1029
1030     /* FIXME: :programs should be handled generically */
1031     if( !strcmp( psz_name, "programs" ) )
1032         i_type = VLC_VAR_LIST;
1033     else
1034         i_type = config_GetType( p_obj, psz_name );
1035
1036     if( !i_type && !psz_value )
1037     {
1038         /* check for "no-foo" or "nofoo" */
1039         if( !strncmp( psz_name, "no-", 3 ) )
1040         {
1041             memmove( psz_name, psz_name + 3, strlen(psz_name) + 1 - 3 );
1042         }
1043         else if( !strncmp( psz_name, "no", 2 ) )
1044         {
1045             memmove( psz_name, psz_name + 2, strlen(psz_name) + 1 - 2 );
1046         }
1047         else goto cleanup;           /* Option doesn't exist */
1048
1049         b_isno = true;
1050         i_type = config_GetType( p_obj, psz_name );
1051     }
1052     if( !i_type ) goto cleanup; /* Option doesn't exist */
1053
1054     if( ( i_type != VLC_VAR_BOOL ) &&
1055         ( !psz_value || !*psz_value ) ) goto cleanup; /* Invalid value */
1056
1057     /* check if option is unsafe */
1058     if( !trusted )
1059     {
1060         module_config_t *p_config = config_FindConfig( p_obj, psz_name );
1061         if( !p_config || !p_config->b_safe )
1062         {
1063             msg_Err( p_obj, "unsafe option \"%s\" has been ignored for "
1064                             "security reasons", psz_name );
1065             free( psz_name );
1066             return;
1067         }
1068     }
1069
1070     /* Create the variable in the input object.
1071      * Children of the input object will be able to retreive this value
1072      * thanks to the inheritance property of the object variables. */
1073     __var_Create( p_obj, psz_name, i_type );
1074
1075     switch( i_type )
1076     {
1077     case VLC_VAR_BOOL:
1078         val.b_bool = !b_isno;
1079         break;
1080
1081     case VLC_VAR_INTEGER:
1082         val.i_int = strtol( psz_value, NULL, 0 );
1083         break;
1084
1085     case VLC_VAR_FLOAT:
1086         val.f_float = us_atof( psz_value );
1087         break;
1088
1089     case VLC_VAR_STRING:
1090     case VLC_VAR_MODULE:
1091     case VLC_VAR_FILE:
1092     case VLC_VAR_DIRECTORY:
1093         val.psz_string = psz_value;
1094         break;
1095
1096     case VLC_VAR_LIST:
1097     {
1098         char *psz_orig, *psz_var;
1099         vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1100         val.p_list = p_list;
1101         p_list->i_count = 0;
1102
1103         psz_var = psz_orig = strdup(psz_value);
1104         while( psz_var && *psz_var )
1105         {
1106             char *psz_item = psz_var;
1107             vlc_value_t val2;
1108             while( *psz_var && *psz_var != ',' ) psz_var++;
1109             if( *psz_var == ',' )
1110             {
1111                 *psz_var = '\0';
1112                 psz_var++;
1113             }
1114             val2.i_int = strtol( psz_item, NULL, 0 );
1115             INSERT_ELEM( p_list->p_values, p_list->i_count,
1116                          p_list->i_count, val2 );
1117             /* p_list->i_count is incremented twice by INSERT_ELEM */
1118             p_list->i_count--;
1119             INSERT_ELEM( p_list->pi_types, p_list->i_count,
1120                          p_list->i_count, VLC_VAR_INTEGER );
1121         }
1122         free( psz_orig );
1123         break;
1124     }
1125
1126     default:
1127         goto cleanup;
1128     }
1129
1130     __var_Set( p_obj, psz_name, val );
1131
1132     /* If that's a list, remove all elements allocated */
1133     if( i_type == VLC_VAR_LIST )
1134         FreeList( &val );
1135
1136 cleanup:
1137     free( psz_name );
1138 }
1139
1140
1141 /* Following functions are local */
1142
1143 /*****************************************************************************
1144  * GetUnused: find an unused (not in callback) variable from its name
1145  *****************************************************************************/
1146 static int GetUnused( vlc_object_t *p_this, const char *psz_name )
1147 {
1148     assert( p_this );
1149
1150     vlc_object_internals_t *p_priv = vlc_internals( p_this );
1151
1152     while( true )
1153     {
1154         int i_var;
1155
1156         i_var = Lookup( p_this, psz_name );
1157         if( i_var < 0 )
1158         {
1159             return VLC_ENOVAR;
1160         }
1161
1162         if( ! p_priv->pp_vars[i_var]->b_incallback )
1163         {
1164             return i_var;
1165         }
1166
1167         mutex_cleanup_push( &p_priv->var_lock );
1168         vlc_cond_wait( &p_priv->var_wait, &p_priv->var_lock );
1169         vlc_cleanup_pop( );
1170     }
1171 }
1172
1173 /*****************************************************************************
1174  * HashString: our cool hash function
1175  *****************************************************************************
1176  * This function is not intended to be crypto-secure, we only want it to be
1177  * fast and not suck too much. This one is pretty fast and did 0 collisions
1178  * in wenglish's dictionary.
1179  *****************************************************************************/
1180 static uint32_t HashString( const char *psz_string )
1181 {
1182     uint32_t i_hash = 0;
1183
1184     while( *psz_string )
1185     {
1186         i_hash += *psz_string++;
1187         i_hash += i_hash << 10;
1188         i_hash ^= i_hash >> 8;
1189     }
1190
1191     return i_hash;
1192 }
1193
1194 /*****************************************************************************
1195  * Insert: find an empty slot to insert a new variable
1196  *****************************************************************************
1197  * We use a recursive inner function indexed on the hash. This function does
1198  * nothing in the rare cases where a collision may occur, see Lookup()
1199  * to see how we handle them.
1200  * XXX: does this really need to be written recursively?
1201  *****************************************************************************/
1202 static int Insert( variable_t **pp_vars, int i_count, const char *psz_name )
1203 {
1204     if( i_count == 0 )
1205     {
1206         return 0;
1207     }
1208
1209     return InsertInner( pp_vars, i_count, HashString( psz_name ) );
1210 }
1211
1212 static int InsertInner( variable_t **pp_vars, int i_count, uint32_t i_hash )
1213 {
1214     int i_middle;
1215
1216     if( i_hash <= pp_vars[0]->i_hash )
1217     {
1218         return 0;
1219     }
1220
1221     if( i_hash >= pp_vars[i_count - 1]->i_hash )
1222     {
1223         return i_count;
1224     }
1225
1226     i_middle = i_count / 2;
1227
1228     /* We know that 0 < i_middle */
1229     if( i_hash < pp_vars[i_middle]->i_hash )
1230     {
1231         return InsertInner( pp_vars, i_middle, i_hash );
1232     }
1233
1234     /* We know that i_middle + 1 < i_count */
1235     if( i_hash > pp_vars[i_middle + 1]->i_hash )
1236     {
1237         return i_middle + 1 + InsertInner( pp_vars + i_middle + 1,
1238                                            i_count - i_middle - 1,
1239                                            i_hash );
1240     }
1241
1242     return i_middle + 1;
1243 }
1244
1245 static int u32cmp( const void *key, const void *data )
1246 {
1247     const variable_t *const *pp_var = data;
1248     uint32_t hash = *(const uint32_t *)key ;
1249
1250     if( hash > (*pp_var)->i_hash )
1251         return 1;
1252     if( hash < (*pp_var)->i_hash )
1253         return -1;
1254     return 0;
1255 }
1256
1257 /*****************************************************************************
1258  * Lookup: find an existing variable given its name
1259  *****************************************************************************
1260  * We use a recursive inner function indexed on the hash. Care is taken of
1261  * possible hash collisions.
1262  *****************************************************************************/
1263 static int Lookup( vlc_object_t *obj, const char *psz_name )
1264 {
1265     vlc_object_internals_t *priv = vlc_internals( obj );
1266     variable_t **pp_vars = priv->pp_vars;
1267     size_t i_vars = priv->i_vars;
1268     variable_t **pp_var;
1269     uint32_t i_hash = HashString( psz_name );
1270
1271     pp_var = bsearch( &i_hash, pp_vars, i_vars, sizeof( *pp_var ), u32cmp );
1272
1273     /* Hash not found */
1274     if( pp_var == NULL )
1275         return -1;
1276
1277     assert( i_vars > 0 );
1278
1279     /* Find the first entry with the right hash */
1280     while( (pp_var > pp_vars) && (i_hash == pp_var[-1]->i_hash) )
1281         pp_var--;
1282
1283     assert( (*pp_var)->i_hash == i_hash );
1284
1285     /* Hash collision should be very unlikely, but we cannot guarantee
1286      * it will never happen. So we do an exhaustive search amongst all
1287      * entries with the same hash. Typically, there is only one anyway. */
1288     for( variable_t *const *p_end = pp_vars + i_vars;
1289          (pp_var < p_end) && (i_hash == (*pp_var)->i_hash);
1290          pp_var++ )
1291     {
1292         if( !strcmp( psz_name, (*pp_var)->psz_name ) )
1293             return pp_var - pp_vars;
1294     }
1295
1296     /* Hash found, but entry not found */
1297     return -1;
1298 }
1299
1300 /*****************************************************************************
1301  * CheckValue: check that a value is valid wrt. a variable
1302  *****************************************************************************
1303  * This function checks p_val's value against p_var's limitations such as
1304  * minimal and maximal value, step, in-list position, and modifies p_val if
1305  * necessary.
1306  ****************************************************************************/
1307 static void CheckValue ( variable_t *p_var, vlc_value_t *p_val )
1308 {
1309     /* Check that our variable is in the list */
1310     if( p_var->i_type & VLC_VAR_HASCHOICE && p_var->choices.i_count )
1311     {
1312         int i;
1313
1314         /* This list is not sorted so go throug it (this is a small list) */
1315         for( i = p_var->choices.i_count ; i-- ; )
1316         {
1317             if( p_var->ops->pf_cmp( *p_val, p_var->choices.p_values[i] ) == 0 )
1318             {
1319                 break;
1320             }
1321         }
1322
1323         /* If not found, change it to anything vaguely valid */
1324         if( i < 0 )
1325         {
1326             /* Free the old variable, get the new one, dup it */
1327             p_var->ops->pf_free( p_val );
1328             *p_val = p_var->choices.p_values[p_var->i_default >= 0
1329                                           ? p_var->i_default : 0 ];
1330             p_var->ops->pf_dup( p_val );
1331         }
1332     }
1333
1334     /* Check that our variable is within the bounds */
1335     switch( p_var->i_type & VLC_VAR_TYPE )
1336     {
1337         case VLC_VAR_INTEGER:
1338             if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.i_int
1339                  && (p_val->i_int % p_var->step.i_int) )
1340             {
1341                 p_val->i_int = (p_val->i_int + (p_var->step.i_int / 2))
1342                                / p_var->step.i_int * p_var->step.i_int;
1343             }
1344             if( p_var->i_type & VLC_VAR_HASMIN
1345                  && p_val->i_int < p_var->min.i_int )
1346             {
1347                 p_val->i_int = p_var->min.i_int;
1348             }
1349             if( p_var->i_type & VLC_VAR_HASMAX
1350                  && p_val->i_int > p_var->max.i_int )
1351             {
1352                 p_val->i_int = p_var->max.i_int;
1353             }
1354             break;
1355         case VLC_VAR_FLOAT:
1356             if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.f_float )
1357             {
1358                 float f_round = p_var->step.f_float * (float)(int)( 0.5 +
1359                                         p_val->f_float / p_var->step.f_float );
1360                 if( p_val->f_float != f_round )
1361                 {
1362                     p_val->f_float = f_round;
1363                 }
1364             }
1365             if( p_var->i_type & VLC_VAR_HASMIN
1366                  && p_val->f_float < p_var->min.f_float )
1367             {
1368                 p_val->f_float = p_var->min.f_float;
1369             }
1370             if( p_var->i_type & VLC_VAR_HASMAX
1371                  && p_val->f_float > p_var->max.f_float )
1372             {
1373                 p_val->f_float = p_var->max.f_float;
1374             }
1375             break;
1376         case VLC_VAR_TIME:
1377             /* FIXME: TODO */
1378             break;
1379     }
1380 }
1381
1382 /**
1383  * Finds the value of a variable. If the specified object does not hold a
1384  * variable with the specified name, try the parent object, and iterate until
1385  * the top of the tree. If no match is found, the value is read from the
1386  * configuration.
1387  */
1388 int var_Inherit( vlc_object_t *p_this, const char *psz_name, int i_type,
1389                  vlc_value_t *p_val )
1390 {
1391     i_type &= VLC_VAR_CLASS;
1392     for( vlc_object_t *obj = p_this; obj != NULL; obj = obj->p_parent )
1393         if( var_GetChecked( obj, psz_name, i_type, p_val ) == VLC_SUCCESS )
1394             return VLC_SUCCESS;
1395
1396     /* else take value from config */
1397     switch( i_type & VLC_VAR_CLASS )
1398     {
1399         case VLC_VAR_STRING:
1400             p_val->psz_string = config_GetPsz( p_this, psz_name );
1401             if( !p_val->psz_string ) p_val->psz_string = strdup("");
1402             break;
1403         case VLC_VAR_FLOAT:
1404             p_val->f_float = config_GetFloat( p_this, psz_name );
1405             break;
1406         case VLC_VAR_INTEGER:
1407             p_val->i_int = config_GetInt( p_this, psz_name );
1408             break;
1409         case VLC_VAR_BOOL:
1410             p_val->b_bool = config_GetInt( p_this, psz_name );
1411             break;
1412         case VLC_VAR_LIST:
1413         {
1414             char *psz_orig, *psz_var;
1415             vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1416             p_val->p_list = p_list;
1417             p_list->i_count = 0;
1418
1419             psz_var = psz_orig = config_GetPsz( p_this, psz_name );
1420             while( psz_var && *psz_var )
1421             {
1422                 char *psz_item = psz_var;
1423                 vlc_value_t val;
1424                 while( *psz_var && *psz_var != ',' ) psz_var++;
1425                 if( *psz_var == ',' )
1426                 {
1427                     *psz_var = '\0';
1428                     psz_var++;
1429                 }
1430                 val.i_int = strtol( psz_item, NULL, 0 );
1431                 INSERT_ELEM( p_list->p_values, p_list->i_count,
1432                              p_list->i_count, val );
1433                 /* p_list->i_count is incremented twice by INSERT_ELEM */
1434                 p_list->i_count--;
1435                 INSERT_ELEM( p_list->pi_types, p_list->i_count,
1436                              p_list->i_count, VLC_VAR_INTEGER );
1437             }
1438             free( psz_orig );
1439             break;
1440         }
1441         default:
1442             msg_Warn( p_this, "Could not inherit value for var %s "
1443                               "from config. Invalid Type", psz_name );
1444             return VLC_ENOOBJ;
1445     }
1446     /*msg_Dbg( p_this, "Inherited value for var %s from config", psz_name );*/
1447     return VLC_SUCCESS;
1448 }
1449
1450
1451 /**********************************************************************
1452  * Trigger the callbacks.
1453  * Tell we're in a callback, release the lock, call stored functions,
1454  * retake the lock.
1455  **********************************************************************/
1456 static int TriggerCallback( vlc_object_t *p_this, variable_t *p_var,
1457                             const char *psz_name, vlc_value_t oldval )
1458 {
1459     assert( p_this );
1460
1461     int i_entries = p_var->i_entries;
1462     if( i_entries == 0 )
1463         return VLC_SUCCESS;
1464
1465     callback_entry_t *p_entries = p_var->p_entries;
1466     vlc_object_internals_t *p_priv = vlc_internals( p_this );
1467
1468     p_var->b_incallback = true;
1469     vlc_mutex_unlock( &p_priv->var_lock );
1470
1471     /* The real calls */
1472     for( ; i_entries-- ; )
1473     {
1474         p_entries[i_entries].pf_callback( p_this, psz_name, oldval, p_var->val,
1475                                           p_entries[i_entries].p_data );
1476     }
1477
1478     vlc_mutex_lock( &p_priv->var_lock );
1479     p_var->b_incallback = false;
1480     vlc_cond_broadcast( &p_priv->var_wait );
1481
1482     return VLC_SUCCESS;
1483 }
1484
1485
1486 /**********************************************************************
1487  * Execute a var command on an object identified by its name
1488  **********************************************************************/
1489 int __var_Command( vlc_object_t *p_this, const char *psz_name,
1490                    const char *psz_cmd, const char *psz_arg, char **psz_msg )
1491 {
1492     vlc_object_t *p_obj = vlc_object_find_name( p_this->p_libvlc,
1493                                                 psz_name, FIND_CHILD );
1494     int i_type, i_ret;
1495
1496     if( !p_obj )
1497     {
1498         if( psz_msg )
1499             *psz_msg = strdup( "Unknown destination object." );
1500         return VLC_ENOOBJ;
1501     }
1502
1503     i_type = var_Type( p_obj, psz_cmd );
1504     if( !( i_type&VLC_VAR_ISCOMMAND ) )
1505     {
1506         vlc_object_release( p_obj );
1507         if( psz_msg )
1508             *psz_msg = strdup( "Variable doesn't exist or isn't a command." );
1509         return VLC_EGENERIC;
1510     }
1511
1512     i_type &= VLC_VAR_CLASS;
1513     switch( i_type )
1514     {
1515         case VLC_VAR_INTEGER:
1516             i_ret = var_SetInteger( p_obj, psz_cmd, atoi( psz_arg ) );
1517             break;
1518         case VLC_VAR_FLOAT:
1519             i_ret = var_SetFloat( p_obj, psz_cmd, us_atof( psz_arg ) );
1520             break;
1521         case VLC_VAR_STRING:
1522             i_ret = var_SetString( p_obj, psz_cmd, psz_arg );
1523             break;
1524         case VLC_VAR_BOOL:
1525             i_ret = var_SetBool( p_obj, psz_cmd, atoi( psz_arg ) );
1526             break;
1527         default:
1528             i_ret = VLC_EGENERIC;
1529             break;
1530     }
1531
1532     vlc_object_release( p_obj );
1533
1534     if( psz_msg )
1535     {
1536         if( asprintf( psz_msg, "%s on object %s returned %i (%s)",
1537                   psz_cmd, psz_name, i_ret, vlc_error( i_ret ) ) == -1)
1538             *psz_msg = NULL;
1539     }
1540
1541     return i_ret;
1542 }
1543
1544
1545 /**
1546  * Free a list and the associated strings
1547  * @param p_val: the list variable
1548  * @param p_val2: the variable associated or NULL
1549  */
1550 void var_FreeList( vlc_value_t *p_val, vlc_value_t *p_val2 )
1551 {
1552     FreeList( p_val );
1553     if( p_val2 && p_val2->p_list )
1554     {
1555         for( int i = 0; i < p_val2->p_list->i_count; i++ )
1556             free( p_val2->p_list->p_values[i].psz_string );
1557         if( p_val2->p_list->i_count )
1558         {
1559             free( p_val2->p_list->p_values );
1560             free( p_val2->p_list->pi_types );
1561         }
1562         free( p_val2->p_list );
1563     }
1564 }