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 (args=size_t (*)(<type> **, char ***)) */
107 /* Insert new VLC_CONFIG_* here */
110 /* Configuration hint types */
111 #define CONFIG_HINT_CATEGORY 0x02 /* Start of new category */
112 #define CONFIG_HINT_SUBCATEGORY 0x03 /* Start of sub-category */
113 #define CONFIG_HINT_SUBCATEGORY_END 0x04 /* End of sub-category */
114 #define CONFIG_HINT_USAGE 0x05 /* Usage information */
116 #define CONFIG_CATEGORY 0x06 /* Set category */
117 #define CONFIG_SUBCATEGORY 0x07 /* Set subcategory */
118 #define CONFIG_SECTION 0x08 /* Start of new section */
120 /* Configuration item types */
121 #define CONFIG_ITEM_FLOAT 0x20 /* Float option */
122 #define CONFIG_ITEM_INTEGER 0x40 /* Integer option */
123 #define CONFIG_ITEM_RGB 0x41 /* RGB color option */
124 #define CONFIG_ITEM_BOOL 0x60 /* Bool option */
125 #define CONFIG_ITEM_STRING 0x80 /* String option */
126 #define CONFIG_ITEM_PASSWORD 0x81 /* Password option (*) */
127 #define CONFIG_ITEM_KEY 0x82 /* Hot key option */
128 #define CONFIG_ITEM_MODULE 0x84 /* Module option */
129 #define CONFIG_ITEM_MODULE_CAT 0x85 /* Module option */
130 #define CONFIG_ITEM_MODULE_LIST 0x86 /* Module option */
131 #define CONFIG_ITEM_MODULE_LIST_CAT 0x87 /* Module option */
132 #define CONFIG_ITEM_LOADFILE 0x8C /* Read file option */
133 #define CONFIG_ITEM_SAVEFILE 0x8D /* Written file option */
134 #define CONFIG_ITEM_DIRECTORY 0x8E /* Directory option */
135 #define CONFIG_ITEM_FONT 0x8F /* Font option */
137 #define CONFIG_ITEM(x) (((x) & ~0xF) != 0)
139 /* Categories and subcategories */
140 #define CAT_INTERFACE 1
141 #define SUBCAT_INTERFACE_GENERAL 101
142 #define SUBCAT_INTERFACE_MAIN 102
143 #define SUBCAT_INTERFACE_CONTROL 103
144 #define SUBCAT_INTERFACE_HOTKEYS 104
147 #define SUBCAT_AUDIO_GENERAL 201
148 #define SUBCAT_AUDIO_AOUT 202
149 #define SUBCAT_AUDIO_AFILTER 203
150 #define SUBCAT_AUDIO_VISUAL 204
151 #define SUBCAT_AUDIO_MISC 205
154 #define SUBCAT_VIDEO_GENERAL 301
155 #define SUBCAT_VIDEO_VOUT 302
156 #define SUBCAT_VIDEO_VFILTER 303
157 #define SUBCAT_VIDEO_TEXT 304
158 #define SUBCAT_VIDEO_SUBPIC 305
159 #define SUBCAT_VIDEO_VFILTER2 306
162 #define SUBCAT_INPUT_GENERAL 401
163 #define SUBCAT_INPUT_ACCESS 402
164 #define SUBCAT_INPUT_DEMUX 403
165 #define SUBCAT_INPUT_VCODEC 404
166 #define SUBCAT_INPUT_ACODEC 405
167 #define SUBCAT_INPUT_SCODEC 406
168 #define SUBCAT_INPUT_STREAM_FILTER 407
171 #define SUBCAT_SOUT_GENERAL 501
172 #define SUBCAT_SOUT_STREAM 502
173 #define SUBCAT_SOUT_MUX 503
174 #define SUBCAT_SOUT_ACO 504
175 #define SUBCAT_SOUT_PACKETIZER 505
176 #define SUBCAT_SOUT_SAP 506
177 #define SUBCAT_SOUT_VOD 507
179 #define CAT_ADVANCED 6
180 #define SUBCAT_ADVANCED_CPU 601
181 #define SUBCAT_ADVANCED_MISC 602
182 #define SUBCAT_ADVANCED_NETWORK 603
183 #define SUBCAT_ADVANCED_XML 604
185 #define CAT_PLAYLIST 7
186 #define SUBCAT_PLAYLIST_GENERAL 701
187 #define SUBCAT_PLAYLIST_SD 702
188 #define SUBCAT_PLAYLIST_EXPORT 703
191 #define SUBCAT_OSD_IMPORT 801
195 * Current plugin ABI version
197 # define MODULE_SYMBOL 2_1_0a
198 # define MODULE_SUFFIX "__2_1_0a"
200 /*****************************************************************************
201 * Add a few defines. You do not want to read this section. Really.
202 *****************************************************************************/
206 * if linking a module statically, we will need:
207 * #define MODULE_FUNC( zog ) module_foo_zog
209 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
212 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
213 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
214 #define CRUDE_HACK( y, z ) y##__##z
216 /* If the module is built-in, then we need to define foo_InitModule instead
217 * of InitModule. Same for Activate- and DeactivateModule. */
219 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
221 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
225 #if defined (__PLUGIN__)
227 # define DLL_SYMBOL __declspec(dllexport)
229 # define CDECL_SYMBOL __cdecl
230 # elif VLC_GCC_VERSION(4,0)
231 # define DLL_SYMBOL __attribute__((visibility("default")))
239 #if defined( __cplusplus )
240 # define EXTERN_SYMBOL extern "C"
242 # define EXTERN_SYMBOL
245 typedef int (*vlc_set_cb) (void *, void *, int, ...);
247 #define vlc_plugin_set(...) vlc_set (opaque, NULL, __VA_ARGS__)
248 #define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__)
249 #define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__)
252 * InitModule: this function is called once and only once, when the module
253 * is looked at for the first time. We get the useful data from it, for
254 * instance the module name, its shortcuts, its capabilities... we also create
255 * a copy of its config because the module can be unloaded at any time.
257 #define vlc_module_begin() \
258 EXTERN_SYMBOL DLL_SYMBOL \
259 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb, void *); \
260 EXTERN_SYMBOL DLL_SYMBOL \
261 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb vlc_set, void *opaque) \
264 module_config_t *config = NULL; \
265 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
267 if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \
270 #define vlc_module_end() \
278 #define add_submodule( ) \
279 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
282 #define add_shortcut( ... ) \
284 const char *shortcuts[] = { __VA_ARGS__ }; \
285 if (vlc_module_set (VLC_MODULE_SHORTCUT, \
286 sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
290 #define set_shortname( shortname ) \
291 if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \
294 #define set_description( desc ) \
295 if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \
298 #define set_help( help ) \
299 if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \
302 #define set_capability( cap, score ) \
303 if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \
304 || vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \
307 #define set_callbacks( activate, deactivate ) \
308 if (vlc_module_set (VLC_MODULE_CB_OPEN, activate) \
309 || vlc_module_set (VLC_MODULE_CB_CLOSE, deactivate)) \
312 #define cannot_unload_broken_library( ) \
313 if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
316 #define set_text_domain( dom ) \
317 if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \
320 /*****************************************************************************
321 * Macros used to build the configuration structure.
323 * Note that internally we support only 3 types of config data: int, float
325 * The other types declared here just map to one of these 3 basic types but
326 * have the advantage of also providing very good hints to a configuration
327 * interface so as to make it more user friendly.
328 * The configuration structure also includes category hints. These hints can
329 * provide a configuration interface with some very useful data and again
330 * allow for a more user friendly interface.
331 *****************************************************************************/
333 #define add_type_inner( type ) \
334 vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config);
336 #define add_typedesc_inner( type, text, longtext ) \
337 add_type_inner( type ) \
338 vlc_config_set (VLC_CONFIG_DESC, \
339 (const char *)(text), (const char *)(longtext));
341 #define add_typeadv_inner( type, text, longtext, advc ) \
342 add_typedesc_inner( type, text, longtext ) \
343 if (advc) vlc_config_set (VLC_CONFIG_ADVANCED);
345 #define add_typename_inner( type, name, text, longtext, advc ) \
346 add_typeadv_inner( type, text, longtext, advc ) \
347 vlc_config_set (VLC_CONFIG_NAME, (const char *)(name));
349 #define add_string_inner( type, name, text, longtext, advc, v ) \
350 add_typename_inner( type, name, text, longtext, advc ) \
351 vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v));
353 #define add_int_inner( type, name, text, longtext, advc, v ) \
354 add_typename_inner( type, name, text, longtext, advc ) \
355 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v));
358 #define set_category( i_id ) \
359 add_type_inner( CONFIG_CATEGORY ) \
360 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
362 #define set_subcategory( i_id ) \
363 add_type_inner( CONFIG_SUBCATEGORY ) \
364 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
366 #define set_section( text, longtext ) \
367 add_typedesc_inner( CONFIG_SECTION, text, longtext )
369 #define add_category_hint( text, longtext, advc ) \
370 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
372 #define add_subcategory_hint( text, longtext ) \
373 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
375 #define end_subcategory_hint \
376 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
378 #define add_usage_hint( text ) \
379 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
381 #define add_string( name, value, text, longtext, advc ) \
382 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
385 #define add_password( name, value, text, longtext, advc ) \
386 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
389 #define add_loadfile( name, value, text, longtext, advc ) \
390 add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
393 #define add_savefile( name, value, text, longtext, advc ) \
394 add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
397 #define add_directory( name, value, text, longtext, advc ) \
398 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
401 #define add_font( name, value, text, longtext, advc )\
402 add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
405 #define add_module( name, psz_caps, value, text, longtext, advc ) \
406 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
408 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
410 #define add_module_list( name, psz_caps, value, text, longtext, advc ) \
411 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
413 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
416 #define add_module_cat( name, i_subcategory, value, text, longtext, advc ) \
417 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
419 change_integer_range (i_subcategory /* gruik */, 0);
421 #define add_module_list_cat( name, i_subcategory, value, text, longtext, advc ) \
422 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
424 change_integer_range (i_subcategory /* gruik */, 0);
427 #define add_integer( name, value, text, longtext, advc ) \
428 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
430 #define add_rgb( name, value, text, longtext, advc ) \
431 add_int_inner( CONFIG_ITEM_RGB, name, text, longtext, advc, value ) \
432 change_integer_range( 0, 0xFFFFFF )
434 #define add_key( name, value, text, longtext, advc ) \
435 add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
437 add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value )
439 #define add_integer_with_range( name, value, i_min, i_max, text, longtext, advc ) \
440 add_integer( name, value, text, longtext, advc ) \
441 change_integer_range( i_min, i_max )
443 #define add_float( name, v, text, longtext, advc ) \
444 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
445 vlc_config_set (VLC_CONFIG_VALUE, (double)(v));
447 #define add_float_with_range( name, value, f_min, f_max, text, longtext, advc ) \
448 add_float( name, value, text, longtext, advc ) \
449 change_float_range( f_min, f_max )
451 #define add_bool( name, v, text, longtext, advc ) \
452 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
453 if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true);
455 /* For removed option */
456 #define add_obsolete_inner( name, type ) \
457 add_type_inner( type ) \
458 vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); \
459 vlc_config_set (VLC_CONFIG_REMOVED);
461 #define add_obsolete_bool( name ) \
462 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
464 #define add_obsolete_integer( name ) \
465 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
467 #define add_obsolete_float( name ) \
468 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
470 #define add_obsolete_string( name ) \
471 add_obsolete_inner( name, CONFIG_ITEM_STRING )
473 /* Modifier macros for the config options (used for fine tuning) */
475 #define change_short( ch ) \
476 vlc_config_set (VLC_CONFIG_SHORTCUT, (int)(ch));
478 #define change_string_list( list, list_text ) \
479 vlc_config_set (VLC_CONFIG_LIST, \
480 (size_t)(sizeof (list) / sizeof (char *)), \
481 (const char *const *)(list), \
482 (const char *const *)(list_text));
484 #define change_string_cb( cb ) \
485 vlc_config_set (VLC_CONFIG_LIST_CB, (cb));
487 #define change_integer_list( list, list_text ) \
488 vlc_config_set (VLC_CONFIG_LIST, \
489 (size_t)(sizeof (list) / sizeof (int)), \
490 (const int *)(list), \
491 (const char *const *)(list_text));
493 #define change_integer_range( minv, maxv ) \
494 vlc_config_set (VLC_CONFIG_RANGE, (int64_t)(minv), (int64_t)(maxv));
496 #define change_float_range( minv, maxv ) \
497 vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv));
499 #define change_action_add( pf_action, text ) \
500 (void)(pf_action, text);
502 /* For options that are saved but hidden from the preferences panel */
503 #define change_private() \
504 vlc_config_set (VLC_CONFIG_PRIVATE);
506 /* For options that cannot be saved in the configuration */
507 #define change_volatile() \
509 vlc_config_set (VLC_CONFIG_VOLATILE);
511 #define change_safe() \
512 vlc_config_set (VLC_CONFIG_SAFE);
514 /* Meta data plugin exports */
515 #define VLC_META_EXPORT( name, value ) \
516 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
517 __VLC_SYMBOL(vlc_entry_ ## name) (void); \
518 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
519 __VLC_SYMBOL(vlc_entry_ ## name) (void) \
524 #if defined (__LIBVLC__)
525 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
526 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
527 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
528 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
529 "\x6c\x6f\x70\x65\x72\x73" )
530 #elif !defined (VLC_COPYRIGHT_EXPORT)
531 # define VLC_COPYRIGHT_EXPORT
533 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
534 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
535 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
536 "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
537 "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
538 "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
540 #define VLC_METADATA_EXPORTS \
541 VLC_COPYRIGHT_EXPORT \