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