vlc_plugin.h 18.1 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 116 117 118 119 120 121 122
/*****************************************************************************
 * 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
 */
123 124
# define MODULE_SYMBOL 1_2_0f
# define MODULE_SUFFIX "__1_2_0f"
125 126 127 128 129 130 131

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

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

138
/* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
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 170 171
#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                                 \
172
    __VLC_SYMBOL(vlc_entry) ( module_t *p_module );                           \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
173 174
                                                                              \
    EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
175 176 177 178 179 180 181
    __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;                                                       \
        {                                                                     \
182
            module_t *p_submodule = p_module;
183 184 185 186 187 188 189 190

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

#define add_submodule( ) \
195 196
    if (vlc_plugin_set (p_module, NULL, VLC_SUBMODULE_CREATE, &p_submodule)) \
        goto error;
197

198
#define add_shortcut( ... ) \
199 200
{ \
    const char *shortcuts[] = { __VA_ARGS__ }; \
Rafaël Carré's avatar
Rafaël Carré committed
201
    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
202 203 204
                        sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
        goto error; \
}
205 206

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

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

#define set_help( help ) \
217
    if (vlc_module_set (p_submodule, VLC_MODULE_HELP, \
218
                        (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
#define cannot_unload_broken_library( ) \
233
    if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
234
        goto error;
235

236 237 238
#define set_text_domain( dom ) \
    if (vlc_module_set (p_module, VLC_MODULE_TEXTDOMAIN, (dom))) \
        goto error;
239

240 241 242 243 244 245 246 247 248 249 250 251 252 253
/*****************************************************************************
 * 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 ) \
254
    vlc_plugin_set (p_module, NULL, VLC_CONFIG_CREATE, (type), &p_config);
255 256

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

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

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

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

274 275
#define add_int_inner( type, name, text, longtext, advc, v ) \
    add_typename_inner( type, name, text, longtext, advc ) \
276
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(v));
277 278 279


#define set_category( i_id ) \
280
    add_type_inner( CONFIG_CATEGORY ) \
281
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id));
282 283

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

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

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

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

310
#define add_loadfile( name, value, text, longtext, advc ) \
311
    add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
312
                      value )
313

314
#define add_savefile( name, value, text, longtext, advc ) \
315
    add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
316
                      value )
317 318

#define add_directory( name, value, p_callback, text, longtext, advc ) \
319
    add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
320
                      value )
321

322
#define add_font( name, value, text, longtext, advc )\
323
    add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
324
                      value )
325

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

#define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
332
    add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
333
                      value ) \
334
    vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
335 336 337

#ifndef __PLUGIN__
#define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
338
    add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
339
                      value ) \
340
    change_integer_range (i_subcategory /* gruik */, 0);
341 342

#define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
343
    add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
344
                      advc, value ) \
345
    change_integer_range (i_subcategory /* gruik */, 0);
346 347 348
#endif

#define add_integer( name, value, p_callback, text, longtext, advc ) \
349
    add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
350

Hannes Domani's avatar
Hannes Domani committed
351
#define add_key( name, value, p_callback, text, longtext, advc ) \
352
    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value ) \
Hannes Domani's avatar
Hannes Domani committed
353
    add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
354
                   KEY_UNSET )
355 356

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

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

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

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

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

#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 ) \
394
    vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name));
395 396

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

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

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

#define change_integer_range( minv, maxv ) \
414 415
    vlc_config_set (p_config, VLC_CONFIG_RANGE, \
                    (int64_t)(minv), (int64_t)(maxv));
416 417 418

#define change_float_range( minv, maxv ) \
    vlc_config_set (p_config, VLC_CONFIG_RANGE, \
419
                    (double)(minv), (double)(maxv));
420 421

#define change_action_add( pf_action, text ) \
422
    vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
423
                    (vlc_callback_t)(pf_action), (const char *)(text));
424 425

#define change_need_restart() \
426
    vlc_config_set (p_config, VLC_CONFIG_RESTART);
427 428

#define change_autosave() \
429
    vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
430

431 432 433 434 435 436 437
/* 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() \
438
    vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
439 440

#define change_safe() \
441
    vlc_config_set (p_config, VLC_CONFIG_SAFE);
442

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

#if defined (__LIBVLC__)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
454 455 456
# 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
457
    "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
458
    "\x6c\x6f\x70\x65\x72\x73" )
459 460 461 462
#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
463 464 465 466 467
    "\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" )
468 469 470 471 472

#define VLC_METADATA_EXPORTS \
    VLC_COPYRIGHT_EXPORT \
    VLC_LICENSE_EXPORT

473
#endif