VLC  4.0.0-dev
Macros | Typedefs | Enumerations | Functions
vlc_plugin.h File Reference

This file implements plugin (module) macros used to define a vlc module. More...

Include dependency graph for vlc_plugin.h:

Go to the source code of this file.

Macros

#define CONFIG_HINT_CATEGORY   0x02 /* Start of new category */
 
#define CONFIG_HINT_USAGE   0x05 /* Usage information */
 
#define CONFIG_CATEGORY   0x06 /* Set category */
 
#define CONFIG_SUBCATEGORY   0x07 /* Set subcategory */
 
#define CONFIG_SECTION   0x08 /* Start of new section */
 
#define CONFIG_ITEM_FLOAT   0x20 /* Float option */
 
#define CONFIG_ITEM_INTEGER   0x40 /* Integer option */
 
#define CONFIG_ITEM_RGB   0x41 /* RGB color option */
 
#define CONFIG_ITEM_BOOL   0x60 /* Bool option */
 
#define CONFIG_ITEM_STRING   0x80 /* String option */
 
#define CONFIG_ITEM_PASSWORD   0x81 /* Password option (*) */
 
#define CONFIG_ITEM_KEY   0x82 /* Hot key option */
 
#define CONFIG_ITEM_MODULE   0x84 /* Module option */
 
#define CONFIG_ITEM_MODULE_CAT   0x85 /* Module option */
 
#define CONFIG_ITEM_MODULE_LIST   0x86 /* Module option */
 
#define CONFIG_ITEM_MODULE_LIST_CAT   0x87 /* Module option */
 
#define CONFIG_ITEM_LOADFILE   0x8C /* Read file option */
 
#define CONFIG_ITEM_SAVEFILE   0x8D /* Written file option */
 
#define CONFIG_ITEM_DIRECTORY   0x8E /* Directory option */
 
#define CONFIG_ITEM_FONT   0x8F /* Font option */
 
#define CONFIG_ITEM(x)   (((x) & ~0xF) != 0)
 
#define CAT_INTERFACE   1
 
#define SUBCAT_INTERFACE_GENERAL   101
 
#define SUBCAT_INTERFACE_MAIN   102
 
#define SUBCAT_INTERFACE_CONTROL   103
 
#define SUBCAT_INTERFACE_HOTKEYS   104
 
#define CAT_AUDIO   2
 
#define SUBCAT_AUDIO_GENERAL   201
 
#define SUBCAT_AUDIO_AOUT   202
 
#define SUBCAT_AUDIO_AFILTER   203
 
#define SUBCAT_AUDIO_VISUAL   204
 
#define SUBCAT_AUDIO_MISC   205
 
#define SUBCAT_AUDIO_RESAMPLER   206
 
#define CAT_VIDEO   3
 
#define SUBCAT_VIDEO_GENERAL   301
 
#define SUBCAT_VIDEO_VOUT   302
 
#define SUBCAT_VIDEO_VFILTER   303
 
#define SUBCAT_VIDEO_SUBPIC   305
 
#define SUBCAT_VIDEO_SPLITTER   306
 
#define CAT_INPUT   4
 
#define SUBCAT_INPUT_GENERAL   401
 
#define SUBCAT_INPUT_ACCESS   402
 
#define SUBCAT_INPUT_DEMUX   403
 
#define SUBCAT_INPUT_VCODEC   404
 
#define SUBCAT_INPUT_ACODEC   405
 
#define SUBCAT_INPUT_SCODEC   406
 
#define SUBCAT_INPUT_STREAM_FILTER   407
 
#define CAT_SOUT   5
 
#define SUBCAT_SOUT_GENERAL   501
 
#define SUBCAT_SOUT_STREAM   502
 
#define SUBCAT_SOUT_MUX   503
 
#define SUBCAT_SOUT_ACO   504
 
#define SUBCAT_SOUT_PACKETIZER   505
 
#define SUBCAT_SOUT_VOD   507
 
#define SUBCAT_SOUT_RENDERER   508
 
#define CAT_ADVANCED   6
 
#define SUBCAT_ADVANCED_MISC   602
 
#define SUBCAT_ADVANCED_NETWORK   603
 
#define CAT_PLAYLIST   7
 
#define SUBCAT_PLAYLIST_GENERAL   701
 
#define SUBCAT_PLAYLIST_SD   702
 
#define SUBCAT_PLAYLIST_EXPORT   703
 
#define VLC_API_VERSION_STRING   "4.0.4"
 Current plugin ABI version. More...
 
#define CONCATENATE(y, z)   CRUDE_HACK( y, z )
 
#define CRUDE_HACK(y, z)   y##__##z
 
#define VLC_SYMBOL(symbol)   CONCATENATE(symbol, MODULE_NAME)
 
#define VLC_MODULE_NAME_HIDDEN_SYMBOL
 
#define CDECL_SYMBOL
 
#define DLL_SYMBOL
 
#define EXTERN_SYMBOL
 
#define vlc_plugin_set(...)   vlc_set (opaque, NULL, __VA_ARGS__)
 
#define vlc_module_set(...)   vlc_set (opaque, module, __VA_ARGS__)
 
#define vlc_config_set(...)   vlc_set (opaque, config, __VA_ARGS__)
 
#define vlc_module_begin()
 
#define vlc_module_end()
 
#define add_submodule()
 
#define add_shortcut(...)
 
#define set_shortname(shortname)
 
#define set_description(desc)
 
#define set_help(help)
 
#define set_capability(cap, score)
 
#define set_callback(activate)
 
#define set_callbacks(activate, deactivate)
 
#define cannot_unload_broken_library()
 
#define set_text_domain(dom)
 
#define add_type_inner(type)   vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config);
 
#define add_typedesc_inner(type, text, longtext)
 
#define add_typename_inner(type, name, text, longtext)
 
#define add_string_inner(type, name, text, longtext, v)
 
#define add_int_inner(type, name, text, longtext, v)
 
#define set_category(i_id)
 
#define set_subcategory(i_id)
 
#define set_section(text, longtext)   add_typedesc_inner( CONFIG_SECTION, text, longtext )
 
#define add_category_hint(text, longtext)   add_typedesc_inner( CONFIG_HINT_CATEGORY, text, longtext )
 
#define add_usage_hint(text)   add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
 
#define add_string(name, value, text, longtext, advc)   add_string_inner(CONFIG_ITEM_STRING, name, text, longtext, value)
 
#define add_password(name, value, text, longtext)   add_string_inner(CONFIG_ITEM_PASSWORD, name, text, longtext, value)
 
#define add_loadfile(name, value, text, longtext)   add_string_inner(CONFIG_ITEM_LOADFILE, name, text, longtext, value)
 
#define add_savefile(name, value, text, longtext)   add_string_inner(CONFIG_ITEM_SAVEFILE, name, text, longtext, value)
 
#define add_directory(name, value, text, longtext)   add_string_inner(CONFIG_ITEM_DIRECTORY, name, text, longtext, value)
 
#define add_font(name, value, text, longtext)   add_string_inner(CONFIG_ITEM_FONT, name, text, longtext, value)
 
#define add_module(name, psz_caps, value, text, longtext)
 
#define add_module_list(name, psz_caps, value, text, longtext)
 
#define add_module_cat(name, i_subcategory, value, text, longtext)
 
#define add_module_list_cat(name, i_subcategory, value, text, longtext)
 
#define add_integer(name, value, text, longtext, advc)   add_int_inner(CONFIG_ITEM_INTEGER, name, text, longtext, value)
 
#define add_rgb(name, value, text, longtext)
 
#define add_key(name, value, text, longtext)
 
#define add_integer_with_range(name, value, i_min, i_max, text, longtext, advc)
 
#define add_float(name, v, text, longtext, advc)
 
#define add_float_with_range(name, value, f_min, f_max, text, longtext, advc)
 
#define add_bool(name, v, text, longtext, advc)
 
#define add_obsolete_inner(name, type)
 
#define add_obsolete_bool(name)   add_obsolete_inner( name, CONFIG_ITEM_BOOL )
 
#define add_obsolete_integer(name)   add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
 
#define add_obsolete_float(name)   add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
 
#define add_obsolete_string(name)   add_obsolete_inner( name, CONFIG_ITEM_STRING )
 
#define change_short(ch)   vlc_config_set (VLC_CONFIG_SHORTCUT, (int)(ch));
 
#define change_string_list(list, list_text)
 
#define change_integer_list(list, list_text)
 
#define change_integer_range(minv, maxv)   vlc_config_set (VLC_CONFIG_RANGE, (int64_t)(minv), (int64_t)(maxv));
 
#define change_float_range(minv, maxv)   vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv));
 
#define change_private()   vlc_config_set (VLC_CONFIG_PRIVATE);
 
#define change_volatile()
 
#define change_safe()   vlc_config_set (VLC_CONFIG_SAFE);
 
#define VLC_CONFIG_INTEGER_ENUM(cb)
 
#define VLC_CONFIG_STRING_ENUM(cb)
 
#define VLC_META_EXPORT(name, value)
 
#define VLC_API_VERSION_EXPORT   VLC_META_EXPORT(api_version, VLC_API_VERSION_STRING)
 
#define VLC_COPYRIGHT_VIDEOLAN
 
#define VLC_LICENSE_LGPL_2_1_PLUS
 
#define VLC_LICENSE_GPL_2_PLUS
 
#define VLC_COPYRIGHT_EXPORT
 
#define VLC_LICENSE_EXPORT
 
#define VLC_METADATA_EXPORTS
 

Typedefs

typedef int(* vlc_set_cb) (void *, void *, int,...)
 

Enumerations

enum  vlc_module_properties {
  VLC_MODULE_CREATE, VLC_CONFIG_CREATE, VLC_MODULE_CPU_REQUIREMENT =0x100, VLC_MODULE_SHORTCUT,
  VLC_MODULE_CAPABILITY, VLC_MODULE_SCORE, VLC_MODULE_CB_OPEN, VLC_MODULE_CB_CLOSE,
  VLC_MODULE_NO_UNLOAD, VLC_MODULE_NAME, VLC_MODULE_SHORTNAME, VLC_MODULE_DESCRIPTION,
  VLC_MODULE_HELP, VLC_MODULE_TEXTDOMAIN, VLC_CONFIG_NAME =0x1000, VLC_CONFIG_VALUE,
  VLC_CONFIG_RANGE, VLC_CONFIG_ADVANCED_RESERVED, VLC_CONFIG_VOLATILE, VLC_CONFIG_PERSISTENT_OBSOLETE,
  VLC_CONFIG_PRIVATE, VLC_CONFIG_REMOVED, VLC_CONFIG_CAPABILITY, VLC_CONFIG_SHORTCUT,
  VLC_CONFIG_OLDNAME_OBSOLETE, VLC_CONFIG_SAFE, VLC_CONFIG_DESC, VLC_CONFIG_LIST_OBSOLETE,
  VLC_CONFIG_ADD_ACTION_OBSOLETE, VLC_CONFIG_LIST, VLC_CONFIG_LIST_CB_OBSOLETE
}
 

Functions

int vlc_entry__MODULE_NAME (vlc_set_cb, void *)
 
int vlc_entry_cfg_int_enum__MODULE_NAME (const char *name, int64_t **values, char ***descs)
 
int vlc_entry_cfg_str_enum__MODULE_NAME (const char *name, char ***values, char ***descs)
 

Detailed Description

This file implements plugin (module) macros used to define a vlc module.

Macro Definition Documentation

◆ add_bool

#define add_bool (   name,
  v,
  text,
  longtext,
  advc 
)
Value:
if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true);
#define CONFIG_ITEM_BOOL
Definition: vlc_plugin.h:123
const char name[16]
Definition: httpd.c:1266
#define add_typename_inner(type, name, text, longtext)
Definition: vlc_plugin.h:350
Definition: vlc_plugin.h:59
#define vlc_config_set(...)
Definition: vlc_plugin.h:245

◆ add_category_hint

#define add_category_hint (   text,
  longtext 
)    add_typedesc_inner( CONFIG_HINT_CATEGORY, text, longtext )

◆ add_directory

#define add_directory (   name,
  value,
  text,
  longtext 
)    add_string_inner(CONFIG_ITEM_DIRECTORY, name, text, longtext, value)

◆ add_float

#define add_float (   name,
  v,
  text,
  longtext,
  advc 
)
Value:
vlc_config_set (VLC_CONFIG_VALUE, (double)(v));
const char name[16]
Definition: httpd.c:1266
#define add_typename_inner(type, name, text, longtext)
Definition: vlc_plugin.h:350
Definition: vlc_plugin.h:59
#define CONFIG_ITEM_FLOAT
Definition: vlc_plugin.h:120

◆ add_float_with_range

#define add_float_with_range (   name,
  value,
  f_min,
  f_max,
  text,
  longtext,
  advc 
)
Value:
add_float( name, value, text, longtext, advc ) \
change_float_range( f_min, f_max )
#define add_float(name, v, text, longtext, advc)
Definition: vlc_plugin.h:433
const char name[16]
Definition: httpd.c:1266

◆ add_font

#define add_font (   name,
  value,
  text,
  longtext 
)    add_string_inner(CONFIG_ITEM_FONT, name, text, longtext, value)

◆ add_int_inner

#define add_int_inner (   type,
  name,
  text,
  longtext,
 
)
Value:
add_typename_inner(type, name, text, longtext) \
vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v));
const char name[16]
Definition: httpd.c:1266
#define add_typename_inner(type, name, text, longtext)
Definition: vlc_plugin.h:350
Definition: vlc_plugin.h:59

◆ add_integer

#define add_integer (   name,
  value,
  text,
  longtext,
  advc 
)    add_int_inner(CONFIG_ITEM_INTEGER, name, text, longtext, value)

◆ add_integer_with_range

#define add_integer_with_range (   name,
  value,
  i_min,
  i_max,
  text,
  longtext,
  advc 
)
Value:
add_integer( name, value, text, longtext, advc ) \
change_integer_range( i_min, i_max )
#define add_integer(name, value, text, longtext, advc)
Definition: vlc_plugin.h:417
const char name[16]
Definition: httpd.c:1266

◆ add_key

#define add_key (   name,
  value,
  text,
  longtext 
)
Value:
add_string_inner(CONFIG_ITEM_KEY, "global-" name, text, longtext, \
add_string_inner(CONFIG_ITEM_KEY, name, text, longtext, value)
#define CONFIG_ITEM_KEY
Definition: vlc_plugin.h:126
#define add_string_inner(type, name, text, longtext, v)
Definition: vlc_plugin.h:354
const char name[16]
Definition: httpd.c:1266
#define KEY_UNSET
Definition: vlc_actions.h:49

◆ add_loadfile

#define add_loadfile (   name,
  value,
  text,
  longtext 
)    add_string_inner(CONFIG_ITEM_LOADFILE, name, text, longtext, value)

◆ add_module

#define add_module (   name,
  psz_caps,
  value,
  text,
  longtext 
)
Value:
add_string_inner(CONFIG_ITEM_MODULE, name, text, longtext, value) \
vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
Definition: vlc_plugin.h:80
#define CONFIG_ITEM_MODULE
Definition: vlc_plugin.h:127
#define add_string_inner(type, name, text, longtext, v)
Definition: vlc_plugin.h:354
const char name[16]
Definition: httpd.c:1266

◆ add_module_cat

#define add_module_cat (   name,
  i_subcategory,
  value,
  text,
  longtext 
)
Value:
add_string_inner(CONFIG_ITEM_MODULE_CAT, name, text, longtext, value) \
change_integer_range (i_subcategory /* gruik */, 0);
#define CONFIG_ITEM_MODULE_CAT
Definition: vlc_plugin.h:128
#define add_string_inner(type, name, text, longtext, v)
Definition: vlc_plugin.h:354
const char name[16]
Definition: httpd.c:1266

◆ add_module_list

#define add_module_list (   name,
  psz_caps,
  value,
  text,
  longtext 
)
Value:
add_string_inner(CONFIG_ITEM_MODULE_LIST, name, text, longtext, value) \
vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
Definition: vlc_plugin.h:80
#define add_string_inner(type, name, text, longtext, v)
Definition: vlc_plugin.h:354
#define CONFIG_ITEM_MODULE_LIST
Definition: vlc_plugin.h:129
const char name[16]
Definition: httpd.c:1266

◆ add_module_list_cat

#define add_module_list_cat (   name,
  i_subcategory,
  value,
  text,
  longtext 
)
Value:
value) \
change_integer_range (i_subcategory /* gruik */, 0);
#define CONFIG_ITEM_MODULE_LIST_CAT
Definition: vlc_plugin.h:130
#define add_string_inner(type, name, text, longtext, v)
Definition: vlc_plugin.h:354
const char name[16]
Definition: httpd.c:1266

◆ add_obsolete_bool

#define add_obsolete_bool (   name)    add_obsolete_inner( name, CONFIG_ITEM_BOOL )

◆ add_obsolete_float

#define add_obsolete_float (   name)    add_obsolete_inner( name, CONFIG_ITEM_FLOAT )

◆ add_obsolete_inner

#define add_obsolete_inner (   name,
  type 
)
Value:
add_type_inner( type ) \
vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); \
vlc_config_set (VLC_CONFIG_REMOVED);
#define add_type_inner(type)
Definition: vlc_plugin.h:342
const char name[16]
Definition: httpd.c:1266
Definition: vlc_plugin.h:56
Definition: vlc_plugin.h:77

◆ add_obsolete_integer

#define add_obsolete_integer (   name)    add_obsolete_inner( name, CONFIG_ITEM_INTEGER )

◆ add_obsolete_string

#define add_obsolete_string (   name)    add_obsolete_inner( name, CONFIG_ITEM_STRING )

◆ add_password

#define add_password (   name,
  value,
  text,
  longtext 
)    add_string_inner(CONFIG_ITEM_PASSWORD, name, text, longtext, value)

◆ add_rgb

#define add_rgb (   name,
  value,
  text,
  longtext 
)
Value:
add_int_inner(CONFIG_ITEM_RGB, name, text, longtext, value) \
change_integer_range( 0, 0xFFFFFF )
#define add_int_inner(type, name, text, longtext, v)
Definition: vlc_plugin.h:358
const char name[16]
Definition: httpd.c:1266
#define CONFIG_ITEM_RGB
Definition: vlc_plugin.h:122

◆ add_savefile

#define add_savefile (   name,
  value,
  text,
  longtext 
)    add_string_inner(CONFIG_ITEM_SAVEFILE, name, text, longtext, value)

◆ add_shortcut

#define add_shortcut (   ...)
Value:
{ \
const char *shortcuts[] = { __VA_ARGS__ }; \
sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
goto error; \
}
#define vlc_module_set(...)
Definition: vlc_plugin.h:244
Definition: vlc_plugin.h:41

◆ add_string

#define add_string (   name,
  value,
  text,
  longtext,
  advc 
)    add_string_inner(CONFIG_ITEM_STRING, name, text, longtext, value)

◆ add_string_inner

#define add_string_inner (   type,
  name,
  text,
  longtext,
 
)
Value:
add_typename_inner(type, name, text, longtext) \
vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v));
const char name[16]
Definition: httpd.c:1266
#define add_typename_inner(type, name, text, longtext)
Definition: vlc_plugin.h:350
Definition: vlc_plugin.h:59

◆ add_submodule

#define add_submodule ( )
Value:
goto error;
#define vlc_plugin_set(...)
Definition: vlc_plugin.h:243
Definition: vlc_plugin.h:35

◆ add_type_inner

#define add_type_inner (   type)    vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config);

◆ add_typedesc_inner

#define add_typedesc_inner (   type,
  text,
  longtext 
)
Value:
add_type_inner( type ) \
vlc_config_set (VLC_CONFIG_DESC, \
(const char *)(text), (const char *)(longtext));
#define add_type_inner(type)
Definition: vlc_plugin.h:342
Definition: vlc_plugin.h:92

◆ add_typename_inner

#define add_typename_inner (   type,
  name,
  text,
  longtext 
)
Value:
add_typedesc_inner(type, text, longtext) \
vlc_config_set (VLC_CONFIG_NAME, (const char *)(name));
const char name[16]
Definition: httpd.c:1266
Definition: vlc_plugin.h:56
#define add_typedesc_inner(type, text, longtext)
Definition: vlc_plugin.h:345

◆ add_usage_hint

#define add_usage_hint (   text)    add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )

◆ cannot_unload_broken_library

#define cannot_unload_broken_library ( )
Value:
goto error;
#define vlc_module_set(...)
Definition: vlc_plugin.h:244
Definition: vlc_plugin.h:46

◆ CAT_ADVANCED

#define CAT_ADVANCED   6

◆ CAT_AUDIO

#define CAT_AUDIO   2

◆ CAT_INPUT

#define CAT_INPUT   4

◆ CAT_INTERFACE

#define CAT_INTERFACE   1

◆ CAT_PLAYLIST

#define CAT_PLAYLIST   7

◆ CAT_SOUT

#define CAT_SOUT   5

◆ CAT_VIDEO

#define CAT_VIDEO   3

◆ CDECL_SYMBOL

#define CDECL_SYMBOL

◆ change_float_range

#define change_float_range (   minv,
  maxv 
)    vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv));

◆ change_integer_list

#define change_integer_list (   list,
  list_text 
)
Value:
(size_t)(sizeof (list) / sizeof (int)), \
(const int *)(list), \
(const char *const *)(list_text));
Definition: vlc_plugin.h:101
module_config_t ** list
Definition: core.c:401
#define vlc_config_set(...)
Definition: vlc_plugin.h:245

◆ change_integer_range

#define change_integer_range (   minv,
  maxv 
)    vlc_config_set (VLC_CONFIG_RANGE, (int64_t)(minv), (int64_t)(maxv));

◆ change_private

#define change_private ( )    vlc_config_set (VLC_CONFIG_PRIVATE);

◆ change_safe

#define change_safe ( )    vlc_config_set (VLC_CONFIG_SAFE);

◆ change_short

#define change_short (   ch)    vlc_config_set (VLC_CONFIG_SHORTCUT, (int)(ch));

◆ change_string_list

#define change_string_list (   list,
  list_text 
)
Value:
(size_t)(sizeof (list) / sizeof (char *)), \
(const char *const *)(list), \
(const char *const *)(list_text));
Definition: vlc_plugin.h:101
module_config_t ** list
Definition: core.c:401
#define vlc_config_set(...)
Definition: vlc_plugin.h:245

◆ change_volatile

#define change_volatile ( )
Value:
vlc_config_set (VLC_CONFIG_VOLATILE);
Definition: vlc_plugin.h:68
#define change_private()
Definition: vlc_plugin.h:487

◆ CONCATENATE

#define CONCATENATE (   y,
 
)    CRUDE_HACK( y, z )

◆ CONFIG_CATEGORY

#define CONFIG_CATEGORY   0x06 /* Set category */

◆ CONFIG_HINT_CATEGORY

#define CONFIG_HINT_CATEGORY   0x02 /* Start of new category */

Referenced by print_item().

◆ CONFIG_HINT_USAGE

#define CONFIG_HINT_USAGE   0x05 /* Usage information */

Referenced by print_item().

◆ CONFIG_ITEM

#define CONFIG_ITEM (   x)    (((x) & ~0xF) != 0)

◆ CONFIG_ITEM_BOOL

#define CONFIG_ITEM_BOOL   0x60 /* Bool option */

◆ CONFIG_ITEM_DIRECTORY

#define CONFIG_ITEM_DIRECTORY   0x8E /* Directory option */

◆ CONFIG_ITEM_FLOAT

#define CONFIG_ITEM_FLOAT   0x20 /* Float option */

◆ CONFIG_ITEM_FONT

#define CONFIG_ITEM_FONT   0x8F /* Font option */

◆ CONFIG_ITEM_INTEGER

#define CONFIG_ITEM_INTEGER   0x40 /* Integer option */

◆ CONFIG_ITEM_KEY

#define CONFIG_ITEM_KEY   0x82 /* Hot key option */

◆ CONFIG_ITEM_LOADFILE

#define CONFIG_ITEM_LOADFILE   0x8C /* Read file option */

◆ CONFIG_ITEM_MODULE

#define CONFIG_ITEM_MODULE   0x84 /* Module option */

Referenced by config_GetPszChoices().

◆ CONFIG_ITEM_MODULE_CAT

#define CONFIG_ITEM_MODULE_CAT   0x85 /* Module option */

◆ CONFIG_ITEM_MODULE_LIST

#define CONFIG_ITEM_MODULE_LIST   0x86 /* Module option */

◆ CONFIG_ITEM_MODULE_LIST_CAT

#define CONFIG_ITEM_MODULE_LIST_CAT   0x87 /* Module option */

◆ CONFIG_ITEM_PASSWORD

#define CONFIG_ITEM_PASSWORD   0x81 /* Password option (*) */

◆ CONFIG_ITEM_RGB

#define CONFIG_ITEM_RGB   0x41 /* RGB color option */

◆ CONFIG_ITEM_SAVEFILE

#define CONFIG_ITEM_SAVEFILE   0x8D /* Written file option */

◆ CONFIG_ITEM_STRING

#define CONFIG_ITEM_STRING   0x80 /* String option */

◆ CONFIG_SECTION

#define CONFIG_SECTION   0x08 /* Start of new section */

Referenced by print_item().

◆ CONFIG_SUBCATEGORY

#define CONFIG_SUBCATEGORY   0x07 /* Set subcategory */

◆ CRUDE_HACK

#define CRUDE_HACK (   y,
 
)    y##__##z

◆ DLL_SYMBOL

#define DLL_SYMBOL

◆ EXTERN_SYMBOL

#define EXTERN_SYMBOL

◆ set_callback

#define set_callback (   activate)
Value:
if (vlc_module_set(VLC_MODULE_CB_OPEN, #activate, (void *)(activate))) \
goto error;
#define vlc_module_set(...)
Definition: vlc_plugin.h:244
Definition: vlc_plugin.h:44

◆ set_callbacks

#define set_callbacks (   activate,
  deactivate 
)
Value:
set_callback(activate) \
if (vlc_module_set(VLC_MODULE_CB_CLOSE, #deactivate, \
(void (*)(vlc_object_t *)){ deactivate })) \
goto error;
#define set_callback(activate)
Definition: vlc_plugin.h:311
#define vlc_module_set(...)
Definition: vlc_plugin.h:244
Definition: vlc_plugin.h:45
VLC object common members.
Definition: vlc_objects.h:43

◆ set_capability

#define set_capability (   cap,
  score 
)
Value:
if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \
|| vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \
goto error;
Definition: vlc_plugin.h:43
#define vlc_module_set(...)
Definition: vlc_plugin.h:244
Definition: vlc_plugin.h:42

◆ set_category

#define set_category (   i_id)
Value:
vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
#define add_type_inner(type)
Definition: vlc_plugin.h:342
Definition: vlc_plugin.h:59
#define CONFIG_CATEGORY
Definition: vlc_plugin.h:115

◆ set_description

#define set_description (   desc)
Value:
if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \
goto error;
Definition: vlc_plugin.h:49
#define vlc_module_set(...)
Definition: vlc_plugin.h:244

◆ set_help

#define set_help (   help)
Value:
if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \
goto error;
#define vlc_module_set(...)
Definition: vlc_plugin.h:244
Definition: vlc_plugin.h:50

◆ set_section

#define set_section (   text,
  longtext 
)    add_typedesc_inner( CONFIG_SECTION, text, longtext )

◆ set_shortname

#define set_shortname (   shortname)
Value:
if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \
goto error;
Definition: vlc_plugin.h:48
#define vlc_module_set(...)
Definition: vlc_plugin.h:244

◆ set_subcategory

#define set_subcategory (   i_id)
Value:
vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
#define CONFIG_SUBCATEGORY
Definition: vlc_plugin.h:116
#define add_type_inner(type)
Definition: vlc_plugin.h:342
Definition: vlc_plugin.h:59

◆ set_text_domain

#define set_text_domain (   dom)
Value:
goto error;
Definition: vlc_plugin.h:51
#define vlc_plugin_set(...)
Definition: vlc_plugin.h:243

◆ SUBCAT_ADVANCED_MISC

#define SUBCAT_ADVANCED_MISC   602

◆ SUBCAT_ADVANCED_NETWORK

#define SUBCAT_ADVANCED_NETWORK   603

◆ SUBCAT_AUDIO_AFILTER

#define SUBCAT_AUDIO_AFILTER   203

◆ SUBCAT_AUDIO_AOUT

#define SUBCAT_AUDIO_AOUT   202

◆ SUBCAT_AUDIO_GENERAL

#define SUBCAT_AUDIO_GENERAL   201

◆ SUBCAT_AUDIO_MISC

#define SUBCAT_AUDIO_MISC   205

◆ SUBCAT_AUDIO_RESAMPLER

#define SUBCAT_AUDIO_RESAMPLER   206

◆ SUBCAT_AUDIO_VISUAL

#define SUBCAT_AUDIO_VISUAL   204

◆ SUBCAT_INPUT_ACCESS

#define SUBCAT_INPUT_ACCESS   402

◆ SUBCAT_INPUT_ACODEC

#define SUBCAT_INPUT_ACODEC   405

◆ SUBCAT_INPUT_DEMUX

#define SUBCAT_INPUT_DEMUX   403

◆ SUBCAT_INPUT_GENERAL

#define SUBCAT_INPUT_GENERAL   401

◆ SUBCAT_INPUT_SCODEC

#define SUBCAT_INPUT_SCODEC   406

◆ SUBCAT_INPUT_STREAM_FILTER

#define SUBCAT_INPUT_STREAM_FILTER   407

◆ SUBCAT_INPUT_VCODEC

#define SUBCAT_INPUT_VCODEC   404

◆ SUBCAT_INTERFACE_CONTROL

#define SUBCAT_INTERFACE_CONTROL   103

◆ SUBCAT_INTERFACE_GENERAL

#define SUBCAT_INTERFACE_GENERAL   101

◆ SUBCAT_INTERFACE_HOTKEYS

#define SUBCAT_INTERFACE_HOTKEYS   104

◆ SUBCAT_INTERFACE_MAIN

#define SUBCAT_INTERFACE_MAIN   102

◆ SUBCAT_PLAYLIST_EXPORT

#define SUBCAT_PLAYLIST_EXPORT   703

◆ SUBCAT_PLAYLIST_GENERAL

#define SUBCAT_PLAYLIST_GENERAL   701

◆ SUBCAT_PLAYLIST_SD

#define SUBCAT_PLAYLIST_SD   702

◆ SUBCAT_SOUT_ACO

#define SUBCAT_SOUT_ACO   504

◆ SUBCAT_SOUT_GENERAL

#define SUBCAT_SOUT_GENERAL   501

◆ SUBCAT_SOUT_MUX

#define SUBCAT_SOUT_MUX   503

◆ SUBCAT_SOUT_PACKETIZER

#define SUBCAT_SOUT_PACKETIZER   505

◆ SUBCAT_SOUT_RENDERER

#define SUBCAT_SOUT_RENDERER   508

◆ SUBCAT_SOUT_STREAM

#define SUBCAT_SOUT_STREAM   502

◆ SUBCAT_SOUT_VOD

#define SUBCAT_SOUT_VOD   507

◆ SUBCAT_VIDEO_GENERAL

#define SUBCAT_VIDEO_GENERAL   301

◆ SUBCAT_VIDEO_SPLITTER

#define SUBCAT_VIDEO_SPLITTER   306

◆ SUBCAT_VIDEO_SUBPIC

#define SUBCAT_VIDEO_SUBPIC   305

◆ SUBCAT_VIDEO_VFILTER

#define SUBCAT_VIDEO_VFILTER   303

◆ SUBCAT_VIDEO_VOUT

#define SUBCAT_VIDEO_VOUT   302

◆ VLC_API_VERSION_EXPORT

#define VLC_API_VERSION_EXPORT   VLC_META_EXPORT(api_version, VLC_API_VERSION_STRING)

◆ VLC_API_VERSION_STRING

#define VLC_API_VERSION_STRING   "4.0.4"

Current plugin ABI version.

Referenced by module_InitStaticModules().

◆ VLC_CONFIG_INTEGER_ENUM

#define VLC_CONFIG_INTEGER_ENUM (   cb)
Value:
EXTERN_SYMBOL DLL_SYMBOL \
int CDECL_SYMBOL VLC_SYMBOL(vlc_entry_cfg_int_enum)(const char *name, \
int64_t **values, char ***descs) \
{ \
return (cb)(name, values, descs); \
}
#define EXTERN_SYMBOL
Definition: vlc_plugin.h:238
#define CDECL_SYMBOL
Definition: vlc_plugin.h:220
const char name[16]
Definition: httpd.c:1266
#define VLC_SYMBOL(symbol)
Definition: vlc_plugin.h:216

◆ vlc_config_set

#define vlc_config_set (   ...)    vlc_set (opaque, config, __VA_ARGS__)

◆ VLC_CONFIG_STRING_ENUM

#define VLC_CONFIG_STRING_ENUM (   cb)
Value:
EXTERN_SYMBOL DLL_SYMBOL \
int CDECL_SYMBOL VLC_SYMBOL(vlc_entry_cfg_str_enum)(const char *name, \
char ***values, char ***descs) \
{ \
return (cb)(name, values, descs); \
}
#define EXTERN_SYMBOL
Definition: vlc_plugin.h:238
#define CDECL_SYMBOL
Definition: vlc_plugin.h:220
const char name[16]
Definition: httpd.c:1266
#define VLC_SYMBOL(symbol)
Definition: vlc_plugin.h:216

◆ VLC_COPYRIGHT_EXPORT

#define VLC_COPYRIGHT_EXPORT

◆ VLC_COPYRIGHT_VIDEOLAN

#define VLC_COPYRIGHT_VIDEOLAN
Value:
"\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
"\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
"\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
"\x6c\x6f\x70\x65\x72\x73"

◆ VLC_LICENSE_EXPORT

#define VLC_LICENSE_EXPORT

◆ VLC_LICENSE_GPL_2_PLUS

#define VLC_LICENSE_GPL_2_PLUS
Value:
"\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
"\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
"\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
"\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
"\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e"

◆ VLC_LICENSE_LGPL_2_1_PLUS

#define VLC_LICENSE_LGPL_2_1_PLUS
Value:
"\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
"\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
"\x47\x4e\x55\x20\x4c\x65\x73\x73\x65\x72\x20\x47\x65\x6e\x65\x72" \
"\x61\x6c\x20\x50\x75\x62\x6c\x69\x63\x20\x4c\x69\x63\x65\x6e\x73" \
"\x65\x2c\x20\x76\x65\x72\x73\x69\x6f\x6e\x20\x32\x2e\x31\x20\x6f" \
"\x72\x20\x6c\x61\x74\x65\x72\x2e"

◆ VLC_META_EXPORT

#define VLC_META_EXPORT (   name,
  value 
)
Value:
VLC_SYMBOL(vlc_entry_ ## name)(void); \
EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
VLC_SYMBOL(vlc_entry_ ## name)(void) \
{ \
return value; \
}
#define EXTERN_SYMBOL
Definition: vlc_plugin.h:238
#define DLL_SYMBOL
Definition: vlc_plugin.h:232
const char name[16]
Definition: httpd.c:1266
#define VLC_SYMBOL(symbol)
Definition: vlc_plugin.h:216

◆ VLC_METADATA_EXPORTS

#define VLC_METADATA_EXPORTS
Value:
VLC_API_VERSION_EXPORT \
VLC_COPYRIGHT_EXPORT \
VLC_LICENSE_EXPORT

◆ vlc_module_begin

#define vlc_module_begin ( )
Value:
EXTERN_SYMBOL DLL_SYMBOL \
int CDECL_SYMBOL VLC_SYMBOL(vlc_entry)(vlc_set_cb vlc_set, void *opaque) \
{ \
module_t *module; \
module_config_t *config = NULL; \
goto error; \
goto error;
#define EXTERN_SYMBOL
Definition: vlc_plugin.h:238
static struct @10 config
static void vlc_entry(void *p)
Definition: thread.c:277
Definition: vlc_plugin.h:47
int(* vlc_set_cb)(void *, void *, int,...)
Definition: vlc_plugin.h:241
#define vlc_plugin_set(...)
Definition: vlc_plugin.h:243
#define CDECL_SYMBOL
Definition: vlc_plugin.h:220
#define vlc_module_set(...)
Definition: vlc_plugin.h:244
#define VLC_SYMBOL(symbol)
Definition: vlc_plugin.h:216
#define MODULE_STRING
Definition: access.c:26
Definition: vlc_plugin.h:35

◆ vlc_module_end

#define vlc_module_end ( )
Value:
(void) config; \
return 0; \
error: \
return -1; \
} \
VLC_MODULE_NAME_HIDDEN_SYMBOL \
VLC_METADATA_EXPORTS
static struct @10 config

◆ VLC_MODULE_NAME_HIDDEN_SYMBOL

#define VLC_MODULE_NAME_HIDDEN_SYMBOL

◆ vlc_module_set

#define vlc_module_set (   ...)    vlc_set (opaque, module, __VA_ARGS__)

◆ vlc_plugin_set

#define vlc_plugin_set (   ...)    vlc_set (opaque, NULL, __VA_ARGS__)

◆ VLC_SYMBOL

#define VLC_SYMBOL (   symbol)    CONCATENATE(symbol, MODULE_NAME)

Typedef Documentation

◆ vlc_set_cb

typedef int(* vlc_set_cb) (void *, void *, int,...)

Enumeration Type Documentation

◆ vlc_module_properties

Enumerator
VLC_MODULE_CREATE 
VLC_CONFIG_CREATE 
VLC_MODULE_CPU_REQUIREMENT 
VLC_MODULE_SHORTCUT 
VLC_MODULE_CAPABILITY 
VLC_MODULE_SCORE 
VLC_MODULE_CB_OPEN 
VLC_MODULE_CB_CLOSE 
VLC_MODULE_NO_UNLOAD 
VLC_MODULE_NAME 
VLC_MODULE_SHORTNAME 
VLC_MODULE_DESCRIPTION 
VLC_MODULE_HELP 
VLC_MODULE_TEXTDOMAIN 
VLC_CONFIG_NAME 
VLC_CONFIG_VALUE 
VLC_CONFIG_RANGE 
VLC_CONFIG_ADVANCED_RESERVED 
VLC_CONFIG_VOLATILE 
VLC_CONFIG_PERSISTENT_OBSOLETE 
VLC_CONFIG_PRIVATE 
VLC_CONFIG_REMOVED 
VLC_CONFIG_CAPABILITY 
VLC_CONFIG_SHORTCUT 
VLC_CONFIG_OLDNAME_OBSOLETE 
VLC_CONFIG_SAFE 
VLC_CONFIG_DESC 
VLC_CONFIG_LIST_OBSOLETE 
VLC_CONFIG_ADD_ACTION_OBSOLETE 
VLC_CONFIG_LIST 
VLC_CONFIG_LIST_CB_OBSOLETE 

Function Documentation

◆ vlc_entry__MODULE_NAME()

int vlc_entry__MODULE_NAME ( vlc_set_cb  ,
void *   
)

◆ vlc_entry_cfg_int_enum__MODULE_NAME()

int vlc_entry_cfg_int_enum__MODULE_NAME ( const char *  name,
int64_t **  values,
char ***  descs 
)

◆ vlc_entry_cfg_str_enum__MODULE_NAME()

int vlc_entry_cfg_str_enum__MODULE_NAME ( const char *  name,
char ***  values,
char ***  descs 
)