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
29 #ifndef _VLC_VARIABLES_H
30 #define _VLC_VARIABLES_H 1
33 * \defgroup variables Variables
35 * Functions for using the object variables in vlc.
37 * Vlc have a very powerful "object variable" infrastructure useful
43 /*****************************************************************************
44 * Variable types - probably very incomplete
45 *****************************************************************************/
46 #define VLC_VAR_TYPE 0x00ff
47 #define VLC_VAR_FLAGS 0xff00
49 /** \defgroup var_flags Additive flags
50 * These flags are added to the type field of the variable. Most as a result of
51 * a __var_Change() call, but some may be added at creation time
54 #define VLC_VAR_HASCHOICE 0x0100
55 #define VLC_VAR_HASMIN 0x0200
56 #define VLC_VAR_HASMAX 0x0400
57 #define VLC_VAR_HASSTEP 0x0800
59 #define VLC_VAR_ISCOMMAND 0x2000
62 #define VLC_VAR_DOINHERIT 0x8000
66 * \defgroup var_action Variable actions
67 * These are the different actions that can be used with __var_Change().
68 * The parameters given are the meaning of the two last parameters of
69 * __var_Change() when this action is being used.
74 * Set the minimum value of this variable
75 * \param p_val The new minimum value
76 * \param p_val2 Unused
78 #define VLC_VAR_SETMIN 0x0010
80 * Set the maximum value of this variable
81 * \param p_val The new maximum value
82 * \param p_val2 Unused
84 #define VLC_VAR_SETMAX 0x0011
85 #define VLC_VAR_SETSTEP 0x0012
88 * Set the value of this variable without triggering any callbacks
89 * \param p_val The new value
90 * \param p_val2 Unused
92 #define VLC_VAR_SETVALUE 0x0013
94 #define VLC_VAR_SETTEXT 0x0014
95 #define VLC_VAR_GETTEXT 0x0015
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_OptionParse(a,b) __var_OptionParse( VLC_OBJECT( a ) , b )
124 VLC_EXPORT( void, __var_OptionParse, ( vlc_object_t *, const char * ) );
126 #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
127 VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
130 * __var_Create() with automatic casting.
132 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
134 * __var_Destroy() with automatic casting
136 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
139 * __var_Change() with automatic casting
141 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
144 * __var_Type() with automatic casting
146 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
148 * __var_Set() with automatic casting
150 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
152 * __var_Get() with automatic casting
154 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
156 /*****************************************************************************
158 *****************************************************************************
159 * int MyCallback( vlc_object_t *p_this,
160 * char const *psz_variable,
161 * vlc_value_t oldvalue,
162 * vlc_value_t newvalue,
164 *****************************************************************************/
165 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
166 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
167 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
170 * __var_AddCallback() with automatic casting
172 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
175 * __var_DelCallback() with automatic casting
177 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
180 * __var_TriggerCallback() with automatic casting
182 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
184 /*****************************************************************************
186 *****************************************************************************/
189 * Set the value of an integer variable
191 * \param p_obj The object that holds the variable
192 * \param psz_name The name of the variable
193 * \param i The new integer value of this variable
195 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
199 return __var_Set( p_obj, psz_name, val );
201 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
203 * Set the value of an boolean variable
205 * \param p_obj The object that holds the variable
206 * \param psz_name The name of the variable
207 * \param b The new boolean value of this variable
209 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, vlc_bool_t b )
213 return __var_Set( p_obj, psz_name, val );
217 * Set the value of a time variable
219 * \param p_obj The object that holds the variable
220 * \param psz_name The name of the variable
221 * \param i The new time value of this variable
223 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
227 return __var_Set( p_obj, psz_name, val );
231 * Set the value of a float variable
233 * \param p_obj The object that holds the variable
234 * \param psz_name The name of the variable
235 * \param f The new float value of this variable
237 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
241 return __var_Set( p_obj, psz_name, val );
245 * Set the value of a string variable
247 * \param p_obj The object that holds the variable
248 * \param psz_name The name of the variable
249 * \param psz_string The new string value of this variable
251 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
254 val.psz_string = (char *)psz_string;
255 return __var_Set( p_obj, psz_name, val );
259 * Trigger the callbacks on a void variable
261 * \param p_obj The object that holds the variable
262 * \param psz_name The name of the variable
264 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
267 val.b_bool = VLC_TRUE;
268 return __var_Set( p_obj, psz_name, val );
270 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
273 * __var_SetBool() with automatic casting
275 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
278 * __var_SetTime() with automatic casting
280 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
282 * __var_SetFloat() with automatic casting
284 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
286 * __var_SetString() with automatic casting
288 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
291 * Get an integer value
293 * \param p_obj The object that holds the variable
294 * \param psz_name The name of the variable
296 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
298 vlc_value_t val;val.i_int = 0;
299 if( !__var_Get( p_obj, psz_name, &val ) )
306 * Get a boolean value
308 * \param p_obj The object that holds the variable
309 * \param psz_name The name of the variable
311 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
313 vlc_value_t val; val.b_bool = VLC_FALSE;
314 if( !__var_Get( p_obj, psz_name, &val ) )
323 * \param p_obj The object that holds the variable
324 * \param psz_name The name of the variable
326 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
328 vlc_value_t val; val.i_time = 0L;
329 if( !__var_Get( p_obj, psz_name, &val ) )
338 * \param p_obj The object that holds the variable
339 * \param psz_name The name of the variable
341 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
343 vlc_value_t val; val.f_float = 0.0;
344 if( !__var_Get( p_obj, psz_name, &val ) )
353 * \param p_obj The object that holds the variable
354 * \param psz_name The name of the variable
356 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
358 vlc_value_t val; val.psz_string = NULL;
359 if( !__var_Get( p_obj, psz_name, &val ) )
360 return val.psz_string;
365 static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
368 if( __var_Get( obj, name, &val ) )
370 if( *val.psz_string )
371 return val.psz_string;
372 free( val.psz_string );
378 * __var_GetInteger() with automatic casting
380 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
382 * __var_GetBool() with automatic casting
384 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
386 * __var_GetTime() with automatic casting
388 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
390 * __var_GetFloat() with automatic casting
392 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
394 * __var_GetString() with automatic casting
396 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
397 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
402 * Increment 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_IncInteger( 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_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
414 * Decrement an integer variable
415 * \param p_obj the object that holds the variable
416 * \param psz_name the name of the variable
418 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
420 int i_val = __var_GetInteger( p_obj, psz_name );
421 __var_SetInteger( p_obj, psz_name, --i_val );
423 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
426 * Create a integer 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_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
433 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
434 return __var_GetInteger( p_obj, psz_name );
438 * Create a boolean 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 int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
445 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
446 return __var_GetBool( p_obj, psz_name );
450 * Create a time 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 int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
457 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
458 return __var_GetTime( p_obj, psz_name );
462 * Create a float 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 float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
469 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
470 return __var_GetFloat( p_obj, psz_name );
474 * Create a string variable with inherit and get its value.
476 * \param p_obj The object that holds the variable
477 * \param psz_name The name of the variable
479 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
480 const char *psz_name )
482 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
483 return __var_GetString( p_obj, psz_name );
486 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
487 const char *psz_name )
489 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
490 return __var_GetNonEmptyString( p_obj, psz_name );
494 * __var_CreateGetInteger() with automatic casting
496 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
498 * __var_CreateGetBool() with automatic casting
500 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
502 * __var_CreateGetTime() with automatic casting
504 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
506 * __var_CreateGetFloat() with automatic casting
508 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
510 * __var_CreateGetString() with automatic casting
512 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
513 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
516 * Create a integer command variable with inherit and get its value.
518 * \param p_obj The object that holds the variable
519 * \param psz_name The name of the variable
521 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
523 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
524 | VLC_VAR_ISCOMMAND );
525 return __var_GetInteger( p_obj, psz_name );
529 * Create a boolean command variable with inherit and get its value.
531 * \param p_obj The object that holds the variable
532 * \param psz_name The name of the variable
534 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
536 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
537 | VLC_VAR_ISCOMMAND );
538 return __var_GetBool( p_obj, psz_name );
542 * Create a time command variable with inherit and get its value.
544 * \param p_obj The object that holds the variable
545 * \param psz_name The name of the variable
547 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
549 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
550 | VLC_VAR_ISCOMMAND );
551 return __var_GetTime( p_obj, psz_name );
555 * Create a float command variable with inherit and get its value.
557 * \param p_obj The object that holds the variable
558 * \param psz_name The name of the variable
560 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
562 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
563 | VLC_VAR_ISCOMMAND );
564 return __var_GetFloat( p_obj, psz_name );
568 * Create a string command variable with inherit and get its value.
570 * \param p_obj The object that holds the variable
571 * \param psz_name The name of the variable
573 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
574 const char *psz_name )
576 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
577 | VLC_VAR_ISCOMMAND );
578 return __var_GetString( p_obj, psz_name );
581 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
582 const char *psz_name )
584 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
585 | VLC_VAR_ISCOMMAND );
586 return __var_GetNonEmptyString( p_obj, psz_name );
590 * __var_CreateGetInteger() with automatic casting
592 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
594 * __var_CreateGetBoolCommand() with automatic casting
596 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
598 * __var_CreateGetTimeCommand() with automatic casting
600 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
602 * __var_CreateGetFloat() with automatic casting
604 #define var_CreateGetFloatCommand(a,b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
606 * __var_CreateGetStringCommand() with automatic casting
608 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
609 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
613 #endif /* _VLC_VARIABLES_H */