git.sesse.net Git - vlc/blob - include/vlc_variables.h

   1 /*****************************************************************************
   2  * variables.h: variables handling
   3  *****************************************************************************
   4  * Copyright (C) 2002-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *          Gildas Bazin <gbazin@netcourrier.com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef VLC_VARIABLES_H
  26 #define VLC_VARIABLES_H 1
  27
  28 /**
  29  * \file
  30  * This file defines functions and structures for dynamic variables in vlc
  31  */
  32
  33 /**
  34  * \defgroup variables Variables
  35  *
  36  * Functions for using the object variables in vlc.
  37  *
  38  * Vlc have a very powerful "object variable" infrastructure useful
  39  * for many things.
  40  *
  41  * @{
  42  */
  43
  44 /*****************************************************************************
  45  * Variable types - probably very incomplete
  46  *****************************************************************************/
  47 #define VLC_VAR_TYPE      0x00ff
  48 #define VLC_VAR_CLASS     0x00f0
  49 #define VLC_VAR_FLAGS     0xff00
  50
  51 /** \defgroup var_flags Additive flags
  52  * These flags are added to the type field of the variable. Most as a result of
  53  * a __var_Change() call, but some may be added at creation time
  54  * @{
  55  */
  56 #define VLC_VAR_HASCHOICE 0x0100
  57 #define VLC_VAR_HASMIN    0x0200
  58 #define VLC_VAR_HASMAX    0x0400
  59 #define VLC_VAR_HASSTEP   0x0800
  60
  61 #define VLC_VAR_ISCOMMAND 0x2000
  62
  63 /** Creation flag */
  64 /* If the variable is not found on the current module
  65    search all parents and finally module config until found */
  66 #define VLC_VAR_DOINHERIT 0x8000
  67 /**@}*/
  68
  69 /**
  70  * \defgroup var_action Variable actions
  71  * These are the different actions that can be used with __var_Change().
  72  * The parameters given are the meaning of the two last parameters of
  73  * __var_Change() when this action is being used.
  74  * @{
  75  */
  76
  77 /**
  78  * Set the minimum value of this variable
  79  * \param p_val The new minimum value
  80  * \param p_val2 Unused
  81  */
  82 #define VLC_VAR_SETMIN              0x0010
  83 /**
  84  * Set the maximum value of this variable
  85  * \param p_val The new maximum value
  86  * \param p_val2 Unused
  87  */
  88 #define VLC_VAR_SETMAX              0x0011
  89 #define VLC_VAR_SETSTEP             0x0012
  90
  91 /**
  92  * Set the value of this variable without triggering any callbacks
  93  * \param p_val The new value
  94  * \param p_val2 Unused
  95  */
  96 #define VLC_VAR_SETVALUE            0x0013
  97
  98 #define VLC_VAR_SETTEXT             0x0014
  99 #define VLC_VAR_GETTEXT             0x0015
 100
 101 #define VLC_VAR_GETMIN              0x0016
 102 #define VLC_VAR_GETMAX              0x0017
 103 #define VLC_VAR_GETSTEP             0x0018
 104
 105 #define VLC_VAR_ADDCHOICE           0x0020
 106 #define VLC_VAR_DELCHOICE           0x0021
 107 #define VLC_VAR_CLEARCHOICES        0x0022
 108 #define VLC_VAR_SETDEFAULT          0x0023
 109 #define VLC_VAR_GETCHOICES          0x0024
 110 #define VLC_VAR_GETLIST             0x0025
 111 #define VLC_VAR_CHOICESCOUNT        0x0026
 112
 113 #define VLC_VAR_SETISCOMMAND        0x0040
 114 /**@}*/
 115
 116 /** \defgroup var_GetAndSet Variable actions
 117  * These are the different actions that can be used with __var_GetAndSet()
 118  * @{
 119  */
 120 /**
 121  * Toggle the value of this boolean
 122  * \param val Unused
 123  */
 124 #define VLC_VAR_TOGGLE_BOOL         0x0010
 125 /**
 126  * Increment or decrement an integer of a given value
 127  * \param val the value
 128  */
 129 #define VLC_VAR_INTEGER_INCDEC      0x0020
 130 /**@}*/
 131
 132 /*****************************************************************************
 133  * Prototypes
 134  *****************************************************************************/
 135 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
 136 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
 137
 138 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
 139
 140 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
 141 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
 142 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
 143 VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) );
 144 VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
 145 VLC_EXPORT( int, __var_GetAndSet, ( vlc_object_t *, const char *, int, vlc_value_t ) );
 146
 147 #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
 148 VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
 149
 150 VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) );
 151
 152 /**
 153  * __var_Create() with automatic casting.
 154  */
 155 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
 156 /**
 157  * __var_Destroy() with automatic casting
 158  */
 159 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
 160
 161 /**
 162  * __var_Change() with automatic casting
 163  */
 164 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
 165
 166 /**
 167  * __var_Type() with automatic casting
 168  */
 169 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
 170 /**
 171  * __var_Set() with automatic casting
 172  */
 173 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
 174 /**
 175  * __var_Get() with automatic casting
 176  */
 177 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
 178 /**
 179  * __var_GetAndSet() with automatic casting
 180  */
 181 #define var_GetAndSet(a,b,c,d) __var_GetAndSet(VLC_OBJECT(a), b, c, d)
 182
 183 /*****************************************************************************
 184  * Variable callbacks
 185  *****************************************************************************
 186  * int MyCallback( vlc_object_t *p_this,
 187  *                 char const *psz_variable,
 188  *                 vlc_value_t oldvalue,
 189  *                 vlc_value_t newvalue,
 190  *                 void *p_data);
 191  *****************************************************************************/
 192 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
 193 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
 194 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
 195
 196 /**
 197  * __var_AddCallback() with automatic casting
 198  */
 199 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
 200 /**
 201  * __var_DelCallback() with automatic casting
 202  */
 203 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
 204 /**
 205  * __var_TriggerCallback() with automatic casting
 206  */
 207 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
 208
 209 /*****************************************************************************
 210  * helpers functions
 211  *****************************************************************************/
 212
 213 /**
 214  * Set the value of an integer variable
 215  *
 216  * \param p_obj The object that holds the variable
 217  * \param psz_name The name of the variable
 218  * \param i The new integer value of this variable
 219  */
 220 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
 221 {
 222     vlc_value_t val;
 223     val.i_int = i;
 224     return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
 225 }
 226
 227 /**
 228  * Set the value of an boolean variable
 229  *
 230  * \param p_obj The object that holds the variable
 231  * \param psz_name The name of the variable
 232  * \param b The new boolean value of this variable
 233  */
 234 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
 235 {
 236     vlc_value_t val;
 237     val.b_bool = b;
 238     return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
 239 }
 240
 241 /**
 242  * Set the value of a time variable
 243  *
 244  * \param p_obj The object that holds the variable
 245  * \param psz_name The name of the variable
 246  * \param i The new time value of this variable
 247  */
 248 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
 249 {
 250     vlc_value_t val;
 251     val.i_time = i;
 252     return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
 253 }
 254
 255 /**
 256  * Set the value of a float variable
 257  *
 258  * \param p_obj The object that holds the variable
 259  * \param psz_name The name of the variable
 260  * \param f The new float value of this variable
 261  */
 262 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
 263 {
 264     vlc_value_t val;
 265     val.f_float = f;
 266     return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
 267 }
 268
 269 /**
 270  * Set the value of a string variable
 271  *
 272  * \param p_obj The object that holds the variable
 273  * \param psz_name The name of the variable
 274  * \param psz_string The new string value of this variable
 275  */
 276 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
 277 {
 278     vlc_value_t val;
 279     val.psz_string = (char *)psz_string;
 280     return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
 281 }
 282
 283 /**
 284  * Set the value of a pointer variable
 285  *
 286  * \param p_obj The object that holds the variable
 287  * \param psz_name The name of the variable
 288  * \param ptr The new pointer value of this variable
 289  */
 290 static inline
 291 int __var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
 292 {
 293     vlc_value_t val;
 294     val.p_address = ptr;
 295     return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
 296 }
 297
 298 /**
 299  * __var_SetInteger() with automatic casting
 300  */
 301 #define var_SetInteger(a,b,c)   __var_SetInteger( VLC_OBJECT(a),b,c)
 302 /**
 303  * __var_SetBool() with automatic casting
 304  */
 305 #define var_SetBool(a,b,c)      __var_SetBool( VLC_OBJECT(a),b,c)
 306 /**
 307  * __var_SetTime() with automatic casting
 308  */
 309 #define var_SetTime(a,b,c)      __var_SetTime( VLC_OBJECT(a),b,c)
 310 /**
 311  * __var_SetFloat() with automatic casting
 312  */
 313 #define var_SetFloat(a,b,c)     __var_SetFloat( VLC_OBJECT(a),b,c)
 314 /**
 315  * __var_SetString() with automatic casting
 316  */
 317 #define var_SetString(a,b,c)    __var_SetString( VLC_OBJECT(a),b,c)
 318 /**
 319  * __var_SetAddress() with automatic casting
 320  */
 321 #define var_SetAddress(o, n, p) __var_SetAddress(VLC_OBJECT(o), n, p)
 322
 323
 324 /**
 325  * Get an integer value
 326 *
 327  * \param p_obj The object that holds the variable
 328  * \param psz_name The name of the variable
 329  */
 330 LIBVLC_USED
 331 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
 332 {
 333     vlc_value_t val;
 334     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
 335         return val.i_int;
 336     else
 337         return 0;
 338 }
 339
 340 /**
 341  * Get a boolean value
 342  *
 343  * \param p_obj The object that holds the variable
 344  * \param psz_name The name of the variable
 345  */
 346 LIBVLC_USED
 347 static inline bool __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
 348 {
 349     vlc_value_t val; val.b_bool = false;
 350
 351     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
 352         return val.b_bool;
 353     else
 354         return false;
 355 }
 356
 357 /**
 358  * Get a time value
 359  *
 360  * \param p_obj The object that holds the variable
 361  * \param psz_name The name of the variable
 362  */
 363 LIBVLC_USED
 364 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
 365 {
 366     vlc_value_t val; val.i_time = 0L;
 367     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
 368         return val.i_time;
 369     else
 370         return 0;
 371 }
 372
 373 /**
 374  * Get a float value
 375  *
 376  * \param p_obj The object that holds the variable
 377  * \param psz_name The name of the variable
 378  */
 379 LIBVLC_USED
 380 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
 381 {
 382     vlc_value_t val; val.f_float = 0.0;
 383     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
 384         return val.f_float;
 385     else
 386         return 0.0;
 387 }
 388
 389 /**
 390  * Get a string value
 391  *
 392  * \param p_obj The object that holds the variable
 393  * \param psz_name The name of the variable
 394  */
 395 LIBVLC_USED
 396 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
 397 {
 398     vlc_value_t val; val.psz_string = NULL;
 399     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
 400         return NULL;
 401     else
 402         return val.psz_string;
 403 }
 404
 405 LIBVLC_USED
 406 static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
 407 {
 408     vlc_value_t val;
 409     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
 410         return NULL;
 411     if( val.psz_string && *val.psz_string )
 412         return val.psz_string;
 413     free( val.psz_string );
 414     return NULL;
 415 }
 416
 417 LIBVLC_USED
 418 static inline void *__var_GetAddress( vlc_object_t *p_obj, const char *psz_name )
 419 {
 420     vlc_value_t val;
 421     if( var_GetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, &val ) )
 422         return NULL;
 423     else
 424         return val.p_address;
 425 }
 426
 427 /**
 428  * __var_GetInteger() with automatic casting
 429  */
 430 #define var_GetInteger(a,b)   __var_GetInteger( VLC_OBJECT(a),b)
 431 /**
 432  * __var_GetBool() with automatic casting
 433  */
 434 #define var_GetBool(a,b)   __var_GetBool( VLC_OBJECT(a),b)
 435 /**
 436  * __var_GetTime() with automatic casting
 437  */
 438 #define var_GetTime(a,b)   __var_GetTime( VLC_OBJECT(a),b)
 439 /**
 440  * __var_GetFloat() with automatic casting
 441  */
 442 #define var_GetFloat(a,b)   __var_GetFloat( VLC_OBJECT(a),b)
 443 /**
 444  * __var_GetString() with automatic casting
 445  */
 446 #define var_GetString(a,b)   __var_GetString( VLC_OBJECT(a),b)
 447 #define var_GetNonEmptyString(a,b)   __var_GetNonEmptyString( VLC_OBJECT(a),b)
 448 /**
 449  * __var_GetAddress() with automatic casting
 450  */
 451 #define var_GetAddress(a,b)  __var_GetAddress( VLC_OBJECT(a),b)
 452
 453
 454
 455 /**
 456  * Increment an integer variable
 457  * \param p_obj the object that holds the variable
 458  * \param psz_name the name of the variable
 459  */
 460 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
 461 {
 462     vlc_value_t val;
 463     val.i_int = 1;
 464     __var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val );
 465 }
 466 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
 467
 468 /**
 469  * Decrement an integer variable
 470  * \param p_obj the object that holds the variable
 471  * \param psz_name the name of the variable
 472  */
 473 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
 474 {
 475     vlc_value_t val;
 476     val.i_int = -1;
 477     __var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val );
 478 }
 479 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
 480
 481 /**
 482  * Create a integer variable with inherit and get its value.
 483  *
 484  * \param p_obj The object that holds the variable
 485  * \param psz_name The name of the variable
 486  */
 487 LIBVLC_USED
 488 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
 489 {
 490     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 491     return __var_GetInteger( p_obj, psz_name );
 492 }
 493
 494 /**
 495  * Create a boolean variable with inherit and get its value.
 496  *
 497  * \param p_obj The object that holds the variable
 498  * \param psz_name The name of the variable
 499  */
 500 LIBVLC_USED
 501 static inline bool __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
 502 {
 503     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 504     return __var_GetBool( p_obj, psz_name );
 505 }
 506
 507 /**
 508  * Create a time variable with inherit and get its value.
 509  *
 510  * \param p_obj The object that holds the variable
 511  * \param psz_name The name of the variable
 512  */
 513 LIBVLC_USED
 514 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
 515 {
 516     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
 517     return __var_GetTime( p_obj, psz_name );
 518 }
 519
 520 /**
 521  * Create a float variable with inherit and get its value.
 522  *
 523  * \param p_obj The object that holds the variable
 524  * \param psz_name The name of the variable
 525  */
 526 LIBVLC_USED
 527 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
 528 {
 529     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 530     return __var_GetFloat( p_obj, psz_name );
 531 }
 532
 533 /**
 534  * Create a string variable with inherit and get its value.
 535  *
 536  * \param p_obj The object that holds the variable
 537  * \param psz_name The name of the variable
 538  */
 539 LIBVLC_USED
 540 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
 541                                            const char *psz_name )
 542 {
 543     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 544     return __var_GetString( p_obj, psz_name );
 545 }
 546
 547 LIBVLC_USED
 548 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
 549                                                    const char *psz_name )
 550 {
 551     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 552     return __var_GetNonEmptyString( p_obj, psz_name );
 553 }
 554
 555 /**
 556  * Create an address variable with inherit and get its value.
 557  *
 558  * \param p_obj The object that holds the variable
 559  * \param psz_name The name of the variable
 560  */
 561 LIBVLC_USED
 562 static inline void *__var_CreateGetAddress( vlc_object_t *p_obj,
 563                                            const char *psz_name )
 564 {
 565     __var_Create( p_obj, psz_name, VLC_VAR_ADDRESS | VLC_VAR_DOINHERIT );
 566     return __var_GetAddress( p_obj, psz_name );
 567 }
 568
 569 /**
 570  * __var_CreateGetInteger() with automatic casting
 571  */
 572 #define var_CreateGetInteger(a,b)   __var_CreateGetInteger( VLC_OBJECT(a),b)
 573 /**
 574  * __var_CreateGetBool() with automatic casting
 575  */
 576 #define var_CreateGetBool(a,b)   __var_CreateGetBool( VLC_OBJECT(a),b)
 577 /**
 578  * __var_CreateGetTime() with automatic casting
 579  */
 580 #define var_CreateGetTime(a,b)   __var_CreateGetTime( VLC_OBJECT(a),b)
 581 /**
 582  * __var_CreateGetFloat() with automatic casting
 583  */
 584 #define var_CreateGetFloat(a,b)   __var_CreateGetFloat( VLC_OBJECT(a),b)
 585 /**
 586  * __var_CreateGetString() with automatic casting
 587  */
 588 #define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
 589 #define var_CreateGetNonEmptyString(a,b)   __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
 590 /**
 591  * __var_CreateGetString() with automatic casting
 592  */
 593 #define var_CreateGetAddress(a,b)  __var_CreateGetAddress( VLC_OBJECT(a),b)
 594
 595 /**
 596  * Create a integer command variable with inherit and get its value.
 597  *
 598  * \param p_obj The object that holds the variable
 599  * \param psz_name The name of the variable
 600  */
 601 LIBVLC_USED
 602 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
 603 {
 604     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
 605                                    | VLC_VAR_ISCOMMAND );
 606     return __var_GetInteger( p_obj, psz_name );
 607 }
 608
 609 /**
 610  * Create a boolean command variable with inherit and get its value.
 611  *
 612  * \param p_obj The object that holds the variable
 613  * \param psz_name The name of the variable
 614  */
 615 LIBVLC_USED
 616 static inline bool __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
 617 {
 618     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
 619                                    | VLC_VAR_ISCOMMAND );
 620     return __var_GetBool( p_obj, psz_name );
 621 }
 622
 623 /**
 624  * Create a time command variable with inherit and get its value.
 625  *
 626  * \param p_obj The object that holds the variable
 627  * \param psz_name The name of the variable
 628  */
 629 LIBVLC_USED
 630 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
 631 {
 632     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
 633                                    | VLC_VAR_ISCOMMAND );
 634     return __var_GetTime( p_obj, psz_name );
 635 }
 636
 637 /**
 638  * Create a float command variable with inherit and get its value.
 639  *
 640  * \param p_obj The object that holds the variable
 641  * \param psz_name The name of the variable
 642  */
 643 LIBVLC_USED
 644 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
 645 {
 646     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
 647                                    | VLC_VAR_ISCOMMAND );
 648     return __var_GetFloat( p_obj, psz_name );
 649 }
 650
 651 /**
 652  * Create a string command variable with inherit and get its value.
 653  *
 654  * \param p_obj The object that holds the variable
 655  * \param psz_name The name of the variable
 656  */
 657 LIBVLC_USED
 658 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
 659                                            const char *psz_name )
 660 {
 661     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
 662                                    | VLC_VAR_ISCOMMAND );
 663     return __var_GetString( p_obj, psz_name );
 664 }
 665
 666 LIBVLC_USED
 667 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
 668                                                    const char *psz_name )
 669 {
 670     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
 671                                    | VLC_VAR_ISCOMMAND );
 672     return __var_GetNonEmptyString( p_obj, psz_name );
 673 }
 674
 675 /**
 676  * __var_CreateGetInteger() with automatic casting
 677  */
 678 #define var_CreateGetIntegerCommand(a,b)   __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
 679 /**
 680  * __var_CreateGetBoolCommand() with automatic casting
 681  */
 682 #define var_CreateGetBoolCommand(a,b)   __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
 683 /**
 684  * __var_CreateGetTimeCommand() with automatic casting
 685  */
 686 #define var_CreateGetTimeCommand(a,b)   __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
 687 /**
 688  * __var_CreateGetFloat() with automatic casting
 689  */
 690 #define var_CreateGetFloatCommand(a,b)   __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
 691 /**
 692  * __var_CreateGetStringCommand() with automatic casting
 693  */
 694 #define var_CreateGetStringCommand(a,b)   __var_CreateGetStringCommand( VLC_OBJECT(a),b)
 695 #define var_CreateGetNonEmptyStringCommand(a,b)   __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
 696
 697 LIBVLC_USED
 698 static inline int __var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
 699 {
 700     vlc_value_t count;
 701     if( __var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
 702         return 0;
 703     return count.i_int;
 704 }
 705 /**
 706  * __var_CountChoices() with automatic casting
 707  */
 708 #define var_CountChoices(a,b) __var_CountChoices( VLC_OBJECT(a),b)
 709
 710
 711 static inline int __var_ToggleBool( vlc_object_t *p_obj, const char *psz_name )
 712 {
 713     vlc_value_t val;
 714     return __var_GetAndSet( p_obj, psz_name, VLC_VAR_TOGGLE_BOOL, val );
 715 }
 716 /**
 717  * __var_ToggleBool() with automatic casting
 718  */
 719 #define var_ToggleBool(a,b) __var_ToggleBool( VLC_OBJECT(a),b )
 720 /**
 721  * @}
 722  */
 723 #endif /*  _VLC_VARIABLES_H */