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