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 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
 168
 169 /**
 170  * __var_AddCallback() with automatic casting
 171  */
 172 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
 173
 174 /**
 175  * __var_DelCallback() with automatic casting
 176  */
 177 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
 178
 179 /**
 180  * __var_TriggerCallback() with automatic casting
 181  */
 182 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
 183
 184 /*****************************************************************************
 185  * helpers functions
 186  *****************************************************************************/
 187
 188 /**
 189  * Set the value of an integer variable
 190  *
 191  * \param p_obj The object that holds the variable
 192  * \param psz_name The name of the variable
 193  * \param i The new integer value of this variable
 194  */
 195 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
 196 {
 197     vlc_value_t val;
 198     val.i_int = i;
 199     return __var_Set( p_obj, psz_name, val );
 200 }
 201 #define var_SetInteger(a,b,c)   __var_SetInteger( VLC_OBJECT(a),b,c)
 202 /**
 203  * Set the value of an boolean variable
 204  *
 205  * \param p_obj The object that holds the variable
 206  * \param psz_name The name of the variable
 207  * \param b The new boolean value of this variable
 208  */
 209 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, vlc_bool_t b )
 210 {
 211     vlc_value_t val;
 212     val.b_bool = b;
 213     return __var_Set( p_obj, psz_name, val );
 214 }
 215
 216 /**
 217  * Set the value of a time variable
 218  *
 219  * \param p_obj The object that holds the variable
 220  * \param psz_name The name of the variable
 221  * \param i The new time value of this variable
 222  */
 223 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
 224 {
 225     vlc_value_t val;
 226     val.i_time = i;
 227     return __var_Set( p_obj, psz_name, val );
 228 }
 229
 230 /**
 231  * Set the value of a float variable
 232  *
 233  * \param p_obj The object that holds the variable
 234  * \param psz_name The name of the variable
 235  * \param f The new float value of this variable
 236  */
 237 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
 238 {
 239     vlc_value_t val;
 240     val.f_float = f;
 241     return __var_Set( p_obj, psz_name, val );
 242 }
 243
 244 /**
 245  * Set the value of a string variable
 246  *
 247  * \param p_obj The object that holds the variable
 248  * \param psz_name The name of the variable
 249  * \param psz_string The new string value of this variable
 250  */
 251 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
 252 {
 253     vlc_value_t val;
 254     val.psz_string = (char *)psz_string;
 255     return __var_Set( p_obj, psz_name, val );
 256 }
 257
 258 /**
 259  * Trigger the callbacks on a void variable
 260  *
 261  * \param p_obj The object that holds the variable
 262  * \param psz_name The name of the variable
 263  */
 264 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
 265 {
 266     vlc_value_t val;
 267     val.b_bool = VLC_TRUE;
 268     return __var_Set( p_obj, psz_name, val );
 269 }
 270 #define var_SetVoid(a,b)        __var_SetVoid( VLC_OBJECT(a),b)
 271
 272 /**
 273  * __var_SetBool() with automatic casting
 274  */
 275 #define var_SetBool(a,b,c)   __var_SetBool( VLC_OBJECT(a),b,c)
 276
 277 /**
 278  * __var_SetTime() with automatic casting
 279  */
 280 #define var_SetTime(a,b,c)      __var_SetTime( VLC_OBJECT(a),b,c)
 281 /**
 282  * __var_SetFloat() with automatic casting
 283  */
 284 #define var_SetFloat(a,b,c)     __var_SetFloat( VLC_OBJECT(a),b,c)
 285 /**
 286  * __var_SetString() with automatic casting
 287  */
 288 #define var_SetString(a,b,c)     __var_SetString( VLC_OBJECT(a),b,c)
 289
 290 /**
 291  * Get an integer value
 292 *
 293  * \param p_obj The object that holds the variable
 294  * \param psz_name The name of the variable
 295  */
 296 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
 297 {
 298     vlc_value_t val;val.i_int = 0;
 299     if( !__var_Get( p_obj, psz_name, &val ) )
 300         return val.i_int;
 301     else
 302         return 0;
 303 }
 304
 305 /**
 306  * Get a boolean value
 307  *
 308  * \param p_obj The object that holds the variable
 309  * \param psz_name The name of the variable
 310  */
 311 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
 312 {
 313     vlc_value_t val; val.b_bool = VLC_FALSE;
 314     if( !__var_Get( p_obj, psz_name, &val ) )
 315         return val.b_bool;
 316     else
 317         return VLC_FALSE;
 318 }
 319
 320 /**
 321  * Get a time value
 322  *
 323  * \param p_obj The object that holds the variable
 324  * \param psz_name The name of the variable
 325  */
 326 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
 327 {
 328     vlc_value_t val; val.i_time = 0L;
 329     if( !__var_Get( p_obj, psz_name, &val ) )
 330         return val.i_time;
 331     else
 332         return 0;
 333 }
 334
 335 /**
 336  * Get a float value
 337  *
 338  * \param p_obj The object that holds the variable
 339  * \param psz_name The name of the variable
 340  */
 341 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
 342 {
 343     vlc_value_t val; val.f_float = 0.0;
 344     if( !__var_Get( p_obj, psz_name, &val ) )
 345         return val.f_float;
 346     else
 347         return 0.0;
 348 }
 349
 350 /**
 351  * Get a string value
 352  *
 353  * \param p_obj The object that holds the variable
 354  * \param psz_name The name of the variable
 355  */
 356 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
 357 {
 358     vlc_value_t val; val.psz_string = NULL;
 359     if( !__var_Get( p_obj, psz_name, &val ) )
 360         return val.psz_string;
 361     else
 362         return strdup( "" );
 363 }
 364
 365 static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
 366 {
 367     vlc_value_t val;
 368     if( __var_Get( obj, name, &val ) )
 369         return NULL;
 370     if( *val.psz_string )
 371         return val.psz_string;
 372     free( val.psz_string );
 373     return NULL;
 374 }
 375
 376
 377 /**
 378  * __var_GetInteger() with automatic casting
 379  */
 380 #define var_GetInteger(a,b)   __var_GetInteger( VLC_OBJECT(a),b)
 381 /**
 382  * __var_GetBool() with automatic casting
 383  */
 384 #define var_GetBool(a,b)   __var_GetBool( VLC_OBJECT(a),b)
 385 /**
 386  * __var_GetTime() with automatic casting
 387  */
 388 #define var_GetTime(a,b)   __var_GetTime( VLC_OBJECT(a),b)
 389 /**
 390  * __var_GetFloat() with automatic casting
 391  */
 392 #define var_GetFloat(a,b)   __var_GetFloat( VLC_OBJECT(a),b)
 393 /**
 394  * __var_GetString() with automatic casting
 395  */
 396 #define var_GetString(a,b)   __var_GetString( VLC_OBJECT(a),b)
 397 #define var_GetNonEmptyString(a,b)   __var_GetNonEmptyString( VLC_OBJECT(a),b)
 398
 399
 400
 401 /**
 402  * Increment 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_IncInteger( 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_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
 412
 413 /**
 414  * Decrement an integer variable
 415  * \param p_obj the object that holds the variable
 416  * \param psz_name the name of the variable
 417  */
 418 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
 419 {
 420     int i_val = __var_GetInteger( p_obj, psz_name );
 421     __var_SetInteger( p_obj, psz_name, --i_val );
 422 }
 423 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
 424
 425 /**
 426  * Create a integer variable with inherit and get its value.
 427  *
 428  * \param p_obj The object that holds the variable
 429  * \param psz_name The name of the variable
 430  */
 431 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
 432 {
 433     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 434     return __var_GetInteger( p_obj, psz_name );
 435 }
 436
 437 /**
 438  * Create a boolean variable with inherit and get its value.
 439  *
 440  * \param p_obj The object that holds the variable
 441  * \param psz_name The name of the variable
 442  */
 443 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
 444 {
 445     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 446     return __var_GetBool( p_obj, psz_name );
 447 }
 448
 449 /**
 450  * Create a time variable with inherit and get its value.
 451  *
 452  * \param p_obj The object that holds the variable
 453  * \param psz_name The name of the variable
 454  */
 455 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
 456 {
 457     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
 458     return __var_GetTime( p_obj, psz_name );
 459 }
 460
 461 /**
 462  * Create a float variable with inherit and get its value.
 463  *
 464  * \param p_obj The object that holds the variable
 465  * \param psz_name The name of the variable
 466  */
 467 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
 468 {
 469     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 470     return __var_GetFloat( p_obj, psz_name );
 471 }
 472
 473 /**
 474  * Create a string variable with inherit and get its value.
 475  *
 476  * \param p_obj The object that holds the variable
 477  * \param psz_name The name of the variable
 478  */
 479 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
 480                                            const char *psz_name )
 481 {
 482     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 483     return __var_GetString( p_obj, psz_name );
 484 }
 485
 486 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
 487                                                    const char *psz_name )
 488 {
 489     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 490     return __var_GetNonEmptyString( p_obj, psz_name );
 491 }
 492
 493 /**
 494  * __var_CreateGetInteger() with automatic casting
 495  */
 496 #define var_CreateGetInteger(a,b)   __var_CreateGetInteger( VLC_OBJECT(a),b)
 497 /**
 498  * __var_CreateGetBool() with automatic casting
 499  */
 500 #define var_CreateGetBool(a,b)   __var_CreateGetBool( VLC_OBJECT(a),b)
 501 /**
 502  * __var_CreateGetTime() with automatic casting
 503  */
 504 #define var_CreateGetTime(a,b)   __var_CreateGetTime( VLC_OBJECT(a),b)
 505 /**
 506  * __var_CreateGetFloat() with automatic casting
 507  */
 508 #define var_CreateGetFloat(a,b)   __var_CreateGetFloat( VLC_OBJECT(a),b)
 509 /**
 510  * __var_CreateGetString() with automatic casting
 511  */
 512 #define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
 513 #define var_CreateGetNonEmptyString(a,b)   __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
 514
 515 /**
 516  * Create a integer command variable with inherit and get its value.
 517  *
 518  * \param p_obj The object that holds the variable
 519  * \param psz_name The name of the variable
 520  */
 521 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
 522 {
 523     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
 524                                    | VLC_VAR_ISCOMMAND );
 525     return __var_GetInteger( p_obj, psz_name );
 526 }
 527
 528 /**
 529  * Create a boolean command variable with inherit and get its value.
 530  *
 531  * \param p_obj The object that holds the variable
 532  * \param psz_name The name of the variable
 533  */
 534 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
 535 {
 536     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
 537                                    | VLC_VAR_ISCOMMAND );
 538     return __var_GetBool( p_obj, psz_name );
 539 }
 540
 541 /**
 542  * Create a time command variable with inherit and get its value.
 543  *
 544  * \param p_obj The object that holds the variable
 545  * \param psz_name The name of the variable
 546  */
 547 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
 548 {
 549     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
 550                                    | VLC_VAR_ISCOMMAND );
 551     return __var_GetTime( p_obj, psz_name );
 552 }
 553
 554 /**
 555  * Create a float command variable with inherit and get its value.
 556  *
 557  * \param p_obj The object that holds the variable
 558  * \param psz_name The name of the variable
 559  */
 560 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
 561 {
 562     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
 563                                    | VLC_VAR_ISCOMMAND );
 564     return __var_GetFloat( p_obj, psz_name );
 565 }
 566
 567 /**
 568  * Create a string command variable with inherit and get its value.
 569  *
 570  * \param p_obj The object that holds the variable
 571  * \param psz_name The name of the variable
 572  */
 573 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
 574                                            const char *psz_name )
 575 {
 576     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
 577                                    | VLC_VAR_ISCOMMAND );
 578     return __var_GetString( p_obj, psz_name );
 579 }
 580
 581 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
 582                                                    const char *psz_name )
 583 {
 584     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
 585                                    | VLC_VAR_ISCOMMAND );
 586     return __var_GetNonEmptyString( p_obj, psz_name );
 587 }
 588
 589 /**
 590  * __var_CreateGetInteger() with automatic casting
 591  */
 592 #define var_CreateGetIntegerCommand(a,b)   __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
 593 /**
 594  * __var_CreateGetBoolCommand() with automatic casting
 595  */
 596 #define var_CreateGetBoolCommand(a,b)   __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
 597 /**
 598  * __var_CreateGetTimeCommand() with automatic casting
 599  */
 600 #define var_CreateGetTimeCommand(a,b)   __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
 601 /**
 602  * __var_CreateGetFloat() with automatic casting
 603  */
 604 #define var_CreateGetFloatCommand(a,b)   __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
 605 /**
 606  * __var_CreateGetStringCommand() with automatic casting
 607  */
 608 #define var_CreateGetStringCommand(a,b)   __var_CreateGetStringCommand( VLC_OBJECT(a),b)
 609 #define var_CreateGetNonEmptyStringCommand(a,b)   __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
 610 /**
 611  * @}
 612  */
 613 #endif /*  _VLC_VARIABLES_H */