Go to the documentation of this file.
   24 #ifndef LIBVLC_MODULES_MACROS_H 
   25 # define LIBVLC_MODULES_MACROS_H 1 
  112 #define CONFIG_HINT_CATEGORY                0x02   
  113 #define CONFIG_HINT_USAGE                   0x05   
  115 #define CONFIG_CATEGORY                     0x06  
  116 #define CONFIG_SUBCATEGORY                  0x07  
  117 #define CONFIG_SECTION                      0x08  
  120 #define CONFIG_ITEM_FLOAT                   0x20   
  121 #define CONFIG_ITEM_INTEGER                 0x40   
  122 #define CONFIG_ITEM_RGB                     0x41   
  123 #define CONFIG_ITEM_BOOL                    0x60   
  124 #define CONFIG_ITEM_STRING                  0x80   
  125 #define CONFIG_ITEM_PASSWORD                0x81   
  126 #define CONFIG_ITEM_KEY                     0x82   
  127 #define CONFIG_ITEM_MODULE                  0x84   
  128 #define CONFIG_ITEM_MODULE_CAT              0x85   
  129 #define CONFIG_ITEM_MODULE_LIST             0x86   
  130 #define CONFIG_ITEM_MODULE_LIST_CAT         0x87   
  131 #define CONFIG_ITEM_LOADFILE                0x8C   
  132 #define CONFIG_ITEM_SAVEFILE                0x8D   
  133 #define CONFIG_ITEM_DIRECTORY               0x8E   
  134 #define CONFIG_ITEM_FONT                    0x8F   
  136 #define CONFIG_ITEM(x) (((x) & ~0xF) != 0) 
  139 #define CAT_INTERFACE 1 
  140 #define SUBCAT_INTERFACE_GENERAL 101 
  141 #define SUBCAT_INTERFACE_MAIN 102 
  142 #define SUBCAT_INTERFACE_CONTROL 103 
  143 #define SUBCAT_INTERFACE_HOTKEYS 104 
  146 #define SUBCAT_AUDIO_GENERAL 201 
  147 #define SUBCAT_AUDIO_AOUT 202 
  148 #define SUBCAT_AUDIO_AFILTER 203 
  149 #define SUBCAT_AUDIO_VISUAL 204 
  150 #define SUBCAT_AUDIO_MISC 205 
  151 #define SUBCAT_AUDIO_RESAMPLER 206 
  154 #define SUBCAT_VIDEO_GENERAL 301 
  155 #define SUBCAT_VIDEO_VOUT 302 
  156 #define SUBCAT_VIDEO_VFILTER 303 
  157 #define SUBCAT_VIDEO_SUBPIC 305 
  158 #define SUBCAT_VIDEO_SPLITTER 306 
  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 
  176 #define SUBCAT_SOUT_RENDERER 508 
  178 #define CAT_ADVANCED 6 
  179 #define SUBCAT_ADVANCED_MISC 602 
  180 #define SUBCAT_ADVANCED_NETWORK 603 
  182 #define CAT_PLAYLIST 7 
  183 #define SUBCAT_PLAYLIST_GENERAL 701 
  184 #define SUBCAT_PLAYLIST_SD 702 
  185 #define SUBCAT_PLAYLIST_EXPORT 703 
  191 # define MODULE_SYMBOL 3_0_0f 
  192 # define MODULE_SUFFIX "__3_0_0f" 
  207 #define CONCATENATE( y, z ) CRUDE_HACK( y, z ) 
  208 #define CRUDE_HACK( y, z )  y##__##z 
  213 # define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL ) 
  214 # define VLC_MODULE_NAME_HIDDEN_SYMBOL \ 
  215     const char vlc_module_name[] = MODULE_STRING; 
  217 # define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME ) 
  218 # define VLC_MODULE_NAME_HIDDEN_SYMBOL 
  222 #if defined (__PLUGIN__) 
  223 # if defined (_WIN32) 
  224 #   define DLL_SYMBOL              __declspec(dllexport) 
  226 #   define CDECL_SYMBOL            __cdecl 
  227 # elif defined (__GNUC__) 
  228 #   define DLL_SYMBOL              __attribute__((visibility("default"))) 
  236 #if defined( __cplusplus ) 
  237 #   define EXTERN_SYMBOL           extern "C" 
  239 #   define EXTERN_SYMBOL 
  244 #define vlc_plugin_set(...) vlc_set (opaque,   NULL, __VA_ARGS__) 
  245 #define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__) 
  246 #define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__) 
  254 #define vlc_module_begin() \ 
  255 EXTERN_SYMBOL DLL_SYMBOL \ 
  256 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb, void *); \ 
  257 EXTERN_SYMBOL DLL_SYMBOL \ 
  258 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb vlc_set, void *opaque) \ 
  261     module_config_t *config = NULL; \ 
  262     if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \ 
  264     if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \ 
  267 #define vlc_module_end() \ 
  273 VLC_MODULE_NAME_HIDDEN_SYMBOL \ 
  276 #define add_submodule( ) \ 
  277     if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \ 
  280 #define add_shortcut( ... ) \ 
  282     const char *shortcuts[] = { __VA_ARGS__ }; \ 
  283     if (vlc_module_set (VLC_MODULE_SHORTCUT, \ 
  284                         sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \ 
  288 #define set_shortname( shortname ) \ 
  289     if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \ 
  292 #define set_description( desc ) \ 
  293     if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \ 
  296 #define set_help( help ) \ 
  297     if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \ 
  300 #define set_capability( cap, score ) \ 
  301     if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \ 
  302      || vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \ 
  305 #define set_callbacks( activate, deactivate ) \ 
  306     if (vlc_module_set(VLC_MODULE_CB_OPEN, #activate, (void *)(activate)) \ 
  307      || vlc_module_set(VLC_MODULE_CB_CLOSE, #deactivate, \ 
  308                        (void *)(deactivate))) \ 
  311 #define cannot_unload_broken_library( ) \ 
  312     if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \ 
  315 #define set_text_domain( dom ) \ 
  316     if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \ 
  332 #define add_type_inner( type ) \ 
  333     vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config); 
  335 #define add_typedesc_inner( type, text, longtext ) \ 
  336     add_type_inner( type ) \ 
  337     vlc_config_set (VLC_CONFIG_DESC, \ 
  338                     (const char *)(text), (const char *)(longtext)); 
  340 #define add_typeadv_inner( type, text, longtext, advc ) \ 
  341     add_typedesc_inner( type, text, longtext ) \ 
  342     if (advc) vlc_config_set (VLC_CONFIG_ADVANCED); 
  344 #define add_typename_inner( type, name, text, longtext, advc ) \ 
  345     add_typeadv_inner( type, text, longtext, advc ) \ 
  346     vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); 
  348 #define add_string_inner( type, name, text, longtext, advc, v ) \ 
  349     add_typename_inner( type, name, text, longtext, advc ) \ 
  350     vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v)); 
  352 #define add_int_inner( type, name, text, longtext, advc, v ) \ 
  353     add_typename_inner( type, name, text, longtext, advc ) \ 
  354     vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v)); 
  357 #define set_category( i_id ) \ 
  358     add_type_inner( CONFIG_CATEGORY ) \ 
  359     vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id)); 
  361 #define set_subcategory( i_id ) \ 
  362     add_type_inner( CONFIG_SUBCATEGORY ) \ 
  363     vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id)); 
  365 #define set_section( text, longtext ) \ 
  366     add_typedesc_inner( CONFIG_SECTION, text, longtext ) 
  368 #define add_category_hint( text, longtext, advc ) \ 
  369     add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc ) 
  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, (void *)(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, (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)); 
  496 #define change_private() \ 
  497     vlc_config_set (VLC_CONFIG_PRIVATE); 
  500 #define change_volatile() \ 
  502     vlc_config_set (VLC_CONFIG_VOLATILE); 
  504 #define change_safe() \ 
  505     vlc_config_set (VLC_CONFIG_SAFE); 
  508 #define VLC_META_EXPORT( name, value ) \ 
  509     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \ 
  510     __VLC_SYMBOL(vlc_entry_ ## name) (void); \ 
  511     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \ 
  512     __VLC_SYMBOL(vlc_entry_ ## name) (void) \ 
  517 #define VLC_COPYRIGHT_VIDEOLAN \ 
  518     "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \ 
  519     "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \ 
  520     "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \ 
  521     "\x6c\x6f\x70\x65\x72\x73" 
  522 #define VLC_LICENSE_LGPL_2_1_PLUS \ 
  523     "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \ 
  524     "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \ 
  525     "\x47\x4e\x55\x20\x4c\x65\x73\x73\x65\x72\x20\x47\x65\x6e\x65\x72" \ 
  526     "\x61\x6c\x20\x50\x75\x62\x6c\x69\x63\x20\x4c\x69\x63\x65\x6e\x73" \ 
  527     "\x65\x2c\x20\x76\x65\x72\x73\x69\x6f\x6e\x20\x32\x2e\x31\x20\x6f" \ 
  528     "\x72\x20\x6c\x61\x74\x65\x72\x2e" 
  529 #define VLC_LICENSE_GPL_2_PLUS \ 
  530     "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \ 
  531     "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \ 
  532     "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \ 
  533     "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \ 
  534     "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" 
  535 #if defined (__LIBVLC__) 
  536 # define VLC_MODULE_COPYRIGHT VLC_COPYRIGHT_VIDEOLAN 
  537 # ifndef VLC_MODULE_LICENSE 
  538 #  define VLC_MODULE_LICENSE VLC_LICENSE_LGPL_2_1_PLUS 
  542 #ifdef VLC_MODULE_COPYRIGHT 
  543 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT(copyright, VLC_MODULE_COPYRIGHT) 
  545 # define VLC_COPYRIGHT_EXPORT 
  547 #ifdef VLC_MODULE_LICENSE 
  548 # define VLC_LICENSE_EXPORT VLC_META_EXPORT(license, VLC_MODULE_LICENSE) 
  550 # define VLC_LICENSE_EXPORT 
  553 #define VLC_METADATA_EXPORTS \ 
  554     VLC_COPYRIGHT_EXPORT \ 
  
Definition: vlc_plugin.h:42
Definition: vlc_plugin.h:40
Definition: vlc_plugin.h:100
Definition: vlc_plugin.h:64
Definition: vlc_plugin.h:94
Definition: vlc_plugin.h:48
Definition: vlc_plugin.h:91
Definition: vlc_plugin.h:79
Definition: vlc_plugin.h:35
Definition: vlc_plugin.h:67
Definition: vlc_plugin.h:61
Definition: vlc_plugin.h:50
Definition: vlc_plugin.h:73
Definition: vlc_plugin.h:70
vlc_module_properties
Definition: vlc_plugin.h:32
Definition: vlc_plugin.h:47
Definition: vlc_plugin.h:76
Definition: vlc_plugin.h:55
Definition: vlc_plugin.h:46
Definition: vlc_plugin.h:82
Definition: vlc_plugin.h:58
Definition: vlc_plugin.h:104
Definition: vlc_plugin.h:85
int(* vlc_set_cb)(void *, void *, int,...)
Definition: vlc_plugin.h:241
Definition: vlc_plugin.h:39
Definition: vlc_plugin.h:45
Definition: vlc_plugin.h:97
Definition: vlc_plugin.h:49
#define EXTERN_SYMBOL
Definition: vlc_plugin.h:238
Definition: vlc_plugin.h:88
Definition: vlc_plugin.h:34
Definition: vlc_plugin.h:43
Definition: vlc_plugin.h:41
Definition: vlc_plugin.h:44