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