24 #ifndef LIBVLC_MODULES_MACROS_H
25 # define LIBVLC_MODULES_MACROS_H 1
32 enum vlc_module_properties
39 VLC_MODULE_CPU_REQUIREMENT=0x100,
41 VLC_MODULE_CAPABILITY,
48 VLC_MODULE_DESCRIPTION,
50 VLC_MODULE_TEXTDOMAIN,
55 VLC_CONFIG_NAME=0x1000,
70 VLC_CONFIG_PERSISTENT_OBSOLETE,
79 VLC_CONFIG_CAPABILITY,
85 VLC_CONFIG_OLDNAME_OBSOLETE,
94 VLC_CONFIG_LIST_OBSOLETE,
97 VLC_CONFIG_ADD_ACTION_OBSOLETE,
112 #define CONFIG_HINT_CATEGORY 0x02
113 #define CONFIG_HINT_SUBCATEGORY 0x03
114 #define CONFIG_HINT_SUBCATEGORY_END 0x04
115 #define CONFIG_HINT_USAGE 0x05
117 #define CONFIG_CATEGORY 0x06
118 #define CONFIG_SUBCATEGORY 0x07
119 #define CONFIG_SECTION 0x08
122 #define CONFIG_ITEM_FLOAT 0x20
123 #define CONFIG_ITEM_INTEGER 0x40
124 #define CONFIG_ITEM_RGB 0x41
125 #define CONFIG_ITEM_BOOL 0x60
126 #define CONFIG_ITEM_STRING 0x80
127 #define CONFIG_ITEM_PASSWORD 0x81
128 #define CONFIG_ITEM_KEY 0x82
129 #define CONFIG_ITEM_MODULE 0x84
130 #define CONFIG_ITEM_MODULE_CAT 0x85
131 #define CONFIG_ITEM_MODULE_LIST 0x86
132 #define CONFIG_ITEM_MODULE_LIST_CAT 0x87
133 #define CONFIG_ITEM_LOADFILE 0x8C
134 #define CONFIG_ITEM_SAVEFILE 0x8D
135 #define CONFIG_ITEM_DIRECTORY 0x8E
136 #define CONFIG_ITEM_FONT 0x8F
138 #define CONFIG_ITEM(x) (((x) & ~0xF) != 0)
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_SUBPIC 305
161 #define SUBCAT_INPUT_GENERAL 401
162 #define SUBCAT_INPUT_ACCESS 402
163 #define SUBCAT_INPUT_DEMUX 403
164 #define SUBCAT_INPUT_VCODEC 404
165 #define SUBCAT_INPUT_ACODEC 405
166 #define SUBCAT_INPUT_SCODEC 406
167 #define SUBCAT_INPUT_STREAM_FILTER 407
170 #define SUBCAT_SOUT_GENERAL 501
171 #define SUBCAT_SOUT_STREAM 502
172 #define SUBCAT_SOUT_MUX 503
173 #define SUBCAT_SOUT_ACO 504
174 #define SUBCAT_SOUT_PACKETIZER 505
175 #define SUBCAT_SOUT_VOD 507
177 #define CAT_ADVANCED 6
178 #define SUBCAT_ADVANCED_MISC 602
179 #define SUBCAT_ADVANCED_NETWORK 603
181 #define CAT_PLAYLIST 7
182 #define SUBCAT_PLAYLIST_GENERAL 701
183 #define SUBCAT_PLAYLIST_SD 702
184 #define SUBCAT_PLAYLIST_EXPORT 703
190 # define MODULE_SYMBOL 2_1_0a
191 # define MODULE_SUFFIX "__2_1_0a"
206 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
207 #define CRUDE_HACK( y, z ) y##__##z
212 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
214 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
218 #if defined (__PLUGIN__)
219 # if defined (_WIN32)
220 # define DLL_SYMBOL __declspec(dllexport)
222 # define CDECL_SYMBOL __cdecl
223 # elif VLC_GCC_VERSION(4,0)
224 # define DLL_SYMBOL __attribute__((visibility("default")))
232 #if defined( __cplusplus )
233 # define EXTERN_SYMBOL extern "C"
235 # define EXTERN_SYMBOL
238 typedef int (*vlc_set_cb) (
void *,
void *, int, ...);
240 #define vlc_plugin_set(...) vlc_set (opaque, NULL, __VA_ARGS__)
241 #define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__)
242 #define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__)
250 #define vlc_module_begin() \
251 EXTERN_SYMBOL DLL_SYMBOL \
252 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb, void *); \
253 EXTERN_SYMBOL DLL_SYMBOL \
254 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb vlc_set, void *opaque) \
257 module_config_t *config = NULL; \
258 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
260 if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \
263 #define vlc_module_end() \
271 #define add_submodule( ) \
272 if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
275 #define add_shortcut( ... ) \
277 const char *shortcuts[] = { __VA_ARGS__ }; \
278 if (vlc_module_set (VLC_MODULE_SHORTCUT, \
279 sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
283 #define set_shortname( shortname ) \
284 if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \
287 #define set_description( desc ) \
288 if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \
291 #define set_help( help ) \
292 if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \
295 #define set_capability( cap, score ) \
296 if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \
297 || vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \
300 #define set_callbacks( activate, deactivate ) \
301 if (vlc_module_set (VLC_MODULE_CB_OPEN, activate) \
302 || vlc_module_set (VLC_MODULE_CB_CLOSE, deactivate)) \
305 #define cannot_unload_broken_library( ) \
306 if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
309 #define set_text_domain( dom ) \
310 if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \
326 #define add_type_inner( type ) \
327 vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config);
329 #define add_typedesc_inner( type, text, longtext ) \
330 add_type_inner( type ) \
331 vlc_config_set (VLC_CONFIG_DESC, \
332 (const char *)(text), (const char *)(longtext));
334 #define add_typeadv_inner( type, text, longtext, advc ) \
335 add_typedesc_inner( type, text, longtext ) \
336 if (advc) vlc_config_set (VLC_CONFIG_ADVANCED);
338 #define add_typename_inner( type, name, text, longtext, advc ) \
339 add_typeadv_inner( type, text, longtext, advc ) \
340 vlc_config_set (VLC_CONFIG_NAME, (const char *)(name));
342 #define add_string_inner( type, name, text, longtext, advc, v ) \
343 add_typename_inner( type, name, text, longtext, advc ) \
344 vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v));
346 #define add_int_inner( type, name, text, longtext, advc, v ) \
347 add_typename_inner( type, name, text, longtext, advc ) \
348 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v));
351 #define set_category( i_id ) \
352 add_type_inner( CONFIG_CATEGORY ) \
353 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
355 #define set_subcategory( i_id ) \
356 add_type_inner( CONFIG_SUBCATEGORY ) \
357 vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
359 #define set_section( text, longtext ) \
360 add_typedesc_inner( CONFIG_SECTION, text, longtext )
362 #define add_category_hint( text, longtext, advc ) \
363 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
365 #define add_subcategory_hint( text, longtext ) \
366 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
368 #define end_subcategory_hint \
369 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
371 #define add_usage_hint( text ) \
372 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
374 #define add_string( name, value, text, longtext, advc ) \
375 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
378 #define add_password( name, value, text, longtext, advc ) \
379 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
382 #define add_loadfile( name, value, text, longtext, advc ) \
383 add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
386 #define add_savefile( name, value, text, longtext, advc ) \
387 add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
390 #define add_directory( name, value, text, longtext, advc ) \
391 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
394 #define add_font( name, value, text, longtext, advc )\
395 add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
398 #define add_module( name, psz_caps, value, text, longtext, advc ) \
399 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
401 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
403 #define add_module_list( name, psz_caps, value, text, longtext, advc ) \
404 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
406 vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
409 #define add_module_cat( name, i_subcategory, value, text, longtext, advc ) \
410 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
412 change_integer_range (i_subcategory , 0);
414 #define add_module_list_cat( name, i_subcategory, value, text, longtext, advc ) \
415 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
417 change_integer_range (i_subcategory , 0);
420 #define add_integer( name, value, text, longtext, advc ) \
421 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
423 #define add_rgb( name, value, text, longtext, advc ) \
424 add_int_inner( CONFIG_ITEM_RGB, name, text, longtext, advc, value ) \
425 change_integer_range( 0, 0xFFFFFF )
427 #define add_key( name, value, text, longtext, advc ) \
428 add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
430 add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value )
432 #define add_integer_with_range( name, value, i_min, i_max, text, longtext, advc ) \
433 add_integer( name, value, text, longtext, advc ) \
434 change_integer_range( i_min, i_max )
436 #define add_float( name, v, text, longtext, advc ) \
437 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
438 vlc_config_set (VLC_CONFIG_VALUE, (double)(v));
440 #define add_float_with_range( name, value, f_min, f_max, text, longtext, advc ) \
441 add_float( name, value, text, longtext, advc ) \
442 change_float_range( f_min, f_max )
444 #define add_bool( name, v, text, longtext, advc ) \
445 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
446 if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true);
449 #define add_obsolete_inner( name, type ) \
450 add_type_inner( type ) \
451 vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); \
452 vlc_config_set (VLC_CONFIG_REMOVED);
454 #define add_obsolete_bool( name ) \
455 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
457 #define add_obsolete_integer( name ) \
458 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
460 #define add_obsolete_float( name ) \
461 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
463 #define add_obsolete_string( name ) \
464 add_obsolete_inner( name, CONFIG_ITEM_STRING )
468 #define change_short( ch ) \
469 vlc_config_set (VLC_CONFIG_SHORTCUT, (int)(ch));
471 #define change_string_list( list, list_text ) \
472 vlc_config_set (VLC_CONFIG_LIST, \
473 (size_t)(sizeof (list) / sizeof (char *)), \
474 (const char *const *)(list), \
475 (const char *const *)(list_text));
477 #define change_string_cb( cb ) \
478 vlc_config_set (VLC_CONFIG_LIST_CB, (cb));
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));
486 #define change_integer_cb( cb ) \
487 vlc_config_set (VLC_CONFIG_LIST_CB, (cb));
489 #define change_integer_range( minv, maxv ) \
490 vlc_config_set (VLC_CONFIG_RANGE, (int64_t)(minv), (int64_t)(maxv));
492 #define change_float_range( minv, maxv ) \
493 vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv));
495 #define change_action_add( pf_action, text ) \
496 (void)(pf_action, text);
499 #define change_private() \
500 vlc_config_set (VLC_CONFIG_PRIVATE);
503 #define change_volatile() \
505 vlc_config_set (VLC_CONFIG_VOLATILE);
507 #define change_safe() \
508 vlc_config_set (VLC_CONFIG_SAFE);
511 #define VLC_META_EXPORT( name, value ) \
512 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
513 __VLC_SYMBOL(vlc_entry_ ## name) (void); \
514 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
515 __VLC_SYMBOL(vlc_entry_ ## name) (void) \
520 #if defined (__LIBVLC__)
521 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
522 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
523 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
524 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
525 "\x6c\x6f\x70\x65\x72\x73" )
526 # define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
527 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
528 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
529 "\x47\x4e\x55\x20\x4c\x65\x73\x73\x65\x72\x20\x47\x65\x6e\x65\x72" \
530 "\x61\x6c\x20\x50\x75\x62\x6c\x69\x63\x20\x4c\x69\x63\x65\x6e\x73" \
531 "\x65\x2c\x20\x76\x65\x72\x73\x69\x6f\x6e\x20\x32\x2e\x31\x20\x6f" \
532 "\x72\x20\x6c\x61\x74\x65\x72\x2e" )
534 # if !defined (VLC_COPYRIGHT_EXPORT)
535 # define VLC_COPYRIGHT_EXPORT
537 # if !defined (VLC_LICENSE_EXPORT)
538 # define VLC_LICENSE_EXPORT
542 #define VLC_METADATA_EXPORTS \
543 VLC_COPYRIGHT_EXPORT \