Metadata base class template, to provide default versions of interface functions. More...

#include <giface.h>

Inheritance diagram for calf_plugins::plugin_metadata< Metadata >:

Public Types
typedef plugin_metadata< Metadata >	metadata_class
Public Types inherited from calf_plugins::plugin_metadata_iface
enum	{ simulate_stereo_input = true , has_live_updates = true }

Public Member Functions
const char *	get_name () const
const char *	get_id () const
const char *	get_label () const
int	get_input_count () const
int	get_output_count () const
int	get_inputs_optional () const
int	get_outputs_optional () const
int	get_param_count () const
bool	get_midi () const
bool	requires_midi () const
bool	requires_instance_access () const
bool	is_rt_capable () const
int	get_param_port_offset () const
char *	get_gui_xml (const char *prefix) const
	Return custom XML.
plugin_command_info *	get_commands () const
const parameter_properties *	get_param_props (int param_no) const
const char **	get_port_names () const
bool	is_cv (int param_no) const
	is a given parameter a control voltage?
bool	is_noisy (int param_no) const
	is the given parameter non-interpolated?
const ladspa_plugin_info &	get_plugin_info () const
bool	get_simulate_stereo_input () const
bool	sends_live_updates () const
Public Member Functions inherited from calf_plugins::plugin_metadata_iface
virtual void	get_configure_vars (std::vector< std::string > &names) const
	obtain array of names of configure variables (or NULL is none needed)
virtual const table_metadata_iface *	get_table_metadata_iface (const char *key) const
virtual	~plugin_metadata_iface ()
	Do-nothing destructor to silence compiler warning.

Static Public Attributes
static const char *	port_names []
static parameter_properties	param_props []
static ladspa_plugin_info	plugin_info

Detailed Description

template<class Metadata>
class calf_plugins::plugin_metadata< Metadata >

Metadata base class template, to provide default versions of interface functions.

Member Typedef Documentation

◆ metadata_class

template<class Metadata>

typedef plugin_metadata<Metadata> calf_plugins::plugin_metadata< Metadata >::metadata_class

Member Function Documentation

◆ get_commands()

template<class Metadata>

plugin_command_info * calf_plugins::plugin_metadata< Metadata >::get_commands ( ) const

inlinevirtual

Returns: NULL-terminated list of menu commands

Reimplemented from calf_plugins::plugin_metadata_iface.

◆ get_gui_xml()

template<class Metadata>

char * calf_plugins::plugin_metadata< Metadata >::get_gui_xml ( const char * prefix ) const

inlinevirtual

Return custom XML.

Implements calf_plugins::plugin_metadata_iface.

◆ get_id()

template<class Metadata>

const char * calf_plugins::plugin_metadata< Metadata >::get_id ( ) const

inlinevirtual

Returns: plugin LV2 label

Implements calf_plugins::plugin_metadata_iface.

◆ get_input_count()

template<class Metadata>

int calf_plugins::plugin_metadata< Metadata >::get_input_count ( ) const

inlinevirtual

Returns: number of audio inputs

Implements calf_plugins::plugin_metadata_iface.

◆ get_inputs_optional()

template<class Metadata>

int calf_plugins::plugin_metadata< Metadata >::get_inputs_optional ( ) const

inlinevirtual

Returns: number of optional inputs

Implements calf_plugins::plugin_metadata_iface.

◆ get_label()

template<class Metadata>

const char * calf_plugins::plugin_metadata< Metadata >::get_label ( ) const

inlinevirtual

Returns: plugin human-readable label

Implements calf_plugins::plugin_metadata_iface.

◆ get_midi()

template<class Metadata>

bool calf_plugins::plugin_metadata< Metadata >::get_midi ( ) const

inlinevirtual

Returns: true if plugin has MIDI input

Implements calf_plugins::plugin_metadata_iface.

◆ get_name()

template<class Metadata>

const char * calf_plugins::plugin_metadata< Metadata >::get_name ( ) const

inlinevirtual

Returns: plugin long name

Implements calf_plugins::plugin_metadata_iface.

◆ get_output_count()

template<class Metadata>

int calf_plugins::plugin_metadata< Metadata >::get_output_count ( ) const

inlinevirtual

Returns: number of audio outputs

Implements calf_plugins::plugin_metadata_iface.

◆ get_outputs_optional()

template<class Metadata>

int calf_plugins::plugin_metadata< Metadata >::get_outputs_optional ( ) const

inlinevirtual

Returns: number of optional outputs

Implements calf_plugins::plugin_metadata_iface.

◆ get_param_count()

template<class Metadata>

int calf_plugins::plugin_metadata< Metadata >::get_param_count ( ) const

inlinevirtual

Returns: total number of parameters

Implements calf_plugins::plugin_metadata_iface.

◆ get_param_port_offset()

template<class Metadata>

int calf_plugins::plugin_metadata< Metadata >::get_param_port_offset ( ) const

inlinevirtual

Returns: port offset of first control (parameter) port (= number of audio inputs + number of audio outputs in all existing plugins as for 1 Aug 2008)

Implements calf_plugins::plugin_metadata_iface.

◆ get_param_props()

template<class Metadata>

const parameter_properties * calf_plugins::plugin_metadata< Metadata >::get_param_props ( int param_no ) const

inlinevirtual

Returns: description structure for given parameter

Implements calf_plugins::plugin_metadata_iface.

◆ get_plugin_info()

template<class Metadata>

const ladspa_plugin_info & calf_plugins::plugin_metadata< Metadata >::get_plugin_info ( ) const

inlinevirtual

Returns: description structure for the plugin

Implements calf_plugins::plugin_metadata_iface.

◆ get_port_names()

template<class Metadata>

const char ** calf_plugins::plugin_metadata< Metadata >::get_port_names ( ) const

inlinevirtual

Returns: retrieve names of audio ports (

Note: control ports are named in parameter_properties, not here)

Implements calf_plugins::plugin_metadata_iface.

◆ get_simulate_stereo_input()

template<class Metadata>

bool calf_plugins::plugin_metadata< Metadata >::get_simulate_stereo_input ( ) const

inlinevirtual

Returns: whether to auto-connect right input with left input if unconnected

Implements calf_plugins::plugin_metadata_iface.

◆ is_cv()

template<class Metadata>

bool calf_plugins::plugin_metadata< Metadata >::is_cv ( int param_no ) const

inlinevirtual

is a given parameter a control voltage?

Implements calf_plugins::plugin_metadata_iface.

◆ is_noisy()

template<class Metadata>

bool calf_plugins::plugin_metadata< Metadata >::is_noisy ( int param_no ) const

inlinevirtual

is the given parameter non-interpolated?

Implements calf_plugins::plugin_metadata_iface.

◆ is_rt_capable()

template<class Metadata>

bool calf_plugins::plugin_metadata< Metadata >::is_rt_capable ( ) const

inlinevirtual

Returns: true if plugin can work in hard-realtime conditions

Implements calf_plugins::plugin_metadata_iface.

◆ requires_instance_access()

template<class Metadata>

bool calf_plugins::plugin_metadata< Metadata >::requires_instance_access ( ) const

inlinevirtual

Returns: true if plugin requires instance access

Implements calf_plugins::plugin_metadata_iface.

◆ requires_midi()

template<class Metadata>

bool calf_plugins::plugin_metadata< Metadata >::requires_midi ( ) const

inlinevirtual

Returns: true if plugin has MIDI input

Implements calf_plugins::plugin_metadata_iface.

◆ sends_live_updates()

template<class Metadata>

bool calf_plugins::plugin_metadata< Metadata >::sends_live_updates ( ) const

inlinevirtual

Returns: whether live UI events are generated

Implements calf_plugins::plugin_metadata_iface.

Member Data Documentation

◆ param_props

template<class Metadata>

parameter_properties calf_plugins::plugin_metadata< Metadata >::param_props[]

static

◆ plugin_info

template<class Metadata>

ladspa_plugin_info calf_plugins::plugin_metadata< Metadata >::plugin_info

static

◆ port_names

template<class Metadata>

const char* calf_plugins::plugin_metadata< Metadata >::port_names[]

static

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

/home/runner/work/lmms-fork/lmms-fork/plugins/LadspaEffect/calf/veal/src/calf/giface.h

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ metadata_class

Member Function Documentation

◆ get_commands()

◆ get_gui_xml()

◆ get_id()

◆ get_input_count()

◆ get_inputs_optional()

◆ get_label()

◆ get_midi()

◆ get_name()

◆ get_output_count()

◆ get_outputs_optional()

◆ get_param_count()

◆ get_param_port_offset()

◆ get_param_props()

◆ get_plugin_info()

◆ get_port_names()

◆ get_simulate_stereo_input()

◆ is_cv()

◆ is_noisy()

◆ is_rt_capable()

◆ requires_instance_access()

◆ requires_midi()

◆ sends_live_updates()

Member Data Documentation

◆ param_props

◆ plugin_info

◆ port_names