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 #ifndef VLC_CONFIGURATION_H
27 #define VLC_CONFIGURATION_H 1
31 * This file describes the programming interface for the configuration module.
32 * It includes functions allowing to declare, get or set configuration options.
39 /*****************************************************************************
40 * Macros used to build the configuration structure.
41 *****************************************************************************/
43 /* Configuration hint types */
46 #define CONFIG_HINT_CATEGORY 0x0002 /* Start of new category */
47 #define CONFIG_HINT_SUBCATEGORY 0x0003 /* Start of sub-category */
48 #define CONFIG_HINT_SUBCATEGORY_END 0x0004 /* End of sub-category */
49 #define CONFIG_HINT_USAGE 0x0005 /* Usage information */
51 #define CONFIG_CATEGORY 0x0006 /* Set category */
52 #define CONFIG_SUBCATEGORY 0x0007 /* Set subcategory */
53 #define CONFIG_SECTION 0x0008 /* Start of new section */
55 #define CONFIG_HINT 0x000F
57 /* Configuration item types */
58 #define CONFIG_ITEM_STRING 0x0010 /* String option */
60 #define CONFIG_ITEM_MODULE 0x0030 /* Module option */
61 #define CONFIG_ITEM_INTEGER 0x0040 /* Integer option */
62 #define CONFIG_ITEM_BOOL 0x0050 /* Bool option */
63 #define CONFIG_ITEM_FLOAT 0x0060 /* Float option */
64 #define CONFIG_ITEM_DIRECTORY 0x0070 /* Directory option */
65 #define CONFIG_ITEM_KEY 0x0080 /* Hot key option */
66 #define CONFIG_ITEM_MODULE_CAT 0x0090 /* Module option */
67 #define CONFIG_ITEM_MODULE_LIST 0x00A0 /* Module option */
68 #define CONFIG_ITEM_MODULE_LIST_CAT 0x00B0 /* Module option */
69 #define CONFIG_ITEM_FONT 0x00C0 /* Font option */
70 #define CONFIG_ITEM_PASSWORD 0x00D0 /* Password option (*) */
71 #define CONFIG_ITEM_LOADFILE 0x00E0 /* Read file option */
72 #define CONFIG_ITEM_SAVEFILE 0x00F0 /* Written file option */
74 #define CONFIG_ITEM 0x00F0
76 /*******************************************************************
77 * All predefined categories and subcategories
78 *******************************************************************/
79 #define CAT_INTERFACE 1
80 #define SUBCAT_INTERFACE_GENERAL 101
81 #define SUBCAT_INTERFACE_MAIN 102
82 #define SUBCAT_INTERFACE_CONTROL 103
83 #define SUBCAT_INTERFACE_HOTKEYS 104
86 #define SUBCAT_AUDIO_GENERAL 201
87 #define SUBCAT_AUDIO_AOUT 202
88 #define SUBCAT_AUDIO_AFILTER 203
89 #define SUBCAT_AUDIO_VISUAL 204
90 #define SUBCAT_AUDIO_MISC 205
93 #define SUBCAT_VIDEO_GENERAL 301
94 #define SUBCAT_VIDEO_VOUT 302
95 #define SUBCAT_VIDEO_VFILTER 303
96 #define SUBCAT_VIDEO_TEXT 304
97 #define SUBCAT_VIDEO_SUBPIC 305
98 #define SUBCAT_VIDEO_VFILTER2 306
101 #define SUBCAT_INPUT_GENERAL 401
102 #define SUBCAT_INPUT_ACCESS 402
103 #define SUBCAT_INPUT_DEMUX 403
104 #define SUBCAT_INPUT_VCODEC 404
105 #define SUBCAT_INPUT_ACODEC 405
106 #define SUBCAT_INPUT_SCODEC 406
107 #define SUBCAT_INPUT_STREAM_FILTER 407
110 #define SUBCAT_SOUT_GENERAL 501
111 #define SUBCAT_SOUT_STREAM 502
112 #define SUBCAT_SOUT_MUX 503
113 #define SUBCAT_SOUT_ACO 504
114 #define SUBCAT_SOUT_PACKETIZER 505
115 #define SUBCAT_SOUT_SAP 506
116 #define SUBCAT_SOUT_VOD 507
118 #define CAT_ADVANCED 6
119 #define SUBCAT_ADVANCED_CPU 601
120 #define SUBCAT_ADVANCED_MISC 602
121 #define SUBCAT_ADVANCED_NETWORK 603
122 #define SUBCAT_ADVANCED_XML 604
124 #define CAT_PLAYLIST 7
125 #define SUBCAT_PLAYLIST_GENERAL 701
126 #define SUBCAT_PLAYLIST_SD 702
127 #define SUBCAT_PLAYLIST_EXPORT 703
130 #define SUBCAT_OSD_IMPORT 801
132 struct config_category_t
135 const char *psz_name;
136 const char *psz_help;
146 struct module_config_t
148 char *psz_type; /* Configuration subtype */
149 char *psz_name; /* Option name */
150 char *psz_text; /* Short comment on the configuration option */
151 char *psz_longtext; /* Long comment on the configuration option */
152 module_value_t value; /* Option value */
154 module_value_t saved;
158 /* Function to call when commiting a change */
159 vlc_callback_t pf_callback;
160 void *p_callback_data;
163 char ** ppsz_list; /* List of possible values for the option */
164 int *pi_list; /* Idem for integers */
165 char **ppsz_list_text; /* Friendly names for list values */
166 int i_list; /* Options list size */
167 int i_type; /* Configuration type */
168 vlc_callback_t pf_update_list; /*callback to initialize dropdownlists */
169 char i_short; /* Optional short option name */
172 int i_action; /* actions list size */
173 vlc_callback_t *ppf_action; /* List of possible actions for a config */
174 char **ppsz_action_text; /* Friendly names for actions */
177 char *psz_oldname; /* Old option name */
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 */
186 /* Option values loaded from config file */
187 bool b_autosave; /* Config will be auto-saved at exit time */
188 bool b_unsaveable; /* Config should not be saved */
193 /*****************************************************************************
194 * Prototypes - these methods are used to get, set or manipulate configuration
196 *****************************************************************************/
197 VLC_EXPORT( int, config_GetType, (vlc_object_t *, const char *) LIBVLC_USED );
198 VLC_EXPORT( int64_t, config_GetInt, (vlc_object_t *, const char *) LIBVLC_USED );
199 VLC_EXPORT( void, config_PutInt, (vlc_object_t *, const char *, int64_t) );
200 VLC_EXPORT( float, config_GetFloat, (vlc_object_t *, const char *) LIBVLC_USED );
201 VLC_EXPORT( void, config_PutFloat, (vlc_object_t *, const char *, float) );
202 VLC_EXPORT( char *, config_GetPsz, (vlc_object_t *, const char *) LIBVLC_USED );
203 VLC_EXPORT( void, config_PutPsz, (vlc_object_t *, const char *, const char *) );
205 VLC_EXPORT( int, config_SaveConfigFile, ( vlc_object_t *, const char * ) );
206 #define config_SaveConfigFile(a,b) config_SaveConfigFile(VLC_OBJECT(a),b)
207 VLC_EXPORT( void, config_ResetAll, ( vlc_object_t * ) );
208 #define config_ResetAll(a) config_ResetAll(VLC_OBJECT(a))
210 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) LIBVLC_USED );
211 VLC_EXPORT(char *, config_GetDataDir, ( vlc_object_t * ) LIBVLC_USED);
212 #define config_GetDataDir(a) config_GetDataDir(VLC_OBJECT(a))
213 VLC_EXPORT(const char *, config_GetLibDir, ( void ) LIBVLC_USED);
214 VLC_EXPORT(const char *, config_GetConfDir, ( void ) LIBVLC_USED);
216 typedef enum vlc_userdir
218 VLC_HOME_DIR, /* User's home */
219 VLC_CONFIG_DIR, /* VLC-specific configuration directory */
220 VLC_DATA_DIR, /* VLC-specific data directory */
221 VLC_CACHE_DIR, /* VLC-specific user cached data directory */
222 /* Generic directories (same as XDG) */
223 VLC_DESKTOP_DIR=0x80,
233 VLC_EXPORT(char *, config_GetUserDir, ( vlc_userdir_t ) LIBVLC_USED);
235 VLC_EXPORT( void, config_AddIntf, ( vlc_object_t *, const char * ) );
236 VLC_EXPORT( void, config_RemoveIntf, ( vlc_object_t *, const char * ) );
237 VLC_EXPORT( bool, config_ExistIntf, ( vlc_object_t *, const char * ) LIBVLC_USED);
239 #define config_GetType(a,b) config_GetType(VLC_OBJECT(a),b)
240 #define config_GetInt(a,b) config_GetInt(VLC_OBJECT(a),b)
241 #define config_PutInt(a,b,c) config_PutInt(VLC_OBJECT(a),b,c)
242 #define config_GetFloat(a,b) config_GetFloat(VLC_OBJECT(a),b)
243 #define config_PutFloat(a,b,c) config_PutFloat(VLC_OBJECT(a),b,c)
244 #define config_GetPsz(a,b) config_GetPsz(VLC_OBJECT(a),b)
245 #define config_PutPsz(a,b,c) config_PutPsz(VLC_OBJECT(a),b,c)
247 #define config_AddIntf(a,b) config_AddIntf(VLC_OBJECT(a),b)
248 #define config_RemoveIntf(a,b) config_RemoveIntf(VLC_OBJECT(a),b)
249 #define config_ExistIntf(a,b) config_ExistIntf(VLC_OBJECT(a),b)
251 /****************************************************************************
253 ****************************************************************************/
254 struct config_chain_t
256 config_chain_t *p_next; /**< Pointer on the next config_chain_t element */
258 char *psz_name; /**< Option name */
259 char *psz_value; /**< Option value */
264 * - create all options in the array ppsz_options (var_Create).
265 * - parse the given linked list of config_chain_t and set the value (var_Set).
267 * The option names will be created by adding the psz_prefix prefix.
269 VLC_EXPORT( void, config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * ) );
270 #define config_ChainParse( a, b, c, d ) config_ChainParse( VLC_OBJECT(a), b, c, d )
273 * This function will parse a configuration string (psz_string) and
274 * - set the module name (*ppsz_name)
275 * - set all options for this module in a chained list (*pp_cfg)
276 * - returns a pointer on the next module if any.
278 * The string format is
279 * module{option=*,option=*}[:modulenext{option=*,...}]
281 * The options values are unescaped using config_StringUnescape.
283 VLC_EXPORT( char *, config_ChainCreate, ( char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string ) ) LIBVLC_USED LIBVLC_MALLOC;
286 * This function will release a linked list of config_chain_t
287 * (Including the head)
289 VLC_EXPORT( void, config_ChainDestroy, ( config_chain_t * ) );
292 * This function will duplicate a linked list of config_chain_t
294 VLC_EXPORT( config_chain_t *, config_ChainDuplicate, ( const config_chain_t * ) );
297 * This function will unescape a string in place and will return a pointer on
299 * No memory is allocated by it (unlike config_StringEscape).
300 * If NULL is given as parameter nothing will be done (NULL will be returned).
302 * The following sequences will be unescaped (only one time):
305 VLC_EXPORT( char *, config_StringUnescape, ( char *psz_string ) );
308 * This function will escape a string that can be unescaped by
309 * config_StringUnescape.
310 * The returned value is allocated by it. You have to free it once you
311 * do not need it anymore (unlike config_StringUnescape).
312 * If NULL is given as parameter nothing will be done (NULL will be returned).
314 * The escaped characters are ' " and \
316 VLC_EXPORT( char *, config_StringEscape, ( const char *psz_string ) LIBVLC_USED);
322 #endif /* _VLC_CONFIGURATION_H */