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 0x02 /* Start of new category */
47 #define CONFIG_HINT_SUBCATEGORY 0x03 /* Start of sub-category */
48 #define CONFIG_HINT_SUBCATEGORY_END 0x04 /* End of sub-category */
49 #define CONFIG_HINT_USAGE 0x05 /* Usage information */
51 #define CONFIG_CATEGORY 0x06 /* Set category */
52 #define CONFIG_SUBCATEGORY 0x07 /* Set subcategory */
53 #define CONFIG_SECTION 0x08 /* Start of new section */
55 /* Configuration item types */
56 #define CONFIG_ITEM_STRING 0x10 /* String option */
58 #define CONFIG_ITEM_MODULE 0x30 /* Module option */
59 #define CONFIG_ITEM_INTEGER 0x40 /* Integer option */
60 #define CONFIG_ITEM_BOOL 0x50 /* Bool option */
61 #define CONFIG_ITEM_FLOAT 0x60 /* Float option */
62 #define CONFIG_ITEM_DIRECTORY 0x70 /* Directory option */
63 #define CONFIG_ITEM_KEY 0x80 /* Hot key option */
64 #define CONFIG_ITEM_MODULE_CAT 0x90 /* Module option */
65 #define CONFIG_ITEM_MODULE_LIST 0xA0 /* Module option */
66 #define CONFIG_ITEM_MODULE_LIST_CAT 0xB0 /* Module option */
67 #define CONFIG_ITEM_FONT 0xC0 /* Font option */
68 #define CONFIG_ITEM_PASSWORD 0xD0 /* Password option (*) */
69 #define CONFIG_ITEM_LOADFILE 0xE0 /* Read file option */
70 #define CONFIG_ITEM_SAVEFILE 0xF0 /* Written file option */
72 #define CONFIG_ITEM(x) (((x) & 0xF0) != 0)
74 /*******************************************************************
75 * All predefined categories and subcategories
76 *******************************************************************/
77 #define CAT_INTERFACE 1
78 #define SUBCAT_INTERFACE_GENERAL 101
79 #define SUBCAT_INTERFACE_MAIN 102
80 #define SUBCAT_INTERFACE_CONTROL 103
81 #define SUBCAT_INTERFACE_HOTKEYS 104
84 #define SUBCAT_AUDIO_GENERAL 201
85 #define SUBCAT_AUDIO_AOUT 202
86 #define SUBCAT_AUDIO_AFILTER 203
87 #define SUBCAT_AUDIO_VISUAL 204
88 #define SUBCAT_AUDIO_MISC 205
91 #define SUBCAT_VIDEO_GENERAL 301
92 #define SUBCAT_VIDEO_VOUT 302
93 #define SUBCAT_VIDEO_VFILTER 303
94 #define SUBCAT_VIDEO_TEXT 304
95 #define SUBCAT_VIDEO_SUBPIC 305
96 #define SUBCAT_VIDEO_VFILTER2 306
99 #define SUBCAT_INPUT_GENERAL 401
100 #define SUBCAT_INPUT_ACCESS 402
101 #define SUBCAT_INPUT_DEMUX 403
102 #define SUBCAT_INPUT_VCODEC 404
103 #define SUBCAT_INPUT_ACODEC 405
104 #define SUBCAT_INPUT_SCODEC 406
105 #define SUBCAT_INPUT_STREAM_FILTER 407
108 #define SUBCAT_SOUT_GENERAL 501
109 #define SUBCAT_SOUT_STREAM 502
110 #define SUBCAT_SOUT_MUX 503
111 #define SUBCAT_SOUT_ACO 504
112 #define SUBCAT_SOUT_PACKETIZER 505
113 #define SUBCAT_SOUT_SAP 506
114 #define SUBCAT_SOUT_VOD 507
116 #define CAT_ADVANCED 6
117 #define SUBCAT_ADVANCED_CPU 601
118 #define SUBCAT_ADVANCED_MISC 602
119 #define SUBCAT_ADVANCED_NETWORK 603
120 #define SUBCAT_ADVANCED_XML 604
122 #define CAT_PLAYLIST 7
123 #define SUBCAT_PLAYLIST_GENERAL 701
124 #define SUBCAT_PLAYLIST_SD 702
125 #define SUBCAT_PLAYLIST_EXPORT 703
128 #define SUBCAT_OSD_IMPORT 801
130 struct config_category_t
133 const char *psz_name;
134 const char *psz_help;
144 struct module_config_t
146 char *psz_type; /* Configuration subtype */
147 char *psz_name; /* Option name */
148 char *psz_text; /* Short comment on the configuration option */
149 char *psz_longtext; /* Long comment on the configuration option */
150 module_value_t value; /* Option value */
156 char ** ppsz_list; /* List of possible values for the option */
157 int *pi_list; /* Idem for integers */
158 char **ppsz_list_text; /* Friendly names for list values */
159 int i_list; /* Options list size */
160 vlc_callback_t pf_update_list; /* Callback to initialize dropdown lists */
161 uint8_t i_type; /* Configuration type */
162 char i_short; /* Optional short option name */
165 unsigned b_dirty:1; /* Dirty flag to indicate a config change */
166 unsigned b_advanced:1; /* Flag to indicate an advanced option */
167 unsigned b_internal:1; /* Flag to indicate option is not to be shown */
168 unsigned b_unsaveable:1; /* Config should not be saved */
169 unsigned b_safe:1; /* Safe to use in web plugins and playlists */
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 /*****************************************************************************
182 * Prototypes - these methods are used to get, set or manipulate configuration
184 *****************************************************************************/
185 VLC_API int config_GetType(vlc_object_t *, const char *) VLC_USED;
186 VLC_API int64_t config_GetInt(vlc_object_t *, const char *) VLC_USED;
187 VLC_API void config_PutInt(vlc_object_t *, const char *, int64_t);
188 VLC_API float config_GetFloat(vlc_object_t *, const char *) VLC_USED;
189 VLC_API void config_PutFloat(vlc_object_t *, const char *, float);
190 VLC_API char * config_GetPsz(vlc_object_t *, const char *) VLC_USED VLC_MALLOC;
191 VLC_API void config_PutPsz(vlc_object_t *, const char *, const char *);
193 VLC_API int config_SaveConfigFile( vlc_object_t * );
194 #define config_SaveConfigFile(a) config_SaveConfigFile(VLC_OBJECT(a))
196 VLC_API void config_ResetAll( vlc_object_t * );
197 #define config_ResetAll(a) config_ResetAll(VLC_OBJECT(a))
199 VLC_API module_config_t * config_FindConfig( vlc_object_t *, const char * ) VLC_USED;
200 VLC_API char * config_GetDataDir( vlc_object_t * ) VLC_USED VLC_MALLOC;
201 #define config_GetDataDir(a) config_GetDataDir(VLC_OBJECT(a))
202 VLC_API const char * config_GetLibDir( void ) VLC_USED;
203 VLC_API const char * config_GetConfDir( void ) VLC_USED;
205 typedef enum vlc_userdir
207 VLC_HOME_DIR, /* User's home */
208 VLC_CONFIG_DIR, /* VLC-specific configuration directory */
209 VLC_DATA_DIR, /* VLC-specific data directory */
210 VLC_CACHE_DIR, /* VLC-specific user cached data directory */
211 /* Generic directories (same as XDG) */
212 VLC_DESKTOP_DIR=0x80,
222 VLC_API char * config_GetUserDir( vlc_userdir_t ) VLC_USED VLC_MALLOC;
224 VLC_API void config_AddIntf( vlc_object_t *, const char * );
225 VLC_API void config_RemoveIntf( vlc_object_t *, const char * );
226 VLC_API bool config_ExistIntf( vlc_object_t *, const char * ) VLC_USED;
228 #define config_GetType(a,b) config_GetType(VLC_OBJECT(a),b)
229 #define config_GetInt(a,b) config_GetInt(VLC_OBJECT(a),b)
230 #define config_PutInt(a,b,c) config_PutInt(VLC_OBJECT(a),b,c)
231 #define config_GetFloat(a,b) config_GetFloat(VLC_OBJECT(a),b)
232 #define config_PutFloat(a,b,c) config_PutFloat(VLC_OBJECT(a),b,c)
233 #define config_GetPsz(a,b) config_GetPsz(VLC_OBJECT(a),b)
234 #define config_PutPsz(a,b,c) config_PutPsz(VLC_OBJECT(a),b,c)
236 #define config_AddIntf(a,b) config_AddIntf(VLC_OBJECT(a),b)
237 #define config_RemoveIntf(a,b) config_RemoveIntf(VLC_OBJECT(a),b)
238 #define config_ExistIntf(a,b) config_ExistIntf(VLC_OBJECT(a),b)
240 /****************************************************************************
242 ****************************************************************************/
243 struct config_chain_t
245 config_chain_t *p_next; /**< Pointer on the next config_chain_t element */
247 char *psz_name; /**< Option name */
248 char *psz_value; /**< Option value */
253 * - create all options in the array ppsz_options (var_Create).
254 * - parse the given linked list of config_chain_t and set the value (var_Set).
256 * The option names will be created by adding the psz_prefix prefix.
258 VLC_API void config_ChainParse( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * );
259 #define config_ChainParse( a, b, c, d ) config_ChainParse( VLC_OBJECT(a), b, c, d )
262 * This function will parse a configuration string (psz_string) and
263 * - set the module name (*ppsz_name)
264 * - set all options for this module in a chained list (*pp_cfg)
265 * - returns a pointer on the next module if any.
267 * The string format is
268 * module{option=*,option=*}[:modulenext{option=*,...}]
270 * The options values are unescaped using config_StringUnescape.
272 VLC_API char *config_ChainCreate( char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string ) VLC_USED VLC_MALLOC;
275 * This function will release a linked list of config_chain_t
276 * (Including the head)
278 VLC_API void config_ChainDestroy( config_chain_t * );
281 * This function will duplicate a linked list of config_chain_t
283 VLC_API config_chain_t * config_ChainDuplicate( const config_chain_t * ) VLC_USED VLC_MALLOC;
286 * This function will unescape a string in place and will return a pointer on
288 * No memory is allocated by it (unlike config_StringEscape).
289 * If NULL is given as parameter nothing will be done (NULL will be returned).
291 * The following sequences will be unescaped (only one time):
294 VLC_API char * config_StringUnescape( char *psz_string );
297 * This function will escape a string that can be unescaped by
298 * config_StringUnescape.
299 * The returned value is allocated by it. You have to free it once you
300 * do not need it anymore (unlike config_StringUnescape).
301 * If NULL is given as parameter nothing will be done (NULL will be returned).
303 * The escaped characters are ' " and \
305 VLC_API char * config_StringEscape( const char *psz_string ) VLC_USED VLC_MALLOC;
311 #endif /* _VLC_CONFIGURATION_H */