TSDuck v3.46-4965
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
ts::PluginRepository Class Reference

#include <tsPluginRepository.h>

Classes

class  Register

Public Types

using InputPluginFactory = InputPlugin* (*)(TSP* tsp)
enum  ListFlags {
  LIST_INPUT = 0x0001 ,
  LIST_PACKET = 0x0002 ,
  LIST_OUTPUT = 0x0004 ,
  LIST_COMPACT = 0x0010 ,
  LIST_NAMES = 0x0020 ,
  LIST_ALL = LIST_INPUT | LIST_PACKET | LIST_OUTPUT
}
using OutputPluginFactory = OutputPlugin* (*)(TSP* tsp)
using ProcessorPluginFactory = ProcessorPlugin* (*)(TSP* tsp)

Public Member Functions

InputPluginFactory getInput (const UString &name, Report &report)
OutputPluginFactory getOutput (const UString &name, Report &report)
ProcessorPluginFactory getProcessor (const UString &name, Report &report)
size_t inputCount () const
UStringList inputNames () const
UString listPlugins (bool loadAll, Report &report, int flags=LIST_ALL)
void loadAllPlugins (Report &report)
size_t outputCount () const
UStringList outputNames () const
size_t processorCount () const
UStringList processorNames () const
void registerInput (const UString &name, InputPluginFactory allocator)
void registerOutput (const UString &name, OutputPluginFactory allocator)
void registerProcessor (const UString &name, ProcessorPluginFactory allocator)
void setSharedLibraryAllowed (bool allowed)

Static Public Member Functions

static PluginRepository & Instance ()
 Get the instance of the singleton of this class.
static const Names & ListProcessorEnum ()

Detailed Description

A repository of TSP plugins, either statically or dynamically linked.

This class is a singleton. Use static Instance() method to access the single instance.

Member Typedef Documentation

◆ InputPluginFactory

Profile of a function which creates an input plugin.

Parameters
[in]tspAssociated callback to tsp.
Returns
A new allocated object implementing ts::InputPlugin.

◆ OutputPluginFactory

Profile of a function which creates an output plugin.

Parameters
[in]tspAssociated callback to tsp.
Returns
A new allocated object implementing ts::OutputPlugin.

◆ ProcessorPluginFactory

Profile of a function which creates a packet processor plugin.

Parameters
[in]tspAssociated callback to tsp.
Returns
A new allocated object implementing ts::ProcessorPlugin.

Member Enumeration Documentation

◆ ListFlags

Flags for listPlugins().

Enumerator
LIST_INPUT 

List input plugins.

LIST_PACKET 

List packet processor plugins.

LIST_OUTPUT 

List output plugins.

LIST_COMPACT 

Compact output.

LIST_NAMES 

Names only.

LIST_ALL 

List all plugins.

Member Function Documentation

◆ Instance()

PluginRepository & ts::PluginRepository::Instance ( )
static

Get the instance of the singleton of this class.

Returns
The instance of the singleton of this class.

◆ setSharedLibraryAllowed()

void ts::PluginRepository::setSharedLibraryAllowed ( bool allowed)
inline

Allow or disallow the loading of plugins from shareable objects. When disabled, only statically registered plugins are allowed. Loading is initially enabled by default.

Parameters
[in]allowedWhen true, dynamically loading plugins is allowed.

◆ registerInput()

void ts::PluginRepository::registerInput ( const UString & name,
InputPluginFactory allocator )

Register an input plugin.

Parameters
[in]namePlugin name.
[in]allocatorNew input plugin allocator function. Ignored when zero.

◆ registerProcessor()

void ts::PluginRepository::registerProcessor ( const UString & name,
ProcessorPluginFactory allocator )

Register a packet processor plugin.

Parameters
[in]namePlugin name.
[in]allocatorNew packet processor plugin allocator function. Ignored when zero.

◆ registerOutput()

void ts::PluginRepository::registerOutput ( const UString & name,
OutputPluginFactory allocator )

Register an output plugin.

Parameters
[in]namePlugin name.
[in]allocatorNew output plugin allocator function. Ignored when zero.

◆ getInput()

InputPluginFactory ts::PluginRepository::getInput ( const UString & name,
Report & report )

Get an input plugin by name. If not found and loading shareable library is allowed, try to load it.

Parameters
[in]namePlugin name.
[in,out]reportWhere to report errors.
Returns
Plugin allocator function. Zero when not found.

◆ getProcessor()

ProcessorPluginFactory ts::PluginRepository::getProcessor ( const UString & name,
Report & report )

Get a packet processor plugin by name. If not found and loading shareable library is allowed, try to load it.

Parameters
[in]namePlugin name.
[in,out]reportWhere to report errors.
Returns
Plugin allocator function. Zero when not found.

◆ getOutput()

OutputPluginFactory ts::PluginRepository::getOutput ( const UString & name,
Report & report )

Get an output plugin by name. If not found and loading shareable library is allowed, try to load it.

Parameters
[in]namePlugin name.
[in,out]reportWhere to report errors.
Returns
Plugin allocator function. Zero when not found.

◆ inputCount()

size_t ts::PluginRepository::inputCount ( ) const
inline

Get the number of registered input plugins.

Returns
The number of registered input plugins.

◆ processorCount()

size_t ts::PluginRepository::processorCount ( ) const
inline

Get the number of registered processor plugins.

Returns
The number of registered processor plugins.

◆ outputCount()

size_t ts::PluginRepository::outputCount ( ) const
inline

Get the number of registered output plugins.

Returns
The number of registered output plugins.

◆ inputNames()

UStringList ts::PluginRepository::inputNames ( ) const

Get the names of all registered input plugins.

Returns
The names of all registered input plugins.

◆ processorNames()

UStringList ts::PluginRepository::processorNames ( ) const

Get the names of all registered packet processor plugins.

Returns
The names of all registered packet processor plugins.

◆ outputNames()

UStringList ts::PluginRepository::outputNames ( ) const

Get the names of all registered output plugins.

Returns
The names of all registered output plugins.

◆ loadAllPlugins()

void ts::PluginRepository::loadAllPlugins ( Report & report)

Load all available tsp processors. Does nothing when dynamic loading of plugins is disabled.

Parameters
[in,out]reportWhere to report errors.

◆ ListProcessorEnum()

const Names & ts::PluginRepository::ListProcessorEnum ( )
static

Convenient command line options for "list processor" option.

Returns
A constant reference to the enumeration description.

◆ listPlugins()

UString ts::PluginRepository::listPlugins ( bool loadAll,
Report & report,
int flags = LIST_ALL )

List all tsp processors. This function is typically used to implement the tsp --list-processors option.

Parameters
[in]loadAllWhen true, all available plugins are loaded first. Ignored when dynamic loading of plugins is disabled.
[in,out]reportWhere to report errors.
[in]flagsList options, an or'ed mask of ListFlags values.
Returns
The text to display.

The documentation for this class was generated from the following file: