rand_s() is only in Win XP and latest. so use rand() until we decide to not support...
[vlc.git] / include / vlc_variables.h
blob71365c6a277524053e208eae061dcb16e5331a03
1 /*****************************************************************************
2 * variables.h: variables handling
3 *****************************************************************************
4 * Copyright (C) 2002-2004 the VideoLAN team
5 * $Id$
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
27 #endif
29 #ifndef _VLC_VARIABLES_H
30 #define _VLC_VARIABLES_H 1
32 /**
33 * \defgroup variables Variables
35 * Functions for using the object variables in vlc.
37 * Vlc have a very powerful "object variable" infrastructure useful
38 * for many things.
40 * @{
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
52 * @{
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
61 /** Creation flag */
62 #define VLC_VAR_DOINHERIT 0x8000
63 /**@}*/
65 /**
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.
70 * @{
73 /**
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
79 /**
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
87 /**
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
109 /**@}*/
111 /*****************************************************************************
112 * Prototypes
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 ** ) );
129 VLC_EXPORT( vlc_mutex_t *, var_GetGlobalMutex, ( const char * ) );
132 * __var_Create() with automatic casting.
134 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
136 * __var_Destroy() with automatic casting
138 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
141 * __var_Change() with automatic casting
143 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
146 * __var_Type() with automatic casting
148 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
150 * __var_Set() with automatic casting
152 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
154 * __var_Get() with automatic casting
156 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
158 /*****************************************************************************
159 * Variable callbacks
160 *****************************************************************************
161 * int MyCallback( vlc_object_t *p_this,
162 * char const *psz_variable,
163 * vlc_value_t oldvalue,
164 * vlc_value_t newvalue,
165 * void *p_data);
166 *****************************************************************************/
167 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
168 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
169 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
172 * __var_AddCallback() with automatic casting
174 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
177 * __var_DelCallback() with automatic casting
179 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
182 * __var_TriggerCallback() with automatic casting
184 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
186 /*****************************************************************************
187 * helpers functions
188 *****************************************************************************/
191 * Set the value of an integer variable
193 * \param p_obj The object that holds the variable
194 * \param psz_name The name of the variable
195 * \param i The new integer value of this variable
197 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
199 vlc_value_t val;
200 val.i_int = i;
201 return __var_Set( p_obj, psz_name, val );
203 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
205 * Set the value of an boolean variable
207 * \param p_obj The object that holds the variable
208 * \param psz_name The name of the variable
209 * \param b The new boolean value of this variable
211 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, vlc_bool_t b )
213 vlc_value_t val;
214 val.b_bool = b;
215 return __var_Set( p_obj, psz_name, val );
219 * Set the value of a time variable
221 * \param p_obj The object that holds the variable
222 * \param psz_name The name of the variable
223 * \param i The new time value of this variable
225 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
227 vlc_value_t val;
228 val.i_time = i;
229 return __var_Set( p_obj, psz_name, val );
233 * Set the value of a float variable
235 * \param p_obj The object that holds the variable
236 * \param psz_name The name of the variable
237 * \param f The new float value of this variable
239 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
241 vlc_value_t val;
242 val.f_float = f;
243 return __var_Set( p_obj, psz_name, val );
247 * Set the value of a string variable
249 * \param p_obj The object that holds the variable
250 * \param psz_name The name of the variable
251 * \param psz_string The new string value of this variable
253 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
255 vlc_value_t val;
256 val.psz_string = (char *)psz_string;
257 return __var_Set( p_obj, psz_name, val );
261 * Trigger the callbacks on a void variable
263 * \param p_obj The object that holds the variable
264 * \param psz_name The name of the variable
266 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
268 vlc_value_t val;
269 val.b_bool = VLC_TRUE;
270 return __var_Set( p_obj, psz_name, val );
272 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
275 * __var_SetBool() with automatic casting
277 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
280 * __var_SetTime() with automatic casting
282 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
284 * __var_SetFloat() with automatic casting
286 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
288 * __var_SetString() with automatic casting
290 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
293 * Get an integer value
295 * \param p_obj The object that holds the variable
296 * \param psz_name The name of the variable
298 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
300 vlc_value_t val;val.i_int = 0;
301 if( !__var_Get( p_obj, psz_name, &val ) )
302 return val.i_int;
303 else
304 return 0;
308 * Get a boolean value
310 * \param p_obj The object that holds the variable
311 * \param psz_name The name of the variable
313 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
315 vlc_value_t val; val.b_bool = VLC_FALSE;
316 if( !__var_Get( p_obj, psz_name, &val ) )
317 return val.b_bool;
318 else
319 return VLC_FALSE;
323 * Get a time value
325 * \param p_obj The object that holds the variable
326 * \param psz_name The name of the variable
328 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
330 vlc_value_t val; val.i_time = 0L;
331 if( !__var_Get( p_obj, psz_name, &val ) )
332 return val.i_time;
333 else
334 return 0;
338 * Get a float value
340 * \param p_obj The object that holds the variable
341 * \param psz_name The name of the variable
343 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
345 vlc_value_t val; val.f_float = 0.0;
346 if( !__var_Get( p_obj, psz_name, &val ) )
347 return val.f_float;
348 else
349 return 0.0;
353 * Get a string value
355 * \param p_obj The object that holds the variable
356 * \param psz_name The name of the variable
358 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
360 vlc_value_t val; val.psz_string = NULL;
361 if( !__var_Get( p_obj, psz_name, &val ) )
362 return val.psz_string;
363 else
364 return strdup( "" );
367 static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
369 vlc_value_t val;
370 if( __var_Get( obj, name, &val ) )
371 return NULL;
372 if( *val.psz_string )
373 return val.psz_string;
374 free( val.psz_string );
375 return NULL;
380 * __var_GetInteger() with automatic casting
382 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
384 * __var_GetBool() with automatic casting
386 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
388 * __var_GetTime() with automatic casting
390 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
392 * __var_GetFloat() with automatic casting
394 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
396 * __var_GetString() with automatic casting
398 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
399 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
404 * Increment an integer variable
405 * \param p_obj the object that holds the variable
406 * \param psz_name the name of the variable
408 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
410 int i_val = __var_GetInteger( p_obj, psz_name );
411 __var_SetInteger( p_obj, psz_name, ++i_val );
413 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
416 * Decrement an integer variable
417 * \param p_obj the object that holds the variable
418 * \param psz_name the name of the variable
420 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
422 int i_val = __var_GetInteger( p_obj, psz_name );
423 __var_SetInteger( p_obj, psz_name, --i_val );
425 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
428 * Create a integer variable with inherit and get its value.
430 * \param p_obj The object that holds the variable
431 * \param psz_name The name of the variable
433 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
435 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
436 return __var_GetInteger( p_obj, psz_name );
440 * Create a boolean variable with inherit and get its value.
442 * \param p_obj The object that holds the variable
443 * \param psz_name The name of the variable
445 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
447 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
448 return __var_GetBool( p_obj, psz_name );
452 * Create a time variable with inherit and get its value.
454 * \param p_obj The object that holds the variable
455 * \param psz_name The name of the variable
457 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
459 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
460 return __var_GetTime( p_obj, psz_name );
464 * Create a float variable with inherit and get its value.
466 * \param p_obj The object that holds the variable
467 * \param psz_name The name of the variable
469 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
471 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
472 return __var_GetFloat( p_obj, psz_name );
476 * Create a string variable with inherit and get its value.
478 * \param p_obj The object that holds the variable
479 * \param psz_name The name of the variable
481 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
482 const char *psz_name )
484 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
485 return __var_GetString( p_obj, psz_name );
488 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
489 const char *psz_name )
491 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
492 return __var_GetNonEmptyString( p_obj, psz_name );
496 * __var_CreateGetInteger() with automatic casting
498 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
500 * __var_CreateGetBool() with automatic casting
502 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
504 * __var_CreateGetTime() with automatic casting
506 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
508 * __var_CreateGetFloat() with automatic casting
510 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
512 * __var_CreateGetString() with automatic casting
514 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
515 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
518 * Create a integer command variable with inherit and get its value.
520 * \param p_obj The object that holds the variable
521 * \param psz_name The name of the variable
523 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
525 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
526 | VLC_VAR_ISCOMMAND );
527 return __var_GetInteger( p_obj, psz_name );
531 * Create a boolean command variable with inherit and get its value.
533 * \param p_obj The object that holds the variable
534 * \param psz_name The name of the variable
536 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
538 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
539 | VLC_VAR_ISCOMMAND );
540 return __var_GetBool( p_obj, psz_name );
544 * Create a time command variable with inherit and get its value.
546 * \param p_obj The object that holds the variable
547 * \param psz_name The name of the variable
549 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
551 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
552 | VLC_VAR_ISCOMMAND );
553 return __var_GetTime( p_obj, psz_name );
557 * Create a float command variable with inherit and get its value.
559 * \param p_obj The object that holds the variable
560 * \param psz_name The name of the variable
562 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
564 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
565 | VLC_VAR_ISCOMMAND );
566 return __var_GetFloat( p_obj, psz_name );
570 * Create a string command variable with inherit and get its value.
572 * \param p_obj The object that holds the variable
573 * \param psz_name The name of the variable
575 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
576 const char *psz_name )
578 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
579 | VLC_VAR_ISCOMMAND );
580 return __var_GetString( p_obj, psz_name );
583 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
584 const char *psz_name )
586 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
587 | VLC_VAR_ISCOMMAND );
588 return __var_GetNonEmptyString( p_obj, psz_name );
592 * __var_CreateGetInteger() with automatic casting
594 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
596 * __var_CreateGetBoolCommand() with automatic casting
598 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
600 * __var_CreateGetTimeCommand() with automatic casting
602 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
604 * __var_CreateGetFloat() with automatic casting
606 #define var_CreateGetFloatCommand(a,b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
608 * __var_CreateGetStringCommand() with automatic casting
610 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
611 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
613 * @}
615 #endif /* _VLC_VARIABLES_H */