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 #if !defined( __LIBVLC__ )
26 #error You are not libvlc or one of its plugins. You cannot include this file
30 * \defgroup variables Variables
32 * Functions for using the object variables in vlc.
34 * Vlc have a very powerful "object variable" infrastructure useful
40 /*****************************************************************************
41 * Variable types - probably very incomplete
42 *****************************************************************************/
43 #define VLC_VAR_TYPE 0x00ff
44 #define VLC_VAR_FLAGS 0xff00
46 /** \defgroup var_flags Additive flags
47 * These flags are added to the type field of the variable. Most as a result of
48 * a __var_Change() call, but some may be added at creation time
51 #define VLC_VAR_HASCHOICE 0x0100
52 #define VLC_VAR_HASMIN 0x0200
53 #define VLC_VAR_HASMAX 0x0400
54 #define VLC_VAR_HASSTEP 0x0800
56 #define VLC_VAR_ISCOMMAND 0x2000
59 #define VLC_VAR_DOINHERIT 0x8000
63 * \defgroup var_action Variable actions
64 * These are the different actions that can be used with __var_Change().
65 * The parameters given are the meaning of the two last parameters of
66 * __var_Change() when this action is being used.
71 * Set the minimum value of this variable
72 * \param p_val The new minimum value
73 * \param p_val2 Unused
75 #define VLC_VAR_SETMIN 0x0010
77 * Set the maximum value of this variable
78 * \param p_val The new maximum value
79 * \param p_val2 Unused
81 #define VLC_VAR_SETMAX 0x0011
82 #define VLC_VAR_SETSTEP 0x0012
85 * Set the value of this variable without triggering any callbacks
86 * \param p_val The new value
87 * \param p_val2 Unused
89 #define VLC_VAR_SETVALUE 0x0013
91 #define VLC_VAR_SETTEXT 0x0014
92 #define VLC_VAR_GETTEXT 0x0015
94 #define VLC_VAR_ADDCHOICE 0x0020
95 #define VLC_VAR_DELCHOICE 0x0021
96 #define VLC_VAR_CLEARCHOICES 0x0022
97 #define VLC_VAR_SETDEFAULT 0x0023
98 #define VLC_VAR_GETCHOICES 0x0024
99 #define VLC_VAR_FREECHOICES 0x0025
100 #define VLC_VAR_GETLIST 0x0026
101 #define VLC_VAR_FREELIST 0x0027
102 #define VLC_VAR_CHOICESCOUNT 0x0028
104 #define VLC_VAR_INHERITVALUE 0x0030
105 #define VLC_VAR_TRIGGER_CALLBACKS 0x0035
108 /*****************************************************************************
110 *****************************************************************************/
111 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
112 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
114 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
116 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) );
117 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
118 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
120 #define var_OptionParse(a,b) __var_OptionParse( VLC_OBJECT( a ) , b )
121 VLC_EXPORT( void, __var_OptionParse, ( vlc_object_t *, const char * ) );
124 * __var_Create() with automatic casting.
126 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
128 * __var_Destroy() with automatic casting
130 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
133 * __var_Change() with automatic casting
135 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
138 * __var_Type() with automatic casting
140 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
142 * __var_Set() with automatic casting
144 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
146 * __var_Get() with automatic casting
148 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
150 /*****************************************************************************
152 *****************************************************************************
153 * int MyCallback( vlc_object_t *p_this,
154 * char const *psz_variable,
155 * vlc_value_t oldvalue,
156 * vlc_value_t newvalue,
158 *****************************************************************************/
159 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
160 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
163 * __var_AddCallback() with automatic casting
165 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
168 * __var_DelCallback() with automatic casting
170 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
172 /*****************************************************************************
174 *****************************************************************************/
177 * Set the value of an integer variable
179 * \param p_obj The object that holds the variable
180 * \param psz_name The name of the variable
181 * \param i The new integer value of this variable
183 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
187 return __var_Set( p_obj, psz_name, val );
189 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
191 * Set the value of an boolean variable
193 * \param p_obj The object that holds the variable
194 * \param psz_name The name of the variable
195 * \param b The new boolean value of this variable
197 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, vlc_bool_t b )
201 return __var_Set( p_obj, psz_name, val );
205 * Set the value of a time variable
207 * \param p_obj The object that holds the variable
208 * \param psz_name The name of the variable
209 * \param i The new time value of this variable
211 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
215 return __var_Set( p_obj, psz_name, val );
219 * Set the value of a float variable
221 * \param p_obj The object that holds the variable
222 * \param psz_name The name of the variable
223 * \param f The new float value of this variable
225 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
229 return __var_Set( p_obj, psz_name, val );
233 * Set the value of a string variable
235 * \param p_obj The object that holds the variable
236 * \param psz_name The name of the variable
237 * \param psz_string The new string value of this variable
239 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
242 val.psz_string = (char *)psz_string;
243 return __var_Set( p_obj, psz_name, val );
247 * Trigger the callbacks on a void variable
249 * \param p_obj The object that holds the variable
250 * \param psz_name The name of the variable
252 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
255 val.b_bool = VLC_TRUE;
256 return __var_Set( p_obj, psz_name, val );
258 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
261 * __var_SetBool() with automatic casting
263 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
266 * __var_SetTime() with automatic casting
268 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
270 * __var_SetFloat() with automatic casting
272 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
274 * __var_SetString() with automatic casting
276 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
279 * Get an integer value
281 * \param p_obj The object that holds the variable
282 * \param psz_name The name of the variable
284 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
286 vlc_value_t val;val.i_int = 0;
287 if( !__var_Get( p_obj, psz_name, &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
299 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
301 vlc_value_t val; val.b_bool = VLC_FALSE;
302 if( !__var_Get( p_obj, psz_name, &val ) )
311 * \param p_obj The object that holds the variable
312 * \param psz_name The name of the variable
314 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
316 vlc_value_t val; val.i_time = 0L;
317 if( !__var_Get( p_obj, psz_name, &val ) )
326 * \param p_obj The object that holds the variable
327 * \param psz_name The name of the variable
329 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
331 vlc_value_t val; val.f_float = 0.0;
332 if( !__var_Get( p_obj, psz_name, &val ) )
341 * \param p_obj The object that holds the variable
342 * \param psz_name The name of the variable
344 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
346 vlc_value_t val; val.psz_string = NULL;
347 if( !__var_Get( p_obj, psz_name, &val ) )
348 return val.psz_string;
353 static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
356 if (__var_Get (obj, name, &val))
359 return val.psz_string;
360 free (val.psz_string);
366 * __var_GetInteger() with automatic casting
368 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
370 * __var_GetBool() with automatic casting
372 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
374 * __var_GetTime() with automatic casting
376 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
378 * __var_GetFloat() with automatic casting
380 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
382 * __var_GetString() with automatic casting
384 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
385 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
390 * Increment an integer variable
391 * \param p_obj the object that holds the variable
392 * \param psz_name the name of the variable
394 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
396 int i_val = __var_GetInteger( p_obj, psz_name );
397 __var_SetInteger( p_obj, psz_name, ++i_val );
399 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
402 * Decrement an integer variable
403 * \param p_obj the object that holds the variable
404 * \param psz_name the name of the variable
406 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
408 int i_val = __var_GetInteger( p_obj, psz_name );
409 __var_SetInteger( p_obj, psz_name, --i_val );
411 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
414 * Create a integer variable with inherit and get its value.
416 * \param p_obj The object that holds the variable
417 * \param psz_name The name of the variable
419 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
421 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
422 return __var_GetInteger( p_obj, psz_name );
426 * Create a boolean variable with inherit and get its value.
428 * \param p_obj The object that holds the variable
429 * \param psz_name The name of the variable
431 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
433 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
434 return __var_GetBool( p_obj, psz_name );
438 * Create a time variable with inherit and get its value.
440 * \param p_obj The object that holds the variable
441 * \param psz_name The name of the variable
443 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
445 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
446 return __var_GetTime( p_obj, psz_name );
450 * Create a float variable with inherit and get its value.
452 * \param p_obj The object that holds the variable
453 * \param psz_name The name of the variable
455 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
457 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
458 return __var_GetFloat( p_obj, psz_name );
462 * Create a string variable with inherit and get its value.
464 * \param p_obj The object that holds the variable
465 * \param psz_name The name of the variable
467 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
468 const char *psz_name )
470 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
471 return __var_GetString( p_obj, psz_name );
474 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
475 const char *psz_name )
477 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
478 return __var_GetNonEmptyString( p_obj, psz_name );
482 * __var_CreateGetInteger() with automatic casting
484 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
486 * __var_CreateGetBool() with automatic casting
488 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
490 * __var_CreateGetTime() with automatic casting
492 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
494 * __var_CreateGetFloat() with automatic casting
496 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
498 * __var_CreateGetString() with automatic casting
500 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
501 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
504 * Create a integer command variable with inherit and get its value.
506 * \param p_obj The object that holds the variable
507 * \param psz_name The name of the variable
509 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
511 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
512 | VLC_VAR_ISCOMMAND );
513 return __var_GetInteger( p_obj, psz_name );
517 * Create a boolean command variable with inherit and get its value.
519 * \param p_obj The object that holds the variable
520 * \param psz_name The name of the variable
522 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
524 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
525 | VLC_VAR_ISCOMMAND );
526 return __var_GetBool( p_obj, psz_name );
530 * Create a time command variable with inherit and get its value.
532 * \param p_obj The object that holds the variable
533 * \param psz_name The name of the variable
535 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
537 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
538 | VLC_VAR_ISCOMMAND );
539 return __var_GetTime( p_obj, psz_name );
543 * Create a float command variable with inherit and get its value.
545 * \param p_obj The object that holds the variable
546 * \param psz_name The name of the variable
548 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
550 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
551 | VLC_VAR_ISCOMMAND );
552 return __var_GetFloat( p_obj, psz_name );
556 * Create a string command variable with inherit and get its value.
558 * \param p_obj The object that holds the variable
559 * \param psz_name The name of the variable
561 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
562 const char *psz_name )
564 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
565 | VLC_VAR_ISCOMMAND );
566 return __var_GetString( p_obj, psz_name );
569 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
570 const char *psz_name )
572 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
573 | VLC_VAR_ISCOMMAND );
574 return __var_GetNonEmptyString( p_obj, psz_name );
578 * __var_CreateGetInteger() with automatic casting
580 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
582 * __var_CreateGetBoolCommand() with automatic casting
584 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
586 * __var_CreateGetTimeCommand() with automatic casting
588 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
590 * __var_CreateGetFloat() with automatic casting
592 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
594 * __var_CreateGetStringCommand() with automatic casting
596 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
597 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)