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
34 /*****************************************************************************
35 * Macros used to build the configuration structure.
36 *****************************************************************************/
38 /* Configuration hint types */
41 #define CONFIG_HINT_CATEGORY 0x0002 /* Start of new category */
42 #define CONFIG_HINT_SUBCATEGORY 0x0003 /* Start of sub-category */
43 #define CONFIG_HINT_SUBCATEGORY_END 0x0004 /* End of sub-category */
44 #define CONFIG_HINT_USAGE 0x0005 /* Usage information */
46 #define CONFIG_CATEGORY 0x0006 /* Set category */
47 #define CONFIG_SUBCATEGORY 0x0007 /* Set subcategory */
48 #define CONFIG_SECTION 0x0008 /* Start of new section */
50 #define CONFIG_HINT 0x000F
52 /* Configuration item types */
53 #define CONFIG_ITEM_STRING 0x0010 /* String option */
54 #define CONFIG_ITEM_FILE 0x0020 /* File option */
55 #define CONFIG_ITEM_MODULE 0x0030 /* Module option */
56 #define CONFIG_ITEM_INTEGER 0x0040 /* Integer option */
57 #define CONFIG_ITEM_BOOL 0x0050 /* Bool option */
58 #define CONFIG_ITEM_FLOAT 0x0060 /* Float option */
59 #define CONFIG_ITEM_DIRECTORY 0x0070 /* Directory option */
60 #define CONFIG_ITEM_KEY 0x0080 /* Hot key option */
61 #define CONFIG_ITEM_MODULE_CAT 0x0090 /* Module option */
62 #define CONFIG_ITEM_MODULE_LIST 0x00A0 /* Module option */
63 #define CONFIG_ITEM_MODULE_LIST_CAT 0x00B0 /* Module option */
64 #define CONFIG_ITEM_FONT 0x00C0 /* Font option */
65 #define CONFIG_ITEM_PASSWORD 0x00D0 /* Password option (*) */
67 #define CONFIG_ITEM 0x00F0
69 /*******************************************************************
70 * All predefined categories and subcategories
71 *******************************************************************/
72 #define CAT_INTERFACE 1
73 #define SUBCAT_INTERFACE_GENERAL 101
74 #define SUBCAT_INTERFACE_MAIN 102
75 #define SUBCAT_INTERFACE_CONTROL 103
76 #define SUBCAT_INTERFACE_HOTKEYS 104
79 #define SUBCAT_AUDIO_GENERAL 201
80 #define SUBCAT_AUDIO_AOUT 202
81 #define SUBCAT_AUDIO_AFILTER 203
82 #define SUBCAT_AUDIO_VISUAL 204
83 #define SUBCAT_AUDIO_MISC 205
86 #define SUBCAT_VIDEO_GENERAL 301
87 #define SUBCAT_VIDEO_VOUT 302
88 #define SUBCAT_VIDEO_VFILTER 303
89 #define SUBCAT_VIDEO_TEXT 304
90 #define SUBCAT_VIDEO_SUBPIC 305
91 #define SUBCAT_VIDEO_VFILTER2 306
94 #define SUBCAT_INPUT_GENERAL 401
95 #define SUBCAT_INPUT_ACCESS 402
96 #define SUBCAT_INPUT_ACCESS_FILTER 403
97 #define SUBCAT_INPUT_DEMUX 404
98 #define SUBCAT_INPUT_VCODEC 405
99 #define SUBCAT_INPUT_ACODEC 406
100 #define SUBCAT_INPUT_SCODEC 407
103 #define SUBCAT_SOUT_GENERAL 501
104 #define SUBCAT_SOUT_STREAM 502
105 #define SUBCAT_SOUT_MUX 503
106 #define SUBCAT_SOUT_ACO 504
107 #define SUBCAT_SOUT_PACKETIZER 505
108 #define SUBCAT_SOUT_SAP 506
109 #define SUBCAT_SOUT_VOD 507
111 #define CAT_ADVANCED 6
112 #define SUBCAT_ADVANCED_CPU 601
113 #define SUBCAT_ADVANCED_MISC 602
114 #define SUBCAT_ADVANCED_NETWORK 603
115 #define SUBCAT_ADVANCED_XML 604
117 #define CAT_PLAYLIST 7
118 #define SUBCAT_PLAYLIST_GENERAL 701
119 #define SUBCAT_PLAYLIST_SD 702
120 #define SUBCAT_PLAYLIST_EXPORT 703
123 #define SUBCAT_OSD_IMPORT 801
125 struct config_category_t
128 const char *psz_name;
129 const char *psz_help;
145 struct module_config_t
147 int i_type; /* Configuration type */
148 char *psz_type; /* Configuration subtype */
149 char *psz_name; /* Option name */
150 char i_short; /* Optional short option name */
151 char *psz_text; /* Short comment on the configuration option */
152 char *psz_longtext; /* Long comment on the configuration option */
153 module_value_t value; /* Option value */
155 module_value_t saved;
159 /* Function to call when commiting a change */
160 vlc_callback_t pf_callback;
161 void *p_callback_data;
164 char ** ppsz_list; /* List of possible values for the option */
165 int *pi_list; /* Idem for integers */
166 char **ppsz_list_text; /* Friendly names for list values */
167 int i_list; /* Options list size */
168 vlc_callback_t pf_update_list; /*callback to initialize dropdownlists */
171 vlc_callback_t *ppf_action; /* List of possible actions for a config */
172 char **ppsz_action_text; /* Friendly names for actions */
173 int i_action; /* actions list size */
176 vlc_mutex_t *p_lock; /* Lock to use when modifying the config */
177 bool b_dirty; /* Dirty flag to indicate a config change */
178 bool b_advanced; /* Flag to indicate an advanced option */
179 bool b_internal; /* Flag to indicate option is not to be shown */
180 bool b_restart; /* Flag to indicate the option needs a restart */
184 char *psz_oldname; /* Old option name */
187 /* Option values loaded from config file */
188 bool b_autosave; /* Config will be auto-saved at exit time */
189 bool b_unsaveable; /* Config should not be saved */
194 /*****************************************************************************
195 * Prototypes - these methods are used to get, set or manipulate configuration
197 *****************************************************************************/
198 VLC_EXPORT( int, __config_GetType, (vlc_object_t *, const char *) );
199 VLC_EXPORT( int, __config_GetInt, (vlc_object_t *, const char *) );
200 VLC_EXPORT( void, __config_PutInt, (vlc_object_t *, const char *, int) );
201 VLC_EXPORT( float, __config_GetFloat, (vlc_object_t *, const char *) );
202 VLC_EXPORT( void, __config_PutFloat, (vlc_object_t *, const char *, float) );
203 VLC_EXPORT( char *, __config_GetPsz, (vlc_object_t *, const char *) );
204 VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, const char *) );
206 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
207 VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
208 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
209 VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) );
211 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
213 VLC_EXPORT(const char *, config_GetDataDir, ( void ));
214 VLC_EXPORT(const char *, config_GetConfDir, ( void ) );
215 VLC_EXPORT(const char *, config_GetHomeDir, ( void ));
216 VLC_EXPORT(char *, config_GetUserConfDir, ( void ) );
217 VLC_EXPORT(char *, config_GetUserDataDir, ( void ) );
218 VLC_EXPORT(char *, config_GetCacheDir, ( void ) );
220 VLC_EXPORT( void, __config_AddIntf, ( vlc_object_t *, const char * ) );
221 VLC_EXPORT( void, __config_RemoveIntf, ( vlc_object_t *, const char * ) );
222 VLC_EXPORT( bool, __config_ExistIntf, ( vlc_object_t *, const char * ) );
224 #define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
225 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
226 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
227 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
228 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
229 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
230 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
232 #define config_AddIntf(a,b) __config_AddIntf(VLC_OBJECT(a),b)
233 #define config_RemoveIntf(a,b) __config_RemoveIntf(VLC_OBJECT(a),b)
234 #define config_ExistIntf(a,b) __config_ExistIntf(VLC_OBJECT(a),b)
236 /****************************************************************************
238 ****************************************************************************/
239 struct config_chain_t
241 config_chain_t *p_next;
247 #define config_ChainParse( a, b, c, d ) __config_ChainParse( VLC_OBJECT(a), b, c, d )
248 VLC_EXPORT( void, __config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * ) );
249 VLC_EXPORT( char *, config_ChainCreate, ( char **, config_chain_t **, const char * ) );
250 VLC_EXPORT( void, config_ChainDestroy, ( config_chain_t * ) );
256 #endif /* _VLC_CONFIGURATION_H */