pulp::format::clap_adapter Namespace Reference

Classes
struct	OutboundParamEvent
struct	PulpClapPlugin

Enumerations
enum class	OutboundParamEventKind : std::uint8_t { GestureBegin , Value , GestureEnd }

Functions
const clap_plugin_entry_t *	get_clap_entry ()
clap_plugin_descriptor_t	make_clap_descriptor (const PluginDescriptor &desc)
bool	clap_init (const clap_plugin_t *plugin)
void	clap_destroy (const clap_plugin_t *plugin)
bool	clap_activate (const clap_plugin_t *plugin, double sr, uint32_t min_frames, uint32_t max_frames)
void	clap_deactivate (const clap_plugin_t *plugin)
bool	clap_start_processing (const clap_plugin_t *plugin)
void	clap_stop_processing (const clap_plugin_t *plugin)
void	clap_reset (const clap_plugin_t *plugin)
clap_process_status	clap_process (const clap_plugin_t *plugin, const clap_process_t *process)
void	clap_params_flush (const clap_plugin_t *plugin, const clap_input_events_t *in, const clap_output_events_t *out)
bool	clap_param_modulation_lane (const PulpClapPlugin &self, const clap_event_param_mod_t &event, state::ModulationLane &lane)
const void *	clap_get_extension (const clap_plugin_t *plugin, const char *id)
void	clap_on_main_thread (const clap_plugin_t *plugin)
const clap_plugin_gui_t *	contract_gui_extension (const clap_plugin_t *plugin)
	The contract GUI extension for plugin, or null when its processor is not initialized, has no editor factory, or editors are blocked by the environment (headless, CI, tests).
const clap_plugin_timer_support_t *	contract_timer_extension (const clap_plugin_t *plugin)
	The timer-support extension that drives a contract editor's idle tick, or null when the contract GUI does not apply to plugin.
ContractEditorSession *	contract_gui_session (const clap_plugin_t *plugin)
	The session behind plugin's open contract GUI, or null when none is open, so an in-process host (automation, tests) can reach the editor and its EditorAutomation.

Variables
static constexpr int	kMaxChannels
static constexpr int	kMaxInputBuses = 2
static constexpr int	kMaxOutputBuses = 8
static constexpr state::ModulationSourceId	kClapHostModulationSourceId = 1
static constexpr std::size_t	kOutboundParamEventCapacity = 1024

Enumeration Type Documentation

OutboundParamEventKind

enum class pulp::format::clap_adapter::OutboundParamEventKind : std::uint8_t

strong

Enumerator
GestureBegin
Value
GestureEnd

Function Documentation

clap_activate()

bool pulp::format::clap_adapter::clap_activate	(	const clap_plugin_t *	plugin,
		double	sr,
		uint32_t	min_frames,
		uint32_t	max_frames )

clap_deactivate()

void pulp::format::clap_adapter::clap_deactivate

(

const clap_plugin_t *

plugin

)

clap_destroy()

void pulp::format::clap_adapter::clap_destroy

(

const clap_plugin_t *

plugin

)

clap_get_extension()

const void * pulp::format::clap_adapter::clap_get_extension	(	const clap_plugin_t *	plugin,
		const char *	id )

clap_init()

bool pulp::format::clap_adapter::clap_init

(

const clap_plugin_t *

plugin

)

clap_on_main_thread()

void pulp::format::clap_adapter::clap_on_main_thread

(

const clap_plugin_t *

plugin

)

clap_param_modulation_lane()

bool pulp::format::clap_adapter::clap_param_modulation_lane	(	const PulpClapPlugin &	self,
		const clap_event_param_mod_t &	event,
		state::ModulationLane &	lane )

clap_params_flush()

void pulp::format::clap_adapter::clap_params_flush	(	const clap_plugin_t *	plugin,
		const clap_input_events_t *	in,
		const clap_output_events_t *	out )

clap_process()

clap_process_status pulp::format::clap_adapter::clap_process	(	const clap_plugin_t *	plugin,
		const clap_process_t *	process )

clap_reset()

void pulp::format::clap_adapter::clap_reset

(

const clap_plugin_t *

plugin

)

clap_start_processing()

bool pulp::format::clap_adapter::clap_start_processing

(

const clap_plugin_t *

plugin

)

clap_stop_processing()

void pulp::format::clap_adapter::clap_stop_processing

(

const clap_plugin_t *

plugin

)

contract_gui_extension()

const clap_plugin_gui_t * pulp::format::clap_adapter::contract_gui_extension

(

const clap_plugin_t *

plugin

)

The contract GUI extension for plugin, or null when its processor is not initialized, has no editor factory, or editors are blocked by the environment (headless, CI, tests).

contract_gui_session()

ContractEditorSession * pulp::format::clap_adapter::contract_gui_session

(

const clap_plugin_t *

plugin

)

The session behind plugin's open contract GUI, or null when none is open, so an in-process host (automation, tests) can reach the editor and its EditorAutomation.

Main thread.

contract_timer_extension()

const clap_plugin_timer_support_t * pulp::format::clap_adapter::contract_timer_extension

(

const clap_plugin_t *

plugin

)

The timer-support extension that drives a contract editor's idle tick, or null when the contract GUI does not apply to plugin.

get_clap_entry()

const clap_plugin_entry_t * pulp::format::clap_adapter::get_clap_entry

(

)

make_clap_descriptor()

clap_plugin_descriptor_t pulp::format::clap_adapter::make_clap_descriptor

(

const PluginDescriptor &

desc

)

Variable Documentation

kClapHostModulationSourceId

state::ModulationSourceId pulp::format::clap_adapter::kClapHostModulationSourceId = 1

staticconstexpr

kMaxChannels

int pulp::format::clap_adapter::kMaxChannels

staticconstexpr

Initial value:

=
    static_cast<int>(boundary::kBoundaryMaxChannels)

kMaxInputBuses

int pulp::format::clap_adapter::kMaxInputBuses = 2

staticconstexpr

kMaxOutputBuses

int pulp::format::clap_adapter::kMaxOutputBuses = 8

staticconstexpr

kOutboundParamEventCapacity

std::size_t pulp::format::clap_adapter::kOutboundParamEventCapacity = 1024

staticconstexpr