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