]> git.sesse.net Git - vlc/blob - include/vlc_configuration.h
Export config_Get*Dir
[vlc] / 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     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     char **      ppsz_list;       /* List of possible values for the option */
169     int         *pi_list;                              /* Idem for integers */
170     char       **ppsz_list_text;          /* Friendly names for list values */
171     int          i_list;                               /* Options list size */
172     vlc_callback_t pf_update_list; /*callback to initialize dropdownlists */
173
174     /* Actions list */
175     vlc_callback_t *ppf_action;    /* List of possible actions for a config */
176     char          **ppsz_action_text;         /* Friendly names for actions */
177     int            i_action;                           /* actions list size */
178
179     /* Misc */
180     vlc_mutex_t *p_lock;            /* Lock to use when modifying the config */
181     bool   b_dirty;          /* Dirty flag to indicate a config change */
182     bool   b_advanced;          /* Flag to indicate an advanced option */
183     bool   b_internal;   /* Flag to indicate option is not to be shown */
184     bool   b_restart;   /* Flag to indicate the option needs a restart */
185                               /* to take effect */
186
187     /* Deprecated */
188     char          *psz_oldname;                          /* Old option name */
189     bool     b_removed;
190
191     /* Option values loaded from config file */
192     bool   b_autosave;      /* Config will be auto-saved at exit time */
193     bool   b_unsaveable;                /* Config should not be saved */
194
195     bool   b_safe;
196 };
197
198 /*****************************************************************************
199  * Prototypes - these methods are used to get, set or manipulate configuration
200  * data.
201  *****************************************************************************/
202 VLC_EXPORT( int,    __config_GetType,  (vlc_object_t *, const char *) );
203 VLC_EXPORT( int,    __config_GetInt,   (vlc_object_t *, const char *) );
204 VLC_EXPORT( void,   __config_PutInt,   (vlc_object_t *, const char *, int) );
205 VLC_EXPORT( float,  __config_GetFloat, (vlc_object_t *, const char *) );
206 VLC_EXPORT( void,   __config_PutFloat, (vlc_object_t *, const char *, float) );
207 VLC_EXPORT( char *, __config_GetPsz,   (vlc_object_t *, const char *) );
208 VLC_EXPORT( void,   __config_PutPsz,   (vlc_object_t *, const char *, const char *) );
209
210 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
211 VLC_EXPORT( int,    __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
212 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
213 VLC_EXPORT( void,   __config_ResetAll, ( vlc_object_t * ) );
214
215 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
216
217 VLC_EXPORT(const char *, config_GetDataDir, ( void ));
218 VLC_EXPORT(char *, config_GetConfigDir, ( void ) );
219 VLC_EXPORT(char *, config_GetUserDataDir, ( void ) );
220 VLC_EXPORT(char *, config_GetCacheDir, ( void ) );
221
222 VLC_EXPORT( void,       __config_AddIntf,    ( vlc_object_t *, const char * ) );
223 VLC_EXPORT( void,       __config_RemoveIntf, ( vlc_object_t *, const char * ) );
224 VLC_EXPORT( bool, __config_ExistIntf,  ( vlc_object_t *, const char * ) );
225
226 #define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
227 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
228 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
229 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
230 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
231 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
232 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
233
234 #define config_AddIntf(a,b) __config_AddIntf(VLC_OBJECT(a),b)
235 #define config_RemoveIntf(a,b) __config_RemoveIntf(VLC_OBJECT(a),b)
236 #define config_ExistIntf(a,b) __config_ExistIntf(VLC_OBJECT(a),b)
237
238 enum vlc_config_properties
239 {
240     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
241      * Append new items at the end ONLY. */
242
243     VLC_CONFIG_NAME,
244     /* command line name (args=const char *, vlc_callback_t) */
245
246     VLC_CONFIG_DESC,
247     /* description (args=const char *, const char *) */
248
249     VLC_CONFIG_VALUE,
250     /* actual value (args=int/double/const char *) */
251
252     VLC_CONFIG_RANGE,
253     /* minimum value (args=int/double/const char * twice) */
254
255     VLC_CONFIG_ADVANCED,
256     /* enable advanced flag (args=none) */
257
258     VLC_CONFIG_VOLATILE,
259     /* don't write variable to storage (args=none) */
260
261     VLC_CONFIG_PERSISTENT,
262     /* always write variable to storage (args=none) */
263
264     VLC_CONFIG_RESTART,
265     /* restart required to apply value change (args=none) */
266
267     VLC_CONFIG_PRIVATE,
268     /* hide from user (args=none) */
269
270     VLC_CONFIG_REMOVED,
271     /* tag as no longer supported (args=none) */
272
273     VLC_CONFIG_CAPABILITY,
274     /* capability for a module or list thereof (args=const char*) */
275
276     VLC_CONFIG_SHORTCUT,
277     /* one-character (short) command line option name (args=char) */
278
279     VLC_CONFIG_LIST,
280     /* possible values list
281      * (args=size_t, const <type> *, const char *const *) */
282
283     VLC_CONFIG_ADD_ACTION,
284     /* add value change callback (args=vlc_callback_t, const char *) */
285
286     VLC_CONFIG_OLDNAME,
287     /* former option name (args=const char *) */
288
289     VLC_CONFIG_SAFE,
290     /* tag as modifiable by untrusted input item "sources" (args=none) */
291 };
292
293
294 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
295 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
296
297 /*****************************************************************************
298  * Macros used to build the configuration structure.
299  *
300  * Note that internally we support only 3 types of config data: int, float
301  *   and string.
302  *   The other types declared here just map to one of these 3 basic types but
303  *   have the advantage of also providing very good hints to a configuration
304  *   interface so as to make it more user friendly.
305  * The configuration structure also includes category hints. These hints can
306  *   provide a configuration interface with some very useful data and again
307  *   allow for a more user friendly interface.
308  *****************************************************************************/
309
310 #define add_type_inner( type ) \
311     p_config = vlc_config_create (p_module, type)
312
313 #define add_typedesc_inner( type, text, longtext ) \
314     add_type_inner( type ); \
315     vlc_config_set (p_config, VLC_CONFIG_DESC, \
316                     (const char *)(text), (const char *)(longtext))
317
318 #define add_typeadv_inner( type, text, longtext, advc ) \
319     add_typedesc_inner( type, text, longtext ); \
320     if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED)
321
322 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
323     add_typeadv_inner( type, text, longtext, advc ); \
324     vlc_config_set (p_config, VLC_CONFIG_NAME, \
325                     (const char *)(name), (vlc_callback_t)(cb))
326
327 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
328     add_typename_inner( type, name, text, longtext, advc, cb ); \
329     vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v))
330
331 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
332     add_typename_inner( type, name, text, longtext, advc, cb ); \
333     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v))
334
335
336 #define set_category( i_id ) \
337     add_type_inner( CONFIG_CATEGORY ); \
338     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
339
340 #define set_subcategory( i_id ) \
341     add_type_inner( CONFIG_SUBCATEGORY ); \
342     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
343
344 #define set_section( text, longtext ) \
345     add_typedesc_inner( CONFIG_SECTION, text, longtext )
346
347 #define add_category_hint( text, longtext, advc ) \
348     add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
349
350 #define add_subcategory_hint( text, longtext ) \
351     add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
352
353 #define end_subcategory_hint \
354     add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
355
356 #define add_usage_hint( text ) \
357     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
358
359 #define add_string( name, value, p_callback, text, longtext, advc ) \
360     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value )
361
362 #define add_password( name, value, p_callback, text, longtext, advc ) \
363     add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, p_callback, value )
364
365 #define add_file( name, value, p_callback, text, longtext, advc ) \
366     add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value )
367
368 #define add_directory( name, value, p_callback, text, longtext, advc ) \
369     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value )
370
371 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
372     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \
373     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
374
375 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
376     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \
377     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
378
379 #ifndef __PLUGIN__
380 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
381     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \
382     p_config->min.i = i_subcategory /* gruik */
383
384 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
385     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \
386     p_config->min.i = i_subcategory /* gruik */
387 #endif
388
389 #define add_integer( name, value, p_callback, text, longtext, advc ) \
390     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
391
392 #define add_key( name, value, p_callback, text, longtext, advc ) \
393     add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value )
394
395 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
396     add_integer( name, value, p_callback, text, longtext, advc ); \
397     change_integer_range( i_min, i_max )
398
399 #define add_float( name, v, p_callback, text, longtext, advc ) \
400     add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \
401     vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v))
402
403 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
404     add_float( name, value, p_callback, text, longtext, advc ); \
405     change_float_range( f_min, f_max )
406
407 #define add_bool( name, v, p_callback, text, longtext, advc ) \
408     add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \
409     if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true)
410
411 /* For removed option */
412 #define add_obsolete_inner( name, type ) \
413     add_type_inner( type ); \
414     vlc_config_set (p_config, VLC_CONFIG_NAME, \
415                     (const char *)(name), (vlc_callback_t)NULL); \
416     vlc_config_set (p_config, VLC_CONFIG_REMOVED)
417
418 #define add_obsolete_bool( name ) \
419         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
420
421 #define add_obsolete_integer( name ) \
422         add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
423
424 #define add_obsolete_float( name ) \
425         add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
426
427 #define add_obsolete_string( name ) \
428         add_obsolete_inner( name, CONFIG_ITEM_STRING )
429
430 /* Modifier macros for the config options (used for fine tuning) */
431
432 #define add_deprecated_alias( name ) \
433     vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))
434
435 #define change_short( ch ) \
436     vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch))
437
438 #define change_string_list( list, list_text, list_update_func ) \
439     vlc_config_set (p_config, VLC_CONFIG_LIST, \
440                     (size_t)(sizeof (list) / sizeof (char *)), \
441                     (const char *const *)(list), \
442                     (const char *const *)(list_text), \
443                     list_update_func)
444
445 #define change_integer_list( list, list_text, list_update_func ) \
446     vlc_config_set (p_config, VLC_CONFIG_LIST, \
447                     (size_t)(sizeof (list) / sizeof (int)), \
448                     (const int *)(list), \
449                     (const char *const *)(list_text), \
450                     list_update_func)
451
452 #define change_float_list( list, list_text, list_update_func ) \
453     vlc_config_set (p_config, VLC_CONFIG_LIST, \
454                     (size_t)(sizeof (list) / sizeof (float)), \
455                     (const float *)(list), \
456                     (const char *const *)(list_text), \
457                     list_update_func)
458
459 #define change_integer_range( minv, maxv ) \
460     vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv))
461
462 #define change_float_range( minv, maxv ) \
463     vlc_config_set (p_config, VLC_CONFIG_RANGE, \
464                     (double)(minv), (double)(maxv))
465
466 #define change_action_add( pf_action, text ) \
467     vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
468                     (vlc_callback_t)(pf_action), (const char *)(text))
469
470 #define change_internal() \
471     vlc_config_set (p_config, VLC_CONFIG_PRIVATE)
472
473 #define change_need_restart() \
474     vlc_config_set (p_config, VLC_CONFIG_RESTART)
475
476 #define change_autosave() \
477     vlc_config_set (p_config, VLC_CONFIG_PERSISTENT)
478
479 #define change_unsaveable() \
480     vlc_config_set (p_config, VLC_CONFIG_VOLATILE)
481
482 #define change_unsafe() (void)0 /* no-op */
483
484 #define change_safe() \
485     vlc_config_set (p_config, VLC_CONFIG_SAFE)
486
487 /****************************************************************************
488  * config_chain_t:
489  ****************************************************************************/
490 struct config_chain_t
491 {
492     config_chain_t *p_next;
493
494     char        *psz_name;
495     char        *psz_value;
496 };
497
498 #define config_ChainParse( a, b, c, d ) __config_ChainParse( VLC_OBJECT(a), b, c, d )
499 VLC_EXPORT( void,   __config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * ) );
500 VLC_EXPORT( char *, config_ChainCreate, ( char **, config_chain_t **, const char * ) );
501 VLC_EXPORT( void, config_ChainDestroy, ( config_chain_t * ) );
502
503 # ifdef __cplusplus
504 }
505 # endif
506
507 #endif /* _VLC_CONFIGURATION_H */