git.sesse.net Git - vlc/blob - src/misc/variables.c

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