home *** CD-ROM | disk | FTP | other *** search
/ mail.altrad.com / 2015.02.mail.altrad.com.tar / mail.altrad.com / TEST / vlc-2-0-5-win32.exe / sdk / include / vlc / plugins / vlc_plugin.h < prev    next >
C/C++ Source or Header  |  2012-12-12  |  16KB  |  456 lines
  1. /*****************************************************************************
  2.  * vlc_plugin.h : Macros used from within a module.
  3.  *****************************************************************************
  4.  * Copyright (C) 2001-2006 VLC authors and VideoLAN
  5.  * Copyright ┬⌐ 2007-2009 R├⌐mi Denis-Courmont
  6.  *
  7.  * Authors: Samuel Hocevar <sam@zoy.org>
  8.  *
  9.  * This program is free software; you can redistribute it and/or modify it
  10.  * under the terms of the GNU Lesser General Public License as published by
  11.  * the Free Software Foundation; either version 2.1 of the License, or
  12.  * (at your option) any later version.
  13.  *
  14.  * This program is distributed in the hope that it will be useful,
  15.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17.  * GNU Lesser General Public License for more details.
  18.  *
  19.  * You should have received a copy of the GNU Lesser General Public License
  20.  * along with this program; if not, write to the Free Software Foundation,
  21.  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22.  *****************************************************************************/
  23.  
  24. #ifndef LIBVLC_MODULES_MACROS_H
  25. # define LIBVLC_MODULES_MACROS_H 1
  26.  
  27. /**
  28.  * \file
  29.  * This file implements plugin (module) macros used to define a vlc module.
  30.  */
  31.  
  32. enum vlc_module_properties
  33. {
  34.     VLC_MODULE_CREATE,
  35.     VLC_CONFIG_CREATE,
  36.  
  37.     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
  38.      * Append new items at the end ONLY. */
  39.     VLC_MODULE_CPU_REQUIREMENT=0x100,
  40.     VLC_MODULE_SHORTCUT,
  41.     VLC_MODULE_CAPABILITY,
  42.     VLC_MODULE_SCORE,
  43.     VLC_MODULE_CB_OPEN,
  44.     VLC_MODULE_CB_CLOSE,
  45.     VLC_MODULE_NO_UNLOAD,
  46.     VLC_MODULE_NAME,
  47.     VLC_MODULE_SHORTNAME,
  48.     VLC_MODULE_DESCRIPTION,
  49.     VLC_MODULE_HELP,
  50.     VLC_MODULE_TEXTDOMAIN,
  51.     /* Insert new VLC_MODULE_* here */
  52.  
  53.     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
  54.      * Append new items at the end ONLY. */
  55.     VLC_CONFIG_NAME=0x1000,
  56.     /* command line name (args=const char *) */
  57.  
  58.     VLC_CONFIG_VALUE,
  59.     /* actual value (args=int/double/const char *) */
  60.  
  61.     VLC_CONFIG_RANGE,
  62.     /* minimum value (args=int/double/const char * twice) */
  63.  
  64.     VLC_CONFIG_ADVANCED,
  65.     /* enable advanced flag (args=none) */
  66.  
  67.     VLC_CONFIG_VOLATILE,
  68.     /* don't write variable to storage (args=none) */
  69.  
  70.     VLC_CONFIG_PERSISTENT_OBSOLETE,
  71.     /* unused (ignored) */
  72.  
  73.     VLC_CONFIG_PRIVATE,
  74.     /* hide from user (args=none) */
  75.  
  76.     VLC_CONFIG_REMOVED,
  77.     /* tag as no longer supported (args=none) */
  78.  
  79.     VLC_CONFIG_CAPABILITY,
  80.     /* capability for a module or list thereof (args=const char*) */
  81.  
  82.     VLC_CONFIG_SHORTCUT,
  83.     /* one-character (short) command line option name (args=char) */
  84.  
  85.     VLC_CONFIG_OLDNAME_OBSOLETE,
  86.     /* unused (ignored) */
  87.  
  88.     VLC_CONFIG_SAFE,
  89.     /* tag as modifiable by untrusted input item "sources" (args=none) */
  90.  
  91.     VLC_CONFIG_DESC,
  92.     /* description (args=const char *, const char *, const char *) */
  93.  
  94.     VLC_CONFIG_LIST,
  95.     /* possible values list
  96.      * (args=const char *, size_t, const <type> *, const char *const *) */
  97.  
  98.     VLC_CONFIG_ADD_ACTION,
  99.     /* add value change callback
  100.      * (args=const char *, vlc_callback_t, const char *) */
  101.  
  102.     /* Insert new VLC_CONFIG_* here */
  103. };
  104.  
  105. /**
  106.  * Current plugin ABI version
  107.  */
  108. # define MODULE_SYMBOL 1_2_0l
  109. # define MODULE_SUFFIX "__1_2_0l"
  110.  
  111. /*****************************************************************************
  112.  * Add a few defines. You do not want to read this section. Really.
  113.  *****************************************************************************/
  114.  
  115. /* Explanation:
  116.  *
  117.  * if linking a module statically, we will need:
  118.  * #define MODULE_FUNC( zog ) module_foo_zog
  119.  *
  120.  * this can't easily be done with the C preprocessor, thus a few ugly hacks.
  121.  */
  122.  
  123. /* I need to do _this_ to change ┬½ foo bar ┬╗ to ┬½ module_foo_bar ┬╗ ! */
  124. #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
  125. #define CRUDE_HACK( y, z )  y##__##z
  126.  
  127. /* If the module is built-in, then we need to define foo_InitModule instead
  128.  * of InitModule. Same for Activate- and DeactivateModule. */
  129. #ifdef __PLUGIN__
  130. #   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
  131. #else
  132. #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
  133. #endif
  134.  
  135. #define CDECL_SYMBOL
  136. #if defined (__PLUGIN__)
  137. # if defined (WIN32)
  138. #   define DLL_SYMBOL              __declspec(dllexport)
  139. #   undef CDECL_SYMBOL
  140. #   define CDECL_SYMBOL            __cdecl
  141. # elif VLC_GCC_VERSION(4,0)
  142. #   define DLL_SYMBOL              __attribute__((visibility("default")))
  143. # else
  144. #  define DLL_SYMBOL
  145. # endif
  146. #else
  147. # define DLL_SYMBOL
  148. #endif
  149.  
  150. #if defined( __cplusplus )
  151. #   define EXTERN_SYMBOL           extern "C"
  152. #else
  153. #   define EXTERN_SYMBOL
  154. #endif
  155.  
  156. typedef int (*vlc_set_cb) (void *, void *, int, ...);
  157.  
  158. #define vlc_plugin_set(...) vlc_set (opaque,   NULL, __VA_ARGS__)
  159. #define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__)
  160. #define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__)
  161.  
  162. /*
  163.  * InitModule: this function is called once and only once, when the module
  164.  * is looked at for the first time. We get the useful data from it, for
  165.  * instance the module name, its shortcuts, its capabilities... we also create
  166.  * a copy of its config because the module can be unloaded at any time.
  167.  */
  168. #define vlc_module_begin() \
  169. EXTERN_SYMBOL DLL_SYMBOL \
  170. int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb, void *); \
  171. EXTERN_SYMBOL DLL_SYMBOL \
  172. int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb vlc_set, void *opaque) \
  173. { \
  174.     module_t *module; \
  175.     module_config_t *config = NULL; \
  176.     if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
  177.         goto error; \
  178.     if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \
  179.         goto error;
  180.  
  181. #define vlc_module_end() \
  182.     (void) config; \
  183.     return 0; \
  184. error: \
  185.     return -1; \
  186. } \
  187. VLC_METADATA_EXPORTS
  188.  
  189. #define add_submodule( ) \
  190.     if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
  191.         goto error;
  192.  
  193. #define add_shortcut( ... ) \
  194. { \
  195.     const char *shortcuts[] = { __VA_ARGS__ }; \
  196.     if (vlc_module_set (VLC_MODULE_SHORTCUT, \
  197.                         sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
  198.         goto error; \
  199. }
  200.  
  201. #define set_shortname( shortname ) \
  202.     if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \
  203.         goto error;
  204.  
  205. #define set_description( desc ) \
  206.     if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \
  207.         goto error;
  208.  
  209. #define set_help( help ) \
  210.     if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \
  211.         goto error;
  212.  
  213. #define set_capability( cap, score ) \
  214.     if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \
  215.      || vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \
  216.         goto error;
  217.  
  218. #define set_callbacks( activate, deactivate ) \
  219.     if (vlc_module_set (VLC_MODULE_CB_OPEN, activate) \
  220.      || vlc_module_set (VLC_MODULE_CB_CLOSE, deactivate)) \
  221.         goto error;
  222.  
  223. #define cannot_unload_broken_library( ) \
  224.     if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
  225.         goto error;
  226.  
  227. #define set_text_domain( dom ) \
  228.     if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \
  229.         goto error;
  230.  
  231. /*****************************************************************************
  232.  * Macros used to build the configuration structure.
  233.  *
  234.  * Note that internally we support only 3 types of config data: int, float
  235.  *   and string.
  236.  *   The other types declared here just map to one of these 3 basic types but
  237.  *   have the advantage of also providing very good hints to a configuration
  238.  *   interface so as to make it more user friendly.
  239.  * The configuration structure also includes category hints. These hints can
  240.  *   provide a configuration interface with some very useful data and again
  241.  *   allow for a more user friendly interface.
  242.  *****************************************************************************/
  243.  
  244. #define add_type_inner( type ) \
  245.     vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config);
  246.  
  247. #define add_typedesc_inner( type, text, longtext ) \
  248.     add_type_inner( type ) \
  249.     vlc_config_set (VLC_CONFIG_DESC, \
  250.                     (const char *)(text), (const char *)(longtext));
  251.  
  252. #define add_typeadv_inner( type, text, longtext, advc ) \
  253.     add_typedesc_inner( type, text, longtext ) \
  254.     if (advc) vlc_config_set (VLC_CONFIG_ADVANCED);
  255.  
  256. #define add_typename_inner( type, name, text, longtext, advc ) \
  257.     add_typeadv_inner( type, text, longtext, advc ) \
  258.     vlc_config_set (VLC_CONFIG_NAME, (const char *)(name));
  259.  
  260. #define add_string_inner( type, name, text, longtext, advc, v ) \
  261.     add_typename_inner( type, name, text, longtext, advc ) \
  262.     vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v));
  263.  
  264. #define add_int_inner( type, name, text, longtext, advc, v ) \
  265.     add_typename_inner( type, name, text, longtext, advc ) \
  266.     vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v));
  267.  
  268.  
  269. #define set_category( i_id ) \
  270.     add_type_inner( CONFIG_CATEGORY ) \
  271.     vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
  272.  
  273. #define set_subcategory( i_id ) \
  274.     add_type_inner( CONFIG_SUBCATEGORY ) \
  275.     vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
  276.  
  277. #define set_section( text, longtext ) \
  278.     add_typedesc_inner( CONFIG_SECTION, text, longtext )
  279.  
  280. #define add_category_hint( text, longtext, advc ) \
  281.     add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
  282.  
  283. #define add_subcategory_hint( text, longtext ) \
  284.     add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
  285.  
  286. #define end_subcategory_hint \
  287.     add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
  288.  
  289. #define add_usage_hint( text ) \
  290.     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
  291.  
  292. #define add_string( name, value, text, longtext, advc ) \
  293.     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
  294.                       value )
  295.  
  296. #define add_password( name, value, text, longtext, advc ) \
  297.     add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
  298.                       value )
  299.  
  300. #define add_loadfile( name, value, text, longtext, advc ) \
  301.     add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
  302.                       value )
  303.  
  304. #define add_savefile( name, value, text, longtext, advc ) \
  305.     add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
  306.                       value )
  307.  
  308. #define add_directory( name, value, text, longtext, advc ) \
  309.     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
  310.                       value )
  311.  
  312. #define add_font( name, value, text, longtext, advc )\
  313.     add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
  314.                       value )
  315.  
  316. #define add_module( name, psz_caps, value, text, longtext, advc ) \
  317.     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
  318.                       value ) \
  319.     vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
  320.  
  321. #define add_module_list( name, psz_caps, value, text, longtext, advc ) \
  322.     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
  323.                       value ) \
  324.     vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
  325.  
  326. #ifndef __PLUGIN__
  327. #define add_module_cat( name, i_subcategory, value, text, longtext, advc ) \
  328.     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
  329.                       value ) \
  330.     change_integer_range (i_subcategory /* gruik */, 0);
  331.  
  332. #define add_module_list_cat( name, i_subcategory, value, text, longtext, advc ) \
  333.     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
  334.                       advc, value ) \
  335.     change_integer_range (i_subcategory /* gruik */, 0);
  336. #endif
  337.  
  338. #define add_integer( name, value, text, longtext, advc ) \
  339.     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
  340.  
  341. #define add_rgb( name, value, text, longtext, advc ) \
  342.     add_int_inner( CONFIG_ITEM_RGB, name, text, longtext, advc, value ) \
  343.     change_integer_range( 0, 0xFFFFFF )
  344.  
  345. #define add_key( name, value, text, longtext, advc ) \
  346.     add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
  347.                    KEY_UNSET ) \
  348.     add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value )
  349.  
  350. #define add_integer_with_range( name, value, i_min, i_max, text, longtext, advc ) \
  351.     add_integer( name, value, text, longtext, advc ) \
  352.     change_integer_range( i_min, i_max )
  353.  
  354. #define add_float( name, v, text, longtext, advc ) \
  355.     add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
  356.     vlc_config_set (VLC_CONFIG_VALUE, (double)(v));
  357.  
  358. #define add_float_with_range( name, value, f_min, f_max, text, longtext, advc ) \
  359.     add_float( name, value, text, longtext, advc ) \
  360.     change_float_range( f_min, f_max )
  361.  
  362. #define add_bool( name, v, text, longtext, advc ) \
  363.     add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
  364.     if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true);
  365.  
  366. /* For removed option */
  367. #define add_obsolete_inner( name, type ) \
  368.     add_type_inner( type ) \
  369.     vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); \
  370.     vlc_config_set (VLC_CONFIG_REMOVED);
  371.  
  372. #define add_obsolete_bool( name ) \
  373.         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
  374.  
  375. #define add_obsolete_integer( name ) \
  376.         add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
  377.  
  378. #define add_obsolete_float( name ) \
  379.         add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
  380.  
  381. #define add_obsolete_string( name ) \
  382.         add_obsolete_inner( name, CONFIG_ITEM_STRING )
  383.  
  384. /* Modifier macros for the config options (used for fine tuning) */
  385.  
  386. #define change_short( ch ) \
  387.     vlc_config_set (VLC_CONFIG_SHORTCUT, (int)(ch));
  388.  
  389. #define change_string_list( list, list_text, list_update_func ) \
  390.     vlc_config_set (VLC_CONFIG_LIST, \
  391.                     (size_t)(sizeof (list) / sizeof (char *)), \
  392.                     (const char *const *)(list), \
  393.                     (const char *const *)(list_text), \
  394.                     (vlc_callback_t)(list_update_func));
  395.  
  396. #define change_integer_list( list, list_text ) \
  397.     vlc_config_set (VLC_CONFIG_LIST, \
  398.                     (size_t)(sizeof (list) / sizeof (int)), \
  399.                     (const int *)(list), \
  400.                     (const char *const *)(list_text), \
  401.                     (vlc_callback_t)(NULL));
  402.  
  403. #define change_integer_range( minv, maxv ) \
  404.     vlc_config_set (VLC_CONFIG_RANGE, (int64_t)(minv), (int64_t)(maxv));
  405.  
  406. #define change_float_range( minv, maxv ) \
  407.     vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv));
  408.  
  409. #define change_action_add( pf_action, text ) \
  410.     vlc_config_set (VLC_CONFIG_ADD_ACTION, \
  411.                     (vlc_callback_t)(pf_action), (const char *)(text));
  412.  
  413. /* For options that are saved but hidden from the preferences panel */
  414. #define change_private() \
  415.     vlc_config_set (VLC_CONFIG_PRIVATE);
  416.  
  417. /* For options that cannot be saved in the configuration */
  418. #define change_volatile() \
  419.     change_private() \
  420.     vlc_config_set (VLC_CONFIG_VOLATILE);
  421.  
  422. #define change_safe() \
  423.     vlc_config_set (VLC_CONFIG_SAFE);
  424.  
  425. /* Meta data plugin exports */
  426. #define VLC_META_EXPORT( name, value ) \
  427.     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
  428.     __VLC_SYMBOL(vlc_entry_ ## name) (void); \
  429.     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
  430.     __VLC_SYMBOL(vlc_entry_ ## name) (void) \
  431.     { \
  432.          return value; \
  433.     }
  434.  
  435. #if defined (__LIBVLC__)
  436. # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
  437.     "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
  438.     "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
  439.     "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
  440.     "\x6c\x6f\x70\x65\x72\x73" )
  441. #elif !defined (VLC_COPYRIGHT_EXPORT)
  442. # define VLC_COPYRIGHT_EXPORT
  443. #endif
  444. #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
  445.     "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
  446.     "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
  447.     "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
  448.     "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
  449.     "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
  450.  
  451. #define VLC_METADATA_EXPORTS \
  452.     VLC_COPYRIGHT_EXPORT \
  453.     VLC_LICENSE_EXPORT
  454.  
  455. #endif
  456.