vlc_plugin.h 15.9 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_plugin.h : Macros used from within a module.
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2001-2006 VLC authors and VideoLAN
5
 * Copyright © 2007-2009 Rémi Denis-Courmont
6 7
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
8
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
9 10 11
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
12 13 14 15
 * (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
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser 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.
22 23
 *****************************************************************************/

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
enum vlc_module_properties
{
34
    VLC_MODULE_CREATE,
35 36
    VLC_CONFIG_CREATE,

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

    /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
     * Append new items at the end ONLY. */
55
    VLC_CONFIG_NAME=0x1000,
56
    /* command line name (args=const char *) */
57 58 59 60 61 62 63 64 65 66 67 68 69

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

70 71
    VLC_CONFIG_PERSISTENT_OBSOLETE,
    /* unused (ignored) */
72 73 74 75 76 77 78 79 80 81 82 83 84

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

85 86
    VLC_CONFIG_OLDNAME_OBSOLETE,
    /* unused (ignored) */
87 88 89 90 91 92 93 94 95 96 97 98 99 100

    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 *) */
101 102

    /* Insert new VLC_CONFIG_* here */
103 104
};

105 106 107
/**
 * Current plugin ABI version
 */
108 109
# define MODULE_SYMBOL 2_1_0a
# define MODULE_SUFFIX "__2_1_0a"
110 111 112 113 114 115 116

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

/* Explanation:
 *
117
 * if linking a module statically, we will need:
118 119 120 121 122
 * #define MODULE_FUNC( zog ) module_foo_zog
 *
 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
 */

123
/* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
124 125 126 127 128 129 130 131 132 133 134
#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

135 136 137
#define CDECL_SYMBOL
#if defined (__PLUGIN__)
# if defined (WIN32)
138
#   define DLL_SYMBOL              __declspec(dllexport)
139
#   undef CDECL_SYMBOL
140
#   define CDECL_SYMBOL            __cdecl
141
# elif VLC_GCC_VERSION(4,0)
142 143 144 145
#   define DLL_SYMBOL              __attribute__((visibility("default")))
# else
#  define DLL_SYMBOL
# endif
146
#else
147
# define DLL_SYMBOL
148 149 150 151 152 153 154 155
#endif

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

156 157 158 159 160 161
typedef int (*vlc_set_cb) (void *, void *, int, ...);

#define vlc_plugin_set(...) vlc_set (opaque,   NULL, __VA_ARGS__)
#define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__)
#define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__)

162 163 164 165 166 167
/*
 * 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.
 */
168 169
#define vlc_module_begin() \
EXTERN_SYMBOL DLL_SYMBOL \
170
int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb, void *); \
171
EXTERN_SYMBOL DLL_SYMBOL \
172
int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb vlc_set, void *opaque) \
173
{ \
174 175 176
    module_t *module; \
    module_config_t *config = NULL; \
    if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
177
        goto error; \
178 179
    if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \
        goto error;
180 181

#define vlc_module_end() \
182 183
    (void) config; \
    return 0; \
184
error: \
185
    return -1; \
186 187
} \
VLC_METADATA_EXPORTS
188 189

#define add_submodule( ) \
190
    if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
191
        goto error;
192

193
#define add_shortcut( ... ) \
194 195
{ \
    const char *shortcuts[] = { __VA_ARGS__ }; \
196
    if (vlc_module_set (VLC_MODULE_SHORTCUT, \
197 198 199
                        sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
        goto error; \
}
200 201

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

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

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

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

#define set_callbacks( activate, deactivate ) \
219 220
    if (vlc_module_set (VLC_MODULE_CB_OPEN, activate) \
     || vlc_module_set (VLC_MODULE_CB_CLOSE, deactivate)) \
221
        goto error;
222

223
#define cannot_unload_broken_library( ) \
224
    if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
225
        goto error;
226

227
#define set_text_domain( dom ) \
228
    if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \
229
        goto error;
230

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

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

#define add_typeadv_inner( type, text, longtext, advc ) \
253
    add_typedesc_inner( type, text, longtext ) \
254
    if (advc) vlc_config_set (VLC_CONFIG_ADVANCED);
255

256
#define add_typename_inner( type, name, text, longtext, advc ) \
257
    add_typeadv_inner( type, text, longtext, advc ) \
258
    vlc_config_set (VLC_CONFIG_NAME, (const char *)(name));
259

260 261
#define add_string_inner( type, name, text, longtext, advc, v ) \
    add_typename_inner( type, name, text, longtext, advc ) \
262
    vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v));
263

264 265
#define add_int_inner( type, name, text, longtext, advc, v ) \
    add_typename_inner( type, name, text, longtext, advc ) \
266
    vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v));
267 268 269


#define set_category( i_id ) \
270
    add_type_inner( CONFIG_CATEGORY ) \
271
    vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
272 273

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

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

292
#define add_string( name, value, text, longtext, advc ) \
293
    add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
294
                      value )
295

296
#define add_password( name, value, text, longtext, advc ) \
297
    add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
298
                      value )
299

300
#define add_loadfile( name, value, text, longtext, advc ) \
301
    add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
302
                      value )
303

304
#define add_savefile( name, value, text, longtext, advc ) \
305
    add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
306
                      value )
307

308
#define add_directory( name, value, text, longtext, advc ) \
309
    add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
310
                      value )
311

312
#define add_font( name, value, text, longtext, advc )\
313
    add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
314
                      value )
315

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

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

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

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

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

341 342 343 344
#define add_rgb( name, value, text, longtext, advc ) \
    add_int_inner( CONFIG_ITEM_RGB, name, text, longtext, advc, value ) \
    change_integer_range( 0, 0xFFFFFF )

345
#define add_key( name, value, text, longtext, advc ) \
346
    add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
347
                   KEY_UNSET ) \
348
    add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value )
349

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

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

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

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

/* For removed option */
#define add_obsolete_inner( name, type ) \
368
    add_type_inner( type ) \
369 370
    vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); \
    vlc_config_set (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 change_short( ch ) \
387
    vlc_config_set (VLC_CONFIG_SHORTCUT, (int)(ch));
388 389

#define change_string_list( list, list_text, list_update_func ) \
390
    vlc_config_set (VLC_CONFIG_LIST, \
391 392 393
                    (size_t)(sizeof (list) / sizeof (char *)), \
                    (const char *const *)(list), \
                    (const char *const *)(list_text), \
394
                    (vlc_callback_t)(list_update_func));
395

396
#define change_integer_list( list, list_text ) \
397
    vlc_config_set (VLC_CONFIG_LIST, \
398 399 400
                    (size_t)(sizeof (list) / sizeof (int)), \
                    (const int *)(list), \
                    (const char *const *)(list_text), \
401
                    (vlc_callback_t)(NULL));
402 403

#define change_integer_range( minv, maxv ) \
404
    vlc_config_set (VLC_CONFIG_RANGE, (int64_t)(minv), (int64_t)(maxv));
405 406

#define change_float_range( minv, maxv ) \
407
    vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv));
408 409

#define change_action_add( pf_action, text ) \
410
    vlc_config_set (VLC_CONFIG_ADD_ACTION, \
411
                    (vlc_callback_t)(pf_action), (const char *)(text));
412

413 414
/* For options that are saved but hidden from the preferences panel */
#define change_private() \
415
    vlc_config_set (VLC_CONFIG_PRIVATE);
416 417 418 419

/* For options that cannot be saved in the configuration */
#define change_volatile() \
    change_private() \
420
    vlc_config_set (VLC_CONFIG_VOLATILE);
421 422

#define change_safe() \
423
    vlc_config_set (VLC_CONFIG_SAFE);
424

425 426
/* Meta data plugin exports */
#define VLC_META_EXPORT( name, value ) \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
427
    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
428
    __VLC_SYMBOL(vlc_entry_ ## name) (void); \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
429
    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
430 431 432 433 434 435
    __VLC_SYMBOL(vlc_entry_ ## name) (void) \
    { \
         return value; \
    }

#if defined (__LIBVLC__)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
436 437 438
# 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
439
    "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
440
    "\x6c\x6f\x70\x65\x72\x73" )
441 442 443 444
#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
445 446 447 448 449
    "\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" )
450 451 452 453 454

#define VLC_METADATA_EXPORTS \
    VLC_COPYRIGHT_EXPORT \
    VLC_LICENSE_EXPORT

455
#endif