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