X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fconfiguration.h;h=58466ab3ad58717c961cd21c7af351449d2c1ed9;hb=af23abe4b8908ee9067b412fce5b93918e8750b1;hp=ac9848c82a9e1a4c54949aa959998b299df4718c;hpb=78270dd35467a3900c606ba4771356d7f2d366d0;p=vlc diff --git a/include/configuration.h b/include/configuration.h index ac9848c82a..58466ab3ad 100644 --- a/include/configuration.h +++ b/include/configuration.h @@ -3,7 +3,7 @@ * This file describes the programming interface for the configuration module. * It includes functions allowing to declare, get or set configuration options. ***************************************************************************** - * Copyright (C) 1999, 2000 the VideoLAN team + * Copyright (C) 1999-2006 the VideoLAN team * $Id$ * * Authors: Gildas Bazin @@ -20,7 +20,7 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ /***************************************************************************** @@ -62,8 +62,9 @@ *******************************************************************/ #define CAT_INTERFACE 1 #define SUBCAT_INTERFACE_GENERAL 101 - #define SUBCAT_INTERFACE_CONTROL 102 - #define SUBCAT_INTERFACE_HOTKEYS 103 + #define SUBCAT_INTERFACE_MAIN 102 + #define SUBCAT_INTERFACE_CONTROL 103 + #define SUBCAT_INTERFACE_HOTKEYS 104 #define CAT_AUDIO 2 #define SUBCAT_AUDIO_GENERAL 201 @@ -80,13 +81,13 @@ #define SUBCAT_VIDEO_SUBPIC 305 #define CAT_INPUT 4 - #define SUBCAT_INPUT_ACCESS 401 - #define SUBCAT_INPUT_ACCESS_FILTER 402 - #define SUBCAT_INPUT_DEMUX 403 - #define SUBCAT_INPUT_VCODEC 404 - #define SUBCAT_INPUT_ACODEC 405 - #define SUBCAT_INPUT_SCODEC 406 - #define SUBCAT_INPUT_ADVANCED 407 + #define SUBCAT_INPUT_GENERAL 401 + #define SUBCAT_INPUT_ACCESS 402 + #define SUBCAT_INPUT_ACCESS_FILTER 403 + #define SUBCAT_INPUT_DEMUX 404 + #define SUBCAT_INPUT_VCODEC 405 + #define SUBCAT_INPUT_ACODEC 406 + #define SUBCAT_INPUT_SCODEC 407 #define CAT_SOUT 5 #define SUBCAT_SOUT_GENERAL 501 @@ -153,6 +154,7 @@ struct module_config_t vlc_mutex_t *p_lock; /* Lock to use when modifying the config */ vlc_bool_t b_dirty; /* Dirty flag to indicate a config change */ vlc_bool_t b_advanced; /* Flag to indicate an advanced option */ + vlc_bool_t b_internal; /* Flag to indicate option is not to be shown */ /* Original option values */ char *psz_value_orig; @@ -181,6 +183,7 @@ VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, const char VLC_EXPORT( int, __config_LoadCmdLine, ( vlc_object_t *, int *, char *[], vlc_bool_t ) ); VLC_EXPORT( char *, config_GetHomeDir, ( void ) ); VLC_EXPORT( char *, config_GetUserDir, ( void ) ); +VLC_EXPORT( const char *, config_GetDataDir, ( const vlc_object_t * ) ); VLC_EXPORT( int, __config_LoadConfigFile, ( vlc_object_t *, const char * ) ); VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) ); VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) ); @@ -208,13 +211,13 @@ VLC_EXPORT( void, config_UnsetCallbacks, ( module_config_t * ) ); #define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a)) /* internal only */ -int config_CreateDir( vlc_object_t *, char * ); +int config_CreateDir( vlc_object_t *, const char * ); int config_AutoSaveConfigFile( vlc_object_t * ); /***************************************************************************** * Macros used to build the configuration structure. * - * Note that internally we support only 3 types of config data: int , float + * Note that internally we support only 3 types of config data: int, float * and string. * The other types declared here just map to one of these 3 basic types but * have the advantage of also providing very good hints to a configuration @@ -224,174 +227,138 @@ int config_AutoSaveConfigFile( vlc_object_t * ); * allow for a more user friendly interface. *****************************************************************************/ -#define set_category( i_id ) \ +#define add_config_inner( ) \ i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { static module_config_t tmp = { CONFIG_CATEGORY, NULL, NULL , '\0', NULL, NULL, NULL, i_id }; p_config[ i_config ] = tmp; } + if( (i_config % 10) == 0 ) \ + p_config = (module_config_t *) \ + realloc(p_config, (i_config+11) * sizeof(module_config_t)); \ + memset( p_config + i_config, 0, sizeof( *p_config ) ) + +#define add_type_inner( type ) \ + add_config_inner( ); \ + p_config[i_config].i_type = type + +#define add_typedesc_inner( type, text, longtext ) \ + add_type_inner( type ); \ + p_config[i_config].psz_text = text; \ + p_config[i_config].psz_longtext = longtext + +#define add_typeadv_inner( type, text, longtext, advc ) \ + add_typedesc_inner( type, text, longtext ); \ + p_config[i_config].b_advanced = advc + +#define add_typename_inner( type, name, text, longtext, advc, cb ) \ + add_typeadv_inner( type, text, longtext, advc ); \ + p_config[i_config].psz_name = name; \ + p_config[i_config].pf_callback = cb + +#define add_string_inner( type, name, text, longtext, advc, cb, value ) \ + add_typename_inner( type, name, text, longtext, advc, cb ); \ + p_config[i_config].psz_value = value + +#define add_int_inner( type, name, text, longtext, advc, cb, value ) \ + add_typename_inner( type, name, text, longtext, advc, cb ); \ + p_config[i_config].i_value = value + + +#define set_category( i_id ) \ + add_type_inner( CONFIG_CATEGORY ); \ + p_config[i_config].i_value = i_id #define set_subcategory( i_id ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { static module_config_t tmp = { CONFIG_SUBCATEGORY, NULL, NULL , '\0', NULL, NULL, NULL, i_id }; p_config[ i_config ] = tmp; } + add_type_inner( CONFIG_SUBCATEGORY ); \ + p_config[i_config].i_value = i_id -#define set_section( text, longtext) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { static module_config_t tmp = { CONFIG_SECTION, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; } +#define set_section( text, longtext ) \ + add_typedesc_inner( CONFIG_SECTION, text, longtext ) #define add_category_hint( text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } + add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc ) #define add_subcategory_hint( text, longtext ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY, NULL, NULL, '\0', text, longtext }; p_config[ i_config ] = tmp; } - + add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext ) #define end_subcategory_hint \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { static module_config_t tmp = { CONFIG_HINT_SUBCATEGORY_END, NULL, NULL, '\0' }; p_config[ i_config ] = tmp; } + add_type_inner( CONFIG_HINT_SUBCATEGORY_END ) + #define add_usage_hint( text ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { static module_config_t tmp = { CONFIG_HINT_USAGE, NULL, NULL, '\0', text }; p_config[ i_config ] = tmp; } + add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL ) +#define add_string( name, value, p_callback, text, longtext, advc ) \ + add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value ) -#define add_string( name, psz_value, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } -#define add_file( name, psz_value, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } -#define add_directory( name, psz_value, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } +#define add_file( name, value, p_callback, text, longtext, advc ) \ + add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value ) -#define add_module( name, psz_caps, psz_value, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } +#define add_directory( name, value, p_callback, text, longtext, advc ) \ + add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value ) -#define add_module_cat( name, i_subcategory, psz_value, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } +#define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \ + add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \ + p_config[i_config].psz_type = psz_caps -#define add_module_list( name, psz_caps, psz_value, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } +#define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \ + add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \ + p_config[i_config].i_min = i_subcategory /* gruik */ +#define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \ + add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \ + p_config[i_config].psz_type = psz_caps -#define add_module_list_cat( name, i_subcategory, psz_value, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } +#define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \ + add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \ + p_config[i_config].i_min = i_subcategory /* gruik */ -#define add_integer( name, i_value, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } +#define add_integer( name, value, p_callback, text, longtext, advc ) \ + add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value ) -#define add_key( name, i_value, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } +#define add_key( name, value, p_callback, text, longtext, advc ) \ + add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value ) -#define add_integer_with_range( name, i_value, i_min, i_max, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } +#define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \ + add_integer( name, value, p_callback, text, longtext, advc ); \ + change_integer_range( i_min, i_max ) -#define add_float( name, f_value, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } +#define add_float( name, value, p_callback, text, longtext, advc ) \ + add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \ + p_config[i_config].f_value = value -#define add_float_with_range( name, f_value, f_min, f_max, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } +#define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \ + add_float( name, value, p_callback, text, longtext, advc ); \ + change_float_range( f_min, f_max ) + +#define add_bool( name, value, p_callback, text, longtext, advc ) \ + add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \ + p_config[i_config].i_value = value -#define add_bool( name, b_value, p_callback, text, longtext, advc ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { 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; } /* For option renamed */ #define add_deprecated( name, strict ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { static module_config_t tmp; \ - p_config[ i_config ] = tmp; \ - p_config[ i_config ].i_type = p_config[ i_config -1 ].i_type; \ - p_config[ i_config ].psz_name = name; \ - p_config[i_config].b_strict = strict; \ - p_config[ i_config ].psz_current = p_config[ i_config-1].psz_current?p_config[ i_config-1 ].psz_current:p_config[ i_config-1 ].psz_name; } + add_config_inner( ); \ + p_config[ i_config ].i_type = p_config[ i_config -1 ].i_type; \ + p_config[ i_config ].psz_name = name; \ + p_config[i_config].b_strict = strict; \ + p_config[ i_config ].psz_current = p_config[ i_config-1].psz_current \ + ? p_config[ i_config-1 ].psz_current \ + : p_config[ i_config-1 ].psz_name; + /* For option suppressed*/ +#define add_suppressed_inner( name, type ) \ + add_type_inner( type ); \ + p_config[ i_config ].psz_name = name; \ + p_config[ i_config ].psz_current = "SUPPRESSED"; + #define add_suppressed_bool( name ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { static module_config_t tmp; \ - p_config[ i_config ] = tmp; \ - p_config[ i_config ].i_type = CONFIG_ITEM_BOOL; \ - p_config[ i_config ].psz_name = name; \ - p_config[ i_config ].psz_current = "SUPPRESSED"; } + add_suppressed_inner( name, CONFIG_ITEM_BOOL ) #define add_suppressed_integer( name ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { static module_config_t tmp; \ - p_config[ i_config ] = tmp; \ - p_config[ i_config ].i_type = CONFIG_ITEM_INTEGER; \ - p_config[ i_config ].psz_name = name; \ - p_config[ i_config ].psz_current = "SUPPRESSED"; } + add_suppressed_inner( name, CONFIG_ITEM_INTEGER ) + #define add_suppressed_float( name ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { static module_config_t tmp; \ - p_config[ i_config ] = tmp; \ - p_config[ i_config ].i_type = CONFIG_ITEM_FLOAT; \ - p_config[ i_config ].psz_name = name; \ - p_config[ i_config ].psz_current = "SUPPRESSED"; } + add_suppressed_inner( name, CONFIG_ITEM_FLOAT ) + #define add_suppressed_string( name ) \ - i_config++; \ - if(!(i_config%10)) p_config = (module_config_t* )realloc(p_config, \ - (i_config+11) * sizeof(module_config_t)); \ - { static module_config_t tmp; \ - p_config[ i_config ] = tmp; \ - p_config[ i_config ].i_type = CONFIG_ITEM_STRING; \ - p_config[ i_config ].psz_name = name; \ - p_config[ i_config ].psz_current = "SUPPRESSED"; } + add_suppressed_inner( name, CONFIG_ITEM_STRING ) + /* Modifier macros for the config options (used for fine tuning) */ #define change_short( ch ) \ p_config[i_config].i_short = ch; @@ -429,5 +396,8 @@ int config_AutoSaveConfigFile( vlc_object_t * ); action_text; \ p_config[i_config].i_action++; +#define change_internal() \ + p_config[i_config].b_internal = VLC_TRUE; + #define change_autosave() \ p_config[i_config].b_autosave = VLC_TRUE;