VLC 4.0.0-dev
Loading...
Searching...
No Matches
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_SUBCATEGORY   0x07 /* Set subcategory */
 
#define CONFIG_SECTION   0x08 /* Start of new section */
 
#define CONFIG_ITEM_FLOAT   (1 << 5) /* Float option */
 
#define CONFIG_ITEM_INTEGER   (2 << 5) /* Integer option */
 
#define CONFIG_ITEM_RGB   (CONFIG_ITEM_INTEGER | 0x01) /* RGB color option */
 
#define CONFIG_ITEM_BOOL   (3 << 5) /* Bool option */
 
#define CONFIG_ITEM_STRING   (4 << 5) /* String option */
 
#define CONFIG_ITEM_PASSWORD   (CONFIG_ITEM_STRING | 0x01) /* Password option (*) */
 
#define CONFIG_ITEM_KEY   (CONFIG_ITEM_STRING | 0x02) /* Hot key option */
 
#define CONFIG_ITEM_MODULE   (CONFIG_ITEM_STRING | 0x04) /* Module option */
 
#define CONFIG_ITEM_MODULE_CAT   (CONFIG_ITEM_STRING | 0x05) /* Module option */
 
#define CONFIG_ITEM_MODULE_LIST   (CONFIG_ITEM_STRING | 0x06) /* Module option */
 
#define CONFIG_ITEM_MODULE_LIST_CAT   (CONFIG_ITEM_STRING | 0x07) /* Module option */
 
#define CONFIG_ITEM_LOADFILE   (CONFIG_ITEM_STRING | 0x0C) /* Read file option */
 
#define CONFIG_ITEM_SAVEFILE   (CONFIG_ITEM_STRING | 0x0D) /* Written file option */
 
#define CONFIG_ITEM_DIRECTORY   (CONFIG_ITEM_STRING | 0x0E) /* Directory option */
 
#define CONFIG_ITEM_FONT   (CONFIG_ITEM_STRING | 0x0F) /* Font option */
 
#define CONFIG_CLASS(x)   ((x) & ~0x1F)
 
#define CONFIG_ITEM(x)   (((x) & ~0xF) != 0)
 
#define IsConfigStringType(type)    (((type) & CONFIG_ITEM_STRING) != 0)
 
#define IsConfigIntegerType(type)    (((type) & CONFIG_ITEM_INTEGER) != 0)
 
#define IsConfigFloatType(type)    ((type) == CONFIG_ITEM_FLOAT)
 
#define VLC_API_VERSION_STRING   "4.0.6"
 Current plugin ABI version.
 
#define CONCATENATE(y, z)   CRUDE_HACK( y, z )
 
#define CRUDE_HACK(y, z)   y##__##z
 
#define STRINGIFY_NAME_(z)   #z
 
#define STRINGIFY_NAME(z)   STRINGIFY_NAME_( z )
 
#define EXTERN_SYMBOL
 
#define VLC_ENTRY_FUNC(name)   int (name)(vlc_set_cb, void *)
 
#define VLC_MODULE_ENTRY(name)   CONCATENATE(vlc_entry, name)
 
#define VLC_DECL_MODULE_ENTRY(name)   VLC_ENTRY_FUNC(VLC_MODULE_ENTRY(name))
 
#define VLC_SYMBOL(symbol)   CONCATENATE(symbol, MODULE_NAME)
 
#define VLC_MODULE_NAME_HIDDEN_SYMBOL
 
#define CDECL_SYMBOL
 
#define DLL_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_CHECKED_TYPE(type, value)   (type){ value }
 
#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_help_html(help_html)
 
#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_subcategory(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_string(name, value, text, longtext)    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, cap, value, text, longtext)
 
#define add_module_list(name, cap, value, text, longtext)
 
#define add_module_cat(name, subcategory, value, text, longtext)
 
#define add_module_list_cat(name, subcategory, value, text, longtext)
 
#define add_integer(name, value, text, longtext)    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, min, max, text, longtext)
 
#define add_float(name, v, text, longtext)
 
#define add_float_with_range(name, value, min, max, text, longtext)
 
#define add_bool(name, v, text, longtext)
 
#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, VLC_CHECKED_TYPE(char, ch));
 
#define change_string_list(list, list_text)
 
#define change_integer_list(list, list_text)
 
#define change_integer_range(minv, maxv)
 
#define change_float_range(minv, 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,...)
 
typedef int(* vlc_plugin_cb) (vlc_set_cb, void *)
 Plugin entry point prototype.
 

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_MODULE_HELP_HTML , 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
}
 
enum  vlc_config_cat {
  CAT_HIDDEN = -1 , CAT_UNKNOWN = 0 , CAT_INTERFACE = 1 , CAT_AUDIO = 2 ,
  CAT_VIDEO = 3 , CAT_INPUT = 4 , CAT_SOUT = 5 , CAT_ADVANCED = 6 ,
  CAT_PLAYLIST = 7
}
 
enum  vlc_config_subcat {
  SUBCAT_HIDDEN = -1 , SUBCAT_UNKNOWN = 0 , SUBCAT_INTERFACE_GENERAL = 101 , SUBCAT_INTERFACE_MAIN = 102 ,
  SUBCAT_INTERFACE_CONTROL = 103 , SUBCAT_INTERFACE_HOTKEYS = 104 , SUBCAT_AUDIO_GENERAL = 201 , SUBCAT_AUDIO_AOUT = 202 ,
  SUBCAT_AUDIO_AFILTER = 203 , SUBCAT_AUDIO_VISUAL = 204 , SUBCAT_AUDIO_RESAMPLER = 206 , SUBCAT_VIDEO_GENERAL = 301 ,
  SUBCAT_VIDEO_VOUT = 302 , SUBCAT_VIDEO_VFILTER = 303 , SUBCAT_VIDEO_SUBPIC = 305 , SUBCAT_VIDEO_SPLITTER = 306 ,
  SUBCAT_INPUT_GENERAL = 401 , SUBCAT_INPUT_ACCESS = 402 , SUBCAT_INPUT_DEMUX = 403 , SUBCAT_INPUT_VCODEC = 404 ,
  SUBCAT_INPUT_ACODEC = 405 , SUBCAT_INPUT_SCODEC = 406 , SUBCAT_INPUT_STREAM_FILTER = 407 , SUBCAT_SOUT_GENERAL = 501 ,
  SUBCAT_SOUT_STREAM = 502 , SUBCAT_SOUT_MUX = 503 , SUBCAT_SOUT_ACO = 504 , SUBCAT_SOUT_PACKETIZER = 505 ,
  SUBCAT_SOUT_VOD = 507 , SUBCAT_SOUT_RENDERER = 508 , SUBCAT_ADVANCED_MISC = 602 , SUBCAT_ADVANCED_NETWORK = 603 ,
  SUBCAT_PLAYLIST_GENERAL = 701 , SUBCAT_PLAYLIST_SD = 702 , SUBCAT_PLAYLIST_EXPORT = 703
}
 

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 
)
Value:
add_typename_inner(CONFIG_ITEM_BOOL, name, text, longtext) \
if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true);
name
const char name[16]
Definition httpd.c:1298
CONFIG_ITEM_BOOL
#define CONFIG_ITEM_BOOL
Definition vlc_plugin.h:124
add_typename_inner
#define add_typename_inner(type, name, text, longtext)
Definition vlc_plugin.h:411
VLC_CONFIG_VALUE
@ VLC_CONFIG_VALUE
Definition vlc_plugin.h:62
vlc_config_set
#define vlc_config_set(...)
Definition vlc_plugin.h:295

◆ 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 
)
Value:
add_typename_inner(CONFIG_ITEM_FLOAT, name, text, longtext) \
vlc_config_set (VLC_CONFIG_VALUE, VLC_CHECKED_TYPE(double, v));
CONFIG_ITEM_FLOAT
#define CONFIG_ITEM_FLOAT
Definition vlc_plugin.h:121
VLC_CHECKED_TYPE
#define VLC_CHECKED_TYPE(type, value)
Definition vlc_plugin.h:310

◆ add_float_with_range

#define add_float_with_range (   name,
  value,
  min,
  max,
  text,
  longtext 
)
Value:
add_float( name, value, text, longtext ) \
change_float_range( min, max )
add_float
#define add_float(name, v, text, longtext)
Definition vlc_plugin.h:489

◆ 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,
  v 
)
Value:
add_typename_inner(type, name, text, longtext) \
vlc_config_set (VLC_CONFIG_VALUE, VLC_CHECKED_TYPE(int64_t, v));

◆ add_integer

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

◆ add_integer_with_range

#define add_integer_with_range (   name,
  value,
  min,
  max,
  text,
  longtext 
)
Value:
add_integer( name, value, text, longtext ) \
change_integer_range( min, max )
add_integer
#define add_integer(name, value, text, longtext)
Definition vlc_plugin.h:473

◆ add_key

#define add_key (   name,
  value,
  text,
  longtext 
)
Value:
add_string_inner(CONFIG_ITEM_KEY, "global-" name, text, longtext, \
KEY_UNSET) \
add_string_inner(CONFIG_ITEM_KEY, name, text, longtext, value)
KEY_UNSET
#define KEY_UNSET
Definition vlc_actions.h:49
CONFIG_ITEM_KEY
#define CONFIG_ITEM_KEY
Definition vlc_plugin.h:127
add_string_inner
#define add_string_inner(type, name, text, longtext, v)
Definition vlc_plugin.h:415

◆ 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,
  cap,
  value,
  text,
  longtext 
)
Value:
add_string_inner(CONFIG_ITEM_MODULE, name, text, longtext, value) \
vlc_config_set (VLC_CONFIG_CAPABILITY, VLC_CHECKED_TYPE(const char *, cap));
VLC_CONFIG_CAPABILITY
@ VLC_CONFIG_CAPABILITY
Definition vlc_plugin.h:83
CONFIG_ITEM_MODULE
#define CONFIG_ITEM_MODULE
Definition vlc_plugin.h:128

◆ add_module_cat

#define add_module_cat (   name,
  subcategory,
  value,
  text,
  longtext 
)
Value:
add_string_inner(CONFIG_ITEM_MODULE_CAT, name, text, longtext, value) \
change_integer_range (subcategory /* gruik */, 0)
CONFIG_ITEM_MODULE_CAT
#define CONFIG_ITEM_MODULE_CAT
Definition vlc_plugin.h:129

◆ add_module_list

#define add_module_list (   name,
  cap,
  value,
  text,
  longtext 
)
Value:
add_string_inner(CONFIG_ITEM_MODULE_LIST, name, text, longtext, value) \
vlc_config_set (VLC_CONFIG_CAPABILITY, VLC_CHECKED_TYPE(const char *, cap));
CONFIG_ITEM_MODULE_LIST
#define CONFIG_ITEM_MODULE_LIST
Definition vlc_plugin.h:130

◆ add_module_list_cat

#define add_module_list_cat (   name,
  subcategory,
  value,
  text,
  longtext 
)
Value:
add_string_inner(CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
value) \
change_integer_range (subcategory /* gruik */, 0)
CONFIG_ITEM_MODULE_LIST_CAT
#define CONFIG_ITEM_MODULE_LIST_CAT
Definition vlc_plugin.h:131

◆ 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, VLC_CHECKED_TYPE(const char *, name)); \
vlc_config_set (VLC_CONFIG_REMOVED);
add_type_inner
#define add_type_inner(type)
Definition vlc_plugin.h:403
VLC_CONFIG_NAME
@ VLC_CONFIG_NAME
Definition vlc_plugin.h:59
VLC_CONFIG_REMOVED
@ VLC_CONFIG_REMOVED
Definition vlc_plugin.h:80

◆ 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 )
add_int_inner
#define add_int_inner(type, name, text, longtext, v)
Definition vlc_plugin.h:419
CONFIG_ITEM_RGB
#define CONFIG_ITEM_RGB
Definition vlc_plugin.h:123

◆ 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__ }; \
if (vlc_module_set (VLC_MODULE_SHORTCUT, \
sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
goto error; \
}
vlc_module_set
#define vlc_module_set(...)
Definition vlc_plugin.h:294
VLC_MODULE_SHORTCUT
@ VLC_MODULE_SHORTCUT
Definition vlc_plugin.h:43

◆ add_string

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

◆ add_string_inner

#define add_string_inner (   type,
  name,
  text,
  longtext,
  v 
)
Value:
add_typename_inner(type, name, text, longtext) \
vlc_config_set (VLC_CONFIG_VALUE, VLC_CHECKED_TYPE(const char *, v));

◆ add_submodule

#define add_submodule ( )
Value:
if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
goto error;
vlc_plugin_set
#define vlc_plugin_set(...)
Definition vlc_plugin.h:293
VLC_MODULE_CREATE
@ VLC_MODULE_CREATE
Definition vlc_plugin.h:37

◆ 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, VLC_CHECKED_TYPE(const char *, text), \
VLC_CHECKED_TYPE(const char *, longtext));
VLC_CONFIG_DESC
@ VLC_CONFIG_DESC
Definition vlc_plugin.h:95

◆ add_typename_inner

#define add_typename_inner (   type,
  name,
  text,
  longtext 
)
Value:
add_typedesc_inner(type, text, longtext) \
vlc_config_set (VLC_CONFIG_NAME, VLC_CHECKED_TYPE(const char *, name));
add_typedesc_inner
#define add_typedesc_inner(type, text, longtext)
Definition vlc_plugin.h:406

◆ cannot_unload_broken_library

#define cannot_unload_broken_library ( )
Value:
if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
goto error;
VLC_MODULE_NO_UNLOAD
@ VLC_MODULE_NO_UNLOAD
Definition vlc_plugin.h:48

◆ CDECL_SYMBOL

#define CDECL_SYMBOL

◆ change_float_range

#define change_float_range (   minv,
  maxv 
)
Value:
vlc_config_set (VLC_CONFIG_RANGE, VLC_CHECKED_TYPE(double, minv), \
VLC_CHECKED_TYPE(double, maxv));
VLC_CONFIG_RANGE
@ VLC_CONFIG_RANGE
Definition vlc_plugin.h:65

◆ change_integer_list

#define change_integer_list (   list,
  list_text 
)
Value:
vlc_config_set (VLC_CONFIG_LIST, \
ARRAY_SIZE(list), \
VLC_CHECKED_TYPE(const int *, list), \
VLC_CHECKED_TYPE(const char *const *, list_text));
list
struct vlc_param ** list
Definition core.c:402
ARRAY_SIZE
#define ARRAY_SIZE(x)
Definition vlc_common.h:905
VLC_CONFIG_LIST
@ VLC_CONFIG_LIST
Definition vlc_plugin.h:104

◆ change_integer_range

#define change_integer_range (   minv,
  maxv 
)
Value:
vlc_config_set (VLC_CONFIG_RANGE, VLC_CHECKED_TYPE(int64_t, minv), \
VLC_CHECKED_TYPE(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, VLC_CHECKED_TYPE(char, ch));

◆ change_string_list

#define change_string_list (   list,
  list_text 
)
Value:
vlc_config_set (VLC_CONFIG_LIST, \
ARRAY_SIZE(list), \
VLC_CHECKED_TYPE(const char *const *, list), \
VLC_CHECKED_TYPE(const char *const *, list_text));

◆ change_volatile

#define change_volatile ( )
Value:
change_private() \
vlc_config_set (VLC_CONFIG_VOLATILE);
VLC_CONFIG_VOLATILE
@ VLC_CONFIG_VOLATILE
Definition vlc_plugin.h:71
change_private
#define change_private()
Definition vlc_plugin.h:545

◆ CONCATENATE

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

◆ CONFIG_CLASS

#define CONFIG_CLASS (   x)    ((x) & ~0x1F)

◆ CONFIG_HINT_CATEGORY

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

◆ CONFIG_ITEM

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

◆ CONFIG_ITEM_BOOL

#define CONFIG_ITEM_BOOL   (3 << 5) /* Bool option */

◆ CONFIG_ITEM_DIRECTORY

#define CONFIG_ITEM_DIRECTORY   (CONFIG_ITEM_STRING | 0x0E) /* Directory option */

◆ CONFIG_ITEM_FLOAT

#define CONFIG_ITEM_FLOAT   (1 << 5) /* Float option */

◆ CONFIG_ITEM_FONT

#define CONFIG_ITEM_FONT   (CONFIG_ITEM_STRING | 0x0F) /* Font option */

◆ CONFIG_ITEM_INTEGER

#define CONFIG_ITEM_INTEGER   (2 << 5) /* Integer option */

◆ CONFIG_ITEM_KEY

#define CONFIG_ITEM_KEY   (CONFIG_ITEM_STRING | 0x02) /* Hot key option */

◆ CONFIG_ITEM_LOADFILE

#define CONFIG_ITEM_LOADFILE   (CONFIG_ITEM_STRING | 0x0C) /* Read file option */

◆ CONFIG_ITEM_MODULE

#define CONFIG_ITEM_MODULE   (CONFIG_ITEM_STRING | 0x04) /* Module option */

◆ CONFIG_ITEM_MODULE_CAT

#define CONFIG_ITEM_MODULE_CAT   (CONFIG_ITEM_STRING | 0x05) /* Module option */

◆ CONFIG_ITEM_MODULE_LIST

#define CONFIG_ITEM_MODULE_LIST   (CONFIG_ITEM_STRING | 0x06) /* Module option */

◆ CONFIG_ITEM_MODULE_LIST_CAT

#define CONFIG_ITEM_MODULE_LIST_CAT   (CONFIG_ITEM_STRING | 0x07) /* Module option */

◆ CONFIG_ITEM_PASSWORD

#define CONFIG_ITEM_PASSWORD   (CONFIG_ITEM_STRING | 0x01) /* Password option (*) */

◆ CONFIG_ITEM_RGB

#define CONFIG_ITEM_RGB   (CONFIG_ITEM_INTEGER | 0x01) /* RGB color option */

◆ CONFIG_ITEM_SAVEFILE

#define CONFIG_ITEM_SAVEFILE   (CONFIG_ITEM_STRING | 0x0D) /* Written file option */

◆ CONFIG_ITEM_STRING

#define CONFIG_ITEM_STRING   (4 << 5) /* String option */

◆ CONFIG_SECTION

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

◆ CONFIG_SUBCATEGORY

#define CONFIG_SUBCATEGORY   0x07 /* Set subcategory */

◆ CRUDE_HACK

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

◆ DLL_SYMBOL

#define DLL_SYMBOL

◆ EXTERN_SYMBOL

#define EXTERN_SYMBOL

◆ IsConfigFloatType

#define IsConfigFloatType (   type)     ((type) == CONFIG_ITEM_FLOAT)

◆ IsConfigIntegerType

#define IsConfigIntegerType (   type)     (((type) & CONFIG_ITEM_INTEGER) != 0)

◆ IsConfigStringType

#define IsConfigStringType (   type)     (((type) & CONFIG_ITEM_STRING) != 0)

◆ set_callback

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

◆ 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;
vlc_object_t
VLC object common members.
Definition vlc_objects.h:53
set_callback
#define set_callback(activate)
Definition vlc_plugin.h:372
VLC_MODULE_CB_CLOSE
@ VLC_MODULE_CB_CLOSE
Definition vlc_plugin.h:47

◆ set_capability

#define set_capability (   cap,
  score 
)
Value:
if (vlc_module_set (VLC_MODULE_CAPABILITY, VLC_CHECKED_TYPE(const char *, cap)) \
|| vlc_module_set (VLC_MODULE_SCORE, VLC_CHECKED_TYPE(int, score))) \
goto error;
VLC_MODULE_SCORE
@ VLC_MODULE_SCORE
Definition vlc_plugin.h:45
VLC_MODULE_CAPABILITY
@ VLC_MODULE_CAPABILITY
Definition vlc_plugin.h:44

◆ set_description

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

◆ set_help

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

◆ set_help_html

#define set_help_html (   help_html)
Value:
if (vlc_module_set (VLC_MODULE_HELP_HTML, VLC_CHECKED_TYPE(const char *, help_html))) \
goto error;
VLC_MODULE_HELP_HTML
@ VLC_MODULE_HELP_HTML
Definition vlc_plugin.h:54

◆ 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, VLC_CHECKED_TYPE(const char *, shortname))) \
goto error;
VLC_MODULE_SHORTNAME
@ VLC_MODULE_SHORTNAME
Definition vlc_plugin.h:50

◆ set_subcategory

#define set_subcategory (   id)
Value:
add_type_inner( CONFIG_SUBCATEGORY ) \
vlc_config_set (VLC_CONFIG_VALUE, VLC_CHECKED_TYPE(int64_t, id));
CONFIG_SUBCATEGORY
#define CONFIG_SUBCATEGORY
Definition vlc_plugin.h:117

◆ set_text_domain

#define set_text_domain (   dom)
Value:
if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, VLC_CHECKED_TYPE(const char *, dom))) \
goto error;
VLC_MODULE_TEXTDOMAIN
@ VLC_MODULE_TEXTDOMAIN
Definition vlc_plugin.h:53

◆ STRINGIFY_NAME

#define STRINGIFY_NAME (   z)    STRINGIFY_NAME_( z )

◆ STRINGIFY_NAME_

#define STRINGIFY_NAME_ (   z)    #z

◆ 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.6"

Current plugin ABI version.

◆ VLC_CHECKED_TYPE

#define VLC_CHECKED_TYPE (   type,
  value 
)    (type){ value }

◆ 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); \
}
VLC_SYMBOL
#define VLC_SYMBOL(symbol)
Definition vlc_plugin.h:267
CDECL_SYMBOL
#define CDECL_SYMBOL
Definition vlc_plugin.h:271
EXTERN_SYMBOL
#define EXTERN_SYMBOL
Definition vlc_plugin.h:246

◆ 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); \
}

◆ 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_DECL_MODULE_ENTRY

#define VLC_DECL_MODULE_ENTRY (   name)    VLC_ENTRY_FUNC(VLC_MODULE_ENTRY(name))

◆ VLC_ENTRY_FUNC

#define VLC_ENTRY_FUNC (   name)    int (name)(vlc_set_cb, void *)

◆ 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:
EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
VLC_SYMBOL(vlc_entry_ ## name)(void); \
EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
VLC_SYMBOL(vlc_entry_ ## name)(void) \
{ \
return value; \
}
DLL_SYMBOL
#define DLL_SYMBOL
Definition vlc_plugin.h:283

◆ 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; \
struct vlc_param *config = NULL; \
if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
goto error; \
if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \
goto error;
config
static struct @13 config
MODULE_STRING
#define MODULE_STRING
Definition access.c:26
vlc_entry
static void vlc_entry(void *p)
Definition thread.c:436
module_t
Internal module descriptor.
Definition modules.h:76
vlc_param
Definition configuration.h:30
VLC_MODULE_NAME
@ VLC_MODULE_NAME
Definition vlc_plugin.h:49
vlc_set_cb
int(* vlc_set_cb)(void *, void *, int,...)
Definition vlc_plugin.h:288

◆ vlc_module_end

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

◆ VLC_MODULE_ENTRY

#define VLC_MODULE_ENTRY (   name)    CONCATENATE(vlc_entry, name)

◆ 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_plugin_cb

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

Plugin entry point prototype.

◆ vlc_set_cb

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

Enumeration Type Documentation

◆ vlc_config_cat

enum vlc_config_cat
Enumerator
CAT_HIDDEN 
CAT_UNKNOWN 
CAT_INTERFACE 
CAT_AUDIO 
CAT_VIDEO 
CAT_INPUT 
CAT_SOUT 
CAT_ADVANCED 
CAT_PLAYLIST 

◆ vlc_config_subcat

enum vlc_config_subcat
Enumerator
SUBCAT_HIDDEN 
SUBCAT_UNKNOWN 
SUBCAT_INTERFACE_GENERAL 
SUBCAT_INTERFACE_MAIN 
SUBCAT_INTERFACE_CONTROL 
SUBCAT_INTERFACE_HOTKEYS 
SUBCAT_AUDIO_GENERAL 
SUBCAT_AUDIO_AOUT 
SUBCAT_AUDIO_AFILTER 
SUBCAT_AUDIO_VISUAL 
SUBCAT_AUDIO_RESAMPLER 
SUBCAT_VIDEO_GENERAL 
SUBCAT_VIDEO_VOUT 
SUBCAT_VIDEO_VFILTER 
SUBCAT_VIDEO_SUBPIC 
SUBCAT_VIDEO_SPLITTER 
SUBCAT_INPUT_GENERAL 
SUBCAT_INPUT_ACCESS 
SUBCAT_INPUT_DEMUX 
SUBCAT_INPUT_VCODEC 
SUBCAT_INPUT_ACODEC 
SUBCAT_INPUT_SCODEC 
SUBCAT_INPUT_STREAM_FILTER 
SUBCAT_SOUT_GENERAL 
SUBCAT_SOUT_STREAM 
SUBCAT_SOUT_MUX 
SUBCAT_SOUT_ACO 
SUBCAT_SOUT_PACKETIZER 
SUBCAT_SOUT_VOD 
SUBCAT_SOUT_RENDERER 
SUBCAT_ADVANCED_MISC 
SUBCAT_ADVANCED_NETWORK 
SUBCAT_PLAYLIST_GENERAL 
SUBCAT_PLAYLIST_SD 
SUBCAT_PLAYLIST_EXPORT 

◆ vlc_module_properties

enum 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_MODULE_HELP_HTML 
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  vlc_set,
void *  opaque 
)

◆ 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 
)