1 /*****************************************************************************
2 * variables.h: variables handling
3 *****************************************************************************
4 * Copyright (C) 2002-2004 VideoLAN
5 * $Id: variables.h,v 1.21 2004/01/09 22:11:04 hartman Exp $
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
26 * \defgroup variables Variables
28 * Functions for using the object variables in vlc.
30 * Vlc have a very powerful "object variable" infrastructure useful
36 typedef struct callback_entry_t callback_entry_t;
39 * The structure describing a variable.
40 * \note vlc_value_t is the common union for variable values
44 /** The variable's exported value */
47 char * psz_name; /**< The variable unique name */
48 uint32_t i_hash; /**< (almost) unique hashed value */
49 int i_type; /**< The type of the variable */
51 /** The variable display name, mainly for use by the interfaces */
54 /** A pointer to a comparison function */
55 int ( * pf_cmp ) ( vlc_value_t, vlc_value_t );
56 /** A pointer to a duplication function */
57 void ( * pf_dup ) ( vlc_value_t * );
58 /** A pointer to a deallocation function */
59 void ( * pf_free ) ( vlc_value_t * );
61 /** Creation count: we only destroy the variable if it reaches 0 */
64 /** If the variable has min/max/step values */
65 vlc_value_t min, max, step;
67 /** Index of the default choice, if the variable is to be chosen in
70 /** List of choices */
72 /** List of friendly names for the choices */
73 vlc_list_t choices_text;
75 /** Set to TRUE if the variable is in a callback */
76 vlc_bool_t b_incallback;
78 /** Number of registered callbacks */
80 /** Array of registered callbacks */
81 callback_entry_t * p_entries;
84 /*****************************************************************************
85 * Variable types - probably very incomplete
86 *****************************************************************************/
87 #define VLC_VAR_TYPE 0x00ff
88 #define VLC_VAR_FLAGS 0xff00
91 * \defgroup var_type Variable types
92 * These are the different types a vlc variable can have.
95 #define VLC_VAR_VOID 0x0010
96 #define VLC_VAR_BOOL 0x0020
97 #define VLC_VAR_INTEGER 0x0030
98 #define VLC_VAR_HOTKEY 0x0031
99 #define VLC_VAR_STRING 0x0040
100 #define VLC_VAR_MODULE 0x0041
101 #define VLC_VAR_FILE 0x0042
102 #define VLC_VAR_DIRECTORY 0x0043
103 #define VLC_VAR_VARIABLE 0x0044
104 #define VLC_VAR_FLOAT 0x0050
105 #define VLC_VAR_TIME 0x0060
106 #define VLC_VAR_ADDRESS 0x0070
107 #define VLC_VAR_MUTEX 0x0080
108 #define VLC_VAR_LIST 0x0090
110 /** \defgroup var_flags Additive flags
111 * These flags are added to the type field of the variable. Most as a result of
112 * a __var_Change() call, but some may be added at creation time
115 #define VLC_VAR_HASCHOICE 0x0100
116 #define VLC_VAR_HASMIN 0x0200
117 #define VLC_VAR_HASMAX 0x0400
118 #define VLC_VAR_HASSTEP 0x0800
120 #define VLC_VAR_ISLIST 0x1000
121 #define VLC_VAR_ISCOMMAND 0x2000
122 #define VLC_VAR_ISCONFIG 0x2000
125 #define VLC_VAR_DOINHERIT 0x8000
129 * \defgroup var_action Variable actions
130 * These are the different actions that can be used with __var_Change().
131 * The parameters given are the meaning of the two last parameters of
132 * __var_Change() when this action is being used.
137 * Set the minimum value of this variable
138 * \param p_val The new minimum value
139 * \param p_val2 Unused
141 #define VLC_VAR_SETMIN 0x0010
143 * Set the maximum value of this variable
144 * \param p_val The new maximum value
145 * \param p_val2 Unused
147 #define VLC_VAR_SETMAX 0x0011
148 #define VLC_VAR_SETSTEP 0x0012
151 * Set the value of this variable without triggering any callbacks
152 * \param p_val The new value
153 * \param p_val2 Unused
155 #define VLC_VAR_SETVALUE 0x0013
157 #define VLC_VAR_SETTEXT 0x0014
158 #define VLC_VAR_GETTEXT 0x0015
160 #define VLC_VAR_ADDCHOICE 0x0020
161 #define VLC_VAR_DELCHOICE 0x0021
162 #define VLC_VAR_CLEARCHOICES 0x0022
163 #define VLC_VAR_SETDEFAULT 0x0023
164 #define VLC_VAR_GETCHOICES 0x0024
165 #define VLC_VAR_FREECHOICES 0x0025
166 #define VLC_VAR_GETLIST 0x0026
167 #define VLC_VAR_FREELIST 0x0027
168 #define VLC_VAR_CHOICESCOUNT 0x0028
170 #define VLC_VAR_INHERITVALUE 0x0030
171 #define VLC_VAR_TRIGGER_CALLBACKS 0x0035
174 /*****************************************************************************
176 *****************************************************************************/
177 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
178 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
180 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
182 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) );
183 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
184 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
187 * __var_Create() with automatic casting.
189 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
191 * __var_Destroy() with automatic casting
193 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
196 * __var_Change() with automatic casting
198 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
201 * __var_Type() with automatic casting
203 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
205 * __var_Set() with automatic casting
207 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
209 * __var_Get() with automatic casting
211 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
213 /*****************************************************************************
215 *****************************************************************************
216 * int MyCallback( vlc_object_t *p_this,
217 * char const *psz_variable,
218 * vlc_value_t oldvalue,
219 * vlc_value_t newvalue,
221 *****************************************************************************/
222 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
223 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
226 * __var_AddCallback() with automatic casting
228 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
231 * __var_DelCallback() with automatic casting
233 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
235 /*****************************************************************************
237 *****************************************************************************/
240 * Set the value of an integer variable
242 * \param p_obj The object that holds the variable
243 * \param psz_name The name of the variable
244 * \param i The new integer value of this variable
246 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
250 return __var_Set( p_obj, psz_name, val );
254 * Set the value of a time variable
256 * \param p_obj The object that holds the variable
257 * \param psz_name The name of the variable
258 * \param i The new time value of this variable
260 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
264 return __var_Set( p_obj, psz_name, val );
268 * Set the value of a float variable
270 * \param p_obj The object that holds the variable
271 * \param psz_name The name of the variable
272 * \param f The new float value of this variable
274 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
278 return __var_Set( p_obj, psz_name, val );
282 * Trigger the callbacks on a void variable
284 * \param p_obj The object that holds the variable
285 * \param psz_name The name of the variable
287 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
290 val.b_bool = VLC_TRUE;
291 return __var_Set( p_obj, psz_name, val );
295 * __var_SetInteger() with automatic casting
297 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
299 * __var_SetTime() with automatic casting
301 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
303 * __var_SetFloat() with automatic casting
305 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
307 * __var_SetVoid() with automatic casting
309 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)