#include <return.h>

Inheritance diagram for ARDOUR::Return:

Public Member Functions
	Return (Session &, bool internal=false)

virtual	~Return ()

void	run (BufferSet &bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool)

std::shared_ptr< Amp >	amp () const

std::shared_ptr< PeakMeter >	meter () const

std::shared_ptr< GainControl >	gain_control () const

bool	metering () const

void	set_metering (bool yn)

int	set_state (const XMLNode &, int version)

uint32_t	pans_required () const

bool	can_support_io_configuration (const ChanCount &in, ChanCount &out)

bool	configure_io (ChanCount in, ChanCount out)

Public Member Functions inherited from ARDOUR::IOProcessor
	IOProcessor (Session &, bool with_input, bool with_output, const std::string &proc_name, const std::string io_name="", ARDOUR::DataType default_type=DataType::AUDIO, bool sendish=false)

	IOProcessor (Session &, std::shared_ptr< IO > input, std::shared_ptr< IO > output, const std::string &proc_name, Temporal::TimeDomainProvider const &, bool sendish=false)

virtual	~IOProcessor ()

bool	set_name (const std::string &str)

bool	does_routing () const

virtual ChanCount	natural_output_streams () const

virtual ChanCount	natural_input_streams () const

std::shared_ptr< IO >	input ()

std::shared_ptr< const IO >	input () const

std::shared_ptr< IO >	output ()

std::shared_ptr< const IO >	output () const

void	set_input (std::shared_ptr< IO >)

void	set_output (std::shared_ptr< IO >)

void	silence (samplecnt_t nframes, samplepos_t start_sample)

void	disconnect ()

virtual bool	feeds (std::shared_ptr< Route > other) const

uint32_t	bit_slot () const

Public Member Functions inherited from ARDOUR::Processor
	Processor (Session &, const std::string &name, Temporal::TimeDomainProvider const &)

	Processor (const Processor &other)

virtual	~Processor ()

virtual std::string	display_name () const

virtual bool	display_to_user () const

virtual void	set_display_to_user (bool)

bool	active () const
	ardour hard bypass More...

virtual bool	enabled () const
	processor enabled/bypass More...

virtual bool	bypassable () const
	enable is not automated or locked More...

bool	get_next_ab_is_active () const

void	set_next_ab_is_active (bool yn)

virtual samplecnt_t	signal_latency () const

virtual void	set_input_latency (samplecnt_t cnt)

samplecnt_t	input_latency () const

virtual void	set_output_latency (samplecnt_t cnt)

samplecnt_t	output_latency () const

virtual void	set_capture_offset (samplecnt_t cnt)

samplecnt_t	capture_offset () const

virtual void	set_playback_offset (samplecnt_t cnt)

samplecnt_t	playback_offset () const

virtual int	set_block_size (pframes_t)

virtual bool	requires_fixed_sized_buffers () const

virtual void	activate ()

virtual void	deactivate ()

virtual void	flush ()

virtual void	enable (bool yn)

virtual ChanCount	input_streams () const

virtual ChanCount	output_streams () const

virtual void	realtime_handle_transport_stopped ()

virtual void	realtime_locate (bool)

virtual void	set_loop (Location *loc)

virtual void	monitoring_changed ()

XMLNode &	get_state () const

virtual void	set_pre_fader (bool)

virtual bool	get_pre_fader () const

ProcessorWindowProxy *	window_proxy () const

void	set_window_proxy (ProcessorWindowProxy *wp)

PluginPinWindowProxy *	pinmgr_proxy () const

void	set_pingmgr_proxy (PluginPinWindowProxy *wp)

virtual void	set_owner (SessionObject *)

SessionObject *	owner () const

Public Member Functions inherited from ARDOUR::SessionObject
	SessionObject (Session &session, const std::string &name)

Session &	session () const

std::string	name () const

Public Member Functions inherited from ARDOUR::SessionHandleRef
	SessionHandleRef (ARDOUR::Session &s)

virtual	~SessionHandleRef ()

Public Member Functions inherited from PBD::ScopedConnectionList
	ScopedConnectionList ()

	ScopedConnectionList (const ScopedConnectionList &)=delete

ScopedConnectionList &	operator= (const ScopedConnectionList &)=delete

virtual	~ScopedConnectionList ()

void	add_connection (const UnscopedConnection &c)

void	drop_connections ()

Public Member Functions inherited from PBD::Stateful
	Stateful ()

virtual	~Stateful ()

virtual bool	apply_change (PropertyBase const &)

PropertyChange	apply_changes (PropertyList const &)

const OwnedPropertyList &	properties () const

void	add_property (PropertyBase &s)

void	add_extra_xml (XMLNode &)

XMLNode *	extra_xml (const std::string &str, bool add_if_missing=false)

void	save_extra_xml (const XMLNode &)

const PBD::ID &	id () const

bool	set_id (const XMLNode &)

void	set_id (const std::string &)

void	reset_id ()

void	clear_changes ()

virtual void	clear_owned_changes ()

PropertyList *	get_changes_as_properties (PBD::Command *) const

virtual void	rdiff (std::vector< PBD::Command * > &) const

bool	changed () const

virtual PropertyList *	property_factory (const XMLNode &) const

virtual void	suspend_property_changes ()

virtual void	resume_property_changes ()

bool	property_changes_suspended () const

Public Member Functions inherited from PBD::Destructible
virtual	~Destructible ()

virtual void	drop_references ()

Public Member Functions inherited from ARDOUR::Automatable
	Automatable (Session &, Temporal::TimeDomainProvider const &)

	Automatable (const Automatable &other)

virtual	~Automatable ()

virtual void	automatables (PBD::ControllableSet &) const

std::shared_ptr< Evoral::Control >	control_factory (const Evoral::Parameter &id)

std::shared_ptr< AutomationControl >	automation_control (PBD::ID const &id) const

virtual std::shared_ptr< AutomationControl >	automation_control_recurse (PBD::ID const &id) const

std::shared_ptr< AutomationControl >	automation_control (const Evoral::Parameter &id)

std::shared_ptr< AutomationControl >	automation_control (const Evoral::Parameter &id, bool create_if_missing)

std::shared_ptr< const AutomationControl >	automation_control (const Evoral::Parameter &id) const

virtual void	add_control (std::shared_ptr< Evoral::Control >)

virtual bool	find_next_event (Temporal::timepos_t const &start, Temporal::timepos_t const &end, Evoral::ControlEvent &ev, bool only_active=true) const

void	clear_controls ()

virtual void	non_realtime_locate (samplepos_t now)

virtual void	non_realtime_transport_stop (samplepos_t now, bool flush)

virtual void	automation_run (samplepos_t, pframes_t, bool only_active=false)

virtual std::string	describe_parameter (Evoral::Parameter param)

AutoState	get_parameter_automation_state (Evoral::Parameter param)

virtual void	set_parameter_automation_state (Evoral::Parameter param, AutoState)

void	protect_automation ()

const std::set< Evoral::Parameter > &	what_can_be_automated () const

std::vector< Evoral::Parameter >	all_automatable_params () const

void	what_has_existing_automation (std::set< Evoral::Parameter > &) const

int	set_automation_xml_state (const XMLNode &, Evoral::Parameter default_param)

XMLNode &	get_automation_xml_state () const

void	start_domain_bounce (Temporal::DomainBounceInfo &)

void	finish_domain_bounce (Temporal::DomainBounceInfo &)

Public Member Functions inherited from Evoral::ControlSet
	ControlSet ()

	ControlSet (const ControlSet &)

virtual	~ControlSet ()

std::shared_ptr< Control >	control (const Parameter &id, bool create_if_missing=false)

std::shared_ptr< const Control >	control (const Parameter &id) const

Controls &	controls ()

const Controls &	controls () const

virtual bool	controls_empty () const

void	what_has_data (std::set< Parameter > &) const

Glib::Threads::Mutex &	control_lock () const

void	start_domain_bounce (Temporal::DomainBounceInfo &)

void	finish_domain_bounce (Temporal::DomainBounceInfo &)

Public Member Functions inherited from Temporal::TimeDomainSwapper
virtual	~TimeDomainSwapper ()

Public Member Functions inherited from ARDOUR::Slavable
	Slavable ()

virtual	~Slavable ()

XMLNode &	get_state () const

int	set_state (XMLNode const &, int)

virtual void	assign (std::shared_ptr< VCA >)

void	unassign (std::shared_ptr< VCA >)

std::vector< std::shared_ptr< VCA > >	masters (VCAManager *) const

bool	assigned_to (VCAManager *, std::shared_ptr< VCA >) const

Public Member Functions inherited from Temporal::TimeDomainProvider
	TimeDomainProvider ()

	TimeDomainProvider (TimeDomain td)

	TimeDomainProvider (TimeDomain td, TimeDomainProvider const &p)

	TimeDomainProvider (TimeDomainProvider const &other)

	TimeDomainProvider (TimeDomainProvider const &parnt, bool)

virtual	~TimeDomainProvider ()

XMLNode &	get_state () const

int	set_state (const XMLNode &, int version)

TimeDomainProvider &	operator= (TimeDomainProvider const &other)

TimeDomain	time_domain () const

bool	has_own_time_domain () const

void	clear_time_domain ()

void	set_time_domain (TimeDomain td)

TimeDomainProvider const *	time_domain_parent () const

bool	has_time_domain_parent () const

void	clear_time_domain_parent ()

void	set_time_domain_parent (TimeDomainProvider const &p)

virtual void	time_domain_changed ()

Public Member Functions inherited from ARDOUR::Latent
	Latent ()

	Latent (Latent const &)

virtual	~Latent ()

samplecnt_t	effective_latency () const

samplecnt_t	user_latency () const

void	unset_user_latency ()

virtual void	set_user_latency (samplecnt_t val)

Public Member Functions inherited from ARDOUR::HasLatency
virtual	~HasLatency ()

Static Public Member Functions
static uint32_t	how_many_returns ()

static std::string	name_and_id_new_return (Session &, uint32_t &)

Static Public Member Functions inherited from ARDOUR::IOProcessor
static void	prepare_for_reset (XMLNode &state, const std::string &name)

Static Public Member Functions inherited from ARDOUR::SessionObject
static void	make_property_quarks ()

Static Public Member Functions inherited from ARDOUR::Automatable
static void	find_next_ac_event (std::shared_ptr< AutomationControl >, Temporal::timepos_t const &start, Temporal::timepos_t const &end, Evoral::ControlEvent &ev)

static void	find_prev_ac_event (std::shared_ptr< AutomationControl >, Temporal::timepos_t const &start, Temporal::timepos_t const &end, Evoral::ControlEvent &ev)

Static Public Member Functions inherited from ARDOUR::Latent
static void	force_zero_latency (bool en)

static bool	zero_latency ()

Protected Member Functions
XMLNode &	state () const

Protected Member Functions inherited from ARDOUR::IOProcessor
std::string	validate_name (std::string const &new_name, std::string const &canonical_name) const

Protected Member Functions inherited from ARDOUR::Processor
bool	check_active ()

bool	map_loop_range (samplepos_t &start, samplepos_t &end) const

Protected Member Functions inherited from ARDOUR::SessionHandleRef
virtual void	session_going_away ()

virtual void	insanity_check ()

Protected Member Functions inherited from PBD::Stateful
void	add_instant_xml (XMLNode &, const std::string &directory_path)

XMLNode *	instant_xml (const std::string &str, const std::string &directory_path)

void	add_properties (XMLNode &) const

PropertyChange	set_values (XMLNode const &)

virtual void	post_set (const PropertyChange &)

virtual void	send_change (const PropertyChange &)

virtual void	mid_thaw (const PropertyChange &)

bool	regenerate_xml_or_string_ids () const

Protected Member Functions inherited from ARDOUR::Automatable
void	can_automate (Evoral::Parameter)

virtual void	automation_list_automation_state_changed (Evoral::Parameter const &, AutoState)

int	load_automation (const std::string &path)

int	old_set_automation_state (const XMLNode &)

SlavableAutomationControlList	slavables () const

Protected Member Functions inherited from Evoral::ControlSet
virtual void	control_list_marked_dirty ()

virtual void	control_list_interpolation_changed (Parameter const &, ControlList::InterpolationStyle)

Protected Member Functions inherited from Temporal::TimeDomainProvider
void	listen ()

Protected Member Functions inherited from ARDOUR::Latent
int	set_state (const XMLNode &node, int version)

void	add_state (XMLNode *) const

Protected Attributes
bool	_metering

std::shared_ptr< GainControl >	_gain_control

std::shared_ptr< Amp >	_amp

std::shared_ptr< PeakMeter >	_meter

Protected Attributes inherited from ARDOUR::IOProcessor
std::shared_ptr< IO >	_input

std::shared_ptr< IO >	_output

uint32_t	_bitslot

Protected Attributes inherited from ARDOUR::Processor
int	_pending_active

bool	_active

bool	_next_ab_is_active

bool	_configured

ChanCount	_configured_input

ChanCount	_configured_output

bool	_display_to_user

bool	_pre_fader
	true if this processor is currently placed before the Amp, otherwise false More...

void *	_ui_pointer

ProcessorWindowProxy *	_window_proxy

PluginPinWindowProxy *	_pinmgr_proxy

SessionObject *	_owner

samplecnt_t	_input_latency

samplecnt_t	_output_latency

samplecnt_t	_capture_offset

samplecnt_t	_playback_offset

Location *	_loop_location

Protected Attributes inherited from ARDOUR::SessionObject
PBD::Property< std::string >	_name

Protected Attributes inherited from ARDOUR::SessionHandleRef
ARDOUR::Session &	_session

Protected Attributes inherited from PBD::Stateful
XMLNode *	_extra_xml

XMLNode *	_instant_xml

PBD::PropertyChange	_pending_changed

Glib::Threads::Mutex	_lock

std::string	_xml_node_name
	name of node to use for this object in XML More...

OwnedPropertyList *	_properties

Protected Attributes inherited from ARDOUR::Automatable
Session &	_a_session

SerializedRCUManager< AutomationControlList >	_automated_controls

std::set< Evoral::Parameter >	_can_automate_list

samplepos_t	_last_automation_snapshot

Protected Attributes inherited from Evoral::ControlSet
Glib::Threads::Mutex	_control_lock

Controls	_controls

PBD::ScopedConnectionList	_list_connections

Private Member Functions
	Return (const Return &)

void	collect_input (BufferSet &bufs, pframes_t nframes, ChanCount offset=ChanCount::ZERO)

Additional Inherited Members
Public Types inherited from Evoral::ControlSet
typedef std::map< Parameter, std::shared_ptr< Control > >	Controls

Public Attributes inherited from ARDOUR::IOProcessor
PBD::Signal< void(IOProcessor *, bool)>	AutomationPlaybackChanged

PBD::Signal< void(IOProcessor *, uint32_t)>	AutomationChanged

Public Attributes inherited from ARDOUR::Processor
PBD::Signal< void()>	ActiveChanged

PBD::Signal< void()>	BypassableChanged

PBD::Signal< void(ChanCount, ChanCount)>	ConfigurationChanged

PBD::Signal< void()>	ToggleUI

PBD::Signal< void()>	ShowUI

PBD::Signal< void()>	HideUI

Public Attributes inherited from PBD::Stateful
PBD::Signal< void(const PropertyChange &)>	PropertyChanged

Public Attributes inherited from PBD::Destructible
PBD::Signal< void()>	Destroyed

PBD::Signal< void()>	DropReferences

Public Attributes inherited from ARDOUR::Automatable
PBD::Signal< void()>	AutomationStateChanged

Public Attributes inherited from ARDOUR::Slavable
PBD::Signal< void(std::shared_ptr< VCA >, bool)>	AssignmentChange

Public Attributes inherited from Temporal::TimeDomainProvider
PBD::Signal< void()>	TimeDomainChanged

Public Attributes inherited from ARDOUR::Latent
PBD::Signal< void()>	LatencyChanged

Static Public Attributes inherited from ARDOUR::Processor
static const std::string	state_node_name

Static Public Attributes inherited from PBD::Stateful
static int	current_state_version

static int	loading_state_version

Static Public Attributes inherited from ARDOUR::Automatable
static bool	skip_saving_automation

static const std::string	xml_node_name

Static Public Attributes inherited from ARDOUR::Slavable
static std::string	xml_node_name

static PBD::Signal< void(VCAManager *)>	Assign

Static Public Attributes inherited from ARDOUR::Latent
static PBD::Signal< void()>	DisableSwitchChanged

Detailed Description

Definition at line 37 of file return.h.

Constructor & Destructor Documentation

◆ Return() [1/2]

ARDOUR::Return::Return	(	Session &	,
		bool	internal = `false`
	)

◆ ~Return()

virtual ARDOUR::Return::~Return ( )

virtual

◆ Return() [2/2]

ARDOUR::Return::Return ( const Return & )

private

Member Function Documentation

◆ amp()

std::shared_ptr<Amp> ARDOUR::Return::amp ( ) const

inline

Definition at line 45 of file return.h.

◆ can_support_io_configuration()

bool ARDOUR::Return::can_support_io_configuration	(	const ChanCount &	in,
		ChanCount &	out
	)

virtual

Implements ARDOUR::Processor.

◆ collect_input()

void ARDOUR::Return::collect_input	(	BufferSet &	bufs,
		pframes_t	nframes,
		ChanCount	offset = `ChanCount::ZERO`
	)

private

◆ configure_io()

bool ARDOUR::Return::configure_io	(	ChanCount	in,
		ChanCount	out
	)

virtual

Reimplemented from ARDOUR::Processor.

◆ gain_control()

std::shared_ptr<GainControl> ARDOUR::Return::gain_control ( ) const

inline

Definition at line 47 of file return.h.

◆ how_many_returns()

static uint32_t ARDOUR::Return::how_many_returns ( )

static

◆ meter()

std::shared_ptr<PeakMeter> ARDOUR::Return::meter ( ) const

inline

Definition at line 46 of file return.h.

◆ metering()

bool ARDOUR::Return::metering ( ) const

inline

Definition at line 49 of file return.h.

◆ name_and_id_new_return()

static std::string ARDOUR::Return::name_and_id_new_return	(	Session &	,
		uint32_t &
	)

static

◆ pans_required()

uint32_t ARDOUR::Return::pans_required ( ) const

inline

Definition at line 54 of file return.h.

◆ run()

void ARDOUR::Return::run	(	BufferSet &	bufs,
		samplepos_t	start_sample,
		samplepos_t	end_sample,
		double	speed,
		pframes_t	nframes,
		bool	result_required
	)

virtual

The main process function for processors

Parameters

bufs	bufferset of data to process in-place
start_sample	absolute timeline position in audio-samples to commence processing (latency compensated)
end_sample	absolute timeline position in audio-samples, usually start_sample +/- `nframes`
speed	transport speed. usually -1, 0, +1
nframes	number of audio samples to process
result_required	true if, on return from this method, `bufs` is required to contain valid data; if false, the method need not bother writing to bufs if it doesn't want to.

Reimplemented from ARDOUR::Processor.

◆ set_metering()

void ARDOUR::Return::set_metering ( bool yn )

inline

Definition at line 50 of file return.h.

◆ set_state()

int ARDOUR::Return::set_state	(	const XMLNode &	,
		int	version
	)

virtual

Reimplemented from ARDOUR::IOProcessor.

◆ state()

XMLNode& ARDOUR::Return::state ( ) const

protectedvirtual

Reimplemented from ARDOUR::IOProcessor.

Member Data Documentation

◆ _amp

std::shared_ptr<Amp> ARDOUR::Return::_amp

protected

Definition at line 67 of file return.h.

◆ _gain_control

std::shared_ptr<GainControl> ARDOUR::Return::_gain_control

protected

Definition at line 66 of file return.h.

◆ _meter

std::shared_ptr<PeakMeter> ARDOUR::Return::_meter

protected

Definition at line 68 of file return.h.

◆ _metering

bool ARDOUR::Return::_metering

protected

Definition at line 65 of file return.h.

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

return.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Return() [1/2]

◆ ~Return()

◆ Return() [2/2]

Member Function Documentation

◆ amp()

◆ can_support_io_configuration()

◆ collect_input()

◆ configure_io()

◆ gain_control()

◆ how_many_returns()

◆ meter()

◆ metering()

◆ name_and_id_new_return()

◆ pans_required()

◆ run()

◆ set_metering()

◆ set_state()

◆ state()

Member Data Documentation

◆ _amp

◆ _gain_control

◆ _meter

◆ _metering