calf_plugins::analyzer_audio_module Class Reference

#include <modules_tools.h>

Inheritance diagram for calf_plugins::analyzer_audio_module:

Public Member Functions
	analyzer_audio_module ()
void	params_changed ()
	Called when params are changed (before processing).
void	activate ()
	LADSPA-esque activate function, except it is called after ports are connected, not before.
void	set_sample_rate (uint32_t sr)
	Set sample rate for the plugin.
void	deactivate ()
	LADSPA-esque deactivate function.
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_phase_graph (int index, float **_buffer, int *_length, int *_mode, bool *_use_fade, float *_fade, int *_accuracy, bool *_display) const
bool	get_graph (int index, int subindex, int phase, float *data, int points, cairo_iface *context, int *mode) const
bool	get_moving (int index, int subindex, int &direction, float *data, int x, int y, int &offset, uint32_t &color) 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
	~analyzer_audio_module ()
Public Member Functions inherited from calf_plugins::audio_module< analyzer_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	params_changed ()
	Called when params are changed (before processing).
void	activate ()
	LADSPA-esque activate function, except it is called after ports are connected, not before.
void	deactivate ()
	LADSPA-esque deactivate function.
void	set_sample_rate (uint32_t sr)
	Set sample rate for the plugin.
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< analyzer_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::phase_graph_iface
virtual	~phase_graph_iface ()
Public Member Functions inherited from calf_plugins::frequency_response_line_graph
virtual float	freq_gain (int index, double freq) 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
Public Member Functions inherited from calf_plugins::line_graph_iface
virtual bool	get_dot (int index, int subindex, int phase, float &x, float &y, int &size, cairo_iface *context) const
virtual	~line_graph_iface ()
	Standard destructor to make compiler happy.

Protected Attributes
int	phase_buffer_size
float *	phase_buffer
int	ppos
int	plength

Static Protected Attributes
static const int	max_phase_buffer_size = 8192

Private Types
typedef analyzer_audio_module	AM

Private Attributes
uint32_t	srate
bool	active
float	envelope
float	attack_coef
float	release_coef
uint32_t	clip_L
uint32_t	clip_R
float	meter_L
float	meter_R
analyzer	_analyzer

Additional Inherited Members
Public Types inherited from calf_plugins::audio_module< analyzer_metadata >
typedef analyzer_metadata	metadata_type
Public Types inherited from calf_plugins::analyzer_metadata
enum	{   in_count = 2 , out_count = 2 , ins_optional = 1 , outs_optional = 1 ,   support_midi = false , require_midi = false , rt_capable = true , require_instance_access = true }
enum	{   param_meter_L , param_meter_R , param_clip_L , param_clip_R ,   param_analyzer_level , param_analyzer_mode , param_analyzer_scale , param_analyzer_post ,   param_analyzer_view , param_analyzer_smoothing , param_analyzer_windowing , param_analyzer_accuracy ,   param_analyzer_speed , param_analyzer_display , param_analyzer_hold , param_analyzer_freeze ,   param_gonio_mode , param_gonio_use_fade , param_gonio_fade , param_gonio_accuracy ,   param_gonio_display , param_count }
Public Types inherited from calf_plugins::plugin_metadata< analyzer_metadata >
typedef plugin_metadata< analyzer_metadata >	metadata_class
Public Types inherited from calf_plugins::plugin_metadata_iface
enum	{ simulate_stereo_input = true , has_live_updates = true }
Public Attributes inherited from calf_plugins::audio_module< analyzer_metadata >
float *	ins [(analyzer_metadata::in_count !=0) ? analyzer_metadata::in_count :1]
float *	outs [(analyzer_metadata::out_count !=0) ? analyzer_metadata::out_count :1]
float *	params [analyzer_metadata::param_count]
bool	questionable_data_reported_in
bool	questionable_data_reported_out
progress_report_iface *	progress_report
Public Attributes inherited from calf_plugins::frequency_response_line_graph
bool	redraw_graph
Static Public Attributes inherited from calf_plugins::plugin_metadata< analyzer_metadata >
static const char *	port_names []
static parameter_properties	param_props []
static ladspa_plugin_info	plugin_info

Member Typedef Documentation

AM

typedef analyzer_audio_module calf_plugins::analyzer_audio_module::AM

private

Constructor & Destructor Documentation

analyzer_audio_module()

analyzer_audio_module::analyzer_audio_module

(

)

~analyzer_audio_module()

analyzer_audio_module::~analyzer_audio_module

(

)

Member Function Documentation

activate()

void analyzer_audio_module::activate ( )

virtual

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

Implements calf_plugins::audio_module_iface.

deactivate()

void analyzer_audio_module::deactivate ( )

virtual

LADSPA-esque deactivate function.

Implements calf_plugins::audio_module_iface.

get_graph()

bool analyzer_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::frequency_response_line_graph.

get_gridline()

bool analyzer_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::frequency_response_line_graph.

get_layers()

bool analyzer_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::frequency_response_line_graph.

get_moving()

bool analyzer_audio_module::get_moving ( int index, int subindex, int & direction, float * data, int x, int y, int & offset, uint32_t & color ) const

virtual

Obtain subindex'th moving surface of parameter 'index'

Parameters

index	parameter/dot number (usually tied to particular plugin control port)
subindex	mvoing line number (there may be multiple graphs for one parameter)
direction	0 if horizontal or 1 if vertical movement
data	buffer for normalized output values
x	number of points direction to fill in x
y	number of points direction to fill in y

Reimplemented from calf_plugins::line_graph_iface.

get_phase_graph()

bool analyzer_audio_module::get_phase_graph ( int index, float ** _buffer, int * _length, int * _mode, bool * _use_fade, float * _fade, int * _accuracy, bool * _display ) const

virtual

Reimplemented from calf_plugins::phase_graph_iface.

params_changed()

void analyzer_audio_module::params_changed ( )

virtual

Called when params are changed (before processing).

Implements calf_plugins::audio_module_iface.

process()

uint32_t analyzer_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 analyzer_audio_module::set_sample_rate ( uint32_t sr )

virtual

Set sample rate for the plugin.

Implements calf_plugins::audio_module_iface.

Member Data Documentation

_analyzer

analyzer calf_plugins::analyzer_audio_module::_analyzer

private

active

bool calf_plugins::analyzer_audio_module::active

private

attack_coef

float calf_plugins::analyzer_audio_module::attack_coef

private

clip_L

uint32_t calf_plugins::analyzer_audio_module::clip_L

private

clip_R

uint32_t calf_plugins::analyzer_audio_module::clip_R

private

envelope

float calf_plugins::analyzer_audio_module::envelope

private

max_phase_buffer_size

const int calf_plugins::analyzer_audio_module::max_phase_buffer_size = 8192

staticprotected

meter_L

float calf_plugins::analyzer_audio_module::meter_L

private

meter_R

float calf_plugins::analyzer_audio_module::meter_R

private

phase_buffer

float* calf_plugins::analyzer_audio_module::phase_buffer

protected

phase_buffer_size

int calf_plugins::analyzer_audio_module::phase_buffer_size

protected

plength

int calf_plugins::analyzer_audio_module::plength

protected

ppos

int calf_plugins::analyzer_audio_module::ppos

protected

release_coef

float calf_plugins::analyzer_audio_module::release_coef

private

srate

uint32_t calf_plugins::analyzer_audio_module::srate

private

---

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_tools.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/LadspaEffect/calf/veal/src/modules_tools.cpp