af1057323b26fc64f78aa042fd748f4b63e01b2b
[vlc.git] / include / vlc_variables.h
1 /*****************************************************************************
2  * variables.h: variables handling
3  *****************************************************************************
4  * Copyright (C) 2002-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *          Gildas Bazin <gbazin@netcourrier.com>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 #if !defined( __LIBVLC__ )
26   #error You are not libvlc or one of its plugins. You cannot include this file
27 #endif
28
29 #ifndef _VLC_VARIABLES_H
30 #define _VLC_VARIABLES_H 1
31
32 /**
33  * \defgroup variables Variables
34  *
35  * Functions for using the object variables in vlc.
36  *
37  * Vlc have a very powerful "object variable" infrastructure useful
38  * for many things.
39  *
40  * @{
41  */
42
43 /*****************************************************************************
44  * Variable types - probably very incomplete
45  *****************************************************************************/
46 #define VLC_VAR_TYPE      0x00ff
47 #define VLC_VAR_FLAGS     0xff00
48
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  * @{
53  */
54 #define VLC_VAR_HASCHOICE 0x0100
55 #define VLC_VAR_HASMIN    0x0200
56 #define VLC_VAR_HASMAX    0x0400
57 #define VLC_VAR_HASSTEP   0x0800
58
59 #define VLC_VAR_ISCOMMAND 0x2000
60
61 /** Creation flag */
62 #define VLC_VAR_DOINHERIT 0x8000
63 /**@}*/
64
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  * @{
71  */
72
73 /**
74  * Set the minimum value of this variable
75  * \param p_val The new minimum value
76  * \param p_val2 Unused
77  */
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
83  */
84 #define VLC_VAR_SETMAX              0x0011
85 #define VLC_VAR_SETSTEP             0x0012
86
87 /**
88  * Set the value of this variable without triggering any callbacks
89  * \param p_val The new value
90  * \param p_val2 Unused
91  */
92 #define VLC_VAR_SETVALUE            0x0013
93
94 #define VLC_VAR_SETTEXT             0x0014
95 #define VLC_VAR_GETTEXT             0x0015
96
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
106
107 #define VLC_VAR_INHERITVALUE        0x0030
108 #define VLC_VAR_TRIGGER_CALLBACKS   0x0035
109 /**@}*/
110
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 * ) );
116
117 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
118
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 * ) );
122
123 #define var_OptionParse(a,b) __var_OptionParse( VLC_OBJECT( a ) , b )
124 VLC_EXPORT( void, __var_OptionParse, ( vlc_object_t *, const char * ) );
125
126 /**
127  * __var_Create() with automatic casting.
128  */
129 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
130 /**
131  * __var_Destroy() with automatic casting
132  */
133 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
134
135 /**
136  * __var_Change() with automatic casting
137  */
138 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
139
140 /**
141  * __var_Type() with automatic casting
142  */
143 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
144 /**
145  * __var_Set() with automatic casting
146  */
147 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
148 /**
149  * __var_Get() with automatic casting
150  */
151 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
152
153 /*****************************************************************************
154  * Variable callbacks
155  *****************************************************************************
156  * int MyCallback( vlc_object_t *p_this,
157  *                 char const *psz_variable,
158  *                 vlc_value_t oldvalue,
159  *                 vlc_value_t newvalue,
160  *                 void *p_data);
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 * ) );
164
165 /**
166  * __var_AddCallback() with automatic casting
167  */
168 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
169
170 /**
171  * __var_DelCallback() with automatic casting
172  */
173 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
174
175 /*****************************************************************************
176  * helpers functions
177  *****************************************************************************/
178
179 /**
180  * Set the value of an integer variable
181  *
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
185  */
186 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
187 {
188     vlc_value_t val;
189     val.i_int = i;
190     return __var_Set( p_obj, psz_name, val );
191 }
192 #define var_SetInteger(a,b,c)   __var_SetInteger( VLC_OBJECT(a),b,c)
193 /**
194  * Set the value of an boolean variable
195  *
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
199  */
200 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, vlc_bool_t b )
201 {
202     vlc_value_t val;
203     val.b_bool = b;
204     return __var_Set( p_obj, psz_name, val );
205 }
206
207 /**
208  * Set the value of a time variable
209  *
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
213  */
214 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
215 {
216     vlc_value_t val;
217     val.i_time = i;
218     return __var_Set( p_obj, psz_name, val );
219 }
220
221 /**
222  * Set the value of a float variable
223  *
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
227  */
228 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
229 {
230     vlc_value_t val;
231     val.f_float = f;
232     return __var_Set( p_obj, psz_name, val );
233 }
234
235 /**
236  * Set the value of a string variable
237  *
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
241  */
242 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
243 {
244     vlc_value_t val;
245     val.psz_string = (char *)psz_string;
246     return __var_Set( p_obj, psz_name, val );
247 }
248
249 /**
250  * Trigger the callbacks on a void variable
251  *
252  * \param p_obj The object that holds the variable
253  * \param psz_name The name of the variable
254  */
255 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
256 {
257     vlc_value_t val;
258     val.b_bool = VLC_TRUE;
259     return __var_Set( p_obj, psz_name, val );
260 }
261 #define var_SetVoid(a,b)        __var_SetVoid( VLC_OBJECT(a),b)
262
263 /**
264  * __var_SetBool() with automatic casting
265  */
266 #define var_SetBool(a,b,c)   __var_SetBool( VLC_OBJECT(a),b,c)
267
268 /**
269  * __var_SetTime() with automatic casting
270  */
271 #define var_SetTime(a,b,c)      __var_SetTime( VLC_OBJECT(a),b,c)
272 /**
273  * __var_SetFloat() with automatic casting
274  */
275 #define var_SetFloat(a,b,c)     __var_SetFloat( VLC_OBJECT(a),b,c)
276 /**
277  * __var_SetString() with automatic casting
278  */
279 #define var_SetString(a,b,c)     __var_SetString( VLC_OBJECT(a),b,c)
280
281 /**
282  * Get an integer value
283 *
284  * \param p_obj The object that holds the variable
285  * \param psz_name The name of the variable
286  */
287 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
288 {
289     vlc_value_t val;val.i_int = 0;
290     if( !__var_Get( p_obj, psz_name, &val ) )
291         return val.i_int;
292     else
293         return 0;
294 }
295
296 /**
297  * Get a boolean value
298  *
299  * \param p_obj The object that holds the variable
300  * \param psz_name The name of the variable
301  */
302 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
303 {
304     vlc_value_t val; val.b_bool = VLC_FALSE;
305     if( !__var_Get( p_obj, psz_name, &val ) )
306         return val.b_bool;
307     else
308         return VLC_FALSE;
309 }
310
311 /**
312  * Get a time value
313  *
314  * \param p_obj The object that holds the variable
315  * \param psz_name The name of the variable
316  */
317 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
318 {
319     vlc_value_t val; val.i_time = 0L;
320     if( !__var_Get( p_obj, psz_name, &val ) )
321         return val.i_time;
322     else
323         return 0;
324 }
325
326 /**
327  * Get a float value
328  *
329  * \param p_obj The object that holds the variable
330  * \param psz_name The name of the variable
331  */
332 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
333 {
334     vlc_value_t val; val.f_float = 0.0;
335     if( !__var_Get( p_obj, psz_name, &val ) )
336         return val.f_float;
337     else
338         return 0.0;
339 }
340
341 /**
342  * Get a string value
343  *
344  * \param p_obj The object that holds the variable
345  * \param psz_name The name of the variable
346  */
347 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
348 {
349     vlc_value_t val; val.psz_string = NULL;
350     if( !__var_Get( p_obj, psz_name, &val ) )
351         return val.psz_string;
352     else
353         return strdup( "" );
354 }
355
356 static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
357 {
358     vlc_value_t val;
359     if (__var_Get (obj, name, &val))
360         return NULL;
361     if (*val.psz_string)
362         return val.psz_string;
363     free (val.psz_string);
364     return NULL;
365 }
366
367
368 /**
369  * __var_GetInteger() with automatic casting
370  */
371 #define var_GetInteger(a,b)   __var_GetInteger( VLC_OBJECT(a),b)
372 /**
373  * __var_GetBool() with automatic casting
374  */
375 #define var_GetBool(a,b)   __var_GetBool( VLC_OBJECT(a),b)
376 /**
377  * __var_GetTime() with automatic casting
378  */
379 #define var_GetTime(a,b)   __var_GetTime( VLC_OBJECT(a),b)
380 /**
381  * __var_GetFloat() with automatic casting
382  */
383 #define var_GetFloat(a,b)   __var_GetFloat( VLC_OBJECT(a),b)
384 /**
385  * __var_GetString() with automatic casting
386  */
387 #define var_GetString(a,b)   __var_GetString( VLC_OBJECT(a),b)
388 #define var_GetNonEmptyString(a,b)   __var_GetNonEmptyString( VLC_OBJECT(a),b)
389
390
391
392 /**
393  * Increment an integer variable
394  * \param p_obj the object that holds the variable
395  * \param psz_name the name of the variable
396  */
397 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
398 {
399     int i_val = __var_GetInteger( p_obj, psz_name );
400     __var_SetInteger( p_obj, psz_name, ++i_val );
401 }
402 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
403
404 /**
405  * Decrement an integer variable
406  * \param p_obj the object that holds the variable
407  * \param psz_name the name of the variable
408  */
409 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
410 {
411     int i_val = __var_GetInteger( p_obj, psz_name );
412     __var_SetInteger( p_obj, psz_name, --i_val );
413 }
414 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
415
416 /**
417  * Create a integer variable with inherit and get its value.
418  *
419  * \param p_obj The object that holds the variable
420  * \param psz_name The name of the variable
421  */
422 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
423 {
424     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
425     return __var_GetInteger( p_obj, psz_name );
426 }
427
428 /**
429  * Create a boolean variable with inherit and get its value.
430  *
431  * \param p_obj The object that holds the variable
432  * \param psz_name The name of the variable
433  */
434 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
435 {
436     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
437     return __var_GetBool( p_obj, psz_name );
438 }
439
440 /**
441  * Create a time variable with inherit and get its value.
442  *
443  * \param p_obj The object that holds the variable
444  * \param psz_name The name of the variable
445  */
446 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
447 {
448     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
449     return __var_GetTime( p_obj, psz_name );
450 }
451
452 /**
453  * Create a float variable with inherit and get its value.
454  *
455  * \param p_obj The object that holds the variable
456  * \param psz_name The name of the variable
457  */
458 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
459 {
460     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
461     return __var_GetFloat( p_obj, psz_name );
462 }
463
464 /**
465  * Create a string variable with inherit and get its value.
466  *
467  * \param p_obj The object that holds the variable
468  * \param psz_name The name of the variable
469  */
470 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
471                                            const char *psz_name )
472 {
473     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
474     return __var_GetString( p_obj, psz_name );
475 }
476
477 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
478                                                    const char *psz_name )
479 {
480     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
481     return __var_GetNonEmptyString( p_obj, psz_name );
482 }
483
484 /**
485  * __var_CreateGetInteger() with automatic casting
486  */
487 #define var_CreateGetInteger(a,b)   __var_CreateGetInteger( VLC_OBJECT(a),b)
488 /**
489  * __var_CreateGetBool() with automatic casting
490  */
491 #define var_CreateGetBool(a,b)   __var_CreateGetBool( VLC_OBJECT(a),b)
492 /**
493  * __var_CreateGetTime() with automatic casting
494  */
495 #define var_CreateGetTime(a,b)   __var_CreateGetTime( VLC_OBJECT(a),b)
496 /**
497  * __var_CreateGetFloat() with automatic casting
498  */
499 #define var_CreateGetFloat(a,b)   __var_CreateGetFloat( VLC_OBJECT(a),b)
500 /**
501  * __var_CreateGetString() with automatic casting
502  */
503 #define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
504 #define var_CreateGetNonEmptyString(a,b)   __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
505
506 /**
507  * Create a integer command variable with inherit and get its value.
508  *
509  * \param p_obj The object that holds the variable
510  * \param psz_name The name of the variable
511  */
512 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
513 {
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 );
517 }
518
519 /**
520  * Create a boolean command variable with inherit and get its value.
521  *
522  * \param p_obj The object that holds the variable
523  * \param psz_name The name of the variable
524  */
525 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
526 {
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 );
530 }
531
532 /**
533  * Create a time command variable with inherit and get its value.
534  *
535  * \param p_obj The object that holds the variable
536  * \param psz_name The name of the variable
537  */
538 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
539 {
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 );
543 }
544
545 /**
546  * Create a float command variable with inherit and get its value.
547  *
548  * \param p_obj The object that holds the variable
549  * \param psz_name The name of the variable
550  */
551 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
552 {
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 );
556 }
557
558 /**
559  * Create a string command variable with inherit and get its value.
560  *
561  * \param p_obj The object that holds the variable
562  * \param psz_name The name of the variable
563  */
564 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
565                                            const char *psz_name )
566 {
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 );
570 }
571
572 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
573                                                    const char *psz_name )
574 {
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 );
578 }
579
580 /**
581  * __var_CreateGetInteger() with automatic casting
582  */
583 #define var_CreateGetIntegerCommand(a,b)   __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
584 /**
585  * __var_CreateGetBoolCommand() with automatic casting
586  */
587 #define var_CreateGetBoolCommand(a,b)   __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
588 /**
589  * __var_CreateGetTimeCommand() with automatic casting
590  */
591 #define var_CreateGetTimeCommand(a,b)   __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
592 /**
593  * __var_CreateGetFloat() with automatic casting
594  */
595 #define var_CreateGetFloatCommand(a,b)   __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
596 /**
597  * __var_CreateGetStringCommand() with automatic casting
598  */
599 #define var_CreateGetStringCommand(a,b)   __var_CreateGetStringCommand( VLC_OBJECT(a),b)
600 #define var_CreateGetNonEmptyStringCommand(a,b)   __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
601 /**
602  * @}
603  */
604 #endif /*  _VLC_VARIABLES_H */