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

This file defines functions for modules in vlc. More...

Include dependency graph for vlc_modules.h:

Go to the source code of this file.

Macros

#define vlc_module_load(ctx, cap, name, strict, ...)
 
#define module_need(a, b, c, d)   module_need(VLC_OBJECT(a),b,c,d)
 
#define module_need_var(a, b, c)   module_need_var(VLC_OBJECT(a),b,c)
 
#define module_unneed(a, b)   module_unneed(VLC_OBJECT(a),b)
 
#define module_GetShortName(m)   module_get_name( m, false )
 
#define module_GetLongName(m)   module_get_name( m, true )
 

Typedefs

typedef int(* vlc_activate_t) (void *func, bool forced, va_list args)
 

Functions

ssize_t vlc_module_match (const char *capability, const char *names, bool strict, module_t ***restrict modules, size_t *restrict strict_matches)
 Finds the candidate modules for given criteria. More...
 
void * vlc_module_map (struct vlc_logger *log, module_t *mod)
 Maps a module in memory. More...
 
module_tvlc_module_load (struct vlc_logger *log, const char *cap, const char *name, bool strict, vlc_activate_t probe,...)
 Finds and instantiates the best module of a certain type. More...
 
module_tmodule_need (vlc_object_t *, const char *, const char *, bool)
 
static module_tmodule_need_var (vlc_object_t *obj, const char *cap, const char *varname)
 
void module_unneed (vlc_object_t *, module_t *)
 
module_tmodule_find (const char *name)
 Get a pointer to a module_t given it's name. More...
 
static bool module_exists (const char *name)
 Checks if a module exists. More...
 
module_config_tmodule_config_get (const module_t *module, unsigned *restrict psize)
 Gets the table of module configuration items. More...
 
void module_config_free (module_config_t *tab)
 Releases a configuration items table. More...
 
void module_list_free (module_t **)
 Frees a flat list of VLC modules. More...
 
module_t ** module_list_get (size_t *n)
 Gets the flat list of VLC modules. More...
 
bool module_provides (const module_t *m, const char *cap)
 Checks whether a module implements a capability. More...
 
const char * module_get_object (const module_t *m)
 Gets the internal name of a module. More...
 
const char * module_get_name (const module_t *m, bool longname)
 Gets the human-friendly name of a module. More...
 
const char * module_get_help (const module_t *m)
 Gets the help text for a module. More...
 
const char * module_get_capability (const module_t *m)
 Gets the capability string of a module. More...
 
int module_get_score (const module_t *m)
 Gets the precedence of a module. More...
 
const char * module_gettext (const module_t *m, const char *s)
 Translates a string using the module's text domain. More...
 
static module_tmodule_get_main (void)
 
static bool module_is_main (const module_t *p_module)
 

Detailed Description

This file defines functions for modules in vlc.

Macro Definition Documentation

◆ module_GetLongName

#define module_GetLongName (   m)    module_get_name( m, true )

◆ module_GetShortName

#define module_GetShortName (   m)    module_get_name( m, false )

◆ module_need

#define module_need (   a,
  b,
  c,
 
)    module_need(VLC_OBJECT(a),b,c,d)

◆ module_need_var

#define module_need_var (   a,
  b,
 
)    module_need_var(VLC_OBJECT(a),b,c)

◆ module_unneed

#define module_unneed (   a,
 
)    module_unneed(VLC_OBJECT(a),b)

◆ vlc_module_load

#define vlc_module_load (   ctx,
  cap,
  name,
  strict,
  ... 
)
Value:
_Generic ((ctx), \
struct vlc_logger *: \
vlc_module_load((void *)(ctx), cap, name, strict, __VA_ARGS__), \
void *: \
vlc_module_load((void *)(ctx), cap, name, strict, __VA_ARGS__), \
default: \
name, strict, __VA_ARGS__))
#define vlc_object_logger(o)
Definition: vlc_objects.h:163
const char name[16]
Definition: httpd.c:1268
Definition: messages.c:54
VLC object common members.
Definition: vlc_objects.h:45
#define vlc_module_load(ctx, cap, name, strict,...)
Definition: vlc_modules.h:99

Typedef Documentation

◆ vlc_activate_t

typedef int(* vlc_activate_t) (void *func, bool forced, va_list args)

Function Documentation

◆ module_config_free()

void module_config_free ( module_config_t tab)

Releases a configuration items table.

Parameters
tabbase address of a table returned by module_config_get()

References config.

◆ module_config_get()

module_config_t* module_config_get ( const module_t module,
unsigned *restrict  psize 
)

Gets the table of module configuration items.

Note
Use module_config_free() to release the allocated memory.
Parameters
modulethe module
psizethe size of the configuration returned
Returns
the configuration as an array

References module_config_t::b_internal, module_config_t::b_removed, vlc_plugin_t::conf, config, vlc_plugin_t::items, vlc_plugin_t::module, module_t::plugin, vlc_plugin_t::size, and vlc_alloc().

◆ module_exists()

static bool module_exists ( const char *  name)
inlinestatic

Checks if a module exists.

Parameters
namename of the module
Return values
trueif the module exists
falseif the module does not exist (in the running installation)

References module_find(), and name.

Referenced by aout_New(), and aout_SetupMixModeChoices().

◆ module_find()

module_t* module_find ( const char *  name)

Get a pointer to a module_t given it's name.

Parameters
namethe name of the module
Returns
a pointer to the module or NULL in case of a failure

References count, module_t::i_shortcuts, list, module_list_free(), module_list_get(), name, module_t::pp_shortcuts, and unlikely.

Referenced by module_exists(), and module_get_main().

◆ module_get_capability()

const char* module_get_capability ( const module_t m)

Gets the capability string of a module.

Parameters
mthe module
Returns
the capability, or "none" if unspecified

References module_t::psz_capability.

Referenced by module_provides(), and vlc_module_store().

◆ module_get_help()

const char* module_get_help ( const module_t m)

Gets the help text for a module.

Parameters
mthe module
Returns
the help

References module_t::psz_help.

◆ module_get_main()

static module_t* module_get_main ( void  )
inlinestatic

References module_find().

◆ module_get_name()

const char* module_get_name ( const module_t m,
bool  longname 
)

Gets the human-friendly name of a module.

Parameters
mthe module
longnameTRUE to have the long name of the module
Returns
the short or long name of the module

References module_get_object(), module_t::psz_longname, and module_t::psz_shortname.

◆ module_get_object()

const char* module_get_object ( const module_t m)

Gets the internal name of a module.

Parameters
mthe module
Returns
the module name

References module_t::i_shortcuts, module_t::pp_shortcuts, and unlikely.

Referenced by config_ListModules(), config_SaveConfigFile(), ListModules(), module_get_name(), module_is_main(), module_match(), module_need(), module_unneed(), Usage(), and vlc_module_load().

◆ module_get_score()

int module_get_score ( const module_t m)

Gets the precedence of a module.

Parameters
mthe module return the score for the capability

References module_t::i_score.

Referenced by vlc_module_match().

◆ module_gettext()

const char* module_gettext ( const module_t m,
const char *  s 
)

Translates a string using the module's text domain.

Parameters
mthe module
sthe American English ASCII string to localize
Returns
the gettext-translated string

References module_t::plugin, vlc_plugin_t::textdomain, and unlikely.

Referenced by config_ListModules(), ListModules(), print_item(), print_section(), and Usage().

◆ module_is_main()

static bool module_is_main ( const module_t p_module)
inlinestatic

References module_get_object().

◆ module_list_free()

void module_list_free ( module_t **  list)

Frees a flat list of VLC modules.

Parameters
listlist obtained by module_list_get()

References list.

Referenced by ListModules(), and module_find().

◆ module_list_get()

module_t** module_list_get ( size_t *  n)

Gets the flat list of VLC modules.

Parameters
n[OUT] pointer to the number of modules
Returns
table of module pointers (release with module_list_free()), or NULL in case of error (in that case, *n is zeroed).

References modules, vlc_plugin_t::next, module_t::next, unlikely, and vlc_plugins.

Referenced by ListModules(), and module_find().

◆ module_need()

module_t* module_need ( vlc_object_t obj,
const char *  cap,
const char *  name,
bool  strict 
)

◆ module_need_var()

static module_t* module_need_var ( vlc_object_t obj,
const char *  cap,
const char *  varname 
)
inlinestatic

◆ module_provides()

bool module_provides ( const module_t m,
const char *  cap 
)

Checks whether a module implements a capability.

Parameters
mthe module
capthe capability to check
Return values
trueif the module has the capability
falseif the module has another capability

References module_get_capability().

◆ module_unneed()

void module_unneed ( vlc_object_t obj,
module_t module 
)

◆ vlc_module_load()

module_t* vlc_module_load ( struct vlc_logger log,
const char *  capability,
const char *  name,
bool  strict,
vlc_activate_t  probe,
  ... 
)

Finds and instantiates the best module of a certain type.

All candidates modules having the specified capability and name will be sorted in decreasing order of priority. Then the probe callback will be invoked for each module, until it succeeds (returns 0), or all candidate module failed to initialize.

The probe callback first parameter is the address of the module entry point. Further parameters are passed as an argument list; it corresponds to the variable arguments passed to this function. This scheme is meant to support arbitrary prototypes for the module entry point.

Parameters
loglogger for debugging (or NULL to ignore)
capabilitycapability, i.e. class of module
namename of the module asked, if any
strictif true, do not fallback to plugin with a different name but the same capability
probemodule probe callback
Returns
the module or NULL in case of a failure

All candidates modules having the specified capability and name will be sorted in decreasing order of priority. Then the probe callback will be invoked for each module, until it succeeds (returns 0), or all candidate module failed to initialize.

The probe callback first parameter is the address of the module entry point. Further parameters are passed as an argument list; it corresponds to the variable arguments passed to this function. This scheme is meant to support arbitrary prototypes for the module entry point.

Parameters
loglogger (or NULL to ignore)
capabilitycapability, i.e. class of module
namename of the module asked, if any
strictif true, do not fallback to plugin with a different name but the same capability
probemodule probe callback
Returns
the module or NULL in case of a failure

References module_get_object(), name, unlikely, vlc_debug, VLC_EGENERIC, VLC_ETIMEOUT, vlc_module_map(), vlc_module_match(), and VLC_SUCCESS.

Referenced by module_need().

◆ vlc_module_map()

void* vlc_module_map ( struct vlc_logger log,
module_t mod 
)

Maps a module in memory.

This function attempts to map a given module in memory, if it is not already mapped. If it is already mapped, this function does nothing.

Parameters
logmessage logger
modmodule to map
Returns
the module activation function on success, NULL on failure

References module_t::pf_activate, module_t::plugin, and vlc_plugin_Map().

Referenced by libvlc_AutoRun(), vlc_module_load(), vlc_tls_ClientCreate(), and vlc_tls_ServerCreate().

◆ vlc_module_match()

ssize_t vlc_module_match ( const char *  capability,
const char *  names,
bool  strict,
module_t ***restrict  modules,
size_t *restrict  strict_matches 
)

Finds the candidate modules for given criteria.

All candidates modules having the specified capability and name will be sorted in decreasing order of priority and returned in a heap-allocated table.

Parameters
capabilitycapability, i.e. class of module
namesstring of comma-separated requested module shortcut names, or NULL for defaults
strictwhether to exclude modules with no unmatching shortcut names
modulesstorage location for the base address of a sorted table of candidate modules (NULL on error) [OUT]
strict_matchesstorage location for the count of strictly matched modules [OUT]
Returns
number of modules found or a strictly negative value on error

References module_get_score(), module_list_cap(), module_match_name(), modules, and unlikely.

Referenced by libvlc_AutoRun(), vlc_module_load(), vlc_tls_ClientCreate(), and vlc_tls_ServerCreate().