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 * ) );
127 * __var_Create() with automatic casting.
129 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
131 * __var_Destroy() with automatic casting
133 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
136 * __var_Change() with automatic casting
138 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
141 * __var_Type() with automatic casting
143 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
145 * __var_Set() with automatic casting
147 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
149 * __var_Get() with automatic casting
151 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
153 /*****************************************************************************
155 *****************************************************************************
156 * int MyCallback( vlc_object_t *p_this,
157 * char const *psz_variable,
158 * vlc_value_t oldvalue,
159 * vlc_value_t newvalue,
161 *****************************************************************************/
162 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
163 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
166 * __var_AddCallback() with automatic casting
168 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
171 * __var_DelCallback() with automatic casting
173 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
175 /*****************************************************************************
177 *****************************************************************************/
180 * Set the value of an integer variable
182 * \param p_obj The object that holds the variable
183 * \param psz_name The name of the variable
184 * \param i The new integer value of this variable
186 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
190 return __var_Set( p_obj, psz_name, val );
192 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
194 * Set the value of an boolean variable
196 * \param p_obj The object that holds the variable
197 * \param psz_name The name of the variable
198 * \param b The new boolean value of this variable
200 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, vlc_bool_t b )
204 return __var_Set( p_obj, psz_name, val );
208 * Set the value of a time variable
210 * \param p_obj The object that holds the variable
211 * \param psz_name The name of the variable
212 * \param i The new time value of this variable
214 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
218 return __var_Set( p_obj, psz_name, val );
222 * Set the value of a float variable
224 * \param p_obj The object that holds the variable
225 * \param psz_name The name of the variable
226 * \param f The new float value of this variable
228 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
232 return __var_Set( p_obj, psz_name, val );
236 * Set the value of a string variable
238 * \param p_obj The object that holds the variable
239 * \param psz_name The name of the variable
240 * \param psz_string The new string value of this variable
242 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
245 val.psz_string = (char *)psz_string;
246 return __var_Set( p_obj, psz_name, val );
250 * Trigger the callbacks on a void variable
252 * \param p_obj The object that holds the variable
253 * \param psz_name The name of the variable
255 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
258 val.b_bool = VLC_TRUE;
259 return __var_Set( p_obj, psz_name, val );
261 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
264 * __var_SetBool() with automatic casting
266 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
269 * __var_SetTime() with automatic casting
271 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
273 * __var_SetFloat() with automatic casting
275 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
277 * __var_SetString() with automatic casting
279 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
282 * Get an integer value
284 * \param p_obj The object that holds the variable
285 * \param psz_name The name of the variable
287 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
289 vlc_value_t val;val.i_int = 0;
290 if( !__var_Get( p_obj, psz_name, &val ) )
297 * Get a boolean value
299 * \param p_obj The object that holds the variable
300 * \param psz_name The name of the variable
302 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
304 vlc_value_t val; val.b_bool = VLC_FALSE;
305 if( !__var_Get( p_obj, psz_name, &val ) )
314 * \param p_obj The object that holds the variable
315 * \param psz_name The name of the variable
317 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
319 vlc_value_t val; val.i_time = 0L;
320 if( !__var_Get( p_obj, psz_name, &val ) )
329 * \param p_obj The object that holds the variable
330 * \param psz_name The name of the variable
332 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
334 vlc_value_t val; val.f_float = 0.0;
335 if( !__var_Get( p_obj, psz_name, &val ) )
344 * \param p_obj The object that holds the variable
345 * \param psz_name The name of the variable
347 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
349 vlc_value_t val; val.psz_string = NULL;
350 if( !__var_Get( p_obj, psz_name, &val ) )
351 return val.psz_string;
356 static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
359 if (__var_Get (obj, name, &val))
362 return val.psz_string;
363 free (val.psz_string);
369 * __var_GetInteger() with automatic casting
371 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
373 * __var_GetBool() with automatic casting
375 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
377 * __var_GetTime() with automatic casting
379 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
381 * __var_GetFloat() with automatic casting
383 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
385 * __var_GetString() with automatic casting
387 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
388 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
393 * Increment an integer variable
394 * \param p_obj the object that holds the variable
395 * \param psz_name the name of the variable
397 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
399 int i_val = __var_GetInteger( p_obj, psz_name );
400 __var_SetInteger( p_obj, psz_name, ++i_val );
402 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
405 * Decrement an integer variable
406 * \param p_obj the object that holds the variable
407 * \param psz_name the name of the variable
409 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
411 int i_val = __var_GetInteger( p_obj, psz_name );
412 __var_SetInteger( p_obj, psz_name, --i_val );
414 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
417 * Create a integer variable with inherit and get its value.
419 * \param p_obj The object that holds the variable
420 * \param psz_name The name of the variable
422 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
424 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
425 return __var_GetInteger( p_obj, psz_name );
429 * Create a boolean variable with inherit and get its value.
431 * \param p_obj The object that holds the variable
432 * \param psz_name The name of the variable
434 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
436 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
437 return __var_GetBool( p_obj, psz_name );
441 * Create a time variable with inherit and get its value.
443 * \param p_obj The object that holds the variable
444 * \param psz_name The name of the variable
446 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
448 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
449 return __var_GetTime( p_obj, psz_name );
453 * Create a float variable with inherit and get its value.
455 * \param p_obj The object that holds the variable
456 * \param psz_name The name of the variable
458 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
460 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
461 return __var_GetFloat( p_obj, psz_name );
465 * Create a string variable with inherit and get its value.
467 * \param p_obj The object that holds the variable
468 * \param psz_name The name of the variable
470 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
471 const char *psz_name )
473 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
474 return __var_GetString( p_obj, psz_name );
477 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
478 const char *psz_name )
480 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
481 return __var_GetNonEmptyString( p_obj, psz_name );
485 * __var_CreateGetInteger() with automatic casting
487 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
489 * __var_CreateGetBool() with automatic casting
491 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
493 * __var_CreateGetTime() with automatic casting
495 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
497 * __var_CreateGetFloat() with automatic casting
499 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
501 * __var_CreateGetString() with automatic casting
503 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
504 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
507 * Create a integer command 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
512 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
514 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
515 | VLC_VAR_ISCOMMAND );
516 return __var_GetInteger( p_obj, psz_name );
520 * Create a boolean command variable with inherit and get its value.
522 * \param p_obj The object that holds the variable
523 * \param psz_name The name of the variable
525 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
527 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
528 | VLC_VAR_ISCOMMAND );
529 return __var_GetBool( p_obj, psz_name );
533 * Create a time command variable with inherit and get its value.
535 * \param p_obj The object that holds the variable
536 * \param psz_name The name of the variable
538 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
540 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
541 | VLC_VAR_ISCOMMAND );
542 return __var_GetTime( p_obj, psz_name );
546 * Create a float command variable with inherit and get its value.
548 * \param p_obj The object that holds the variable
549 * \param psz_name The name of the variable
551 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
553 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
554 | VLC_VAR_ISCOMMAND );
555 return __var_GetFloat( p_obj, psz_name );
559 * Create a string command variable with inherit and get its value.
561 * \param p_obj The object that holds the variable
562 * \param psz_name The name of the variable
564 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
565 const char *psz_name )
567 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
568 | VLC_VAR_ISCOMMAND );
569 return __var_GetString( p_obj, psz_name );
572 static inline char *__var_CreateGetNonEmptyStringCommand( 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_GetNonEmptyString( p_obj, psz_name );
581 * __var_CreateGetInteger() with automatic casting
583 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
585 * __var_CreateGetBoolCommand() with automatic casting
587 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
589 * __var_CreateGetTimeCommand() with automatic casting
591 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
593 * __var_CreateGetFloat() with automatic casting
595 #define var_CreateGetFloatCommand(a,b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
597 * __var_CreateGetStringCommand() with automatic casting
599 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
600 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
604 #endif /* _VLC_VARIABLES_H */