vlc_plugin.h 18.6 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_plugin.h : Macros used from within a module.
3
 *****************************************************************************
4
 * Copyright (C) 2001-2006 the VideoLAN team
5
 * Copyright © 2007-2009 Rémi Denis-Courmont
6 7
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 * 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
 * (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.
 *
 * 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.
 *****************************************************************************/

24 25 26
#ifndef LIBVLC_MODULES_MACROS_H
# define LIBVLC_MODULES_MACROS_H 1

27 28 29 30 31
/**
 * \file
 * This file implements plugin (module) macros used to define a vlc module.
 */

32
VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
33 34 35 36 37
VLC_EXPORT( int, vlc_plugin_set, (module_t *, module_config_t *, int, ...) );
VLC_EXPORT( module_config_t *, vlc_config_create, (module_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__)
38 39 40 41 42

enum vlc_module_properties
{
    /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
     * Append new items at the end ONLY. */
43
    VLC_MODULE_CPU_REQUIREMENT=0x100,
44 45 46 47 48 49 50 51 52 53
    VLC_MODULE_SHORTCUT,
    VLC_MODULE_CAPABILITY,
    VLC_MODULE_SCORE,
    VLC_MODULE_CB_OPEN,
    VLC_MODULE_CB_CLOSE,
    VLC_MODULE_NO_UNLOAD,
    VLC_MODULE_NAME,
    VLC_MODULE_SHORTNAME,
    VLC_MODULE_DESCRIPTION,
    VLC_MODULE_HELP,
54
    /* Insert new VLC_MODULE_* here */
55 56 57

    /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
     * Append new items at the end ONLY. */
58
    VLC_CONFIG_NAME=0x1000,
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
    /* command line name (args=const char *, vlc_callback_t) */

    VLC_CONFIG_VALUE,
    /* actual value (args=int/double/const char *) */

    VLC_CONFIG_RANGE,
    /* minimum value (args=int/double/const char * twice) */

    VLC_CONFIG_ADVANCED,
    /* enable advanced flag (args=none) */

    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_PRIVATE,
    /* hide from user (args=none) */

    VLC_CONFIG_REMOVED,
    /* tag as no longer supported (args=none) */

    VLC_CONFIG_CAPABILITY,
    /* capability for a module or list thereof (args=const char*) */

    VLC_CONFIG_SHORTCUT,
    /* one-character (short) command line option name (args=char) */

    VLC_CONFIG_OLDNAME,
    /* former option name (args=const char *) */

    VLC_CONFIG_SAFE,
    /* tag as modifiable by untrusted input item "sources" (args=none) */

    VLC_CONFIG_DESC,
    /* description (args=const char *, const char *, const char *) */

    VLC_CONFIG_LIST,
    /* possible values list
     * (args=const char *, size_t, const <type> *, const char *const *) */

    VLC_CONFIG_ADD_ACTION,
    /* add value change callback
     * (args=const char *, vlc_callback_t, const char *) */
107 108

    /* Insert new VLC_CONFIG_* here */
109 110
};

111 112 113 114 115 116 117 118 119 120
/*****************************************************************************
 * If we are not within a module, assume we're in the vlc core.
 *****************************************************************************/
#if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
#   define MODULE_NAME main
#endif

/**
 * Current plugin ABI version
 */
121 122
# define MODULE_SYMBOL 1_0_0d
# define MODULE_SUFFIX "__1_0_0d"
123 124 125 126 127 128 129

/*****************************************************************************
 * Add a few defines. You do not want to read this section. Really.
 *****************************************************************************/

/* Explanation:
 *
130
 * if linking a module statically, we will need:
131 132 133 134 135
 * #define MODULE_FUNC( zog ) module_foo_zog
 *
 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
 */

136
/* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
#define CONCATENATE( y, z ) CRUDE_HACK( y, z )
#define CRUDE_HACK( y, z )  y##__##z

/* If the module is built-in, then we need to define foo_InitModule instead
 * of InitModule. Same for Activate- and DeactivateModule. */
#ifdef __PLUGIN__
#   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
#else
#   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
#endif

#if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
#   define DLL_SYMBOL              __declspec(dllexport)
#   define CDECL_SYMBOL            __cdecl
#else
#   define DLL_SYMBOL
#   define CDECL_SYMBOL
#endif

#if defined( __cplusplus )
#   define EXTERN_SYMBOL           extern "C"
#else
#   define EXTERN_SYMBOL
#endif

/*
 * 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                                 \
170
    __VLC_SYMBOL(vlc_entry) ( module_t *p_module );                           \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
171 172
                                                                              \
    EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
173 174 175
    __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
    {                                                                         \
        module_config_t *p_config = NULL;                                     \
176
        const char *domain = NULL;                                            \
177 178 179 180
        if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
                            (const char *)(MODULE_STRING)))                   \
            goto error;                                                       \
        {                                                                     \
181
            module_t *p_submodule = p_module;
182 183 184 185 186 187 188 189

#define vlc_module_end( )                                                     \
        }                                                                     \
        (void)p_config;                                                       \
        return VLC_SUCCESS;                                                   \
                                                                              \
    error:                                                                    \
        return VLC_EGENERIC;                                                  \
190 191
    }                                                                         \
    VLC_METADATA_EXPORTS
192 193

#define add_submodule( ) \
194
    p_submodule = vlc_submodule_create( p_module );
195 196 197 198

#define add_requirement( cap ) \
    if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
                        (int)(CPU_CAPABILITY_##cap))) \
199
        goto error;
200 201

#define add_shortcut( shortcut ) \
Rafaël Carré's avatar
Rafaël Carré committed
202 203
    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
        (const char *)(shortcut))) \
204
        goto error;
205 206

#define set_shortname( shortname ) \
207 208
    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \
                        (const char *)(shortname))) \
209
        goto error;
210 211

#define set_description( desc ) \
212
    if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \
213
                        (const char *)(desc))) \
214
        goto error;
215 216

#define set_help( help ) \
217 218
    if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \
                        (const char *)(help))) \
219
        goto error;
220 221

#define set_capability( cap, score ) \
222 223
    if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
                        (const char *)(cap)) \
224
     || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
225
        goto error;
226 227 228 229

#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)) \
230
        goto error;
231 232 233

#define linked_with_a_crap_library_which_uses_atexit( ) \
    if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
234
        goto error;
235

236 237
#define set_text_domain( dom ) domain = (dom);

238 239 240 241 242 243 244 245 246 247 248 249 250 251
/*****************************************************************************
 * Macros used to build the configuration structure.
 *
 * Note that internally we support only 3 types of config data: int, float
 *   and string.
 *   The other types declared here just map to one of these 3 basic types but
 *   have the advantage of also providing very good hints to a configuration
 *   interface so as to make it more user friendly.
 * The configuration structure also includes category hints. These hints can
 *   provide a configuration interface with some very useful data and again
 *   allow for a more user friendly interface.
 *****************************************************************************/

#define add_type_inner( type ) \
252
    p_config = vlc_config_create (p_module, type);
253 254

#define add_typedesc_inner( type, text, longtext ) \
255
    add_type_inner( type ) \
256
    vlc_config_set (p_config, VLC_CONFIG_DESC, domain, \
257
                    (const char *)(text), (const char *)(longtext));
258 259

#define add_typeadv_inner( type, text, longtext, advc ) \
260 261
    add_typedesc_inner( type, text, longtext ) \
    if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
262 263

#define add_typename_inner( type, name, text, longtext, advc, cb ) \
264
    add_typeadv_inner( type, text, longtext, advc ) \
265
    vlc_config_set (p_config, VLC_CONFIG_NAME, \
266
                    (const char *)(name), (vlc_callback_t)(cb));
267 268

#define add_string_inner( type, name, text, longtext, advc, cb, v ) \
269 270
    add_typename_inner( type, name, text, longtext, advc, cb ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
271 272

#define add_int_inner( type, name, text, longtext, advc, cb, v ) \
273 274
    add_typename_inner( type, name, text, longtext, advc, cb ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
275 276 277


#define set_category( i_id ) \
278 279
    add_type_inner( CONFIG_CATEGORY ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
280 281

#define set_subcategory( i_id ) \
282 283
    add_type_inner( CONFIG_SUBCATEGORY ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300

#define set_section( text, longtext ) \
    add_typedesc_inner( CONFIG_SECTION, text, longtext )

#define add_category_hint( text, longtext, advc ) \
    add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )

#define add_subcategory_hint( text, longtext ) \
    add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )

#define end_subcategory_hint \
    add_type_inner( CONFIG_HINT_SUBCATEGORY_END )

#define add_usage_hint( text ) \
    add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )

#define add_string( name, value, p_callback, text, longtext, advc ) \
301 302
    add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
                      p_callback, value )
303 304

#define add_password( name, value, p_callback, text, longtext, advc ) \
305 306
    add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
                      p_callback, value )
307 308

#define add_file( name, value, p_callback, text, longtext, advc ) \
309 310
    add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
                      p_callback, value )
311 312

#define add_directory( name, value, p_callback, text, longtext, advc ) \
313 314
    add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
                      p_callback, value )
315 316

#define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
317 318 319
    add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
                      p_callback, value ) \
    vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
320 321

#define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
322 323 324
    add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
                      p_callback, value ) \
    vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
325 326 327

#ifndef __PLUGIN__
#define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
328 329
    add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
                      p_callback, value ) \
330
    change_integer_range (i_subcategory /* gruik */, 0);
331 332

#define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
333 334
    add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
                      advc, p_callback, value ) \
335
    change_integer_range (i_subcategory /* gruik */, 0);
336 337 338
#endif

#define add_integer( name, value, p_callback, text, longtext, advc ) \
339 340
    add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
                   p_callback, value )
341

342
#if !defined(WIN32) && !defined(SYS_LINUX)
343
#define add_key( name, value, p_callback, text, longtext, advc ) \
344 345
    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
                   value )
Hannes Domani's avatar
Hannes Domani committed
346 347 348 349 350 351 352
#else
#define add_key( name, value, p_callback, text, longtext, advc ) \
    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, \
                   p_callback, value ) \
    add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
                   p_callback, KEY_UNSET )
#endif
353 354

#define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
355
    add_integer( name, value, p_callback, text, longtext, advc ) \
356 357 358
    change_integer_range( i_min, i_max )

#define add_float( name, v, p_callback, text, longtext, advc ) \
359 360
    add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
361 362

#define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
363
    add_float( name, value, p_callback, text, longtext, advc ) \
364 365 366
    change_float_range( f_min, f_max )

#define add_bool( name, v, p_callback, text, longtext, advc ) \
367 368 369
    add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
                        p_callback ) \
    if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
370 371 372

/* For removed option */
#define add_obsolete_inner( name, type ) \
373
    add_type_inner( type ) \
374 375
    vlc_config_set (p_config, VLC_CONFIG_NAME, \
                    (const char *)(name), (vlc_callback_t)NULL); \
376
    vlc_config_set (p_config, VLC_CONFIG_REMOVED);
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392

#define add_obsolete_bool( name ) \
        add_obsolete_inner( name, CONFIG_ITEM_BOOL )

#define add_obsolete_integer( name ) \
        add_obsolete_inner( name, CONFIG_ITEM_INTEGER )

#define add_obsolete_float( name ) \
        add_obsolete_inner( name, CONFIG_ITEM_FLOAT )

#define add_obsolete_string( name ) \
        add_obsolete_inner( name, CONFIG_ITEM_STRING )

/* Modifier macros for the config options (used for fine tuning) */

#define add_deprecated_alias( name ) \
393
    vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name));
394 395

#define change_short( ch ) \
396
    vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
397 398

#define change_string_list( list, list_text, list_update_func ) \
399
    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
400 401 402
                    (size_t)(sizeof (list) / sizeof (char *)), \
                    (const char *const *)(list), \
                    (const char *const *)(list_text), \
403
                    (vlc_callback_t)(list_update_func));
404 405

#define change_integer_list( list, list_text, list_update_func ) \
406
    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
407 408 409
                    (size_t)(sizeof (list) / sizeof (int)), \
                    (const int *)(list), \
                    (const char *const *)(list_text), \
410
                    (vlc_callback_t)(list_update_func));
411 412

#define change_float_list( list, list_text, list_update_func ) \
413
    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
414 415 416
                    (size_t)(sizeof (list) / sizeof (float)), \
                    (const float *)(list), \
                    (const char *const *)(list_text), \
417
                    (vlc_callback_t)(list_update_func));
418 419

#define change_integer_range( minv, maxv ) \
420
    vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
421 422 423

#define change_float_range( minv, maxv ) \
    vlc_config_set (p_config, VLC_CONFIG_RANGE, \
424
                    (double)(minv), (double)(maxv));
425 426

#define change_action_add( pf_action, text ) \
427
    vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, domain, \
428
                    (vlc_callback_t)(pf_action), (const char *)(text));
429 430

#define change_internal() \
431
    vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
432 433

#define change_need_restart() \
434
    vlc_config_set (p_config, VLC_CONFIG_RESTART);
435 436

#define change_autosave() \
437
    vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
438 439

#define change_unsaveable() \
440
    vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
441 442

#define change_safe() \
443
    vlc_config_set (p_config, VLC_CONFIG_SAFE);
444

445 446
/* Meta data plugin exports */
#define VLC_META_EXPORT( name, value ) \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
447
    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
448
    __VLC_SYMBOL(vlc_entry_ ## name) (void); \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
449
    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
450 451 452 453 454 455
    __VLC_SYMBOL(vlc_entry_ ## name) (void) \
    { \
         return value; \
    }

#if defined (__LIBVLC__)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
456 457 458
# define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
    "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
    "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
Rémi Denis-Courmont's avatar
Typo  
Rémi Denis-Courmont committed
459
    "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
460
    "\x6c\x6f\x70\x70\x65\x72\x73" )
461 462 463 464
#elif !defined (VLC_COPYRIGHT_EXPORT)
# define VLC_COPYRIGHT_EXPORT
#endif
#define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
465 466 467 468 469
    "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
    "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
    "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
    "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
    "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
470 471 472 473 474

#define VLC_METADATA_EXPORTS \
    VLC_COPYRIGHT_EXPORT \
    VLC_LICENSE_EXPORT

475
#endif