5b8f69df47d691047d3351424ab509c3154d531e
[vlc.git] / include / vlc_configuration.h
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
7  * $Id$
8  *
9  * Authors: Gildas Bazin <gbazin@videolan.org>
10  *
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.
15  *
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.
20  *
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  *****************************************************************************/
25
26 #ifndef VLC_CONFIGURATION_H
27 #define VLC_CONFIGURATION_H 1
28
29 /**
30  * \file
31  * This file describes the programming interface for the configuration module.
32  * It includes functions allowing to declare, get or set configuration options.
33  */
34
35 # ifdef __cplusplus
36 extern "C" {
37 # endif
38
39 /*****************************************************************************
40  * Macros used to build the configuration structure.
41  *****************************************************************************/
42
43 /* Configuration hint types */
44
45
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 */
50
51 #define CONFIG_CATEGORY                     0x0006 /* Set category */
52 #define CONFIG_SUBCATEGORY                  0x0007 /* Set subcategory */
53 #define CONFIG_SECTION                      0x0008 /* Start of new section */
54
55 #define CONFIG_HINT                         0x000F
56
57 /* Configuration item types */
58 #define CONFIG_ITEM_STRING                  0x0010  /* String option */
59 #define CONFIG_ITEM_FILE                    0x0020  /* File 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
72 #define CONFIG_ITEM                         0x00F0
73
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
82
83 #define CAT_AUDIO 2
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
89
90 #define CAT_VIDEO 3
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
97
98 #define CAT_INPUT 4
99    #define SUBCAT_INPUT_GENERAL 401
100    #define SUBCAT_INPUT_ACCESS 402
101    #define SUBCAT_INPUT_ACCESS_FILTER 403
102    #define SUBCAT_INPUT_DEMUX 404
103    #define SUBCAT_INPUT_VCODEC 405
104    #define SUBCAT_INPUT_ACODEC 406
105    #define SUBCAT_INPUT_SCODEC 407
106    #define SUBCAT_INPUT_STREAM_FILTER 408
107
108 #define CAT_SOUT 5
109    #define SUBCAT_SOUT_GENERAL 501
110    #define SUBCAT_SOUT_STREAM 502
111    #define SUBCAT_SOUT_MUX 503
112    #define SUBCAT_SOUT_ACO 504
113    #define SUBCAT_SOUT_PACKETIZER 505
114    #define SUBCAT_SOUT_SAP 506
115    #define SUBCAT_SOUT_VOD 507
116
117 #define CAT_ADVANCED 6
118    #define SUBCAT_ADVANCED_CPU 601
119    #define SUBCAT_ADVANCED_MISC 602
120    #define SUBCAT_ADVANCED_NETWORK 603
121    #define SUBCAT_ADVANCED_XML 604
122
123 #define CAT_PLAYLIST 7
124    #define SUBCAT_PLAYLIST_GENERAL 701
125    #define SUBCAT_PLAYLIST_SD 702
126    #define SUBCAT_PLAYLIST_EXPORT 703
127
128 #define CAT_OSD 8
129    #define SUBCAT_OSD_IMPORT 801
130
131 struct config_category_t
132 {
133     int         i_id;
134     const char *psz_name;
135     const char *psz_help;
136 };
137
138 typedef union
139 {
140     char       *psz;
141     int         i;
142     float       f;
143 } module_value_t;
144
145 typedef union
146 {
147     int         i;
148     float       f;
149 } module_nvalue_t;
150
151 struct module_config_t
152 {
153     int          i_type;                               /* Configuration type */
154     char        *psz_type;                          /* Configuration subtype */
155     char        *psz_name;                                    /* Option name */
156     char         i_short;                      /* Optional short option name */
157     char        *psz_text;      /* Short comment on the configuration option */
158     char        *psz_longtext;   /* Long comment on the configuration option */
159     module_value_t value;                                    /* Option value */
160     module_value_t orig;
161     module_value_t saved;
162     module_nvalue_t min;
163     module_nvalue_t max;
164
165     /* Function to call when commiting a change */
166     vlc_callback_t pf_callback;
167     void          *p_callback_data;
168
169     /* Values list */
170     char **      ppsz_list;       /* List of possible values for the option */
171     int         *pi_list;                              /* Idem for integers */
172     char       **ppsz_list_text;          /* Friendly names for list values */
173     int          i_list;                               /* Options list size */
174     vlc_callback_t pf_update_list; /*callback to initialize dropdownlists */
175
176     /* Actions list */
177     vlc_callback_t *ppf_action;    /* List of possible actions for a config */
178     char          **ppsz_action_text;         /* Friendly names for actions */
179     int            i_action;                           /* actions list size */
180
181     /* Misc */
182     vlc_mutex_t *p_lock;           /* Lock to use when modifying the config */
183     bool        b_dirty;          /* Dirty flag to indicate a config change */
184     bool        b_advanced;          /* Flag to indicate an advanced option */
185     bool        b_internal;   /* Flag to indicate option is not to be shown */
186     bool        b_restart;   /* Flag to indicate the option needs a restart */
187                               /* to take effect */
188
189     /* Deprecated */
190     char        *psz_oldname;                          /* Old option name */
191     bool        b_removed;
192
193     /* Option values loaded from config file */
194     bool        b_autosave;      /* Config will be auto-saved at exit time */
195     bool        b_unsaveable;                /* Config should not be saved */
196
197     bool        b_safe;
198 };
199
200 /*****************************************************************************
201  * Prototypes - these methods are used to get, set or manipulate configuration
202  * data.
203  *****************************************************************************/
204 VLC_EXPORT( int,    __config_GetType,  (vlc_object_t *, const char *) LIBVLC_USED );
205 VLC_EXPORT( int,    __config_GetInt,   (vlc_object_t *, const char *) LIBVLC_USED );
206 VLC_EXPORT( void,   __config_PutInt,   (vlc_object_t *, const char *, int) );
207 VLC_EXPORT( float,  __config_GetFloat, (vlc_object_t *, const char *) LIBVLC_USED );
208 VLC_EXPORT( void,   __config_PutFloat, (vlc_object_t *, const char *, float) );
209 VLC_EXPORT( char *, __config_GetPsz,   (vlc_object_t *, const char *) LIBVLC_USED );
210 VLC_EXPORT( void,   __config_PutPsz,   (vlc_object_t *, const char *, const char *) );
211
212 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
213 VLC_EXPORT( int,    __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
214 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
215 VLC_EXPORT( void,   __config_ResetAll, ( vlc_object_t * ) );
216
217 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) LIBVLC_USED );
218
219 VLC_EXPORT(const char *, config_GetDataDir, ( void ) LIBVLC_USED);
220 VLC_EXPORT(const char *, config_GetConfDir, ( void ) LIBVLC_USED);
221 VLC_EXPORT(const char *, config_GetHomeDir, ( void ) LIBVLC_USED);
222 VLC_EXPORT(char *, config_GetUserConfDir, ( void ) LIBVLC_USED);
223 VLC_EXPORT(char *, config_GetUserDataDir, ( void ) LIBVLC_USED);
224 VLC_EXPORT(char *, config_GetCacheDir, ( void ) LIBVLC_USED);
225
226 VLC_EXPORT( void,       __config_AddIntf,    ( vlc_object_t *, const char * ) );
227 VLC_EXPORT( void,       __config_RemoveIntf, ( vlc_object_t *, const char * ) );
228 VLC_EXPORT( bool, __config_ExistIntf,  ( vlc_object_t *, const char * ) LIBVLC_USED);
229
230 #define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
231 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
232 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
233 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
234 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
235 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
236 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
237
238 #define config_AddIntf(a,b) __config_AddIntf(VLC_OBJECT(a),b)
239 #define config_RemoveIntf(a,b) __config_RemoveIntf(VLC_OBJECT(a),b)
240 #define config_ExistIntf(a,b) __config_ExistIntf(VLC_OBJECT(a),b)
241
242 /****************************************************************************
243  * config_chain_t:
244  ****************************************************************************/
245 struct config_chain_t
246 {
247     config_chain_t *p_next;     /**< Pointer on the next config_chain_t element */
248
249     char        *psz_name;      /**< Option name */
250     char        *psz_value;     /**< Option value */
251 };
252
253 /**
254  * This function will
255  * - create all options in the array ppsz_options (var_Create).
256  * - parse the given linked list of config_chain_t and set the value (var_Set).
257  *
258  * The option names will be created by adding the psz_prefix prefix.
259  */
260 #define config_ChainParse( a, b, c, d ) __config_ChainParse( VLC_OBJECT(a), b, c, d )
261 VLC_EXPORT( void,   __config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * ) );
262
263 /**
264  * This function will parse a configuration string (psz_string) and
265  * - set the module name (*ppsz_name)
266  * - set all options for this module in a chained list (*pp_cfg)
267  * - returns a pointer on the next module if any.
268  *
269  * The string format is
270  *   module{option=*,option=*}[:modulenext{option=*,...}]
271  *
272  * The options values are unescaped using config_StringUnescape.
273  */
274 VLC_EXPORT( char *, config_ChainCreate, ( char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string ) );
275
276 /**
277  * This function will release a linked list of config_chain_t
278  * (Including the head)
279  */
280 VLC_EXPORT( void, config_ChainDestroy, ( config_chain_t * ) );
281
282 /**
283  * This function will unescape a string in place and will return a pointer on
284  * the given string.
285  * No memory is allocated by it (unlike config_StringEscape).
286  * If NULL is given as parameter nothing will be done (NULL will be returned).
287  *
288  * The following sequences will be unescaped (only one time):
289  * \\ \' and \"
290  */
291 VLC_EXPORT( char *, config_StringUnescape, ( char *psz_string ) );
292
293 /**
294  * This function will escape a string that can be unescaped by
295  * config_StringUnescape.
296  * The returned value is allocated by it. You have to free it once you
297  * do not need it anymore (unlike config_StringUnescape).
298  * If NULL is given as parameter nothing will be done (NULL will be returned).
299  *
300  * The escaped characters are ' " and \
301  */
302 VLC_EXPORT( char *, config_StringEscape, ( const char *psz_string ) LIBVLC_USED);
303
304 # ifdef __cplusplus
305 }
306 # endif
307
308 #endif /* _VLC_CONFIGURATION_H */