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