1 /*****************************************************************************
2 * configuration.h : configuration management module
3 * This file describes the programming interface for the configuration module.
4 * It includes functions allowing to declare, get or set configuration options.
5 *****************************************************************************
6 * Copyright (C) 1999-2006 the VideoLAN team
9 * Authors: Gildas Bazin <gbazin@videolan.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /*****************************************************************************
27 * Macros used to build the configuration structure.
28 *****************************************************************************/
30 /* Configuration hint types */
33 #define CONFIG_HINT_END 0x0001 /* End of config */
34 #define CONFIG_HINT_CATEGORY 0x0002 /* Start of new category */
35 #define CONFIG_HINT_SUBCATEGORY 0x0003 /* Start of sub-category */
36 #define CONFIG_HINT_SUBCATEGORY_END 0x0004 /* End of sub-category */
37 #define CONFIG_HINT_USAGE 0x0005 /* Usage information */
39 #define CONFIG_CATEGORY 0x0006 /* Set category */
40 #define CONFIG_SUBCATEGORY 0x0007 /* Set subcategory */
41 #define CONFIG_SECTION 0x0008 /* Start of new section */
43 #define CONFIG_HINT 0x000F
45 /* Configuration item types */
46 #define CONFIG_ITEM_STRING 0x0010 /* String option */
47 #define CONFIG_ITEM_FILE 0x0020 /* File option */
48 #define CONFIG_ITEM_MODULE 0x0030 /* Module option */
49 #define CONFIG_ITEM_INTEGER 0x0040 /* Integer option */
50 #define CONFIG_ITEM_BOOL 0x0050 /* Bool option */
51 #define CONFIG_ITEM_FLOAT 0x0060 /* Float option */
52 #define CONFIG_ITEM_DIRECTORY 0x0070 /* Directory option */
53 #define CONFIG_ITEM_KEY 0x0080 /* Hot key option */
54 #define CONFIG_ITEM_MODULE_CAT 0x0090 /* Module option */
55 #define CONFIG_ITEM_MODULE_LIST 0x00A0 /* Module option */
56 #define CONFIG_ITEM_MODULE_LIST_CAT 0x00B0 /* Module option */
58 #define CONFIG_ITEM 0x00F0
60 /*******************************************************************
61 * All predefined categories and subcategories
62 *******************************************************************/
63 #define CAT_INTERFACE 1
64 #define SUBCAT_INTERFACE_GENERAL 101
65 #define SUBCAT_INTERFACE_MAIN 102
66 #define SUBCAT_INTERFACE_CONTROL 103
67 #define SUBCAT_INTERFACE_HOTKEYS 104
70 #define SUBCAT_AUDIO_GENERAL 201
71 #define SUBCAT_AUDIO_AOUT 202
72 #define SUBCAT_AUDIO_AFILTER 203
73 #define SUBCAT_AUDIO_VISUAL 204
74 #define SUBCAT_AUDIO_MISC 205
77 #define SUBCAT_VIDEO_GENERAL 301
78 #define SUBCAT_VIDEO_VOUT 302
79 #define SUBCAT_VIDEO_VFILTER 303
80 #define SUBCAT_VIDEO_TEXT 304
81 #define SUBCAT_VIDEO_SUBPIC 305
84 #define SUBCAT_INPUT_GENERAL 401
85 #define SUBCAT_INPUT_ACCESS 402
86 #define SUBCAT_INPUT_ACCESS_FILTER 403
87 #define SUBCAT_INPUT_DEMUX 404
88 #define SUBCAT_INPUT_VCODEC 405
89 #define SUBCAT_INPUT_ACODEC 406
90 #define SUBCAT_INPUT_SCODEC 407
93 #define SUBCAT_SOUT_GENERAL 501
94 #define SUBCAT_SOUT_STREAM 502
95 #define SUBCAT_SOUT_MUX 503
96 #define SUBCAT_SOUT_ACO 504
97 #define SUBCAT_SOUT_PACKETIZER 505
98 #define SUBCAT_SOUT_SAP 506
99 #define SUBCAT_SOUT_VOD 507
101 #define CAT_ADVANCED 6
102 #define SUBCAT_ADVANCED_CPU 601
103 #define SUBCAT_ADVANCED_MISC 602
104 #define SUBCAT_ADVANCED_NETWORK 603
105 #define SUBCAT_ADVANCED_XML 604
107 #define CAT_PLAYLIST 7
108 #define SUBCAT_PLAYLIST_GENERAL 701
109 #define SUBCAT_PLAYLIST_SD 702
110 #define SUBCAT_PLAYLIST_EXPORT 703
112 struct config_category_t
119 struct module_config_t
121 int i_type; /* Configuration type */
122 char *psz_type; /* Configuration subtype */
123 char *psz_name; /* Option name */
124 char i_short; /* Optional short option name */
125 char *psz_text; /* Short comment on the configuration option */
126 char *psz_longtext; /* Long comment on the configuration option */
127 char *psz_value; /* Option value */
128 int i_value; /* Option value */
129 float f_value; /* Option value */
130 int i_min; /* Option minimum value */
131 int i_max; /* Option maximum value */
132 float f_min; /* Option minimum value */
133 float f_max; /* Option maximum value */
135 /* Function to call when commiting a change */
136 vlc_callback_t pf_callback;
137 void *p_callback_data;
140 char **ppsz_list; /* List of possible values for the option */
141 int *pi_list; /* Idem for integers */
142 char **ppsz_list_text; /* Friendly names for list values */
143 int i_list; /* Options list size */
146 vlc_callback_t *ppf_action; /* List of possible actions for a config */
147 char **ppsz_action_text; /* Friendly names for actions */
148 int i_action; /* actions list size */
151 char *psz_current; /* Good option name */
152 vlc_bool_t b_strict; /* Transitionnal or strict */
154 vlc_mutex_t *p_lock; /* Lock to use when modifying the config */
155 vlc_bool_t b_dirty; /* Dirty flag to indicate a config change */
156 vlc_bool_t b_advanced; /* Flag to indicate an advanced option */
157 vlc_bool_t b_internal; /* Flag to indicate option is not to be shows */
159 /* Original option values */
160 char *psz_value_orig;
164 /* Option values loaded from config file */
165 char *psz_value_saved;
168 vlc_bool_t b_autosave; /* Config will be auto-saved at exit time */
171 /*****************************************************************************
172 * Prototypes - these methods are used to get, set or manipulate configuration
174 *****************************************************************************/
175 VLC_EXPORT( int, __config_GetType, (vlc_object_t *, const char *) );
176 VLC_EXPORT( int, __config_GetInt, (vlc_object_t *, const char *) );
177 VLC_EXPORT( void, __config_PutInt, (vlc_object_t *, const char *, int) );
178 VLC_EXPORT( float, __config_GetFloat, (vlc_object_t *, const char *) );
179 VLC_EXPORT( void, __config_PutFloat, (vlc_object_t *, const char *, float) );
180 VLC_EXPORT( char *, __config_GetPsz, (vlc_object_t *, const char *) );
181 VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, const char *) );
183 VLC_EXPORT( int, __config_LoadCmdLine, ( vlc_object_t *, int *, char *[], vlc_bool_t ) );
184 VLC_EXPORT( char *, config_GetHomeDir, ( void ) );
185 VLC_EXPORT( char *, config_GetUserDir, ( void ) );
186 VLC_EXPORT( const char *, config_GetDataDir, ( const vlc_object_t * ) );
187 VLC_EXPORT( int, __config_LoadConfigFile, ( vlc_object_t *, const char * ) );
188 VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
189 VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) );
191 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
192 VLC_EXPORT( module_t *, config_FindModule,( vlc_object_t *, const char * ) );
194 VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
195 void config_Free ( module_t * );
197 VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
198 VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) );
200 #define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
201 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
202 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
203 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
204 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
205 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
206 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
208 #define config_LoadCmdLine(a,b,c,d) __config_LoadCmdLine(VLC_OBJECT(a),b,c,d)
209 #define config_LoadConfigFile(a,b) __config_LoadConfigFile(VLC_OBJECT(a),b)
210 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
211 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
214 int config_CreateDir( vlc_object_t *, const char * );
215 int config_AutoSaveConfigFile( vlc_object_t * );
217 /*****************************************************************************
218 * Macros used to build the configuration structure.
220 * Note that internally we support only 3 types of config data: int, float
222 * The other types declared here just map to one of these 3 basic types but
223 * have the advantage of also providing very good hints to a configuration
224 * interface so as to make it more user friendly.
225 * The configuration structure also includes category hints. These hints can
226 * provide a configuration interface with some very useful data and again
227 * allow for a more user friendly interface.
228 *****************************************************************************/
230 #define add_config_inner( ) \
232 if( (i_config % 10) == 0 ) \
233 p_config = (module_config_t *) \
234 realloc(p_config, (i_config+11) * sizeof(module_config_t)); \
235 memset( p_config + i_config, 0, sizeof( *p_config ) )
237 #define add_type_inner( type ) \
238 add_config_inner( ); \
239 p_config[i_config].i_type = type
241 #define add_typedesc_inner( type, text, longtext ) \
242 add_type_inner( type ); \
243 p_config[i_config].psz_text = text; \
244 p_config[i_config].psz_longtext = longtext
246 #define add_typeadv_inner( type, text, longtext, advc ) \
247 add_typedesc_inner( type, text, longtext ); \
248 p_config[i_config].b_advanced = advc
250 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
251 add_typeadv_inner( type, text, longtext, advc ); \
252 p_config[i_config].psz_name = name; \
253 p_config[i_config].pf_callback = cb
255 #define add_string_inner( type, name, text, longtext, advc, cb, value ) \
256 add_typename_inner( type, name, text, longtext, advc, cb ); \
257 p_config[i_config].psz_value = value
259 #define add_int_inner( type, name, text, longtext, advc, cb, value ) \
260 add_typename_inner( type, name, text, longtext, advc, cb ); \
261 p_config[i_config].i_value = value
264 #define set_category( i_id ) \
265 add_type_inner( CONFIG_CATEGORY ); \
266 p_config[i_config].i_value = i_id
268 #define set_subcategory( i_id ) \
269 add_type_inner( CONFIG_SUBCATEGORY ); \
270 p_config[i_config].i_value = i_id
272 #define set_section( text, longtext ) \
273 add_typedesc_inner( CONFIG_SECTION, text, longtext )
275 #define add_category_hint( text, longtext, advc ) \
276 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
278 #define add_subcategory_hint( text, longtext ) \
279 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
281 #define end_subcategory_hint \
282 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
284 #define add_usage_hint( text ) \
285 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
287 #define add_string( name, value, p_callback, text, longtext, advc ) \
288 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value )
290 #define add_file( name, value, p_callback, text, longtext, advc ) \
291 add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value )
293 #define add_directory( name, value, p_callback, text, longtext, advc ) \
294 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value )
296 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
297 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \
298 p_config[i_config].psz_type = psz_caps
300 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
301 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \
302 p_config[i_config].i_min = i_subcategory /* gruik */
304 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
305 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \
306 p_config[i_config].psz_type = psz_caps
308 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
309 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \
310 p_config[i_config].i_min = i_subcategory /* gruik */
312 #define add_integer( name, value, p_callback, text, longtext, advc ) \
313 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
315 #define add_key( name, value, p_callback, text, longtext, advc ) \
316 add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value )
318 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
319 add_integer( name, value, p_callback, text, longtext, advc ); \
320 change_integer_range( i_min, i_max )
322 #define add_float( name, value, p_callback, text, longtext, advc ) \
323 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \
324 p_config[i_config].f_value = value
326 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
327 add_float( name, value, p_callback, text, longtext, advc ); \
328 change_float_range( f_min, f_max )
330 #define add_bool( name, value, p_callback, text, longtext, advc ) \
331 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \
332 p_config[i_config].i_value = value
334 /* For option renamed */
335 #define add_deprecated( name, strict ) \
336 add_config_inner( ); \
337 p_config[ i_config ].i_type = p_config[ i_config -1 ].i_type; \
338 p_config[ i_config ].psz_name = name; \
339 p_config[i_config].b_strict = strict; \
340 p_config[ i_config ].psz_current = p_config[ i_config-1].psz_current \
341 ? p_config[ i_config-1 ].psz_current \
342 : p_config[ i_config-1 ].psz_name;
344 /* For option suppressed*/
345 #define add_suppressed_inner( name, type ) \
346 add_type_inner( type ); \
347 p_config[ i_config ].psz_name = name; \
348 p_config[ i_config ].psz_current = "SUPPRESSED";
350 #define add_suppressed_bool( name ) \
351 add_suppressed_inner( name, CONFIG_ITEM_BOOL )
353 #define add_suppressed_integer( name ) \
354 add_suppressed_inner( name, CONFIG_ITEM_INTEGER )
356 #define add_suppressed_float( name ) \
357 add_suppressed_inner( name, CONFIG_ITEM_FLOAT )
359 #define add_suppressed_string( name ) \
360 add_suppressed_inner( name, CONFIG_ITEM_STRING )
362 /* Modifier macros for the config options (used for fine tuning) */
363 #define change_short( ch ) \
364 p_config[i_config].i_short = ch;
366 #define change_string_list( list, list_text, list_update_func ) \
367 p_config[i_config].i_list = sizeof(list)/sizeof(char *); \
368 p_config[i_config].ppsz_list = list; \
369 p_config[i_config].ppsz_list_text = list_text;
371 #define change_integer_list( list, list_text, list_update_func ) \
372 p_config[i_config].i_list = sizeof(list)/sizeof(int); \
373 p_config[i_config].pi_list = list; \
374 p_config[i_config].ppsz_list_text = list_text;
376 #define change_integer_range( min, max ) \
377 p_config[i_config].i_min = min; \
378 p_config[i_config].i_max = max;
380 #define change_float_range( min, max ) \
381 p_config[i_config].f_min = min; \
382 p_config[i_config].f_max = max;
384 #define change_action_add( pf_action, action_text ) \
385 if( !p_config[i_config].i_action ) \
386 { p_config[i_config].ppsz_action_text = 0; \
387 p_config[i_config].ppf_action = 0; } \
388 p_config[i_config].ppf_action = (vlc_callback_t *) \
389 realloc( p_config[i_config].ppf_action, \
390 (p_config[i_config].i_action + 1) * sizeof(void *) ); \
391 p_config[i_config].ppsz_action_text = (char **)\
392 realloc( p_config[i_config].ppsz_action_text, \
393 (p_config[i_config].i_action + 1) * sizeof(void *) ); \
394 p_config[i_config].ppf_action[p_config[i_config].i_action] = pf_action; \
395 p_config[i_config].ppsz_action_text[p_config[i_config].i_action] = \
397 p_config[i_config].i_action++;
399 #define change_internal() \
400 p_config[i_config].b_internal = VLC_TRUE;
402 #define change_autosave() \
403 p_config[i_config].b_autosave = VLC_TRUE;