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