Adds CONFIG_ITEM_PASSWORD for showing stars in preferences dialog (still to be implem...
[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 struct config_category_t
127 {
128     int         i_id;
129     const char *psz_name;
130     const char *psz_help;
131 };
132
133 typedef union
134 {
135     const char *psz;
136     int         i;
137     float       f;
138 } module_value_t;
139
140 typedef union
141 {
142     int         i;
143     float       f;
144 } module_nvalue_t;
145
146 struct module_config_t
147 {
148     int          i_type;                               /* Configuration type */
149     const char  *psz_type;                          /* Configuration subtype */
150     const char  *psz_name;                                    /* Option name */
151     char         i_short;                      /* Optional short option name */
152     const char  *psz_text;      /* Short comment on the configuration option */
153     const char  *psz_longtext;   /* Long comment on the configuration option */
154     module_value_t value;                                    /* Option value */
155     module_value_t orig;
156     module_value_t saved;
157     module_nvalue_t min;
158     module_nvalue_t max;
159
160     /* Function to call when commiting a change */
161     vlc_callback_t pf_callback;
162     void          *p_callback_data;
163
164     /* Values list */
165     const char **ppsz_list;       /* List of possible values for the option */
166     int         *pi_list;                              /* Idem for integers */
167     const char **ppsz_list_text;          /* Friendly names for list values */
168     int          i_list;                               /* Options list size */
169
170     /* Actions list */
171     vlc_callback_t *ppf_action;    /* List of possible actions for a config */
172     const char    **ppsz_action_text;         /* Friendly names for actions */
173     int            i_action;                           /* actions list size */
174
175     /* Misc */
176     vlc_mutex_t *p_lock;            /* Lock to use when modifying the config */
177     vlc_bool_t   b_dirty;          /* Dirty flag to indicate a config change */
178     vlc_bool_t   b_advanced;          /* Flag to indicate an advanced option */
179     vlc_bool_t   b_internal;   /* Flag to indicate option is not to be shown */
180     vlc_bool_t   b_restart;   /* Flag to indicate the option needs a restart */
181                               /* to take effect */
182
183     /* Deprecated */
184     const char    *psz_current;                         /* Good option name */
185     vlc_bool_t     b_strict;                     /* Transitionnal or strict */
186
187     /* Option values loaded from config file */
188     vlc_bool_t   b_autosave;      /* Config will be auto-saved at exit time */
189     vlc_bool_t   b_unsaveable;                    /* Config should be saved */
190 };
191
192 /*****************************************************************************
193  * Prototypes - these methods are used to get, set or manipulate configuration
194  * data.
195  *****************************************************************************/
196 VLC_EXPORT( int,    __config_GetType,  (vlc_object_t *, const char *) );
197 VLC_EXPORT( int,    __config_GetInt,   (vlc_object_t *, const char *) );
198 VLC_EXPORT( void,   __config_PutInt,   (vlc_object_t *, const char *, int) );
199 VLC_EXPORT( float,  __config_GetFloat, (vlc_object_t *, const char *) );
200 VLC_EXPORT( void,   __config_PutFloat, (vlc_object_t *, const char *, float) );
201 VLC_EXPORT( char *, __config_GetPsz,   (vlc_object_t *, const char *) );
202 VLC_EXPORT( void,   __config_PutPsz,   (vlc_object_t *, const char *, const char *) );
203
204 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
205 VLC_EXPORT( int,    __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
206 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
207 VLC_EXPORT( void,   __config_ResetAll, ( vlc_object_t * ) );
208
209 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
210 VLC_EXPORT( module_t *, config_FindModule,( vlc_object_t *, const char * ) );
211
212 VLC_EXPORT( int, config_Duplicate,( module_t *, const module_config_t *, size_t ));
213
214 VLC_EXPORT(const char *, config_GetDataDir, ( void ));
215
216 #define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
217 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
218 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
219 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
220 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
221 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
222 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
223
224
225 /*****************************************************************************
226  * Macros used to build the configuration structure.
227  *
228  * Note that internally we support only 3 types of config data: int, float
229  *   and string.
230  *   The other types declared here just map to one of these 3 basic types but
231  *   have the advantage of also providing very good hints to a configuration
232  *   interface so as to make it more user friendly.
233  * The configuration structure also includes category hints. These hints can
234  *   provide a configuration interface with some very useful data and again
235  *   allow for a more user friendly interface.
236  *****************************************************************************/
237
238 #define add_config_inner( ) \
239     i_config++; \
240     if( (i_config % 10) == 0 ) \
241         p_config = (module_config_t *) \
242              realloc(p_config, (i_config+11) * sizeof(module_config_t)); \
243     memset( p_config + i_config, 0, sizeof( *p_config ) )
244
245 #define add_type_inner( type ) \
246     add_config_inner( ); \
247     p_config[i_config].i_type = type
248
249 #define add_typedesc_inner( type, text, longtext ) \
250     add_type_inner( type ); \
251     p_config[i_config].psz_text = text; \
252     p_config[i_config].psz_longtext = longtext
253
254 #define add_typeadv_inner( type, text, longtext, advc ) \
255     add_typedesc_inner( type, text, longtext ); \
256     p_config[i_config].b_advanced = advc
257
258 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
259     add_typeadv_inner( type, text, longtext, advc ); \
260     p_config[i_config].psz_name = name; \
261     p_config[i_config].pf_callback = cb
262
263 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
264     add_typename_inner( type, name, text, longtext, advc, cb ); \
265     p_config[i_config].value.psz = v
266
267 #define add_password_inner( type, name, text, longtext, advc, cb, v ) \
268     add_typename_inner( type, name, text, longtext, advc, cb ); \
269     p_config[i_config].value.psz = v
270
271 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
272     add_typename_inner( type, name, text, longtext, advc, cb ); \
273     p_config[i_config].value.i = v
274
275
276 #define set_category( i_id ) \
277     add_type_inner( CONFIG_CATEGORY ); \
278     p_config[i_config].value.i = i_id
279
280 #define set_subcategory( i_id ) \
281     add_type_inner( CONFIG_SUBCATEGORY ); \
282     p_config[i_config].value.i = i_id
283
284 #define set_section( text, longtext ) \
285     add_typedesc_inner( CONFIG_SECTION, text, longtext )
286
287 #define add_category_hint( text, longtext, advc ) \
288     add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
289
290 #define add_subcategory_hint( text, longtext ) \
291     add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
292
293 #define end_subcategory_hint \
294     add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
295
296 #define add_usage_hint( text ) \
297     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
298
299 #define add_string( name, value, p_callback, text, longtext, advc ) \
300     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value )
301
302 #define add_password( name, value, p_callback, text, longtext, advc ) \
303     add_password_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, p_callback, value )
304
305 #define add_file( name, value, p_callback, text, longtext, advc ) \
306     add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value )
307
308 #define add_directory( name, value, p_callback, text, longtext, advc ) \
309     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value )
310
311 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
312     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \
313     p_config[i_config].psz_type = psz_caps
314
315 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
316     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \
317     p_config[i_config].min.i = i_subcategory /* gruik */
318
319 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
320     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \
321     p_config[i_config].psz_type = psz_caps
322
323 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
324     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \
325     p_config[i_config].min.i = i_subcategory /* gruik */
326
327 #define add_integer( name, value, p_callback, text, longtext, advc ) \
328     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
329
330 #define add_key( name, value, p_callback, text, longtext, advc ) \
331     add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value )
332
333 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
334     add_integer( name, value, p_callback, text, longtext, advc ); \
335     change_integer_range( i_min, i_max )
336
337 #define add_float( name, v, p_callback, text, longtext, advc ) \
338     add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \
339     p_config[i_config].value.f = v
340
341 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
342     add_float( name, value, p_callback, text, longtext, advc ); \
343     change_float_range( f_min, f_max )
344
345 #define add_bool( name, v, p_callback, text, longtext, advc ) \
346     add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \
347     p_config[i_config].value.i = v
348
349 /* For renamed option */
350 #define add_deprecated_alias( name ) \
351     add_config_inner( ); \
352     p_config[ i_config ].i_type = p_config[ i_config -1 ].i_type; \
353     p_config[ i_config ].psz_name = name; \
354     p_config[i_config].b_strict = VLC_FALSE; \
355     p_config[ i_config ].psz_current = p_config[ i_config-1 ].psz_current \
356         ? p_config[ i_config-1 ].psz_current \
357         : p_config[ i_config-1 ].psz_name;
358
359 /* For removed option */
360 #define add_obsolete_inner( name, type ) \
361     add_type_inner( type ); \
362     p_config[ i_config ].psz_name = name; \
363     p_config[ i_config ].psz_current = "SUPPRESSED";
364
365 #define add_obsolete_bool( name ) \
366         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
367
368 #define add_obsolete_integer( name ) \
369         add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
370
371 #define add_obsolete_float( name ) \
372         add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
373
374 #define add_obsolete_string( name ) \
375         add_obsolete_inner( name, CONFIG_ITEM_STRING )
376
377 /* Modifier macros for the config options (used for fine tuning) */
378 #define change_short( ch ) \
379     p_config[i_config].i_short = ch;
380
381 #define change_string_list( list, list_text, list_update_func ) \
382     p_config[i_config].i_list = sizeof(list)/sizeof(char *); \
383     p_config[i_config].ppsz_list = list; \
384     p_config[i_config].ppsz_list_text = list_text;
385
386 #define change_integer_list( list, list_text, list_update_func ) \
387     p_config[i_config].i_list = sizeof(list)/sizeof(int); \
388     p_config[i_config].pi_list = (int *)list; \
389     p_config[i_config].ppsz_list_text = list_text;
390
391 #define change_integer_range( minv, maxv ) \
392     p_config[i_config].min.i = minv; \
393     p_config[i_config].max.i = maxv;
394
395 #define change_float_range( minv, maxv ) \
396     p_config[i_config].min.f = minv; \
397     p_config[i_config].max.f = maxv;
398
399 #define change_action_add( pf_action, action_text ) \
400     if( !p_config[i_config].i_action ) \
401     { p_config[i_config].ppsz_action_text = 0; \
402       p_config[i_config].ppf_action = 0; } \
403     p_config[i_config].ppf_action = (vlc_callback_t *) \
404       realloc( p_config[i_config].ppf_action, \
405       (p_config[i_config].i_action + 1) * sizeof(void *) ); \
406     p_config[i_config].ppsz_action_text = (const char **)\
407       realloc( p_config[i_config].ppsz_action_text, \
408       (p_config[i_config].i_action + 1) * sizeof(void *) ); \
409     p_config[i_config].ppf_action[p_config[i_config].i_action] = pf_action; \
410     p_config[i_config].ppsz_action_text[p_config[i_config].i_action] = \
411       action_text; \
412     p_config[i_config].i_action++;
413
414 #define change_internal() \
415     p_config[i_config].b_internal = VLC_TRUE;
416
417 #define change_need_restart() \
418     p_config[i_config].b_restart = VLC_TRUE;
419
420 #define change_autosave() \
421     p_config[i_config].b_autosave = VLC_TRUE;
422
423 #define change_unsaveable() \
424     p_config[i_config].b_unsaveable = VLC_TRUE;
425
426 /****************************************************************************
427  * config_chain_t:
428  ****************************************************************************/
429 struct config_chain_t
430 {
431     config_chain_t *p_next;
432
433     char        *psz_name;
434     char        *psz_value;
435 };
436
437 #define config_ChainParse( a, b, c, d ) __config_ChainParse( VLC_OBJECT(a), b, c, d )
438 VLC_EXPORT( void,   __config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * ) );
439 VLC_EXPORT( char *, config_ChainCreate, ( char **, config_chain_t **, const char * ) );
440 VLC_EXPORT( void, config_ChainDestroy, ( config_chain_t * ) );
441
442 static inline config_chain_t *config_chain_find( config_chain_t *p_cfg, const char *psz_name )
443 {
444     while( p_cfg && strcmp( p_cfg->psz_name, psz_name ) )
445     {
446         p_cfg = p_cfg->p_next;
447     }
448
449     return p_cfg;
450 }
451
452 static inline char *config_chain_find_value( config_chain_t *p_cfg, const char *psz_name )
453 {
454     while( p_cfg && strcmp( p_cfg->psz_name, psz_name ) )
455     {
456         p_cfg = p_cfg->p_next;
457     }
458
459     if( p_cfg && p_cfg->psz_value )
460     {
461         return( p_cfg->psz_value );
462     }
463
464     return NULL;
465 }
466
467 # ifdef __cplusplus
468 }
469 # endif
470
471 #endif /* _VLC_CONFIGURATION_H */