Interface for host-GUI-plugin interaction (should be really split in two, but ... meh). More...

#include <giface.h>

Inheritance diagram for calf_plugins::plugin_ctl_iface:

Public Member Functions
virtual float	get_param_value (int param_no)=0
virtual void	set_param_value (int param_no, float value)=0
	Set value of given parameter.
virtual bool	activate_preset (int bank, int program)=0
	Load preset with given number.
virtual float	get_level (unsigned int port)=0
virtual void	execute (int cmd_no)=0
	Execute menu command with given number.
virtual char *	configure (const char key, const char value)=0
	Set a configure variable on a plugin.
virtual void	send_configures (send_configure_iface *)=0
	Send all configure variables set within a plugin to given destination (which may be limited to only those that plugin understands).
virtual void	clear_preset ()
	Restore all state (parameters and configure vars) to default values - implemented in giface.cpp.
virtual bool	blobcall (const char *command, const std::string &request, std::string &result)
virtual int	send_status_updates (send_updates_iface *sui, int last_serial)=0
virtual const plugin_metadata_iface *	get_metadata_iface () const =0
	Return metadata object.
virtual const line_graph_iface *	get_line_graph_iface () const =0
virtual const phase_graph_iface *	get_phase_graph_iface () const =0
virtual int	get_write_serial (int param_no)
virtual void	add_automation (uint32_t source, const automation_range &dest)
	Add or update parameter automation routing.
virtual void	delete_automation (uint32_t source, int param_no)
	Remove parameter automation routing.
virtual void	get_automation (int param_no, std::multimap< uint32_t, automation_range > &dests)
virtual uint32_t	get_last_automation_source ()
	Return the source identifier for the most recently seen control change that could be used for automation.
virtual void	send_automation_configures (send_configure_iface *)
virtual	~plugin_ctl_iface ()
	Do-nothing destructor to silence compiler warning.

Detailed Description

Interface for host-GUI-plugin interaction (should be really split in two, but ... meh).

Constructor & Destructor Documentation

◆ ~plugin_ctl_iface()

virtual calf_plugins::plugin_ctl_iface::~plugin_ctl_iface ( )

inlinevirtual

Do-nothing destructor to silence compiler warning.

Member Function Documentation

◆ activate_preset()

virtual bool calf_plugins::plugin_ctl_iface::activate_preset	(	int	bank,
		int	program )

pure virtual

Load preset with given number.

Implemented in lv2_plugin_proxy.

◆ add_automation()

virtual void calf_plugins::plugin_ctl_iface::add_automation	(	uint32_t	source,
		const automation_range &	dest )

inlinevirtual

Add or update parameter automation routing.

◆ blobcall()

virtual bool calf_plugins::plugin_ctl_iface::blobcall	(	const char *	command,
		const std::string &	request,
		std::string &	result )

inlinevirtual

Call a named function in a plugin - this will most likely be redesigned soon - and never used

Return values

false call has failed, result contains an error message

◆ clear_preset()

void calf_plugins::plugin_ctl_iface::clear_preset ( )

virtual

Restore all state (parameters and configure vars) to default values - implemented in giface.cpp.

◆ configure()

virtual char * calf_plugins::plugin_ctl_iface::configure	(	const char *	key,
		const char *	value )

pure virtual

Set a configure variable on a plugin.

Implemented in lv2_plugin_proxy.

◆ delete_automation()

virtual void calf_plugins::plugin_ctl_iface::delete_automation	(	uint32_t	source,
		int	param_no )

inlinevirtual

Remove parameter automation routing.

◆ execute()

virtual void calf_plugins::plugin_ctl_iface::execute ( int cmd_no )

pure virtual

Execute menu command with given number.

Implemented in lv2_plugin_proxy.

◆ get_automation()

virtual void calf_plugins::plugin_ctl_iface::get_automation	(	int	param_no,
		std::multimap< uint32_t, automation_range > &	dests )

inlinevirtual

Retrieve automation list for a given parameter

Parameters

param_no parameter to retrieve automation list for, or -1 for all

◆ get_last_automation_source()

virtual uint32_t calf_plugins::plugin_ctl_iface::get_last_automation_source ( )

inlinevirtual

Return the source identifier for the most recently seen control change that could be used for automation.

◆ get_level()

virtual float calf_plugins::plugin_ctl_iface::get_level ( unsigned int port )

pure virtual

Returns: volume level for port'th port (if supported by the implementation, currently only jack_host<Module> implements that by measuring signal level on plugin ports)

Implemented in lv2_plugin_proxy.

◆ get_line_graph_iface()

virtual const line_graph_iface * calf_plugins::plugin_ctl_iface::get_line_graph_iface ( ) const

pure virtual

Returns: line_graph_iface if any

Implemented in lv2_plugin_proxy.

◆ get_metadata_iface()

virtual const plugin_metadata_iface * calf_plugins::plugin_ctl_iface::get_metadata_iface ( ) const

pure virtual

Return metadata object.

Implemented in lv2_plugin_proxy.

◆ get_param_value()

virtual float calf_plugins::plugin_ctl_iface::get_param_value ( int param_no )

pure virtual

Returns: value of given parameter

Implemented in lv2_plugin_proxy.

◆ get_phase_graph_iface()

virtual const phase_graph_iface * calf_plugins::plugin_ctl_iface::get_phase_graph_iface ( ) const

pure virtual

Returns: phase_graph_iface if any

Implemented in lv2_plugin_proxy.

◆ get_write_serial()

virtual int calf_plugins::plugin_ctl_iface::get_write_serial ( int param_no )

inlinevirtual

Returns: serial number of last automation write (JACK host only)

◆ send_automation_configures()

virtual void calf_plugins::plugin_ctl_iface::send_automation_configures ( send_configure_iface * )

inlinevirtual

◆ send_configures()

virtual void calf_plugins::plugin_ctl_iface::send_configures ( send_configure_iface * )

pure virtual

Send all configure variables set within a plugin to given destination (which may be limited to only those that plugin understands).

Implemented in lv2_plugin_proxy.

◆ send_status_updates()

virtual int calf_plugins::plugin_ctl_iface::send_status_updates	(	send_updates_iface *	sui,
		int	last_serial )

pure virtual

Update status variables changed since last_serial

Returns: new last_serial

Implemented in lv2_plugin_proxy.

◆ set_param_value()

virtual void calf_plugins::plugin_ctl_iface::set_param_value	(	int	param_no,
		float	value )

pure virtual

Set value of given parameter.

Implemented in lv2_plugin_proxy.

The documentation for this struct was generated from the following files:

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~plugin_ctl_iface()

Member Function Documentation

◆ activate_preset()

◆ add_automation()

◆ blobcall()

◆ clear_preset()

◆ configure()

◆ delete_automation()

◆ execute()

◆ get_automation()

◆ get_last_automation_source()

◆ get_level()

◆ get_line_graph_iface()

◆ get_metadata_iface()

◆ get_param_value()

◆ get_phase_graph_iface()

◆ get_write_serial()

◆ send_automation_configures()

◆ send_configures()

◆ send_status_updates()

◆ set_param_value()