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)
#define	CONFIG_ITEM(x)
#define	IsConfigStringType(type)
#define	IsConfigIntegerType(type)
#define	IsConfigFloatType(type)
#define	VLC_API_VERSION_STRING   "4.0.6"
	Current plugin ABI version.
#define	CONCATENATE(y, z)
#define	CRUDE_HACK(y, z)
#define	STRINGIFY_NAME_(z)
#define	STRINGIFY_NAME(z)
#define	EXTERN_SYMBOL
#define	VLC_ENTRY_FUNC(name)
#define	VLC_MODULE_ENTRY(name)
#define	VLC_DECL_MODULE_ENTRY(name)
#define	VLC_SYMBOL(symbol)
#define	VLC_MODULE_NAME_HIDDEN_SYMBOL
#define	CDECL_SYMBOL
#define	DLL_SYMBOL
#define	vlc_plugin_set(...)
#define	vlc_module_set(...)
#define	vlc_config_set(...)
#define	VLC_CHECKED_TYPE(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)
#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)
#define	add_string(name, value, text, longtext)
#define	add_password(name, value, text, longtext)
#define	add_loadfile(name, value, text, longtext)
#define	add_savefile(name, value, text, longtext)
#define	add_directory(name, value, text, longtext)
#define	add_font(name, value, text, longtext)
#define	add_module(name, cap, value, text, longtext)
#define	add_module_list(name, cap, value, text, longtext)
#define	add_integer(name, value, text, longtext)
#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)
#define	add_obsolete_integer(name)
#define	add_obsolete_float(name)
#define	add_obsolete_string(name)
#define	change_short(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()
#define	change_volatile()
#define	change_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);

Referenced by vlc_entry__core(), and vlc_entry__MODULE_NAME().

add_directory

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

Value:

    add_string_inner(CONFIG_ITEM_DIRECTORY, name, text, longtext, value)

Referenced by vlc_entry__core().

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

Referenced by vlc_entry__core().

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_font

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

Value:

    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 )

Value:

    add_int_inner(CONFIG_ITEM_INTEGER, name, text, longtext, value)

Referenced by vlc_entry__core(), and vlc_entry__MODULE_NAME().

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

Referenced by vlc_entry__core().

add_loadfile

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

Value:

    add_string_inner(CONFIG_ITEM_LOADFILE, name, text, longtext, value)

Referenced by vlc_entry__core().

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

Referenced by vlc_entry__core().

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

Referenced by vlc_entry__core().

add_obsolete_bool

#define add_obsolete_bool

(

name

)

Value:

        add_obsolete_inner( name, CONFIG_ITEM_BOOL )

Referenced by vlc_entry__core().

add_obsolete_float

#define add_obsolete_float

(

name

)

Value:

        add_obsolete_inner( name, CONFIG_ITEM_FLOAT )

Referenced by vlc_entry__core().

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_obsolete_integer

#define add_obsolete_integer

(

name

)

Value:

        add_obsolete_inner( name, CONFIG_ITEM_INTEGER )

Referenced by vlc_entry__core().

add_obsolete_string

#define add_obsolete_string

(

name

)

Value:

        add_obsolete_inner( name, CONFIG_ITEM_STRING )

Referenced by vlc_entry__core(), and vlc_entry__MODULE_NAME().

add_password

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

Value:

    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_savefile

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

Value:

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

Referenced by vlc_entry__MODULE_NAME(), and vlc_entry__MODULE_NAME().

add_string

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

Value:

    add_string_inner(CONFIG_ITEM_STRING, name, text, longtext, value)

Referenced by vlc_entry__core(), vlc_entry__MODULE_NAME(), and vlc_entry__MODULE_NAME().

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;

Referenced by vlc_entry__MODULE_NAME().

add_type_inner

#define add_type_inner

(

type

)

Value:

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

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

cannot_unload_broken_library

#define cannot_unload_broken_library

(

)

Value:

    if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
        goto error;

CDECL_SYMBOL

#define CDECL_SYMBOL

Referenced by vlc_entry_cfg_int_enum__MODULE_NAME(), and vlc_entry_cfg_str_enum__MODULE_NAME().

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

Referenced by vlc_entry__core().

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

Referenced by vlc_entry__core().

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

Referenced by vlc_entry__core(), and vlc_entry__MODULE_NAME().

change_private

#define change_private

(

)

Value:

    vlc_config_set (VLC_CONFIG_PRIVATE);

Referenced by vlc_entry__core(), and vlc_entry__MODULE_NAME().

change_safe

#define change_safe

(

)

Value:

    vlc_config_set (VLC_CONFIG_SAFE);

Referenced by vlc_entry__core(), vlc_entry__MODULE_NAME(), and vlc_entry__MODULE_NAME().

change_short

#define change_short

(

ch

)

Value:

    vlc_config_set (VLC_CONFIG_SHORTCUT, VLC_CHECKED_TYPE(char, ch));

Referenced by vlc_entry__core().

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

Referenced by vlc_entry__core().

change_volatile

#define change_volatile

(

)

Value:

    change_private() \
    vlc_config_set (VLC_CONFIG_VOLATILE);

Referenced by vlc_entry__core(), and vlc_entry__MODULE_NAME().

CONCATENATE

#define CONCATENATE	(		y,
			z )

Value:

CRUDE_HACK( y, z )

CONFIG_CLASS

#define CONFIG_CLASS

(

x

)

Value:

((x) & ~0x1F)

Referenced by config_ChainParse(), config_GetType(), config_LoadCmdLine(), config_LoadConfigFile(), config_SaveConfigFile(), and print_item().

CONFIG_HINT_CATEGORY

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

Referenced by print_item().

CONFIG_ITEM

#define CONFIG_ITEM

(

x

)

Value:

(((x) & ~0xF) != 0)

Referenced by config_LoadCmdLine(), config_SaveConfigFile(), config_SortConfig(), plugin_show(), vlc_config_create(), and vlc_plugin_desc_cb().

CONFIG_ITEM_BOOL

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

Referenced by config_ChainParse(), config_GetType(), config_LoadCmdLine(), config_LoadConfigFile(), config_SaveConfigFile(), print_item(), and vlc_config_create().

CONFIG_ITEM_DIRECTORY

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

CONFIG_ITEM_FLOAT

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

Referenced by config_ChainParse(), config_GetType(), config_LoadCmdLine(), config_LoadConfigFile(), and print_item().

CONFIG_ITEM_FONT

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

CONFIG_ITEM_INTEGER

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

Referenced by config_ChainParse(), config_GetType(), config_LoadCmdLine(), config_LoadConfigFile(), and print_item().

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 */

Referenced by config_GetPszChoices().

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 */

Referenced by config_ChainParse(), config_GetType(), config_LoadCmdLine(), and print_item().

CONFIG_SECTION

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

Referenced by print_item().

CONFIG_SUBCATEGORY

#define CONFIG_SUBCATEGORY   0x07 /* Set subcategory */

Referenced by print_item().

CRUDE_HACK

#define CRUDE_HACK	(		y,
			z )

Value:

y##__##z

DLL_SYMBOL

#define DLL_SYMBOL

Referenced by vlc_entry_cfg_int_enum__MODULE_NAME().

EXTERN_SYMBOL

#define EXTERN_SYMBOL

Referenced by vlc_entry_cfg_int_enum__MODULE_NAME().

IsConfigFloatType

#define IsConfigFloatType

(

type

)

Value:

    ((type) == CONFIG_ITEM_FLOAT)

Referenced by config_GetFloat(), config_PutFloat(), config_ResetAll(), config_SaveConfigFile(), vlc_config_create(), and vlc_plugin_desc_cb().

IsConfigIntegerType

#define IsConfigIntegerType

(

type

)

Value:

    (((type) & CONFIG_ITEM_INTEGER) != 0)

Referenced by config_GetInt(), config_PutInt(), config_ResetAll(), config_SaveConfigFile(), vlc_config_create(), and vlc_plugin_desc_cb().

IsConfigStringType

#define IsConfigStringType

(

type

)

Value:

    (((type) & CONFIG_ITEM_STRING) != 0)

Referenced by config_Free(), config_GetPsz(), config_GetPszChoices(), config_ResetAll(), config_SaveConfigFile(), vlc_param_SetString(), and vlc_plugin_desc_cb().

set_callback

#define set_callback

(

activate

)

Value:

    if (vlc_module_set(VLC_MODULE_CB_OPEN, #activate, (void *)(activate))) \
        goto error;

Referenced by vlc_entry__MODULE_NAME().

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;

Referenced by vlc_entry__MODULE_NAME(), and vlc_entry__MODULE_NAME().

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;

Referenced by vlc_entry__MODULE_NAME(), and vlc_entry__MODULE_NAME().

set_description

#define set_description

(

desc

)

Value:

    if (vlc_module_set (VLC_MODULE_DESCRIPTION, VLC_CHECKED_TYPE(const char *, desc))) \
        goto error;

Referenced by vlc_entry__core(), vlc_entry__MODULE_NAME(), and vlc_entry__MODULE_NAME().

set_help

#define set_help

(

help

)

Value:

    if (vlc_module_set (VLC_MODULE_HELP, VLC_CHECKED_TYPE(const char *, help))) \
        goto error;

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;

set_section

#define set_section	(		text,
			longtext )

Value:

    add_typedesc_inner( CONFIG_SECTION, text, longtext )

Referenced by vlc_entry__core().

set_shortname

#define set_shortname

(

shortname

)

Value:

    if (vlc_module_set (VLC_MODULE_SHORTNAME, VLC_CHECKED_TYPE(const char *, shortname))) \
        goto error;

Referenced by vlc_entry__MODULE_NAME(), and vlc_entry__MODULE_NAME().

set_subcategory

#define set_subcategory

(

id

)

Value:

    add_type_inner( CONFIG_SUBCATEGORY ) \
    vlc_config_set (VLC_CONFIG_VALUE, VLC_CHECKED_TYPE(int64_t, id));

Referenced by vlc_entry__core(), vlc_entry__MODULE_NAME(), and vlc_entry__MODULE_NAME().

set_text_domain

#define set_text_domain

(

dom

)

Value:

    if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, VLC_CHECKED_TYPE(const char *, dom))) \
        goto error;

STRINGIFY_NAME

#define STRINGIFY_NAME

(

z

)

Value:

STRINGIFY_NAME_( z )

STRINGIFY_NAME_

#define STRINGIFY_NAME_

(

z

)

Value:

#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.

Note

This must be synchronized with the values from:

• src/rust/vlcrs-macros/module.rs

VLC_CHECKED_TYPE

#define VLC_CHECKED_TYPE	(		type,
			value )

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_config_set

#define vlc_config_set

(

...

)

Value:

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

)

Value:

VLC_ENTRY_FUNC(VLC_MODULE_ENTRY(name))

VLC_ENTRY_FUNC

#define VLC_ENTRY_FUNC

(

name

)

Value:

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

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;

vlc_module_end

#define vlc_module_end

(

)

Value:

    (void) config; \
    return 0; \
error: \
    return -1; \
} \
VLC_MODULE_NAME_HIDDEN_SYMBOL \
VLC_METADATA_EXPORTS

Referenced by vlc_entry_api_version__core(), and vlc_entry_api_version__MODULE_NAME().

VLC_MODULE_ENTRY

#define VLC_MODULE_ENTRY

(

name

)

Value:

CONCATENATE(vlc_entry, name)

Referenced by module_InitBank().

VLC_MODULE_NAME_HIDDEN_SYMBOL

#define VLC_MODULE_NAME_HIDDEN_SYMBOL

vlc_module_set

#define vlc_module_set

(

...

)

Value:

vlc_set (opaque, module, __VA_ARGS__)

vlc_plugin_set

#define vlc_plugin_set

(

...

)

Value:

vlc_set (opaque,   NULL, __VA_ARGS__)

VLC_SYMBOL

#define VLC_SYMBOL

(

symbol

)

Value:

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 )

References add_bool, add_integer, add_obsolete_string, add_shortcut, add_string, add_submodule, change_integer_range, change_private, change_safe, change_volatile, Close(), N_, Open(), OpenSDP(), OpenURL(), RTCP_PORT_LONGTEXT, RTCP_PORT_TEXT, rtp_ac3_open(), rtp_h264_open(), rtp_h265_open(), RTP_MAX_DROPOUT_DEFAULT, RTP_MAX_DROPOUT_LONGTEXT, RTP_MAX_DROPOUT_TEXT, RTP_MAX_MISORDER_DEFAULT, RTP_MAX_MISORDER_LONGTEXT, RTP_MAX_MISORDER_TEXT, RTP_MAX_SRC_DEFAULT, RTP_MAX_SRC_LONGTEXT, RTP_MAX_SRC_TEXT, RTP_MAX_TIMEOUT_DEFAULT, rtp_mpeg12_open(), rtp_mpeg4_open(), rtp_opus_open(), rtp_pcm_open(), rtp_raw_open(), RTP_TIMEOUT_LONGTEXT, RTP_TIMEOUT_TEXT, set_callback, set_callbacks, set_capability, set_description, set_rtp_parser_callback, set_shortname, set_subcategory, SRTP_KEY_LONGTEXT, SRTP_KEY_TEXT, SRTP_SALT_LONGTEXT, SRTP_SALT_TEXT, SUBCAT_INPUT_ACCESS, SUBCAT_INPUT_DEMUX, theora_open(), and vorbis_open().

vlc_entry_cfg_int_enum__MODULE_NAME()

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

References CDECL_SYMBOL, DLL_SYMBOL, EXTERN_SYMBOL, and name.

vlc_entry_cfg_str_enum__MODULE_NAME()

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

References CDECL_SYMBOL, and name.