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