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