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

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