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 ** ) );
136 VLC_EXPORT( vlc_mutex_t *, var_AcquireMutex, ( const char * ) LIBVLC_USED );
139 __attribute__((unused))
140 __attribute__((noinline))
141 __attribute__((error("variable mutex name leaks memory at run-time")))
142 const char *nonconst_mutex_name( const char *str )
147 # define check_named_mutex( m ) \
148 (__builtin_constant_p(m) ? m : nonconst_mutex_name(m))
150 # define check_named_mutex( m ) (m)
153 #define var_AcquireMutex( n ) var_AcquireMutex(check_named_mutex(n))
156 * __var_Create() with automatic casting.
158 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
160 * __var_Destroy() with automatic casting
162 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
165 * __var_Change() with automatic casting
167 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
170 * __var_Type() with automatic casting
172 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
174 * __var_Set() with automatic casting
176 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
178 * __var_Get() with automatic casting
180 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
182 /*****************************************************************************
184 *****************************************************************************
185 * int MyCallback( vlc_object_t *p_this,
186 * char const *psz_variable,
187 * vlc_value_t oldvalue,
188 * vlc_value_t newvalue,
190 *****************************************************************************/
191 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
192 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
193 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
196 * __var_AddCallback() with automatic casting
198 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
201 * __var_DelCallback() with automatic casting
203 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
206 * __var_TriggerCallback() with automatic casting
208 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
210 /*****************************************************************************
212 *****************************************************************************/
215 * This function assert the variable is of the expected type or it
218 static inline void __var_AssertType( vlc_object_t *p_obj, const char *psz_name,
221 const int i_type = __var_Type( p_obj, psz_name ) & VLC_VAR_CLASS;
222 assert( i_type == 0 || i_type == (i_expected&VLC_VAR_CLASS) );
226 * Set the value of an integer variable
228 * \param p_obj The object that holds the variable
229 * \param psz_name The name of the variable
230 * \param i The new integer value of this variable
232 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
236 __var_AssertType( p_obj, psz_name, VLC_VAR_INTEGER );
237 return __var_Set( p_obj, psz_name, val );
239 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
241 * Set the value of an boolean variable
243 * \param p_obj The object that holds the variable
244 * \param psz_name The name of the variable
245 * \param b The new boolean value of this variable
247 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
251 __var_AssertType( p_obj, psz_name, VLC_VAR_BOOL );
252 return __var_Set( p_obj, psz_name, val );
256 * Set the value of a time variable
258 * \param p_obj The object that holds the variable
259 * \param psz_name The name of the variable
260 * \param i The new time value of this variable
262 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
266 __var_AssertType( p_obj, psz_name, VLC_VAR_TIME );
267 return __var_Set( p_obj, psz_name, val );
271 * Set the value of a float variable
273 * \param p_obj The object that holds the variable
274 * \param psz_name The name of the variable
275 * \param f The new float value of this variable
277 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
281 __var_AssertType( p_obj, psz_name, VLC_VAR_FLOAT );
282 return __var_Set( p_obj, psz_name, val );
286 * Set the value of a string variable
288 * \param p_obj The object that holds the variable
289 * \param psz_name The name of the variable
290 * \param psz_string The new string value of this variable
292 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
295 val.psz_string = (char *)psz_string;
296 __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
297 return __var_Set( p_obj, psz_name, val );
301 * Trigger the callbacks on a void variable
303 * \param p_obj The object that holds the variable
304 * \param psz_name The name of the variable
306 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
310 __var_AssertType( p_obj, psz_name, VLC_VAR_VOID );
311 return __var_Set( p_obj, psz_name, val );
313 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
316 * __var_SetBool() with automatic casting
318 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
321 * __var_SetTime() with automatic casting
323 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
325 * __var_SetFloat() with automatic casting
327 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
329 * __var_SetString() with automatic casting
331 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
334 * Get an integer value
336 * \param p_obj The object that holds the variable
337 * \param psz_name The name of the variable
340 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
342 vlc_value_t val;val.i_int = 0;
343 __var_AssertType( p_obj, psz_name, VLC_VAR_INTEGER );
344 if( !__var_Get( p_obj, psz_name, &val ) )
351 * Get a boolean value
353 * \param p_obj The object that holds the variable
354 * \param psz_name The name of the variable
357 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
359 vlc_value_t val; val.b_bool = false;
361 __var_AssertType( p_obj, psz_name, VLC_VAR_BOOL );
362 if( !__var_Get( p_obj, psz_name, &val ) )
371 * \param p_obj The object that holds the variable
372 * \param psz_name The name of the variable
375 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
377 vlc_value_t val; val.i_time = 0L;
378 __var_AssertType( p_obj, psz_name, VLC_VAR_TIME );
379 if( !__var_Get( p_obj, psz_name, &val ) )
388 * \param p_obj The object that holds the variable
389 * \param psz_name The name of the variable
392 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
394 vlc_value_t val; val.f_float = 0.0;
395 __var_AssertType( p_obj, psz_name, VLC_VAR_FLOAT );
396 if( !__var_Get( p_obj, psz_name, &val ) )
405 * \param p_obj The object that holds the variable
406 * \param psz_name The name of the variable
409 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
411 vlc_value_t val; val.psz_string = NULL;
412 __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
413 if( __var_Get( p_obj, psz_name, &val ) )
416 return val.psz_string;
420 static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
423 __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
424 if( __var_Get( p_obj, psz_name, &val ) )
426 if( *val.psz_string )
427 return val.psz_string;
428 free( val.psz_string );
434 * __var_GetInteger() with automatic casting
436 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
438 * __var_GetBool() with automatic casting
440 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
442 * __var_GetTime() with automatic casting
444 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
446 * __var_GetFloat() with automatic casting
448 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
450 * __var_GetString() with automatic casting
452 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
453 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
458 * Increment an integer variable
459 * \param p_obj the object that holds the variable
460 * \param psz_name the name of the variable
462 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
464 int i_val = __var_GetInteger( p_obj, psz_name );
465 __var_SetInteger( p_obj, psz_name, ++i_val );
467 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
470 * Decrement an integer variable
471 * \param p_obj the object that holds the variable
472 * \param psz_name the name of the variable
474 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
476 int i_val = __var_GetInteger( p_obj, psz_name );
477 __var_SetInteger( p_obj, psz_name, --i_val );
479 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
482 * Create a integer variable with inherit and get its value.
484 * \param p_obj The object that holds the variable
485 * \param psz_name The name of the variable
488 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
490 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
491 return __var_GetInteger( p_obj, psz_name );
495 * Create a boolean variable with inherit and get its value.
497 * \param p_obj The object that holds the variable
498 * \param psz_name The name of the variable
501 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
503 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
504 return __var_GetBool( p_obj, psz_name );
508 * Create a time variable with inherit and get its value.
510 * \param p_obj The object that holds the variable
511 * \param psz_name The name of the variable
514 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
516 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
517 return __var_GetTime( p_obj, psz_name );
521 * Create a float variable with inherit and get its value.
523 * \param p_obj The object that holds the variable
524 * \param psz_name The name of the variable
527 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
529 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
530 return __var_GetFloat( p_obj, psz_name );
534 * Create a string variable with inherit and get its value.
536 * \param p_obj The object that holds the variable
537 * \param psz_name The name of the variable
540 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
541 const char *psz_name )
543 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
544 return __var_GetString( p_obj, psz_name );
548 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
549 const char *psz_name )
551 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
552 return __var_GetNonEmptyString( p_obj, psz_name );
556 * __var_CreateGetInteger() with automatic casting
558 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
560 * __var_CreateGetBool() with automatic casting
562 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
564 * __var_CreateGetTime() with automatic casting
566 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
568 * __var_CreateGetFloat() with automatic casting
570 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
572 * __var_CreateGetString() with automatic casting
574 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
575 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
578 * Create a integer command variable with inherit and get its value.
580 * \param p_obj The object that holds the variable
581 * \param psz_name The name of the variable
584 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
586 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
587 | VLC_VAR_ISCOMMAND );
588 return __var_GetInteger( p_obj, psz_name );
592 * Create a boolean command variable with inherit and get its value.
594 * \param p_obj The object that holds the variable
595 * \param psz_name The name of the variable
598 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
600 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
601 | VLC_VAR_ISCOMMAND );
602 return __var_GetBool( p_obj, psz_name );
606 * Create a time command variable with inherit and get its value.
608 * \param p_obj The object that holds the variable
609 * \param psz_name The name of the variable
612 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
614 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
615 | VLC_VAR_ISCOMMAND );
616 return __var_GetTime( p_obj, psz_name );
620 * Create a float command variable with inherit and get its value.
622 * \param p_obj The object that holds the variable
623 * \param psz_name The name of the variable
626 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
628 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
629 | VLC_VAR_ISCOMMAND );
630 return __var_GetFloat( p_obj, psz_name );
634 * Create a string command variable with inherit and get its value.
636 * \param p_obj The object that holds the variable
637 * \param psz_name The name of the variable
640 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
641 const char *psz_name )
643 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
644 | VLC_VAR_ISCOMMAND );
645 return __var_GetString( p_obj, psz_name );
649 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
650 const char *psz_name )
652 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
653 | VLC_VAR_ISCOMMAND );
654 return __var_GetNonEmptyString( p_obj, psz_name );
658 * __var_CreateGetInteger() with automatic casting
660 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
662 * __var_CreateGetBoolCommand() with automatic casting
664 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
666 * __var_CreateGetTimeCommand() with automatic casting
668 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
670 * __var_CreateGetFloat() with automatic casting
672 #define var_CreateGetFloatCommand(a,b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
674 * __var_CreateGetStringCommand() with automatic casting
676 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
677 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
681 #endif /* _VLC_VARIABLES_H */