A Fader is a processor that is used for volume controls and pan. More...

#include <src/dsp/fader.h>

Inheritance diagram for zrythm::dsp::Fader:

[legend]

Collaboration diagram for zrythm::dsp::Fader:

[legend]

Public Types
enum class	MidiFaderMode : uint8_t { MIDI_FADER_MODE_VEL_MULTIPLIER , MIDI_FADER_MODE_CC_VOLUME }
using	ShouldBeMutedCallback = std::function<bool (bool fader_solo_status)>
	A callback to check if the fader should be muted based on various external factors (such as solo status of other tracks).
using	MuteGainCallback = std::function<float ()>
	Callback to get the gain that should be used if the fader is effectively muted.
using	PreProcessAudioCallback
	Callback to pre-process the incoming audio before applying gain, pan, etc.

Public Member Functions
	Fader (utils::IObjectRegistry &registry, dsp::PortType signal_type, bool hard_limit_output, bool make_params_automatable, std::optional< std::function< utils::Utf8String()> > owner_name_provider, ShouldBeMutedCallback should_be_muted_cb, QObject *parent=nullptr)
	Creates a new fader.
MidiFaderMode	midiMode () const
void	setMidiMode (MidiFaderMode mode)
Q_SIGNAL void	midiModeChanged (MidiFaderMode mode)
zrythm::dsp::ProcessorParameter *	gain () const
zrythm::dsp::ProcessorParameter *	balance () const
zrythm::dsp::ProcessorParameter *	mute () const
zrythm::dsp::ProcessorParameter *	solo () const
zrythm::dsp::ProcessorParameter *	listen () const
zrythm::dsp::ProcessorParameter *	monoToggle () const
zrythm::dsp::ProcessorParameter *	swapPhaseToggle () const
bool	currently_muted () const
	Returns if the fader is muted.
bool	currently_soloed () const
	Returns if the track is soloed.
bool	currently_listened () const
	Returns whether the fader is listened.
float	get_current_amp () const
	Gets the fader amplitude (not db).
std::string	db_string_getter () const
void	set_mute_gain_callback (MuteGainCallback cb)
void	set_preprocess_audio_callback (PreProcessAudioCallback cb)
void	custom_prepare_for_processing (const graph::GraphNode *node, units::sample_rate_t sample_rate, units::sample_u32_t max_block_length) override
void	custom_release_resources () override
void	custom_process_block (dsp::graph::ProcessBlockInfo time_nfo, const dsp::ITransport &transport, const dsp::TempoMap &tempo_map) noexcept override
	Custom processor logic after processing all owned parameters.
bool	is_audio () const
bool	is_midi () const
bool	hard_limiting_enabled () const
dsp::ProcessorParameter &	get_amp_param () const
dsp::ProcessorParameter &	get_balance_param () const
dsp::ProcessorParameter &	get_mute_param () const
dsp::ProcessorParameter &	get_solo_param () const
dsp::ProcessorParameter &	get_listen_param () const
dsp::ProcessorParameter &	get_mono_compat_enabled_param () const
dsp::ProcessorParameter &	get_swap_phase_param () const
dsp::AudioPort &	get_stereo_in_port () const
dsp::AudioPort &	get_stereo_out_port () const
dsp::MidiPort &	get_midi_in_port () const
dsp::MidiPort &	get_midi_out_port () const
auto	currently_soloed_rt () const noexcept
bool	currently_listened_rt () const noexcept
Public Member Functions inherited from zrythm::dsp::ProcessorBase
	ProcessorBase (utils::IObjectRegistry &registry, utils::Utf8String name={ u8"ProcessorBase" })
void	set_name (const utils::Utf8String &name)
	Set a custom name to be used in the DSP graph.
void	add_input_port (const dsp::PortUuidReference &uuid)
void	add_output_port (const dsp::PortUuidReference &uuid)
void	add_parameter (const dsp::ProcessorParameterUuidReference &uuid)
auto &	get_input_ports () const
auto &	get_output_ports () const
auto &	get_parameters () const
const ParameterChangeTracker &	change_tracker () const noexcept
	Returns the change tracker.
utils::Utf8String	get_node_name () const final
	Returns a human friendly name of the node.
void	process_block (dsp::graph::ProcessBlockInfo time_nfo, const dsp::ITransport &transport, const dsp::TempoMap &tempo_map) noexcept final
	Calls custom_process_block() internally after processing all the parameters.
void	prepare_for_processing_impl (const graph::GraphNode *node, units::sample_rate_t sample_rate, units::sample_u32_t max_block_length) final
void	release_resources () final
	Called to release resources allocated by prepare_for_processing().
Public Member Functions inherited from zrythm::dsp::graph::IProcessable
virtual units::sample_u32_t	get_single_playback_latency () const
	Returns the latency of only the given processable, without adding the previous/next latencies (zero latency by default).
void	prepare_for_processing (const GraphNode *node, units::sample_rate_t sample_rate, units::sample_u32_t max_block_length)
	Called to allocate resources required for processing.

Properties
MidiFaderMode	midiMode
zrythm::dsp::ProcessorParameter *	gain
zrythm::dsp::ProcessorParameter *	balance
zrythm::dsp::ProcessorParameter *	mute
zrythm::dsp::ProcessorParameter *	solo
zrythm::dsp::ProcessorParameter *	listen
zrythm::dsp::ProcessorParameter *	monoToggle
zrythm::dsp::ProcessorParameter *	swapPhaseToggle

Friends
void	init_from (Fader &obj, const Fader &other, utils::ObjectCloneType clone_type)
void	to_json (nlohmann::json &j, const Fader &fader)
void	from_json (const nlohmann::json &j, Fader &fader)

Additional Inherited Members
Protected Member Functions inherited from zrythm::dsp::ProcessorBase
auto	registry () const -> utils::IObjectRegistry &

Detailed Description

A Fader is a processor that is used for volume controls and pan.

Definition at line 16 of file fader.h.

Member Typedef Documentation

◆ MuteGainCallback

using zrythm::dsp::Fader::MuteGainCallback = std::function<float ()>

Callback to get the gain that should be used if the fader is effectively muted.

Definition at line 74 of file fader.h.

◆ PreProcessAudioCallback

using zrythm::dsp::Fader::PreProcessAudioCallback

Initial value:

std::function<void (
   std::pair<std::span<float>, std::span<float>> stereo_bufs,
   const dsp::graph::ProcessBlockInfo           &time_nfo)>

Callback to pre-process the incoming audio before applying gain, pan, etc.

Mainly for use by the monitor fader.

Definition at line 82 of file fader.h.

◆ ShouldBeMutedCallback

using zrythm::dsp::Fader::ShouldBeMutedCallback = std::function<bool (bool fader_solo_status)>

A callback to check if the fader should be muted based on various external factors (such as solo status of other tracks).

Note: If the fader itself is muted this will not be called - fader is assumed to be muted.

Parameters

current_solo_status The fader's own solo status.

Definition at line 68 of file fader.h.

Member Enumeration Documentation

◆ MidiFaderMode

enum class zrythm::dsp::Fader::MidiFaderMode : uint8_t

strong

Enumerator
MIDI_FADER_MODE_VEL_MULTIPLIER	Multiply velocity of all MIDI note ons.
MIDI_FADER_MODE_CC_VOLUME	Send CC volume event on change TODO.

Definition at line 48 of file fader.h.

Constructor & Destructor Documentation

◆ Fader()

zrythm::dsp::Fader::Fader	(	utils::IObjectRegistry &	registry,
		dsp::PortType	signal_type,
		bool	hard_limit_output,
		bool	make_params_automatable,
		std::optional< std::function< utils::Utf8String()> >	owner_name_provider,
		ShouldBeMutedCallback	should_be_muted_cb,
		QObject *	parent = nullptr )

Creates a new fader.

Parameters

hard_limit_output	Whether the output should be hard-limited (only applies to audio faders). This should be true for the master track fader, the monitor fader and the sample processor (deprecated?) fader.
make_params_automatable	Whether to make (a subset of) the parameters automatable. If false, no parameter will be automatable.

Member Function Documentation

◆ balance()

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::balance ( ) const

inline

Definition at line 127 of file fader.h.

◆ currently_listened()

bool zrythm::dsp::Fader::currently_listened ( ) const

inline

Returns whether the fader is listened.

Definition at line 199 of file fader.h.

◆ currently_listened_rt()

bool zrythm::dsp::Fader::currently_listened_rt ( ) const

inlinenoexcept

Definition at line 290 of file fader.h.

◆ currently_muted()

bool zrythm::dsp::Fader::currently_muted ( ) const

inline

Returns if the fader is muted.

Definition at line 181 of file fader.h.

◆ currently_soloed()

bool zrythm::dsp::Fader::currently_soloed ( ) const

inline

Returns if the track is soloed.

Definition at line 190 of file fader.h.

◆ currently_soloed_rt()

auto zrythm::dsp::Fader::currently_soloed_rt ( ) const

inlinenoexcept

Definition at line 284 of file fader.h.

◆ custom_prepare_for_processing()

void zrythm::dsp::Fader::custom_prepare_for_processing	(	const graph::GraphNode *	node,
		units::sample_rate_t	sample_rate,
		units::sample_u32_t	max_block_length )

overridevirtual

Reimplemented from zrythm::dsp::ProcessorBase.

◆ custom_process_block()

void zrythm::dsp::Fader::custom_process_block	(	dsp::graph::ProcessBlockInfo	time_nfo,
		const dsp::ITransport &	transport,
		const dsp::TempoMap &	tempo_map )

overridevirtualnoexcept

Custom processor logic after processing all owned parameters.

By default, this does passthrough to same-type ports.

Reimplemented from zrythm::dsp::ProcessorBase.

◆ custom_release_resources()

void zrythm::dsp::Fader::custom_release_resources ( )

overridevirtual

Reimplemented from zrythm::dsp::ProcessorBase.

◆ gain()

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::gain ( ) const

inline

Definition at line 119 of file fader.h.

◆ get_current_amp()

float zrythm::dsp::Fader::get_current_amp ( ) const

inline

Gets the fader amplitude (not db).

Definition at line 208 of file fader.h.

◆ get_midi_in_port()

dsp::MidiPort & zrythm::dsp::Fader::get_midi_in_port ( ) const

inline

Definition at line 275 of file fader.h.

◆ get_midi_out_port()

dsp::MidiPort & zrythm::dsp::Fader::get_midi_out_port ( ) const

inline

Definition at line 279 of file fader.h.

◆ get_stereo_in_port()

dsp::AudioPort & zrythm::dsp::Fader::get_stereo_in_port ( ) const

inline

Definition at line 259 of file fader.h.

◆ get_stereo_out_port()

dsp::AudioPort & zrythm::dsp::Fader::get_stereo_out_port ( ) const

inline

Definition at line 267 of file fader.h.

◆ hard_limiting_enabled()

bool zrythm::dsp::Fader::hard_limiting_enabled ( ) const

inline

Definition at line 247 of file fader.h.

◆ is_audio()

bool zrythm::dsp::Fader::is_audio ( ) const

inline

Definition at line 244 of file fader.h.

◆ is_midi()

bool zrythm::dsp::Fader::is_midi ( ) const

inline

Definition at line 245 of file fader.h.

◆ listen()

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::listen ( ) const

inline

Definition at line 151 of file fader.h.

◆ midiMode()

MidiFaderMode zrythm::dsp::Fader::midiMode ( ) const

inline

Definition at line 108 of file fader.h.

◆ monoToggle()

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::monoToggle ( ) const

inline

Definition at line 159 of file fader.h.

◆ mute()

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::mute ( ) const

inline

Definition at line 135 of file fader.h.

◆ set_mute_gain_callback()

void zrythm::dsp::Fader::set_mute_gain_callback ( MuteGainCallback cb )

inline

Definition at line 216 of file fader.h.

◆ set_preprocess_audio_callback()

void zrythm::dsp::Fader::set_preprocess_audio_callback ( PreProcessAudioCallback cb )

inline

Definition at line 221 of file fader.h.

◆ setMidiMode()

void zrythm::dsp::Fader::setMidiMode ( MidiFaderMode mode )

inline

Definition at line 109 of file fader.h.

◆ solo()

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::solo ( ) const

inline

Definition at line 143 of file fader.h.

◆ swapPhaseToggle()

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::swapPhaseToggle ( ) const

inline

Definition at line 167 of file fader.h.

Property Documentation

◆ balance

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::balance

read

Definition at line 21 of file fader.h.

◆ gain

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::gain

read

Definition at line 20 of file fader.h.

◆ listen

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::listen

read

Definition at line 24 of file fader.h.

◆ midiMode

MidiFaderMode zrythm::dsp::Fader::midiMode

readwrite

Definition at line 19 of file fader.h.

◆ monoToggle

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::monoToggle

read

Definition at line 25 of file fader.h.

◆ mute

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::mute

read

Definition at line 22 of file fader.h.

◆ solo

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::solo

read

Definition at line 23 of file fader.h.

◆ swapPhaseToggle

zrythm::dsp::ProcessorParameter * zrythm::dsp::Fader::swapPhaseToggle

read

Definition at line 26 of file fader.h.

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

src/dsp/fader.h

Public Types

Public Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MuteGainCallback

◆ PreProcessAudioCallback

◆ ShouldBeMutedCallback

Member Enumeration Documentation

◆ MidiFaderMode

Constructor & Destructor Documentation

◆ Fader()

Member Function Documentation

◆ balance()

◆ currently_listened()

◆ currently_listened_rt()

◆ currently_muted()

◆ currently_soloed()

◆ currently_soloed_rt()

◆ custom_prepare_for_processing()

◆ custom_process_block()

◆ custom_release_resources()

◆ gain()

◆ get_current_amp()

◆ get_midi_in_port()

◆ get_midi_out_port()

◆ get_stereo_in_port()

◆ get_stereo_out_port()

◆ hard_limiting_enabled()

◆ is_audio()

◆ is_midi()

◆ listen()

◆ midiMode()

◆ monoToggle()

◆ mute()

◆ set_mute_gain_callback()

◆ set_preprocess_audio_callback()

◆ setMidiMode()

◆ solo()

◆ swapPhaseToggle()

Property Documentation

◆ balance

◆ gain

◆ listen

◆ midiMode

◆ monoToggle

◆ mute

◆ solo

◆ swapPhaseToggle