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