git.sesse.net Git - vlc/blob - include/vlc_plugin.h

   1 /*****************************************************************************
   2  * vlc_plugin.h : Macros used from within a module.
   3  *****************************************************************************
   4  * Copyright (C) 2001-2006 the VideoLAN team
   5  * Copyright © 2007-2008 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
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, 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 /*****************************************************************************
  33  * If we are not within a module, assume we're in the vlc core.
  34  *****************************************************************************/
  35 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
  36 #   define MODULE_NAME main
  37 #endif
  38
  39 /**
  40  * Current plugin ABI version
  41  */
  42 # define MODULE_SYMBOL 1_0_0b
  43 # define MODULE_SUFFIX "__1_0_0b"
  44
  45 /*****************************************************************************
  46  * Add a few defines. You do not want to read this section. Really.
  47  *****************************************************************************/
  48
  49 /* Explanation:
  50  *
  51  * if linking a module statically, we will need:
  52  * #define MODULE_FUNC( zog ) module_foo_zog
  53  *
  54  * this can't easily be done with the C preprocessor, thus a few ugly hacks.
  55  */
  56
  57 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
  58 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
  59 #define CRUDE_HACK( y, z )  y##__##z
  60
  61 /* If the module is built-in, then we need to define foo_InitModule instead
  62  * of InitModule. Same for Activate- and DeactivateModule. */
  63 #ifdef __PLUGIN__
  64 #   define E_( function )          CONCATENATE( function, MODULE_SYMBOL )
  65 #   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
  66 #else
  67 #   define E_( function )          CONCATENATE( function, MODULE_NAME )
  68 #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
  69 #endif
  70
  71 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
  72 #   define DLL_SYMBOL              __declspec(dllexport)
  73 #   define CDECL_SYMBOL            __cdecl
  74 #else
  75 #   define DLL_SYMBOL
  76 #   define CDECL_SYMBOL
  77 #endif
  78
  79 #if defined( __cplusplus )
  80 #   define EXTERN_SYMBOL           extern "C"
  81 #else
  82 #   define EXTERN_SYMBOL
  83 #endif
  84
  85 /*
  86  * InitModule: this function is called once and only once, when the module
  87  * is looked at for the first time. We get the useful data from it, for
  88  * instance the module name, its shortcuts, its capabilities... we also create
  89  * a copy of its config because the module can be unloaded at any time.
  90  */
  91 #define vlc_module_begin( )                                                   \
  92     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
  93     E_(vlc_entry) ( module_t *p_module );                                     \
  94                                                                               \
  95     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
  96     __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
  97     {                                                                         \
  98         module_config_t *p_config = NULL;                                     \
  99         const char *domain = NULL;                                            \
 100         if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
 101                             (const char *)(MODULE_STRING)))                   \
 102             goto error;                                                       \
 103         {                                                                     \
 104             module_t *p_submodule = p_module;
 105
 106 #define vlc_module_end( )                                                     \
 107         }                                                                     \
 108         (void)p_config;                                                       \
 109         return VLC_SUCCESS;                                                   \
 110                                                                               \
 111     error:                                                                    \
 112         return VLC_EGENERIC;                                                  \
 113     }                                                                         \
 114     VLC_METADATA_EXPORTS
 115
 116 #define add_submodule( ) \
 117     p_submodule = vlc_submodule_create( p_module );
 118
 119 #define add_requirement( cap ) \
 120     if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
 121                         (int)(CPU_CAPABILITY_##cap))) \
 122         goto error;
 123
 124 #define add_shortcut( shortcut ) \
 125     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
 126         (const char *)(shortcut))) \
 127         goto error;
 128
 129 #define set_shortname( shortname ) \
 130     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \
 131                         (const char *)(shortname))) \
 132         goto error;
 133
 134 #define set_description( desc ) \
 135     if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \
 136                         (const char *)(desc))) \
 137         goto error;
 138
 139 #define set_help( help ) \
 140     if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \
 141                         (const char *)(help))) \
 142         goto error;
 143
 144 #define set_capability( cap, score ) \
 145     if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
 146                         (const char *)(cap)) \
 147      || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
 148         goto error;
 149
 150 #define set_callbacks( activate, deactivate ) \
 151     if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
 152      || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
 153         goto error;
 154
 155 #define linked_with_a_crap_library_which_uses_atexit( ) \
 156     if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
 157         goto error;
 158
 159 #define set_text_domain( dom ) domain = (dom);
 160
 161 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
 162 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
 163 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
 164 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
 165 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
 166
 167 enum vlc_module_properties
 168 {
 169     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
 170      * Append new items at the end ONLY. */
 171     VLC_MODULE_CPU_REQUIREMENT,
 172     VLC_MODULE_SHORTCUT,
 173     VLC_MODULE_SHORTNAME_NODOMAIN,
 174     VLC_MODULE_DESCRIPTION_NODOMAIN,
 175     VLC_MODULE_HELP_NODOMAIN,
 176     VLC_MODULE_CAPABILITY,
 177     VLC_MODULE_SCORE,
 178     VLC_MODULE_PROGRAM, /* obsoleted */
 179     VLC_MODULE_CB_OPEN,
 180     VLC_MODULE_CB_CLOSE,
 181     VLC_MODULE_NO_UNLOAD,
 182     VLC_MODULE_NAME,
 183     VLC_MODULE_SHORTNAME,
 184     VLC_MODULE_DESCRIPTION,
 185     VLC_MODULE_HELP,
 186 };
 187
 188 enum vlc_config_properties
 189 {
 190     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
 191      * Append new items at the end ONLY. */
 192
 193     VLC_CONFIG_NAME,
 194     /* command line name (args=const char *, vlc_callback_t) */
 195
 196     VLC_CONFIG_DESC_NODOMAIN,
 197     /* description (args=const char *, const char *) */
 198
 199     VLC_CONFIG_VALUE,
 200     /* actual value (args=int/double/const char *) */
 201
 202     VLC_CONFIG_RANGE,
 203     /* minimum value (args=int/double/const char * twice) */
 204
 205     VLC_CONFIG_ADVANCED,
 206     /* enable advanced flag (args=none) */
 207
 208     VLC_CONFIG_VOLATILE,
 209     /* don't write variable to storage (args=none) */
 210
 211     VLC_CONFIG_PERSISTENT,
 212     /* always write variable to storage (args=none) */
 213
 214     VLC_CONFIG_RESTART,
 215     /* restart required to apply value change (args=none) */
 216
 217     VLC_CONFIG_PRIVATE,
 218     /* hide from user (args=none) */
 219
 220     VLC_CONFIG_REMOVED,
 221     /* tag as no longer supported (args=none) */
 222
 223     VLC_CONFIG_CAPABILITY,
 224     /* capability for a module or list thereof (args=const char*) */
 225
 226     VLC_CONFIG_SHORTCUT,
 227     /* one-character (short) command line option name (args=char) */
 228
 229     VLC_CONFIG_LIST_NODOMAIN,
 230     /* possible values list
 231      * (args=size_t, const <type> *, const char *const *) */
 232
 233     VLC_CONFIG_ADD_ACTION_NODOMAIN,
 234     /* add value change callback (args=vlc_callback_t, const char *) */
 235
 236     VLC_CONFIG_OLDNAME,
 237     /* former option name (args=const char *) */
 238
 239     VLC_CONFIG_SAFE,
 240     /* tag as modifiable by untrusted input item "sources" (args=none) */
 241
 242     VLC_CONFIG_DESC,
 243     /* description (args=const char *, const char *, const char *) */
 244
 245     VLC_CONFIG_LIST,
 246     /* possible values list
 247      * (args=const char *, size_t, const <type> *, const char *const *) */
 248
 249     VLC_CONFIG_ADD_ACTION,
 250     /* add value change callback
 251      * (args=const char *, vlc_callback_t, const char *) */
 252 };
 253
 254 /*****************************************************************************
 255  * Macros used to build the configuration structure.
 256  *
 257  * Note that internally we support only 3 types of config data: int, float
 258  *   and string.
 259  *   The other types declared here just map to one of these 3 basic types but
 260  *   have the advantage of also providing very good hints to a configuration
 261  *   interface so as to make it more user friendly.
 262  * The configuration structure also includes category hints. These hints can
 263  *   provide a configuration interface with some very useful data and again
 264  *   allow for a more user friendly interface.
 265  *****************************************************************************/
 266
 267 #define add_type_inner( type ) \
 268     p_config = vlc_config_create (p_module, type);
 269
 270 #define add_typedesc_inner( type, text, longtext ) \
 271     add_type_inner( type ) \
 272     vlc_config_set (p_config, VLC_CONFIG_DESC, domain, \
 273                     (const char *)(text), (const char *)(longtext));
 274
 275 #define add_typeadv_inner( type, text, longtext, advc ) \
 276     add_typedesc_inner( type, text, longtext ) \
 277     if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
 278
 279 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
 280     add_typeadv_inner( type, text, longtext, advc ) \
 281     vlc_config_set (p_config, VLC_CONFIG_NAME, \
 282                     (const char *)(name), (vlc_callback_t)(cb));
 283
 284 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
 285     add_typename_inner( type, name, text, longtext, advc, cb ) \
 286     vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
 287
 288 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
 289     add_typename_inner( type, name, text, longtext, advc, cb ) \
 290     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
 291
 292
 293 #define set_category( i_id ) \
 294     add_type_inner( CONFIG_CATEGORY ) \
 295     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
 296
 297 #define set_subcategory( i_id ) \
 298     add_type_inner( CONFIG_SUBCATEGORY ) \
 299     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
 300
 301 #define set_section( text, longtext ) \
 302     add_typedesc_inner( CONFIG_SECTION, text, longtext )
 303
 304 #define add_category_hint( text, longtext, advc ) \
 305     add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
 306
 307 #define add_subcategory_hint( text, longtext ) \
 308     add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
 309
 310 #define end_subcategory_hint \
 311     add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
 312
 313 #define add_usage_hint( text ) \
 314     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
 315
 316 #define add_string( name, value, p_callback, text, longtext, advc ) \
 317     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
 318                       p_callback, value )
 319
 320 #define add_password( name, value, p_callback, text, longtext, advc ) \
 321     add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
 322                       p_callback, value )
 323
 324 #define add_file( name, value, p_callback, text, longtext, advc ) \
 325     add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
 326                       p_callback, value )
 327
 328 #define add_directory( name, value, p_callback, text, longtext, advc ) \
 329     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
 330                       p_callback, value )
 331
 332 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
 333     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
 334                       p_callback, value ) \
 335     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
 336
 337 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
 338     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
 339                       p_callback, value ) \
 340     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
 341
 342 #ifndef __PLUGIN__
 343 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
 344     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
 345                       p_callback, value ) \
 346     p_config->min.i = i_subcategory /* gruik */;
 347
 348 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
 349     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
 350                       advc, p_callback, value ) \
 351     p_config->min.i = i_subcategory /* gruik */;
 352 #endif
 353
 354 #define add_integer( name, value, p_callback, text, longtext, advc ) \
 355     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
 356                    p_callback, value )
 357
 358 #define add_key( name, value, p_callback, text, longtext, advc ) \
 359     add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
 360                    value )
 361
 362 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
 363     add_integer( name, value, p_callback, text, longtext, advc ) \
 364     change_integer_range( i_min, i_max )
 365
 366 #define add_float( name, v, p_callback, text, longtext, advc ) \
 367     add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
 368     vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
 369
 370 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
 371     add_float( name, value, p_callback, text, longtext, advc ) \
 372     change_float_range( f_min, f_max )
 373
 374 #define add_bool( name, v, p_callback, text, longtext, advc ) \
 375     add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
 376                         p_callback ) \
 377     if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
 378
 379 /* For removed option */
 380 #define add_obsolete_inner( name, type ) \
 381     add_type_inner( type ) \
 382     vlc_config_set (p_config, VLC_CONFIG_NAME, \
 383                     (const char *)(name), (vlc_callback_t)NULL); \
 384     vlc_config_set (p_config, VLC_CONFIG_REMOVED);
 385
 386 #define add_obsolete_bool( name ) \
 387         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
 388
 389 #define add_obsolete_integer( name ) \
 390         add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
 391
 392 #define add_obsolete_float( name ) \
 393         add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
 394
 395 #define add_obsolete_string( name ) \
 396         add_obsolete_inner( name, CONFIG_ITEM_STRING )
 397
 398 /* Modifier macros for the config options (used for fine tuning) */
 399
 400 #define add_deprecated_alias( name ) \
 401     vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))
 402
 403 #define change_short( ch ) \
 404     vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
 405
 406 #define change_string_list( list, list_text, list_update_func ) \
 407     vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
 408                     (size_t)(sizeof (list) / sizeof (char *)), \
 409                     (const char *const *)(list), \
 410                     (const char *const *)(list_text), \
 411                     (vlc_callback_t)(list_update_func));
 412
 413 #define change_integer_list( list, list_text, list_update_func ) \
 414     vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
 415                     (size_t)(sizeof (list) / sizeof (int)), \
 416                     (const int *)(list), \
 417                     (const char *const *)(list_text), \
 418                     (vlc_callback_t)(list_update_func));
 419
 420 #define change_float_list( list, list_text, list_update_func ) \
 421     vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
 422                     (size_t)(sizeof (list) / sizeof (float)), \
 423                     (const float *)(list), \
 424                     (const char *const *)(list_text), \
 425                     (vlc_callback_t)(list_update_func));
 426
 427 #define change_integer_range( minv, maxv ) \
 428     vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
 429
 430 #define change_float_range( minv, maxv ) \
 431     vlc_config_set (p_config, VLC_CONFIG_RANGE, \
 432                     (double)(minv), (double)(maxv));
 433
 434 #define change_action_add( pf_action, text ) \
 435     vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, domain, \
 436                     (vlc_callback_t)(pf_action), (const char *)(text));
 437
 438 #define change_internal() \
 439     vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
 440
 441 #define change_need_restart() \
 442     vlc_config_set (p_config, VLC_CONFIG_RESTART);
 443
 444 #define change_autosave() \
 445     vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
 446
 447 #define change_unsaveable() \
 448     vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
 449
 450 #define change_unsafe() (void)0; /* no-op */
 451
 452 #define change_safe() \
 453     vlc_config_set (p_config, VLC_CONFIG_SAFE);
 454
 455 /* Meta data plugin exports */
 456 #define VLC_META_EXPORT( name, value ) \
 457     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
 458     E_(vlc_entry_ ## name) (void); \
 459     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
 460     __VLC_SYMBOL(vlc_entry_ ## name) (void) \
 461     { \
 462          return value; \
 463     }
 464
 465 #if defined (__LIBVLC__)
 466 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
 467     "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
 468     "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
 469     "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
 470     "\x6c\x6f\x70\x70\x65\x72\x73" )
 471 #elif !defined (VLC_COPYRIGHT_EXPORT)
 472 # define VLC_COPYRIGHT_EXPORT
 473 #endif
 474 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
 475     "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
 476     "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
 477     "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
 478     "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
 479     "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
 480
 481 #define VLC_METADATA_EXPORTS \
 482     VLC_COPYRIGHT_EXPORT \
 483     VLC_LICENSE_EXPORT
 484
 485 #endif