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 #if !defined( __LIBVLC__ )
  26   #error You are not libvlc or one of its plugins. You cannot include this file
  27 #endif
  28
  29 /**
  30  * \defgroup variables Variables
  31  *
  32  * Functions for using the object variables in vlc.
  33  *
  34  * Vlc have a very powerful "object variable" infrastructure useful
  35  * for many things.
  36  *
  37  * @{
  38  */
  39
  40 /*****************************************************************************
  41  * Variable types - probably very incomplete
  42  *****************************************************************************/
  43 #define VLC_VAR_TYPE      0x00ff
  44 #define VLC_VAR_FLAGS     0xff00
  45
  46 /** \defgroup var_flags Additive flags
  47  * These flags are added to the type field of the variable. Most as a result of
  48  * a __var_Change() call, but some may be added at creation time
  49  * @{
  50  */
  51 #define VLC_VAR_HASCHOICE 0x0100
  52 #define VLC_VAR_HASMIN    0x0200
  53 #define VLC_VAR_HASMAX    0x0400
  54 #define VLC_VAR_HASSTEP   0x0800
  55
  56 #define VLC_VAR_ISLIST    0x1000
  57 #define VLC_VAR_ISCOMMAND 0x2000
  58
  59 /** Creation flag */
  60 #define VLC_VAR_DOINHERIT 0x8000
  61 /**@}*/
  62
  63 /**
  64  * \defgroup var_action Variable actions
  65  * These are the different actions that can be used with __var_Change().
  66  * The parameters given are the meaning of the two last parameters of
  67  * __var_Change() when this action is being used.
  68  * @{
  69  */
  70
  71 /**
  72  * Set the minimum value of this variable
  73  * \param p_val The new minimum value
  74  * \param p_val2 Unused
  75  */
  76 #define VLC_VAR_SETMIN              0x0010
  77 /**
  78  * Set the maximum value of this variable
  79  * \param p_val The new maximum value
  80  * \param p_val2 Unused
  81  */
  82 #define VLC_VAR_SETMAX              0x0011
  83 #define VLC_VAR_SETSTEP             0x0012
  84
  85 /**
  86  * Set the value of this variable without triggering any callbacks
  87  * \param p_val The new value
  88  * \param p_val2 Unused
  89  */
  90 #define VLC_VAR_SETVALUE            0x0013
  91
  92 #define VLC_VAR_SETTEXT             0x0014
  93 #define VLC_VAR_GETTEXT             0x0015
  94
  95 #define VLC_VAR_ADDCHOICE           0x0020
  96 #define VLC_VAR_DELCHOICE           0x0021
  97 #define VLC_VAR_CLEARCHOICES        0x0022
  98 #define VLC_VAR_SETDEFAULT          0x0023
  99 #define VLC_VAR_GETCHOICES          0x0024
 100 #define VLC_VAR_FREECHOICES         0x0025
 101 #define VLC_VAR_GETLIST             0x0026
 102 #define VLC_VAR_FREELIST            0x0027
 103 #define VLC_VAR_CHOICESCOUNT        0x0028
 104
 105 #define VLC_VAR_INHERITVALUE        0x0030
 106 #define VLC_VAR_TRIGGER_CALLBACKS   0x0035
 107 /**@}*/
 108
 109 /*****************************************************************************
 110  * Prototypes
 111  *****************************************************************************/
 112 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
 113 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
 114
 115 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
 116
 117 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) );
 118 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
 119 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
 120
 121 #define var_OptionParse(a,b) __var_OptionParse( VLC_OBJECT( a ) , b )
 122 VLC_EXPORT( void, __var_OptionParse, ( vlc_object_t *, const char * ) );
 123
 124 /**
 125  * __var_Create() with automatic casting.
 126  */
 127 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
 128 /**
 129  * __var_Destroy() with automatic casting
 130  */
 131 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
 132
 133 /**
 134  * __var_Change() with automatic casting
 135  */
 136 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
 137
 138 /**
 139  * __var_Type() with automatic casting
 140  */
 141 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
 142 /**
 143  * __var_Set() with automatic casting
 144  */
 145 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
 146 /**
 147  * __var_Get() with automatic casting
 148  */
 149 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
 150
 151 /*****************************************************************************
 152  * Variable callbacks
 153  *****************************************************************************
 154  * int MyCallback( vlc_object_t *p_this,
 155  *                 char const *psz_variable,
 156  *                 vlc_value_t oldvalue,
 157  *                 vlc_value_t newvalue,
 158  *                 void *p_data);
 159  *****************************************************************************/
 160 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
 161 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
 162
 163 /**
 164  * __var_AddCallback() with automatic casting
 165  */
 166 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
 167
 168 /**
 169  * __var_DelCallback() with automatic casting
 170  */
 171 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
 172
 173 /*****************************************************************************
 174  * helpers functions
 175  *****************************************************************************/
 176
 177 /**
 178  * Set the value of an integer variable
 179  *
 180  * \param p_obj The object that holds the variable
 181  * \param psz_name The name of the variable
 182  * \param i The new integer value of this variable
 183  */
 184 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
 185 {
 186     vlc_value_t val;
 187     val.i_int = i;
 188     return __var_Set( p_obj, psz_name, val );
 189 }
 190 #define var_SetInteger(a,b,c)   __var_SetInteger( VLC_OBJECT(a),b,c)
 191 /**
 192  * Set the value of an boolean variable
 193  *
 194  * \param p_obj The object that holds the variable
 195  * \param psz_name The name of the variable
 196  * \param b The new boolean value of this variable
 197  */
 198 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, vlc_bool_t b )
 199 {
 200     vlc_value_t val;
 201     val.b_bool = b;
 202     return __var_Set( p_obj, psz_name, val );
 203 }
 204
 205 /**
 206  * Set the value of a time variable
 207  *
 208  * \param p_obj The object that holds the variable
 209  * \param psz_name The name of the variable
 210  * \param i The new time value of this variable
 211  */
 212 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
 213 {
 214     vlc_value_t val;
 215     val.i_time = i;
 216     return __var_Set( p_obj, psz_name, val );
 217 }
 218
 219 /**
 220  * Set the value of a float variable
 221  *
 222  * \param p_obj The object that holds the variable
 223  * \param psz_name The name of the variable
 224  * \param f The new float value of this variable
 225  */
 226 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
 227 {
 228     vlc_value_t val;
 229     val.f_float = f;
 230     return __var_Set( p_obj, psz_name, val );
 231 }
 232
 233 /**
 234  * Set the value of a string variable
 235  *
 236  * \param p_obj The object that holds the variable
 237  * \param psz_name The name of the variable
 238  * \param psz_string The new string value of this variable
 239  */
 240 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
 241 {
 242     vlc_value_t val;
 243     val.psz_string = (char *)psz_string;
 244     return __var_Set( p_obj, psz_name, val );
 245 }
 246
 247 /**
 248  * Trigger the callbacks on a void variable
 249  *
 250  * \param p_obj The object that holds the variable
 251  * \param psz_name The name of the variable
 252  */
 253 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
 254 {
 255     vlc_value_t val;
 256     val.b_bool = VLC_TRUE;
 257     return __var_Set( p_obj, psz_name, val );
 258 }
 259 #define var_SetVoid(a,b)        __var_SetVoid( VLC_OBJECT(a),b)
 260
 261 /**
 262  * __var_SetBool() with automatic casting
 263  */
 264 #define var_SetBool(a,b,c)   __var_SetBool( VLC_OBJECT(a),b,c)
 265
 266 /**
 267  * __var_SetTime() with automatic casting
 268  */
 269 #define var_SetTime(a,b,c)      __var_SetTime( VLC_OBJECT(a),b,c)
 270 /**
 271  * __var_SetFloat() with automatic casting
 272  */
 273 #define var_SetFloat(a,b,c)     __var_SetFloat( VLC_OBJECT(a),b,c)
 274 /**
 275  * __var_SetString() with automatic casting
 276  */
 277 #define var_SetString(a,b,c)     __var_SetString( VLC_OBJECT(a),b,c)
 278
 279 /**
 280  * Get an integer value
 281 *
 282  * \param p_obj The object that holds the variable
 283  * \param psz_name The name of the variable
 284  */
 285 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
 286 {
 287     vlc_value_t val;val.i_int = 0;
 288     if( !__var_Get( p_obj, psz_name, &val ) )
 289         return val.i_int;
 290     else
 291         return 0;
 292 }
 293
 294 /**
 295  * Get a boolean value
 296  *
 297  * \param p_obj The object that holds the variable
 298  * \param psz_name The name of the variable
 299  */
 300 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
 301 {
 302     vlc_value_t val; val.b_bool = VLC_FALSE;
 303     if( !__var_Get( p_obj, psz_name, &val ) )
 304         return val.b_bool;
 305     else
 306         return VLC_FALSE;
 307 }
 308
 309 /**
 310  * Get a time value
 311  *
 312  * \param p_obj The object that holds the variable
 313  * \param psz_name The name of the variable
 314  */
 315 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
 316 {
 317     vlc_value_t val; val.i_time = 0L;
 318     if( !__var_Get( p_obj, psz_name, &val ) )
 319         return val.i_time;
 320     else
 321         return 0;
 322 }
 323
 324 /**
 325  * Get a float value
 326  *
 327  * \param p_obj The object that holds the variable
 328  * \param psz_name The name of the variable
 329  */
 330 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
 331 {
 332     vlc_value_t val; val.f_float = 0.0;
 333     if( !__var_Get( p_obj, psz_name, &val ) )
 334         return val.f_float;
 335     else
 336         return 0.0;
 337 }
 338
 339 /**
 340  * Get a string value
 341  *
 342  * \param p_obj The object that holds the variable
 343  * \param psz_name The name of the variable
 344  */
 345 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
 346 {
 347     vlc_value_t val; val.psz_string = NULL;
 348     if( !__var_Get( p_obj, psz_name, &val ) )
 349         return val.psz_string;
 350     else
 351         return strdup( "" );
 352 }
 353
 354 /**
 355  * __var_GetInteger() with automatic casting
 356  */
 357 #define var_GetInteger(a,b)   __var_GetInteger( VLC_OBJECT(a),b)
 358 /**
 359  * __var_GetBool() with automatic casting
 360  */
 361 #define var_GetBool(a,b)   __var_GetBool( VLC_OBJECT(a),b)
 362 /**
 363  * __var_GetTime() with automatic casting
 364  */
 365 #define var_GetTime(a,b)   __var_GetTime( VLC_OBJECT(a),b)
 366 /**
 367  * __var_GetFloat() with automatic casting
 368  */
 369 #define var_GetFloat(a,b)   __var_GetFloat( VLC_OBJECT(a),b)
 370 /**
 371  * __var_GetString() with automatic casting
 372  */
 373 #define var_GetString(a,b)   __var_GetString( VLC_OBJECT(a),b)
 374
 375
 376
 377 /**
 378  * Increment an integer variable
 379  * \param p_obj the object that holds the variable
 380  * \param psz_name the name of the variable
 381  */
 382 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
 383 {
 384     int i_val = __var_GetInteger( p_obj, psz_name );
 385     __var_SetInteger( p_obj, psz_name, ++i_val );
 386 }
 387 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
 388
 389 /**
 390  * Decrement an integer variable
 391  * \param p_obj the object that holds the variable
 392  * \param psz_name the name of the variable
 393  */
 394 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
 395 {
 396     int i_val = __var_GetInteger( p_obj, psz_name );
 397     __var_SetInteger( p_obj, psz_name, --i_val );
 398 }
 399 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
 400
 401 /**
 402  * Create a integer variable with inherit and get its value.
 403  *
 404  * \param p_obj The object that holds the variable
 405  * \param psz_name The name of the variable
 406  */
 407 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
 408 {
 409     vlc_value_t val;
 410
 411     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 412     if( !__var_Get( p_obj, psz_name, &val ) )
 413         return val.i_int;
 414     else
 415         return 0;
 416 }
 417
 418 /**
 419  * Create a boolean variable with inherit and get its value.
 420  *
 421  * \param p_obj The object that holds the variable
 422  * \param psz_name The name of the variable
 423  */
 424 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
 425 {
 426     vlc_value_t val;
 427
 428     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 429     if( !__var_Get( p_obj, psz_name, &val ) )
 430         return val.b_bool;
 431     else
 432         return VLC_FALSE;
 433 }
 434
 435 /**
 436  * Create a time variable with inherit and get its value.
 437  *
 438  * \param p_obj The object that holds the variable
 439  * \param psz_name The name of the variable
 440  */
 441 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
 442 {
 443     vlc_value_t val;
 444
 445     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
 446     if( !__var_Get( p_obj, psz_name, &val ) )
 447         return val.i_time;
 448     else
 449         return 0;
 450 }
 451
 452 /**
 453  * Create a float variable with inherit and get its value.
 454  *
 455  * \param p_obj The object that holds the variable
 456  * \param psz_name The name of the variable
 457  */
 458 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
 459 {
 460     vlc_value_t val;
 461
 462     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 463     if( !__var_Get( p_obj, psz_name, &val ) )
 464         return val.f_float;
 465     else
 466         return 0.0;
 467 }
 468
 469 /**
 470  * Create a string variable with inherit and get its value.
 471  *
 472  * \param p_obj The object that holds the variable
 473  * \param psz_name The name of the variable
 474  */
 475 static inline char *__var_CreateGetString( vlc_object_t *p_obj, const char *psz_name )
 476 {
 477     vlc_value_t val;
 478
 479     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 480     if( !__var_Get( p_obj, psz_name, &val ) )
 481         return val.psz_string;
 482     else
 483         return strdup( "" );
 484 }
 485
 486 /**
 487  * __var_CreateGetInteger() with automatic casting
 488  */
 489 #define var_CreateGetInteger(a,b)   __var_CreateGetInteger( VLC_OBJECT(a),b)
 490 /**
 491  * __var_CreateGetBool() with automatic casting
 492  */
 493 #define var_CreateGetBool(a,b)   __var_CreateGetBool( VLC_OBJECT(a),b)
 494 /**
 495  * __var_CreateGetTime() with automatic casting
 496  */
 497 #define var_CreateGetTime(a,b)   __var_CreateGetTime( VLC_OBJECT(a),b)
 498 /**
 499  * __var_CreateGetFloat() with automatic casting
 500  */
 501 #define var_CreateGetFloat(a,b)   __var_CreateGetFloat( VLC_OBJECT(a),b)
 502 /**
 503  * __var_CreateGetString() with automatic casting
 504  */
 505 #define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
 506
 507 /**
 508  * @}
 509  */
 510