var_LocationParse: helper for DVB/V4L2-style MRLs
[vlc.git] / 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  * \file
30  * This file defines functions and structures for dynamic variables in vlc
31  */
32
33 /**
34  * \defgroup variables Variables
35  *
36  * Functions for using the object variables in vlc.
37  *
38  * Vlc have a very powerful "object variable" infrastructure useful
39  * for many things.
40  *
41  * @{
42  */
43
44 /*****************************************************************************
45  * Variable types - probably very incomplete
46  *****************************************************************************/
47 #define VLC_VAR_TYPE      0x00ff
48 #define VLC_VAR_CLASS     0x00f0
49 #define VLC_VAR_FLAGS     0xff00
50
51 /** \defgroup var_flags Additive flags
52  * These flags are added to the type field of the variable. Most as a result of
53  * a var_Change() call, but some may be added at creation time
54  * @{
55  */
56 #define VLC_VAR_HASCHOICE 0x0100
57 #define VLC_VAR_HASMIN    0x0200
58 #define VLC_VAR_HASMAX    0x0400
59 #define VLC_VAR_HASSTEP   0x0800
60
61 #define VLC_VAR_ISCOMMAND 0x2000
62
63 /** Creation flag */
64 /* If the variable is not found on the current module
65    search all parents and finally module config until found */
66 #define VLC_VAR_DOINHERIT 0x8000
67 /**@}*/
68
69 /**
70  * \defgroup var_action Variable actions
71  * These are the different actions that can be used with var_Change().
72  * The parameters given are the meaning of the two last parameters of
73  * var_Change() when this action is being used.
74  * @{
75  */
76
77 /**
78  * Set the minimum value of this variable
79  * \param p_val The new minimum value
80  * \param p_val2 Unused
81  */
82 #define VLC_VAR_SETMIN              0x0010
83 /**
84  * Set the maximum value of this variable
85  * \param p_val The new maximum value
86  * \param p_val2 Unused
87  */
88 #define VLC_VAR_SETMAX              0x0011
89 #define VLC_VAR_SETSTEP             0x0012
90
91 /**
92  * Set the value of this variable without triggering any callbacks
93  * \param p_val The new value
94  * \param p_val2 Unused
95  */
96 #define VLC_VAR_SETVALUE            0x0013
97
98 #define VLC_VAR_SETTEXT             0x0014
99 #define VLC_VAR_GETTEXT             0x0015
100
101 #define VLC_VAR_GETMIN              0x0016
102 #define VLC_VAR_GETMAX              0x0017
103 #define VLC_VAR_GETSTEP             0x0018
104
105 #define VLC_VAR_ADDCHOICE           0x0020
106 #define VLC_VAR_DELCHOICE           0x0021
107 #define VLC_VAR_CLEARCHOICES        0x0022
108 #define VLC_VAR_SETDEFAULT          0x0023
109 #define VLC_VAR_GETCHOICES          0x0024
110 #define VLC_VAR_GETLIST             0x0025
111 #define VLC_VAR_CHOICESCOUNT        0x0026
112
113 #define VLC_VAR_SETISCOMMAND        0x0040
114 /**@}*/
115
116 /** \defgroup var_GetAndSet Variable actions
117  * These are the different actions that can be used with var_GetAndSet()
118  * @{
119  */
120 enum {
121     VLC_VAR_BOOL_TOGGLE, /**< Invert a boolean value (param ignored) */
122     VLC_VAR_INTEGER_ADD, /**< Add parameter to an integer value */
123     VLC_VAR_INTEGER_OR,  /**< Binary OR over an integer bits field */
124     VLC_VAR_INTEGER_NAND,/**< Binary NAND over an integer bits field */
125 };
126 /**@}*/
127
128 /*****************************************************************************
129  * Prototypes
130  *****************************************************************************/
131 VLC_EXPORT( int, var_Create, ( vlc_object_t *, const char *, int ) );
132 #define var_Create(a,b,c) var_Create( VLC_OBJECT(a), b, c )
133
134 VLC_EXPORT( int, var_Destroy, ( vlc_object_t *, const char * ) );
135 #define var_Destroy(a,b) var_Destroy( VLC_OBJECT(a), b )
136
137 VLC_EXPORT( int, var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
138 #define var_Change(a,b,c,d,e) var_Change( VLC_OBJECT(a), b, c, d, e )
139
140 VLC_EXPORT( int, var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
141 #define var_Type(a,b) var_Type( VLC_OBJECT(a), b )
142
143 VLC_EXPORT( int, var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
144 #define var_Set(a,b,c) var_Set( VLC_OBJECT(a), b, c )
145
146 VLC_EXPORT( int, var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
147 #define var_Get(a,b,c) var_Get( VLC_OBJECT(a), b, c )
148
149 VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) );
150 #define var_SetChecked(o,n,t,v) var_SetChecked(VLC_OBJECT(o),n,t,v)
151 VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
152 #define var_GetChecked(o,n,t,v) var_GetChecked(VLC_OBJECT(o),n,t,v)
153 VLC_EXPORT( int, var_GetAndSet, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
154
155 VLC_EXPORT( int, var_Inherit, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
156
157 VLC_EXPORT( int, var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
158 #define var_Command(a,b,c,d,e) var_Command( VLC_OBJECT( a ), b, c, d, e )
159
160 VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) );
161
162
163 /*****************************************************************************
164  * Variable callbacks
165  *****************************************************************************
166  * int MyCallback( vlc_object_t *p_this,
167  *                 char const *psz_variable,
168  *                 vlc_value_t oldvalue,
169  *                 vlc_value_t newvalue,
170  *                 void *p_data);
171  *****************************************************************************/
172 VLC_EXPORT( int, var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
173 VLC_EXPORT( int, var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
174 VLC_EXPORT( int, var_TriggerCallback, ( vlc_object_t *, const char * ) );
175
176 #define var_AddCallback(a,b,c,d) var_AddCallback( VLC_OBJECT(a), b, c, d )
177 #define var_DelCallback(a,b,c,d) var_DelCallback( VLC_OBJECT(a), b, c, d )
178 #define var_TriggerCallback(a,b) var_TriggerCallback( VLC_OBJECT(a), b )
179
180 /*****************************************************************************
181  * helpers functions
182  *****************************************************************************/
183
184 /**
185  * Set the value of an integer variable
186  *
187  * \param p_obj The object that holds the variable
188  * \param psz_name The name of the variable
189  * \param i The new integer value of this variable
190  */
191 static inline int var_SetInteger( vlc_object_t *p_obj, const char *psz_name,
192                                   int64_t i )
193 {
194     vlc_value_t val;
195     val.i_int = i;
196     return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
197 }
198
199 /**
200  * Set the value of an boolean variable
201  *
202  * \param p_obj The object that holds the variable
203  * \param psz_name The name of the variable
204  * \param b The new boolean value of this variable
205  */
206 static inline int var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
207 {
208     vlc_value_t val;
209     val.b_bool = b;
210     return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
211 }
212
213 /**
214  * Set the value of a time variable
215  *
216  * \param p_obj The object that holds the variable
217  * \param psz_name The name of the variable
218  * \param i The new time value of this variable
219  */
220 static inline int var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
221 {
222     vlc_value_t val;
223     val.i_time = i;
224     return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
225 }
226
227 static inline int var_SetCoords( vlc_object_t *obj, const char *name,
228                                  int32_t x, int32_t y )
229 {
230     vlc_value_t val;
231     val.coords.x = x;
232     val.coords.y = y;
233     return var_SetChecked (obj, name, VLC_VAR_COORDS, val);
234 }
235 #define var_SetCoords(o,n,x,y) var_SetCoords(VLC_OBJECT(o),n,x,y)
236
237 /**
238  * Set the value of a float variable
239  *
240  * \param p_obj The object that holds the variable
241  * \param psz_name The name of the variable
242  * \param f The new float value of this variable
243  */
244 static inline int var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
245 {
246     vlc_value_t val;
247     val.f_float = f;
248     return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
249 }
250
251 /**
252  * Set the value of a string variable
253  *
254  * \param p_obj The object that holds the variable
255  * \param psz_name The name of the variable
256  * \param psz_string The new string value of this variable
257  */
258 static inline int var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
259 {
260     vlc_value_t val;
261     val.psz_string = (char *)psz_string;
262     return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
263 }
264
265 /**
266  * Set the value of a pointer variable
267  *
268  * \param p_obj The object that holds the variable
269  * \param psz_name The name of the variable
270  * \param ptr The new pointer value of this variable
271  */
272 static inline
273 int var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
274 {
275     vlc_value_t val;
276     val.p_address = ptr;
277     return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
278 }
279
280 #define var_SetInteger(a,b,c)   var_SetInteger( VLC_OBJECT(a),b,c)
281 #define var_SetBool(a,b,c)      var_SetBool( VLC_OBJECT(a),b,c)
282 #define var_SetTime(a,b,c)      var_SetTime( VLC_OBJECT(a),b,c)
283 #define var_SetFloat(a,b,c)     var_SetFloat( VLC_OBJECT(a),b,c)
284 #define var_SetString(a,b,c)    var_SetString( VLC_OBJECT(a),b,c)
285 #define var_SetAddress(o, n, p) var_SetAddress(VLC_OBJECT(o), n, p)
286
287
288 /**
289  * Get an integer value
290 *
291  * \param p_obj The object that holds the variable
292  * \param psz_name The name of the variable
293  */
294 LIBVLC_USED
295 static inline int64_t var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
296 {
297     vlc_value_t val;
298     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
299         return val.i_int;
300     else
301         return 0;
302 }
303
304 /**
305  * Get a boolean value
306  *
307  * \param p_obj The object that holds the variable
308  * \param psz_name The name of the variable
309  */
310 LIBVLC_USED
311 static inline bool var_GetBool( vlc_object_t *p_obj, const char *psz_name )
312 {
313     vlc_value_t val; val.b_bool = false;
314
315     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &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 LIBVLC_USED
328 static inline int64_t var_GetTime( vlc_object_t *p_obj, const char *psz_name )
329 {
330     vlc_value_t val; val.i_time = 0L;
331     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
332         return val.i_time;
333     else
334         return 0;
335 }
336
337 static inline void var_GetCoords( vlc_object_t *obj, const char *name,
338                                   int32_t *px, int32_t *py )
339 {
340     vlc_value_t val;
341
342     if (likely(!var_GetChecked (obj, name, VLC_VAR_COORDS, &val)))
343     {
344         *px = val.coords.x;
345         *py = val.coords.y;
346     }
347     else
348         *px = *py = 0;
349 }
350 #define var_GetCoords(o,n,x,y) var_GetCoords(VLC_OBJECT(o),n,x,y)
351
352 /**
353  * Get a float value
354  *
355  * \param p_obj The object that holds the variable
356  * \param psz_name The name of the variable
357  */
358 LIBVLC_USED
359 static inline float var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
360 {
361     vlc_value_t val; val.f_float = 0.0;
362     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
363         return val.f_float;
364     else
365         return 0.0;
366 }
367
368 /**
369  * Get a string value
370  *
371  * \param p_obj The object that holds the variable
372  * \param psz_name The name of the variable
373  */
374 LIBVLC_USED LIBVLC_MALLOC
375 static inline char *var_GetString( vlc_object_t *p_obj, const char *psz_name )
376 {
377     vlc_value_t val; val.psz_string = NULL;
378     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
379         return NULL;
380     else
381         return val.psz_string;
382 }
383
384 LIBVLC_USED LIBVLC_MALLOC
385 static inline char *var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
386 {
387     vlc_value_t val;
388     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
389         return NULL;
390     if( val.psz_string && *val.psz_string )
391         return val.psz_string;
392     free( val.psz_string );
393     return NULL;
394 }
395
396 LIBVLC_USED
397 static inline void *var_GetAddress( vlc_object_t *p_obj, const char *psz_name )
398 {
399     vlc_value_t val;
400     if( var_GetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, &val ) )
401         return NULL;
402     else
403         return val.p_address;
404 }
405
406 /**
407  * Increment an integer variable
408  * \param p_obj the object that holds the variable
409  * \param psz_name the name of the variable
410  */
411 static inline int64_t var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
412 {
413     vlc_value_t val;
414     val.i_int = 1;
415     var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_ADD, &val );
416     return val.i_int;
417 }
418 #define var_IncInteger(a,b) var_IncInteger( VLC_OBJECT(a), b )
419
420 /**
421  * Decrement an integer variable
422  * \param p_obj the object that holds the variable
423  * \param psz_name the name of the variable
424  */
425 static inline int64_t var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
426 {
427     vlc_value_t val;
428     val.i_int = -1;
429     var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_ADD, &val );
430     return val.i_int;
431 }
432 #define var_DecInteger(a,b) var_DecInteger( VLC_OBJECT(a), b )
433
434 static inline uint64_t var_OrInteger( vlc_object_t *obj, const char *name,
435                                       unsigned v )
436 {
437     vlc_value_t val;
438     val.i_int = v;
439     var_GetAndSet( obj, name, VLC_VAR_INTEGER_OR, &val );
440     return val.i_int;
441 }
442 #define var_OrInteger(a,b,c) var_OrInteger(VLC_OBJECT(a),b,c)
443
444 static inline uint64_t var_NAndInteger( vlc_object_t *obj, const char *name,
445                                         unsigned v )
446 {
447     vlc_value_t val;
448     val.i_int = v;
449     var_GetAndSet( obj, name, VLC_VAR_INTEGER_NAND, &val );
450     return val.i_int;
451 }
452 #define var_NAndInteger(a,b,c) var_NAndInteger(VLC_OBJECT(a),b,c)
453
454 /**
455  * Create a integer variable with inherit and get its value.
456  *
457  * \param p_obj The object that holds the variable
458  * \param psz_name The name of the variable
459  */
460 LIBVLC_USED
461 static inline int64_t var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
462 {
463     var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
464     return var_GetInteger( p_obj, psz_name );
465 }
466
467 /**
468  * Create a boolean 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 LIBVLC_USED
474 static inline bool var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
475 {
476     var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
477     return var_GetBool( p_obj, psz_name );
478 }
479
480 /**
481  * Create a time variable with inherit and get its value.
482  *
483  * \param p_obj The object that holds the variable
484  * \param psz_name The name of the variable
485  */
486 LIBVLC_USED
487 static inline int64_t var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
488 {
489     var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
490     return var_GetTime( p_obj, psz_name );
491 }
492
493 /**
494  * Create a float 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 LIBVLC_USED
500 static inline float var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
501 {
502     var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
503     return var_GetFloat( p_obj, psz_name );
504 }
505
506 /**
507  * Create a string variable with inherit and get its value.
508  *
509  * \param p_obj The object that holds the variable
510  * \param psz_name The name of the variable
511  */
512 LIBVLC_USED LIBVLC_MALLOC
513 static inline char *var_CreateGetString( vlc_object_t *p_obj,
514                                            const char *psz_name )
515 {
516     var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
517     return var_GetString( p_obj, psz_name );
518 }
519
520 LIBVLC_USED LIBVLC_MALLOC
521 static inline char *var_CreateGetNonEmptyString( vlc_object_t *p_obj,
522                                                    const char *psz_name )
523 {
524     var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
525     return var_GetNonEmptyString( p_obj, psz_name );
526 }
527
528 /**
529  * Create an address 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 LIBVLC_USED
535 static inline void *var_CreateGetAddress( vlc_object_t *p_obj,
536                                            const char *psz_name )
537 {
538     var_Create( p_obj, psz_name, VLC_VAR_ADDRESS | VLC_VAR_DOINHERIT );
539     return var_GetAddress( p_obj, psz_name );
540 }
541
542 #define var_CreateGetInteger(a,b)   var_CreateGetInteger( VLC_OBJECT(a),b)
543 #define var_CreateGetBool(a,b)   var_CreateGetBool( VLC_OBJECT(a),b)
544 #define var_CreateGetTime(a,b)   var_CreateGetTime( VLC_OBJECT(a),b)
545 #define var_CreateGetFloat(a,b)   var_CreateGetFloat( VLC_OBJECT(a),b)
546 #define var_CreateGetString(a,b)   var_CreateGetString( VLC_OBJECT(a),b)
547 #define var_CreateGetNonEmptyString(a,b)   var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
548 #define var_CreateGetAddress(a,b)  var_CreateGetAddress( VLC_OBJECT(a),b)
549
550 /**
551  * Create a integer command variable with inherit and get its value.
552  *
553  * \param p_obj The object that holds the variable
554  * \param psz_name The name of the variable
555  */
556 LIBVLC_USED
557 static inline int64_t var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
558 {
559     var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
560                                    | VLC_VAR_ISCOMMAND );
561     return var_GetInteger( p_obj, psz_name );
562 }
563
564 /**
565  * Create a boolean command variable with inherit and get its value.
566  *
567  * \param p_obj The object that holds the variable
568  * \param psz_name The name of the variable
569  */
570 LIBVLC_USED
571 static inline bool var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
572 {
573     var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
574                                    | VLC_VAR_ISCOMMAND );
575     return var_GetBool( p_obj, psz_name );
576 }
577
578 /**
579  * Create a time command variable with inherit and get its value.
580  *
581  * \param p_obj The object that holds the variable
582  * \param psz_name The name of the variable
583  */
584 LIBVLC_USED
585 static inline int64_t var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
586 {
587     var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
588                                    | VLC_VAR_ISCOMMAND );
589     return var_GetTime( p_obj, psz_name );
590 }
591
592 /**
593  * Create a float command variable with inherit and get its value.
594  *
595  * \param p_obj The object that holds the variable
596  * \param psz_name The name of the variable
597  */
598 LIBVLC_USED
599 static inline float var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
600 {
601     var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
602                                    | VLC_VAR_ISCOMMAND );
603     return var_GetFloat( p_obj, psz_name );
604 }
605
606 /**
607  * Create a string command variable with inherit and get its value.
608  *
609  * \param p_obj The object that holds the variable
610  * \param psz_name The name of the variable
611  */
612 LIBVLC_USED LIBVLC_MALLOC
613 static inline char *var_CreateGetStringCommand( vlc_object_t *p_obj,
614                                            const char *psz_name )
615 {
616     var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
617                                    | VLC_VAR_ISCOMMAND );
618     return var_GetString( p_obj, psz_name );
619 }
620
621 LIBVLC_USED LIBVLC_MALLOC
622 static inline char *var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
623                                                    const char *psz_name )
624 {
625     var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
626                                    | VLC_VAR_ISCOMMAND );
627     return var_GetNonEmptyString( p_obj, psz_name );
628 }
629
630 #define var_CreateGetIntegerCommand(a,b)   var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
631 #define var_CreateGetBoolCommand(a,b)   var_CreateGetBoolCommand( VLC_OBJECT(a),b)
632 #define var_CreateGetTimeCommand(a,b)   var_CreateGetTimeCommand( VLC_OBJECT(a),b)
633 #define var_CreateGetFloatCommand(a,b)   var_CreateGetFloatCommand( VLC_OBJECT(a),b)
634 #define var_CreateGetStringCommand(a,b)   var_CreateGetStringCommand( VLC_OBJECT(a),b)
635 #define var_CreateGetNonEmptyStringCommand(a,b)   var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
636
637 LIBVLC_USED
638 static inline int var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
639 {
640     vlc_value_t count;
641     if( var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
642         return 0;
643     return count.i_int;
644 }
645 #define var_CountChoices(a,b) var_CountChoices( VLC_OBJECT(a),b)
646
647
648 static inline bool var_ToggleBool( vlc_object_t *p_obj, const char *psz_name )
649 {
650     vlc_value_t val;
651     var_GetAndSet( p_obj, psz_name, VLC_VAR_BOOL_TOGGLE, &val );
652     return val.b_bool;
653 }
654 #define var_ToggleBool(a,b) var_ToggleBool( VLC_OBJECT(a),b )
655
656
657 LIBVLC_USED
658 static inline bool var_InheritBool( vlc_object_t *obj, const char *name )
659 {
660     vlc_value_t val;
661
662     if( var_Inherit( obj, name, VLC_VAR_BOOL, &val ) )
663         val.b_bool = false;
664     return val.b_bool;
665 }
666 #define var_InheritBool(o, n) var_InheritBool(VLC_OBJECT(o), n)
667
668 LIBVLC_USED
669 static inline int64_t var_InheritInteger( vlc_object_t *obj, const char *name )
670 {
671     vlc_value_t val;
672
673     if( var_Inherit( obj, name, VLC_VAR_INTEGER, &val ) )
674         val.i_int = 0;
675     return val.i_int;
676 }
677 #define var_InheritInteger(o, n) var_InheritInteger(VLC_OBJECT(o), n)
678
679 LIBVLC_USED
680 static inline float var_InheritFloat( vlc_object_t *obj, const char *name )
681 {
682     vlc_value_t val;
683
684     if( var_Inherit( obj, name, VLC_VAR_FLOAT, &val ) )
685         val.f_float = 0.;
686     return val.f_float;
687 }
688 #define var_InheritFloat(o, n) var_InheritFloat(VLC_OBJECT(o), n)
689
690 LIBVLC_USED LIBVLC_MALLOC
691 static inline char *var_InheritString( vlc_object_t *obj, const char *name )
692 {
693     vlc_value_t val;
694
695     if( var_Inherit( obj, name, VLC_VAR_STRING, &val ) )
696         val.psz_string = NULL;
697     else if( val.psz_string && !*val.psz_string )
698     {
699         free( val.psz_string );
700         val.psz_string = NULL;
701     }
702     return val.psz_string;
703 }
704 #define var_InheritString(o, n) var_InheritString(VLC_OBJECT(o), n)
705
706 LIBVLC_USED
707 static inline mtime_t var_InheritTime( vlc_object_t *obj, const char *name )
708 {
709     vlc_value_t val;
710
711     if( var_Inherit( obj, name, VLC_VAR_TIME, &val ) )
712         val.i_time = 0;
713     return val.i_time;
714 }
715 #define var_InheritTime(o, n) var_InheritTime(VLC_OBJECT(o), n)
716
717 LIBVLC_USED
718 static inline void *var_InheritAddress( vlc_object_t *obj, const char *name )
719 {
720     vlc_value_t val;
721
722     if( var_Inherit( obj, name, VLC_VAR_ADDRESS, &val ) )
723         val.p_address = NULL;
724     return val.p_address;
725 }
726 #define var_InheritAddress(o, n) var_InheritAddress(VLC_OBJECT(o), n)
727
728 VLC_EXPORT( int, var_InheritURational, ( vlc_object_t *, unsigned *num, unsigned *den, const char *var ) );
729 #define var_InheritURational(a,b,c,d) var_InheritURational(VLC_OBJECT(a), b, c, d)
730
731 #define var_GetInteger(a,b)   var_GetInteger( VLC_OBJECT(a),b)
732 #define var_GetBool(a,b)   var_GetBool( VLC_OBJECT(a),b)
733 #define var_GetTime(a,b)   var_GetTime( VLC_OBJECT(a),b)
734 #define var_GetFloat(a,b)   var_GetFloat( VLC_OBJECT(a),b)
735 #define var_GetString(a,b)   var_GetString( VLC_OBJECT(a),b)
736 #define var_GetNonEmptyString(a,b)   var_GetNonEmptyString( VLC_OBJECT(a),b)
737 #define var_GetAddress(a,b)  var_GetAddress( VLC_OBJECT(a),b)
738
739 VLC_EXPORT( int, var_LocationParse, (vlc_object_t *, const char *mrl, const char *prefix) );
740 #define var_LocationParse(o, m, p) var_LocationParse(VLC_OBJECT(o), m, p)
741
742 /**
743  * @}
744  */
745 #endif /*  _VLC_VARIABLES_H */