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
29 * \defgroup variables Variables
31 * Functions for using the object variables in vlc.
33 * Vlc have a very powerful "object variable" infrastructure useful
39 /*****************************************************************************
40 * Variable types - probably very incomplete
41 *****************************************************************************/
42 #define VLC_VAR_TYPE 0x00ff
43 #define VLC_VAR_FLAGS 0xff00
45 /** \defgroup var_flags Additive flags
46 * These flags are added to the type field of the variable. Most as a result of
47 * a __var_Change() call, but some may be added at creation time
50 #define VLC_VAR_HASCHOICE 0x0100
51 #define VLC_VAR_HASMIN 0x0200
52 #define VLC_VAR_HASMAX 0x0400
53 #define VLC_VAR_HASSTEP 0x0800
55 #define VLC_VAR_ISCOMMAND 0x2000
58 #define VLC_VAR_DOINHERIT 0x8000
62 * \defgroup var_action Variable actions
63 * These are the different actions that can be used with __var_Change().
64 * The parameters given are the meaning of the two last parameters of
65 * __var_Change() when this action is being used.
70 * Set the minimum value of this variable
71 * \param p_val The new minimum value
72 * \param p_val2 Unused
74 #define VLC_VAR_SETMIN 0x0010
76 * Set the maximum value of this variable
77 * \param p_val The new maximum value
78 * \param p_val2 Unused
80 #define VLC_VAR_SETMAX 0x0011
81 #define VLC_VAR_SETSTEP 0x0012
84 * Set the value of this variable without triggering any callbacks
85 * \param p_val The new value
86 * \param p_val2 Unused
88 #define VLC_VAR_SETVALUE 0x0013
90 #define VLC_VAR_SETTEXT 0x0014
91 #define VLC_VAR_GETTEXT 0x0015
93 #define VLC_VAR_GETMIN 0x0016
94 #define VLC_VAR_GETMAX 0x0017
95 #define VLC_VAR_GETSTEP 0x0018
97 #define VLC_VAR_ADDCHOICE 0x0020
98 #define VLC_VAR_DELCHOICE 0x0021
99 #define VLC_VAR_CLEARCHOICES 0x0022
100 #define VLC_VAR_SETDEFAULT 0x0023
101 #define VLC_VAR_GETCHOICES 0x0024
102 #define VLC_VAR_FREECHOICES 0x0025
103 #define VLC_VAR_GETLIST 0x0026
104 #define VLC_VAR_FREELIST 0x0027
105 #define VLC_VAR_CHOICESCOUNT 0x0028
107 #define VLC_VAR_INHERITVALUE 0x0030
108 #define VLC_VAR_TRIGGER_CALLBACKS 0x0035
111 /*****************************************************************************
113 *****************************************************************************/
114 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
115 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
117 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
119 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) );
120 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
121 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
123 #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
124 VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
126 VLC_EXPORT( vlc_mutex_t *, var_AcquireMutex, ( const char * ) );
129 * __var_Create() with automatic casting.
131 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
133 * __var_Destroy() with automatic casting
135 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
138 * __var_Change() with automatic casting
140 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
143 * __var_Type() with automatic casting
145 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
147 * __var_Set() with automatic casting
149 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
151 * __var_Get() with automatic casting
153 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
155 /*****************************************************************************
157 *****************************************************************************
158 * int MyCallback( vlc_object_t *p_this,
159 * char const *psz_variable,
160 * vlc_value_t oldvalue,
161 * vlc_value_t newvalue,
163 *****************************************************************************/
164 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
165 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
166 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
169 * __var_AddCallback() with automatic casting
171 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
174 * __var_DelCallback() with automatic casting
176 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
179 * __var_TriggerCallback() with automatic casting
181 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
183 /*****************************************************************************
185 *****************************************************************************/
188 * Set the value of an integer variable
190 * \param p_obj The object that holds the variable
191 * \param psz_name The name of the variable
192 * \param i The new integer value of this variable
194 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
198 return __var_Set( p_obj, psz_name, val );
200 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
202 * Set the value of an boolean variable
204 * \param p_obj The object that holds the variable
205 * \param psz_name The name of the variable
206 * \param b The new boolean value of this variable
208 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
212 return __var_Set( p_obj, psz_name, val );
216 * Set the value of a time variable
218 * \param p_obj The object that holds the variable
219 * \param psz_name The name of the variable
220 * \param i The new time value of this variable
222 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
226 return __var_Set( p_obj, psz_name, val );
230 * Set the value of a float variable
232 * \param p_obj The object that holds the variable
233 * \param psz_name The name of the variable
234 * \param f The new float value of this variable
236 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
240 return __var_Set( p_obj, psz_name, val );
244 * Set the value of a string variable
246 * \param p_obj The object that holds the variable
247 * \param psz_name The name of the variable
248 * \param psz_string The new string value of this variable
250 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
253 val.psz_string = (char *)psz_string;
254 return __var_Set( p_obj, psz_name, val );
258 * Trigger the callbacks on a void variable
260 * \param p_obj The object that holds the variable
261 * \param psz_name The name of the variable
263 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
267 return __var_Set( p_obj, psz_name, val );
269 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
272 * __var_SetBool() with automatic casting
274 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
277 * __var_SetTime() with automatic casting
279 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
281 * __var_SetFloat() with automatic casting
283 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
285 * __var_SetString() with automatic casting
287 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
290 * Get an integer value
292 * \param p_obj The object that holds the variable
293 * \param psz_name The name of the variable
295 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
297 vlc_value_t val;val.i_int = 0;
298 if( !__var_Get( p_obj, psz_name, &val ) )
305 * Get a boolean value
307 * \param p_obj The object that holds the variable
308 * \param psz_name The name of the variable
310 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
312 vlc_value_t val; val.b_bool = false;
313 if( !__var_Get( p_obj, psz_name, &val ) )
322 * \param p_obj The object that holds the variable
323 * \param psz_name The name of the variable
325 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
327 vlc_value_t val; val.i_time = 0L;
328 if( !__var_Get( p_obj, psz_name, &val ) )
337 * \param p_obj The object that holds the variable
338 * \param psz_name The name of the variable
340 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
342 vlc_value_t val; val.f_float = 0.0;
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
355 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
357 vlc_value_t val; val.psz_string = NULL;
358 if( __var_Get( p_obj, psz_name, &val ) )
361 return val.psz_string;
364 static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
367 if( __var_Get( obj, name, &val ) )
369 if( *val.psz_string )
370 return val.psz_string;
371 free( val.psz_string );
377 * __var_GetInteger() with automatic casting
379 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
381 * __var_GetBool() with automatic casting
383 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
385 * __var_GetTime() with automatic casting
387 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
389 * __var_GetFloat() with automatic casting
391 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
393 * __var_GetString() with automatic casting
395 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
396 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
401 * Increment an integer variable
402 * \param p_obj the object that holds the variable
403 * \param psz_name the name of the variable
405 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
407 int i_val = __var_GetInteger( p_obj, psz_name );
408 __var_SetInteger( p_obj, psz_name, ++i_val );
410 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
413 * Decrement an integer variable
414 * \param p_obj the object that holds the variable
415 * \param psz_name the name of the variable
417 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
419 int i_val = __var_GetInteger( p_obj, psz_name );
420 __var_SetInteger( p_obj, psz_name, --i_val );
422 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
425 * Create a integer variable with inherit and get its value.
427 * \param p_obj The object that holds the variable
428 * \param psz_name The name of the variable
430 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
432 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
433 return __var_GetInteger( p_obj, psz_name );
437 * Create a boolean variable with inherit and get its value.
439 * \param p_obj The object that holds the variable
440 * \param psz_name The name of the variable
442 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
444 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
445 return __var_GetBool( p_obj, psz_name );
449 * Create a time variable with inherit and get its value.
451 * \param p_obj The object that holds the variable
452 * \param psz_name The name of the variable
454 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
456 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
457 return __var_GetTime( p_obj, psz_name );
461 * Create a float variable with inherit and get its value.
463 * \param p_obj The object that holds the variable
464 * \param psz_name The name of the variable
466 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
468 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
469 return __var_GetFloat( p_obj, psz_name );
473 * Create a string variable with inherit and get its value.
475 * \param p_obj The object that holds the variable
476 * \param psz_name The name of the variable
478 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
479 const char *psz_name )
481 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
482 return __var_GetString( p_obj, psz_name );
485 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
486 const char *psz_name )
488 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
489 return __var_GetNonEmptyString( p_obj, psz_name );
493 * __var_CreateGetInteger() with automatic casting
495 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
497 * __var_CreateGetBool() with automatic casting
499 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
501 * __var_CreateGetTime() with automatic casting
503 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
505 * __var_CreateGetFloat() with automatic casting
507 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
509 * __var_CreateGetString() with automatic casting
511 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
512 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
515 * Create a integer command 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
520 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
522 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
523 | VLC_VAR_ISCOMMAND );
524 return __var_GetInteger( p_obj, psz_name );
528 * Create a boolean command variable with inherit and get its value.
530 * \param p_obj The object that holds the variable
531 * \param psz_name The name of the variable
533 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
535 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
536 | VLC_VAR_ISCOMMAND );
537 return __var_GetBool( p_obj, psz_name );
541 * Create a time command variable with inherit and get its value.
543 * \param p_obj The object that holds the variable
544 * \param psz_name The name of the variable
546 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
548 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
549 | VLC_VAR_ISCOMMAND );
550 return __var_GetTime( p_obj, psz_name );
554 * Create a float command variable with inherit and get its value.
556 * \param p_obj The object that holds the variable
557 * \param psz_name The name of the variable
559 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
561 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
562 | VLC_VAR_ISCOMMAND );
563 return __var_GetFloat( p_obj, psz_name );
567 * Create a string 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
572 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
573 const char *psz_name )
575 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
576 | VLC_VAR_ISCOMMAND );
577 return __var_GetString( p_obj, psz_name );
580 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
581 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 );
589 * __var_CreateGetInteger() with automatic casting
591 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
593 * __var_CreateGetBoolCommand() with automatic casting
595 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
597 * __var_CreateGetTimeCommand() with automatic casting
599 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
601 * __var_CreateGetFloat() with automatic casting
603 #define var_CreateGetFloatCommand(a,b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
605 * __var_CreateGetStringCommand() with automatic casting
607 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
608 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
612 #endif /* _VLC_VARIABLES_H */