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