0a41df91364e3f32b54d3c1ae093778ea15495a0
[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 #ifndef VLC_VARIABLES_H
26 #define VLC_VARIABLES_H 1
27
28 /**
29  * \file
30  * This file defines functions and structures for dynamic variables in vlc
31  */
32
33 /**
34  * \defgroup variables Variables
35  *
36  * Functions for using the object variables in vlc.
37  *
38  * Vlc have a very powerful "object variable" infrastructure useful
39  * for many things.
40  *
41  * @{
42  */
43
44 /*****************************************************************************
45  * Variable types - probably very incomplete
46  *****************************************************************************/
47 #define VLC_VAR_TYPE      0x00ff
48 #define VLC_VAR_CLASS     0x00f0
49 #define VLC_VAR_FLAGS     0xff00
50
51 /** \defgroup var_flags Additive flags
52  * These flags are added to the type field of the variable. Most as a result of
53  * a __var_Change() call, but some may be added at creation time
54  * @{
55  */
56 #define VLC_VAR_HASCHOICE 0x0100
57 #define VLC_VAR_HASMIN    0x0200
58 #define VLC_VAR_HASMAX    0x0400
59 #define VLC_VAR_HASSTEP   0x0800
60
61 #define VLC_VAR_ISCOMMAND 0x2000
62
63 /** Creation flag */
64 #define VLC_VAR_DOINHERIT 0x8000
65 /**@}*/
66
67 /**
68  * \defgroup var_action Variable actions
69  * These are the different actions that can be used with __var_Change().
70  * The parameters given are the meaning of the two last parameters of
71  * __var_Change() when this action is being used.
72  * @{
73  */
74
75 /**
76  * Set the minimum value of this variable
77  * \param p_val The new minimum value
78  * \param p_val2 Unused
79  */
80 #define VLC_VAR_SETMIN              0x0010
81 /**
82  * Set the maximum value of this variable
83  * \param p_val The new maximum value
84  * \param p_val2 Unused
85  */
86 #define VLC_VAR_SETMAX              0x0011
87 #define VLC_VAR_SETSTEP             0x0012
88
89 /**
90  * Set the value of this variable without triggering any callbacks
91  * \param p_val The new value
92  * \param p_val2 Unused
93  */
94 #define VLC_VAR_SETVALUE            0x0013
95
96 #define VLC_VAR_SETTEXT             0x0014
97 #define VLC_VAR_GETTEXT             0x0015
98
99 #define VLC_VAR_GETMIN              0x0016
100 #define VLC_VAR_GETMAX              0x0017
101 #define VLC_VAR_GETSTEP             0x0018
102
103 #define VLC_VAR_ADDCHOICE           0x0020
104 #define VLC_VAR_DELCHOICE           0x0021
105 #define VLC_VAR_CLEARCHOICES        0x0022
106 #define VLC_VAR_SETDEFAULT          0x0023
107 #define VLC_VAR_GETCHOICES          0x0024
108 #define VLC_VAR_FREECHOICES         0x0025
109 #define VLC_VAR_GETLIST             0x0026
110 #define VLC_VAR_FREELIST            0x0027
111 #define VLC_VAR_CHOICESCOUNT        0x0028
112
113 #define VLC_VAR_INHERITVALUE        0x0030
114 #define VLC_VAR_TRIGGER_CALLBACKS   0x0035
115
116 #define VLC_VAR_SETISCOMMAND        0x0040
117 /**@}*/
118
119 /*****************************************************************************
120  * Prototypes
121  *****************************************************************************/
122 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
123 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
124
125 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
126
127 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
128 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
129 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
130 VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) );
131 VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
132
133 #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
134 VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
135
136 /**
137  * __var_Create() with automatic casting.
138  */
139 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
140 /**
141  * __var_Destroy() with automatic casting
142  */
143 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
144
145 /**
146  * __var_Change() with automatic casting
147  */
148 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
149
150 /**
151  * __var_Type() with automatic casting
152  */
153 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
154 /**
155  * __var_Set() with automatic casting
156  */
157 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
158 /**
159  * __var_Get() with automatic casting
160  */
161 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
162
163 /*****************************************************************************
164  * Variable callbacks
165  *****************************************************************************
166  * int MyCallback( vlc_object_t *p_this,
167  *                 char const *psz_variable,
168  *                 vlc_value_t oldvalue,
169  *                 vlc_value_t newvalue,
170  *                 void *p_data);
171  *****************************************************************************/
172 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
173 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
174 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
175
176 /**
177  * __var_AddCallback() with automatic casting
178  */
179 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
180
181 /**
182  * __var_DelCallback() with automatic casting
183  */
184 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
185
186 /**
187  * __var_TriggerCallback() with automatic casting
188  */
189 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
190
191 /*****************************************************************************
192  * helpers functions
193  *****************************************************************************/
194
195 /**
196  * Set the value of an integer variable
197  *
198  * \param p_obj The object that holds the variable
199  * \param psz_name The name of the variable
200  * \param i The new integer value of this variable
201  */
202 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
203 {
204     vlc_value_t val;
205     val.i_int = i;
206     return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
207 }
208 #define var_SetInteger(a,b,c)   __var_SetInteger( VLC_OBJECT(a),b,c)
209 /**
210  * Set the value of an boolean variable
211  *
212  * \param p_obj The object that holds the variable
213  * \param psz_name The name of the variable
214  * \param b The new boolean value of this variable
215  */
216 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
217 {
218     vlc_value_t val;
219     val.b_bool = b;
220     return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
221 }
222
223 /**
224  * Set the value of a time variable
225  *
226  * \param p_obj The object that holds the variable
227  * \param psz_name The name of the variable
228  * \param i The new time value of this variable
229  */
230 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
231 {
232     vlc_value_t val;
233     val.i_time = i;
234     return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
235 }
236
237 /**
238  * Set the value of a float variable
239  *
240  * \param p_obj The object that holds the variable
241  * \param psz_name The name of the variable
242  * \param f The new float value of this variable
243  */
244 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
245 {
246     vlc_value_t val;
247     val.f_float = f;
248     return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
249 }
250
251 /**
252  * Set the value of a string variable
253  *
254  * \param p_obj The object that holds the variable
255  * \param psz_name The name of the variable
256  * \param psz_string The new string value of this variable
257  */
258 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
259 {
260     vlc_value_t val;
261     val.psz_string = (char *)psz_string;
262     return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
263 }
264
265 /**
266  * Trigger the callbacks on a void variable
267  *
268  * \param p_obj The object that holds the variable
269  * \param psz_name The name of the variable
270  */
271 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
272 {
273     vlc_value_t val;
274     val.b_bool = true;
275     return var_SetChecked( p_obj, psz_name, VLC_VAR_VOID, val );
276 }
277 #define var_SetVoid(a,b)        __var_SetVoid( VLC_OBJECT(a),b)
278
279 /**
280  * __var_SetBool() with automatic casting
281  */
282 #define var_SetBool(a,b,c)   __var_SetBool( VLC_OBJECT(a),b,c)
283
284 /**
285  * __var_SetTime() with automatic casting
286  */
287 #define var_SetTime(a,b,c)      __var_SetTime( VLC_OBJECT(a),b,c)
288 /**
289  * __var_SetFloat() with automatic casting
290  */
291 #define var_SetFloat(a,b,c)     __var_SetFloat( VLC_OBJECT(a),b,c)
292 /**
293  * __var_SetString() with automatic casting
294  */
295 #define var_SetString(a,b,c)     __var_SetString( VLC_OBJECT(a),b,c)
296
297 /**
298  * Get an integer value
299 *
300  * \param p_obj The object that holds the variable
301  * \param psz_name The name of the variable
302  */
303 LIBVLC_USED
304 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
305 {
306     vlc_value_t val;
307     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
308         return val.i_int;
309     else
310         return 0;
311 }
312
313 /**
314  * Get a boolean value
315  *
316  * \param p_obj The object that holds the variable
317  * \param psz_name The name of the variable
318  */
319 LIBVLC_USED
320 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
321 {
322     vlc_value_t val; val.b_bool = false;
323
324     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
325         return val.b_bool;
326     else
327         return false;
328 }
329
330 /**
331  * Get a time value
332  *
333  * \param p_obj The object that holds the variable
334  * \param psz_name The name of the variable
335  */
336 LIBVLC_USED
337 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
338 {
339     vlc_value_t val; val.i_time = 0L;
340     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
341         return val.i_time;
342     else
343         return 0;
344 }
345
346 /**
347  * Get a float value
348  *
349  * \param p_obj The object that holds the variable
350  * \param psz_name The name of the variable
351  */
352 LIBVLC_USED
353 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
354 {
355     vlc_value_t val; val.f_float = 0.0;
356     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
357         return val.f_float;
358     else
359         return 0.0;
360 }
361
362 /**
363  * Get a string value
364  *
365  * \param p_obj The object that holds the variable
366  * \param psz_name The name of the variable
367  */
368 LIBVLC_USED
369 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
370 {
371     vlc_value_t val; val.psz_string = NULL;
372     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
373         return NULL;
374     else
375         return val.psz_string;
376 }
377
378 LIBVLC_USED
379 static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
380 {
381     vlc_value_t val;
382     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
383         return NULL;
384     if( *val.psz_string )
385         return val.psz_string;
386     free( val.psz_string );
387     return NULL;
388 }
389
390
391 /**
392  * __var_GetInteger() with automatic casting
393  */
394 #define var_GetInteger(a,b)   __var_GetInteger( VLC_OBJECT(a),b)
395 /**
396  * __var_GetBool() with automatic casting
397  */
398 #define var_GetBool(a,b)   __var_GetBool( VLC_OBJECT(a),b)
399 /**
400  * __var_GetTime() with automatic casting
401  */
402 #define var_GetTime(a,b)   __var_GetTime( VLC_OBJECT(a),b)
403 /**
404  * __var_GetFloat() with automatic casting
405  */
406 #define var_GetFloat(a,b)   __var_GetFloat( VLC_OBJECT(a),b)
407 /**
408  * __var_GetString() with automatic casting
409  */
410 #define var_GetString(a,b)   __var_GetString( VLC_OBJECT(a),b)
411 #define var_GetNonEmptyString(a,b)   __var_GetNonEmptyString( VLC_OBJECT(a),b)
412
413
414
415 /**
416  * Increment an integer variable
417  * \param p_obj the object that holds the variable
418  * \param psz_name the name of the variable
419  */
420 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
421 {
422     int i_val = __var_GetInteger( p_obj, psz_name );
423     __var_SetInteger( p_obj, psz_name, ++i_val );
424 }
425 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
426
427 /**
428  * Decrement an integer variable
429  * \param p_obj the object that holds the variable
430  * \param psz_name the name of the variable
431  */
432 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
433 {
434     int i_val = __var_GetInteger( p_obj, psz_name );
435     __var_SetInteger( p_obj, psz_name, --i_val );
436 }
437 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
438
439 /**
440  * Create a integer variable with inherit and get its value.
441  *
442  * \param p_obj The object that holds the variable
443  * \param psz_name The name of the variable
444  */
445 LIBVLC_USED
446 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
447 {
448     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
449     return __var_GetInteger( p_obj, psz_name );
450 }
451
452 /**
453  * Create a boolean 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 LIBVLC_USED
459 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
460 {
461     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
462     return __var_GetBool( p_obj, psz_name );
463 }
464
465 /**
466  * Create a time variable with inherit and get its value.
467  *
468  * \param p_obj The object that holds the variable
469  * \param psz_name The name of the variable
470  */
471 LIBVLC_USED
472 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
473 {
474     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
475     return __var_GetTime( p_obj, psz_name );
476 }
477
478 /**
479  * Create a float variable with inherit and get its value.
480  *
481  * \param p_obj The object that holds the variable
482  * \param psz_name The name of the variable
483  */
484 LIBVLC_USED
485 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
486 {
487     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
488     return __var_GetFloat( p_obj, psz_name );
489 }
490
491 /**
492  * Create a string variable with inherit and get its value.
493  *
494  * \param p_obj The object that holds the variable
495  * \param psz_name The name of the variable
496  */
497 LIBVLC_USED
498 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
499                                            const char *psz_name )
500 {
501     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
502     return __var_GetString( p_obj, psz_name );
503 }
504
505 LIBVLC_USED
506 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
507                                                    const char *psz_name )
508 {
509     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
510     return __var_GetNonEmptyString( p_obj, psz_name );
511 }
512
513 /**
514  * __var_CreateGetInteger() with automatic casting
515  */
516 #define var_CreateGetInteger(a,b)   __var_CreateGetInteger( VLC_OBJECT(a),b)
517 /**
518  * __var_CreateGetBool() with automatic casting
519  */
520 #define var_CreateGetBool(a,b)   __var_CreateGetBool( VLC_OBJECT(a),b)
521 /**
522  * __var_CreateGetTime() with automatic casting
523  */
524 #define var_CreateGetTime(a,b)   __var_CreateGetTime( VLC_OBJECT(a),b)
525 /**
526  * __var_CreateGetFloat() with automatic casting
527  */
528 #define var_CreateGetFloat(a,b)   __var_CreateGetFloat( VLC_OBJECT(a),b)
529 /**
530  * __var_CreateGetString() with automatic casting
531  */
532 #define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
533 #define var_CreateGetNonEmptyString(a,b)   __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
534
535 /**
536  * Create a integer command variable with inherit and get its value.
537  *
538  * \param p_obj The object that holds the variable
539  * \param psz_name The name of the variable
540  */
541 LIBVLC_USED
542 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
543 {
544     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
545                                    | VLC_VAR_ISCOMMAND );
546     return __var_GetInteger( p_obj, psz_name );
547 }
548
549 /**
550  * Create a boolean command variable with inherit and get its value.
551  *
552  * \param p_obj The object that holds the variable
553  * \param psz_name The name of the variable
554  */
555 LIBVLC_USED
556 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
557 {
558     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
559                                    | VLC_VAR_ISCOMMAND );
560     return __var_GetBool( p_obj, psz_name );
561 }
562
563 /**
564  * Create a time command variable with inherit and get its value.
565  *
566  * \param p_obj The object that holds the variable
567  * \param psz_name The name of the variable
568  */
569 LIBVLC_USED
570 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
571 {
572     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
573                                    | VLC_VAR_ISCOMMAND );
574     return __var_GetTime( p_obj, psz_name );
575 }
576
577 /**
578  * Create a float command variable with inherit and get its value.
579  *
580  * \param p_obj The object that holds the variable
581  * \param psz_name The name of the variable
582  */
583 LIBVLC_USED
584 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
585 {
586     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
587                                    | VLC_VAR_ISCOMMAND );
588     return __var_GetFloat( p_obj, psz_name );
589 }
590
591 /**
592  * Create a string command variable with inherit and get its value.
593  *
594  * \param p_obj The object that holds the variable
595  * \param psz_name The name of the variable
596  */
597 LIBVLC_USED
598 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
599                                            const char *psz_name )
600 {
601     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
602                                    | VLC_VAR_ISCOMMAND );
603     return __var_GetString( p_obj, psz_name );
604 }
605
606 LIBVLC_USED
607 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
608                                                    const char *psz_name )
609 {
610     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
611                                    | VLC_VAR_ISCOMMAND );
612     return __var_GetNonEmptyString( p_obj, psz_name );
613 }
614
615 /**
616  * __var_CreateGetInteger() with automatic casting
617  */
618 #define var_CreateGetIntegerCommand(a,b)   __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
619 /**
620  * __var_CreateGetBoolCommand() with automatic casting
621  */
622 #define var_CreateGetBoolCommand(a,b)   __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
623 /**
624  * __var_CreateGetTimeCommand() with automatic casting
625  */
626 #define var_CreateGetTimeCommand(a,b)   __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
627 /**
628  * __var_CreateGetFloat() with automatic casting
629  */
630 #define var_CreateGetFloatCommand(a,b)   __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
631 /**
632  * __var_CreateGetStringCommand() with automatic casting
633  */
634 #define var_CreateGetStringCommand(a,b)   __var_CreateGetStringCommand( VLC_OBJECT(a),b)
635 #define var_CreateGetNonEmptyStringCommand(a,b)   __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
636 /**
637  * @}
638  */
639 #endif /*  _VLC_VARIABLES_H */