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, 2000 VideoLAN
   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., 59 Temple Place - Suite 330, Boston, MA  02111, 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_LIST             0x0090  /* Module option */
  55 #define CONFIG_ITEM_MODULE_LIST_CAT         0x00A0  /* Module option */
  56
  57 #define CONFIG_ITEM                         0x00F0
  58
  59 /*******************************************************************
  60  * All predefined categories and subcategories
  61  *******************************************************************/
  62 #define CAT_INTERFACE 1
  63    #define SUBCAT_INTERFACE_GENERAL 101
  64    #define SUBCAT_INTERFACE_CONTROL 102
  65    #define SUBCAT_INTERFACE_HOTKEYS 103
  66
  67 #define CAT_AUDIO 2
  68    #define SUBCAT_AUDIO_GENERAL 201
  69    #define SUBCAT_AUDIO_AOUT 202
  70    #define SUBCAT_AUDIO_AFILTER 203
  71    #define SUBCAT_AUDIO_VISUAL 204
  72    #define SUBCAT_AUDIO_MISC 205
  73
  74 #define CAT_VIDEO 3
  75    #define SUBCAT_VIDEO_GENERAL 301
  76    #define SUBCAT_VIDEO_VOUT 302
  77    #define SUBCAT_VIDEO_VFILTER 303
  78    #define SUBCAT_VIDEO_TEXT 304
  79    #define SUBCAT_VIDEO_SUBPIC 305
  80
  81 #define CAT_INPUT 4
  82    #define SUBCAT_INPUT_ACCESS 401
  83    #define SUBCAT_INPUT_DEMUX 402
  84    #define SUBCAT_INPUT_VCODEC 403
  85    #define SUBCAT_INPUT_ACODEC 404
  86    #define SUBCAT_INPUT_SCODEC 405
  87    #define SUBCAT_INPUT_ADVANCED 406
  88
  89 #define CAT_SOUT 5
  90    #define SUBCAT_SOUT_GENERAL 501
  91    #define SUBCAT_SOUT_STREAM 502
  92    #define SUBCAT_SOUT_MUX 503
  93    #define SUBCAT_SOUT_ACO 504
  94    #define SUBCAT_SOUT_PACKETIZER 505
  95    #define SUBCAT_SOUT_SAP 506
  96    #define SUBCAT_SOUT_VOD 507
  97
  98 #define CAT_ADVANCED 6
  99    #define SUBCAT_ADVANCED_CPU 601
 100    #define SUBCAT_ADVANCED_MISC 602
 101    #define SUBCAT_ADVANCED_NETWORK 603
 102    #define SUBCAT_ADVANCED_XML 604
 103
 104 #define CAT_PLAYLIST 7
 105    #define SUBCAT_PLAYLIST_GENERAL 701
 106    #define SUBCAT_PLAYLIST_SD 702
 107    #define SUBCAT_PLAYLIST_EXPORT 703
 108
 109 struct config_category_t
 110 {
 111     int         i_id;
 112     char       *psz_name;
 113     char       *psz_help;
 114 };
 115
 116 struct module_config_t
 117 {
 118     int          i_type;                               /* Configuration type */
 119     char        *psz_type;                          /* Configuration subtype */
 120     char        *psz_name;                                    /* Option name */
 121     char         i_short;                      /* Optional short option name */
 122     char        *psz_text;      /* Short comment on the configuration option */
 123     char        *psz_longtext;   /* Long comment on the configuration option */
 124     char        *psz_value;                                  /* Option value */
 125     int          i_value;                                    /* Option value */
 126     float        f_value;                                    /* Option value */
 127     int         i_min;                               /* Option minimum value */
 128     int         i_max;                               /* Option maximum value */
 129     float       f_min;                               /* Option minimum value */
 130     float       f_max;                               /* Option maximum value */
 131
 132     /* Function to call when commiting a change */
 133     vlc_callback_t pf_callback;
 134     void          *p_callback_data;
 135
 136     /* Values list */
 137     char       **ppsz_list;        /* List of possible values for the option */
 138     int         *pi_list;          /* Idem for integers */
 139     char       **ppsz_list_text;   /* Friendly names for list values */
 140     int          i_list;           /* Options list size */
 141
 142     /* Actions list */
 143     vlc_callback_t *ppf_action;    /* List of possible actions for a config */
 144     char           **ppsz_action_text;         /* Friendly names for actions */
 145     int            i_action;                            /* actions list size */
 146
 147     /* Misc */
 148     vlc_mutex_t *p_lock;            /* Lock to use when modifying the config */
 149     vlc_bool_t   b_dirty;          /* Dirty flag to indicate a config change */
 150     vlc_bool_t   b_advanced;          /* Flag to indicate an advanced option */
 151
 152     /* Original option values */
 153     char        *psz_value_orig;
 154     int          i_value_orig;
 155     float        f_value_orig;
 156 };
 157
 158 /*****************************************************************************
 159  * Prototypes - these methods are used to get, set or manipulate configuration
 160  * data.
 161  *****************************************************************************/
 162 VLC_EXPORT( int,    __config_GetType,  (vlc_object_t *, const char *) );
 163 VLC_EXPORT( int,    __config_GetInt,   (vlc_object_t *, const char *) );
 164 VLC_EXPORT( void,   __config_PutInt,   (vlc_object_t *, const char *, int) );
 165 VLC_EXPORT( float,  __config_GetFloat, (vlc_object_t *, const char *) );
 166 VLC_EXPORT( void,   __config_PutFloat, (vlc_object_t *, const char *, float) );
 167 VLC_EXPORT( char *, __config_GetPsz,   (vlc_object_t *, const char *) );
 168 VLC_EXPORT( void,   __config_PutPsz,   (vlc_object_t *, const char *, const char *) );
 169
 170 VLC_EXPORT( int,    __config_LoadCmdLine,  ( vlc_object_t *, int *, char *[], vlc_bool_t ) );
 171 VLC_EXPORT( char *,   config_GetHomeDir,     ( void ) );
 172 VLC_EXPORT( int,    __config_LoadConfigFile, ( vlc_object_t *, const char * ) );
 173 VLC_EXPORT( int,    __config_SaveConfigFile, ( vlc_object_t *, const char * ) );
 174 VLC_EXPORT( void,   __config_ResetAll, ( vlc_object_t * ) );
 175
 176 VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) );
 177 VLC_EXPORT( module_t *, config_FindModule,( vlc_object_t *, const char * ) );
 178
 179 VLC_EXPORT( void, config_Duplicate, ( module_t *, module_config_t * ) );
 180             void  config_Free       ( module_t * );
 181
 182 VLC_EXPORT( void, config_SetCallbacks, ( module_config_t *, module_config_t * ) );
 183 VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) );
 184
 185 #define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b)
 186 #define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b)
 187 #define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c)
 188 #define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b)
 189 #define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c)
 190 #define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b)
 191 #define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c)
 192
 193 #define config_LoadCmdLine(a,b,c,d) __config_LoadCmdLine(VLC_OBJECT(a),b,c,d)
 194 #define config_LoadConfigFile(a,b) __config_LoadConfigFile(VLC_OBJECT(a),b)
 195 #define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b)
 196 #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a))
 197
 198 /* internal only */
 199 int config_CreateDir( vlc_object_t *, char * );
 200
 201 /*****************************************************************************
 202  * Macros used to build the configuration structure.
 203  *
 204  * Note that internally we support only 3 types of config data: int , float
 205  *   and string.
 206  *   The other types declared here just map to one of these 3 basic types but
 207  *   have the advantage of also providing very good hints to a configuration
 208  *   interface so as to make it more user friendly.
 209  * The configuration structure also includes category hints. These hints can
 210  *   provide a configuration interface with some very useful data and again
 211  *   allow for a more user friendly interface.
 212  *****************************************************************************/
 213
 214 #define set_category( i_id ) \
 215     i_config++; \
 216     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 217         (i_config+11) * sizeof(module_config_t)); \
 218     { static module_config_t tmp = { CONFIG_CATEGORY, NULL, NULL , '\0', NULL, NULL, NULL, i_id }; p_config[ i_config ] = tmp;  }
 219
 220 #define set_subcategory( i_id ) \
 221     i_config++; \
 222     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 223         (i_config+11) * sizeof(module_config_t)); \
 224     { static module_config_t tmp = { CONFIG_SUBCATEGORY, NULL, NULL , '\0', NULL, NULL, NULL, i_id }; p_config[ i_config ] = tmp;  }
 225
 226 #define set_section( text, longtext) \
 227     i_config++; \
 228     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 229         (i_config+11) * sizeof(module_config_t)); \
 230     { static module_config_t tmp = { CONFIG_SECTION, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp;  }
 231
 232 #define add_category_hint( text, longtext, advc ) \
 233             i_config++; \
 234     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 235                             (i_config+11) * sizeof(module_config_t)); \
 236     { static module_config_t tmp = { CONFIG_HINT_CATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; p_config[i_config].b_advanced = advc; }
 237
 238 #define add_subcategory_hint( text, longtext ) \
 239             i_config++; \
 240     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 241                             (i_config+11) * sizeof(module_config_t)); \
 242     { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; }
 243
 244
 245 #define end_subcategory_hint \
 246     i_config++; \
 247     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 248         (i_config+11) * sizeof(module_config_t)); \
 249     { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, '\0' }; p_config[ i_config ] = tmp; }
 250 #define add_usage_hint( text ) \
 251     i_config++; \
 252     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 253         (i_config+11) * sizeof(module_config_t)); \
 254     { static module_config_t tmp = { CONFIG_HINT_USAGE, NULL, NULL, '\0', text }; p_config[ i_config ] = tmp; }
 255
 256
 257 #define add_string( name, psz_value, p_callback, text, longtext, advc ) \
 258     i_config++; \
 259     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 260         (i_config+11) * sizeof(module_config_t)); \
 261     { static module_config_t tmp = { CONFIG_ITEM_STRING, NULL, name, '\0', text, longtext, psz_value }; tmp.b_advanced = advc; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; }
 262 #define add_file( name, psz_value, p_callback, text, longtext, advc ) \
 263     i_config++; \
 264     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 265         (i_config+11) * sizeof(module_config_t)); \
 266     { static module_config_t tmp = { CONFIG_ITEM_FILE, NULL, name, '\0', text, longtext, psz_value, 0, 0 }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
 267 #define add_directory( name, psz_value, p_callback, text, longtext, advc ) \
 268     i_config++; \
 269     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 270         (i_config+11) * sizeof(module_config_t)); \
 271     { static module_config_t tmp = { CONFIG_ITEM_DIRECTORY, NULL, name, '\0', text, longtext, psz_value, 0, 0 }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
 272
 273 #define add_module( name, psz_caps, psz_value, p_callback, text, longtext, advc ) \
 274     i_config++; \
 275     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 276         (i_config+11) * sizeof(module_config_t)); \
 277     { static module_config_t tmp = { CONFIG_ITEM_MODULE, psz_caps, name, '\0', text, longtext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
 278
 279
 280 #define add_module_list( name, psz_caps, psz_value, p_callback, text, longtext, advc ) \
 281     i_config++; \
 282     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 283         (i_config+11) * sizeof(module_config_t)); \
 284     { static module_config_t tmp = { CONFIG_ITEM_MODULE_LIST, psz_caps, name, '\0', text, longtext, psz_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
 285
 286
 287 #define add_module_list_cat( name, i_subcategory, psz_value, p_callback, text, longtext, advc ) \
 288     i_config++; \
 289     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 290         (i_config+11) * sizeof(module_config_t)); \
 291     { static module_config_t tmp = { CONFIG_ITEM_MODULE_LIST_CAT, NULL, name, '\0', text, longtext, psz_value, 0, 0.0, i_subcategory }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
 292
 293 #define add_integer( name, i_value, p_callback, text, longtext, advc ) \
 294     i_config++; \
 295     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 296         (i_config+11) * sizeof(module_config_t)); \
 297     { static module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, '\0', text, longtext, NULL, i_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
 298
 299 #define add_key( name, i_value, p_callback, text, longtext, advc ) \
 300     i_config++; \
 301     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 302         (i_config+11) * sizeof(module_config_t)); \
 303     { static module_config_t tmp = { CONFIG_ITEM_KEY, NULL, name, '\0', text, longtext, NULL, i_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
 304
 305 #define add_integer_with_range( name, i_value, i_min, i_max, p_callback, text, longtext, advc ) \
 306     i_config++; \
 307     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 308         (i_config+11) * sizeof(module_config_t)); \
 309     { static module_config_t tmp = { CONFIG_ITEM_INTEGER, NULL, name, '\0', text, longtext, NULL, i_value, 0, i_min, i_max }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
 310
 311 #define add_float( name, f_value, p_callback, text, longtext, advc ) \
 312     i_config++; \
 313     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 314         (i_config+11) * sizeof(module_config_t)); \
 315     { static module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, '\0', text, longtext, NULL, 0, f_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
 316
 317 #define add_float_with_range( name, f_value, f_min, f_max, p_callback, text, longtext, advc ) \
 318     i_config++; \
 319     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 320         (i_config+11) * sizeof(module_config_t)); \
 321     { static module_config_t tmp = { CONFIG_ITEM_FLOAT, NULL, name, '\0', text, longtext, NULL, 0, f_value, 0, 0, f_min, f_max }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
 322
 323 #define add_bool( name, b_value, p_callback, text, longtext, advc ) \
 324     i_config++; \
 325     if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \
 326         (i_config+11) * sizeof(module_config_t)); \
 327     { static module_config_t tmp = { CONFIG_ITEM_BOOL, NULL, name, '\0', text, longtext, NULL, b_value }; p_config[ i_config ] = tmp; p_config[ i_config ].pf_callback = p_callback; p_config[i_config].b_advanced = advc; }
 328
 329 /* Modifier macros for the config options (used for fine tuning) */
 330 #define change_short( ch ) \
 331     p_config[i_config].i_short = ch;
 332
 333 #define change_string_list( list, list_text, list_update_func ) \
 334     p_config[i_config].i_list = sizeof(list)/sizeof(char *); \
 335     p_config[i_config].ppsz_list = list; \
 336     p_config[i_config].ppsz_list_text = list_text;
 337
 338 #define change_integer_list( list, list_text, list_update_func ) \
 339     p_config[i_config].i_list = sizeof(list)/sizeof(int); \
 340     p_config[i_config].pi_list = list; \
 341     p_config[i_config].ppsz_list_text = list_text;
 342
 343 #define change_integer_range( min, max ) \
 344     p_config[i_config].i_min = min; \
 345     p_config[i_config].i_max = max;
 346
 347 #define change_float_range( min, max ) \
 348     p_config[i_config].f_min = min; \
 349     p_config[i_config].f_max = max;
 350
 351 #define change_action_add( pf_action, action_text ) \
 352     if( !p_config[i_config].i_action ) \
 353     { p_config[i_config].ppsz_action_text = 0; \
 354       p_config[i_config].ppf_action = 0; } \
 355     p_config[i_config].ppf_action = (vlc_callback_t *) \
 356       realloc( p_config[i_config].ppf_action, \
 357       (p_config[i_config].i_action + 1) * sizeof(void *) ); \
 358     p_config[i_config].ppsz_action_text = (char **)\
 359       realloc( p_config[i_config].ppsz_action_text, \
 360       (p_config[i_config].i_action + 1) * sizeof(void *) ); \
 361     p_config[i_config].ppf_action[p_config[i_config].i_action] = pf_action; \
 362     p_config[i_config].ppsz_action_text[p_config[i_config].i_action] = \
 363       action_text; \
 364     p_config[i_config].i_action++;