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 #if !defined( __LIBVLC__ )
27 #error You are not libvlc or one of its plugins. You cannot include this file
30 #ifndef _VLC_CONFIGURATION_H
31 #define _VLC_CONFIGURATION_H 1
38 /*****************************************************************************
39 * Macros used to build the configuration structure.
40 *****************************************************************************/
42 /* Configuration hint types */
45 #define CONFIG_HINT_CATEGORY 0x0002 /* Start of new category */
46 #define CONFIG_HINT_SUBCATEGORY 0x0003 /* Start of sub-category */
47 #define CONFIG_HINT_SUBCATEGORY_END 0x0004 /* End of sub-category */
48 #define CONFIG_HINT_USAGE 0x0005 /* Usage information */
50 #define CONFIG_CATEGORY 0x0006 /* Set category */
51 #define CONFIG_SUBCATEGORY 0x0007 /* Set subcategory */
52 #define CONFIG_SECTION 0x0008 /* Start of new section */
54 #define CONFIG_HINT 0x000F
56 /* Configuration item types */
57 #define CONFIG_ITEM_STRING 0x0010 /* String option */
58 #define CONFIG_ITEM_FILE 0x0020 /* File option */
59 #define CONFIG_ITEM_MODULE 0x0030 /* Module option */
60 #define CONFIG_ITEM_INTEGER 0x0040 /* Integer option */
61 #define CONFIG_ITEM_BOOL 0x0050 /* Bool option */
62 #define CONFIG_ITEM_FLOAT 0x0060 /* Float option */
63 #define CONFIG_ITEM_DIRECTORY 0x0070 /* Directory option */
64 #define CONFIG_ITEM_KEY 0x0080 /* Hot key option */
65 #define CONFIG_ITEM_MODULE_CAT 0x0090 /* Module option */
66 #define CONFIG_ITEM_MODULE_LIST 0x00A0 /* Module option */
67 #define CONFIG_ITEM_MODULE_LIST_CAT 0x00B0 /* Module option */
68 #define CONFIG_ITEM_FONT 0x00C0 /* Font option */
69 #define CONFIG_ITEM_PASSWORD 0x00D0 /* Password option (*) */
71 #define CONFIG_ITEM 0x00F0
73 /*******************************************************************
74 * All predefined categories and subcategories
75 *******************************************************************/
76 #define CAT_INTERFACE 1
77 #define SUBCAT_INTERFACE_GENERAL 101
78 #define SUBCAT_INTERFACE_MAIN 102
79 #define SUBCAT_INTERFACE_CONTROL 103
80 #define SUBCAT_INTERFACE_HOTKEYS 104
83 #define SUBCAT_AUDIO_GENERAL 201
84 #define SUBCAT_AUDIO_AOUT 202
85 #define SUBCAT_AUDIO_AFILTER 203
86 #define SUBCAT_AUDIO_VISUAL 204
87 #define SUBCAT_AUDIO_MISC 205
90 #define SUBCAT_VIDEO_GENERAL 301
91 #define SUBCAT_VIDEO_VOUT 302
92 #define SUBCAT_VIDEO_VFILTER 303
93 #define SUBCAT_VIDEO_TEXT 304
94 #define SUBCAT_VIDEO_SUBPIC 305
95 #define SUBCAT_VIDEO_VFILTER2 306
98 #define SUBCAT_INPUT_GENERAL 401
99 #define SUBCAT_INPUT_ACCESS 402
100 #define SUBCAT_INPUT_ACCESS_FILTER 403
101 #define SUBCAT_INPUT_DEMUX 404
102 #define SUBCAT_INPUT_VCODEC 405
103 #define SUBCAT_INPUT_ACODEC 406
104 #define SUBCAT_INPUT_SCODEC 407
107 #define SUBCAT_SOUT_GENERAL 501
108 #define SUBCAT_SOUT_STREAM 502
109 #define SUBCAT_SOUT_MUX 503
110 #define SUBCAT_SOUT_ACO 504
111 #define SUBCAT_SOUT_PACKETIZER 505
112 #define SUBCAT_SOUT_SAP 506
113 #define SUBCAT_SOUT_VOD 507
115 #define CAT_ADVANCED 6
116 #define SUBCAT_ADVANCED_CPU 601
117 #define SUBCAT_ADVANCED_MISC 602
118 #define SUBCAT_ADVANCED_NETWORK 603
119 #define SUBCAT_ADVANCED_XML 604
121 #define CAT_PLAYLIST 7
122 #define SUBCAT_PLAYLIST_GENERAL 701
123 #define SUBCAT_PLAYLIST_SD 702
124 #define SUBCAT_PLAYLIST_EXPORT 703
127 #define SUBCAT_OSD_IMPORT 801
129 struct config_category_t
132 const char *psz_name;
133 const char *psz_help;
149 struct module_config_t
151 int i_type; /* Configuration type */
152 char *psz_type; /* Configuration subtype */
153 char *psz_name; /* Option name */
154 char i_short; /* Optional short option name */
155 char *psz_text; /* Short comment on the configuration option */
156 char *psz_longtext; /* Long comment on the configuration option */
157 module_value_t value; /* Option value */
159 module_value_t saved;
163 /* Function to call when commiting a change */
164 vlc_callback_t pf_callback;
165 void *p_callback_data;
168 char ** ppsz_list; /* List of possible values for the option */
169 int *pi_list; /* Idem for integers */
170 char **ppsz_list_text; /* Friendly names for list values */
171 int i_list; /* Options list size */
172 vlc_callback_t pf_update_list; /*callback to initialize dropdownlists */
175 vlc_callback_t *ppf_action; /* List of possible actions for a config */
176 char **ppsz_action_text; /* Friendly names for actions */
177 int i_action; /* actions list size */
180 vlc_mutex_t *p_lock; /* Lock to use when modifying the config */
181 bool b_dirty; /* Dirty flag to indicate a config change */
182 bool b_advanced; /* Flag to indicate an advanced option */
183 bool b_internal; /* Flag to indicate option is not to be shown */
184 bool b_restart; /* Flag to indicate the option needs a restart */
188 char *psz_oldname; /* Old option name */
191 /* Option values loaded from config file */
192 bool b_autosave; /* Config will be auto-saved at exit time */
193 bool b_unsaveable; /* Config should not be saved */
198 /*****************************************************************************
199 * Prototypes - these methods are used to get, set or manipulate configuration
201 *****************************************************************************/
202 VLC_EXPORT( int, __config_GetType, (vlc_object_t *, const char *) );
203 VLC_EXPORT( int, __config_GetInt, (vlc_object_t *, const char *) );
204 VLC_EXPORT( void, __config_PutInt, (vlc_object_t *, const char *, int) );
205 VLC_EXPORT( float, __config_GetFloat, (vlc_object_t *, const char *) );
206 VLC_EXPORT( void, __config_PutFloat, (vlc_object_t *, const char *, float) );
207 VLC_EXPORT( char *, __config_GetPsz, (vlc_object_t *, const char *) );
208 VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, const char *) );
210 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
211 VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
212 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
213 VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) );
215 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
217 VLC_EXPORT(const char *, config_GetDataDir, ( void ));
218 VLC_EXPORT(const char *, config_GetConfDir, ( void ) );
219 VLC_EXPORT(char *, config_GetUserConfDir, ( void ) );
220 VLC_EXPORT(char *, config_GetUserDataDir, ( void ) );
221 VLC_EXPORT(char *, config_GetCacheDir, ( void ) );
223 VLC_EXPORT( void, __config_AddIntf, ( vlc_object_t *, const char * ) );
224 VLC_EXPORT( void, __config_RemoveIntf, ( vlc_object_t *, const char * ) );
225 VLC_EXPORT( bool, __config_ExistIntf, ( vlc_object_t *, const char * ) );
227 #define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
228 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
229 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
230 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
231 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
232 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
233 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
235 #define config_AddIntf(a,b) __config_AddIntf(VLC_OBJECT(a),b)
236 #define config_RemoveIntf(a,b) __config_RemoveIntf(VLC_OBJECT(a),b)
237 #define config_ExistIntf(a,b) __config_ExistIntf(VLC_OBJECT(a),b)
239 enum vlc_config_properties
241 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
242 * Append new items at the end ONLY. */
245 /* command line name (args=const char *, vlc_callback_t) */
248 /* description (args=const char *, const char *) */
251 /* actual value (args=int/double/const char *) */
254 /* minimum value (args=int/double/const char * twice) */
257 /* enable advanced flag (args=none) */
260 /* don't write variable to storage (args=none) */
262 VLC_CONFIG_PERSISTENT,
263 /* always write variable to storage (args=none) */
266 /* restart required to apply value change (args=none) */
269 /* hide from user (args=none) */
272 /* tag as no longer supported (args=none) */
274 VLC_CONFIG_CAPABILITY,
275 /* capability for a module or list thereof (args=const char*) */
278 /* one-character (short) command line option name (args=char) */
281 /* possible values list
282 * (args=size_t, const <type> *, const char *const *) */
284 VLC_CONFIG_ADD_ACTION,
285 /* add value change callback (args=vlc_callback_t, const char *) */
288 /* former option name (args=const char *) */
291 /* tag as modifiable by untrusted input item "sources" (args=none) */
295 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
296 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
298 /*****************************************************************************
299 * Macros used to build the configuration structure.
301 * Note that internally we support only 3 types of config data: int, float
303 * The other types declared here just map to one of these 3 basic types but
304 * have the advantage of also providing very good hints to a configuration
305 * interface so as to make it more user friendly.
306 * The configuration structure also includes category hints. These hints can
307 * provide a configuration interface with some very useful data and again
308 * allow for a more user friendly interface.
309 *****************************************************************************/
311 #define add_type_inner( type ) \
312 p_config = vlc_config_create (p_module, type)
314 #define add_typedesc_inner( type, text, longtext ) \
315 add_type_inner( type ); \
316 vlc_config_set (p_config, VLC_CONFIG_DESC, \
317 (const char *)(text), (const char *)(longtext))
319 #define add_typeadv_inner( type, text, longtext, advc ) \
320 add_typedesc_inner( type, text, longtext ); \
321 if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED)
323 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
324 add_typeadv_inner( type, text, longtext, advc ); \
325 vlc_config_set (p_config, VLC_CONFIG_NAME, \
326 (const char *)(name), (vlc_callback_t)(cb))
328 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
329 add_typename_inner( type, name, text, longtext, advc, cb ); \
330 vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v))
332 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
333 add_typename_inner( type, name, text, longtext, advc, cb ); \
334 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v))
337 #define set_category( i_id ) \
338 add_type_inner( CONFIG_CATEGORY ); \
339 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
341 #define set_subcategory( i_id ) \
342 add_type_inner( CONFIG_SUBCATEGORY ); \
343 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
345 #define set_section( text, longtext ) \
346 add_typedesc_inner( CONFIG_SECTION, text, longtext )
348 #define add_category_hint( text, longtext, advc ) \
349 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
351 #define add_subcategory_hint( text, longtext ) \
352 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
354 #define end_subcategory_hint \
355 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
357 #define add_usage_hint( text ) \
358 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
360 #define add_string( name, value, p_callback, text, longtext, advc ) \
361 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value )
363 #define add_password( name, value, p_callback, text, longtext, advc ) \
364 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, p_callback, value )
366 #define add_file( name, value, p_callback, text, longtext, advc ) \
367 add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value )
369 #define add_directory( name, value, p_callback, text, longtext, advc ) \
370 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value )
372 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
373 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \
374 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
376 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
377 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \
378 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
381 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
382 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \
383 p_config->min.i = i_subcategory /* gruik */
385 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
386 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \
387 p_config->min.i = i_subcategory /* gruik */
390 #define add_integer( name, value, p_callback, text, longtext, advc ) \
391 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
393 #define add_key( name, value, p_callback, text, longtext, advc ) \
394 add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value )
396 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
397 add_integer( name, value, p_callback, text, longtext, advc ); \
398 change_integer_range( i_min, i_max )
400 #define add_float( name, v, p_callback, text, longtext, advc ) \
401 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \
402 vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v))
404 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
405 add_float( name, value, p_callback, text, longtext, advc ); \
406 change_float_range( f_min, f_max )
408 #define add_bool( name, v, p_callback, text, longtext, advc ) \
409 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \
410 if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true)
412 /* For removed option */
413 #define add_obsolete_inner( name, type ) \
414 add_type_inner( type ); \
415 vlc_config_set (p_config, VLC_CONFIG_NAME, \
416 (const char *)(name), (vlc_callback_t)NULL); \
417 vlc_config_set (p_config, VLC_CONFIG_REMOVED)
419 #define add_obsolete_bool( name ) \
420 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
422 #define add_obsolete_integer( name ) \
423 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
425 #define add_obsolete_float( name ) \
426 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
428 #define add_obsolete_string( name ) \
429 add_obsolete_inner( name, CONFIG_ITEM_STRING )
431 /* Modifier macros for the config options (used for fine tuning) */
433 #define add_deprecated_alias( name ) \
434 vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))
436 #define change_short( ch ) \
437 vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch))
439 #define change_string_list( list, list_text, list_update_func ) \
440 vlc_config_set (p_config, VLC_CONFIG_LIST, \
441 (size_t)(sizeof (list) / sizeof (char *)), \
442 (const char *const *)(list), \
443 (const char *const *)(list_text), \
446 #define change_integer_list( list, list_text, list_update_func ) \
447 vlc_config_set (p_config, VLC_CONFIG_LIST, \
448 (size_t)(sizeof (list) / sizeof (int)), \
449 (const int *)(list), \
450 (const char *const *)(list_text), \
453 #define change_float_list( list, list_text, list_update_func ) \
454 vlc_config_set (p_config, VLC_CONFIG_LIST, \
455 (size_t)(sizeof (list) / sizeof (float)), \
456 (const float *)(list), \
457 (const char *const *)(list_text), \
460 #define change_integer_range( minv, maxv ) \
461 vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv))
463 #define change_float_range( minv, maxv ) \
464 vlc_config_set (p_config, VLC_CONFIG_RANGE, \
465 (double)(minv), (double)(maxv))
467 #define change_action_add( pf_action, text ) \
468 vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
469 (vlc_callback_t)(pf_action), (const char *)(text))
471 #define change_internal() \
472 vlc_config_set (p_config, VLC_CONFIG_PRIVATE)
474 #define change_need_restart() \
475 vlc_config_set (p_config, VLC_CONFIG_RESTART)
477 #define change_autosave() \
478 vlc_config_set (p_config, VLC_CONFIG_PERSISTENT)
480 #define change_unsaveable() \
481 vlc_config_set (p_config, VLC_CONFIG_VOLATILE)
483 #define change_unsafe() (void)0 /* no-op */
485 #define change_safe() \
486 vlc_config_set (p_config, VLC_CONFIG_SAFE)
488 /****************************************************************************
490 ****************************************************************************/
491 struct config_chain_t
493 config_chain_t *p_next;
499 #define config_ChainParse( a, b, c, d ) __config_ChainParse( VLC_OBJECT(a), b, c, d )
500 VLC_EXPORT( void, __config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * ) );
501 VLC_EXPORT( char *, config_ChainCreate, ( char **, config_chain_t **, const char * ) );
502 VLC_EXPORT( void, config_ChainDestroy, ( config_chain_t * ) );
508 #endif /* _VLC_CONFIGURATION_H */