git.sesse.net Git - vlc/blob - include/variables.h

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