#include <return.h>

Inheritance diagram for ARDOUR::Return:

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

virtual	~Return ()

uint32_t	bit_slot () const

void	run (BufferSet &bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool)

boost::shared_ptr< Amp >	amp () const

boost::shared_ptr< PeakMeter >	meter () const

bool	metering () const

void	set_metering (bool yn)

XMLNode &	state (bool full)

XMLNode &	get_state (void)

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 &, boost::shared_ptr< IO > input, boost::shared_ptr< IO > output, const std::string &proc_name, ARDOUR::DataType default_type=DataType::AUDIO)

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

boost::shared_ptr< IO >	input ()

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

boost::shared_ptr< IO >	output ()

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

void	set_input (boost::shared_ptr< IO >)

void	set_output (boost::shared_ptr< IO >)

void	silence (framecnt_t nframes)

void	disconnect ()

void	increment_port_buffer_offset (pframes_t)

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

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

	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

bool	get_next_ab_is_active () const

void	set_next_ab_is_active (bool yn)

virtual framecnt_t	signal_latency () 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 ChanCount	input_streams () const

virtual ChanCount	output_streams () const

virtual void	realtime_handle_transport_stopped ()

virtual void	realtime_locate ()

virtual void	monitoring_changed ()

void	set_pre_fader (bool)

void	set_ui (void *)

void *	get_ui () const

ProcessorWindowProxy *	window_proxy () const

void	set_window_proxy (ProcessorWindowProxy *wp)

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 ()

virtual	~ScopedConnectionList ()

void	add_connection (const UnscopedConnection &c)

void	drop_connections ()

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

virtual	~Stateful ()

virtual bool	apply_changes (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 (Command *) const

virtual void	rdiff (std::vector< 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
	Destructible ()

virtual	~Destructible ()

void	drop_references ()

Public Member Functions inherited from ARDOUR::Automatable
	Automatable (Session &)

	Automatable (const Automatable &other)

virtual	~Automatable ()

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

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

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

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

void	clear_controls ()

virtual void	transport_located (framepos_t now)

virtual void	transport_stopped (framepos_t now)

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

virtual std::string	value_as_string (boost::shared_ptr< AutomationControl >) const

AutoState	get_parameter_automation_state (Evoral::Parameter param)

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

AutoStyle	get_parameter_automation_style (Evoral::Parameter param)

void	set_parameter_automation_style (Evoral::Parameter param, AutoStyle)

void	protect_automation ()

const std::set < Evoral::Parameter > &	what_can_be_automated () 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 ()

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

	ControlSet (const ControlSet &)

virtual	~ControlSet ()

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

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

Controls &	controls ()

const Controls &	controls () const

bool	find_next_event (double start, double end, ControlEvent &ev) const

virtual bool	controls_empty () const

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

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

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

virtual	~Latent ()

framecnt_t	user_latency () const

framecnt_t	effective_latency () const

virtual void	set_user_latency (framecnt_t val)

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 ()

Protected Attributes
bool	_metering

boost::shared_ptr< Amp >	_amp

boost::shared_ptr< PeakMeter >	_meter

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

boost::shared_ptr< IO >	_output

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

SessionObject *	_owner

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

std::set< Evoral::Parameter >	_can_automate_list

framepos_t	_last_automation_snapshot

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

Controls	_controls

PBD::ScopedConnectionList	_list_connections

Protected Attributes inherited from ARDOUR::Latent
framecnt_t	_user_latency

Private Member Functions
	Return (const Return &)

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

Private Attributes
uint32_t	_bitslot

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

Public Attributes inherited from ARDOUR::IOProcessor
PBD::Signal2< void, IOProcessor *, bool >	AutomationPlaybackChanged

PBD::Signal2< void, IOProcessor *, uint32_t >	AutomationChanged

Public Attributes inherited from ARDOUR::Processor
PBD::Signal0< void >	ActiveChanged

PBD::Signal2< void, ChanCount, ChanCount >	ConfigurationChanged

Public Attributes inherited from PBD::Stateful
PBD::Signal1< void, const PropertyChange & >	PropertyChanged

Public Attributes inherited from PBD::Destructible
PBD::Signal0< void >	Destroyed

PBD::Signal0< void >	DropReferences

Public Attributes inherited from ARDOUR::Automatable
PBD::Signal0< void >	AutomationStateChanged

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

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

static int	loading_state_version = 0

Static Public Attributes inherited from ARDOUR::Automatable
static const std::string	xml_node_name = X_("Automation")

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 &)

PropertyChange	set_values (XMLNode const &)

virtual void	post_set (const PropertyChange &)

virtual void	send_change (const PropertyChange &)

virtual void	mid_thaw (const PropertyChange &)

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

virtual void	automation_list_automation_state_changed (Evoral::Parameter, AutoState)

int	load_automation (const std::string &path)

int	old_set_automation_state (const XMLNode &)

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

virtual void	control_list_interpolation_changed (Parameter, ControlList::InterpolationStyle)

Detailed Description

Definition at line 37 of file return.h.

Constructor & Destructor Documentation

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

Definition at line 45 of file return.cc.

Return::~Return ( )

virtual

Definition at line 56 of file return.cc.

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

private

Member Function Documentation

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

inline

Definition at line 47 of file return.h.

uint32_t ARDOUR::Return::bit_slot ( ) const

inline

Definition at line 43 of file return.h.

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

virtual

Implements ARDOUR::Processor.

Definition at line 139 of file return.cc.

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

private

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

virtual

Precondition: Caller must hold process lock

Reimplemented from ARDOUR::Processor.

Definition at line 146 of file return.cc.

XMLNode & Return::get_state ( void )

virtual

Reimplemented from ARDOUR::Processor.

Definition at line 62 of file return.cc.

static uint32_t ARDOUR::Return::how_many_returns ( )

static

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

inline

Definition at line 48 of file return.h.

bool ARDOUR::Return::metering ( ) const

inline

Definition at line 50 of file return.h.

std::string Return::name_and_id_new_return	(	Session &	s,
		uint32_t &	bitslot
	)

static

Definition at line 38 of file return.cc.

uint32_t ARDOUR::Return::pans_required ( ) const

inline

Definition at line 57 of file return.h.

void Return::run	(	BufferSet &	,
		framepos_t	,
		framepos_t	,
		pframes_t	,
		bool
	)

virtual

Parameters

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.

Definition at line 113 of file return.cc.

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

inline

Definition at line 51 of file return.h.

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

virtual

Reimplemented from ARDOUR::IOProcessor.

Definition at line 80 of file return.cc.

XMLNode & Return::state ( bool full )

virtual

Reimplemented from ARDOUR::IOProcessor.

Definition at line 68 of file return.cc.

Member Data Documentation

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

protected

Definition at line 67 of file return.h.

uint32_t ARDOUR::Return::_bitslot

private

Definition at line 74 of file return.h.

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

protected

Definition at line 68 of file return.h.

bool ARDOUR::Return::_metering

protected

Definition at line 66 of file return.h.

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

/usr/local/music/src/ardour/4.0/libs/ardour/ardour/return.h
/usr/local/music/src/ardour/4.0/libs/ardour/return.cc

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation