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_FLAGS 0xff00
50 /** \defgroup var_flags Additive flags
51 * These flags are added to the type field of the variable. Most as a result of
52 * a __var_Change() call, but some may be added at creation time
55 #define VLC_VAR_HASCHOICE 0x0100
56 #define VLC_VAR_HASMIN 0x0200
57 #define VLC_VAR_HASMAX 0x0400
58 #define VLC_VAR_HASSTEP 0x0800
60 #define VLC_VAR_ISCOMMAND 0x2000
63 #define VLC_VAR_DOINHERIT 0x8000
67 * \defgroup var_action Variable actions
68 * These are the different actions that can be used with __var_Change().
69 * The parameters given are the meaning of the two last parameters of
70 * __var_Change() when this action is being used.
75 * Set the minimum value of this variable
76 * \param p_val The new minimum value
77 * \param p_val2 Unused
79 #define VLC_VAR_SETMIN 0x0010
81 * Set the maximum value of this variable
82 * \param p_val The new maximum value
83 * \param p_val2 Unused
85 #define VLC_VAR_SETMAX 0x0011
86 #define VLC_VAR_SETSTEP 0x0012
89 * Set the value of this variable without triggering any callbacks
90 * \param p_val The new value
91 * \param p_val2 Unused
93 #define VLC_VAR_SETVALUE 0x0013
95 #define VLC_VAR_SETTEXT 0x0014
96 #define VLC_VAR_GETTEXT 0x0015
98 #define VLC_VAR_GETMIN 0x0016
99 #define VLC_VAR_GETMAX 0x0017
100 #define VLC_VAR_GETSTEP 0x0018
102 #define VLC_VAR_ADDCHOICE 0x0020
103 #define VLC_VAR_DELCHOICE 0x0021
104 #define VLC_VAR_CLEARCHOICES 0x0022
105 #define VLC_VAR_SETDEFAULT 0x0023
106 #define VLC_VAR_GETCHOICES 0x0024
107 #define VLC_VAR_FREECHOICES 0x0025
108 #define VLC_VAR_GETLIST 0x0026
109 #define VLC_VAR_FREELIST 0x0027
110 #define VLC_VAR_CHOICESCOUNT 0x0028
112 #define VLC_VAR_INHERITVALUE 0x0030
113 #define VLC_VAR_TRIGGER_CALLBACKS 0x0035
115 #define VLC_VAR_SETISCOMMAND 0x0040
118 /*****************************************************************************
120 *****************************************************************************/
121 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
122 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
124 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
126 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
127 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
128 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
130 #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
131 VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
133 VLC_EXPORT( vlc_mutex_t *, var_AcquireMutex, ( const char * ) LIBVLC_USED );
136 __attribute__((unused))
137 __attribute__((noinline))
138 __attribute__((error("variable mutex name leaks memory at run-time")))
139 const char *nonconst_mutex_name( const char *str )
144 # define check_named_mutex( m ) \
145 (__builtin_constant_p(m) ? m : nonconst_mutex_name(m))
147 # define check_named_mutex( m ) (m)
150 #define var_AcquireMutex( n ) var_AcquireMutex(check_named_mutex(n))
153 * __var_Create() with automatic casting.
155 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
157 * __var_Destroy() with automatic casting
159 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
162 * __var_Change() with automatic casting
164 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
167 * __var_Type() with automatic casting
169 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
171 * __var_Set() with automatic casting
173 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
175 * __var_Get() with automatic casting
177 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
179 /*****************************************************************************
181 *****************************************************************************
182 * int MyCallback( vlc_object_t *p_this,
183 * char const *psz_variable,
184 * vlc_value_t oldvalue,
185 * vlc_value_t newvalue,
187 *****************************************************************************/
188 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
189 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
190 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
193 * __var_AddCallback() with automatic casting
195 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
198 * __var_DelCallback() with automatic casting
200 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
203 * __var_TriggerCallback() with automatic casting
205 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
207 /*****************************************************************************
209 *****************************************************************************/
212 * Set the value of an integer variable
214 * \param p_obj The object that holds the variable
215 * \param psz_name The name of the variable
216 * \param i The new integer value of this variable
218 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
222 return __var_Set( p_obj, psz_name, val );
224 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
226 * Set the value of an boolean variable
228 * \param p_obj The object that holds the variable
229 * \param psz_name The name of the variable
230 * \param b The new boolean value of this variable
232 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
236 return __var_Set( p_obj, psz_name, val );
240 * Set the value of a time variable
242 * \param p_obj The object that holds the variable
243 * \param psz_name The name of the variable
244 * \param i The new time value of this variable
246 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
250 return __var_Set( p_obj, psz_name, val );
254 * Set the value of a float variable
256 * \param p_obj The object that holds the variable
257 * \param psz_name The name of the variable
258 * \param f The new float value of this variable
260 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
264 return __var_Set( p_obj, psz_name, val );
268 * Set the value of a string variable
270 * \param p_obj The object that holds the variable
271 * \param psz_name The name of the variable
272 * \param psz_string The new string value of this variable
274 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
277 val.psz_string = (char *)psz_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 return __var_Set( p_obj, psz_name, val );
293 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
296 * __var_SetBool() with automatic casting
298 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
301 * __var_SetTime() with automatic casting
303 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
305 * __var_SetFloat() with automatic casting
307 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
309 * __var_SetString() with automatic casting
311 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
314 * Get an integer value
316 * \param p_obj The object that holds the variable
317 * \param psz_name The name of the variable
320 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
322 vlc_value_t val;val.i_int = 0;
323 if( !__var_Get( p_obj, psz_name, &val ) )
330 * Get a boolean value
332 * \param p_obj The object that holds the variable
333 * \param psz_name The name of the variable
336 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
338 vlc_value_t val; val.b_bool = false;
339 if( !__var_Get( p_obj, psz_name, &val ) )
348 * \param p_obj The object that holds the variable
349 * \param psz_name The name of the variable
352 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
354 vlc_value_t val; val.i_time = 0L;
355 if( !__var_Get( p_obj, psz_name, &val ) )
364 * \param p_obj The object that holds the variable
365 * \param psz_name The name of the variable
368 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
370 vlc_value_t val; val.f_float = 0.0;
371 if( !__var_Get( p_obj, psz_name, &val ) )
380 * \param p_obj The object that holds the variable
381 * \param psz_name The name of the variable
384 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
386 vlc_value_t val; val.psz_string = NULL;
387 if( __var_Get( p_obj, psz_name, &val ) )
390 return val.psz_string;
394 static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
397 if( __var_Get( obj, name, &val ) )
399 if( *val.psz_string )
400 return val.psz_string;
401 free( val.psz_string );
407 * __var_GetInteger() with automatic casting
409 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
411 * __var_GetBool() with automatic casting
413 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
415 * __var_GetTime() with automatic casting
417 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
419 * __var_GetFloat() with automatic casting
421 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
423 * __var_GetString() with automatic casting
425 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
426 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
431 * Increment an integer variable
432 * \param p_obj the object that holds the variable
433 * \param psz_name the name of the variable
435 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
437 int i_val = __var_GetInteger( p_obj, psz_name );
438 __var_SetInteger( p_obj, psz_name, ++i_val );
440 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
443 * Decrement an integer variable
444 * \param p_obj the object that holds the variable
445 * \param psz_name the name of the variable
447 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
449 int i_val = __var_GetInteger( p_obj, psz_name );
450 __var_SetInteger( p_obj, psz_name, --i_val );
452 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
455 * Create a integer 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 int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
463 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
464 return __var_GetInteger( p_obj, psz_name );
468 * Create a boolean 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 int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
476 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
477 return __var_GetBool( p_obj, psz_name );
481 * Create a time 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 int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
489 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
490 return __var_GetTime( p_obj, psz_name );
494 * Create a float variable with inherit and get its value.
496 * \param p_obj The object that holds the variable
497 * \param psz_name The name of the variable
500 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
502 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
503 return __var_GetFloat( p_obj, psz_name );
507 * Create a string variable with inherit and get its value.
509 * \param p_obj The object that holds the variable
510 * \param psz_name The name of the variable
513 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
514 const char *psz_name )
516 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
517 return __var_GetString( p_obj, psz_name );
521 static inline char *__var_CreateGetNonEmptyString( 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_GetNonEmptyString( p_obj, psz_name );
529 * __var_CreateGetInteger() with automatic casting
531 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
533 * __var_CreateGetBool() with automatic casting
535 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
537 * __var_CreateGetTime() with automatic casting
539 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
541 * __var_CreateGetFloat() with automatic casting
543 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
545 * __var_CreateGetString() with automatic casting
547 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
548 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
551 * Create a integer command variable with inherit and get its value.
553 * \param p_obj The object that holds the variable
554 * \param psz_name The name of the variable
557 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
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 );
565 * Create a boolean command variable with inherit and get its value.
567 * \param p_obj The object that holds the variable
568 * \param psz_name The name of the variable
571 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
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 );
579 * Create a time command variable with inherit and get its value.
581 * \param p_obj The object that holds the variable
582 * \param psz_name The name of the variable
585 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
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 );
593 * Create a float command variable with inherit and get its value.
595 * \param p_obj The object that holds the variable
596 * \param psz_name The name of the variable
599 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
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 );
607 * Create a string command variable with inherit and get its value.
609 * \param p_obj The object that holds the variable
610 * \param psz_name The name of the variable
613 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
614 const char *psz_name )
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 );
622 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
623 const char *psz_name )
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 );
631 * __var_CreateGetInteger() with automatic casting
633 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
635 * __var_CreateGetBoolCommand() with automatic casting
637 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
639 * __var_CreateGetTimeCommand() with automatic casting
641 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
643 * __var_CreateGetFloat() with automatic casting
645 #define var_CreateGetFloatCommand(a,b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
647 * __var_CreateGetStringCommand() with automatic casting
649 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
650 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
654 #endif /* _VLC_VARIABLES_H */