24#ifndef LIBVLC_MODULES_MACROS_H
25# define LIBVLC_MODULES_MACROS_H 1
114#define CONFIG_HINT_CATEGORY 0x02
116#define CONFIG_SUBCATEGORY 0x07
117#define CONFIG_SECTION 0x08
120#define CONFIG_ITEM_FLOAT (1 << 5)
121#define CONFIG_ITEM_INTEGER (2 << 5)
122#define CONFIG_ITEM_RGB (CONFIG_ITEM_INTEGER | 0x01)
123#define CONFIG_ITEM_BOOL (3 << 5)
124#define CONFIG_ITEM_STRING (4 << 5)
125#define CONFIG_ITEM_PASSWORD (CONFIG_ITEM_STRING | 0x01)
126#define CONFIG_ITEM_KEY (CONFIG_ITEM_STRING | 0x02)
127#define CONFIG_ITEM_MODULE (CONFIG_ITEM_STRING | 0x04)
128#define CONFIG_ITEM_MODULE_CAT (CONFIG_ITEM_STRING | 0x05)
129#define CONFIG_ITEM_MODULE_LIST (CONFIG_ITEM_STRING | 0x06)
130#define CONFIG_ITEM_MODULE_LIST_CAT (CONFIG_ITEM_STRING | 0x07)
131#define CONFIG_ITEM_LOADFILE (CONFIG_ITEM_STRING | 0x0C)
132#define CONFIG_ITEM_SAVEFILE (CONFIG_ITEM_STRING | 0x0D)
133#define CONFIG_ITEM_DIRECTORY (CONFIG_ITEM_STRING | 0x0E)
134#define CONFIG_ITEM_FONT (CONFIG_ITEM_STRING | 0x0F)
137#define CONFIG_CLASS(x) ((x) & ~0x1F)
140#define CONFIG_ITEM(x) (((x) & ~0xF) != 0)
142#define IsConfigStringType(type) \
143 (((type) & CONFIG_ITEM_STRING) != 0)
144#define IsConfigIntegerType(type) \
145 (((type) & CONFIG_ITEM_INTEGER) != 0)
146#define IsConfigFloatType(type) \
147 ((type) == CONFIG_ITEM_FLOAT)
225#define VLC_API_VERSION_STRING "4.0.6"
240#define CONCATENATE( y, z ) CRUDE_HACK( y, z )
241#define CRUDE_HACK( y, z ) y##__##z
242#define STRINGIFY_NAME_( z ) #z
243#define STRINGIFY_NAME( z ) STRINGIFY_NAME_( z )
245#if defined(__cplusplus)
246#define EXTERN_SYMBOL extern "C"
251#if !defined(MODULE_STRING) && defined(MODULE_NAME)
252# define MODULE_STRING STRINGIFY_NAME(MODULE_NAME)
256#define VLC_ENTRY_FUNC(name) int (name)(vlc_set_cb, void *)
258#define VLC_MODULE_ENTRY(name) CONCATENATE(vlc_entry, name)
260#define VLC_DECL_MODULE_ENTRY(name) VLC_ENTRY_FUNC(VLC_MODULE_ENTRY(name))
264#ifdef VLC_DYNAMIC_PLUGIN
265# define VLC_SYMBOL(symbol) symbol
266# define VLC_MODULE_NAME_HIDDEN_SYMBOL \
267 EXTERN_SYMBOL const char vlc_module_name[] = MODULE_STRING;
269# define VLC_SYMBOL(symbol) CONCATENATE(symbol, MODULE_NAME)
270# define VLC_MODULE_NAME_HIDDEN_SYMBOL
274#if defined (VLC_DYNAMIC_PLUGIN)
279# if defined (_WIN32) || (defined (__OS2__) && !defined (DLL_EXPORT))
280# define DLL_SYMBOL __declspec(dllexport)
282# define CDECL_SYMBOL __cdecl
283# elif defined (__GNUC__)
284# define DLL_SYMBOL __attribute__((visibility("default")))
299#define vlc_plugin_set(...) vlc_set (opaque, NULL, __VA_ARGS__)
300#define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__)
301#define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__)
307 int64_t **values,
char ***descs);
310 char ***values,
char ***descs);
314# define VLC_CHECKED_TYPE(type, value) [](type v){ return v; }(value)
316# define VLC_CHECKED_TYPE(type, value) (type){ value }
325#define vlc_module_begin() \
326EXTERN_SYMBOL DLL_SYMBOL \
327int CDECL_SYMBOL VLC_SYMBOL(vlc_entry)(vlc_set_cb vlc_set, void *opaque) \
330 struct vlc_param *config = NULL; \
331 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
333 if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \
336#define vlc_module_end() \
342VLC_MODULE_NAME_HIDDEN_SYMBOL \
345#define add_submodule( ) \
346 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
349#define add_shortcut( ... ) \
351 const char *shortcuts[] = { __VA_ARGS__ }; \
352 if (vlc_module_set (VLC_MODULE_SHORTCUT, \
353 sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
357#define set_shortname( shortname ) \
358 if (vlc_module_set (VLC_MODULE_SHORTNAME, VLC_CHECKED_TYPE(const char *, shortname))) \
361#define set_description( desc ) \
362 if (vlc_module_set (VLC_MODULE_DESCRIPTION, VLC_CHECKED_TYPE(const char *, desc))) \
365#define set_help( help ) \
366 if (vlc_module_set (VLC_MODULE_HELP, VLC_CHECKED_TYPE(const char *, help))) \
369#define set_help_html( help_html ) \
370 if (vlc_module_set (VLC_MODULE_HELP_HTML, VLC_CHECKED_TYPE(const char *, help_html))) \
373#define set_capability( cap, score ) \
374 if (vlc_module_set (VLC_MODULE_CAPABILITY, VLC_CHECKED_TYPE(const char *, cap)) \
375 || vlc_module_set (VLC_MODULE_SCORE, VLC_CHECKED_TYPE(int, score))) \
378#define set_callback(activate) \
379 if (vlc_module_set(VLC_MODULE_CB_OPEN, #activate, (void *)(activate))) \
382#define set_callbacks( activate, deactivate ) \
383 set_callback(activate) \
384 if (vlc_module_set(VLC_MODULE_CB_CLOSE, #deactivate, \
385 (void (*)(vlc_object_t *))( deactivate ))) \
388#define cannot_unload_broken_library( ) \
389 if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
392#define set_text_domain( dom ) \
393 if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, VLC_CHECKED_TYPE(const char *, dom))) \
409#define add_type_inner( type ) \
410 vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config);
412#define add_typedesc_inner( type, text, longtext ) \
413 add_type_inner( type ) \
414 vlc_config_set (VLC_CONFIG_DESC, VLC_CHECKED_TYPE(const char *, text), \
415 VLC_CHECKED_TYPE(const char *, longtext));
417#define add_typename_inner(type, name, text, longtext) \
418 add_typedesc_inner(type, text, longtext) \
419 vlc_config_set (VLC_CONFIG_NAME, VLC_CHECKED_TYPE(const char *, name));
421#define add_string_inner(type, name, text, longtext, v) \
422 add_typename_inner(type, name, text, longtext) \
423 vlc_config_set (VLC_CONFIG_VALUE, VLC_CHECKED_TYPE(const char *, v));
425#define add_int_inner(type, name, text, longtext, v) \
426 add_typename_inner(type, name, text, longtext) \
427 vlc_config_set (VLC_CONFIG_VALUE, VLC_CHECKED_TYPE(int64_t, v));
430#define set_subcategory( id ) \
431 add_type_inner( CONFIG_SUBCATEGORY ) \
432 vlc_config_set (VLC_CONFIG_VALUE, VLC_CHECKED_TYPE(int64_t, id));
434#define set_section( text, longtext ) \
435 add_typedesc_inner( CONFIG_SECTION, text, longtext )
437#define add_string( name, value, text, longtext ) \
438 add_string_inner(CONFIG_ITEM_STRING, name, text, longtext, value)
440#define add_password(name, value, text, longtext) \
441 add_string_inner(CONFIG_ITEM_PASSWORD, name, text, longtext, value)
443#define add_loadfile(name, value, text, longtext) \
444 add_string_inner(CONFIG_ITEM_LOADFILE, name, text, longtext, value)
446#define add_savefile(name, value, text, longtext) \
447 add_string_inner(CONFIG_ITEM_SAVEFILE, name, text, longtext, value)
449#define add_directory(name, value, text, longtext) \
450 add_string_inner(CONFIG_ITEM_DIRECTORY, name, text, longtext, value)
452#define add_font(name, value, text, longtext) \
453 add_string_inner(CONFIG_ITEM_FONT, name, text, longtext, value)
455#define add_module(name, cap, value, text, longtext) \
456 add_string_inner(CONFIG_ITEM_MODULE, name, text, longtext, value) \
457 vlc_config_set (VLC_CONFIG_CAPABILITY, VLC_CHECKED_TYPE(const char *, cap));
459#define add_module_list(name, cap, value, text, longtext) \
460 add_string_inner(CONFIG_ITEM_MODULE_LIST, name, text, longtext, value) \
461 vlc_config_set (VLC_CONFIG_CAPABILITY, VLC_CHECKED_TYPE(const char *, cap));
463#define add_integer( name, value, text, longtext ) \
464 add_int_inner(CONFIG_ITEM_INTEGER, name, text, longtext, value)
466#define add_rgb(name, value, text, longtext) \
467 add_int_inner(CONFIG_ITEM_RGB, name, text, longtext, value) \
468 change_integer_range( 0, 0xFFFFFF )
470#define add_key(name, value, text, longtext) \
471 add_string_inner(CONFIG_ITEM_KEY, "global-" name, text, longtext, \
473 add_string_inner(CONFIG_ITEM_KEY, name, text, longtext, value)
475#define add_integer_with_range( name, value, min, max, text, longtext ) \
476 add_integer( name, value, text, longtext ) \
477 change_integer_range( min, max )
479#define add_float( name, v, text, longtext ) \
480 add_typename_inner(CONFIG_ITEM_FLOAT, name, text, longtext) \
481 vlc_config_set (VLC_CONFIG_VALUE, VLC_CHECKED_TYPE(double, v));
483#define add_float_with_range( name, value, min, max, text, longtext ) \
484 add_float( name, value, text, longtext ) \
485 change_float_range( min, max )
487#define add_bool( name, v, text, longtext ) \
488 add_typename_inner(CONFIG_ITEM_BOOL, name, text, longtext) \
489 if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true);
492#define add_obsolete_inner( name, type ) \
493 add_type_inner( type ) \
494 vlc_config_set (VLC_CONFIG_NAME, VLC_CHECKED_TYPE(const char *, name)); \
495 vlc_config_set (VLC_CONFIG_REMOVED);
497#define add_obsolete_bool( name ) \
498 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
500#define add_obsolete_integer( name ) \
501 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
503#define add_obsolete_float( name ) \
504 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
506#define add_obsolete_string( name ) \
507 add_obsolete_inner( name, CONFIG_ITEM_STRING )
511#define change_short( ch ) \
512 vlc_config_set (VLC_CONFIG_SHORTCUT, VLC_CHECKED_TYPE(char, ch));
514#define change_string_list( list, list_text ) \
515 vlc_config_set (VLC_CONFIG_LIST, \
517 VLC_CHECKED_TYPE(const char *const *, list), \
518 VLC_CHECKED_TYPE(const char *const *, list_text));
520#define change_integer_list( list, list_text ) \
521 vlc_config_set (VLC_CONFIG_LIST, \
523 VLC_CHECKED_TYPE(const int *, list), \
524 VLC_CHECKED_TYPE(const char *const *, list_text));
526#define change_integer_range( minv, maxv ) \
527 vlc_config_set (VLC_CONFIG_RANGE, VLC_CHECKED_TYPE(int64_t, minv), \
528 VLC_CHECKED_TYPE(int64_t, maxv));
530#define change_float_range( minv, maxv ) \
531 vlc_config_set (VLC_CONFIG_RANGE, VLC_CHECKED_TYPE(double, minv), \
532 VLC_CHECKED_TYPE(double, maxv));
535#define change_private() \
536 vlc_config_set (VLC_CONFIG_PRIVATE);
539#define change_volatile() \
541 vlc_config_set (VLC_CONFIG_VOLATILE);
543#define change_safe() \
544 vlc_config_set (VLC_CONFIG_SAFE);
547#define VLC_CONFIG_INTEGER_ENUM(cb) \
548EXTERN_SYMBOL DLL_SYMBOL \
549int CDECL_SYMBOL VLC_SYMBOL(vlc_entry_cfg_int_enum)(const char *name, \
550 int64_t **values, char ***descs) \
552 return (cb)(name, values, descs); \
555#define VLC_CONFIG_STRING_ENUM(cb) \
556EXTERN_SYMBOL DLL_SYMBOL \
557int CDECL_SYMBOL VLC_SYMBOL(vlc_entry_cfg_str_enum)(const char *name, \
558 char ***values, char ***descs) \
560 return (cb)(name, values, descs); \
564#define VLC_META_EXPORT( name, value ) \
565 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
566 VLC_SYMBOL(vlc_entry_ ## name)(void); \
567 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
568 VLC_SYMBOL(vlc_entry_ ## name)(void) \
573#define VLC_API_VERSION_EXPORT \
574 VLC_META_EXPORT(api_version, VLC_API_VERSION_STRING)
576#define VLC_COPYRIGHT_VIDEOLAN \
577 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
578 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
579 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
580 "\x6c\x6f\x70\x65\x72\x73"
581#define VLC_LICENSE_LGPL_2_1_PLUS \
582 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
583 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
584 "\x47\x4e\x55\x20\x4c\x65\x73\x73\x65\x72\x20\x47\x65\x6e\x65\x72" \
585 "\x61\x6c\x20\x50\x75\x62\x6c\x69\x63\x20\x4c\x69\x63\x65\x6e\x73" \
586 "\x65\x2c\x20\x76\x65\x72\x73\x69\x6f\x6e\x20\x32\x2e\x31\x20\x6f" \
587 "\x72\x20\x6c\x61\x74\x65\x72\x2e"
588#define VLC_LICENSE_GPL_2_PLUS \
589 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
590 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
591 "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
592 "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
593 "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e"
594#if defined (LIBVLC_INTERNAL_)
595# define VLC_MODULE_COPYRIGHT VLC_COPYRIGHT_VIDEOLAN
596# ifndef VLC_MODULE_LICENSE
597# define VLC_MODULE_LICENSE VLC_LICENSE_LGPL_2_1_PLUS
601#ifdef VLC_MODULE_COPYRIGHT
602# define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT(copyright, VLC_MODULE_COPYRIGHT)
604# define VLC_COPYRIGHT_EXPORT
606#ifdef VLC_MODULE_LICENSE
607# define VLC_LICENSE_EXPORT VLC_META_EXPORT(license, VLC_MODULE_LICENSE)
609# define VLC_LICENSE_EXPORT
612#define VLC_METADATA_EXPORTS \
613 VLC_API_VERSION_EXPORT \
614 VLC_COPYRIGHT_EXPORT \
const char name[16]
Definition httpd.c:1298
static void vlc_entry(void *p)
Definition thread.c:388
Definition configuration.h:30
This file is a collection of common definitions and types.
vlc_config_cat
Definition vlc_plugin.h:152
@ CAT_SOUT
Definition vlc_plugin.h:164
@ CAT_AUDIO
Definition vlc_plugin.h:161
@ CAT_HIDDEN
Definition vlc_plugin.h:156
@ CAT_PLAYLIST
Definition vlc_plugin.h:166
@ CAT_VIDEO
Definition vlc_plugin.h:162
@ CAT_INPUT
Definition vlc_plugin.h:163
@ CAT_ADVANCED
Definition vlc_plugin.h:165
@ CAT_UNKNOWN
Definition vlc_plugin.h:158
@ CAT_INTERFACE
Definition vlc_plugin.h:160
#define VLC_SYMBOL(symbol)
Definition vlc_plugin.h:270
#define DLL_SYMBOL
Definition vlc_plugin.h:290
vlc_module_properties
Definition vlc_plugin.h:36
@ VLC_MODULE_NO_UNLOAD
Definition vlc_plugin.h:48
@ VLC_CONFIG_OLDNAME_OBSOLETE
Definition vlc_plugin.h:89
@ VLC_CONFIG_RANGE
Definition vlc_plugin.h:65
@ VLC_CONFIG_DESC
Definition vlc_plugin.h:95
@ VLC_CONFIG_ADD_ACTION_OBSOLETE
Definition vlc_plugin.h:101
@ VLC_MODULE_CB_OPEN
Definition vlc_plugin.h:46
@ VLC_CONFIG_VALUE
Definition vlc_plugin.h:62
@ VLC_MODULE_HELP
Definition vlc_plugin.h:52
@ VLC_CONFIG_ADVANCED_RESERVED
Definition vlc_plugin.h:68
@ VLC_CONFIG_LIST
Definition vlc_plugin.h:104
@ VLC_MODULE_CPU_REQUIREMENT
Definition vlc_plugin.h:42
@ VLC_MODULE_DESCRIPTION
Definition vlc_plugin.h:51
@ VLC_MODULE_CB_CLOSE
Definition vlc_plugin.h:47
@ VLC_MODULE_SHORTCUT
Definition vlc_plugin.h:43
@ VLC_CONFIG_LIST_OBSOLETE
Definition vlc_plugin.h:98
@ VLC_CONFIG_NAME
Definition vlc_plugin.h:59
@ VLC_MODULE_SCORE
Definition vlc_plugin.h:45
@ VLC_MODULE_NAME
Definition vlc_plugin.h:49
@ VLC_CONFIG_VOLATILE
Definition vlc_plugin.h:71
@ VLC_CONFIG_SAFE
Definition vlc_plugin.h:92
@ VLC_MODULE_CAPABILITY
Definition vlc_plugin.h:44
@ VLC_MODULE_CREATE
Definition vlc_plugin.h:37
@ VLC_CONFIG_SHORTCUT
Definition vlc_plugin.h:86
@ VLC_CONFIG_CAPABILITY
Definition vlc_plugin.h:83
@ VLC_CONFIG_REMOVED
Definition vlc_plugin.h:80
@ VLC_MODULE_TEXTDOMAIN
Definition vlc_plugin.h:53
@ VLC_CONFIG_PERSISTENT_OBSOLETE
Definition vlc_plugin.h:74
@ VLC_MODULE_SHORTNAME
Definition vlc_plugin.h:50
@ VLC_CONFIG_PRIVATE
Definition vlc_plugin.h:77
@ VLC_CONFIG_LIST_CB_OBSOLETE
Definition vlc_plugin.h:108
@ VLC_MODULE_HELP_HTML
Definition vlc_plugin.h:54
@ VLC_CONFIG_CREATE
Definition vlc_plugin.h:38
#define CDECL_SYMBOL
Definition vlc_plugin.h:274
int(* vlc_plugin_cb)(vlc_set_cb, void *)
Plugin entry point prototype.
Definition vlc_plugin.h:298
int(* vlc_set_cb)(void *, void *, int,...)
Definition vlc_plugin.h:295
#define EXTERN_SYMBOL
Definition vlc_plugin.h:249
vlc_config_subcat
Definition vlc_plugin.h:171
@ SUBCAT_VIDEO_GENERAL
Definition vlc_plugin.h:190
@ SUBCAT_PLAYLIST_SD
Definition vlc_plugin.h:216
@ SUBCAT_SOUT_GENERAL
Definition vlc_plugin.h:204
@ SUBCAT_INTERFACE_HOTKEYS
Definition vlc_plugin.h:182
@ SUBCAT_INTERFACE_MAIN
Definition vlc_plugin.h:180
@ SUBCAT_SOUT_PACKETIZER
Definition vlc_plugin.h:208
@ SUBCAT_INPUT_STREAM_FILTER
Definition vlc_plugin.h:202
@ SUBCAT_SOUT_STREAM
Definition vlc_plugin.h:205
@ SUBCAT_INPUT_ACODEC
Definition vlc_plugin.h:200
@ SUBCAT_SOUT_VOD
Definition vlc_plugin.h:209
@ SUBCAT_INPUT_GENERAL
Definition vlc_plugin.h:196
@ SUBCAT_VIDEO_VFILTER
Definition vlc_plugin.h:192
@ SUBCAT_VIDEO_SPLITTER
Definition vlc_plugin.h:194
@ SUBCAT_INTERFACE_GENERAL
Definition vlc_plugin.h:179
@ SUBCAT_SOUT_MUX
Definition vlc_plugin.h:206
@ SUBCAT_AUDIO_RESAMPLER
Definition vlc_plugin.h:188
@ SUBCAT_HIDDEN
Definition vlc_plugin.h:175
@ SUBCAT_SOUT_RENDERER
Definition vlc_plugin.h:210
@ SUBCAT_PLAYLIST_GENERAL
Definition vlc_plugin.h:215
@ SUBCAT_AUDIO_AFILTER
Definition vlc_plugin.h:186
@ SUBCAT_INPUT_VCODEC
Definition vlc_plugin.h:199
@ SUBCAT_INPUT_DEMUX
Definition vlc_plugin.h:198
@ SUBCAT_INTERFACE_CONTROL
Definition vlc_plugin.h:181
@ SUBCAT_AUDIO_VISUAL
Definition vlc_plugin.h:187
@ SUBCAT_SOUT_ACO
Definition vlc_plugin.h:207
@ SUBCAT_UNKNOWN
Definition vlc_plugin.h:177
@ SUBCAT_ADVANCED_MISC
Definition vlc_plugin.h:212
@ SUBCAT_AUDIO_AOUT
Definition vlc_plugin.h:185
@ SUBCAT_INPUT_ACCESS
Definition vlc_plugin.h:197
@ SUBCAT_ADVANCED_NETWORK
Definition vlc_plugin.h:213
@ SUBCAT_VIDEO_SUBPIC
Definition vlc_plugin.h:193
@ SUBCAT_PLAYLIST_EXPORT
Definition vlc_plugin.h:217
@ SUBCAT_INPUT_SCODEC
Definition vlc_plugin.h:201
@ SUBCAT_AUDIO_GENERAL
Definition vlc_plugin.h:184
@ SUBCAT_VIDEO_VOUT
Definition vlc_plugin.h:191