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 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * 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 #ifdef HAVE_SEARCH_H
  32 # include <search.h>
  33 #endif
  34 #include <assert.h>
  35 #include <math.h>
  36 #include <limits.h>
  37 #ifdef __GLIBC__
  38 # include <dlfcn.h>
  39 #endif
  40
  41 #include <vlc_common.h>
  42 #include <vlc_charset.h>
  43 #include "libvlc.h"
  44 #include "variables.h"
  45 #include "config/configuration.h"
  46
  47 /*****************************************************************************
  48  * Private types
  49  *****************************************************************************/
  50 struct callback_entry_t
  51 {
  52     vlc_callback_t pf_callback;
  53     void *         p_data;
  54 };
  55
  56 /*****************************************************************************
  57  * Local comparison functions, returns 0 if v == w, < 0 if v < w, > 0 if v > w
  58  *****************************************************************************/
  59 static int CmpBool( vlc_value_t v, vlc_value_t w )
  60 {
  61     return v.b_bool ? w.b_bool ? 0 : 1 : w.b_bool ? -1 : 0;
  62 }
  63
  64 static int CmpInt( vlc_value_t v, vlc_value_t w )
  65 {
  66     return v.i_int == w.i_int ? 0 : v.i_int > w.i_int ? 1 : -1;
  67 }
  68
  69 static int CmpTime( vlc_value_t v, vlc_value_t w )
  70 {
  71     return v.i_time == w.i_time ? 0 : v.i_time > w.i_time ? 1 : -1;
  72 }
  73
  74 static int CmpString( vlc_value_t v, vlc_value_t w )
  75 {
  76     if( !v.psz_string )
  77         return !w.psz_string ? 0 : -1;
  78     else
  79         return !w.psz_string ? 1 : strcmp( v.psz_string, w.psz_string );
  80 }
  81 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; }
  82 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; }
  83
  84 /*****************************************************************************
  85  * Local duplication functions, and local deallocation functions
  86  *****************************************************************************/
  87 static void DupDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
  88 static void DupString( vlc_value_t *p_val )
  89 {
  90     p_val->psz_string = strdup( p_val->psz_string ? p_val->psz_string :  "" );
  91 }
  92
  93 static void FreeDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
  94 static void FreeString( vlc_value_t *p_val ) { free( p_val->psz_string ); }
  95
  96 static void FreeList( vlc_value_t *p_val )
  97 {
  98     int i;
  99     for( i = 0; i < p_val->p_list->i_count; i++ )
 100     {
 101         switch( p_val->p_list->pi_types[i] & VLC_VAR_CLASS )
 102         {
 103         case VLC_VAR_STRING:
 104             FreeString( &p_val->p_list->p_values[i] );
 105             break;
 106         default:
 107             break;
 108         }
 109     }
 110
 111     if( p_val->p_list->i_count )
 112     {
 113         free( p_val->p_list->p_values );
 114         free( p_val->p_list->pi_types );
 115     }
 116     free( p_val->p_list );
 117 }
 118
 119 static const struct variable_ops_t
 120 void_ops   = { NULL,       DupDummy,  FreeDummy,  },
 121 addr_ops   = { CmpAddress, DupDummy,  FreeDummy,  },
 122 bool_ops   = { CmpBool,    DupDummy,  FreeDummy,  },
 123 float_ops  = { CmpFloat,   DupDummy,  FreeDummy,  },
 124 int_ops    = { CmpInt,     DupDummy,  FreeDummy,  },
 125 string_ops = { CmpString,  DupString, FreeString, },
 126 time_ops   = { CmpTime,    DupDummy,  FreeDummy,  },
 127 coords_ops = { NULL,       DupDummy,  FreeDummy,  };
 128
 129 /*****************************************************************************
 130  * Local prototypes
 131  *****************************************************************************/
 132 static void     WaitUnused  ( vlc_object_t *, variable_t * );
 133
 134 static void     CheckValue  ( variable_t *, vlc_value_t * );
 135
 136 static int      TriggerCallback( vlc_object_t *, variable_t *, const char *,
 137                                  vlc_value_t );
 138
 139 static int varcmp( const void *a, const void *b )
 140 {
 141     const variable_t *va = a, *vb = b;
 142
 143     /* psz_name must be first */
 144     assert( va == (const void *)&va->psz_name );
 145     return strcmp( va->psz_name, vb->psz_name );
 146 }
 147
 148 static variable_t *Lookup( vlc_object_t *obj, const char *psz_name )
 149 {
 150     vlc_object_internals_t *priv = vlc_internals( obj );
 151     variable_t **pp_var;
 152
 153     vlc_assert_locked( &priv->var_lock );
 154     pp_var = tfind( &psz_name, &priv->var_root, varcmp );
 155     return (pp_var != NULL) ? *pp_var : NULL;
 156 }
 157
 158 static void Destroy( variable_t *p_var )
 159 {
 160     p_var->ops->pf_free( &p_var->val );
 161     if( p_var->choices.i_count )
 162     {
 163         for( int i = 0 ; i < p_var->choices.i_count ; i++ )
 164         {
 165             p_var->ops->pf_free( &p_var->choices.p_values[i] );
 166             free( p_var->choices_text.p_values[i].psz_string );
 167         }
 168         free( p_var->choices.p_values );
 169         free( p_var->choices_text.p_values );
 170     }
 171 #if 0 // ndef NDEBUG
 172     for (int i = 0; i < p_var->i_entries; i++)
 173     {
 174         const char *file = "?", *symbol = "?";
 175         const void *addr = p_var->p_entries[i].pf_callback;
 176 # ifdef __GLIBC__
 177         Dl_info info;
 178
 179         if (dladdr (addr, &info))
 180         {
 181             if (info.dli_fname) file = info.dli_fname;
 182             if (info.dli_sname) symbol = info.dli_sname;
 183         }
 184 # endif
 185         fprintf (stderr, "Error: callback on \"%s\" dangling %s(%s)[%p]\n",
 186                  p_var->psz_name, file, symbol, addr);
 187     }
 188 #endif
 189
 190     free( p_var->psz_name );
 191     free( p_var->psz_text );
 192     free( p_var->p_entries );
 193     free( p_var );
 194 }
 195
 196 #undef var_Create
 197 /**
 198  * Initialize a vlc variable
 199  *
 200  * We hash the given string and insert it into the sorted list. The insertion
 201  * may require slow memory copies, but think about what we gain in the log(n)
 202  * lookup phase when setting/getting the variable value!
 203  *
 204  * \param p_this The object in which to create the variable
 205  * \param psz_name The name of the variable
 206  * \param i_type The variables type. Must be one of \ref var_type combined with
 207  *               zero or more \ref var_flags
 208  */
 209 int var_Create( vlc_object_t *p_this, const char *psz_name, int i_type )
 210 {
 211     assert( p_this );
 212
 213     variable_t *p_var = calloc( 1, sizeof( *p_var ) );
 214     if( p_var == NULL )
 215         return VLC_ENOMEM;
 216
 217     p_var->psz_name = strdup( psz_name );
 218     p_var->psz_text = NULL;
 219
 220     p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
 221
 222     p_var->i_usage = 1;
 223
 224     p_var->i_default = -1;
 225     p_var->choices.i_count = 0;
 226     p_var->choices.p_values = NULL;
 227     p_var->choices_text.i_count = 0;
 228     p_var->choices_text.p_values = NULL;
 229
 230     p_var->b_incallback = false;
 231     p_var->i_entries = 0;
 232     p_var->p_entries = NULL;
 233
 234     /* Always initialize the variable, even if it is a list variable; this
 235      * will lead to errors if the variable is not initialized, but it will
 236      * not cause crashes in the variable handling. */
 237     switch( i_type & VLC_VAR_CLASS )
 238     {
 239         case VLC_VAR_BOOL:
 240             p_var->ops = &bool_ops;
 241             p_var->val.b_bool = false;
 242             break;
 243         case VLC_VAR_INTEGER:
 244             p_var->ops = &int_ops;
 245             p_var->val.i_int = 0;
 246             break;
 247         case VLC_VAR_STRING:
 248             p_var->ops = &string_ops;
 249             p_var->val.psz_string = NULL;
 250             break;
 251         case VLC_VAR_FLOAT:
 252             p_var->ops = &float_ops;
 253             p_var->val.f_float = 0.0;
 254             break;
 255         case VLC_VAR_TIME:
 256             p_var->ops = &time_ops;
 257             p_var->val.i_time = 0;
 258             break;
 259         case VLC_VAR_COORDS:
 260             p_var->ops = &coords_ops;
 261             p_var->val.coords.x = p_var->val.coords.y = 0;
 262             break;
 263         case VLC_VAR_ADDRESS:
 264             p_var->ops = &addr_ops;
 265             p_var->val.p_address = NULL;
 266             break;
 267         case VLC_VAR_VOID:
 268             p_var->ops = &void_ops;
 269             break;
 270         default:
 271             assert (0);
 272     }
 273
 274     if( (i_type & VLC_VAR_DOINHERIT)
 275      && var_Inherit( p_this, psz_name, i_type, &p_var->val ) == 0 )
 276     {
 277         if( i_type & VLC_VAR_HASCHOICE )
 278         {
 279             /* We must add the inherited value to our choice list */
 280             p_var->i_default = 0;
 281
 282             INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
 283                          0, p_var->val );
 284             INSERT_ELEM( p_var->choices_text.p_values,
 285                          p_var->choices_text.i_count, 0, p_var->val );
 286             p_var->ops->pf_dup( &p_var->choices.p_values[0] );
 287             p_var->choices_text.p_values[0].psz_string = NULL;
 288         }
 289     }
 290
 291     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 292     variable_t **pp_var, *p_oldvar;
 293     int ret = VLC_SUCCESS;
 294
 295     vlc_mutex_lock( &p_priv->var_lock );
 296
 297     pp_var = tsearch( p_var, &p_priv->var_root, varcmp );
 298     if( unlikely(pp_var == NULL) )
 299         ret = VLC_ENOMEM;
 300     else if( (p_oldvar = *pp_var) == p_var ) /* Variable create */
 301         p_var = NULL; /* Variable created */
 302     else /* Variable already exists */
 303     {
 304         assert (((i_type ^ p_oldvar->i_type) & VLC_VAR_CLASS) == 0);
 305         p_oldvar->i_usage++;
 306         p_oldvar->i_type |= i_type & (VLC_VAR_ISCOMMAND|VLC_VAR_HASCHOICE);
 307     }
 308     vlc_mutex_unlock( &p_priv->var_lock );
 309
 310     /* If we did not need to create a new variable, free everything... */
 311     if( p_var != NULL )
 312         Destroy( p_var );
 313     return ret;
 314 }
 315
 316 #undef var_Destroy
 317 /**
 318  * Destroy a vlc variable
 319  *
 320  * Look for the variable and destroy it if it is found. As in var_Create we
 321  * do a call to memmove() but we have performance counterparts elsewhere.
 322  *
 323  * \param p_this The object that holds the variable
 324  * \param psz_name The name of the variable
 325  */
 326 int var_Destroy( vlc_object_t *p_this, const char *psz_name )
 327 {
 328     variable_t *p_var;
 329
 330     assert( p_this );
 331
 332     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 333
 334     vlc_mutex_lock( &p_priv->var_lock );
 335
 336     p_var = Lookup( p_this, psz_name );
 337     if( p_var == NULL )
 338     {
 339         vlc_mutex_unlock( &p_priv->var_lock );
 340         return VLC_ENOVAR;
 341     }
 342
 343     WaitUnused( p_this, p_var );
 344
 345     if( --p_var->i_usage == 0 )
 346         tdelete( p_var, &p_priv->var_root, varcmp );
 347     else
 348         p_var = NULL;
 349     vlc_mutex_unlock( &p_priv->var_lock );
 350
 351     if( p_var != NULL )
 352         Destroy( p_var );
 353     return VLC_SUCCESS;
 354 }
 355
 356 static void CleanupVar( void *var )
 357 {
 358     Destroy( var );
 359 }
 360
 361 void var_DestroyAll( vlc_object_t *obj )
 362 {
 363     vlc_object_internals_t *priv = vlc_internals( obj );
 364
 365     tdestroy( priv->var_root, CleanupVar );
 366     priv->var_root = NULL;
 367 }
 368
 369 #undef var_Change
 370 /**
 371  * Perform an action on a variable
 372  *
 373  * \param p_this The object that holds the variable
 374  * \param psz_name The name of the variable
 375  * \param i_action The action to perform. Must be one of \ref var_action
 376  * \param p_val First action parameter
 377  * \param p_val2 Second action parameter
 378  */
 379 int var_Change( vlc_object_t *p_this, const char *psz_name,
 380                 int i_action, vlc_value_t *p_val, vlc_value_t *p_val2 )
 381 {
 382     int ret = VLC_SUCCESS;
 383     variable_t *p_var;
 384     vlc_value_t oldval;
 385     vlc_value_t newval;
 386
 387     assert( p_this );
 388
 389     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 390
 391     vlc_mutex_lock( &p_priv->var_lock );
 392
 393     p_var = Lookup( p_this, psz_name );
 394     if( p_var == NULL )
 395     {
 396         vlc_mutex_unlock( &p_priv->var_lock );
 397         return VLC_ENOVAR;
 398     }
 399
 400     switch( i_action )
 401     {
 402         case VLC_VAR_SETMIN:
 403             if( p_var->i_type & VLC_VAR_HASMIN )
 404             {
 405                 p_var->ops->pf_free( &p_var->min );
 406             }
 407             p_var->i_type |= VLC_VAR_HASMIN;
 408             p_var->min = *p_val;
 409             p_var->ops->pf_dup( &p_var->min );
 410             CheckValue( p_var, &p_var->val );
 411             break;
 412         case VLC_VAR_GETMIN:
 413             if( p_var->i_type & VLC_VAR_HASMIN )
 414                 *p_val = p_var->min;
 415             else
 416                 ret = VLC_EGENERIC;
 417             break;
 418         case VLC_VAR_SETMAX:
 419             if( p_var->i_type & VLC_VAR_HASMAX )
 420             {
 421                 p_var->ops->pf_free( &p_var->max );
 422             }
 423             p_var->i_type |= VLC_VAR_HASMAX;
 424             p_var->max = *p_val;
 425             p_var->ops->pf_dup( &p_var->max );
 426             CheckValue( p_var, &p_var->val );
 427             break;
 428         case VLC_VAR_GETMAX:
 429             if( p_var->i_type & VLC_VAR_HASMAX )
 430                 *p_val = p_var->max;
 431             else
 432                 ret = VLC_EGENERIC;
 433             break;
 434         case VLC_VAR_SETSTEP:
 435             if( p_var->i_type & VLC_VAR_HASSTEP )
 436             {
 437                 p_var->ops->pf_free( &p_var->step );
 438             }
 439             p_var->i_type |= VLC_VAR_HASSTEP;
 440             p_var->step = *p_val;
 441             p_var->ops->pf_dup( &p_var->step );
 442             CheckValue( p_var, &p_var->val );
 443             break;
 444         case VLC_VAR_GETSTEP:
 445             if( p_var->i_type & VLC_VAR_HASSTEP )
 446                 *p_val = p_var->step;
 447             else
 448                 ret = VLC_EGENERIC;
 449             break;
 450         case VLC_VAR_ADDCHOICE:
 451         {
 452             int i = p_var->choices.i_count;
 453
 454             INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
 455                          i, *p_val );
 456             INSERT_ELEM( p_var->choices_text.p_values,
 457                          p_var->choices_text.i_count, i, *p_val );
 458             p_var->ops->pf_dup( &p_var->choices.p_values[i] );
 459             p_var->choices_text.p_values[i].psz_string =
 460                 ( p_val2 && p_val2->psz_string ) ?
 461                 strdup( p_val2->psz_string ) : NULL;
 462
 463             CheckValue( p_var, &p_var->val );
 464             break;
 465         }
 466         case VLC_VAR_DELCHOICE:
 467         {
 468             int i;
 469
 470             for( i = 0 ; i < p_var->choices.i_count ; i++ )
 471                 if( p_var->ops->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
 472                     break;
 473
 474             if( i == p_var->choices.i_count )
 475             {
 476                 /* Not found */
 477                 vlc_mutex_unlock( &p_priv->var_lock );
 478                 return VLC_EGENERIC;
 479             }
 480
 481             if( p_var->i_default > i )
 482                 p_var->i_default--;
 483             else if( p_var->i_default == i )
 484                 p_var->i_default = -1;
 485
 486             p_var->ops->pf_free( &p_var->choices.p_values[i] );
 487             free( p_var->choices_text.p_values[i].psz_string );
 488             REMOVE_ELEM( p_var->choices.p_values, p_var->choices.i_count, i );
 489             REMOVE_ELEM( p_var->choices_text.p_values,
 490                          p_var->choices_text.i_count, i );
 491
 492             CheckValue( p_var, &p_var->val );
 493             break;
 494         }
 495         case VLC_VAR_CHOICESCOUNT:
 496             p_val->i_int = p_var->choices.i_count;
 497             break;
 498         case VLC_VAR_CLEARCHOICES:
 499             for( int i = 0 ; i < p_var->choices.i_count ; i++ )
 500                 p_var->ops->pf_free( &p_var->choices.p_values[i] );
 501             for( int i = 0 ; i < p_var->choices_text.i_count ; i++ )
 502                 free( p_var->choices_text.p_values[i].psz_string );
 503
 504             if( p_var->choices.i_count ) free( p_var->choices.p_values );
 505             if( p_var->choices_text.i_count ) free( p_var->choices_text.p_values );
 506
 507             p_var->choices.i_count = 0;
 508             p_var->choices.p_values = NULL;
 509             p_var->choices_text.i_count = 0;
 510             p_var->choices_text.p_values = NULL;
 511             p_var->i_default = -1;
 512             break;
 513         case VLC_VAR_SETDEFAULT:
 514         {
 515             int i;
 516             /* FIXME: the list is sorted, dude. Use something cleverer. */
 517             for( i = 0 ; i < p_var->choices.i_count ; i++ )
 518                 if( p_var->ops->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
 519                     break;
 520
 521             if( i == p_var->choices.i_count )
 522                 /* Not found */
 523                 break;
 524
 525             p_var->i_default = i;
 526             CheckValue( p_var, &p_var->val );
 527             break;
 528         }
 529         case VLC_VAR_SETVALUE:
 530             /* Duplicate data if needed */
 531             newval = *p_val;
 532             p_var->ops->pf_dup( &newval );
 533             /* Backup needed stuff */
 534             oldval = p_var->val;
 535             /* Check boundaries and list */
 536             CheckValue( p_var, &newval );
 537             /* Set the variable */
 538             p_var->val = newval;
 539             /* Free data if needed */
 540             p_var->ops->pf_free( &oldval );
 541             break;
 542         case VLC_VAR_GETCHOICES:
 543         case VLC_VAR_GETLIST:
 544             p_val->p_list = malloc( sizeof(vlc_list_t) );
 545             if( p_val2 ) p_val2->p_list = malloc( sizeof(vlc_list_t) );
 546             if( p_var->choices.i_count )
 547             {
 548                 p_val->p_list->p_values = malloc( p_var->choices.i_count
 549                                                   * sizeof(vlc_value_t) );
 550                 p_val->p_list->pi_types = malloc( p_var->choices.i_count
 551                                                   * sizeof(int) );
 552                 if( p_val2 )
 553                 {
 554                     p_val2->p_list->p_values =
 555                         malloc( p_var->choices.i_count * sizeof(vlc_value_t) );
 556                     p_val2->p_list->pi_types =
 557                         malloc( p_var->choices.i_count * sizeof(int) );
 558                 }
 559             }
 560             p_val->p_list->i_count = p_var->choices.i_count;
 561             if( p_val2 ) p_val2->p_list->i_count = p_var->choices.i_count;
 562             for( int i = 0 ; i < p_var->choices.i_count ; i++ )
 563             {
 564                 p_val->p_list->p_values[i] = p_var->choices.p_values[i];
 565                 p_val->p_list->pi_types[i] = p_var->i_type;
 566                 p_var->ops->pf_dup( &p_val->p_list->p_values[i] );
 567                 if( p_val2 )
 568                 {
 569                     p_val2->p_list->p_values[i].psz_string =
 570                         p_var->choices_text.p_values[i].psz_string ?
 571                     strdup(p_var->choices_text.p_values[i].psz_string) : NULL;
 572                     p_val2->p_list->pi_types[i] = VLC_VAR_STRING;
 573                 }
 574             }
 575             break;
 576         case VLC_VAR_SETTEXT:
 577             free( p_var->psz_text );
 578             if( p_val && p_val->psz_string )
 579                 p_var->psz_text = strdup( p_val->psz_string );
 580             else
 581                 p_var->psz_text = NULL;
 582             break;
 583         case VLC_VAR_GETTEXT:
 584             p_val->psz_string = p_var->psz_text ? strdup( p_var->psz_text )
 585                                                 : NULL;
 586             break;
 587         case VLC_VAR_SETISCOMMAND:
 588             p_var->i_type |= VLC_VAR_ISCOMMAND;
 589             break;
 590
 591         default:
 592             break;
 593     }
 594
 595     vlc_mutex_unlock( &p_priv->var_lock );
 596
 597     return ret;
 598 }
 599
 600 #undef var_GetAndSet
 601 /**
 602  * Perform a Get and Set on a variable
 603  *
 604  * \param p_this: The object that hold the variable
 605  * \param psz_name: the name of the variable
 606  * \param i_action: the action to perform
 607  * \param p_val: The action parameter
 608  * \return vlc error codes
 609  */
 610 int var_GetAndSet( vlc_object_t *p_this, const char *psz_name, int i_action,
 611                    vlc_value_t *p_val )
 612 {
 613     int i_ret;
 614     variable_t *p_var;
 615     vlc_value_t oldval;
 616
 617     assert( p_this );
 618     assert( p_val );
 619
 620     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 621
 622     vlc_mutex_lock( &p_priv->var_lock );
 623     p_var = Lookup( p_this, psz_name );
 624     if( p_var == NULL )
 625     {
 626         vlc_mutex_unlock( &p_priv->var_lock );
 627         return VLC_ENOVAR;
 628     }
 629
 630     WaitUnused( p_this, p_var );
 631
 632     /* Duplicated data if needed */
 633     //p_var->ops->pf_dup( &val );
 634
 635     /* Backup needed stuff */
 636     oldval = p_var->val;
 637
 638     /* depending of the action requiered */
 639     switch( i_action )
 640     {
 641     case VLC_VAR_BOOL_TOGGLE:
 642         assert( ( p_var->i_type & VLC_VAR_BOOL ) == VLC_VAR_BOOL );
 643         p_var->val.b_bool = !p_var->val.b_bool;
 644         break;
 645     case VLC_VAR_INTEGER_ADD:
 646         assert( ( p_var->i_type & VLC_VAR_INTEGER ) == VLC_VAR_INTEGER );
 647         p_var->val.i_int += p_val->i_int;
 648         break;
 649     case VLC_VAR_INTEGER_OR:
 650         assert( ( p_var->i_type & VLC_VAR_INTEGER ) == VLC_VAR_INTEGER );
 651         p_var->val.i_int |= p_val->i_int;
 652         break;
 653     case VLC_VAR_INTEGER_NAND:
 654         assert( ( p_var->i_type & VLC_VAR_INTEGER ) == VLC_VAR_INTEGER );
 655         p_var->val.i_int &= ~p_val->i_int;
 656         break;
 657     default:
 658         vlc_mutex_unlock( &p_priv->var_lock );
 659         return VLC_EGENERIC;
 660     }
 661
 662     /*  Check boundaries */
 663     CheckValue( p_var, &p_var->val );
 664     *p_val = p_var->val;
 665
 666     /* Deal with callbacks.*/
 667     i_ret = TriggerCallback( p_this, p_var, psz_name, oldval );
 668
 669     vlc_mutex_unlock( &p_priv->var_lock );
 670
 671     return i_ret;
 672 }
 673
 674 #undef var_Type
 675 /**
 676  * Request a variable's type
 677  *
 678  * \return The variable type if it exists, or 0 if the
 679  * variable could not be found.
 680  * \see \ref var_type
 681  */
 682 int var_Type( vlc_object_t *p_this, const char *psz_name )
 683 {
 684     variable_t *p_var;
 685     int i_type = 0;
 686
 687     assert( p_this );
 688
 689     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 690
 691     vlc_mutex_lock( &p_priv->var_lock );
 692
 693     p_var = Lookup( p_this, psz_name );
 694     if( p_var != NULL )
 695         i_type = p_var->i_type;
 696
 697     vlc_mutex_unlock( &p_priv->var_lock );
 698
 699     return i_type;
 700 }
 701
 702 #undef var_SetChecked
 703 int var_SetChecked( vlc_object_t *p_this, const char *psz_name,
 704                     int expected_type, vlc_value_t val )
 705 {
 706     int i_ret = VLC_SUCCESS;
 707     variable_t *p_var;
 708     vlc_value_t oldval;
 709
 710     assert( p_this );
 711
 712     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 713
 714     vlc_mutex_lock( &p_priv->var_lock );
 715
 716     p_var = Lookup( p_this, psz_name );
 717     if( p_var == NULL )
 718     {
 719         vlc_mutex_unlock( &p_priv->var_lock );
 720         return VLC_ENOVAR;
 721     }
 722
 723     assert( expected_type == 0 ||
 724             (p_var->i_type & VLC_VAR_CLASS) == expected_type );
 725     assert ((p_var->i_type & VLC_VAR_CLASS) != VLC_VAR_VOID);
 726
 727     WaitUnused( p_this, p_var );
 728
 729     /* Duplicate data if needed */
 730     p_var->ops->pf_dup( &val );
 731
 732     /* Backup needed stuff */
 733     oldval = p_var->val;
 734
 735     /* Check boundaries and list */
 736     CheckValue( p_var, &val );
 737
 738     /* Set the variable */
 739     p_var->val = val;
 740
 741     /* Deal with callbacks */
 742     i_ret = TriggerCallback( p_this, p_var, psz_name, oldval );
 743
 744     /* Free data if needed */
 745     p_var->ops->pf_free( &oldval );
 746
 747     vlc_mutex_unlock( &p_priv->var_lock );
 748
 749     return i_ret;
 750 }
 751
 752 #undef var_Set
 753 /**
 754  * Set a variable's value
 755  *
 756  * \param p_this The object that hold the variable
 757  * \param psz_name The name of the variable
 758  * \param val the value to set
 759  */
 760 int var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val )
 761 {
 762     return var_SetChecked( p_this, psz_name, 0, val );
 763 }
 764
 765 #undef var_GetChecked
 766 int var_GetChecked( vlc_object_t *p_this, const char *psz_name,
 767                     int expected_type, vlc_value_t *p_val )
 768 {
 769     assert( p_this );
 770
 771     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 772     variable_t *p_var;
 773     int err = VLC_SUCCESS;
 774
 775     vlc_mutex_lock( &p_priv->var_lock );
 776
 777     p_var = Lookup( p_this, psz_name );
 778     if( p_var != NULL )
 779     {
 780         assert( expected_type == 0 ||
 781                 (p_var->i_type & VLC_VAR_CLASS) == expected_type );
 782         assert ((p_var->i_type & VLC_VAR_CLASS) != VLC_VAR_VOID);
 783
 784         /* Really get the variable */
 785         *p_val = p_var->val;
 786
 787         /* Duplicate value if needed */
 788         p_var->ops->pf_dup( p_val );
 789     }
 790     else
 791         err = VLC_ENOVAR;
 792
 793     vlc_mutex_unlock( &p_priv->var_lock );
 794     return err;
 795 }
 796
 797 #undef var_Get
 798 /**
 799  * Get a variable's value
 800  *
 801  * \param p_this The object that holds the variable
 802  * \param psz_name The name of the variable
 803  * \param p_val Pointer to a vlc_value_t that will hold the variable's value
 804  *              after the function is finished
 805  */
 806 int var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
 807 {
 808     return var_GetChecked( p_this, psz_name, 0, p_val );
 809 }
 810
 811 #undef var_AddCallback
 812 /**
 813  * Register a callback in a variable
 814  *
 815  * We store a function pointer that will be called upon variable
 816  * modification.
 817  *
 818  * \param p_this The object that holds the variable
 819  * \param psz_name The name of the variable
 820  * \param pf_callback The function pointer
 821  * \param p_data A generic pointer that will be passed as the last
 822  *               argument to the callback function.
 823  *
 824  * \warning The callback function is run in the thread that calls var_Set on
 825  *          the variable. Use proper locking. This thread may not have much
 826  *          time to spare, so keep callback functions short.
 827  */
 828 int var_AddCallback( vlc_object_t *p_this, const char *psz_name,
 829                      vlc_callback_t pf_callback, void *p_data )
 830 {
 831     variable_t *p_var;
 832     callback_entry_t entry;
 833
 834     assert( p_this );
 835
 836     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 837
 838     entry.pf_callback = pf_callback;
 839     entry.p_data = p_data;
 840
 841     vlc_mutex_lock( &p_priv->var_lock );
 842
 843     p_var = Lookup( p_this, psz_name );
 844     if( p_var == NULL )
 845     {
 846         vlc_mutex_unlock( &p_priv->var_lock );
 847         msg_Err( p_this, "cannot add callback %p to nonexistent "
 848                          "variable '%s'", pf_callback, psz_name );
 849         return VLC_ENOVAR;
 850     }
 851
 852     WaitUnused( p_this, p_var );
 853     INSERT_ELEM( p_var->p_entries,
 854                  p_var->i_entries,
 855                  p_var->i_entries,
 856                  entry );
 857
 858     vlc_mutex_unlock( &p_priv->var_lock );
 859
 860     return VLC_SUCCESS;
 861 }
 862
 863 #undef var_DelCallback
 864 /**
 865  * Remove a callback from a variable
 866  *
 867  * pf_callback and p_data have to be given again, because different objects
 868  * might have registered the same callback function.
 869  */
 870 int var_DelCallback( vlc_object_t *p_this, const char *psz_name,
 871                      vlc_callback_t pf_callback, void *p_data )
 872 {
 873     int i_entry;
 874     variable_t *p_var;
 875 #ifndef NDEBUG
 876     bool b_found_similar = false;
 877 #endif
 878
 879     assert( p_this );
 880
 881     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 882
 883     vlc_mutex_lock( &p_priv->var_lock );
 884
 885     p_var = Lookup( p_this, psz_name );
 886     if( p_var == NULL )
 887     {
 888         vlc_mutex_unlock( &p_priv->var_lock );
 889         return VLC_ENOVAR;
 890     }
 891
 892     WaitUnused( p_this, p_var );
 893
 894     for( i_entry = p_var->i_entries ; i_entry-- ; )
 895     {
 896         if( p_var->p_entries[i_entry].pf_callback == pf_callback
 897             && p_var->p_entries[i_entry].p_data == p_data )
 898         {
 899             break;
 900         }
 901 #ifndef NDEBUG
 902         else if( p_var->p_entries[i_entry].pf_callback == pf_callback )
 903             b_found_similar = true;
 904 #endif
 905     }
 906
 907     if( i_entry < 0 )
 908     {
 909 #ifndef NDEBUG
 910         if( b_found_similar )
 911             fprintf( stderr, "Calling var_DelCallback for '%s' with the same "
 912                              "function but not the same data.", psz_name );
 913         assert( 0 );
 914 #endif
 915         vlc_mutex_unlock( &p_priv->var_lock );
 916         return VLC_EGENERIC;
 917     }
 918
 919     REMOVE_ELEM( p_var->p_entries, p_var->i_entries, i_entry );
 920
 921     vlc_mutex_unlock( &p_priv->var_lock );
 922
 923     return VLC_SUCCESS;
 924 }
 925
 926 #undef var_TriggerCallback
 927 /**
 928  * Trigger callback on a variable
 929  *
 930  * \param p_this The object that hold the variable
 931  * \param psz_name The name of the variable
 932  */
 933 int var_TriggerCallback( vlc_object_t *p_this, const char *psz_name )
 934 {
 935     int i_ret;
 936     variable_t *p_var;
 937
 938     assert( p_this );
 939
 940     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 941
 942     vlc_mutex_lock( &p_priv->var_lock );
 943
 944     p_var = Lookup( p_this, psz_name );
 945     if( p_var == NULL )
 946     {
 947         vlc_mutex_unlock( &p_priv->var_lock );
 948         return VLC_ENOVAR;
 949     }
 950
 951     WaitUnused( p_this, p_var );
 952
 953     /* Deal with callbacks. Tell we're in a callback, release the lock,
 954      * call stored functions, retake the lock. */
 955     i_ret = TriggerCallback( p_this, p_var, psz_name, p_var->val );
 956
 957     vlc_mutex_unlock( &p_priv->var_lock );
 958     return i_ret;
 959 }
 960
 961 /** Parse a stringified option
 962  * This function parse a string option and create the associated object
 963  * variable
 964  * The option must be of the form "[no[-]]foo[=bar]" where foo is the
 965  * option name and bar is the value of the option.
 966  * \param p_obj the object in which the variable must be created
 967  * \param psz_option the option to parse
 968  * \param trusted whether the option is set by a trusted input or not
 969  * \return nothing
 970  */
 971 void var_OptionParse( vlc_object_t *p_obj, const char *psz_option,
 972                       bool trusted )
 973 {
 974     char *psz_name, *psz_value;
 975     int  i_type;
 976     bool b_isno = false;
 977     vlc_value_t val;
 978
 979     val.psz_string = NULL;
 980
 981     /* It's too much of a hassle to remove the ':' when we parse
 982      * the cmd line :) */
 983     if( psz_option[0] == ':' )
 984         psz_option++;
 985
 986     if( !psz_option[0] )
 987         return;
 988
 989     psz_name = strdup( psz_option );
 990     if( psz_name == NULL )
 991         return;
 992
 993     psz_value = strchr( psz_name, '=' );
 994     if( psz_value != NULL )
 995         *psz_value++ = '\0';
 996
 997     i_type = config_GetType( p_obj, psz_name );
 998     if( !i_type && !psz_value )
 999     {
1000         /* check for "no-foo" or "nofoo" */
1001         if( !strncmp( psz_name, "no-", 3 ) )
1002         {
1003             memmove( psz_name, psz_name + 3, strlen(psz_name) + 1 - 3 );
1004         }
1005         else if( !strncmp( psz_name, "no", 2 ) )
1006         {
1007             memmove( psz_name, psz_name + 2, strlen(psz_name) + 1 - 2 );
1008         }
1009         else goto cleanup;           /* Option doesn't exist */
1010
1011         b_isno = true;
1012         i_type = config_GetType( p_obj, psz_name );
1013     }
1014     if( !i_type ) goto cleanup; /* Option doesn't exist */
1015
1016     if( ( i_type != VLC_VAR_BOOL ) &&
1017         ( !psz_value || !*psz_value ) ) goto cleanup; /* Invalid value */
1018
1019     /* check if option is unsafe */
1020     if( !trusted && !config_IsSafe( psz_name ) )
1021     {
1022         msg_Err( p_obj, "unsafe option \"%s\" has been ignored for "
1023                         "security reasons", psz_name );
1024         free( psz_name );
1025         return;
1026     }
1027
1028     /* Create the variable in the input object.
1029      * Children of the input object will be able to retreive this value
1030      * thanks to the inheritance property of the object variables. */
1031     var_Create( p_obj, psz_name, i_type );
1032
1033     switch( i_type )
1034     {
1035     case VLC_VAR_BOOL:
1036         val.b_bool = !b_isno;
1037         break;
1038
1039     case VLC_VAR_INTEGER:
1040         val.i_int = strtoll( psz_value, NULL, 0 );
1041         break;
1042
1043     case VLC_VAR_FLOAT:
1044         val.f_float = us_atof( psz_value );
1045         break;
1046
1047     case VLC_VAR_STRING:
1048         val.psz_string = psz_value;
1049         break;
1050
1051     default:
1052         goto cleanup;
1053     }
1054
1055     var_Set( p_obj, psz_name, val );
1056
1057 cleanup:
1058     free( psz_name );
1059 }
1060
1061 #undef var_LocationParse
1062 /**
1063  * Parses a set of colon-separated or semicolon-separated
1064  * <variable name>=<value> pairs.
1065  * Some access (or access_demux) plugins uses this scheme
1066  * in media resource location.
1067  * @note Only trusted/safe variables are allowed. This is intended.
1068  *
1069  * @warning Only use this for plugins implementing VLC-specific resource
1070  * location schemes. This would not make any sense for standardized ones.
1071  *
1072  * @param obj VLC object on which to set variables (and emit error messages)
1073  * @param mrl string to parse
1074  * @param pref prefix to prepend to option names in the string
1075  *
1076  * @return VLC_ENOMEM on error, VLC_SUCCESS on success.
1077  */
1078 int var_LocationParse (vlc_object_t *obj, const char *mrl, const char *pref)
1079 {
1080     int ret = VLC_SUCCESS;
1081     size_t preflen = strlen (pref) + 1;
1082
1083     assert(mrl != NULL);
1084     while (*mrl != '\0')
1085     {
1086         mrl += strspn (mrl, ":;"); /* skip leading colon(s) */
1087
1088         size_t len = strcspn (mrl, ":;");
1089         char *buf = malloc (preflen + len);
1090
1091         if (likely(buf != NULL))
1092         {
1093             /* NOTE: this does not support the "no-<varname>" bool syntax. */
1094             /* DO NOT use asprintf() here; it won't work! Think again. */
1095             snprintf (buf, preflen + len, "%s%s", pref, mrl);
1096             var_OptionParse (obj, buf, false);
1097             free (buf);
1098         }
1099         else
1100             ret = VLC_ENOMEM;
1101         mrl += len;
1102     }
1103
1104     return ret;
1105 }
1106
1107 /**
1108  * Waits until the variable is inactive (i.e. not executing a callback)
1109  */
1110 static void WaitUnused( vlc_object_t *p_this, variable_t *p_var )
1111 {
1112     vlc_object_internals_t *p_priv = vlc_internals( p_this );
1113
1114     mutex_cleanup_push( &p_priv->var_lock );
1115     while( p_var->b_incallback )
1116         vlc_cond_wait( &p_priv->var_wait, &p_priv->var_lock );
1117     vlc_cleanup_pop( );
1118 }
1119
1120 /*****************************************************************************
1121  * CheckValue: check that a value is valid wrt. a variable
1122  *****************************************************************************
1123  * This function checks p_val's value against p_var's limitations such as
1124  * minimal and maximal value, step, in-list position, and modifies p_val if
1125  * necessary.
1126  ****************************************************************************/
1127 static void CheckValue ( variable_t *p_var, vlc_value_t *p_val )
1128 {
1129     /* Check that our variable is in the list */
1130     if( p_var->i_type & VLC_VAR_HASCHOICE && p_var->choices.i_count )
1131     {
1132         int i;
1133
1134         /* This list is not sorted so go throug it (this is a small list) */
1135         for( i = p_var->choices.i_count ; i-- ; )
1136         {
1137             if( p_var->ops->pf_cmp( *p_val, p_var->choices.p_values[i] ) == 0 )
1138             {
1139                 break;
1140             }
1141         }
1142
1143         /* If not found, change it to anything vaguely valid */
1144         if( i < 0 )
1145         {
1146             /* Free the old variable, get the new one, dup it */
1147             p_var->ops->pf_free( p_val );
1148             *p_val = p_var->choices.p_values[p_var->i_default >= 0
1149                                           ? p_var->i_default : 0 ];
1150             p_var->ops->pf_dup( p_val );
1151         }
1152     }
1153
1154     /* Check that our variable is within the bounds */
1155     switch( p_var->i_type & VLC_VAR_TYPE )
1156     {
1157         case VLC_VAR_INTEGER:
1158             if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.i_int
1159                  && (p_val->i_int % p_var->step.i_int) )
1160             {
1161                 p_val->i_int = (p_val->i_int + (p_var->step.i_int / 2))
1162                                / p_var->step.i_int * p_var->step.i_int;
1163             }
1164             if( p_var->i_type & VLC_VAR_HASMIN
1165                  && p_val->i_int < p_var->min.i_int )
1166             {
1167                 p_val->i_int = p_var->min.i_int;
1168             }
1169             if( p_var->i_type & VLC_VAR_HASMAX
1170                  && p_val->i_int > p_var->max.i_int )
1171             {
1172                 p_val->i_int = p_var->max.i_int;
1173             }
1174             break;
1175         case VLC_VAR_FLOAT:
1176             if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.f_float )
1177             {
1178                 float f_round = p_var->step.f_float * (float)(int)( 0.5 +
1179                                         p_val->f_float / p_var->step.f_float );
1180                 if( p_val->f_float != f_round )
1181                 {
1182                     p_val->f_float = f_round;
1183                 }
1184             }
1185             if( p_var->i_type & VLC_VAR_HASMIN
1186                  && p_val->f_float < p_var->min.f_float )
1187             {
1188                 p_val->f_float = p_var->min.f_float;
1189             }
1190             if( p_var->i_type & VLC_VAR_HASMAX
1191                  && p_val->f_float > p_var->max.f_float )
1192             {
1193                 p_val->f_float = p_var->max.f_float;
1194             }
1195             break;
1196         case VLC_VAR_TIME:
1197             /* FIXME: TODO */
1198             break;
1199     }
1200 }
1201
1202 /**
1203  * Finds the value of a variable. If the specified object does not hold a
1204  * variable with the specified name, try the parent object, and iterate until
1205  * the top of the tree. If no match is found, the value is read from the
1206  * configuration.
1207  */
1208 int var_Inherit( vlc_object_t *p_this, const char *psz_name, int i_type,
1209                  vlc_value_t *p_val )
1210 {
1211     i_type &= VLC_VAR_CLASS;
1212     for( vlc_object_t *obj = p_this; obj != NULL; obj = obj->p_parent )
1213     {
1214         if( var_GetChecked( obj, psz_name, i_type, p_val ) == VLC_SUCCESS )
1215             return VLC_SUCCESS;
1216     }
1217
1218     /* else take value from config */
1219     switch( i_type & VLC_VAR_CLASS )
1220     {
1221         case VLC_VAR_STRING:
1222             p_val->psz_string = config_GetPsz( p_this, psz_name );
1223             if( !p_val->psz_string ) p_val->psz_string = strdup("");
1224             break;
1225         case VLC_VAR_FLOAT:
1226             p_val->f_float = config_GetFloat( p_this, psz_name );
1227             break;
1228         case VLC_VAR_INTEGER:
1229             p_val->i_int = config_GetInt( p_this, psz_name );
1230             break;
1231         case VLC_VAR_BOOL:
1232             p_val->b_bool = config_GetInt( p_this, psz_name );
1233             break;
1234         default:
1235             assert(0);
1236         case VLC_VAR_ADDRESS:
1237             return VLC_ENOOBJ;
1238     }
1239     return VLC_SUCCESS;
1240 }
1241
1242
1243 /**
1244  * It inherits a string as an unsigned rational number (it also accepts basic
1245  * float number).
1246  *
1247  * It returns an error if the rational number cannot be parsed (0/0 is valid).
1248  * The rational is already reduced.
1249  */
1250 int (var_InheritURational)(vlc_object_t *object,
1251                            unsigned *num, unsigned *den,
1252                            const char *var)
1253 {
1254     /* */
1255     *num = 0;
1256     *den = 0;
1257
1258     /* */
1259     char *tmp = var_InheritString(object, var);
1260     if (!tmp)
1261         goto error;
1262
1263     char *next;
1264     unsigned n = strtol(tmp,  &next, 0);
1265     unsigned d = strtol(*next ? &next[1] : "0", NULL, 0);
1266
1267     if (*next == '.') {
1268         /* Interpret as a float number */
1269         double r = us_atof(tmp);
1270         double c = ceil(r);
1271         if (c >= UINT_MAX)
1272             goto error;
1273         unsigned m = c;
1274         if (m > 0) {
1275             d = UINT_MAX / m;
1276             n = r * d;
1277         } else {
1278             n = 0;
1279             d = 0;
1280         }
1281     }
1282
1283     if (n > 0 && d > 0)
1284         vlc_ureduce(num, den, n, d, 0);
1285
1286     free(tmp);
1287     return VLC_SUCCESS;
1288
1289 error:
1290     free(tmp);
1291     return VLC_EGENERIC;
1292 }
1293
1294 /**********************************************************************
1295  * Trigger the callbacks.
1296  * Tell we're in a callback, release the lock, call stored functions,
1297  * retake the lock.
1298  **********************************************************************/
1299 static int TriggerCallback( vlc_object_t *p_this, variable_t *p_var,
1300                             const char *psz_name, vlc_value_t oldval )
1301 {
1302     assert( p_this );
1303
1304     int i_entries = p_var->i_entries;
1305     if( i_entries == 0 )
1306         return VLC_SUCCESS;
1307
1308     callback_entry_t *p_entries = p_var->p_entries;
1309     vlc_object_internals_t *p_priv = vlc_internals( p_this );
1310
1311     assert( !p_var->b_incallback );
1312     p_var->b_incallback = true;
1313     vlc_mutex_unlock( &p_priv->var_lock );
1314
1315     /* The real calls */
1316     for( ; i_entries-- ; )
1317     {
1318         p_entries[i_entries].pf_callback( p_this, psz_name, oldval, p_var->val,
1319                                           p_entries[i_entries].p_data );
1320     }
1321
1322     vlc_mutex_lock( &p_priv->var_lock );
1323     p_var->b_incallback = false;
1324     vlc_cond_broadcast( &p_priv->var_wait );
1325
1326     return VLC_SUCCESS;
1327 }
1328
1329 /**
1330  * Free a list and the associated strings
1331  * @param p_val: the list variable
1332  * @param p_val2: the variable associated or NULL
1333  */
1334 void var_FreeList( vlc_value_t *p_val, vlc_value_t *p_val2 )
1335 {
1336     FreeList( p_val );
1337     if( p_val2 && p_val2->p_list )
1338     {
1339         for( int i = 0; i < p_val2->p_list->i_count; i++ )
1340             free( p_val2->p_list->p_values[i].psz_string );
1341         if( p_val2->p_list->i_count )
1342         {
1343             free( p_val2->p_list->p_values );
1344             free( p_val2->p_list->pi_types );
1345         }
1346         free( p_val2->p_list );
1347     }
1348 }