#include <modules_comp.h>

Inheritance diagram for calf_plugins::monocompressor_audio_module:

Public Types
typedef std::complex< double >	cfloat
Public Types inherited from calf_plugins::audio_module< monocompressor_metadata >
typedef monocompressor_metadata	metadata_type
Public Types inherited from calf_plugins::monocompressor_metadata
enum	{ in_count = 1 , out_count = 1 , ins_optional = 0 , outs_optional = 0 , support_midi = false , require_midi = false , rt_capable = true , require_instance_access = false }
enum	{ param_bypass , param_level_in , MONO_VU_METER_PARAMS , param_threshold , param_ratio , param_attack , param_release , param_makeup , param_knee , param_compression , param_mix , param_count }
Public Types inherited from calf_plugins::plugin_metadata< monocompressor_metadata >
typedef plugin_metadata< monocompressor_metadata >	metadata_class
Public Types inherited from calf_plugins::plugin_metadata_iface
enum	{ simulate_stereo_input = true , has_live_updates = true }

Public Member Functions
	monocompressor_audio_module ()
void	activate ()
	LADSPA-esque activate function, except it is called after ports are connected, not before.
void	deactivate ()
	LADSPA-esque deactivate function.
void	params_changed ()
	Called when params are changed (before processing).
void	set_sample_rate (uint32_t sr)
	Set sample rate for the plugin.
uint32_t	process (uint32_t offset, uint32_t numsamples, uint32_t inputs_mask, uint32_t outputs_mask)
	The audio processing loop; assumes numsamples <= MAX_SAMPLE_RUN, for larger buffers, call process_slice.
bool	get_graph (int index, int subindex, int phase, float data, int points, cairo_iface context, int *mode) const
bool	get_dot (int index, int subindex, int phase, float &x, float &y, int &size, cairo_iface *context) const
bool	get_gridline (int index, int subindex, int phase, float &pos, bool &vertical, std::string &legend, cairo_iface *context) const
bool	get_layers (int index, int generation, unsigned int &layers) const
Public Member Functions inherited from calf_plugins::audio_module< monocompressor_metadata >
	audio_module ()
void	note_on (int channel, int note, int velocity)
	Handle MIDI Note On.
void	note_off (int channel, int note, int velocity)
	Handle MIDI Note Off.
void	program_change (int channel, int program)
	Handle MIDI Program Change.
void	control_change (int channel, int controller, int value)
	Handle MIDI Control Change.
void	pitch_bend (int channel, int value)
void	channel_pressure (int channel, int value)
void	execute (int cmd_no)
	Execute menu command with given number.
virtual char *	configure (const char key, const char value)
	DSSI configure call.
void	send_configures (send_configure_iface *sci)
	Send all understood configure vars (none by default).
int	send_status_updates (send_updates_iface *sui, int last_serial)
	Send all supported status vars (none by default).
void	params_reset ()
	Reset parameter values for epp:trigger type parameters (ones activated by oneshot push button instead of check box).
void	post_instantiate (uint32_t)
	Called after instantiating (after all the feature pointers are set - including interfaces like progress_report_iface).
uint32_t	message_run (const void valid_ports, void output_ports)
virtual void	get_port_arrays (float &ins_ptrs, float &outs_ptrs, float **&params_ptrs)
	Return the array of input port pointers.
virtual const plugin_metadata_iface *	get_metadata_iface () const
	Return metadata object.
virtual void	set_progress_report_iface (progress_report_iface *iface)
	Set the progress report interface to communicate progress to.
void	zero_by_mask (uint32_t mask, uint32_t offset, uint32_t nsamples)
	utility function: zero port values if mask is 0
uint32_t	process_slice (uint32_t offset, uint32_t end)
	utility function: call process, and if it returned zeros in output masks, zero out the relevant output port buffers
virtual const line_graph_iface *	get_line_graph_iface () const
virtual const phase_graph_iface *	get_phase_graph_iface () const
Public Member Functions inherited from calf_plugins::plugin_metadata< monocompressor_metadata >
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.
Public Member Functions inherited from calf_plugins::audio_module_iface
virtual	~audio_module_iface ()
Public Member Functions inherited from calf_plugins::line_graph_iface
virtual bool	get_moving (int index, int subindex, int &direction, float *data, int x, int y, int &offset, uint32_t &color) const
virtual std::string	get_crosshair_label (int x, int y, int sx, int sy, float q, int dB, int name, int note, int cents) const
virtual	~line_graph_iface ()
	Standard destructor to make compiler happy.

Public Attributes
uint32_t	srate
bool	is_active
Public Attributes inherited from calf_plugins::audio_module< monocompressor_metadata >
float *	ins [(monocompressor_metadata::in_count !=0) ? monocompressor_metadata::in_count :1]
float *	outs [(monocompressor_metadata::out_count !=0) ? monocompressor_metadata::out_count :1]
float *	params [monocompressor_metadata::param_count]
bool	questionable_data_reported_in
bool	questionable_data_reported_out
progress_report_iface *	progress_report

Private Types
typedef monocompressor_audio_module	AM

Private Attributes
gain_reduction2_audio_module	monocompressor
vumeters	meters
dsp::bypass	bypass

Additional Inherited Members
Static Public Attributes inherited from calf_plugins::plugin_metadata< monocompressor_metadata >
static const char *	port_names []
static parameter_properties	param_props []
static ladspa_plugin_info	plugin_info

Member Typedef Documentation

◆ AM

typedef monocompressor_audio_module calf_plugins::monocompressor_audio_module::AM

private

◆ cfloat

typedef std::complex<double> calf_plugins::monocompressor_audio_module::cfloat

Constructor & Destructor Documentation

◆ monocompressor_audio_module()

monocompressor_audio_module::monocompressor_audio_module ( )

Member Function Documentation

◆ activate()

void monocompressor_audio_module::activate ( )

virtual

LADSPA-esque activate function, except it is called after ports are connected, not before.

Reimplemented from calf_plugins::audio_module< monocompressor_metadata >.

◆ deactivate()

void monocompressor_audio_module::deactivate ( )

virtual

LADSPA-esque deactivate function.

Reimplemented from calf_plugins::audio_module< monocompressor_metadata >.

◆ get_dot()

bool monocompressor_audio_module::get_dot	(	int	index,
		int	subindex,
		int	phase,
		float &	x,
		float &	y,
		int &	size,
		cairo_iface *	context ) const

virtual

Obtain subindex'th dot of parameter 'index'

Parameters

index	parameter/dot number (usually tied to particular plugin control port)
subindex	dot number (there may be multiple dots graphs for one parameter)
phase	0 if in cache phase or 1 if in realtime phase

Reimplemented from calf_plugins::line_graph_iface.

◆ get_graph()

bool monocompressor_audio_module::get_graph	(	int	index,
		int	subindex,
		int	phase,
		float *	data,
		int	points,
		cairo_iface *	context,
		int *	mode ) const

virtual

Obtain subindex'th graph of parameter 'index'

Parameters

index	parameter/graph number (usually tied to particular plugin control port)
subindex	graph number (there may be multiple overlaid graphs for one parameter, eg. for monosynth 2x12dB filters)
phase	0 if in cache phase or 1 if in realtime phase
data	buffer for normalized output values
points	number of points to fill
context	cairo context to adjust (for multicolour graphs etc.)

Return values

true	graph data was returned; subindex+1 graph may or may not be available
false	graph data was not returned; subindex+1 graph does not exist either

Reimplemented from calf_plugins::line_graph_iface.

◆ get_gridline()

bool monocompressor_audio_module::get_gridline	(	int	index,
		int	subindex,
		int	phase,
		float &	pos,
		bool &	vertical,
		std::string &	legend,
		cairo_iface *	context ) const

virtual

Obtain subindex'th dot of parameter 'index'

Parameters

index	parameter/dot number (usually tied to particular plugin control port)
subindex	dot number (there may be multiple dots graphs for one parameter)
phase	0 if in cache phase or 1 if in realtime phase

Reimplemented from calf_plugins::line_graph_iface.

◆ get_layers()

bool monocompressor_audio_module::get_layers	(	int	index,
		int	generation,
		unsigned int &	layers ) const

virtual

Return which layers need to be redrawn in the next GTK drawing cycle

Parameters

index	Parameter/graph identifier (usually tied to particular plugin control port)
generation	The overall amount of drawing cycles since the last full refresh of all surfaces
layers	Bitmask defining the layers to be redrawn (see layers_flags above)

Return values

true	there's at least one layer to be redrawn; false nothing to draw in this cycle

Reimplemented from calf_plugins::line_graph_iface.

◆ params_changed()

void monocompressor_audio_module::params_changed ( )

virtual

Called when params are changed (before processing).

Reimplemented from calf_plugins::audio_module< monocompressor_metadata >.

◆ process()

uint32_t monocompressor_audio_module::process	(	uint32_t	offset,
		uint32_t	numsamples,
		uint32_t	inputs_mask,
		uint32_t	outputs_mask )

virtual

The audio processing loop; assumes numsamples <= MAX_SAMPLE_RUN, for larger buffers, call process_slice.

Implements calf_plugins::audio_module_iface.

◆ set_sample_rate()

void monocompressor_audio_module::set_sample_rate ( uint32_t sr )

virtual

Set sample rate for the plugin.

Reimplemented from calf_plugins::audio_module< monocompressor_metadata >.

Member Data Documentation

◆ bypass

dsp::bypass calf_plugins::monocompressor_audio_module::bypass

private

◆ is_active

bool calf_plugins::monocompressor_audio_module::is_active

◆ meters

vumeters calf_plugins::monocompressor_audio_module::meters

private

◆ monocompressor

gain_reduction2_audio_module calf_plugins::monocompressor_audio_module::monocompressor

private

◆ srate

uint32_t calf_plugins::monocompressor_audio_module::srate

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

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

Public Types

Public Member Functions

Public Attributes

Private Types

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AM

◆ cfloat

Constructor & Destructor Documentation

◆ monocompressor_audio_module()

Member Function Documentation

◆ activate()

◆ deactivate()

◆ get_dot()

◆ get_graph()

◆ get_gridline()

◆ get_layers()

◆ params_changed()

◆ process()

◆ set_sample_rate()

Member Data Documentation

◆ bypass

◆ is_active

◆ meters

◆ monocompressor

◆ srate