1 /*****************************************************************************
2 * variables.h: variables handling
3 *****************************************************************************
4 * Copyright (C) 2002-2004 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Gildas Bazin <gbazin@netcourrier.com>
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.
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.
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 *****************************************************************************/
25 #ifndef VLC_VARIABLES_H
26 #define VLC_VARIABLES_H 1
30 * This file defines functions and structures for dynamic variables in vlc
34 * \defgroup variables Variables
36 * Functions for using the object variables in vlc.
38 * Vlc have a very powerful "object variable" infrastructure useful
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
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
56 #define VLC_VAR_HASCHOICE 0x0100
57 #define VLC_VAR_HASMIN 0x0200
58 #define VLC_VAR_HASMAX 0x0400
59 #define VLC_VAR_HASSTEP 0x0800
61 #define VLC_VAR_ISCOMMAND 0x2000
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
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.
78 * Set the minimum value of this variable
79 * \param p_val The new minimum value
80 * \param p_val2 Unused
82 #define VLC_VAR_SETMIN 0x0010
84 * Set the maximum value of this variable
85 * \param p_val The new maximum value
86 * \param p_val2 Unused
88 #define VLC_VAR_SETMAX 0x0011
89 #define VLC_VAR_SETSTEP 0x0012
92 * Set the value of this variable without triggering any callbacks
93 * \param p_val The new value
94 * \param p_val2 Unused
96 #define VLC_VAR_SETVALUE 0x0013
98 #define VLC_VAR_SETTEXT 0x0014
99 #define VLC_VAR_GETTEXT 0x0015
101 #define VLC_VAR_GETMIN 0x0016
102 #define VLC_VAR_GETMAX 0x0017
103 #define VLC_VAR_GETSTEP 0x0018
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
113 #define VLC_VAR_SETISCOMMAND 0x0040
116 /** \defgroup var_GetAndSet Variable actions
117 * These are the different actions that can be used with var_GetAndSet()
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 */
128 /*****************************************************************************
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 )
134 VLC_EXPORT( int, var_Destroy, ( vlc_object_t *, const char * ) );
135 #define var_Destroy(a,b) var_Destroy( VLC_OBJECT(a), b )
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 )
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 )
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 )
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 )
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 * ) );
155 VLC_EXPORT( int, var_Inherit, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
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 )
160 VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) );
163 /*****************************************************************************
165 *****************************************************************************
166 * int MyCallback( vlc_object_t *p_this,
167 * char const *psz_variable,
168 * vlc_value_t oldvalue,
169 * vlc_value_t newvalue,
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 * ) );
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 )
180 /*****************************************************************************
182 *****************************************************************************/
185 * Set the value of an integer variable
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
191 static inline int var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
195 return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
199 * Set the value of an boolean variable
201 * \param p_obj The object that holds the variable
202 * \param psz_name The name of the variable
203 * \param b The new boolean value of this variable
205 static inline int var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
209 return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
213 * Set the value of a time variable
215 * \param p_obj The object that holds the variable
216 * \param psz_name The name of the variable
217 * \param i The new time value of this variable
219 static inline int var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
223 return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
227 * Set the value of a float variable
229 * \param p_obj The object that holds the variable
230 * \param psz_name The name of the variable
231 * \param f The new float value of this variable
233 static inline int var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
237 return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
241 * Set the value of a string variable
243 * \param p_obj The object that holds the variable
244 * \param psz_name The name of the variable
245 * \param psz_string The new string value of this variable
247 static inline int var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
250 val.psz_string = (char *)psz_string;
251 return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
255 * Set the value of a pointer variable
257 * \param p_obj The object that holds the variable
258 * \param psz_name The name of the variable
259 * \param ptr The new pointer value of this variable
262 int var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
266 return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
269 #define var_SetInteger(a,b,c) var_SetInteger( VLC_OBJECT(a),b,c)
270 #define var_SetBool(a,b,c) var_SetBool( VLC_OBJECT(a),b,c)
271 #define var_SetTime(a,b,c) var_SetTime( VLC_OBJECT(a),b,c)
272 #define var_SetFloat(a,b,c) var_SetFloat( VLC_OBJECT(a),b,c)
273 #define var_SetString(a,b,c) var_SetString( VLC_OBJECT(a),b,c)
274 #define var_SetAddress(o, n, p) var_SetAddress(VLC_OBJECT(o), n, p)
278 * Get an integer value
280 * \param p_obj The object that holds the variable
281 * \param psz_name The name of the variable
284 static inline int var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
287 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
294 * Get a boolean value
296 * \param p_obj The object that holds the variable
297 * \param psz_name The name of the variable
300 static inline bool var_GetBool( vlc_object_t *p_obj, const char *psz_name )
302 vlc_value_t val; val.b_bool = false;
304 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
313 * \param p_obj The object that holds the variable
314 * \param psz_name The name of the variable
317 static inline int64_t var_GetTime( vlc_object_t *p_obj, const char *psz_name )
319 vlc_value_t val; val.i_time = 0L;
320 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
329 * \param p_obj The object that holds the variable
330 * \param psz_name The name of the variable
333 static inline float var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
335 vlc_value_t val; val.f_float = 0.0;
336 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
345 * \param p_obj The object that holds the variable
346 * \param psz_name The name of the variable
349 static inline char *var_GetString( vlc_object_t *p_obj, const char *psz_name )
351 vlc_value_t val; val.psz_string = NULL;
352 if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
355 return val.psz_string;
359 static inline char *var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
362 if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
364 if( val.psz_string && *val.psz_string )
365 return val.psz_string;
366 free( val.psz_string );
371 static inline void *var_GetAddress( vlc_object_t *p_obj, const char *psz_name )
374 if( var_GetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, &val ) )
377 return val.p_address;
381 * Increment an integer variable
382 * \param p_obj the object that holds the variable
383 * \param psz_name the name of the variable
385 static inline int var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
389 var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_ADD, &val );
392 #define var_IncInteger(a,b) var_IncInteger( VLC_OBJECT(a), b )
395 * Decrement an integer variable
396 * \param p_obj the object that holds the variable
397 * \param psz_name the name of the variable
399 static inline int var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
403 var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_ADD, &val );
406 #define var_DecInteger(a,b) var_DecInteger( VLC_OBJECT(a), b )
408 static inline unsigned var_OrInteger( vlc_object_t *obj, const char *name,
413 var_GetAndSet( obj, name, VLC_VAR_INTEGER_OR, &val );
416 #define var_OrInteger(a,b,c) var_OrInteger(VLC_OBJECT(a),b,c)
418 static inline unsigned var_NAndInteger( vlc_object_t *obj, const char *name,
423 var_GetAndSet( obj, name, VLC_VAR_INTEGER_NAND, &val );
426 #define var_NAndInteger(a,b,c) var_NAndInteger(VLC_OBJECT(a),b,c)
429 * Create a integer variable with inherit and get its value.
431 * \param p_obj The object that holds the variable
432 * \param psz_name The name of the variable
435 static inline int var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
437 var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
438 return var_GetInteger( p_obj, psz_name );
442 * Create a boolean variable with inherit and get its value.
444 * \param p_obj The object that holds the variable
445 * \param psz_name The name of the variable
448 static inline bool var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
450 var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
451 return var_GetBool( p_obj, psz_name );
455 * Create a time variable with inherit and get its value.
457 * \param p_obj The object that holds the variable
458 * \param psz_name The name of the variable
461 static inline int64_t var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
463 var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
464 return var_GetTime( p_obj, psz_name );
468 * Create a float variable with inherit and get its value.
470 * \param p_obj The object that holds the variable
471 * \param psz_name The name of the variable
474 static inline float var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
476 var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
477 return var_GetFloat( p_obj, psz_name );
481 * Create a string variable with inherit and get its value.
483 * \param p_obj The object that holds the variable
484 * \param psz_name The name of the variable
487 static inline char *var_CreateGetString( vlc_object_t *p_obj,
488 const char *psz_name )
490 var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
491 return var_GetString( p_obj, psz_name );
495 static inline char *var_CreateGetNonEmptyString( vlc_object_t *p_obj,
496 const char *psz_name )
498 var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
499 return var_GetNonEmptyString( p_obj, psz_name );
503 * Create an address variable with inherit and get its value.
505 * \param p_obj The object that holds the variable
506 * \param psz_name The name of the variable
509 static inline void *var_CreateGetAddress( vlc_object_t *p_obj,
510 const char *psz_name )
512 var_Create( p_obj, psz_name, VLC_VAR_ADDRESS | VLC_VAR_DOINHERIT );
513 return var_GetAddress( p_obj, psz_name );
516 #define var_CreateGetInteger(a,b) var_CreateGetInteger( VLC_OBJECT(a),b)
517 #define var_CreateGetBool(a,b) var_CreateGetBool( VLC_OBJECT(a),b)
518 #define var_CreateGetTime(a,b) var_CreateGetTime( VLC_OBJECT(a),b)
519 #define var_CreateGetFloat(a,b) var_CreateGetFloat( VLC_OBJECT(a),b)
520 #define var_CreateGetString(a,b) var_CreateGetString( VLC_OBJECT(a),b)
521 #define var_CreateGetNonEmptyString(a,b) var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
522 #define var_CreateGetAddress(a,b) var_CreateGetAddress( VLC_OBJECT(a),b)
525 * Create a integer command variable with inherit and get its value.
527 * \param p_obj The object that holds the variable
528 * \param psz_name The name of the variable
531 static inline int var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
533 var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
534 | VLC_VAR_ISCOMMAND );
535 return var_GetInteger( p_obj, psz_name );
539 * Create a boolean command variable with inherit and get its value.
541 * \param p_obj The object that holds the variable
542 * \param psz_name The name of the variable
545 static inline bool var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
547 var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
548 | VLC_VAR_ISCOMMAND );
549 return var_GetBool( p_obj, psz_name );
553 * Create a time command variable with inherit and get its value.
555 * \param p_obj The object that holds the variable
556 * \param psz_name The name of the variable
559 static inline int64_t var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
561 var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
562 | VLC_VAR_ISCOMMAND );
563 return var_GetTime( p_obj, psz_name );
567 * Create a float command variable with inherit and get its value.
569 * \param p_obj The object that holds the variable
570 * \param psz_name The name of the variable
573 static inline float var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
575 var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
576 | VLC_VAR_ISCOMMAND );
577 return var_GetFloat( p_obj, psz_name );
581 * Create a string command variable with inherit and get its value.
583 * \param p_obj The object that holds the variable
584 * \param psz_name The name of the variable
587 static inline char *var_CreateGetStringCommand( vlc_object_t *p_obj,
588 const char *psz_name )
590 var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
591 | VLC_VAR_ISCOMMAND );
592 return var_GetString( p_obj, psz_name );
596 static inline char *var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
597 const char *psz_name )
599 var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
600 | VLC_VAR_ISCOMMAND );
601 return var_GetNonEmptyString( p_obj, psz_name );
604 #define var_CreateGetIntegerCommand(a,b) var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
605 #define var_CreateGetBoolCommand(a,b) var_CreateGetBoolCommand( VLC_OBJECT(a),b)
606 #define var_CreateGetTimeCommand(a,b) var_CreateGetTimeCommand( VLC_OBJECT(a),b)
607 #define var_CreateGetFloatCommand(a,b) var_CreateGetFloatCommand( VLC_OBJECT(a),b)
608 #define var_CreateGetStringCommand(a,b) var_CreateGetStringCommand( VLC_OBJECT(a),b)
609 #define var_CreateGetNonEmptyStringCommand(a,b) var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
612 static inline int var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
615 if( var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
619 #define var_CountChoices(a,b) var_CountChoices( VLC_OBJECT(a),b)
622 static inline bool var_ToggleBool( vlc_object_t *p_obj, const char *psz_name )
625 var_GetAndSet( p_obj, psz_name, VLC_VAR_BOOL_TOGGLE, &val );
628 #define var_ToggleBool(a,b) var_ToggleBool( VLC_OBJECT(a),b )
632 static inline bool var_InheritBool( vlc_object_t *obj, const char *name )
636 if( var_Inherit( obj, name, VLC_VAR_BOOL, &val ) )
640 #define var_InheritBool(o, n) var_InheritBool(VLC_OBJECT(o), n)
643 static inline int var_InheritInteger( vlc_object_t *obj, const char *name )
647 if( var_Inherit( obj, name, VLC_VAR_INTEGER, &val ) )
651 #define var_InheritInteger(o, n) var_InheritInteger(VLC_OBJECT(o), n)
654 static inline float var_InheritFloat( vlc_object_t *obj, const char *name )
658 if( var_Inherit( obj, name, VLC_VAR_FLOAT, &val ) )
662 #define var_InheritFloat(o, n) var_InheritFloat(VLC_OBJECT(o), n)
664 LIBVLC_USED LIBVLC_MALLOC
665 static inline char *var_InheritString( vlc_object_t *obj, const char *name )
669 if( var_Inherit( obj, name, VLC_VAR_STRING, &val ) )
670 val.psz_string = NULL;
671 else if( val.psz_string && !*val.psz_string )
673 free( val.psz_string );
674 val.psz_string = NULL;
676 return val.psz_string;
678 #define var_InheritString(o, n) var_InheritString(VLC_OBJECT(o), n)
680 static inline mtime_t var_InheritTime( vlc_object_t *obj, const char *name )
684 if( var_Inherit( obj, name, VLC_VAR_TIME, &val ) )
688 #define var_InheritTime(o, n) var_InheritTime(VLC_OBJECT(o), n)
690 #define var_GetInteger(a,b) var_GetInteger( VLC_OBJECT(a),b)
691 #define var_GetBool(a,b) var_GetBool( VLC_OBJECT(a),b)
692 #define var_GetTime(a,b) var_GetTime( VLC_OBJECT(a),b)
693 #define var_GetFloat(a,b) var_GetFloat( VLC_OBJECT(a),b)
694 #define var_GetString(a,b) var_GetString( VLC_OBJECT(a),b)
695 #define var_GetNonEmptyString(a,b) var_GetNonEmptyString( VLC_OBJECT(a),b)
696 #define var_GetAddress(a,b) var_GetAddress( VLC_OBJECT(a),b)
701 #endif /* _VLC_VARIABLES_H */