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 *) */
94 VLC_CONFIG_LIST_OBSOLETE,
95 /* unused (ignored) */
97 VLC_CONFIG_ADD_ACTION_OBSOLETE,
98 /* unused (ignored) */
101 /* list of suggested values
102 * (args=size_t, const <type> *, const char *const *) */
105 /* callback for suggested values
106 * (args=size_t (*)(vlc_object_t *, <type> **, char ***)) */
108 /* Insert new VLC_CONFIG_* here */
111 /* Configuration hint types */
112 #define CONFIG_HINT_CATEGORY 0x02 /* Start of new category */
113 #define CONFIG_HINT_SUBCATEGORY 0x03 /* Start of sub-category */
114 #define CONFIG_HINT_SUBCATEGORY_END 0x04 /* End of sub-category */
115 #define CONFIG_HINT_USAGE 0x05 /* Usage information */
117 #define CONFIG_CATEGORY 0x06 /* Set category */
118 #define CONFIG_SUBCATEGORY 0x07 /* Set subcategory */
119 #define CONFIG_SECTION 0x08 /* Start of new section */
121 /* Configuration item types */
122 #define CONFIG_ITEM_FLOAT 0x20 /* Float option */
123 #define CONFIG_ITEM_INTEGER 0x40 /* Integer option */
124 #define CONFIG_ITEM_RGB 0x41 /* RGB color option */
125 #define CONFIG_ITEM_BOOL 0x60 /* Bool option */
126 #define CONFIG_ITEM_STRING 0x80 /* String option */
127 #define CONFIG_ITEM_PASSWORD 0x81 /* Password option (*) */
128 #define CONFIG_ITEM_KEY 0x82 /* Hot key option */
129 #define CONFIG_ITEM_MODULE 0x84 /* Module option */
130 #define CONFIG_ITEM_MODULE_CAT 0x85 /* Module option */
131 #define CONFIG_ITEM_MODULE_LIST 0x86 /* Module option */
132 #define CONFIG_ITEM_MODULE_LIST_CAT 0x87 /* Module option */
133 #define CONFIG_ITEM_LOADFILE 0x8C /* Read file option */
134 #define CONFIG_ITEM_SAVEFILE 0x8D /* Written file option */
135 #define CONFIG_ITEM_DIRECTORY 0x8E /* Directory option */
136 #define CONFIG_ITEM_FONT 0x8F /* Font option */
138 #define CONFIG_ITEM(x) (((x) & ~0xF) != 0)
140 /* Categories and subcategories */
141 #define CAT_INTERFACE 1
142 #define SUBCAT_INTERFACE_GENERAL 101
143 #define SUBCAT_INTERFACE_MAIN 102
144 #define SUBCAT_INTERFACE_CONTROL 103
145 #define SUBCAT_INTERFACE_HOTKEYS 104
148 #define SUBCAT_AUDIO_GENERAL 201
149 #define SUBCAT_AUDIO_AOUT 202
150 #define SUBCAT_AUDIO_AFILTER 203
151 #define SUBCAT_AUDIO_VISUAL 204
152 #define SUBCAT_AUDIO_MISC 205
155 #define SUBCAT_VIDEO_GENERAL 301
156 #define SUBCAT_VIDEO_VOUT 302
157 #define SUBCAT_VIDEO_VFILTER 303
158 #define SUBCAT_VIDEO_TEXT 304
159 #define SUBCAT_VIDEO_SUBPIC 305
160 #define SUBCAT_VIDEO_VFILTER2 306
163 #define SUBCAT_INPUT_GENERAL 401
164 #define SUBCAT_INPUT_ACCESS 402
165 #define SUBCAT_INPUT_DEMUX 403
166 #define SUBCAT_INPUT_VCODEC 404
167 #define SUBCAT_INPUT_ACODEC 405
168 #define SUBCAT_INPUT_SCODEC 406
169 #define SUBCAT_INPUT_STREAM_FILTER 407
172 #define SUBCAT_SOUT_GENERAL 501
173 #define SUBCAT_SOUT_STREAM 502
174 #define SUBCAT_SOUT_MUX 503
175 #define SUBCAT_SOUT_ACO 504
176 #define SUBCAT_SOUT_PACKETIZER 505
177 #define SUBCAT_SOUT_SAP 506
178 #define SUBCAT_SOUT_VOD 507
180 #define CAT_ADVANCED 6
181 #define SUBCAT_ADVANCED_CPU 601
182 #define SUBCAT_ADVANCED_MISC 602
183 #define SUBCAT_ADVANCED_NETWORK 603
184 #define SUBCAT_ADVANCED_XML 604
186 #define CAT_PLAYLIST 7
187 #define SUBCAT_PLAYLIST_GENERAL 701
188 #define SUBCAT_PLAYLIST_SD 702
189 #define SUBCAT_PLAYLIST_EXPORT 703
192 #define SUBCAT_OSD_IMPORT 801
196 * Current plugin ABI version
198 # define MODULE_SYMBOL 2_1_0a
199 # define MODULE_SUFFIX "__2_1_0a"
201 /*****************************************************************************
202 * Add a few defines. You do not want to read this section. Really.
203 *****************************************************************************/
207 * if linking a module statically, we will need:
208 * #define MODULE_FUNC( zog ) module_foo_zog
210 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
213 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
214 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
215 #define CRUDE_HACK( y, z ) y##__##z
217 /* If the module is built-in, then we need to define foo_InitModule instead
218 * of InitModule. Same for Activate- and DeactivateModule. */
220 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
222 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
226 #if defined (__PLUGIN__)
228 # define DLL_SYMBOL __declspec(dllexport)
230 # define CDECL_SYMBOL __cdecl
231 # elif VLC_GCC_VERSION(4,0)
232 # define DLL_SYMBOL __attribute__((visibility("default")))
240 #if defined( __cplusplus )
241 # define EXTERN_SYMBOL extern "C"
243 # define EXTERN_SYMBOL
246 typedef int (*vlc_set_cb) (void *, void *, int, ...);
248 #define vlc_plugin_set(...) vlc_set (opaque, NULL, __VA_ARGS__)
249 #define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__)
250 #define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__)
253 * InitModule: this function is called once and only once, when the module
254 * is looked at for the first time. We get the useful data from it, for
255 * instance the module name, its shortcuts, its capabilities... we also create
256 * a copy of its config because the module can be unloaded at any time.
258 #define vlc_module_begin() \
259 EXTERN_SYMBOL DLL_SYMBOL \
260 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb, void *); \
261 EXTERN_SYMBOL DLL_SYMBOL \
262 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb vlc_set, void *opaque) \
265 module_config_t *config = NULL; \
266 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
268 if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \
271 #define vlc_module_end() \
279 #define add_submodule( ) \
280 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
283 #define add_shortcut( ... ) \
285 const char *shortcuts[] = { __VA_ARGS__ }; \
286 if (vlc_module_set (VLC_MODULE_SHORTCUT, \
287 sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
291 #define set_shortname( shortname ) \
292 if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \
295 #define set_description( desc ) \
296 if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \
299 #define set_help( help ) \
300 if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \
303 #define set_capability( cap, score ) \
304 if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \
305 || vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \
308 #define set_callbacks( activate, deactivate ) \
309 if (vlc_module_set (VLC_MODULE_CB_OPEN, activate) \
310 || vlc_module_set (VLC_MODULE_CB_CLOSE, deactivate)) \
313 #define cannot_unload_broken_library( ) \
314 if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
317 #define set_text_domain( dom ) \
318 if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \
321 /*****************************************************************************
322 * Macros used to build the configuration structure.
324 * Note that internally we support only 3 types of config data: int, float
326 * The other types declared here just map to one of these 3 basic types but
327 * have the advantage of also providing very good hints to a configuration
328 * interface so as to make it more user friendly.
329 * The configuration structure also includes category hints. These hints can
330 * provide a configuration interface with some very useful data and again
331 * allow for a more user friendly interface.
332 *****************************************************************************/
334 #define add_type_inner( type ) \
335 vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config);
337 #define add_typedesc_inner( type, text, longtext ) \
338 add_type_inner( type ) \
339 vlc_config_set (VLC_CONFIG_DESC, \
340 (const char *)(text), (const char *)(longtext));
342 #define add_typeadv_inner( type, text, longtext, advc ) \
343 add_typedesc_inner( type, text, longtext ) \
344 if (advc) vlc_config_set (VLC_CONFIG_ADVANCED);
346 #define add_typename_inner( type, name, text, longtext, advc ) \
347 add_typeadv_inner( type, text, longtext, advc ) \
348 vlc_config_set (VLC_CONFIG_NAME, (const char *)(name));
350 #define add_string_inner( type, name, text, longtext, advc, v ) \
351 add_typename_inner( type, name, text, longtext, advc ) \
352 vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v));
354 #define add_int_inner( type, name, text, longtext, advc, v ) \
355 add_typename_inner( type, name, text, longtext, advc ) \
356 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v));
359 #define set_category( i_id ) \
360 add_type_inner( CONFIG_CATEGORY ) \
361 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
363 #define set_subcategory( i_id ) \
364 add_type_inner( CONFIG_SUBCATEGORY ) \
365 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
367 #define set_section( text, longtext ) \
368 add_typedesc_inner( CONFIG_SECTION, text, longtext )
370 #define add_category_hint( text, longtext, advc ) \
371 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
373 #define add_subcategory_hint( text, longtext ) \
374 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
376 #define end_subcategory_hint \
377 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
379 #define add_usage_hint( text ) \
380 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
382 #define add_string( name, value, text, longtext, advc ) \
383 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
386 #define add_password( name, value, text, longtext, advc ) \
387 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
390 #define add_loadfile( name, value, text, longtext, advc ) \
391 add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
394 #define add_savefile( name, value, text, longtext, advc ) \
395 add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
398 #define add_directory( name, value, text, longtext, advc ) \
399 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
402 #define add_font( name, value, text, longtext, advc )\
403 add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
406 #define add_module( name, psz_caps, value, text, longtext, advc ) \
407 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
409 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
411 #define add_module_list( name, psz_caps, value, text, longtext, advc ) \
412 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
414 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
417 #define add_module_cat( name, i_subcategory, value, text, longtext, advc ) \
418 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
420 change_integer_range (i_subcategory /* gruik */, 0);
422 #define add_module_list_cat( name, i_subcategory, value, text, longtext, advc ) \
423 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
425 change_integer_range (i_subcategory /* gruik */, 0);
428 #define add_integer( name, value, text, longtext, advc ) \
429 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
431 #define add_rgb( name, value, text, longtext, advc ) \
432 add_int_inner( CONFIG_ITEM_RGB, name, text, longtext, advc, value ) \
433 change_integer_range( 0, 0xFFFFFF )
435 #define add_key( name, value, text, longtext, advc ) \
436 add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
438 add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value )
440 #define add_integer_with_range( name, value, i_min, i_max, text, longtext, advc ) \
441 add_integer( name, value, text, longtext, advc ) \
442 change_integer_range( i_min, i_max )
444 #define add_float( name, v, text, longtext, advc ) \
445 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
446 vlc_config_set (VLC_CONFIG_VALUE, (double)(v));
448 #define add_float_with_range( name, value, f_min, f_max, text, longtext, advc ) \
449 add_float( name, value, text, longtext, advc ) \
450 change_float_range( f_min, f_max )
452 #define add_bool( name, v, text, longtext, advc ) \
453 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
454 if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true);
456 /* For removed option */
457 #define add_obsolete_inner( name, type ) \
458 add_type_inner( type ) \
459 vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); \
460 vlc_config_set (VLC_CONFIG_REMOVED);
462 #define add_obsolete_bool( name ) \
463 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
465 #define add_obsolete_integer( name ) \
466 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
468 #define add_obsolete_float( name ) \
469 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
471 #define add_obsolete_string( name ) \
472 add_obsolete_inner( name, CONFIG_ITEM_STRING )
474 /* Modifier macros for the config options (used for fine tuning) */
476 #define change_short( ch ) \
477 vlc_config_set (VLC_CONFIG_SHORTCUT, (int)(ch));
479 #define change_string_list( list, list_text ) \
480 vlc_config_set (VLC_CONFIG_LIST, \
481 (size_t)(sizeof (list) / sizeof (char *)), \
482 (const char *const *)(list), \
483 (const char *const *)(list_text));
485 #define change_string_cb( cb ) \
486 vlc_config_set (VLC_CONFIG_LIST_CB, (cb));
488 #define change_integer_list( list, list_text ) \
489 vlc_config_set (VLC_CONFIG_LIST, \
490 (size_t)(sizeof (list) / sizeof (int)), \
491 (const int *)(list), \
492 (const char *const *)(list_text));
494 #define change_integer_cb( cb ) \
495 vlc_config_set (VLC_CONFIG_LIST_CB, (cb));
497 #define change_integer_range( minv, maxv ) \
498 vlc_config_set (VLC_CONFIG_RANGE, (int64_t)(minv), (int64_t)(maxv));
500 #define change_float_range( minv, maxv ) \
501 vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv));
503 #define change_action_add( pf_action, text ) \
504 (void)(pf_action, text);
506 /* For options that are saved but hidden from the preferences panel */
507 #define change_private() \
508 vlc_config_set (VLC_CONFIG_PRIVATE);
510 /* For options that cannot be saved in the configuration */
511 #define change_volatile() \
513 vlc_config_set (VLC_CONFIG_VOLATILE);
515 #define change_safe() \
516 vlc_config_set (VLC_CONFIG_SAFE);
518 /* Meta data plugin exports */
519 #define VLC_META_EXPORT( name, value ) \
520 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
521 __VLC_SYMBOL(vlc_entry_ ## name) (void); \
522 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
523 __VLC_SYMBOL(vlc_entry_ ## name) (void) \
528 #if defined (__LIBVLC__)
529 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
530 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
531 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
532 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
533 "\x6c\x6f\x70\x65\x72\x73" )
534 #elif !defined (VLC_COPYRIGHT_EXPORT)
535 # define VLC_COPYRIGHT_EXPORT
537 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
538 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
539 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
540 "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
541 "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
542 "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
544 #define VLC_METADATA_EXPORTS \
545 VLC_COPYRIGHT_EXPORT \