vlc_variables.h 21.7 KB
Newer Older
1
/*****************************************************************************
Pere Orga's avatar
Pere Orga committed
2
 * vlc_variables.h: variables handling
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2002-2004 VLC authors and VideoLAN
5
 * $Id$
6 7
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
8
 *          Gildas Bazin <gbazin@netcourrier.com>
9
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
10 11 12
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
13
 * (at your option) any later version.
14
 *
15 16
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
19
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
20 21 22
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24
 *****************************************************************************/

25 26
#ifndef VLC_VARIABLES_H
#define VLC_VARIABLES_H 1
27

28 29 30 31 32
/**
 * \file
 * This file defines functions and structures for dynamic variables in vlc
 */

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
33 34 35 36 37 38 39 40 41 42 43
/**
 * \defgroup variables Variables
 *
 * Functions for using the object variables in vlc.
 *
 * Vlc have a very powerful "object variable" infrastructure useful
 * for many things.
 *
 * @{
 */

44
#define VLC_VAR_TYPE      0x00ff
45
#define VLC_VAR_CLASS     0x00f0
46 47
#define VLC_VAR_FLAGS     0xff00

48 49 50 51 52 53 54 55 56 57 58 59 60 61
/**
 * \defgroup var_type Variable types
 * These are the different types a vlc variable can have.
 * @{
 */
#define VLC_VAR_VOID      0x0010
#define VLC_VAR_BOOL      0x0020
#define VLC_VAR_INTEGER   0x0030
#define VLC_VAR_STRING    0x0040
#define VLC_VAR_FLOAT     0x0050
#define VLC_VAR_ADDRESS   0x0070
#define VLC_VAR_COORDS    0x00A0
/**@}*/

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
62 63
/** \defgroup var_flags Additive flags
 * These flags are added to the type field of the variable. Most as a result of
64
 * a var_Change() call, but some may be added at creation time
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
65 66
 * @{
 */
67
#define VLC_VAR_HASCHOICE 0x0100
68 69 70
#define VLC_VAR_HASMIN    0x0200
#define VLC_VAR_HASMAX    0x0400
#define VLC_VAR_HASSTEP   0x0800
71

72
#define VLC_VAR_ISCOMMAND 0x2000
73

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
74
/** Creation flag */
basos G's avatar
basos G committed
75 76
/* If the variable is not found on the current module
   search all parents and finally module config until found */
77
#define VLC_VAR_DOINHERIT 0x8000
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
78
/**@}*/
79

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
80 81
/**
 * \defgroup var_action Variable actions
82
 * These are the different actions that can be used with var_Change().
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
83
 * The parameters given are the meaning of the two last parameters of
84
 * var_Change() when this action is being used.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
85 86 87 88 89 90 91 92
 * @{
 */

/**
 * Set the minimum value of this variable
 * \param p_val The new minimum value
 * \param p_val2 Unused
 */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
93
#define VLC_VAR_SETMIN              0x0010
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
94 95 96 97 98
/**
 * Set the maximum value of this variable
 * \param p_val The new maximum value
 * \param p_val2 Unused
 */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
99 100
#define VLC_VAR_SETMAX              0x0011
#define VLC_VAR_SETSTEP             0x0012
101

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
102 103 104 105 106
/**
 * Set the value of this variable without triggering any callbacks
 * \param p_val The new value
 * \param p_val2 Unused
 */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
107 108 109 110 111
#define VLC_VAR_SETVALUE            0x0013

#define VLC_VAR_SETTEXT             0x0014
#define VLC_VAR_GETTEXT             0x0015

112 113 114 115
#define VLC_VAR_GETMIN              0x0016
#define VLC_VAR_GETMAX              0x0017
#define VLC_VAR_GETSTEP             0x0018

Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
116 117 118 119 120
#define VLC_VAR_ADDCHOICE           0x0020
#define VLC_VAR_DELCHOICE           0x0021
#define VLC_VAR_CLEARCHOICES        0x0022
#define VLC_VAR_SETDEFAULT          0x0023
#define VLC_VAR_GETCHOICES          0x0024
121

Rémi Duraffort's avatar
Rémi Duraffort committed
122
#define VLC_VAR_CHOICESCOUNT        0x0026
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
123

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
124
/**@}*/
125

126
/** \defgroup var_GetAndSet Variable actions
127
 * These are the different actions that can be used with var_GetAndSet()
128 129
 * @{
 */
130 131 132 133 134 135
enum {
    VLC_VAR_BOOL_TOGGLE, /**< Invert a boolean value (param ignored) */
    VLC_VAR_INTEGER_ADD, /**< Add parameter to an integer value */
    VLC_VAR_INTEGER_OR,  /**< Binary OR over an integer bits field */
    VLC_VAR_INTEGER_NAND,/**< Binary NAND over an integer bits field */
};
136 137
/**@}*/

138 139 140
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
141
VLC_API int var_Create( vlc_object_t *, const char *, int );
142
#define var_Create(a,b,c) var_Create( VLC_OBJECT(a), b, c )
143

144
VLC_API int var_Destroy( vlc_object_t *, const char * );
145 146
#define var_Destroy(a,b) var_Destroy( VLC_OBJECT(a), b )

147
VLC_API int var_Change( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * );
148 149
#define var_Change(a,b,c,d,e) var_Change( VLC_OBJECT(a), b, c, d, e )

150
VLC_API int var_Type( vlc_object_t *, const char * ) VLC_USED;
151 152
#define var_Type(a,b) var_Type( VLC_OBJECT(a), b )

153
VLC_API int var_Set( vlc_object_t *, const char *, vlc_value_t );
154 155
#define var_Set(a,b,c) var_Set( VLC_OBJECT(a), b, c )

156
VLC_API int var_Get( vlc_object_t *, const char *, vlc_value_t * );
157
#define var_Get(a,b,c) var_Get( VLC_OBJECT(a), b, c )
158

159
VLC_API int var_SetChecked( vlc_object_t *, const char *, int, vlc_value_t );
160
#define var_SetChecked(o,n,t,v) var_SetChecked(VLC_OBJECT(o),n,t,v)
161
VLC_API int var_GetChecked( vlc_object_t *, const char *, int, vlc_value_t * );
162
#define var_GetChecked(o,n,t,v) var_GetChecked(VLC_OBJECT(o),n,t,v)
163
VLC_API int var_GetAndSet( vlc_object_t *, const char *, int, vlc_value_t * );
164

165
VLC_API int var_Inherit( vlc_object_t *, const char *, int, vlc_value_t * );
166

167
VLC_API void var_FreeList( vlc_value_t *, vlc_value_t * );
168

169

170 171 172 173 174 175 176 177 178
/*****************************************************************************
 * Variable callbacks
 *****************************************************************************
 * int MyCallback( vlc_object_t *p_this,
 *                 char const *psz_variable,
 *                 vlc_value_t oldvalue,
 *                 vlc_value_t newvalue,
 *                 void *p_data);
 *****************************************************************************/
179 180 181
VLC_API int var_AddCallback( vlc_object_t *, const char *, vlc_callback_t, void * );
VLC_API int var_DelCallback( vlc_object_t *, const char *, vlc_callback_t, void * );
VLC_API int var_TriggerCallback( vlc_object_t *, const char * );
182

183 184 185
VLC_API int var_AddListCallback( vlc_object_t *, const char *, vlc_list_callback_t, void * );
VLC_API int var_DelListCallback( vlc_object_t *, const char *, vlc_list_callback_t, void * );

186 187 188
#define var_AddCallback(a,b,c,d) var_AddCallback( VLC_OBJECT(a), b, c, d )
#define var_DelCallback(a,b,c,d) var_DelCallback( VLC_OBJECT(a), b, c, d )
#define var_TriggerCallback(a,b) var_TriggerCallback( VLC_OBJECT(a), b )
189

190 191 192
#define var_AddListCallback(a,b,c,d) var_AddListCallback( VLC_OBJECT(a), b, c, d )
#define var_DelListCallback(a,b,c,d) var_DelListCallback( VLC_OBJECT(a), b, c, d )

193 194 195
/*****************************************************************************
 * helpers functions
 *****************************************************************************/
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
196 197 198 199 200 201 202 203

/**
 * Set the value of an integer variable
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 * \param i The new integer value of this variable
 */
204 205
static inline int var_SetInteger( vlc_object_t *p_obj, const char *psz_name,
                                  int64_t i )
206 207 208
{
    vlc_value_t val;
    val.i_int = i;
209
    return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
210
}
Rémi Duraffort's avatar
Rémi Duraffort committed
211

212 213 214 215 216
/**
 * Set the value of an boolean variable
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
217
 * \param b The new boolean value of this variable
218
 */
219
static inline int var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
220 221 222
{
    vlc_value_t val;
    val.b_bool = b;
223
    return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
224 225
}

226 227 228 229 230 231 232 233 234 235
static inline int var_SetCoords( vlc_object_t *obj, const char *name,
                                 int32_t x, int32_t y )
{
    vlc_value_t val;
    val.coords.x = x;
    val.coords.y = y;
    return var_SetChecked (obj, name, VLC_VAR_COORDS, val);
}
#define var_SetCoords(o,n,x,y) var_SetCoords(VLC_OBJECT(o),n,x,y)

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
236 237 238 239 240 241 242
/**
 * Set the value of a float variable
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 * \param f The new float value of this variable
 */
243
static inline int var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
244 245 246
{
    vlc_value_t val;
    val.f_float = f;
247
    return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
248
}
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
249

250 251 252 253 254 255 256
/**
 * Set the value of a string variable
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 * \param psz_string The new string value of this variable
 */
257
static inline int var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
258 259
{
    vlc_value_t val;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
260
    val.psz_string = (char *)psz_string;
261
    return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
262 263
}

264 265 266 267 268 269 270 271
/**
 * Set the value of a pointer variable
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 * \param ptr The new pointer value of this variable
 */
static inline
272
int var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
273 274 275 276 277 278
{
    vlc_value_t val;
    val.p_address = ptr;
    return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
}

279 280 281 282 283
#define var_SetInteger(a,b,c)   var_SetInteger( VLC_OBJECT(a),b,c)
#define var_SetBool(a,b,c)      var_SetBool( VLC_OBJECT(a),b,c)
#define var_SetFloat(a,b,c)     var_SetFloat( VLC_OBJECT(a),b,c)
#define var_SetString(a,b,c)    var_SetString( VLC_OBJECT(a),b,c)
#define var_SetAddress(o, n, p) var_SetAddress(VLC_OBJECT(o), n, p)
Rémi Duraffort's avatar
Rémi Duraffort committed
284

285

286
/**
287 288
 * Get an integer value
*
289 290 291
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
292
VLC_USED
293
static inline int64_t var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
294
{
295 296
    vlc_value_t val;
    if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
297 298 299 300 301
        return val.i_int;
    else
        return 0;
}

302 303 304 305 306 307
/**
 * Get a boolean value
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
308
VLC_USED
309
static inline bool var_GetBool( vlc_object_t *p_obj, const char *psz_name )
310
{
311
    vlc_value_t val; val.b_bool = false;
312

313
    if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
314 315
        return val.b_bool;
    else
316
        return false;
317 318
}

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
static inline void var_GetCoords( vlc_object_t *obj, const char *name,
                                  int32_t *px, int32_t *py )
{
    vlc_value_t val;

    if (likely(!var_GetChecked (obj, name, VLC_VAR_COORDS, &val)))
    {
        *px = val.coords.x;
        *py = val.coords.y;
    }
    else
        *px = *py = 0;
}
#define var_GetCoords(o,n,x,y) var_GetCoords(VLC_OBJECT(o),n,x,y)

334 335 336 337 338 339
/**
 * Get a float value
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
340
VLC_USED
341
static inline float var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
342
{
Clément Stenac's avatar
Clément Stenac committed
343
    vlc_value_t val; val.f_float = 0.0;
344
    if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
345 346 347 348 349 350 351 352 353 354 355
        return val.f_float;
    else
        return 0.0;
}

/**
 * Get a string value
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
356
VLC_USED VLC_MALLOC
357
static inline char *var_GetString( vlc_object_t *p_obj, const char *psz_name )
358
{
Clément Stenac's avatar
Clément Stenac committed
359
    vlc_value_t val; val.psz_string = NULL;
360
    if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
361
        return NULL;
362
    else
363
        return val.psz_string;
364 365
}

366
VLC_USED VLC_MALLOC
367
static inline char *var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
368 369
{
    vlc_value_t val;
370
    if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
371
        return NULL;
372
    if( val.psz_string && *val.psz_string )
373
        return val.psz_string;
374
    free( val.psz_string );
375 376 377
    return NULL;
}

378
VLC_USED
379
static inline void *var_GetAddress( vlc_object_t *p_obj, const char *psz_name )
380 381 382 383 384 385 386
{
    vlc_value_t val;
    if( var_GetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, &val ) )
        return NULL;
    else
        return val.p_address;
}
387

388 389 390 391 392
/**
 * Increment an integer variable
 * \param p_obj the object that holds the variable
 * \param psz_name the name of the variable
 */
393
static inline int64_t var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
394
{
395 396
    vlc_value_t val;
    val.i_int = 1;
397 398
    if( var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_ADD, &val ) )
        return 0;
399
    return val.i_int;
400
}
401
#define var_IncInteger(a,b) var_IncInteger( VLC_OBJECT(a), b )
402 403 404 405 406 407

/**
 * Decrement an integer variable
 * \param p_obj the object that holds the variable
 * \param psz_name the name of the variable
 */
408
static inline int64_t var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
409
{
410 411
    vlc_value_t val;
    val.i_int = -1;
412 413
    if( var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_ADD, &val ) )
        return 0;
414
    return val.i_int;
415
}
416
#define var_DecInteger(a,b) var_DecInteger( VLC_OBJECT(a), b )
417

418
static inline uint64_t var_OrInteger( vlc_object_t *obj, const char *name,
419 420 421 422
                                      unsigned v )
{
    vlc_value_t val;
    val.i_int = v;
423 424
    if( var_GetAndSet( obj, name, VLC_VAR_INTEGER_OR, &val ) )
        return 0;
425 426 427 428
    return val.i_int;
}
#define var_OrInteger(a,b,c) var_OrInteger(VLC_OBJECT(a),b,c)

429
static inline uint64_t var_NAndInteger( vlc_object_t *obj, const char *name,
430 431 432 433
                                        unsigned v )
{
    vlc_value_t val;
    val.i_int = v;
434 435
    if( var_GetAndSet( obj, name, VLC_VAR_INTEGER_NAND, &val ) )
        return 0;
436 437 438 439
    return val.i_int;
}
#define var_NAndInteger(a,b,c) var_NAndInteger(VLC_OBJECT(a),b,c)

440 441 442 443 444 445
/**
 * Create a integer variable with inherit and get its value.
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
446
VLC_USED
447
static inline int64_t var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
448
{
449 450
    var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
    return var_GetInteger( p_obj, psz_name );
451 452
}

453 454 455 456 457 458
/**
 * Create a boolean variable with inherit and get its value.
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
459
VLC_USED
460
static inline bool var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
461
{
462 463
    var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
    return var_GetBool( p_obj, psz_name );
464 465
}

466 467 468 469 470 471
/**
 * Create a float variable with inherit and get its value.
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
472
VLC_USED
473
static inline float var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
474
{
475 476
    var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
    return var_GetFloat( p_obj, psz_name );
477 478 479 480 481 482 483 484
}

/**
 * Create a string variable with inherit and get its value.
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
485
VLC_USED VLC_MALLOC
486
static inline char *var_CreateGetString( vlc_object_t *p_obj,
487
                                           const char *psz_name )
488
{
489 490
    var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
    return var_GetString( p_obj, psz_name );
491
}
492

493
VLC_USED VLC_MALLOC
494
static inline char *var_CreateGetNonEmptyString( vlc_object_t *p_obj,
495 496
                                                   const char *psz_name )
{
497 498
    var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
    return var_GetNonEmptyString( p_obj, psz_name );
499 500
}

501 502 503 504 505 506
/**
 * Create an address variable with inherit and get its value.
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
507
VLC_USED
508
static inline void *var_CreateGetAddress( vlc_object_t *p_obj,
509 510
                                           const char *psz_name )
{
511 512
    var_Create( p_obj, psz_name, VLC_VAR_ADDRESS | VLC_VAR_DOINHERIT );
    return var_GetAddress( p_obj, psz_name );
513 514
}

515 516 517 518 519 520
#define var_CreateGetInteger(a,b)   var_CreateGetInteger( VLC_OBJECT(a),b)
#define var_CreateGetBool(a,b)   var_CreateGetBool( VLC_OBJECT(a),b)
#define var_CreateGetFloat(a,b)   var_CreateGetFloat( VLC_OBJECT(a),b)
#define var_CreateGetString(a,b)   var_CreateGetString( VLC_OBJECT(a),b)
#define var_CreateGetNonEmptyString(a,b)   var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
#define var_CreateGetAddress(a,b)  var_CreateGetAddress( VLC_OBJECT(a),b)
521

522 523 524 525 526 527
/**
 * Create a integer command variable with inherit and get its value.
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
528
VLC_USED
529
static inline int64_t var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
530
{
531
    var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
532
                                   | VLC_VAR_ISCOMMAND );
533
    return var_GetInteger( p_obj, psz_name );
534 535 536 537 538 539 540 541
}

/**
 * Create a boolean command variable with inherit and get its value.
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
542
VLC_USED
543
static inline bool var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
544
{
545
    var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
546
                                   | VLC_VAR_ISCOMMAND );
547
    return var_GetBool( p_obj, psz_name );
548 549 550 551 552 553 554 555
}

/**
 * Create a float command variable with inherit and get its value.
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
556
VLC_USED
557
static inline float var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
558
{
559
    var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
560
                                   | VLC_VAR_ISCOMMAND );
561
    return var_GetFloat( p_obj, psz_name );
562 563 564 565 566 567 568 569
}

/**
 * Create a string command variable with inherit and get its value.
 *
 * \param p_obj The object that holds the variable
 * \param psz_name The name of the variable
 */
570
VLC_USED VLC_MALLOC
571
static inline char *var_CreateGetStringCommand( vlc_object_t *p_obj,
572 573
                                           const char *psz_name )
{
574
    var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
575
                                   | VLC_VAR_ISCOMMAND );
576
    return var_GetString( p_obj, psz_name );
577 578
}

579
VLC_USED VLC_MALLOC
580
static inline char *var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
581 582
                                                   const char *psz_name )
{
583
    var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
584
                                   | VLC_VAR_ISCOMMAND );
585
    return var_GetNonEmptyString( p_obj, psz_name );
586 587
}

588 589 590 591 592
#define var_CreateGetIntegerCommand(a,b)   var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
#define var_CreateGetBoolCommand(a,b)   var_CreateGetBoolCommand( VLC_OBJECT(a),b)
#define var_CreateGetFloatCommand(a,b)   var_CreateGetFloatCommand( VLC_OBJECT(a),b)
#define var_CreateGetStringCommand(a,b)   var_CreateGetStringCommand( VLC_OBJECT(a),b)
#define var_CreateGetNonEmptyStringCommand(a,b)   var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
593

594
VLC_USED
595
static inline int var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
596 597
{
    vlc_value_t count;
598
    if( var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
599 600 601
        return 0;
    return count.i_int;
}
602
#define var_CountChoices(a,b) var_CountChoices( VLC_OBJECT(a),b)
603

604

605
static inline bool var_ToggleBool( vlc_object_t *p_obj, const char *psz_name )
606 607
{
    vlc_value_t val;
608 609
    if( var_GetAndSet( p_obj, psz_name, VLC_VAR_BOOL_TOGGLE, &val ) )
        return false;
610
    return val.b_bool;
611
}
612
#define var_ToggleBool(a,b) var_ToggleBool( VLC_OBJECT(a),b )
613

Laurent Aimar's avatar
Laurent Aimar committed
614

615
VLC_USED
Laurent Aimar's avatar
Laurent Aimar committed
616 617 618 619 620 621 622 623 624 625
static inline bool var_InheritBool( vlc_object_t *obj, const char *name )
{
    vlc_value_t val;

    if( var_Inherit( obj, name, VLC_VAR_BOOL, &val ) )
        val.b_bool = false;
    return val.b_bool;
}
#define var_InheritBool(o, n) var_InheritBool(VLC_OBJECT(o), n)

626
VLC_USED
627
static inline int64_t var_InheritInteger( vlc_object_t *obj, const char *name )
628 629 630 631 632 633 634 635 636
{
    vlc_value_t val;

    if( var_Inherit( obj, name, VLC_VAR_INTEGER, &val ) )
        val.i_int = 0;
    return val.i_int;
}
#define var_InheritInteger(o, n) var_InheritInteger(VLC_OBJECT(o), n)

637
VLC_USED
638 639 640 641 642 643 644 645 646 647
static inline float var_InheritFloat( vlc_object_t *obj, const char *name )
{
    vlc_value_t val;

    if( var_Inherit( obj, name, VLC_VAR_FLOAT, &val ) )
        val.f_float = 0.;
    return val.f_float;
}
#define var_InheritFloat(o, n) var_InheritFloat(VLC_OBJECT(o), n)

648
VLC_USED VLC_MALLOC
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
static inline char *var_InheritString( vlc_object_t *obj, const char *name )
{
    vlc_value_t val;

    if( var_Inherit( obj, name, VLC_VAR_STRING, &val ) )
        val.psz_string = NULL;
    else if( val.psz_string && !*val.psz_string )
    {
        free( val.psz_string );
        val.psz_string = NULL;
    }
    return val.psz_string;
}
#define var_InheritString(o, n) var_InheritString(VLC_OBJECT(o), n)

664
VLC_USED
665 666 667 668 669 670 671 672
static inline void *var_InheritAddress( vlc_object_t *obj, const char *name )
{
    vlc_value_t val;

    if( var_Inherit( obj, name, VLC_VAR_ADDRESS, &val ) )
        val.p_address = NULL;
    return val.p_address;
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
673
#define var_InheritAddress(o, n) var_InheritAddress(VLC_OBJECT(o), n)
674

675
VLC_API int var_InheritURational( vlc_object_t *, unsigned *num, unsigned *den, const char *var );
676 677
#define var_InheritURational(a,b,c,d) var_InheritURational(VLC_OBJECT(a), b, c, d)

678 679 680 681 682 683 684
#define var_GetInteger(a,b)   var_GetInteger( VLC_OBJECT(a),b)
#define var_GetBool(a,b)   var_GetBool( VLC_OBJECT(a),b)
#define var_GetFloat(a,b)   var_GetFloat( VLC_OBJECT(a),b)
#define var_GetString(a,b)   var_GetString( VLC_OBJECT(a),b)
#define var_GetNonEmptyString(a,b)   var_GetNonEmptyString( VLC_OBJECT(a),b)
#define var_GetAddress(a,b)  var_GetAddress( VLC_OBJECT(a),b)

685
VLC_API int var_LocationParse(vlc_object_t *, const char *mrl, const char *prefix);
686 687
#define var_LocationParse(o, m, p) var_LocationParse(VLC_OBJECT(o), m, p)

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
688 689 690
/**
 * @}
 */
691
#endif /*  _VLC_VARIABLES_H */