X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_plugin.h;h=b9e1ea44a7b3c9a0e28e9e4a1b7ffe8ebd58cca6;hb=85b6c1463736907e6fed0900f0e93df05e89d2fa;hp=15bdef4d3ac4d7bbf15b99d797d856856c6d198e;hpb=cb91467d925414dd82b9965e6245aa4d442e2410;p=vlc diff --git a/include/vlc_plugin.h b/include/vlc_plugin.h index 15bdef4d3a..b9e1ea44a7 100644 --- a/include/vlc_plugin.h +++ b/include/vlc_plugin.h @@ -1,24 +1,24 @@ /***************************************************************************** * vlc_plugin.h : Macros used from within a module. ***************************************************************************** - * Copyright (C) 2001-2006 the VideoLAN team + * Copyright (C) 2001-2006 VLC authors and VideoLAN * Copyright © 2007-2009 Rémi Denis-Courmont * * Authors: Samuel Hocevar * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. * - * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifndef LIBVLC_MODULES_MACROS_H @@ -29,14 +29,9 @@ * 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_MODULE_CREATE, VLC_CONFIG_CREATE, /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI! @@ -72,11 +67,8 @@ enum vlc_module_properties 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_PERSISTENT_OBSOLETE, + /* unused (ignored) */ VLC_CONFIG_PRIVATE, /* hide from user (args=none) */ @@ -90,8 +82,8 @@ enum vlc_module_properties VLC_CONFIG_SHORTCUT, /* one-character (short) command line option name (args=char) */ - VLC_CONFIG_OLDNAME, - /* former option name (args=const char *) */ + VLC_CONFIG_OLDNAME_OBSOLETE, + /* unused (ignored) */ VLC_CONFIG_SAFE, /* tag as modifiable by untrusted input item "sources" (args=none) */ @@ -110,11 +102,95 @@ enum vlc_module_properties /* Insert new VLC_CONFIG_* here */ }; +/* Configuration hint types */ +#define CONFIG_HINT_CATEGORY 0x02 /* Start of new category */ +#define CONFIG_HINT_SUBCATEGORY 0x03 /* Start of sub-category */ +#define CONFIG_HINT_SUBCATEGORY_END 0x04 /* End of sub-category */ +#define CONFIG_HINT_USAGE 0x05 /* Usage information */ + +#define CONFIG_CATEGORY 0x06 /* Set category */ +#define CONFIG_SUBCATEGORY 0x07 /* Set subcategory */ +#define CONFIG_SECTION 0x08 /* Start of new section */ + +/* Configuration item types */ +#define CONFIG_ITEM_FLOAT 0x20 /* Float option */ +#define CONFIG_ITEM_INTEGER 0x40 /* Integer option */ +#define CONFIG_ITEM_RGB 0x41 /* RGB color option */ +#define CONFIG_ITEM_BOOL 0x60 /* Bool option */ +#define CONFIG_ITEM_STRING 0x80 /* String option */ +#define CONFIG_ITEM_PASSWORD 0x81 /* Password option (*) */ +#define CONFIG_ITEM_KEY 0x82 /* Hot key option */ +#define CONFIG_ITEM_MODULE 0x84 /* Module option */ +#define CONFIG_ITEM_MODULE_CAT 0x85 /* Module option */ +#define CONFIG_ITEM_MODULE_LIST 0x86 /* Module option */ +#define CONFIG_ITEM_MODULE_LIST_CAT 0x87 /* Module option */ +#define CONFIG_ITEM_LOADFILE 0x8C /* Read file option */ +#define CONFIG_ITEM_SAVEFILE 0x8D /* Written file option */ +#define CONFIG_ITEM_DIRECTORY 0x8E /* Directory option */ +#define CONFIG_ITEM_FONT 0x8F /* Font option */ + +#define CONFIG_ITEM(x) (((x) & ~0xF) != 0) + +/* Categories and subcategories */ +#define CAT_INTERFACE 1 +#define SUBCAT_INTERFACE_GENERAL 101 +#define SUBCAT_INTERFACE_MAIN 102 +#define SUBCAT_INTERFACE_CONTROL 103 +#define SUBCAT_INTERFACE_HOTKEYS 104 + +#define CAT_AUDIO 2 +#define SUBCAT_AUDIO_GENERAL 201 +#define SUBCAT_AUDIO_AOUT 202 +#define SUBCAT_AUDIO_AFILTER 203 +#define SUBCAT_AUDIO_VISUAL 204 +#define SUBCAT_AUDIO_MISC 205 + +#define CAT_VIDEO 3 +#define SUBCAT_VIDEO_GENERAL 301 +#define SUBCAT_VIDEO_VOUT 302 +#define SUBCAT_VIDEO_VFILTER 303 +#define SUBCAT_VIDEO_TEXT 304 +#define SUBCAT_VIDEO_SUBPIC 305 +#define SUBCAT_VIDEO_VFILTER2 306 + +#define CAT_INPUT 4 +#define SUBCAT_INPUT_GENERAL 401 +#define SUBCAT_INPUT_ACCESS 402 +#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 +#define SUBCAT_SOUT_STREAM 502 +#define SUBCAT_SOUT_MUX 503 +#define SUBCAT_SOUT_ACO 504 +#define SUBCAT_SOUT_PACKETIZER 505 +#define SUBCAT_SOUT_SAP 506 +#define SUBCAT_SOUT_VOD 507 + +#define CAT_ADVANCED 6 +#define SUBCAT_ADVANCED_CPU 601 +#define SUBCAT_ADVANCED_MISC 602 +#define SUBCAT_ADVANCED_NETWORK 603 +#define SUBCAT_ADVANCED_XML 604 + +#define CAT_PLAYLIST 7 +#define SUBCAT_PLAYLIST_GENERAL 701 +#define SUBCAT_PLAYLIST_SD 702 +#define SUBCAT_PLAYLIST_EXPORT 703 + +#define CAT_OSD 8 +#define SUBCAT_OSD_IMPORT 801 + + /** * Current plugin ABI version */ -# define MODULE_SYMBOL 1_2_0g -# define MODULE_SUFFIX "__1_2_0g" +# define MODULE_SYMBOL 2_1_0a +# define MODULE_SUFFIX "__2_1_0a" /***************************************************************************** * Add a few defines. You do not want to read this section. Really. @@ -140,12 +216,19 @@ enum vlc_module_properties # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME ) #endif -#if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) ) +#define CDECL_SYMBOL +#if defined (__PLUGIN__) +# if defined (WIN32) # define DLL_SYMBOL __declspec(dllexport) +# undef CDECL_SYMBOL # define CDECL_SYMBOL __cdecl +# elif VLC_GCC_VERSION(4,0) +# define DLL_SYMBOL __attribute__((visibility("default"))) +# else +# define DLL_SYMBOL +# endif #else -# define DLL_SYMBOL -# define CDECL_SYMBOL +# define DLL_SYMBOL #endif #if defined( __cplusplus ) @@ -154,80 +237,79 @@ enum vlc_module_properties # define EXTERN_SYMBOL #endif +typedef int (*vlc_set_cb) (void *, void *, int, ...); + +#define vlc_plugin_set(...) vlc_set (opaque, NULL, __VA_ARGS__) +#define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__) +#define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__) + /* * InitModule: this function is called once and only once, when the module * is looked at for the first time. We get the useful data from it, for * instance the module name, its shortcuts, its capabilities... we also create * a copy of its config because the module can be unloaded at any time. */ -#define vlc_module_begin( ) \ - EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \ - __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; \ - if (vlc_module_set (p_module, VLC_MODULE_NAME, \ - (const char *)(MODULE_STRING))) \ - goto error; \ - { \ - module_t *p_submodule = p_module; - -#define vlc_module_end( ) \ - } \ - (void)p_config; \ - return VLC_SUCCESS; \ - \ - error: \ - return VLC_EGENERIC; \ - } \ - VLC_METADATA_EXPORTS +#define vlc_module_begin() \ +EXTERN_SYMBOL DLL_SYMBOL \ +int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb, void *); \ +EXTERN_SYMBOL DLL_SYMBOL \ +int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb vlc_set, void *opaque) \ +{ \ + module_t *module; \ + module_config_t *config = NULL; \ + if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \ + goto error; \ + if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \ + goto error; + +#define vlc_module_end() \ + (void) config; \ + return 0; \ +error: \ + return -1; \ +} \ +VLC_METADATA_EXPORTS #define add_submodule( ) \ - if (vlc_plugin_set (p_module, NULL, VLC_SUBMODULE_CREATE, &p_submodule)) \ + if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \ goto error; #define add_shortcut( ... ) \ { \ const char *shortcuts[] = { __VA_ARGS__ }; \ - if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \ + if (vlc_module_set (VLC_MODULE_SHORTCUT, \ sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \ goto error; \ } #define set_shortname( shortname ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \ - (const char *)(shortname))) \ + if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \ goto error; #define set_description( desc ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \ - (const char *)(desc))) \ + if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \ goto error; #define set_help( help ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_HELP, \ - (const char *)(help))) \ + if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \ goto error; #define set_capability( cap, score ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \ - (const char *)(cap)) \ - || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \ + if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \ + || vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \ goto error; #define set_callbacks( activate, deactivate ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \ - || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \ + if (vlc_module_set (VLC_MODULE_CB_OPEN, activate) \ + || vlc_module_set (VLC_MODULE_CB_CLOSE, deactivate)) \ goto error; #define cannot_unload_broken_library( ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \ + if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \ goto error; #define set_text_domain( dom ) \ - if (vlc_module_set (p_module, VLC_MODULE_TEXTDOMAIN, (dom))) \ + if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \ goto error; /***************************************************************************** @@ -244,38 +326,37 @@ enum vlc_module_properties *****************************************************************************/ #define add_type_inner( type ) \ - vlc_plugin_set (p_module, NULL, VLC_CONFIG_CREATE, (type), &p_config); + vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config); #define add_typedesc_inner( type, text, longtext ) \ add_type_inner( type ) \ - vlc_config_set (p_config, VLC_CONFIG_DESC, \ + vlc_config_set (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, VLC_CONFIG_ADVANCED); + if (advc) vlc_config_set (VLC_CONFIG_ADVANCED); #define add_typename_inner( type, name, text, longtext, advc ) \ add_typeadv_inner( type, text, longtext, advc ) \ - vlc_config_set (p_config, VLC_CONFIG_NAME, \ - (const char *)(name)); + vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); #define add_string_inner( type, name, text, longtext, advc, v ) \ add_typename_inner( type, name, text, longtext, advc ) \ - vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v)); + vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v)); #define add_int_inner( type, name, text, longtext, advc, v ) \ add_typename_inner( type, name, text, longtext, advc ) \ - vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(v)); + vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v)); #define set_category( i_id ) \ add_type_inner( CONFIG_CATEGORY ) \ - vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id)); + vlc_config_set (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, (int64_t)(i_id)); + vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id)); #define set_section( text, longtext ) \ add_typedesc_inner( CONFIG_SECTION, text, longtext ) @@ -316,23 +397,23 @@ enum vlc_module_properties add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \ value ) -#define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \ +#define add_module( name, psz_caps, value, text, longtext, advc ) \ add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \ value ) \ - vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps)); + vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps)); -#define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \ +#define add_module_list( name, psz_caps, value, text, longtext, advc ) \ add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \ value ) \ - vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps)); + vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps)); #ifndef __PLUGIN__ -#define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \ +#define add_module_cat( name, i_subcategory, value, text, longtext, advc ) \ add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \ value ) \ change_integer_range (i_subcategory /* gruik */, 0); -#define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \ +#define add_module_list_cat( name, i_subcategory, value, text, longtext, advc ) \ add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \ advc, value ) \ change_integer_range (i_subcategory /* gruik */, 0); @@ -341,33 +422,36 @@ enum vlc_module_properties #define add_integer( name, value, text, longtext, advc ) \ add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value ) +#define add_rgb( name, value, text, longtext, advc ) \ + add_int_inner( CONFIG_ITEM_RGB, name, text, longtext, advc, value ) \ + change_integer_range( 0, 0xFFFFFF ) + #define add_key( name, value, text, longtext, advc ) \ - add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \ + add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \ KEY_UNSET ) \ - add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value ) + add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value ) -#define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \ +#define add_integer_with_range( name, value, i_min, i_max, text, longtext, advc ) \ add_integer( name, value, text, longtext, advc ) \ change_integer_range( i_min, i_max ) #define add_float( name, v, text, longtext, advc ) \ add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \ - vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v)); + vlc_config_set (VLC_CONFIG_VALUE, (double)(v)); -#define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \ +#define add_float_with_range( name, value, f_min, f_max, text, longtext, advc ) \ add_float( name, value, text, longtext, advc ) \ change_float_range( f_min, f_max ) #define add_bool( name, v, text, longtext, advc ) \ add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \ - if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)true); + if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true); /* For removed option */ #define add_obsolete_inner( name, type ) \ add_type_inner( type ) \ - vlc_config_set (p_config, VLC_CONFIG_NAME, \ - (const char *)(name)); \ - vlc_config_set (p_config, VLC_CONFIG_REMOVED); + vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); \ + vlc_config_set (VLC_CONFIG_REMOVED); #define add_obsolete_bool( name ) \ add_obsolete_inner( name, CONFIG_ITEM_BOOL ) @@ -383,55 +467,44 @@ enum vlc_module_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)); - #define change_short( ch ) \ - vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch)); + vlc_config_set (VLC_CONFIG_SHORTCUT, (int)(ch)); #define change_string_list( list, list_text, list_update_func ) \ - vlc_config_set (p_config, VLC_CONFIG_LIST, \ + vlc_config_set (VLC_CONFIG_LIST, \ (size_t)(sizeof (list) / sizeof (char *)), \ (const char *const *)(list), \ (const char *const *)(list_text), \ (vlc_callback_t)(list_update_func)); #define change_integer_list( list, list_text ) \ - vlc_config_set (p_config, VLC_CONFIG_LIST, \ + vlc_config_set (VLC_CONFIG_LIST, \ (size_t)(sizeof (list) / sizeof (int)), \ (const int *)(list), \ (const char *const *)(list_text), \ (vlc_callback_t)(NULL)); #define change_integer_range( minv, maxv ) \ - vlc_config_set (p_config, VLC_CONFIG_RANGE, \ - (int64_t)(minv), (int64_t)(maxv)); + vlc_config_set (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)); + vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv)); #define change_action_add( pf_action, text ) \ - vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \ + vlc_config_set (VLC_CONFIG_ADD_ACTION, \ (vlc_callback_t)(pf_action), (const char *)(text)); -#define change_need_restart() \ - vlc_config_set (p_config, VLC_CONFIG_RESTART); - -#define change_autosave() \ - vlc_config_set (p_config, VLC_CONFIG_PERSISTENT); - /* For options that are saved but hidden from the preferences panel */ #define change_private() \ - vlc_config_set (p_config, VLC_CONFIG_PRIVATE); + vlc_config_set (VLC_CONFIG_PRIVATE); /* For options that cannot be saved in the configuration */ #define change_volatile() \ change_private() \ - vlc_config_set (p_config, VLC_CONFIG_VOLATILE); + vlc_config_set (VLC_CONFIG_VOLATILE); #define change_safe() \ - vlc_config_set (p_config, VLC_CONFIG_SAFE); + vlc_config_set (VLC_CONFIG_SAFE); /* Meta data plugin exports */ #define VLC_META_EXPORT( name, value ) \