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,
99 /* add value change callback
100 * (args=const char *, vlc_callback_t, const char *) */
102 /* Insert new VLC_CONFIG_* here */
105 /* Configuration hint types */
106 #define CONFIG_HINT_CATEGORY 0x02 /* Start of new category */
107 #define CONFIG_HINT_SUBCATEGORY 0x03 /* Start of sub-category */
108 #define CONFIG_HINT_SUBCATEGORY_END 0x04 /* End of sub-category */
109 #define CONFIG_HINT_USAGE 0x05 /* Usage information */
111 #define CONFIG_CATEGORY 0x06 /* Set category */
112 #define CONFIG_SUBCATEGORY 0x07 /* Set subcategory */
113 #define CONFIG_SECTION 0x08 /* Start of new section */
115 /* Configuration item types */
116 #define CONFIG_ITEM_FLOAT 0x20 /* Float option */
117 #define CONFIG_ITEM_INTEGER 0x40 /* Integer option */
118 #define CONFIG_ITEM_RGB 0x41 /* RGB color option */
119 #define CONFIG_ITEM_BOOL 0x60 /* Bool option */
120 #define CONFIG_ITEM_STRING 0x80 /* String option */
121 #define CONFIG_ITEM_PASSWORD 0x81 /* Password option (*) */
122 #define CONFIG_ITEM_KEY 0x82 /* Hot key option */
123 #define CONFIG_ITEM_MODULE 0x84 /* Module option */
124 #define CONFIG_ITEM_MODULE_CAT 0x85 /* Module option */
125 #define CONFIG_ITEM_MODULE_LIST 0x86 /* Module option */
126 #define CONFIG_ITEM_MODULE_LIST_CAT 0x87 /* Module option */
127 #define CONFIG_ITEM_LOADFILE 0x8C /* Read file option */
128 #define CONFIG_ITEM_SAVEFILE 0x8D /* Written file option */
129 #define CONFIG_ITEM_DIRECTORY 0x8E /* Directory option */
130 #define CONFIG_ITEM_FONT 0x8F /* Font option */
132 #define CONFIG_ITEM(x) (((x) & ~0xF) != 0)
134 /* Categories and subcategories */
135 #define CAT_INTERFACE 1
136 #define SUBCAT_INTERFACE_GENERAL 101
137 #define SUBCAT_INTERFACE_MAIN 102
138 #define SUBCAT_INTERFACE_CONTROL 103
139 #define SUBCAT_INTERFACE_HOTKEYS 104
142 #define SUBCAT_AUDIO_GENERAL 201
143 #define SUBCAT_AUDIO_AOUT 202
144 #define SUBCAT_AUDIO_AFILTER 203
145 #define SUBCAT_AUDIO_VISUAL 204
146 #define SUBCAT_AUDIO_MISC 205
149 #define SUBCAT_VIDEO_GENERAL 301
150 #define SUBCAT_VIDEO_VOUT 302
151 #define SUBCAT_VIDEO_VFILTER 303
152 #define SUBCAT_VIDEO_TEXT 304
153 #define SUBCAT_VIDEO_SUBPIC 305
154 #define SUBCAT_VIDEO_VFILTER2 306
157 #define SUBCAT_INPUT_GENERAL 401
158 #define SUBCAT_INPUT_ACCESS 402
159 #define SUBCAT_INPUT_DEMUX 403
160 #define SUBCAT_INPUT_VCODEC 404
161 #define SUBCAT_INPUT_ACODEC 405
162 #define SUBCAT_INPUT_SCODEC 406
163 #define SUBCAT_INPUT_STREAM_FILTER 407
166 #define SUBCAT_SOUT_GENERAL 501
167 #define SUBCAT_SOUT_STREAM 502
168 #define SUBCAT_SOUT_MUX 503
169 #define SUBCAT_SOUT_ACO 504
170 #define SUBCAT_SOUT_PACKETIZER 505
171 #define SUBCAT_SOUT_SAP 506
172 #define SUBCAT_SOUT_VOD 507
174 #define CAT_ADVANCED 6
175 #define SUBCAT_ADVANCED_CPU 601
176 #define SUBCAT_ADVANCED_MISC 602
177 #define SUBCAT_ADVANCED_NETWORK 603
178 #define SUBCAT_ADVANCED_XML 604
180 #define CAT_PLAYLIST 7
181 #define SUBCAT_PLAYLIST_GENERAL 701
182 #define SUBCAT_PLAYLIST_SD 702
183 #define SUBCAT_PLAYLIST_EXPORT 703
186 #define SUBCAT_OSD_IMPORT 801
190 * Current plugin ABI version
192 # define MODULE_SYMBOL 2_1_0a
193 # define MODULE_SUFFIX "__2_1_0a"
195 /*****************************************************************************
196 * Add a few defines. You do not want to read this section. Really.
197 *****************************************************************************/
201 * if linking a module statically, we will need:
202 * #define MODULE_FUNC( zog ) module_foo_zog
204 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
207 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
208 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
209 #define CRUDE_HACK( y, z ) y##__##z
211 /* If the module is built-in, then we need to define foo_InitModule instead
212 * of InitModule. Same for Activate- and DeactivateModule. */
214 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
216 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
220 #if defined (__PLUGIN__)
222 # define DLL_SYMBOL __declspec(dllexport)
224 # define CDECL_SYMBOL __cdecl
225 # elif VLC_GCC_VERSION(4,0)
226 # define DLL_SYMBOL __attribute__((visibility("default")))
234 #if defined( __cplusplus )
235 # define EXTERN_SYMBOL extern "C"
237 # define EXTERN_SYMBOL
240 typedef int (*vlc_set_cb) (void *, void *, int, ...);
242 #define vlc_plugin_set(...) vlc_set (opaque, NULL, __VA_ARGS__)
243 #define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__)
244 #define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__)
247 * InitModule: this function is called once and only once, when the module
248 * is looked at for the first time. We get the useful data from it, for
249 * instance the module name, its shortcuts, its capabilities... we also create
250 * a copy of its config because the module can be unloaded at any time.
252 #define vlc_module_begin() \
253 EXTERN_SYMBOL DLL_SYMBOL \
254 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb, void *); \
255 EXTERN_SYMBOL DLL_SYMBOL \
256 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb vlc_set, void *opaque) \
259 module_config_t *config = NULL; \
260 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
262 if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \
265 #define vlc_module_end() \
273 #define add_submodule( ) \
274 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
277 #define add_shortcut( ... ) \
279 const char *shortcuts[] = { __VA_ARGS__ }; \
280 if (vlc_module_set (VLC_MODULE_SHORTCUT, \
281 sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
285 #define set_shortname( shortname ) \
286 if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \
289 #define set_description( desc ) \
290 if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \
293 #define set_help( help ) \
294 if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \
297 #define set_capability( cap, score ) \
298 if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \
299 || vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \
302 #define set_callbacks( activate, deactivate ) \
303 if (vlc_module_set (VLC_MODULE_CB_OPEN, activate) \
304 || vlc_module_set (VLC_MODULE_CB_CLOSE, deactivate)) \
307 #define cannot_unload_broken_library( ) \
308 if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
311 #define set_text_domain( dom ) \
312 if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \
315 /*****************************************************************************
316 * Macros used to build the configuration structure.
318 * Note that internally we support only 3 types of config data: int, float
320 * The other types declared here just map to one of these 3 basic types but
321 * have the advantage of also providing very good hints to a configuration
322 * interface so as to make it more user friendly.
323 * The configuration structure also includes category hints. These hints can
324 * provide a configuration interface with some very useful data and again
325 * allow for a more user friendly interface.
326 *****************************************************************************/
328 #define add_type_inner( type ) \
329 vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config);
331 #define add_typedesc_inner( type, text, longtext ) \
332 add_type_inner( type ) \
333 vlc_config_set (VLC_CONFIG_DESC, \
334 (const char *)(text), (const char *)(longtext));
336 #define add_typeadv_inner( type, text, longtext, advc ) \
337 add_typedesc_inner( type, text, longtext ) \
338 if (advc) vlc_config_set (VLC_CONFIG_ADVANCED);
340 #define add_typename_inner( type, name, text, longtext, advc ) \
341 add_typeadv_inner( type, text, longtext, advc ) \
342 vlc_config_set (VLC_CONFIG_NAME, (const char *)(name));
344 #define add_string_inner( type, name, text, longtext, advc, v ) \
345 add_typename_inner( type, name, text, longtext, advc ) \
346 vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v));
348 #define add_int_inner( type, name, text, longtext, advc, v ) \
349 add_typename_inner( type, name, text, longtext, advc ) \
350 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v));
353 #define set_category( i_id ) \
354 add_type_inner( CONFIG_CATEGORY ) \
355 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
357 #define set_subcategory( i_id ) \
358 add_type_inner( CONFIG_SUBCATEGORY ) \
359 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
361 #define set_section( text, longtext ) \
362 add_typedesc_inner( CONFIG_SECTION, text, longtext )
364 #define add_category_hint( text, longtext, advc ) \
365 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
367 #define add_subcategory_hint( text, longtext ) \
368 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
370 #define end_subcategory_hint \
371 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
373 #define add_usage_hint( text ) \
374 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
376 #define add_string( name, value, text, longtext, advc ) \
377 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
380 #define add_password( name, value, text, longtext, advc ) \
381 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
384 #define add_loadfile( name, value, text, longtext, advc ) \
385 add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
388 #define add_savefile( name, value, text, longtext, advc ) \
389 add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
392 #define add_directory( name, value, text, longtext, advc ) \
393 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
396 #define add_font( name, value, text, longtext, advc )\
397 add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
400 #define add_module( name, psz_caps, value, text, longtext, advc ) \
401 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
403 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
405 #define add_module_list( name, psz_caps, value, text, longtext, advc ) \
406 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
408 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
411 #define add_module_cat( name, i_subcategory, value, text, longtext, advc ) \
412 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
414 change_integer_range (i_subcategory /* gruik */, 0);
416 #define add_module_list_cat( name, i_subcategory, value, text, longtext, advc ) \
417 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
419 change_integer_range (i_subcategory /* gruik */, 0);
422 #define add_integer( name, value, text, longtext, advc ) \
423 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
425 #define add_rgb( name, value, text, longtext, advc ) \
426 add_int_inner( CONFIG_ITEM_RGB, name, text, longtext, advc, value ) \
427 change_integer_range( 0, 0xFFFFFF )
429 #define add_key( name, value, text, longtext, advc ) \
430 add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
432 add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value )
434 #define add_integer_with_range( name, value, i_min, i_max, text, longtext, advc ) \
435 add_integer( name, value, text, longtext, advc ) \
436 change_integer_range( i_min, i_max )
438 #define add_float( name, v, text, longtext, advc ) \
439 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
440 vlc_config_set (VLC_CONFIG_VALUE, (double)(v));
442 #define add_float_with_range( name, value, f_min, f_max, text, longtext, advc ) \
443 add_float( name, value, text, longtext, advc ) \
444 change_float_range( f_min, f_max )
446 #define add_bool( name, v, text, longtext, advc ) \
447 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
448 if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true);
450 /* For removed option */
451 #define add_obsolete_inner( name, type ) \
452 add_type_inner( type ) \
453 vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); \
454 vlc_config_set (VLC_CONFIG_REMOVED);
456 #define add_obsolete_bool( name ) \
457 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
459 #define add_obsolete_integer( name ) \
460 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
462 #define add_obsolete_float( name ) \
463 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
465 #define add_obsolete_string( name ) \
466 add_obsolete_inner( name, CONFIG_ITEM_STRING )
468 /* Modifier macros for the config options (used for fine tuning) */
470 #define change_short( ch ) \
471 vlc_config_set (VLC_CONFIG_SHORTCUT, (int)(ch));
473 #define change_string_list( list, list_text, list_update_func ) \
474 vlc_config_set (VLC_CONFIG_LIST, \
475 (size_t)(sizeof (list) / sizeof (char *)), \
476 (const char *const *)(list), \
477 (const char *const *)(list_text), \
478 (vlc_callback_t)(list_update_func));
480 #define change_integer_list( list, list_text ) \
481 vlc_config_set (VLC_CONFIG_LIST, \
482 (size_t)(sizeof (list) / sizeof (int)), \
483 (const int *)(list), \
484 (const char *const *)(list_text), \
485 (vlc_callback_t)(NULL));
487 #define change_integer_range( minv, maxv ) \
488 vlc_config_set (VLC_CONFIG_RANGE, (int64_t)(minv), (int64_t)(maxv));
490 #define change_float_range( minv, maxv ) \
491 vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv));
493 #define change_action_add( pf_action, text ) \
494 vlc_config_set (VLC_CONFIG_ADD_ACTION, \
495 (vlc_callback_t)(pf_action), (const char *)(text));
497 /* For options that are saved but hidden from the preferences panel */
498 #define change_private() \
499 vlc_config_set (VLC_CONFIG_PRIVATE);
501 /* For options that cannot be saved in the configuration */
502 #define change_volatile() \
504 vlc_config_set (VLC_CONFIG_VOLATILE);
506 #define change_safe() \
507 vlc_config_set (VLC_CONFIG_SAFE);
509 /* Meta data plugin exports */
510 #define VLC_META_EXPORT( name, value ) \
511 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
512 __VLC_SYMBOL(vlc_entry_ ## name) (void); \
513 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
514 __VLC_SYMBOL(vlc_entry_ ## name) (void) \
519 #if defined (__LIBVLC__)
520 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
521 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
522 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
523 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
524 "\x6c\x6f\x70\x65\x72\x73" )
525 #elif !defined (VLC_COPYRIGHT_EXPORT)
526 # define VLC_COPYRIGHT_EXPORT
528 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
529 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
530 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
531 "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
532 "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
533 "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
535 #define VLC_METADATA_EXPORTS \
536 VLC_COPYRIGHT_EXPORT \