33b052f26100905f30596a3d5b03ecf9a54cc1e8
[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 #if !defined( __LIBVLC__ )
27   #error You are not libvlc or one of its plugins. You cannot include this file
28 #endif
29
30 # ifdef __cplusplus
31 extern "C" {
32 # endif
33
34 /*****************************************************************************
35  * Macros used to build the configuration structure.
36  *****************************************************************************/
37
38 /* Configuration hint types */
39
40
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 */
45
46 #define CONFIG_CATEGORY                     0x0006 /* Set category */
47 #define CONFIG_SUBCATEGORY                  0x0007 /* Set subcategory */
48 #define CONFIG_SECTION                      0x0008 /* Start of new section */
49
50 #define CONFIG_HINT                         0x000F
51
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
66 #define CONFIG_ITEM                         0x00F0
67
68 /* Item types that use a string value (i.e. serialized in the module cache) */
69 #define CONFIG_STRING_TYPES \
70     { \
71         CONFIG_ITEM_STRING, CONFIG_ITEM_FILE, CONFIG_ITEM_MODULE, \
72         CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_MODULE_CAT, \
73         CONFIG_ITEM_MODULE_LIST, CONFIG_ITEM_MODULE_LIST_CAT \
74     }
75
76 static inline int IsConfigStringType (int type)
77 {
78     const unsigned char config_string_types[] = CONFIG_STRING_TYPES;
79
80     /* NOTE: this needs to be changed if we ever get more than 255 types */
81     return memchr (config_string_types, type, sizeof (config_string_types))
82             != NULL;
83 }
84
85 static inline int IsConfigIntegerType (int type)
86 {
87     return (type == CONFIG_ITEM_INTEGER) || (type == CONFIG_ITEM_KEY)
88         || (type == CONFIG_ITEM_BOOL);
89 }
90
91 static inline int IsConfigFloatType (int type)
92 {
93     return type == CONFIG_ITEM_FLOAT;
94 }
95
96 /*******************************************************************
97  * All predefined categories and subcategories
98  *******************************************************************/
99 #define CAT_INTERFACE 1
100    #define SUBCAT_INTERFACE_GENERAL 101
101    #define SUBCAT_INTERFACE_MAIN 102
102    #define SUBCAT_INTERFACE_CONTROL 103
103    #define SUBCAT_INTERFACE_HOTKEYS 104
104
105 #define CAT_AUDIO 2
106    #define SUBCAT_AUDIO_GENERAL 201
107    #define SUBCAT_AUDIO_AOUT 202
108    #define SUBCAT_AUDIO_AFILTER 203
109    #define SUBCAT_AUDIO_VISUAL 204
110    #define SUBCAT_AUDIO_MISC 205
111
112 #define CAT_VIDEO 3
113    #define SUBCAT_VIDEO_GENERAL 301
114    #define SUBCAT_VIDEO_VOUT 302
115    #define SUBCAT_VIDEO_VFILTER 303
116    #define SUBCAT_VIDEO_TEXT 304
117    #define SUBCAT_VIDEO_SUBPIC 305
118    #define SUBCAT_VIDEO_VFILTER2 306
119
120 #define CAT_INPUT 4
121    #define SUBCAT_INPUT_GENERAL 401
122    #define SUBCAT_INPUT_ACCESS 402
123    #define SUBCAT_INPUT_ACCESS_FILTER 403
124    #define SUBCAT_INPUT_DEMUX 404
125    #define SUBCAT_INPUT_VCODEC 405
126    #define SUBCAT_INPUT_ACODEC 406
127    #define SUBCAT_INPUT_SCODEC 407
128
129 #define CAT_SOUT 5
130    #define SUBCAT_SOUT_GENERAL 501
131    #define SUBCAT_SOUT_STREAM 502
132    #define SUBCAT_SOUT_MUX 503
133    #define SUBCAT_SOUT_ACO 504
134    #define SUBCAT_SOUT_PACKETIZER 505
135    #define SUBCAT_SOUT_SAP 506
136    #define SUBCAT_SOUT_VOD 507
137
138 #define CAT_ADVANCED 6
139    #define SUBCAT_ADVANCED_CPU 601
140    #define SUBCAT_ADVANCED_MISC 602
141    #define SUBCAT_ADVANCED_NETWORK 603
142    #define SUBCAT_ADVANCED_XML 604
143
144 #define CAT_PLAYLIST 7
145    #define SUBCAT_PLAYLIST_GENERAL 701
146    #define SUBCAT_PLAYLIST_SD 702
147    #define SUBCAT_PLAYLIST_EXPORT 703
148
149 struct config_category_t
150 {
151     int         i_id;
152     const char *psz_name;
153     const char *psz_help;
154 };
155
156 typedef union
157 {
158     const char *psz;
159     int         i;
160     float       f;
161 } module_value_t;
162
163 typedef union
164 {
165     int         i;
166     float       f;
167 } module_nvalue_t;
168
169 struct module_config_t
170 {
171     int          i_type;                               /* Configuration type */
172     const char  *psz_type;                          /* Configuration subtype */
173     const char  *psz_name;                                    /* Option name */
174     char         i_short;                      /* Optional short option name */
175     const char  *psz_text;      /* Short comment on the configuration option */
176     const char  *psz_longtext;   /* Long comment on the configuration option */
177     module_value_t value;                                    /* Option value */
178     module_value_t orig;
179     module_value_t saved;
180     module_nvalue_t min;
181     module_nvalue_t max;
182
183     /* Function to call when commiting a change */
184     vlc_callback_t pf_callback;
185     void          *p_callback_data;
186
187     /* Values list */
188     const char **ppsz_list;        /* List of possible values for the option */
189     int         *pi_list;          /* Idem for integers */
190     const char **ppsz_list_text;   /* Friendly names for list values */
191     int          i_list;           /* Options list size */
192
193     /* Actions list */
194     vlc_callback_t *ppf_action;    /* List of possible actions for a config */
195     const char    **ppsz_action_text;         /* Friendly names for actions */
196     int            i_action;                            /* actions list size */
197
198     /* Misc */
199     vlc_mutex_t *p_lock;            /* Lock to use when modifying the config */
200     vlc_bool_t   b_dirty;          /* Dirty flag to indicate a config change */
201     vlc_bool_t   b_advanced;          /* Flag to indicate an advanced option */
202     vlc_bool_t   b_internal;   /* Flag to indicate option is not to be shown */
203     vlc_bool_t   b_restart;    /* Flag to indicate the option need a restart */
204                                /* to take effect */
205
206     /* Deprecated */
207     const char    *psz_current;   /* Good option name */
208     vlc_bool_t     b_strict;      /* Transitionnal or strict */
209
210     /* Option values loaded from config file */
211     vlc_bool_t   b_autosave;       /* Config will be auto-saved at exit time */
212     vlc_bool_t   b_unsaveable;       /* confg should be saved*/
213 };
214
215 /*****************************************************************************
216  * Prototypes - these methods are used to get, set or manipulate configuration
217  * data.
218  *****************************************************************************/
219 VLC_EXPORT( int,    __config_GetType,  (vlc_object_t *, const char *) );
220 VLC_EXPORT( int,    __config_GetInt,   (vlc_object_t *, const char *) );
221 VLC_EXPORT( void,   __config_PutInt,   (vlc_object_t *, const char *, int) );
222 VLC_EXPORT( float,  __config_GetFloat, (vlc_object_t *, const char *) );
223 VLC_EXPORT( void,   __config_PutFloat, (vlc_object_t *, const char *, float) );
224 VLC_EXPORT( char *, __config_GetPsz,   (vlc_object_t *, const char *) );
225 VLC_EXPORT( void,   __config_PutPsz,   (vlc_object_t *, const char *, const char *) );
226
227 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
228 VLC_EXPORT( int,    __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
229 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
230 VLC_EXPORT( void,   __config_ResetAll, ( vlc_object_t * ) );
231
232 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
233 VLC_EXPORT( module_t *, config_FindModule,( vlc_object_t *, const char * ) );
234
235 VLC_EXPORT( int, config_Duplicate,( module_t *, const module_config_t *, size_t ));
236
237 VLC_EXPORT(const char *, config_GetDataDir, ( const vlc_object_t * ));
238
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)
246
247
248 /*****************************************************************************
249  * Macros used to build the configuration structure.
250  *
251  * Note that internally we support only 3 types of config data: int, float
252  *   and string.
253  *   The other types declared here just map to one of these 3 basic types but
254  *   have the advantage of also providing very good hints to a configuration
255  *   interface so as to make it more user friendly.
256  * The configuration structure also includes category hints. These hints can
257  *   provide a configuration interface with some very useful data and again
258  *   allow for a more user friendly interface.
259  *****************************************************************************/
260
261 #define add_config_inner( ) \
262     i_config++; \
263     if( (i_config % 10) == 0 ) \
264         p_config = (module_config_t *) \
265              realloc(p_config, (i_config+11) * sizeof(module_config_t)); \
266     memset( p_config + i_config, 0, sizeof( *p_config ) )
267
268 #define add_type_inner( type ) \
269     add_config_inner( ); \
270     p_config[i_config].i_type = type
271
272 #define add_typedesc_inner( type, text, longtext ) \
273     add_type_inner( type ); \
274     p_config[i_config].psz_text = text; \
275     p_config[i_config].psz_longtext = longtext
276
277 #define add_typeadv_inner( type, text, longtext, advc ) \
278     add_typedesc_inner( type, text, longtext ); \
279     p_config[i_config].b_advanced = advc
280
281 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
282     add_typeadv_inner( type, text, longtext, advc ); \
283     p_config[i_config].psz_name = name; \
284     p_config[i_config].pf_callback = cb
285
286 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
287     add_typename_inner( type, name, text, longtext, advc, cb ); \
288     p_config[i_config].value.psz = v
289
290 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
291     add_typename_inner( type, name, text, longtext, advc, cb ); \
292     p_config[i_config].value.i = v
293
294
295 #define set_category( i_id ) \
296     add_type_inner( CONFIG_CATEGORY ); \
297     p_config[i_config].value.i = i_id
298
299 #define set_subcategory( i_id ) \
300     add_type_inner( CONFIG_SUBCATEGORY ); \
301     p_config[i_config].value.i = i_id
302
303 #define set_section( text, longtext ) \
304     add_typedesc_inner( CONFIG_SECTION, text, longtext )
305
306 #define add_category_hint( text, longtext, advc ) \
307     add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
308
309 #define add_subcategory_hint( text, longtext ) \
310     add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
311
312 #define end_subcategory_hint \
313     add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
314
315 #define add_usage_hint( text ) \
316     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
317
318 #define add_string( name, value, p_callback, text, longtext, advc ) \
319     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value )
320
321 #define add_file( name, value, p_callback, text, longtext, advc ) \
322     add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value )
323
324 #define add_directory( name, value, p_callback, text, longtext, advc ) \
325     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value )
326
327 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
328     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \
329     p_config[i_config].psz_type = psz_caps
330
331 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
332     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \
333     p_config[i_config].min.i = i_subcategory /* gruik */
334
335 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
336     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \
337     p_config[i_config].psz_type = psz_caps
338
339 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
340     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \
341     p_config[i_config].min.i = i_subcategory /* gruik */
342
343 #define add_integer( name, value, p_callback, text, longtext, advc ) \
344     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
345
346 #define add_key( name, value, p_callback, text, longtext, advc ) \
347     add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value )
348
349 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
350     add_integer( name, value, p_callback, text, longtext, advc ); \
351     change_integer_range( i_min, i_max )
352
353 #define add_float( name, v, p_callback, text, longtext, advc ) \
354     add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \
355     p_config[i_config].value.f = v
356
357 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
358     add_float( name, value, p_callback, text, longtext, advc ); \
359     change_float_range( f_min, f_max )
360
361 #define add_bool( name, v, p_callback, text, longtext, advc ) \
362     add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \
363     p_config[i_config].value.i = v
364
365 /* For renamed option */
366 #define add_deprecated( name, strict ) \
367     add_config_inner( ); \
368     p_config[ i_config ].i_type = p_config[ i_config -1 ].i_type; \
369     p_config[ i_config ].psz_name = name; \
370     p_config[i_config].b_strict = strict; \
371     p_config[ i_config ].psz_current = p_config[ i_config-1].psz_current \
372         ? p_config[ i_config-1 ].psz_current \
373         : p_config[ i_config-1 ].psz_name;
374
375 /* For removed option */
376 #define add_suppressed_inner( name, type ) \
377     add_type_inner( type ); \
378     p_config[ i_config ].psz_name = name; \
379     p_config[ i_config ].psz_current = "SUPPRESSED";
380
381 #define add_suppressed_bool( name ) \
382         add_suppressed_inner( name, CONFIG_ITEM_BOOL )
383
384 #define add_suppressed_integer( name ) \
385         add_suppressed_inner( name, CONFIG_ITEM_INTEGER )
386
387 #define add_suppressed_float( name ) \
388         add_suppressed_inner( name, CONFIG_ITEM_FLOAT )
389
390 #define add_suppressed_string( name ) \
391         add_suppressed_inner( name, CONFIG_ITEM_STRING )
392
393 /* Modifier macros for the config options (used for fine tuning) */
394 #define change_short( ch ) \
395     p_config[i_config].i_short = ch;
396
397 #define change_string_list( list, list_text, list_update_func ) \
398     p_config[i_config].i_list = sizeof(list)/sizeof(char *); \
399     p_config[i_config].ppsz_list = list; \
400     p_config[i_config].ppsz_list_text = list_text;
401
402 #define change_integer_list( list, list_text, list_update_func ) \
403     p_config[i_config].i_list = sizeof(list)/sizeof(int); \
404     p_config[i_config].pi_list = (int *)list; \
405     p_config[i_config].ppsz_list_text = list_text;
406
407 #define change_integer_range( minv, maxv ) \
408     p_config[i_config].min.i = minv; \
409     p_config[i_config].max.i = maxv;
410
411 #define change_float_range( minv, maxv ) \
412     p_config[i_config].min.f = minv; \
413     p_config[i_config].max.f = maxv;
414
415 #define change_action_add( pf_action, action_text ) \
416     if( !p_config[i_config].i_action ) \
417     { p_config[i_config].ppsz_action_text = 0; \
418       p_config[i_config].ppf_action = 0; } \
419     p_config[i_config].ppf_action = (vlc_callback_t *) \
420       realloc( p_config[i_config].ppf_action, \
421       (p_config[i_config].i_action + 1) * sizeof(void *) ); \
422     p_config[i_config].ppsz_action_text = (const char **)\
423       realloc( p_config[i_config].ppsz_action_text, \
424       (p_config[i_config].i_action + 1) * sizeof(void *) ); \
425     p_config[i_config].ppf_action[p_config[i_config].i_action] = pf_action; \
426     p_config[i_config].ppsz_action_text[p_config[i_config].i_action] = \
427       action_text; \
428     p_config[i_config].i_action++;
429
430 #define change_internal() \
431     p_config[i_config].b_internal = VLC_TRUE;
432
433 #define change_need_restart() \
434     p_config[i_config].b_restart = VLC_TRUE;
435
436 #define change_autosave() \
437     p_config[i_config].b_autosave = VLC_TRUE;
438
439 #define change_unsaveable() \
440     p_config[i_config].b_unsaveable = VLC_TRUE;
441
442 /****************************************************************************
443  * config_chain_t:
444  ****************************************************************************/
445 struct config_chain_t
446 {
447     config_chain_t *p_next;
448
449     char        *psz_name;
450     char        *psz_value;
451 };
452
453 #define config_ChainParse( a, b, c, d ) __config_ChainParse( VLC_OBJECT(a), b, c, d )
454 VLC_EXPORT( void,   __config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char **ppsz_options, config_chain_t * ) );
455 VLC_EXPORT( char *, config_ChainCreate, ( char **, config_chain_t **, const char * ) );
456 VLC_EXPORT( void, config_ChainDestroy, ( config_chain_t * ) );
457
458 static inline config_chain_t *config_chain_find( config_chain_t *p_cfg, const char *psz_name )
459 {
460     while( p_cfg && strcmp( p_cfg->psz_name, psz_name ) )
461     {
462         p_cfg = p_cfg->p_next;
463     }
464
465     return p_cfg;
466 }
467
468 static inline char *config_chain_find_value( config_chain_t *p_cfg, const char *psz_name )
469 {
470     while( p_cfg && strcmp( p_cfg->psz_name, psz_name ) )
471     {
472         p_cfg = p_cfg->p_next;
473     }
474
475     if( p_cfg && p_cfg->psz_value )
476     {
477         return( p_cfg->psz_value );
478     }
479
480     return NULL;
481 }
482
483 # ifdef __cplusplus
484 }
485 # endif