#include <automation_control.h>

Inheritance diagram for ARDOUR::AutomationControl:

Public Member Functions
	AutomationControl (ARDOUR::Session &, const Evoral::Parameter &parameter, const ParameterDescriptor &desc, std::shared_ptr< ARDOUR::AutomationList > l=std::shared_ptr< ARDOUR::AutomationList >(), const std::string &name="", PBD::Controllable::Flag flags=PBD::Controllable::Flag(0))

virtual	~AutomationControl ()

std::shared_ptr< AutomationList >	alist () const

void	set_list (std::shared_ptr< Evoral::ControlList >)

bool	automation_playback () const

bool	automation_write () const

AutoState	automation_state () const

void	set_automation_state (AutoState as)

void	start_touch (timepos_t const &when)

void	stop_touch (timepos_t const &when)

virtual double	get_value () const

virtual double	get_save_value () const

void	set_value (double value, PBD::Controllable::GroupControlDisposition group_override)

virtual bool	writable () const

void	set_value_unchecked (double val)

virtual void	automation_run (samplepos_t start, pframes_t nframes)

double	lower () const

double	upper () const

double	normal () const

bool	toggled () const

double	internal_to_interface (double, bool rotary=false) const

double	interface_to_internal (double, bool rotary=false) const

virtual std::string	get_user_string () const

const ParameterDescriptor &	desc () const

const ARDOUR::Session &	session () const

void	commit_transaction (bool did_write)

AutomationControlList	grouped_controls () const

void	add_visually_linked_control (std::shared_ptr< AutomationControl > ctrl)

void	clear_visually_linked_control ()

WeakAutomationControlList	visually_linked_controls () const

Public Member Functions inherited from PBD::Controllable
	Controllable (const std::string &name, Flag f=Flag(0))

virtual float	get_interface (bool rotary=false) const

virtual void	set_interface (float fraction, bool rotary=false, GroupControlDisposition gcd=NoGroup)

int	set_state (const XMLNode &, int version)

virtual XMLNode &	get_state () const

std::string	name () const

bool	touching () const

bool	is_toggle () const

bool	is_gain_like () const

Flag	flags () const

void	set_flags (Flag f)

void	set_flag (Flag f)
	_flags \|= f; More...

void	clear_flag (Flag f)
	_flags &= ~f; More...

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 Evoral::Control
	Control (const Parameter &parameter, const ParameterDescriptor &desc, std::shared_ptr< ControlList > list)

virtual	~Control ()

virtual void	set_double (double val, Temporal::timepos_t const &when=Temporal::timepos_t(), bool to_list=false)

virtual double	get_double () const

void	set_list (std::shared_ptr< ControlList >)

std::shared_ptr< ControlList >	list ()

std::shared_ptr< const ControlList >	list () const

const Parameter &	parameter () const

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

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

Protected Member Functions
bool	check_rt (double val, Controllable::GroupControlDisposition gcd)

virtual void	actually_set_value (double value, PBD::Controllable::GroupControlDisposition)

void	pre_realtime_queue_stuff (double new_value, PBD::Controllable::GroupControlDisposition)

virtual void	do_pre_realtime_queue_stuff (double new_value)

void	session_going_away ()

Protected Member Functions inherited from PBD::Controllable
void	set_touching (bool yn)

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::SessionHandleRef
virtual void	insanity_check ()

Protected Attributes
std::shared_ptr< ControlGroup >	_group

std::shared_ptr< ControlGroup >	_pushed_group

const ParameterDescriptor	_desc

WeakAutomationControlList	_visually_linked_ctrls

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 Evoral::Control
Parameter	_parameter

std::shared_ptr< ControlList >	_list

double	_user_value

PBD::ScopedConnection	_list_marked_dirty_connection

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

Private Member Functions
void	set_group (std::shared_ptr< ControlGroup >)

bool	push_group (std::shared_ptr< ControlGroup >)

bool	pop_group ()

Private Attributes
PBD::ScopedConnection	_state_changed_connection

bool	_no_session

Friends
class	Session

class	ControlGroup

Additional Inherited Members
Public Types inherited from PBD::Controllable
enum	Flag { Toggle = 0x01 , GainLike = 0x02 , RealTime = 0x04 , NotAutomatable = 0x08 , InlineControl = 0x10 , HiddenControl = 0x20 , MonitorControl = 0x40 }

enum	GroupControlDisposition { InverseGroup , NoGroup , UseGroup , ForGroup }

Static Public Member Functions inherited from PBD::Controllable
static std::shared_ptr< Controllable >	by_id (const PBD::ID &)

static void	dump_registry ()

static ControllableSet	registered_controllables ()

Public Attributes inherited from PBD::Controllable
PBD::Signal0< void >	LearningFinished

PBD::Signal2< void, bool, PBD::Controllable::GroupControlDisposition >	Changed

PBD::Signal0< void >	TouchChanged

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 Evoral::Control
PBD::Signal0< void >	ListMarkedDirty

Static Public Attributes inherited from PBD::Controllable
static PBD::Signal1< bool, std::weak_ptr< PBD::Controllable > >	StartLearning

static PBD::Signal1< void, std::weak_ptr< PBD::Controllable > >	StopLearning

static PBD::Signal1< void, std::weak_ptr< PBD::Controllable > >	GUIFocusChanged

static PBD::Signal1< void, std::weak_ptr< PBD::Controllable > >	ControlTouched

static const std::string	xml_node_name

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

static int	loading_state_version

Detailed Description

A PBD::Controllable with associated automation data (AutomationList)

Definition at line 51 of file automation_control.h.

Constructor & Destructor Documentation

◆ AutomationControl()

ARDOUR::AutomationControl::AutomationControl	(	ARDOUR::Session &	,
		const Evoral::Parameter &	parameter,
		const ParameterDescriptor &	desc,
		std::shared_ptr< ARDOUR::AutomationList >	l = `std::shared_ptr< ARDOUR::AutomationList >()`,
		const std::string &	name = `""`,
		PBD::Controllable::Flag	flags = `PBD::Controllable::Flag(0)`
	)

◆ ~AutomationControl()

virtual ARDOUR::AutomationControl::~AutomationControl ( )

virtual

Member Function Documentation

◆ actually_set_value()

virtual void ARDOUR::AutomationControl::actually_set_value	(	double	value,
		PBD::Controllable::GroupControlDisposition
	)

protectedvirtual

Reimplemented in ARDOUR::SoloSafeControl, ARDOUR::SoloIsolateControl, ARDOUR::SoloControl, ARDOUR::PhaseControl, ARDOUR::PanControllable, ARDOUR::MuteControl, ARDOUR::MonitorControl, ARDOUR::SlavableAutomationControl, ARDOUR::PlugInsertBase::PluginPropertyControl, ARDOUR::GainControl, ARDOUR::PluginInsert::PIControl, ARDOUR::PlugInsertBase::PluginControl, and ARDOUR::MidiTrack::MidiControl.

◆ add_visually_linked_control()

void ARDOUR::AutomationControl::add_visually_linked_control ( std::shared_ptr< AutomationControl > ctrl )

inline

Definition at line 127 of file automation_control.h.

◆ alist()

std::shared_ptr<AutomationList> ARDOUR::AutomationControl::alist ( ) const

inline

Definition at line 68 of file automation_control.h.

◆ automation_playback()

bool ARDOUR::AutomationControl::automation_playback ( ) const

inline

Definition at line 74 of file automation_control.h.

◆ automation_run()

virtual void ARDOUR::AutomationControl::automation_run	(	samplepos_t	start,
		pframes_t	nframes
	)

virtual

Reimplemented in ARDOUR::SlavableAutomationControl, and ARDOUR::MuteControl.

◆ automation_state()

AutoState ARDOUR::AutomationControl::automation_state ( ) const

inline

Definition at line 82 of file automation_control.h.

◆ automation_write()

bool ARDOUR::AutomationControl::automation_write ( ) const

inline

Definition at line 78 of file automation_control.h.

◆ check_rt()

bool ARDOUR::AutomationControl::check_rt	(	double	val,
		Controllable::GroupControlDisposition	gcd
	)

protected

◆ clear_visually_linked_control()

void ARDOUR::AutomationControl::clear_visually_linked_control ( )

inline

Definition at line 131 of file automation_control.h.

◆ commit_transaction()

void ARDOUR::AutomationControl::commit_transaction ( bool did_write )

◆ desc()

const ParameterDescriptor& ARDOUR::AutomationControl::desc ( ) const

inline

Definition at line 120 of file automation_control.h.

◆ do_pre_realtime_queue_stuff()

virtual void ARDOUR::AutomationControl::do_pre_realtime_queue_stuff ( double new_value )

inlineprotectedvirtual

Reimplemented in ARDOUR::RecordEnableControl.

Definition at line 161 of file automation_control.h.

◆ get_save_value()

virtual double ARDOUR::AutomationControl::get_save_value ( ) const

virtual

This is used when saving state. By default it just calls get_value(), but a class with more complex semantics might override this to save some value that differs from what get_value() would return.

Reimplemented from PBD::Controllable.

Reimplemented in ARDOUR::SoloControl, and ARDOUR::MuteControl.

◆ get_user_string()

virtual std::string ARDOUR::AutomationControl::get_user_string ( ) const

virtual

Reimplemented from PBD::Controllable.

Reimplemented in ARDOUR::SurroundControllable, ARDOUR::PlugInsertBase::PluginControl, and ARDOUR::PanControllable.

◆ get_value()

virtual double ARDOUR::AutomationControl::get_value ( ) const

virtual

Get ‘internal’ value

Returns: raw value as used for the plugin/processor control port

Implements PBD::Controllable.

Reimplemented in ARDOUR::PlugInsertBase::PluginPropertyControl, ARDOUR::PlugInsertBase::PluginControl, ARDOUR::SoloSafeControl, ARDOUR::SoloIsolateControl, ARDOUR::SoloControl, ARDOUR::SlavableAutomationControl, and ARDOUR::MuteControl.

◆ grouped_controls()

AutomationControlList ARDOUR::AutomationControl::grouped_controls ( ) const

◆ interface_to_internal()

double ARDOUR::AutomationControl::interface_to_internal	(	double	,
		bool	rotary = `false`
	)		const

virtual

Reimplemented from PBD::Controllable.

◆ internal_to_interface()

double ARDOUR::AutomationControl::internal_to_interface	(	double	i,
		bool	rotary = `false`
	)		const

virtual

Conversions between ‘internal’, 'interface', and 'user' values

Reimplemented from PBD::Controllable.

◆ lower()

double ARDOUR::AutomationControl::lower ( ) const

inlinevirtual

Reimplemented from PBD::Controllable.

Definition at line 110 of file automation_control.h.

◆ normal()

double ARDOUR::AutomationControl::normal ( ) const

inlinevirtual

Reimplemented from PBD::Controllable.

Definition at line 112 of file automation_control.h.

◆ pop_group()

bool ARDOUR::AutomationControl::pop_group ( )

privatevirtual

Implements ARDOUR::ControlGroupMember.

◆ pre_realtime_queue_stuff()

void ARDOUR::AutomationControl::pre_realtime_queue_stuff	(	double	new_value,
		PBD::Controllable::GroupControlDisposition
	)

protected

◆ push_group()

bool ARDOUR::AutomationControl::push_group ( std::shared_ptr< ControlGroup > )

privatevirtual

Implements ARDOUR::ControlGroupMember.

◆ session()

const ARDOUR::Session& ARDOUR::AutomationControl::session ( ) const

inline

Definition at line 122 of file automation_control.h.

◆ session_going_away()

void ARDOUR::AutomationControl::session_going_away ( )

protectedvirtual

Reimplemented from ARDOUR::SessionHandleRef.

◆ set_automation_state()

void ARDOUR::AutomationControl::set_automation_state ( AutoState as )

◆ set_group()

void ARDOUR::AutomationControl::set_group ( std::shared_ptr< ControlGroup > )

privatevirtual

Implements ARDOUR::ControlGroupMember.

◆ set_list()

void ARDOUR::AutomationControl::set_list ( std::shared_ptr< Evoral::ControlList > )

◆ set_value()

void ARDOUR::AutomationControl::set_value	(	double	value,
		PBD::Controllable::GroupControlDisposition	group_override
	)

virtual

Set ‘internal’ value

All derived classes must implement this.

Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.

Parameters

value	raw numeric value to set
group_override	if and how to propagate value to grouped controls

Implements PBD::Controllable.

Reimplemented in ARDOUR::RecordEnableControl.

◆ set_value_unchecked()

void ARDOUR::AutomationControl::set_value_unchecked ( double val )

inline

Definition at line 104 of file automation_control.h.

◆ start_touch()

void ARDOUR::AutomationControl::start_touch ( timepos_t const & when )

◆ stop_touch()

void ARDOUR::AutomationControl::stop_touch ( timepos_t const & when )

◆ toggled()

bool ARDOUR::AutomationControl::toggled ( ) const

inline

Definition at line 113 of file automation_control.h.

◆ upper()

double ARDOUR::AutomationControl::upper ( ) const

inlinevirtual

Reimplemented from PBD::Controllable.

Definition at line 111 of file automation_control.h.

◆ visually_linked_controls()

WeakAutomationControlList ARDOUR::AutomationControl::visually_linked_controls ( ) const

inline

Definition at line 135 of file automation_control.h.

◆ writable()

virtual bool ARDOUR::AutomationControl::writable ( ) const

virtual

Reimplemented in ARDOUR::MidiTrack::MidiControl.

Friends And Related Function Documentation

◆ ControlGroup

friend class ControlGroup

friend

Definition at line 172 of file automation_control.h.

◆ Session

friend class Session

friend

Definition at line 157 of file automation_control.h.

Member Data Documentation

◆ _desc

const ParameterDescriptor ARDOUR::AutomationControl::_desc

protected

Definition at line 143 of file automation_control.h.

◆ _group

std::shared_ptr<ControlGroup> ARDOUR::AutomationControl::_group

protected

Definition at line 140 of file automation_control.h.

◆ _no_session

bool ARDOUR::AutomationControl::_no_session

private

Definition at line 177 of file automation_control.h.

◆ _pushed_group

std::shared_ptr<ControlGroup> ARDOUR::AutomationControl::_pushed_group

protected

Definition at line 141 of file automation_control.h.

◆ _state_changed_connection

PBD::ScopedConnection ARDOUR::AutomationControl::_state_changed_connection

private

Definition at line 176 of file automation_control.h.

◆ _visually_linked_ctrls

WeakAutomationControlList ARDOUR::AutomationControl::_visually_linked_ctrls

protected

Definition at line 165 of file automation_control.h.

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

automation_control.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AutomationControl()

◆ ~AutomationControl()

Member Function Documentation

◆ actually_set_value()

◆ add_visually_linked_control()

◆ alist()

◆ automation_playback()

◆ automation_run()

◆ automation_state()

◆ automation_write()

◆ check_rt()

◆ clear_visually_linked_control()

◆ commit_transaction()

◆ desc()

◆ do_pre_realtime_queue_stuff()

◆ get_save_value()

◆ get_user_string()

◆ get_value()

◆ grouped_controls()

◆ interface_to_internal()

◆ internal_to_interface()

◆ lower()

◆ normal()

◆ pop_group()

◆ pre_realtime_queue_stuff()

◆ push_group()

◆ session()

◆ session_going_away()

◆ set_automation_state()

◆ set_group()

◆ set_list()

◆ set_value()

◆ set_value_unchecked()

◆ start_touch()

◆ stop_touch()

◆ toggled()

◆ upper()

◆ visually_linked_controls()

◆ writable()

Friends And Related Function Documentation

◆ ControlGroup

◆ Session

Member Data Documentation

◆ _desc

◆ _group

◆ _no_session

◆ _pushed_group

◆ _state_changed_connection

◆ _visually_linked_ctrls