X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_configuration.h;h=c2c544a22af89bd462a499ca3ff06b5a4bc0f2d4;hb=12ade3e3bc975d5426ba4af155b7372c31093b31;hp=0611e5549e2101278f03f9e42588424c1b8aa861;hpb=3655c1c6edfa65212b263fa330e0bf4809eeb5d1;p=vlc diff --git a/include/vlc_configuration.h b/include/vlc_configuration.h index 0611e5549e..c2c544a22a 100644 --- a/include/vlc_configuration.h +++ b/include/vlc_configuration.h @@ -23,13 +23,14 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#if !defined( __LIBVLC__ ) - #error You are not libvlc or one of its plugins. You cannot include this file -#endif - -#ifndef _VLC_CONFIGURATION_H -#define _VLC_CONFIGURATION_H 1 +#ifndef VLC_CONFIGURATION_H +#define VLC_CONFIGURATION_H 1 +/** + * \file + * This file describes the programming interface for the configuration module. + * It includes functions allowing to declare, get or set configuration options. + */ # ifdef __cplusplus extern "C" { @@ -97,11 +98,11 @@ extern "C" { #define CAT_INPUT 4 #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 SUBCAT_INPUT_DEMUX 403 + #define SUBCAT_INPUT_VCODEC 404 + #define SUBCAT_INPUT_ACODEC 405 + #define SUBCAT_INPUT_SCODEC 406 + #define SUBCAT_INPUT_STREAM_FILTER 407 #define CAT_SOUT 5 #define SUBCAT_SOUT_GENERAL 501 @@ -136,29 +137,21 @@ struct config_category_t typedef union { char *psz; - int i; + int64_t i; float f; } module_value_t; -typedef union -{ - int i; - float f; -} module_nvalue_t; - struct module_config_t { - int i_type; /* Configuration type */ char *psz_type; /* Configuration subtype */ char *psz_name; /* Option name */ - char i_short; /* Optional short option name */ char *psz_text; /* Short comment on the configuration option */ char *psz_longtext; /* Long comment on the configuration option */ module_value_t value; /* Option value */ module_value_t orig; module_value_t saved; - module_nvalue_t min; - module_nvalue_t max; + module_value_t min; + module_value_t max; /* Function to call when commiting a change */ vlc_callback_t pf_callback; @@ -169,334 +162,157 @@ struct module_config_t int *pi_list; /* Idem for integers */ char **ppsz_list_text; /* Friendly names for list values */ int i_list; /* Options list size */ + int i_type; /* Configuration type */ + vlc_callback_t pf_update_list; /*callback to initialize dropdownlists */ + char i_short; /* Optional short option name */ /* Actions list */ + int i_action; /* actions list size */ vlc_callback_t *ppf_action; /* List of possible actions for a config */ char **ppsz_action_text; /* Friendly names for actions */ - int i_action; /* actions list size */ - - /* Misc */ - 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 */ - vlc_bool_t b_restart; /* Flag to indicate the option needs a restart */ - /* to take effect */ /* Deprecated */ - char *psz_oldname; /* Old option name */ - vlc_bool_t b_removed; + char *psz_oldname; /* Old option name */ + bool b_removed; + /* Misc */ + bool b_dirty; /* Dirty flag to indicate a config change */ + bool b_advanced; /* Flag to indicate an advanced option */ + bool b_internal; /* Flag to indicate option is not to be shown */ + bool b_restart; /* Flag to indicate the option needs a restart */ + /* to take effect */ /* Option values loaded from config file */ - vlc_bool_t b_autosave; /* Config will be auto-saved at exit time */ - vlc_bool_t b_unsaveable; /* Config should be saved */ + bool b_autosave; /* Config will be auto-saved at exit time */ + bool b_unsaveable; /* Config should not be saved */ + + bool b_safe; }; /***************************************************************************** * Prototypes - these methods are used to get, set or manipulate configuration * data. *****************************************************************************/ -VLC_EXPORT( int, __config_GetType, (vlc_object_t *, const char *) ); -VLC_EXPORT( int, __config_GetInt, (vlc_object_t *, const char *) ); -VLC_EXPORT( void, __config_PutInt, (vlc_object_t *, const char *, int) ); -VLC_EXPORT( float, __config_GetFloat, (vlc_object_t *, const char *) ); -VLC_EXPORT( void, __config_PutFloat, (vlc_object_t *, const char *, float) ); -VLC_EXPORT( char *, __config_GetPsz, (vlc_object_t *, const char *) ); -VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, const char *) ); - -#define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b) -VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) ); -#define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a)) -VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) ); - -VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) ); - -VLC_EXPORT( int, config_Duplicate,( module_t *, const module_config_t *, size_t )); - -VLC_EXPORT(const char *, config_GetDataDir, ( void )); - -VLC_EXPORT( void, __config_AddIntf, ( vlc_object_t *, const char * ) ); -VLC_EXPORT( void, __config_RemoveIntf, ( vlc_object_t *, const char * ) ); -VLC_EXPORT( vlc_bool_t, __config_ExistIntf, ( vlc_object_t *, const char * ) ); - -#define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b) -#define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b) -#define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c) -#define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b) -#define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c) -#define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b) -#define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c) - -#define config_AddIntf(a,b) __config_AddIntf(VLC_OBJECT(a),b) -#define config_RemoveIntf(a,b) __config_RemoveIntf(VLC_OBJECT(a),b) -#define config_ExistIntf(a,b) __config_ExistIntf(VLC_OBJECT(a),b) - -enum vlc_config_properties +VLC_EXPORT( int, config_GetType, (vlc_object_t *, const char *) LIBVLC_USED ); +VLC_EXPORT( int64_t, config_GetInt, (vlc_object_t *, const char *) LIBVLC_USED ); +VLC_EXPORT( void, config_PutInt, (vlc_object_t *, const char *, int64_t) ); +VLC_EXPORT( float, config_GetFloat, (vlc_object_t *, const char *) LIBVLC_USED ); +VLC_EXPORT( void, config_PutFloat, (vlc_object_t *, const char *, float) ); +VLC_EXPORT( char *, config_GetPsz, (vlc_object_t *, const char *) LIBVLC_USED ); +VLC_EXPORT( void, config_PutPsz, (vlc_object_t *, const char *, const char *) ); + +VLC_EXPORT( int, config_SaveConfigFile, ( vlc_object_t *, const char * ) ); +#define config_SaveConfigFile(a,b) config_SaveConfigFile(VLC_OBJECT(a),b) +VLC_EXPORT( void, config_ResetAll, ( vlc_object_t * ) ); +#define config_ResetAll(a) config_ResetAll(VLC_OBJECT(a)) + +VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) LIBVLC_USED ); +VLC_EXPORT(char *, config_GetDataDir, ( vlc_object_t * ) LIBVLC_USED); +#define config_GetDataDir(a) config_GetDataDir(VLC_OBJECT(a)) +VLC_EXPORT(const char *, config_GetLibDir, ( void ) LIBVLC_USED); +VLC_EXPORT(const char *, config_GetConfDir, ( void ) LIBVLC_USED); + +typedef enum vlc_userdir { - /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI! - * Append new items at the end ONLY. */ - - VLC_CONFIG_NAME, - /* command line name (args=const char *, vlc_callback_t) */ - - VLC_CONFIG_DESC, - /* description (args=const char *, const char *) */ - - VLC_CONFIG_VALUE, - /* actual value (args=int/double/const char *) */ - - VLC_CONFIG_RANGE, - /* minimum value (args=int/double/const char * twice) */ - - VLC_CONFIG_ADVANCED, - /* enable advanced flag (args=none) */ - - VLC_CONFIG_VOLATILE, - /* don't write variable to storage (args=none) */ - - VLC_CONFIG_PERSISTENT, - /* always write variable to storage (args=none) */ - - VLC_CONFIG_RESTART, - /* restart required to apply value change (args=none) */ - - VLC_CONFIG_PRIVATE, - /* hide from user (args=none) */ - - VLC_CONFIG_REMOVED, - /* tag as no longer supported (args=none) */ - - VLC_CONFIG_CAPABILITY, - /* capability for a module or list thereof (args=const char*) */ - - VLC_CONFIG_SHORTCUT, - /* one-character (short) command line option name (args=char) */ - - VLC_CONFIG_LIST, - /* possible values list - * (args=size_t, const *, const char *const *) */ - - VLC_CONFIG_ADD_ACTION, - /* add value change callback (args=vlc_callback_t, const char *) */ - - VLC_CONFIG_OLDNAME, - /* former option name (args=const char *) */ -}; - - -VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) ); -VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) ); - -/***************************************************************************** - * Macros used to build the configuration structure. - * - * 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 - * interface so as to make it more user friendly. - * The configuration structure also includes category hints. These hints can - * provide a configuration interface with some very useful data and again - * allow for a more user friendly interface. - *****************************************************************************/ - -#define add_config_inner( ) \ - i_config++; \ - 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 ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_DESC, \ - (const char *)(text), (const char *)(longtext)) - -#define add_typeadv_inner( type, text, longtext, advc ) \ - add_typedesc_inner( type, text, longtext ); \ - if (advc) vlc_config_set (p_config + i_config, VLC_CONFIG_ADVANCED) - -#define add_typename_inner( type, name, text, longtext, advc, cb ) \ - add_typeadv_inner( type, text, longtext, advc ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_NAME, \ - (const char *)(name), (vlc_callback_t)(cb)) - -#define add_string_inner( type, name, text, longtext, advc, cb, v ) \ - add_typename_inner( type, name, text, longtext, advc, cb ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_VALUE, (const char *)(v)) - -#define add_int_inner( type, name, text, longtext, advc, cb, v ) \ - add_typename_inner( type, name, text, longtext, advc, cb ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_VALUE, (int)(v)) - - -#define set_category( i_id ) \ - add_type_inner( CONFIG_CATEGORY ); \ - p_config[i_config].value.i = i_id - -#define set_subcategory( i_id ) \ - add_type_inner( CONFIG_SUBCATEGORY ); \ - p_config[i_config].value.i = i_id - -#define set_section( text, longtext ) \ - add_typedesc_inner( CONFIG_SECTION, text, longtext ) - -#define add_category_hint( text, longtext, advc ) \ - add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc ) - -#define add_subcategory_hint( text, longtext ) \ - add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext ) - -#define end_subcategory_hint \ - add_type_inner( CONFIG_HINT_SUBCATEGORY_END ) - -#define add_usage_hint( text ) \ - 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_password( name, value, p_callback, text, longtext, advc ) \ - add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, p_callback, value ) - -#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_directory( name, value, p_callback, text, longtext, advc ) \ - add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value ) - -#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 ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_CAPABILITY, \ - (const char *)(psz_caps)) - -#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 ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_CAPABILITY, \ - (const char *)(psz_caps)) - -#ifndef __PLUGIN__ -#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].min.i = i_subcategory /* gruik */ - -#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].min.i = i_subcategory /* gruik */ -#endif - -#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, 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, 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, v, p_callback, text, longtext, advc ) \ - add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_VALUE, (double)(v)) - -#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, v, p_callback, text, longtext, advc ) \ - add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \ - if (v) vlc_config_set (p_config + i_config, VLC_CONFIG_VALUE, (int)VLC_TRUE) - -/* For removed option */ -#define add_obsolete_inner( name, type ) \ - add_type_inner( type ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_NAME, \ - (const char *)(name), (vlc_callback_t)NULL); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_REMOVED) - -#define add_obsolete_bool( name ) \ - add_obsolete_inner( name, CONFIG_ITEM_BOOL ) - -#define add_obsolete_integer( name ) \ - add_obsolete_inner( name, CONFIG_ITEM_INTEGER ) - -#define add_obsolete_float( name ) \ - add_obsolete_inner( name, CONFIG_ITEM_FLOAT ) - -#define add_obsolete_string( name ) \ - add_obsolete_inner( name, CONFIG_ITEM_STRING ) - -/* Modifier macros for the config options (used for fine tuning) */ - -#define add_deprecated_alias( name ) \ - vlc_config_set (p_config + i_config, VLC_CONFIG_OLDNAME, \ - (const char *)(name)) - -#define change_short( ch ) \ - vlc_config_set (p_config + i_config, VLC_CONFIG_SHORTCUT, (int)(ch)) - -#define change_string_list( list, list_text, list_update_func ) \ - vlc_config_set (p_config + i_config, VLC_CONFIG_LIST, \ - (size_t)(sizeof (list) / sizeof (char *)), \ - (const char *const *)(list), \ - (const char *const *)(list_text)) - -#define change_integer_list( list, list_text, list_update_func ) \ - vlc_config_set (p_config + i_config, VLC_CONFIG_LIST, \ - (size_t)(sizeof (list) / sizeof (int)), \ - (const int *)(list), \ - (const char *const *)(list_text)) - -#define change_float_list( list, list_text, list_update_func ) \ - vlc_config_set (p_config + i_config, VLC_CONFIG_LIST, \ - (size_t)(sizeof (list) / sizeof (float)), \ - (const float *)(list), \ - (const char *const *)(list_text)) - -#define change_integer_range( minv, maxv ) \ - vlc_config_set (p_config + i_config, VLC_CONFIG_RANGE, \ - (int)(minv), (int)(maxv)) - -#define change_float_range( minv, maxv ) \ - vlc_config_set (p_config + i_config, VLC_CONFIG_RANGE, \ - (double)(minv), (double)(maxv)) - -#define change_action_add( pf_action, text ) \ - vlc_config_set (p_config + i_config, VLC_CONFIG_ADD_ACTION, \ - (vlc_callback_t)(pf_action), (const char *)(text)) - -#define change_internal() \ - vlc_config_set (p_config + i_config, VLC_CONFIG_PRIVATE) - -#define change_need_restart() \ - vlc_config_set (p_config + i_config, VLC_CONFIG_RESTART) - -#define change_autosave() \ - vlc_config_set (p_config + i_config, VLC_CONFIG_PERSISTENT) - -#define change_unsaveable() \ - vlc_config_set (p_config + i_config, VLC_CONFIG_VOLATILE) + VLC_HOME_DIR, /* User's home */ + VLC_CONFIG_DIR, /* VLC-specific configuration directory */ + VLC_DATA_DIR, /* VLC-specific data directory */ + VLC_CACHE_DIR, /* VLC-specific user cached data directory */ + /* Generic directories (same as XDG) */ + VLC_DESKTOP_DIR=0x80, + VLC_DOWNLOAD_DIR, + VLC_TEMPLATES_DIR, + VLC_PUBLICSHARE_DIR, + VLC_DOCUMENTS_DIR, + VLC_MUSIC_DIR, + VLC_PICTURES_DIR, + VLC_VIDEOS_DIR, +} vlc_userdir_t; + +VLC_EXPORT(char *, config_GetUserDir, ( vlc_userdir_t ) LIBVLC_USED); + +VLC_EXPORT( void, config_AddIntf, ( vlc_object_t *, const char * ) ); +VLC_EXPORT( void, config_RemoveIntf, ( vlc_object_t *, const char * ) ); +VLC_EXPORT( bool, config_ExistIntf, ( vlc_object_t *, const char * ) LIBVLC_USED); + +#define config_GetType(a,b) config_GetType(VLC_OBJECT(a),b) +#define config_GetInt(a,b) config_GetInt(VLC_OBJECT(a),b) +#define config_PutInt(a,b,c) config_PutInt(VLC_OBJECT(a),b,c) +#define config_GetFloat(a,b) config_GetFloat(VLC_OBJECT(a),b) +#define config_PutFloat(a,b,c) config_PutFloat(VLC_OBJECT(a),b,c) +#define config_GetPsz(a,b) config_GetPsz(VLC_OBJECT(a),b) +#define config_PutPsz(a,b,c) config_PutPsz(VLC_OBJECT(a),b,c) + +#define config_AddIntf(a,b) config_AddIntf(VLC_OBJECT(a),b) +#define config_RemoveIntf(a,b) config_RemoveIntf(VLC_OBJECT(a),b) +#define config_ExistIntf(a,b) config_ExistIntf(VLC_OBJECT(a),b) /**************************************************************************** * config_chain_t: ****************************************************************************/ struct config_chain_t { - config_chain_t *p_next; + config_chain_t *p_next; /**< Pointer on the next config_chain_t element */ - char *psz_name; - char *psz_value; + char *psz_name; /**< Option name */ + char *psz_value; /**< Option value */ }; -#define config_ChainParse( a, b, c, d ) __config_ChainParse( VLC_OBJECT(a), b, c, d ) -VLC_EXPORT( void, __config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * ) ); -VLC_EXPORT( char *, config_ChainCreate, ( char **, config_chain_t **, const char * ) ); +/** + * This function will + * - create all options in the array ppsz_options (var_Create). + * - parse the given linked list of config_chain_t and set the value (var_Set). + * + * The option names will be created by adding the psz_prefix prefix. + */ +VLC_EXPORT( void, config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * ) ); +#define config_ChainParse( a, b, c, d ) config_ChainParse( VLC_OBJECT(a), b, c, d ) + +/** + * This function will parse a configuration string (psz_string) and + * - set the module name (*ppsz_name) + * - set all options for this module in a chained list (*pp_cfg) + * - returns a pointer on the next module if any. + * + * The string format is + * module{option=*,option=*}[:modulenext{option=*,...}] + * + * The options values are unescaped using config_StringUnescape. + */ +VLC_EXPORT( char *, config_ChainCreate, ( char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string ) ) LIBVLC_USED LIBVLC_MALLOC; + +/** + * This function will release a linked list of config_chain_t + * (Including the head) + */ VLC_EXPORT( void, config_ChainDestroy, ( config_chain_t * ) ); +/** + * This function will duplicate a linked list of config_chain_t + */ +VLC_EXPORT( config_chain_t *, config_ChainDuplicate, ( const config_chain_t * ) ); + +/** + * This function will unescape a string in place and will return a pointer on + * the given string. + * No memory is allocated by it (unlike config_StringEscape). + * If NULL is given as parameter nothing will be done (NULL will be returned). + * + * The following sequences will be unescaped (only one time): + * \\ \' and \" + */ +VLC_EXPORT( char *, config_StringUnescape, ( char *psz_string ) ); + +/** + * This function will escape a string that can be unescaped by + * config_StringUnescape. + * The returned value is allocated by it. You have to free it once you + * do not need it anymore (unlike config_StringUnescape). + * If NULL is given as parameter nothing will be done (NULL will be returned). + * + * The escaped characters are ' " and \ + */ +VLC_EXPORT( char *, config_StringEscape, ( const char *psz_string ) LIBVLC_USED); + # ifdef __cplusplus } # endif