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