vlc_plugin.h 17.7 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 33 34 35
VLC_EXPORT( int, vlc_plugin_set, (module_t *, module_config_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__)
36 37 38

enum vlc_module_properties
{
39 40 41
    VLC_SUBMODULE_CREATE,
    VLC_CONFIG_CREATE,

42 43
    /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
     * Append new items at the end ONLY. */
44
    VLC_MODULE_CPU_REQUIREMENT=0x100,
45 46 47 48 49 50 51 52 53 54
    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,
55
    VLC_MODULE_TEXTDOMAIN,
56
    /* Insert new VLC_MODULE_* here */
57 58 59

    /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
     * Append new items at the end ONLY. */
60
    VLC_CONFIG_NAME=0x1000,
61
    /* command line name (args=const char *) */
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 107 108

    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 *) */
109 110

    /* Insert new VLC_CONFIG_* here */
111 112
};

113 114 115
/**
 * Current plugin ABI version
 */
116 117
# define MODULE_SYMBOL 1_2_0f
# define MODULE_SUFFIX "__1_2_0f"
118 119 120 121 122 123 124

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

/* Explanation:
 *
125
 * if linking a module statically, we will need:
126 127 128 129 130
 * #define MODULE_FUNC( zog ) module_foo_zog
 *
 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
 */

131
/* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
132 133 134 135 136 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
#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                                 \
165
    __VLC_SYMBOL(vlc_entry) ( module_t *p_module );                           \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
166 167
                                                                              \
    EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
168 169 170 171 172 173 174
    __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
    {                                                                         \
        module_config_t *p_config = NULL;                                     \
        if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
                            (const char *)(MODULE_STRING)))                   \
            goto error;                                                       \
        {                                                                     \
175
            module_t *p_submodule = p_module;
176 177 178 179 180 181 182 183

#define vlc_module_end( )                                                     \
        }                                                                     \
        (void)p_config;                                                       \
        return VLC_SUCCESS;                                                   \
                                                                              \
    error:                                                                    \
        return VLC_EGENERIC;                                                  \
184 185
    }                                                                         \
    VLC_METADATA_EXPORTS
186 187

#define add_submodule( ) \
188 189
    if (vlc_plugin_set (p_module, NULL, VLC_SUBMODULE_CREATE, &p_submodule)) \
        goto error;
190

191
#define add_shortcut( ... ) \
192 193
{ \
    const char *shortcuts[] = { __VA_ARGS__ }; \
Rafaël Carré's avatar
Rafaël Carré committed
194
    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
195 196 197
                        sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
        goto error; \
}
198 199

#define set_shortname( shortname ) \
200
    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
201
                        (const char *)(shortname))) \
202
        goto error;
203 204

#define set_description( desc ) \
205
    if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
206
                        (const char *)(desc))) \
207
        goto error;
208 209

#define set_help( help ) \
210
    if (vlc_module_set (p_submodule, VLC_MODULE_HELP, \
211
                        (const char *)(help))) \
212
        goto error;
213 214

#define set_capability( cap, score ) \
215 216
    if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
                        (const char *)(cap)) \
217
     || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
218
        goto error;
219 220 221 222

#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)) \
223
        goto error;
224

225
#define cannot_unload_broken_library( ) \
226
    if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
227
        goto error;
228

229 230 231
#define set_text_domain( dom ) \
    if (vlc_module_set (p_module, VLC_MODULE_TEXTDOMAIN, (dom))) \
        goto error;
232

233 234 235 236 237 238 239 240 241 242 243 244 245 246
/*****************************************************************************
 * 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 ) \
247
    vlc_plugin_set (p_module, NULL, VLC_CONFIG_CREATE, (type), &p_config);
248 249

#define add_typedesc_inner( type, text, longtext ) \
250
    add_type_inner( type ) \
251
    vlc_config_set (p_config, VLC_CONFIG_DESC, \
252
                    (const char *)(text), (const char *)(longtext));
253 254

#define add_typeadv_inner( type, text, longtext, advc ) \
255 256
    add_typedesc_inner( type, text, longtext ) \
    if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
257

258
#define add_typename_inner( type, name, text, longtext, advc ) \
259
    add_typeadv_inner( type, text, longtext, advc ) \
260
    vlc_config_set (p_config, VLC_CONFIG_NAME, \
261
                    (const char *)(name));
262

263 264
#define add_string_inner( type, name, text, longtext, advc, v ) \
    add_typename_inner( type, name, text, longtext, advc ) \
265
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
266

267 268
#define add_int_inner( type, name, text, longtext, advc, v ) \
    add_typename_inner( type, name, text, longtext, advc ) \
269
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(v));
270 271 272


#define set_category( i_id ) \
273
    add_type_inner( CONFIG_CATEGORY ) \
274
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id));
275 276

#define set_subcategory( i_id ) \
277
    add_type_inner( CONFIG_SUBCATEGORY ) \
278
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id));
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294

#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 )

295
#define add_string( name, value, text, longtext, advc ) \
296
    add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
297
                      value )
298

299
#define add_password( name, value, text, longtext, advc ) \
300
    add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
301
                      value )
302

303
#define add_loadfile( name, value, text, longtext, advc ) \
304
    add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
305
                      value )
306

307
#define add_savefile( name, value, text, longtext, advc ) \
308
    add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
309
                      value )
310

311
#define add_directory( name, value, text, longtext, advc ) \
312
    add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
313
                      value )
314

315
#define add_font( name, value, text, longtext, advc )\
316
    add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
317
                      value )
318

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

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

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

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

341
#define add_integer( name, value, text, longtext, advc ) \
342
    add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
343

344
#define add_key( name, value, text, longtext, advc ) \
345
    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value ) \
Hannes Domani's avatar
Hannes Domani committed
346
    add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
347
                   KEY_UNSET )
348 349

#define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
350
    add_integer( name, value, text, longtext, advc ) \
351 352
    change_integer_range( i_min, i_max )

353
#define add_float( name, v, text, longtext, advc ) \
354
    add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
355
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
356 357

#define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
358
    add_float( name, value, text, longtext, advc ) \
359 360
    change_float_range( f_min, f_max )

361
#define add_bool( name, v, text, longtext, advc ) \
362
    add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
363
    if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)true);
364 365 366

/* For removed option */
#define add_obsolete_inner( name, type ) \
367
    add_type_inner( type ) \
368
    vlc_config_set (p_config, VLC_CONFIG_NAME, \
369
                    (const char *)(name)); \
370
    vlc_config_set (p_config, VLC_CONFIG_REMOVED);
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386

#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 ) \
387
    vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name));
388 389

#define change_short( ch ) \
390
    vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
391 392

#define change_string_list( list, list_text, list_update_func ) \
393
    vlc_config_set (p_config, VLC_CONFIG_LIST, \
394 395 396
                    (size_t)(sizeof (list) / sizeof (char *)), \
                    (const char *const *)(list), \
                    (const char *const *)(list_text), \
397
                    (vlc_callback_t)(list_update_func));
398

399
#define change_integer_list( list, list_text ) \
400
    vlc_config_set (p_config, VLC_CONFIG_LIST, \
401 402 403
                    (size_t)(sizeof (list) / sizeof (int)), \
                    (const int *)(list), \
                    (const char *const *)(list_text), \
404
                    (vlc_callback_t)(NULL));
405 406

#define change_integer_range( minv, maxv ) \
407 408
    vlc_config_set (p_config, VLC_CONFIG_RANGE, \
                    (int64_t)(minv), (int64_t)(maxv));
409 410 411

#define change_float_range( minv, maxv ) \
    vlc_config_set (p_config, VLC_CONFIG_RANGE, \
412
                    (double)(minv), (double)(maxv));
413 414

#define change_action_add( pf_action, text ) \
415
    vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
416
                    (vlc_callback_t)(pf_action), (const char *)(text));
417 418

#define change_need_restart() \
419
    vlc_config_set (p_config, VLC_CONFIG_RESTART);
420 421

#define change_autosave() \
422
    vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
423

424 425 426 427 428 429 430
/* For options that are saved but hidden from the preferences panel */
#define change_private() \
    vlc_config_set (p_config, VLC_CONFIG_PRIVATE);

/* For options that cannot be saved in the configuration */
#define change_volatile() \
    change_private() \
431
    vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
432 433

#define change_safe() \
434
    vlc_config_set (p_config, VLC_CONFIG_SAFE);
435

436 437
/* Meta data plugin exports */
#define VLC_META_EXPORT( name, value ) \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
438
    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
439
    __VLC_SYMBOL(vlc_entry_ ## name) (void); \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
440
    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
441 442 443 444 445 446
    __VLC_SYMBOL(vlc_entry_ ## name) (void) \
    { \
         return value; \
    }

#if defined (__LIBVLC__)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
447 448 449
# 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
450
    "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
451
    "\x6c\x6f\x70\x65\x72\x73" )
452 453 454 455
#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
456 457 458 459 460
    "\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" )
461 462 463 464 465

#define VLC_METADATA_EXPORTS \
    VLC_COPYRIGHT_EXPORT \
    VLC_LICENSE_EXPORT

466
#endif