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
32 * This file defines functions and structures for dynamic variables in vlc
36 * \defgroup variables Variables
38 * Functions for using the object variables in vlc.
40 * Vlc have a very powerful "object variable" infrastructure useful
46 /*****************************************************************************
47 * Variable types - probably very incomplete
48 *****************************************************************************/
49 #define VLC_VAR_TYPE 0x00ff
50 #define VLC_VAR_CLASS 0x00f0
51 #define VLC_VAR_FLAGS 0xff00
53 /** \defgroup var_flags Additive flags
54 * These flags are added to the type field of the variable. Most as a result of
55 * a __var_Change() call, but some may be added at creation time
58 #define VLC_VAR_HASCHOICE 0x0100
59 #define VLC_VAR_HASMIN 0x0200
60 #define VLC_VAR_HASMAX 0x0400
61 #define VLC_VAR_HASSTEP 0x0800
63 #define VLC_VAR_ISCOMMAND 0x2000
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_FREECHOICES 0x0025
111 #define VLC_VAR_GETLIST 0x0026
112 #define VLC_VAR_FREELIST 0x0027
113 #define VLC_VAR_CHOICESCOUNT 0x0028
115 #define VLC_VAR_INHERITVALUE 0x0030
116 #define VLC_VAR_TRIGGER_CALLBACKS 0x0035
118 #define VLC_VAR_SETISCOMMAND 0x0040
121 /*****************************************************************************
123 *****************************************************************************/
124 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
125 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
127 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
129 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
130 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
131 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
133 #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
134 VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
137 * __var_Create() with automatic casting.
139 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
141 * __var_Destroy() with automatic casting
143 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
146 * __var_Change() with automatic casting
148 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
151 * __var_Type() with automatic casting
153 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
155 * __var_Set() with automatic casting
157 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
159 * __var_Get() with automatic casting
161 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
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 * ) );
177 * __var_AddCallback() with automatic casting
179 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
182 * __var_DelCallback() with automatic casting
184 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
187 * __var_TriggerCallback() with automatic casting
189 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
191 /*****************************************************************************
193 *****************************************************************************/
196 * This function assert the variable is of the expected type or it
199 static inline void __var_AssertType( vlc_object_t *p_obj, const char *psz_name,
202 const int i_type = __var_Type( p_obj, psz_name ) & VLC_VAR_CLASS;
203 assert( i_type == 0 || i_type == (i_expected&VLC_VAR_CLASS) );
207 * Set the value of an integer variable
209 * \param p_obj The object that holds the variable
210 * \param psz_name The name of the variable
211 * \param i The new integer value of this variable
213 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
217 __var_AssertType( p_obj, psz_name, VLC_VAR_INTEGER );
218 return __var_Set( p_obj, psz_name, val );
220 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
222 * Set the value of an boolean variable
224 * \param p_obj The object that holds the variable
225 * \param psz_name The name of the variable
226 * \param b The new boolean value of this variable
228 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
232 __var_AssertType( p_obj, psz_name, VLC_VAR_BOOL );
233 return __var_Set( p_obj, psz_name, val );
237 * Set the value of a time variable
239 * \param p_obj The object that holds the variable
240 * \param psz_name The name of the variable
241 * \param i The new time value of this variable
243 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
247 __var_AssertType( p_obj, psz_name, VLC_VAR_TIME );
248 return __var_Set( p_obj, psz_name, val );
252 * Set the value of a float variable
254 * \param p_obj The object that holds the variable
255 * \param psz_name The name of the variable
256 * \param f The new float value of this variable
258 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
262 __var_AssertType( p_obj, psz_name, VLC_VAR_FLOAT );
263 return __var_Set( p_obj, psz_name, val );
267 * Set the value of a string variable
269 * \param p_obj The object that holds the variable
270 * \param psz_name The name of the variable
271 * \param psz_string The new string value of this variable
273 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
276 val.psz_string = (char *)psz_string;
277 __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
278 return __var_Set( p_obj, psz_name, val );
282 * Trigger the callbacks on a void variable
284 * \param p_obj The object that holds the variable
285 * \param psz_name The name of the variable
287 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
291 __var_AssertType( p_obj, psz_name, VLC_VAR_VOID );
292 return __var_Set( p_obj, psz_name, val );
294 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
297 * __var_SetBool() with automatic casting
299 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
302 * __var_SetTime() with automatic casting
304 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
306 * __var_SetFloat() with automatic casting
308 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
310 * __var_SetString() with automatic casting
312 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
315 * Get an integer value
317 * \param p_obj The object that holds the variable
318 * \param psz_name The name of the variable
321 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
323 vlc_value_t val;val.i_int = 0;
324 __var_AssertType( p_obj, psz_name, VLC_VAR_INTEGER );
325 if( !__var_Get( p_obj, psz_name, &val ) )
332 * Get a boolean value
334 * \param p_obj The object that holds the variable
335 * \param psz_name The name of the variable
338 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
340 vlc_value_t val; val.b_bool = false;
342 __var_AssertType( p_obj, psz_name, VLC_VAR_BOOL );
343 if( !__var_Get( p_obj, psz_name, &val ) )
352 * \param p_obj The object that holds the variable
353 * \param psz_name The name of the variable
356 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
358 vlc_value_t val; val.i_time = 0L;
359 __var_AssertType( p_obj, psz_name, VLC_VAR_TIME );
360 if( !__var_Get( p_obj, psz_name, &val ) )
369 * \param p_obj The object that holds the variable
370 * \param psz_name The name of the variable
373 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
375 vlc_value_t val; val.f_float = 0.0;
376 __var_AssertType( p_obj, psz_name, VLC_VAR_FLOAT );
377 if( !__var_Get( p_obj, psz_name, &val ) )
386 * \param p_obj The object that holds the variable
387 * \param psz_name The name of the variable
390 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
392 vlc_value_t val; val.psz_string = NULL;
393 __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
394 if( __var_Get( p_obj, psz_name, &val ) )
397 return val.psz_string;
401 static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
404 __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
405 if( __var_Get( p_obj, psz_name, &val ) )
407 if( *val.psz_string )
408 return val.psz_string;
409 free( val.psz_string );
415 * __var_GetInteger() with automatic casting
417 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
419 * __var_GetBool() with automatic casting
421 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
423 * __var_GetTime() with automatic casting
425 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
427 * __var_GetFloat() with automatic casting
429 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
431 * __var_GetString() with automatic casting
433 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
434 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
439 * Increment an integer variable
440 * \param p_obj the object that holds the variable
441 * \param psz_name the name of the variable
443 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
445 int i_val = __var_GetInteger( p_obj, psz_name );
446 __var_SetInteger( p_obj, psz_name, ++i_val );
448 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
451 * Decrement an integer variable
452 * \param p_obj the object that holds the variable
453 * \param psz_name the name of the variable
455 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
457 int i_val = __var_GetInteger( p_obj, psz_name );
458 __var_SetInteger( p_obj, psz_name, --i_val );
460 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
463 * Create a integer variable with inherit and get its value.
465 * \param p_obj The object that holds the variable
466 * \param psz_name The name of the variable
469 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
471 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
472 return __var_GetInteger( p_obj, psz_name );
476 * Create a boolean variable with inherit and get its value.
478 * \param p_obj The object that holds the variable
479 * \param psz_name The name of the variable
482 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
484 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
485 return __var_GetBool( p_obj, psz_name );
489 * Create a time variable with inherit and get its value.
491 * \param p_obj The object that holds the variable
492 * \param psz_name The name of the variable
495 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
497 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
498 return __var_GetTime( p_obj, psz_name );
502 * Create a float variable with inherit and get its value.
504 * \param p_obj The object that holds the variable
505 * \param psz_name The name of the variable
508 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
510 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
511 return __var_GetFloat( p_obj, psz_name );
515 * Create a string variable with inherit and get its value.
517 * \param p_obj The object that holds the variable
518 * \param psz_name The name of the variable
521 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
522 const char *psz_name )
524 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
525 return __var_GetString( p_obj, psz_name );
529 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
530 const char *psz_name )
532 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
533 return __var_GetNonEmptyString( p_obj, psz_name );
537 * __var_CreateGetInteger() with automatic casting
539 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
541 * __var_CreateGetBool() with automatic casting
543 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
545 * __var_CreateGetTime() with automatic casting
547 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
549 * __var_CreateGetFloat() with automatic casting
551 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
553 * __var_CreateGetString() with automatic casting
555 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
556 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
559 * Create a integer command variable with inherit and get its value.
561 * \param p_obj The object that holds the variable
562 * \param psz_name The name of the variable
565 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
567 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
568 | VLC_VAR_ISCOMMAND );
569 return __var_GetInteger( p_obj, psz_name );
573 * Create a boolean command variable with inherit and get its value.
575 * \param p_obj The object that holds the variable
576 * \param psz_name The name of the variable
579 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
581 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
582 | VLC_VAR_ISCOMMAND );
583 return __var_GetBool( p_obj, psz_name );
587 * Create a time command variable with inherit and get its value.
589 * \param p_obj The object that holds the variable
590 * \param psz_name The name of the variable
593 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
595 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
596 | VLC_VAR_ISCOMMAND );
597 return __var_GetTime( p_obj, psz_name );
601 * Create a float command variable with inherit and get its value.
603 * \param p_obj The object that holds the variable
604 * \param psz_name The name of the variable
607 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
609 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
610 | VLC_VAR_ISCOMMAND );
611 return __var_GetFloat( p_obj, psz_name );
615 * Create a string command variable with inherit and get its value.
617 * \param p_obj The object that holds the variable
618 * \param psz_name The name of the variable
621 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
622 const char *psz_name )
624 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
625 | VLC_VAR_ISCOMMAND );
626 return __var_GetString( p_obj, psz_name );
630 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
631 const char *psz_name )
633 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
634 | VLC_VAR_ISCOMMAND );
635 return __var_GetNonEmptyString( p_obj, psz_name );
639 * __var_CreateGetInteger() with automatic casting
641 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
643 * __var_CreateGetBoolCommand() with automatic casting
645 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
647 * __var_CreateGetTimeCommand() with automatic casting
649 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
651 * __var_CreateGetFloat() with automatic casting
653 #define var_CreateGetFloatCommand(a,b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
655 * __var_CreateGetStringCommand() with automatic casting
657 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
658 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
662 #endif /* _VLC_VARIABLES_H */