1 /*****************************************************************************
2 * vlc_plugin.h : Macros used from within a module.
3 *****************************************************************************
4 * Copyright (C) 2001-2006 VLC authors and VideoLAN
5 * Copyright © 2007-2009 Rémi Denis-Courmont
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #ifndef LIBVLC_MODULES_MACROS_H
25 # define LIBVLC_MODULES_MACROS_H 1
29 * This file implements plugin (module) macros used to define a vlc module.
32 enum vlc_module_properties
37 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
38 * Append new items at the end ONLY. */
39 VLC_MODULE_CPU_REQUIREMENT=0x100,
41 VLC_MODULE_CAPABILITY,
48 VLC_MODULE_DESCRIPTION,
50 VLC_MODULE_TEXTDOMAIN,
51 /* Insert new VLC_MODULE_* here */
53 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
54 * Append new items at the end ONLY. */
55 VLC_CONFIG_NAME=0x1000,
56 /* command line name (args=const char *) */
59 /* actual value (args=int/double/const char *) */
62 /* minimum value (args=int/double/const char * twice) */
65 /* enable advanced flag (args=none) */
68 /* don't write variable to storage (args=none) */
70 VLC_CONFIG_PERSISTENT_OBSOLETE,
71 /* unused (ignored) */
74 /* hide from user (args=none) */
77 /* tag as no longer supported (args=none) */
79 VLC_CONFIG_CAPABILITY,
80 /* capability for a module or list thereof (args=const char*) */
83 /* one-character (short) command line option name (args=char) */
85 VLC_CONFIG_OLDNAME_OBSOLETE,
86 /* unused (ignored) */
89 /* tag as modifiable by untrusted input item "sources" (args=none) */
92 /* description (args=const char *, const char *, const char *) */
95 /* possible values list
96 * (args=const char *, size_t, const <type> *, const char *const *) */
98 VLC_CONFIG_ADD_ACTION_OBSOLETE,
99 /* unused (ignored) */
101 /* Insert new VLC_CONFIG_* here */
104 /* Configuration hint types */
105 #define CONFIG_HINT_CATEGORY 0x02 /* Start of new category */
106 #define CONFIG_HINT_SUBCATEGORY 0x03 /* Start of sub-category */
107 #define CONFIG_HINT_SUBCATEGORY_END 0x04 /* End of sub-category */
108 #define CONFIG_HINT_USAGE 0x05 /* Usage information */
110 #define CONFIG_CATEGORY 0x06 /* Set category */
111 #define CONFIG_SUBCATEGORY 0x07 /* Set subcategory */
112 #define CONFIG_SECTION 0x08 /* Start of new section */
114 /* Configuration item types */
115 #define CONFIG_ITEM_FLOAT 0x20 /* Float option */
116 #define CONFIG_ITEM_INTEGER 0x40 /* Integer option */
117 #define CONFIG_ITEM_RGB 0x41 /* RGB color option */
118 #define CONFIG_ITEM_BOOL 0x60 /* Bool option */
119 #define CONFIG_ITEM_STRING 0x80 /* String option */
120 #define CONFIG_ITEM_PASSWORD 0x81 /* Password option (*) */
121 #define CONFIG_ITEM_KEY 0x82 /* Hot key option */
122 #define CONFIG_ITEM_MODULE 0x84 /* Module option */
123 #define CONFIG_ITEM_MODULE_CAT 0x85 /* Module option */
124 #define CONFIG_ITEM_MODULE_LIST 0x86 /* Module option */
125 #define CONFIG_ITEM_MODULE_LIST_CAT 0x87 /* Module option */
126 #define CONFIG_ITEM_LOADFILE 0x8C /* Read file option */
127 #define CONFIG_ITEM_SAVEFILE 0x8D /* Written file option */
128 #define CONFIG_ITEM_DIRECTORY 0x8E /* Directory option */
129 #define CONFIG_ITEM_FONT 0x8F /* Font option */
131 #define CONFIG_ITEM(x) (((x) & ~0xF) != 0)
133 /* Categories and subcategories */
134 #define CAT_INTERFACE 1
135 #define SUBCAT_INTERFACE_GENERAL 101
136 #define SUBCAT_INTERFACE_MAIN 102
137 #define SUBCAT_INTERFACE_CONTROL 103
138 #define SUBCAT_INTERFACE_HOTKEYS 104
141 #define SUBCAT_AUDIO_GENERAL 201
142 #define SUBCAT_AUDIO_AOUT 202
143 #define SUBCAT_AUDIO_AFILTER 203
144 #define SUBCAT_AUDIO_VISUAL 204
145 #define SUBCAT_AUDIO_MISC 205
148 #define SUBCAT_VIDEO_GENERAL 301
149 #define SUBCAT_VIDEO_VOUT 302
150 #define SUBCAT_VIDEO_VFILTER 303
151 #define SUBCAT_VIDEO_TEXT 304
152 #define SUBCAT_VIDEO_SUBPIC 305
153 #define SUBCAT_VIDEO_VFILTER2 306
156 #define SUBCAT_INPUT_GENERAL 401
157 #define SUBCAT_INPUT_ACCESS 402
158 #define SUBCAT_INPUT_DEMUX 403
159 #define SUBCAT_INPUT_VCODEC 404
160 #define SUBCAT_INPUT_ACODEC 405
161 #define SUBCAT_INPUT_SCODEC 406
162 #define SUBCAT_INPUT_STREAM_FILTER 407
165 #define SUBCAT_SOUT_GENERAL 501
166 #define SUBCAT_SOUT_STREAM 502
167 #define SUBCAT_SOUT_MUX 503
168 #define SUBCAT_SOUT_ACO 504
169 #define SUBCAT_SOUT_PACKETIZER 505
170 #define SUBCAT_SOUT_SAP 506
171 #define SUBCAT_SOUT_VOD 507
173 #define CAT_ADVANCED 6
174 #define SUBCAT_ADVANCED_CPU 601
175 #define SUBCAT_ADVANCED_MISC 602
176 #define SUBCAT_ADVANCED_NETWORK 603
177 #define SUBCAT_ADVANCED_XML 604
179 #define CAT_PLAYLIST 7
180 #define SUBCAT_PLAYLIST_GENERAL 701
181 #define SUBCAT_PLAYLIST_SD 702
182 #define SUBCAT_PLAYLIST_EXPORT 703
185 #define SUBCAT_OSD_IMPORT 801
189 * Current plugin ABI version
191 # define MODULE_SYMBOL 2_1_0a
192 # define MODULE_SUFFIX "__2_1_0a"
194 /*****************************************************************************
195 * Add a few defines. You do not want to read this section. Really.
196 *****************************************************************************/
200 * if linking a module statically, we will need:
201 * #define MODULE_FUNC( zog ) module_foo_zog
203 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
206 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
207 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
208 #define CRUDE_HACK( y, z ) y##__##z
210 /* If the module is built-in, then we need to define foo_InitModule instead
211 * of InitModule. Same for Activate- and DeactivateModule. */
213 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
215 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
219 #if defined (__PLUGIN__)
221 # define DLL_SYMBOL __declspec(dllexport)
223 # define CDECL_SYMBOL __cdecl
224 # elif VLC_GCC_VERSION(4,0)
225 # define DLL_SYMBOL __attribute__((visibility("default")))
233 #if defined( __cplusplus )
234 # define EXTERN_SYMBOL extern "C"
236 # define EXTERN_SYMBOL
239 typedef int (*vlc_set_cb) (void *, void *, int, ...);
241 #define vlc_plugin_set(...) vlc_set (opaque, NULL, __VA_ARGS__)
242 #define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__)
243 #define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__)
246 * InitModule: this function is called once and only once, when the module
247 * is looked at for the first time. We get the useful data from it, for
248 * instance the module name, its shortcuts, its capabilities... we also create
249 * a copy of its config because the module can be unloaded at any time.
251 #define vlc_module_begin() \
252 EXTERN_SYMBOL DLL_SYMBOL \
253 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb, void *); \
254 EXTERN_SYMBOL DLL_SYMBOL \
255 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb vlc_set, void *opaque) \
258 module_config_t *config = NULL; \
259 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
261 if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \
264 #define vlc_module_end() \
272 #define add_submodule( ) \
273 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
276 #define add_shortcut( ... ) \
278 const char *shortcuts[] = { __VA_ARGS__ }; \
279 if (vlc_module_set (VLC_MODULE_SHORTCUT, \
280 sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
284 #define set_shortname( shortname ) \
285 if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \
288 #define set_description( desc ) \
289 if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \
292 #define set_help( help ) \
293 if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \
296 #define set_capability( cap, score ) \
297 if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \
298 || vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \
301 #define set_callbacks( activate, deactivate ) \
302 if (vlc_module_set (VLC_MODULE_CB_OPEN, activate) \
303 || vlc_module_set (VLC_MODULE_CB_CLOSE, deactivate)) \
306 #define cannot_unload_broken_library( ) \
307 if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
310 #define set_text_domain( dom ) \
311 if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \
314 /*****************************************************************************
315 * Macros used to build the configuration structure.
317 * Note that internally we support only 3 types of config data: int, float
319 * The other types declared here just map to one of these 3 basic types but
320 * have the advantage of also providing very good hints to a configuration
321 * interface so as to make it more user friendly.
322 * The configuration structure also includes category hints. These hints can
323 * provide a configuration interface with some very useful data and again
324 * allow for a more user friendly interface.
325 *****************************************************************************/
327 #define add_type_inner( type ) \
328 vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config);
330 #define add_typedesc_inner( type, text, longtext ) \
331 add_type_inner( type ) \
332 vlc_config_set (VLC_CONFIG_DESC, \
333 (const char *)(text), (const char *)(longtext));
335 #define add_typeadv_inner( type, text, longtext, advc ) \
336 add_typedesc_inner( type, text, longtext ) \
337 if (advc) vlc_config_set (VLC_CONFIG_ADVANCED);
339 #define add_typename_inner( type, name, text, longtext, advc ) \
340 add_typeadv_inner( type, text, longtext, advc ) \
341 vlc_config_set (VLC_CONFIG_NAME, (const char *)(name));
343 #define add_string_inner( type, name, text, longtext, advc, v ) \
344 add_typename_inner( type, name, text, longtext, advc ) \
345 vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v));
347 #define add_int_inner( type, name, text, longtext, advc, v ) \
348 add_typename_inner( type, name, text, longtext, advc ) \
349 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v));
352 #define set_category( i_id ) \
353 add_type_inner( CONFIG_CATEGORY ) \
354 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
356 #define set_subcategory( i_id ) \
357 add_type_inner( CONFIG_SUBCATEGORY ) \
358 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
360 #define set_section( text, longtext ) \
361 add_typedesc_inner( CONFIG_SECTION, text, longtext )
363 #define add_category_hint( text, longtext, advc ) \
364 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
366 #define add_subcategory_hint( text, longtext ) \
367 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
369 #define end_subcategory_hint \
370 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
372 #define add_usage_hint( text ) \
373 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
375 #define add_string( name, value, text, longtext, advc ) \
376 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
379 #define add_password( name, value, text, longtext, advc ) \
380 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
383 #define add_loadfile( name, value, text, longtext, advc ) \
384 add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
387 #define add_savefile( name, value, text, longtext, advc ) \
388 add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
391 #define add_directory( name, value, text, longtext, advc ) \
392 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
395 #define add_font( name, value, text, longtext, advc )\
396 add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
399 #define add_module( name, psz_caps, value, text, longtext, advc ) \
400 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
402 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
404 #define add_module_list( name, psz_caps, value, text, longtext, advc ) \
405 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
407 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
410 #define add_module_cat( name, i_subcategory, value, text, longtext, advc ) \
411 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
413 change_integer_range (i_subcategory /* gruik */, 0);
415 #define add_module_list_cat( name, i_subcategory, value, text, longtext, advc ) \
416 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
418 change_integer_range (i_subcategory /* gruik */, 0);
421 #define add_integer( name, value, text, longtext, advc ) \
422 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
424 #define add_rgb( name, value, text, longtext, advc ) \
425 add_int_inner( CONFIG_ITEM_RGB, name, text, longtext, advc, value ) \
426 change_integer_range( 0, 0xFFFFFF )
428 #define add_key( name, value, text, longtext, advc ) \
429 add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
431 add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value )
433 #define add_integer_with_range( name, value, i_min, i_max, text, longtext, advc ) \
434 add_integer( name, value, text, longtext, advc ) \
435 change_integer_range( i_min, i_max )
437 #define add_float( name, v, text, longtext, advc ) \
438 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
439 vlc_config_set (VLC_CONFIG_VALUE, (double)(v));
441 #define add_float_with_range( name, value, f_min, f_max, text, longtext, advc ) \
442 add_float( name, value, text, longtext, advc ) \
443 change_float_range( f_min, f_max )
445 #define add_bool( name, v, text, longtext, advc ) \
446 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
447 if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true);
449 /* For removed option */
450 #define add_obsolete_inner( name, type ) \
451 add_type_inner( type ) \
452 vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); \
453 vlc_config_set (VLC_CONFIG_REMOVED);
455 #define add_obsolete_bool( name ) \
456 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
458 #define add_obsolete_integer( name ) \
459 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
461 #define add_obsolete_float( name ) \
462 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
464 #define add_obsolete_string( name ) \
465 add_obsolete_inner( name, CONFIG_ITEM_STRING )
467 /* Modifier macros for the config options (used for fine tuning) */
469 #define change_short( ch ) \
470 vlc_config_set (VLC_CONFIG_SHORTCUT, (int)(ch));
472 #define change_string_list( list, list_text ) \
473 vlc_config_set (VLC_CONFIG_LIST, \
474 (size_t)(sizeof (list) / sizeof (char *)), \
475 (const char *const *)(list), \
476 (const char *const *)(list_text), \
477 (vlc_callback_t)NULL);
479 #define change_string_cb( cb ) \
480 vlc_config_set (VLC_CONFIG_LIST, 0, NULL, NULL, (vlc_callback_t)(cb));
482 #define change_integer_list( list, list_text ) \
483 vlc_config_set (VLC_CONFIG_LIST, \
484 (size_t)(sizeof (list) / sizeof (int)), \
485 (const int *)(list), \
486 (const char *const *)(list_text), \
487 (vlc_callback_t)(NULL));
489 #define change_integer_range( minv, maxv ) \
490 vlc_config_set (VLC_CONFIG_RANGE, (int64_t)(minv), (int64_t)(maxv));
492 #define change_float_range( minv, maxv ) \
493 vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv));
495 #define change_action_add( pf_action, text ) \
496 (void)(pf_action, text);
498 /* For options that are saved but hidden from the preferences panel */
499 #define change_private() \
500 vlc_config_set (VLC_CONFIG_PRIVATE);
502 /* For options that cannot be saved in the configuration */
503 #define change_volatile() \
505 vlc_config_set (VLC_CONFIG_VOLATILE);
507 #define change_safe() \
508 vlc_config_set (VLC_CONFIG_SAFE);
510 /* Meta data plugin exports */
511 #define VLC_META_EXPORT( name, value ) \
512 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
513 __VLC_SYMBOL(vlc_entry_ ## name) (void); \
514 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
515 __VLC_SYMBOL(vlc_entry_ ## name) (void) \
520 #if defined (__LIBVLC__)
521 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
522 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
523 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
524 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
525 "\x6c\x6f\x70\x65\x72\x73" )
526 #elif !defined (VLC_COPYRIGHT_EXPORT)
527 # define VLC_COPYRIGHT_EXPORT
529 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
530 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
531 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
532 "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
533 "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
534 "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
536 #define VLC_METADATA_EXPORTS \
537 VLC_COPYRIGHT_EXPORT \