X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_plugin.h;h=2788e4a2b3645f028f1fe7ed53966fdae6a62466;hb=12ade3e3bc975d5426ba4af155b7372c31093b31;hp=f0d2554562ecbb4b15a76776a44664f5c0cf25c2;hpb=264f09b66b24ea7d11e875d255c11f7e90947410;p=vlc diff --git a/include/vlc_plugin.h b/include/vlc_plugin.h index f0d2554562..2788e4a2b3 100644 --- a/include/vlc_plugin.h +++ b/include/vlc_plugin.h @@ -2,7 +2,7 @@ * vlc_plugin.h : Macros used from within a module. ***************************************************************************** * Copyright (C) 2001-2006 the VideoLAN team - * Copyright © 2007-2008 Rémi Denis-Courmont + * Copyright © 2007-2009 Rémi Denis-Courmont * * Authors: Samuel Hocevar * @@ -24,6 +24,92 @@ #ifndef LIBVLC_MODULES_MACROS_H # define LIBVLC_MODULES_MACROS_H 1 +/** + * \file + * This file implements plugin (module) macros used to define a vlc module. + */ + +VLC_EXPORT( int, vlc_plugin_set, (module_t *, module_config_t *, int, ...) ); + +#define vlc_module_set( mod, ... ) vlc_plugin_set ((mod), NULL, __VA_ARGS__) +#define vlc_config_set( cfg, ... ) vlc_plugin_set (NULL, (cfg), __VA_ARGS__) + +enum vlc_module_properties +{ + VLC_SUBMODULE_CREATE, + VLC_CONFIG_CREATE, + + /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI! + * Append new items at the end ONLY. */ + VLC_MODULE_CPU_REQUIREMENT=0x100, + VLC_MODULE_SHORTCUT, + VLC_MODULE_CAPABILITY, + VLC_MODULE_SCORE, + VLC_MODULE_CB_OPEN, + VLC_MODULE_CB_CLOSE, + VLC_MODULE_NO_UNLOAD, + VLC_MODULE_NAME, + VLC_MODULE_SHORTNAME, + VLC_MODULE_DESCRIPTION, + VLC_MODULE_HELP, + VLC_MODULE_TEXTDOMAIN, + /* Insert new VLC_MODULE_* here */ + + /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI! + * Append new items at the end ONLY. */ + VLC_CONFIG_NAME=0x1000, + /* command line name (args=const char *, vlc_callback_t) */ + + 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_OLDNAME, + /* former option name (args=const char *) */ + + VLC_CONFIG_SAFE, + /* tag as modifiable by untrusted input item "sources" (args=none) */ + + VLC_CONFIG_DESC, + /* description (args=const char *, const char *, const char *) */ + + VLC_CONFIG_LIST, + /* possible values list + * (args=const char *, size_t, const *, const char *const *) */ + + VLC_CONFIG_ADD_ACTION, + /* add value change callback + * (args=const char *, vlc_callback_t, const char *) */ + + /* Insert new VLC_CONFIG_* here */ +}; + /***************************************************************************** * If we are not within a module, assume we're in the vlc core. *****************************************************************************/ @@ -34,8 +120,8 @@ /** * Current plugin ABI version */ -# define MODULE_SYMBOL 0_9_0m -# define MODULE_SUFFIX "__0_9_0m" +# define MODULE_SYMBOL 1_2_0d +# define MODULE_SUFFIX "__1_2_0d" /***************************************************************************** * Add a few defines. You do not want to read this section. Really. @@ -56,10 +142,8 @@ /* If the module is built-in, then we need to define foo_InitModule instead * of InitModule. Same for Activate- and DeactivateModule. */ #ifdef __PLUGIN__ -# define E_( function ) CONCATENATE( function, MODULE_SYMBOL ) # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL ) #else -# define E_( function ) CONCATENATE( function, MODULE_NAME ) # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME ) #endif @@ -85,13 +169,12 @@ */ #define vlc_module_begin( ) \ EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \ - E_(vlc_entry) ( module_t *p_module ); \ + __VLC_SYMBOL(vlc_entry) ( module_t *p_module ); \ \ EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \ __VLC_SYMBOL(vlc_entry) ( module_t *p_module ) \ { \ module_config_t *p_config = NULL; \ - const char *domain = NULL; \ if (vlc_module_set (p_module, VLC_MODULE_NAME, \ (const char *)(MODULE_STRING))) \ goto error; \ @@ -109,30 +192,29 @@ VLC_METADATA_EXPORTS #define add_submodule( ) \ - p_submodule = vlc_submodule_create( p_module ); - -#define add_requirement( cap ) \ - if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \ - (int)(CPU_CAPABILITY_##cap))) \ + if (vlc_plugin_set (p_module, NULL, VLC_SUBMODULE_CREATE, &p_submodule)) \ goto error; -#define add_shortcut( shortcut ) \ +#define add_shortcut( ... ) \ +{ \ + const char *shortcuts[] = { __VA_ARGS__ }; \ if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \ - (const char *)(shortcut))) \ - goto error; + sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \ + goto error; \ +} #define set_shortname( shortname ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \ + if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \ (const char *)(shortname))) \ goto error; #define set_description( desc ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \ + if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \ (const char *)(desc))) \ goto error; #define set_help( help ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \ + if (vlc_module_set (p_submodule, VLC_MODULE_HELP, \ (const char *)(help))) \ goto error; @@ -147,104 +229,13 @@ || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \ goto error; -#define linked_with_a_crap_library_which_uses_atexit( ) \ +#define cannot_unload_broken_library( ) \ if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \ goto error; -#define set_text_domain( dom ) domain = (dom); - -VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) ); -VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) ); -VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) ); -VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) ); -VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) ); - -enum vlc_module_properties -{ - /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI! - * Append new items at the end ONLY. */ - VLC_MODULE_CPU_REQUIREMENT, - VLC_MODULE_SHORTCUT, - VLC_MODULE_SHORTNAME_NODOMAIN, - VLC_MODULE_DESCRIPTION_NODOMAIN, - VLC_MODULE_HELP_NODOMAIN, - VLC_MODULE_CAPABILITY, - VLC_MODULE_SCORE, - VLC_MODULE_PROGRAM, /* obsoleted */ - VLC_MODULE_CB_OPEN, - VLC_MODULE_CB_CLOSE, - VLC_MODULE_NO_UNLOAD, - VLC_MODULE_NAME, - VLC_MODULE_SHORTNAME, - VLC_MODULE_DESCRIPTION, - VLC_MODULE_HELP, -}; - -enum vlc_config_properties -{ - /* 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_NODOMAIN, - /* 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_NODOMAIN, - /* possible values list - * (args=size_t, const *, const char *const *) */ - - VLC_CONFIG_ADD_ACTION_NODOMAIN, - /* add value change callback (args=vlc_callback_t, const char *) */ - - VLC_CONFIG_OLDNAME, - /* former option name (args=const char *) */ - - VLC_CONFIG_SAFE, - /* tag as modifiable by untrusted input item "sources" (args=none) */ - - VLC_CONFIG_DESC, - /* description (args=const char *, const char *, const char *) */ - - VLC_CONFIG_LIST, - /* possible values list - * (args=const char *, size_t, const *, const char *const *) */ - - VLC_CONFIG_ADD_ACTION, - /* add value change callback - * (args=const char *, vlc_callback_t, const char *) */ -}; +#define set_text_domain( dom ) \ + if (vlc_module_set (p_module, VLC_MODULE_TEXTDOMAIN, (dom))) \ + goto error; /***************************************************************************** * Macros used to build the configuration structure. @@ -260,11 +251,11 @@ enum vlc_config_properties *****************************************************************************/ #define add_type_inner( type ) \ - p_config = vlc_config_create (p_module, type); + vlc_plugin_set (p_module, NULL, VLC_CONFIG_CREATE, (type), &p_config); #define add_typedesc_inner( type, text, longtext ) \ add_type_inner( type ) \ - vlc_config_set (p_config, VLC_CONFIG_DESC, domain, \ + vlc_config_set (p_config, VLC_CONFIG_DESC, \ (const char *)(text), (const char *)(longtext)); #define add_typeadv_inner( type, text, longtext, advc ) \ @@ -282,16 +273,16 @@ enum vlc_config_properties #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, VLC_CONFIG_VALUE, (int)(v)); + vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(v)); #define set_category( i_id ) \ add_type_inner( CONFIG_CATEGORY ) \ - vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id)); + vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id)); #define set_subcategory( i_id ) \ add_type_inner( CONFIG_SUBCATEGORY ) \ - vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id)); + vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id)); #define set_section( text, longtext ) \ add_typedesc_inner( CONFIG_SECTION, text, longtext ) @@ -324,6 +315,10 @@ enum vlc_config_properties add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \ p_callback, value ) +#define add_font( name, value, p_callback, text, longtext, advc )\ + add_string_inner( CONFIG_ITEM_FONT, 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 ) \ @@ -338,12 +333,12 @@ enum vlc_config_properties #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->min.i = i_subcategory /* gruik */; + change_integer_range (i_subcategory /* gruik */, 0); #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->min.i = i_subcategory /* gruik */; + change_integer_range (i_subcategory /* gruik */, 0); #endif #define add_integer( name, value, p_callback, text, longtext, advc ) \ @@ -351,8 +346,10 @@ enum vlc_config_properties 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 ) + add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, \ + p_callback, value ) \ + add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \ + p_callback, KEY_UNSET ) #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 ) \ @@ -369,7 +366,7 @@ enum vlc_config_properties #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, VLC_CONFIG_VALUE, (int)true); + if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)true); /* For removed option */ #define add_obsolete_inner( name, type ) \ @@ -393,56 +390,51 @@ enum vlc_config_properties /* Modifier macros for the config options (used for fine tuning) */ #define add_deprecated_alias( name ) \ - vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name)) + vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name)); #define change_short( ch ) \ vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch)); #define change_string_list( list, list_text, list_update_func ) \ - vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \ + vlc_config_set (p_config, VLC_CONFIG_LIST, \ (size_t)(sizeof (list) / sizeof (char *)), \ (const char *const *)(list), \ (const char *const *)(list_text), \ - list_update_func); + (vlc_callback_t)(list_update_func)); #define change_integer_list( list, list_text, list_update_func ) \ - vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \ + vlc_config_set (p_config, VLC_CONFIG_LIST, \ (size_t)(sizeof (list) / sizeof (int)), \ (const int *)(list), \ (const char *const *)(list_text), \ - list_update_func); - -#define change_float_list( list, list_text, list_update_func ) \ - vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \ - (size_t)(sizeof (list) / sizeof (float)), \ - (const float *)(list), \ - (const char *const *)(list_text), \ - list_update_func); + (vlc_callback_t)(list_update_func)); #define change_integer_range( minv, maxv ) \ - vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv)); + vlc_config_set (p_config, VLC_CONFIG_RANGE, \ + (int64_t)(minv), (int64_t)(maxv)); #define change_float_range( minv, maxv ) \ vlc_config_set (p_config, VLC_CONFIG_RANGE, \ (double)(minv), (double)(maxv)); #define change_action_add( pf_action, text ) \ - vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, domain, \ + vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \ (vlc_callback_t)(pf_action), (const char *)(text)); -#define change_internal() \ - vlc_config_set (p_config, VLC_CONFIG_PRIVATE); - #define change_need_restart() \ vlc_config_set (p_config, VLC_CONFIG_RESTART); #define change_autosave() \ vlc_config_set (p_config, VLC_CONFIG_PERSISTENT); -#define change_unsaveable() \ - vlc_config_set (p_config, VLC_CONFIG_VOLATILE); +/* For options that are saved but hidden from the preferences panel */ +#define change_private() \ + vlc_config_set (p_config, VLC_CONFIG_PRIVATE); -#define change_unsafe() (void)0; /* no-op */ +/* For options that cannot be saved in the configuration */ +#define change_volatile() \ + change_private() \ + vlc_config_set (p_config, VLC_CONFIG_VOLATILE); #define change_safe() \ vlc_config_set (p_config, VLC_CONFIG_SAFE); @@ -450,7 +442,7 @@ enum vlc_config_properties /* Meta data plugin exports */ #define VLC_META_EXPORT( name, value ) \ EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \ - E_(vlc_entry_ ## name) (void); \ + __VLC_SYMBOL(vlc_entry_ ## name) (void); \ EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \ __VLC_SYMBOL(vlc_entry_ ## name) (void) \ { \ @@ -462,7 +454,7 @@ enum vlc_config_properties "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \ "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \ "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \ - "\x6c\x6f\x70\x70\x65\x72\x73" ) + "\x6c\x6f\x70\x65\x72\x73" ) #elif !defined (VLC_COPYRIGHT_EXPORT) # define VLC_COPYRIGHT_EXPORT #endif