Go to the documentation of this file.
24 #ifndef LIBVLC_MODULES_MACROS_H
25 # define LIBVLC_MODULES_MACROS_H 1
111 #define CONFIG_HINT_CATEGORY 0x02
112 #define CONFIG_HINT_USAGE 0x05
114 #define CONFIG_CATEGORY 0x06
115 #define CONFIG_SUBCATEGORY 0x07
116 #define CONFIG_SECTION 0x08
119 #define CONFIG_ITEM_FLOAT 0x20
120 #define CONFIG_ITEM_INTEGER 0x40
121 #define CONFIG_ITEM_RGB 0x41
122 #define CONFIG_ITEM_BOOL 0x60
123 #define CONFIG_ITEM_STRING 0x80
124 #define CONFIG_ITEM_PASSWORD 0x81
125 #define CONFIG_ITEM_KEY 0x82
126 #define CONFIG_ITEM_MODULE 0x84
127 #define CONFIG_ITEM_MODULE_CAT 0x85
128 #define CONFIG_ITEM_MODULE_LIST 0x86
129 #define CONFIG_ITEM_MODULE_LIST_CAT 0x87
130 #define CONFIG_ITEM_LOADFILE 0x8C
131 #define CONFIG_ITEM_SAVEFILE 0x8D
132 #define CONFIG_ITEM_DIRECTORY 0x8E
133 #define CONFIG_ITEM_FONT 0x8F
135 #define CONFIG_ITEM(x) (((x) & ~0xF) != 0)
140 #define CAT_HIDDEN -1
141 #define SUBCAT_HIDDEN -1
144 #define CAT_INTERFACE 1
145 #define SUBCAT_INTERFACE_GENERAL 101
146 #define SUBCAT_INTERFACE_MAIN 102
147 #define SUBCAT_INTERFACE_CONTROL 103
148 #define SUBCAT_INTERFACE_HOTKEYS 104
151 #define SUBCAT_AUDIO_GENERAL 201
152 #define SUBCAT_AUDIO_AOUT 202
153 #define SUBCAT_AUDIO_AFILTER 203
154 #define SUBCAT_AUDIO_VISUAL 204
155 #define SUBCAT_AUDIO_RESAMPLER 206
158 #define SUBCAT_VIDEO_GENERAL 301
159 #define SUBCAT_VIDEO_VOUT 302
160 #define SUBCAT_VIDEO_VFILTER 303
161 #define SUBCAT_VIDEO_SUBPIC 305
162 #define SUBCAT_VIDEO_SPLITTER 306
165 #define SUBCAT_INPUT_GENERAL 401
166 #define SUBCAT_INPUT_ACCESS 402
167 #define SUBCAT_INPUT_DEMUX 403
168 #define SUBCAT_INPUT_VCODEC 404
169 #define SUBCAT_INPUT_ACODEC 405
170 #define SUBCAT_INPUT_SCODEC 406
171 #define SUBCAT_INPUT_STREAM_FILTER 407
174 #define SUBCAT_SOUT_GENERAL 501
175 #define SUBCAT_SOUT_STREAM 502
176 #define SUBCAT_SOUT_MUX 503
177 #define SUBCAT_SOUT_ACO 504
178 #define SUBCAT_SOUT_PACKETIZER 505
179 #define SUBCAT_SOUT_VOD 507
180 #define SUBCAT_SOUT_RENDERER 508
182 #define CAT_ADVANCED 6
183 #define SUBCAT_ADVANCED_MISC 602
184 #define SUBCAT_ADVANCED_NETWORK 603
186 #define CAT_PLAYLIST 7
187 #define SUBCAT_PLAYLIST_GENERAL 701
188 #define SUBCAT_PLAYLIST_SD 702
189 #define SUBCAT_PLAYLIST_EXPORT 703
195 #define VLC_API_VERSION_STRING "4.0.4"
210 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
211 #define CRUDE_HACK( y, z ) y##__##z
213 #if defined(__cplusplus)
214 #define EXTERN_SYMBOL extern "C"
216 #define EXTERN_SYMBOL
222 # define VLC_SYMBOL(symbol) symbol
223 # define VLC_MODULE_NAME_HIDDEN_SYMBOL \
224 EXTERN_SYMBOL const char vlc_module_name[] = MODULE_STRING;
226 # define VLC_SYMBOL(symbol) CONCATENATE(symbol, MODULE_NAME)
227 # define VLC_MODULE_NAME_HIDDEN_SYMBOL
231 #if defined (__PLUGIN__)
232 # if defined (_WIN32)
233 # define DLL_SYMBOL __declspec(dllexport)
235 # define CDECL_SYMBOL __cdecl
236 # elif defined (__GNUC__)
237 # define DLL_SYMBOL __attribute__((visibility("default")))
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__)
255 int64_t **values,
char ***descs);
258 char ***values,
char ***descs);
266 #define vlc_module_begin() \
267 EXTERN_SYMBOL DLL_SYMBOL \
268 int CDECL_SYMBOL VLC_SYMBOL(vlc_entry)(vlc_set_cb vlc_set, void *opaque) \
271 module_config_t *config = NULL; \
272 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
274 if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \
277 #define vlc_module_end() \
283 VLC_MODULE_NAME_HIDDEN_SYMBOL \
286 #define add_submodule( ) \
287 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
290 #define add_shortcut( ... ) \
292 const char *shortcuts[] = { __VA_ARGS__ }; \
293 if (vlc_module_set (VLC_MODULE_SHORTCUT, \
294 sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
298 #define set_shortname( shortname ) \
299 if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \
302 #define set_description( desc ) \
303 if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \
306 #define set_help( help ) \
307 if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \
310 #define set_capability( cap, score ) \
311 if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \
312 || vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \
315 #define set_callback(activate) \
316 if (vlc_module_set(VLC_MODULE_CB_OPEN, #activate, (void *)(activate))) \
319 #define set_callbacks( activate, deactivate ) \
320 set_callback(activate) \
321 if (vlc_module_set(VLC_MODULE_CB_CLOSE, #deactivate, \
322 (void (*)(vlc_object_t *))( deactivate ))) \
325 #define cannot_unload_broken_library( ) \
326 if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
329 #define set_text_domain( dom ) \
330 if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \
346 #define add_type_inner( type ) \
347 vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config);
349 #define add_typedesc_inner( type, text, longtext ) \
350 add_type_inner( type ) \
351 vlc_config_set (VLC_CONFIG_DESC, \
352 (const char *)(text), (const char *)(longtext));
354 #define add_typename_inner(type, name, text, longtext) \
355 add_typedesc_inner(type, text, longtext) \
356 vlc_config_set (VLC_CONFIG_NAME, (const char *)(name));
358 #define add_string_inner(type, name, text, longtext, v) \
359 add_typename_inner(type, name, text, longtext) \
360 vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v));
362 #define add_int_inner(type, name, text, longtext, v) \
363 add_typename_inner(type, name, text, longtext) \
364 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v));
367 #define set_category( i_id ) \
368 add_type_inner( CONFIG_CATEGORY ) \
369 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
371 #define set_subcategory( i_id ) \
372 add_type_inner( CONFIG_SUBCATEGORY ) \
373 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
375 #define set_section( text, longtext ) \
376 add_typedesc_inner( CONFIG_SECTION, text, longtext )
378 #define add_category_hint(text, longtext) \
379 add_typedesc_inner( CONFIG_HINT_CATEGORY, text, longtext )
381 #define add_usage_hint( text ) \
382 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
384 #define add_string( name, value, text, longtext, advc ) \
385 add_string_inner(CONFIG_ITEM_STRING, name, text, longtext, value)
387 #define add_password(name, value, text, longtext) \
388 add_string_inner(CONFIG_ITEM_PASSWORD, name, text, longtext, value)
390 #define add_loadfile(name, value, text, longtext) \
391 add_string_inner(CONFIG_ITEM_LOADFILE, name, text, longtext, value)
393 #define add_savefile(name, value, text, longtext) \
394 add_string_inner(CONFIG_ITEM_SAVEFILE, name, text, longtext, value)
396 #define add_directory(name, value, text, longtext) \
397 add_string_inner(CONFIG_ITEM_DIRECTORY, name, text, longtext, value)
399 #define add_font(name, value, text, longtext) \
400 add_string_inner(CONFIG_ITEM_FONT, name, text, longtext, value)
402 #define add_module(name, psz_caps, value, text, longtext) \
403 add_string_inner(CONFIG_ITEM_MODULE, name, text, longtext, value) \
404 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
406 #define add_module_list(name, psz_caps, value, text, longtext) \
407 add_string_inner(CONFIG_ITEM_MODULE_LIST, name, text, longtext, value) \
408 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
411 #define add_module_cat(name, i_subcategory, value, text, longtext) \
412 add_string_inner(CONFIG_ITEM_MODULE_CAT, name, text, longtext, value) \
413 change_integer_range (i_subcategory , 0);
415 #define add_module_list_cat(name, i_subcategory, value, text, longtext) \
416 add_string_inner(CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
418 change_integer_range (i_subcategory , 0);
421 #define add_integer( name, value, text, longtext, advc ) \
422 add_int_inner(CONFIG_ITEM_INTEGER, name, text, longtext, value)
424 #define add_rgb(name, value, text, longtext) \
425 add_int_inner(CONFIG_ITEM_RGB, name, text, longtext, value) \
426 change_integer_range( 0, 0xFFFFFF )
428 #define add_key(name, value, text, longtext) \
429 add_string_inner(CONFIG_ITEM_KEY, "global-" name, text, longtext, \
431 add_string_inner(CONFIG_ITEM_KEY, name, text, longtext, 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) \
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) \
447 if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true);
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 )
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));
478 #define change_integer_list( list, list_text ) \
479 vlc_config_set (VLC_CONFIG_LIST, \
480 (size_t)(sizeof (list) / sizeof (int)), \
481 (const int *)(list), \
482 (const char *const *)(list_text));
484 #define change_integer_range( minv, maxv ) \
485 vlc_config_set (VLC_CONFIG_RANGE, (int64_t)(minv), (int64_t)(maxv));
487 #define change_float_range( minv, maxv ) \
488 vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv));
491 #define change_private() \
492 vlc_config_set (VLC_CONFIG_PRIVATE);
495 #define change_volatile() \
497 vlc_config_set (VLC_CONFIG_VOLATILE);
499 #define change_safe() \
500 vlc_config_set (VLC_CONFIG_SAFE);
503 #define VLC_CONFIG_INTEGER_ENUM(cb) \
504 EXTERN_SYMBOL DLL_SYMBOL \
505 int CDECL_SYMBOL VLC_SYMBOL(vlc_entry_cfg_int_enum)(const char *name, \
506 int64_t **values, char ***descs) \
508 return (cb)(name, values, descs); \
511 #define VLC_CONFIG_STRING_ENUM(cb) \
512 EXTERN_SYMBOL DLL_SYMBOL \
513 int CDECL_SYMBOL VLC_SYMBOL(vlc_entry_cfg_str_enum)(const char *name, \
514 char ***values, char ***descs) \
516 return (cb)(name, values, descs); \
520 #define VLC_META_EXPORT( name, value ) \
521 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
522 VLC_SYMBOL(vlc_entry_ ## name)(void); \
523 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
524 VLC_SYMBOL(vlc_entry_ ## name)(void) \
529 #define VLC_API_VERSION_EXPORT \
530 VLC_META_EXPORT(api_version, VLC_API_VERSION_STRING)
532 #define VLC_COPYRIGHT_VIDEOLAN \
533 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
534 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
535 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
536 "\x6c\x6f\x70\x65\x72\x73"
537 #define VLC_LICENSE_LGPL_2_1_PLUS \
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\x4c\x65\x73\x73\x65\x72\x20\x47\x65\x6e\x65\x72" \
541 "\x61\x6c\x20\x50\x75\x62\x6c\x69\x63\x20\x4c\x69\x63\x65\x6e\x73" \
542 "\x65\x2c\x20\x76\x65\x72\x73\x69\x6f\x6e\x20\x32\x2e\x31\x20\x6f" \
543 "\x72\x20\x6c\x61\x74\x65\x72\x2e"
544 #define VLC_LICENSE_GPL_2_PLUS \
545 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
546 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
547 "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
548 "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
549 "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e"
550 #if defined (__LIBVLC__)
551 # define VLC_MODULE_COPYRIGHT VLC_COPYRIGHT_VIDEOLAN
552 # ifndef VLC_MODULE_LICENSE
553 # define VLC_MODULE_LICENSE VLC_LICENSE_LGPL_2_1_PLUS
557 #ifdef VLC_MODULE_COPYRIGHT
558 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT(copyright, VLC_MODULE_COPYRIGHT)
560 # define VLC_COPYRIGHT_EXPORT
562 #ifdef VLC_MODULE_LICENSE
563 # define VLC_LICENSE_EXPORT VLC_META_EXPORT(license, VLC_MODULE_LICENSE)
565 # define VLC_LICENSE_EXPORT
568 #define VLC_METADATA_EXPORTS \
569 VLC_API_VERSION_EXPORT \
570 VLC_COPYRIGHT_EXPORT \
@ VLC_MODULE_SCORE
Definition: vlc_plugin.h:43
@ VLC_MODULE_SHORTCUT
Definition: vlc_plugin.h:41
@ VLC_CONFIG_LIST
Definition: vlc_plugin.h:101
@ VLC_CONFIG_LIST_OBSOLETE
Definition: vlc_plugin.h:95
@ VLC_MODULE_DESCRIPTION
Definition: vlc_plugin.h:49
@ VLC_CONFIG_DESC
Definition: vlc_plugin.h:92
@ VLC_CONFIG_CAPABILITY
Definition: vlc_plugin.h:80
@ VLC_CONFIG_CREATE
Definition: vlc_plugin.h:36
@ VLC_CONFIG_VOLATILE
Definition: vlc_plugin.h:68
static void vlc_entry(void *p)
Definition: thread.c:434
@ VLC_CONFIG_RANGE
Definition: vlc_plugin.h:62
@ VLC_MODULE_TEXTDOMAIN
Definition: vlc_plugin.h:51
@ VLC_CONFIG_PRIVATE
Definition: vlc_plugin.h:74
@ VLC_CONFIG_PERSISTENT_OBSOLETE
Definition: vlc_plugin.h:71
vlc_module_properties
Definition: vlc_plugin.h:33
@ VLC_MODULE_SHORTNAME
Definition: vlc_plugin.h:48
@ VLC_CONFIG_REMOVED
Definition: vlc_plugin.h:77
@ VLC_CONFIG_NAME
Definition: vlc_plugin.h:56
#define CDECL_SYMBOL
Definition: vlc_plugin.h:231
@ VLC_MODULE_NAME
Definition: vlc_plugin.h:47
@ VLC_CONFIG_SHORTCUT
Definition: vlc_plugin.h:83
@ VLC_CONFIG_VALUE
Definition: vlc_plugin.h:59
@ VLC_CONFIG_LIST_CB_OBSOLETE
Definition: vlc_plugin.h:105
@ VLC_CONFIG_OLDNAME_OBSOLETE
Definition: vlc_plugin.h:86
int(* vlc_set_cb)(void *, void *, int,...)
Definition: vlc_plugin.h:246
@ VLC_MODULE_CPU_REQUIREMENT
Definition: vlc_plugin.h:40
@ VLC_MODULE_NO_UNLOAD
Definition: vlc_plugin.h:46
#define VLC_SYMBOL(symbol)
Definition: vlc_plugin.h:227
@ VLC_CONFIG_ADD_ACTION_OBSOLETE
Definition: vlc_plugin.h:98
@ VLC_MODULE_HELP
Definition: vlc_plugin.h:50
#define EXTERN_SYMBOL
Definition: vlc_plugin.h:217
@ VLC_CONFIG_ADVANCED_RESERVED
Definition: vlc_plugin.h:65
@ VLC_CONFIG_SAFE
Definition: vlc_plugin.h:89
@ VLC_MODULE_CREATE
Definition: vlc_plugin.h:35
@ VLC_MODULE_CB_OPEN
Definition: vlc_plugin.h:44
const char name[16]
Definition: httpd.c:1268
@ VLC_MODULE_CAPABILITY
Definition: vlc_plugin.h:42
#define DLL_SYMBOL
Definition: vlc_plugin.h:243
@ VLC_MODULE_CB_CLOSE
Definition: vlc_plugin.h:45