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