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, 2000 VideoLAN
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., 59 Temple Place - Suite 330, Boston, MA 02111, 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_CONTROL 102
66 #define SUBCAT_INTERFACE_HOTKEYS 103
69 #define SUBCAT_AUDIO_GENERAL 201
70 #define SUBCAT_AUDIO_AOUT 202
71 #define SUBCAT_AUDIO_AFILTER 203
72 #define SUBCAT_AUDIO_VISUAL 204
73 #define SUBCAT_AUDIO_MISC 205
76 #define SUBCAT_VIDEO_GENERAL 301
77 #define SUBCAT_VIDEO_VOUT 302
78 #define SUBCAT_VIDEO_VFILTER 303
79 #define SUBCAT_VIDEO_TEXT 304
80 #define SUBCAT_VIDEO_SUBPIC 305
83 #define SUBCAT_INPUT_ACCESS 401
84 #define SUBCAT_INPUT_ACCESS_FILTER 402
85 #define SUBCAT_INPUT_DEMUX 403
86 #define SUBCAT_INPUT_VCODEC 404
87 #define SUBCAT_INPUT_ACODEC 405
88 #define SUBCAT_INPUT_SCODEC 406
89 #define SUBCAT_INPUT_ADVANCED 407
92 #define SUBCAT_SOUT_GENERAL 501
93 #define SUBCAT_SOUT_STREAM 502
94 #define SUBCAT_SOUT_MUX 503
95 #define SUBCAT_SOUT_ACO 504
96 #define SUBCAT_SOUT_PACKETIZER 505
97 #define SUBCAT_SOUT_SAP 506
98 #define SUBCAT_SOUT_VOD 507
100 #define CAT_ADVANCED 6
101 #define SUBCAT_ADVANCED_CPU 601
102 #define SUBCAT_ADVANCED_MISC 602
103 #define SUBCAT_ADVANCED_NETWORK 603
104 #define SUBCAT_ADVANCED_XML 604
106 #define CAT_PLAYLIST 7
107 #define SUBCAT_PLAYLIST_GENERAL 701
108 #define SUBCAT_PLAYLIST_SD 702
109 #define SUBCAT_PLAYLIST_EXPORT 703
111 struct config_category_t
118 struct module_config_t
120 int i_type; /* Configuration type */
121 char *psz_type; /* Configuration subtype */
122 char *psz_name; /* Option name */
123 char i_short; /* Optional short option name */
124 char *psz_text; /* Short comment on the configuration option */
125 char *psz_longtext; /* Long comment on the configuration option */
126 char *psz_value; /* Option value */
127 int i_value; /* Option value */
128 float f_value; /* Option value */
129 int i_min; /* Option minimum value */
130 int i_max; /* Option maximum value */
131 float f_min; /* Option minimum value */
132 float f_max; /* Option maximum value */
134 /* Function to call when commiting a change */
135 vlc_callback_t pf_callback;
136 void *p_callback_data;
139 char **ppsz_list; /* List of possible values for the option */
140 int *pi_list; /* Idem for integers */
141 char **ppsz_list_text; /* Friendly names for list values */
142 int i_list; /* Options list size */
145 vlc_callback_t *ppf_action; /* List of possible actions for a config */
146 char **ppsz_action_text; /* Friendly names for actions */
147 int i_action; /* actions list size */
150 char *psz_current; /* Good option name */
151 vlc_bool_t b_strict; /* Transitionnal or strict */
153 vlc_mutex_t *p_lock; /* Lock to use when modifying the config */
154 vlc_bool_t b_dirty; /* Dirty flag to indicate a config change */
155 vlc_bool_t b_advanced; /* Flag to indicate an advanced option */
157 /* Original option values */
158 char *psz_value_orig;
162 /* Option values loaded from config file */
163 char *psz_value_saved;
166 vlc_bool_t b_autosave; /* Config will be auto-saved at exit time */
169 /*****************************************************************************
170 * Prototypes - these methods are used to get, set or manipulate configuration
172 *****************************************************************************/
173 VLC_EXPORT( int, __config_GetType, (vlc_object_t *, const char *) );
174 VLC_EXPORT( int, __config_GetInt, (vlc_object_t *, const char *) );
175 VLC_EXPORT( void, __config_PutInt, (vlc_object_t *, const char *, int) );
176 VLC_EXPORT( float, __config_GetFloat, (vlc_object_t *, const char *) );
177 VLC_EXPORT( void, __config_PutFloat, (vlc_object_t *, const char *, float) );
178 VLC_EXPORT( char *, __config_GetPsz, (vlc_object_t *, const char *) );
179 VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, const char *) );
181 VLC_EXPORT( int, __config_LoadCmdLine, ( vlc_object_t *, int *, char *[], vlc_bool_t ) );
182 VLC_EXPORT( char *, config_GetHomeDir, ( void ) );
183 VLC_EXPORT( int, __config_LoadConfigFile, ( vlc_object_t *, const char * ) );
184 VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
185 VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) );
187 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
188 VLC_EXPORT( module_t *, config_FindModule,( vlc_object_t *, const char * ) );
190 VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
191 void config_Free ( module_t * );
193 VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
194 VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) );
196 #define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
197 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
198 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
199 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
200 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
201 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
202 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
204 #define config_LoadCmdLine(a,b,c,d) __config_LoadCmdLine(VLC_OBJECT(a),b,c,d)
205 #define config_LoadConfigFile(a,b) __config_LoadConfigFile(VLC_OBJECT(a),b)
206 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
207 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
210 int config_CreateDir( vlc_object_t *, char * );
211 int config_AutoSaveConfigFile( vlc_object_t * );
213 /*****************************************************************************
214 * Macros used to build the configuration structure.
216 * Note that internally we support only 3 types of config data: int , float
218 * The other types declared here just map to one of these 3 basic types but
219 * have the advantage of also providing very good hints to a configuration
220 * interface so as to make it more user friendly.
221 * The configuration structure also includes category hints. These hints can
222 * provide a configuration interface with some very useful data and again
223 * allow for a more user friendly interface.
224 *****************************************************************************/
226 #define set_category( i_id ) \
228 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
229 (i_config+11) * sizeof(module_config_t)); \
230 { static module_config_t tmp = { CONFIG_CATEGORY, NULL, NULL , '\0', NULL, NULL, NULL, i_id }; p_config[ i_config ] = tmp; }
232 #define set_subcategory( i_id ) \
234 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
235 (i_config+11) * sizeof(module_config_t)); \
236 { static module_config_t tmp = { CONFIG_SUBCATEGORY, NULL, NULL , '\0', NULL, NULL, NULL, i_id }; p_config[ i_config ] = tmp; }
238 #define set_section( text, longtext) \
240 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
241 (i_config+11) * sizeof(module_config_t)); \
242 { static module_config_t tmp = { CONFIG_SECTION, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; }
244 #define add_category_hint( text, longtext, advc ) \
246 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
247 (i_config+11) * sizeof(module_config_t)); \
248 { static module_config_t tmp = { CONFIG_HINT_CATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; p_config[i_config].b_advanced = advc; }
250 #define add_subcategory_hint( text, longtext ) \
252 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
253 (i_config+11) * sizeof(module_config_t)); \
254 { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; }
257 #define end_subcategory_hint \
259 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
260 (i_config+11) * sizeof(module_config_t)); \
261 { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, '\0' }; p_config[ i_config ] = tmp; }
262 #define add_usage_hint( text ) \
264 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
265 (i_config+11) * sizeof(module_config_t)); \
266 { static module_config_t tmp = { CONFIG_HINT_USAGE, NULL, NULL, '\0', text }; p_config[ i_config ] = tmp; }
269 #define add_string( name, psz_value, p_callback, text, longtext, advc ) \
271 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
272 (i_config+11) * sizeof(module_config_t)); \
273 { static module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value }; tmp.b_advanced = advc; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; }
274 #define add_file( name, psz_value, p_callback, text, longtext, advc ) \
276 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
277 (i_config+11) * sizeof(module_config_t)); \
278 { static module_config_t tmp = { CONFIG_ITEM_FILE, NULL, name, '\0', text, longtext, psz_value, 0, 0 }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
279 #define add_directory( name, psz_value, p_callback, text, longtext, advc ) \
281 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
282 (i_config+11) * sizeof(module_config_t)); \
283 { static module_config_t tmp = { CONFIG_ITEM_DIRECTORY, NULL, name, '\0', text, longtext, psz_value, 0, 0 }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
285 #define add_module( name, psz_caps, psz_value, p_callback, text, longtext, advc ) \
287 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
288 (i_config+11) * sizeof(module_config_t)); \
289 { static module_config_t tmp = { CONFIG_ITEM_MODULE, psz_caps, name, '\0', text, longtext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
291 #define add_module_cat( name, i_subcategory, psz_value, p_callback, text, longtext, advc ) \
293 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
294 (i_config+11) * sizeof(module_config_t)); \
295 { static module_config_t tmp = { CONFIG_ITEM_MODULE_CAT, NULL, name, '\0', text, longtext, psz_value, 0, 0.0, i_subcategory }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
297 #define add_module_list( name, psz_caps, psz_value, p_callback, text, longtext, advc ) \
299 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
300 (i_config+11) * sizeof(module_config_t)); \
301 { static module_config_t tmp = { CONFIG_ITEM_MODULE_LIST, psz_caps, name, '\0', text, longtext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
304 #define add_module_list_cat( name, i_subcategory, psz_value, p_callback, text, longtext, advc ) \
306 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
307 (i_config+11) * sizeof(module_config_t)); \
308 { static module_config_t tmp = { CONFIG_ITEM_MODULE_LIST_CAT, NULL, name, '\0', text, longtext, psz_value, 0, 0.0, i_subcategory }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
310 #define add_integer( name, i_value, p_callback, text, longtext, advc ) \
312 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
313 (i_config+11) * sizeof(module_config_t)); \
314 { static module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, '\0', text, longtext, NULL, i_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
316 #define add_key( name, i_value, p_callback, text, longtext, advc ) \
318 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
319 (i_config+11) * sizeof(module_config_t)); \
320 { static module_config_t tmp = { CONFIG_ITEM_KEY, NULL, name, '\0', text, longtext, NULL, i_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
322 #define add_integer_with_range( name, i_value, i_min, i_max, p_callback, text, longtext, advc ) \
324 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
325 (i_config+11) * sizeof(module_config_t)); \
326 { static module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, '\0', text, longtext, NULL, i_value, 0, i_min, i_max }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
328 #define add_float( name, f_value, p_callback, text, longtext, advc ) \
330 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
331 (i_config+11) * sizeof(module_config_t)); \
332 { static module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, '\0', text, longtext, NULL, 0, f_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
334 #define add_float_with_range( name, f_value, f_min, f_max, p_callback, text, longtext, advc ) \
336 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
337 (i_config+11) * sizeof(module_config_t)); \
338 { static module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, '\0', text, longtext, NULL, 0, f_value, 0, 0, f_min, f_max }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
340 #define add_bool( name, b_value, p_callback, text, longtext, advc ) \
342 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
343 (i_config+11) * sizeof(module_config_t)); \
344 { static module_config_t tmp = { CONFIG_ITEM_BOOL, NULL, name, '\0', text, longtext, NULL, b_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
346 #define add_deprecated( name, strict ) \
348 if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
349 (i_config+11) * sizeof(module_config_t)); \
350 { static module_config_t tmp={}; \
351 p_config[ i_config ] = tmp; \
352 p_config[ i_config ].i_type = p_config[ i_config -1 ].i_type; \
353 p_config[ i_config ].psz_name = name; \
354 p_config[i_config].b_strict = strict; \
355 p_config[ i_config ].psz_current = p_config[ i_config-1].psz_current?p_config[ i_config-1 ].psz_current:p_config[ i_config-1 ].psz_name; }
357 /* Modifier macros for the config options (used for fine tuning) */
358 #define change_short( ch ) \
359 p_config[i_config].i_short = ch;
361 #define change_string_list( list, list_text, list_update_func ) \
362 p_config[i_config].i_list = sizeof(list)/sizeof(char *); \
363 p_config[i_config].ppsz_list = list; \
364 p_config[i_config].ppsz_list_text = list_text;
366 #define change_integer_list( list, list_text, list_update_func ) \
367 p_config[i_config].i_list = sizeof(list)/sizeof(int); \
368 p_config[i_config].pi_list = list; \
369 p_config[i_config].ppsz_list_text = list_text;
371 #define change_integer_range( min, max ) \
372 p_config[i_config].i_min = min; \
373 p_config[i_config].i_max = max;
375 #define change_float_range( min, max ) \
376 p_config[i_config].f_min = min; \
377 p_config[i_config].f_max = max;
379 #define change_action_add( pf_action, action_text ) \
380 if( !p_config[i_config].i_action ) \
381 { p_config[i_config].ppsz_action_text = 0; \
382 p_config[i_config].ppf_action = 0; } \
383 p_config[i_config].ppf_action = (vlc_callback_t *) \
384 realloc( p_config[i_config].ppf_action, \
385 (p_config[i_config].i_action + 1) * sizeof(void *) ); \
386 p_config[i_config].ppsz_action_text = (char **)\
387 realloc( p_config[i_config].ppsz_action_text, \
388 (p_config[i_config].i_action + 1) * sizeof(void *) ); \
389 p_config[i_config].ppf_action[p_config[i_config].i_action] = pf_action; \
390 p_config[i_config].ppsz_action_text[p_config[i_config].i_action] = \
392 p_config[i_config].i_action++;
394 #define change_autosave() \
395 p_config[i_config].b_autosave = VLC_TRUE;