ardour
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
ARDOUR::Processor Class Referenceabstract

#include <processor.h>

Inheritance diagram for ARDOUR::Processor:
ARDOUR::SessionObject ARDOUR::Automatable ARDOUR::Latent ARDOUR::SessionHandleRef PBD::StatefulDestructible Evoral::ControlSet PBD::ScopedConnectionList PBD::Stateful PBD::Destructible ARDOUR::Amp ARDOUR::CapturingProcessor ARDOUR::DelayLine ARDOUR::IOProcessor ARDOUR::MonitorProcessor ARDOUR::PeakMeter ARDOUR::PluginInsert ARDOUR::UnknownProcessor

Public Member Functions

 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
 
virtual bool does_routing () 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 run (BufferSet &, framepos_t, framepos_t, pframes_t, bool)
 
virtual void silence (framecnt_t)
 
virtual void activate ()
 
virtual void deactivate ()
 
virtual void flush ()
 
virtual bool configure_io (ChanCount in, ChanCount out)
 
virtual bool can_support_io_configuration (const ChanCount &in, ChanCount &out)=0
 
virtual ChanCount input_streams () const
 
virtual ChanCount output_streams () const
 
virtual void realtime_handle_transport_stopped ()
 
virtual void realtime_locate ()
 
virtual void monitoring_changed ()
 
virtual XMLNodestate (bool full)
 
XMLNodeget_state (void)
 
int set_state (const XMLNode &, int version)
 
void set_pre_fader (bool)
 
void set_ui (void *)
 
void * get_ui () const
 
ProcessorWindowProxywindow_proxy () const
 
void set_window_proxy (ProcessorWindowProxy *wp)
 
void set_owner (SessionObject *)
 
SessionObjectowner () const
 
- Public Member Functions inherited from ARDOUR::SessionObject
 SessionObject (Session &session, const std::string &name)
 
Sessionsession () const
 
std::string name () const
 
virtual bool set_name (const std::string &str)
 
- 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 OwnedPropertyListproperties () const
 
void add_property (PropertyBase &s)
 
void add_extra_xml (XMLNode &)
 
XMLNodeextra_xml (const std::string &str, bool add_if_missing=false)
 
void save_extra_xml (const XMLNode &)
 
const PBD::IDid () const
 
bool set_id (const XMLNode &)
 
void set_id (const std::string &)
 
void reset_id ()
 
void clear_changes ()
 
virtual void clear_owned_changes ()
 
PropertyListget_changes_as_properties (Command *) const
 
virtual void rdiff (std::vector< Command * > &) const
 
bool changed () const
 
virtual PropertyListproperty_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)
 
XMLNodeget_automation_xml_state ()
 
- Public Member Functions inherited from Evoral::ControlSet
 ControlSet ()
 
 ControlSet (const ControlSet &)
 
virtual ~ControlSet ()
 
boost::shared_ptr< Controlcontrol (const Parameter &id, bool create_if_missing=false)
 
boost::shared_ptr< const Controlcontrol (const Parameter &id) const
 
Controlscontrols ()
 
const Controlscontrols () 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)
 

Public Attributes

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

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

virtual int set_state_2X (const XMLNode &, int version)
 
- 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)
 
XMLNodeinstant_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)
 

Protected Attributes

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
 

Additional Inherited Members

- Public Types inherited from Evoral::ControlSet
typedef std::map< Parameter,
boost::shared_ptr< Control > > 
Controls
 
- Static Public Member Functions inherited from ARDOUR::SessionObject
static void make_property_quarks ()
 

Detailed Description

A mixer strip element - plugin, send, meter, etc

Definition at line 46 of file processor.h.

Constructor & Destructor Documentation

ARDOUR::Processor::Processor ( Session ,
const std::string &  name 
)
Processor::Processor ( const Processor other)

Definition at line 71 of file processor.cc.

virtual ARDOUR::Processor::~Processor ( )
inlinevirtual

Definition at line 54 of file processor.h.

Member Function Documentation

virtual void ARDOUR::Processor::activate ( )
inlinevirtual

Reimplemented in ARDOUR::PeakMeter, ARDOUR::Send, ARDOUR::PortInsert, and ARDOUR::PluginInsert.

Definition at line 79 of file processor.h.

bool ARDOUR::Processor::active ( ) const
inline

Definition at line 61 of file processor.h.

virtual bool ARDOUR::Processor::can_support_io_configuration ( const ChanCount in,
ChanCount out 
)
pure virtual
bool Processor::configure_io ( ChanCount  in,
ChanCount  out 
)
virtual
virtual void ARDOUR::Processor::deactivate ( )
inlinevirtual

Reimplemented in ARDOUR::PeakMeter, ARDOUR::Send, ARDOUR::PortInsert, and ARDOUR::PluginInsert.

Definition at line 80 of file processor.h.

virtual std::string ARDOUR::Processor::display_name ( ) const
inlinevirtual

Reimplemented in ARDOUR::Delivery, ARDOUR::Amp, and ARDOUR::InternalSend.

Definition at line 56 of file processor.h.

virtual bool ARDOUR::Processor::display_to_user ( ) const
inlinevirtual
virtual bool ARDOUR::Processor::does_routing ( ) const
inlinevirtual

Reimplemented in ARDOUR::Delivery, and ARDOUR::IOProcessor.

Definition at line 63 of file processor.h.

virtual void ARDOUR::Processor::flush ( )
inlinevirtual

Reimplemented in ARDOUR::PluginInsert, and ARDOUR::DelayLine.

Definition at line 81 of file processor.h.

bool ARDOUR::Processor::get_next_ab_is_active ( ) const
inline

Definition at line 65 of file processor.h.

XMLNode & Processor::get_state ( void  )
virtual

Implements PBD::Stateful.

Reimplemented in ARDOUR::Return, and ARDOUR::Send.

Definition at line 89 of file processor.cc.

void* ARDOUR::Processor::get_ui ( ) const
inline

Definition at line 116 of file processor.h.

virtual ChanCount ARDOUR::Processor::input_streams ( ) const
inlinevirtual

Reimplemented in ARDOUR::PeakMeter, and ARDOUR::PluginInsert.

Definition at line 88 of file processor.h.

virtual void ARDOUR::Processor::monitoring_changed ( )
inlinevirtual

Reimplemented in ARDOUR::PluginInsert, and ARDOUR::DelayLine.

Definition at line 99 of file processor.h.

virtual ChanCount ARDOUR::Processor::output_streams ( ) const
inlinevirtual

Reimplemented in ARDOUR::PeakMeter, and ARDOUR::PluginInsert.

Definition at line 89 of file processor.h.

SessionObject * Processor::owner ( ) const

Definition at line 293 of file processor.cc.

virtual void ARDOUR::Processor::realtime_handle_transport_stopped ( )
inlinevirtual

Reimplemented in ARDOUR::PluginInsert, and ARDOUR::DelayLine.

Definition at line 91 of file processor.h.

virtual void ARDOUR::Processor::realtime_locate ( )
inlinevirtual

Reimplemented in ARDOUR::PluginInsert, ARDOUR::Delivery, and ARDOUR::DelayLine.

Definition at line 92 of file processor.h.

virtual bool ARDOUR::Processor::requires_fixed_sized_buffers ( ) const
inlinevirtual

Definition at line 71 of file processor.h.

virtual void ARDOUR::Processor::run ( BufferSet ,
framepos_t  ,
framepos_t  ,
pframes_t  ,
bool   
)
inlinevirtual
Parameters
result_requiredtrue 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 in ARDOUR::MonitorProcessor, ARDOUR::Delivery, ARDOUR::PeakMeter, ARDOUR::Send, ARDOUR::PluginInsert, ARDOUR::PortInsert, ARDOUR::Amp, ARDOUR::Return, ARDOUR::InternalSend, ARDOUR::DelayLine, ARDOUR::InternalReturn, and ARDOUR::CapturingProcessor.

Definition at line 76 of file processor.h.

virtual int ARDOUR::Processor::set_block_size ( pframes_t  )
inlinevirtual

Reimplemented in ARDOUR::PluginInsert, ARDOUR::InternalSend, and ARDOUR::CapturingProcessor.

Definition at line 70 of file processor.h.

void Processor::set_display_to_user ( bool  yn)
virtual

Definition at line 263 of file processor.cc.

void ARDOUR::Processor::set_next_ab_is_active ( bool  yn)
inline

Definition at line 66 of file processor.h.

void Processor::set_owner ( SessionObject o)

Definition at line 287 of file processor.cc.

void Processor::set_pre_fader ( bool  p)

Definition at line 269 of file processor.cc.

int Processor::set_state ( const XMLNode node,
int  version 
)
virtual

Implements PBD::Stateful.

Reimplemented in ARDOUR::Return, and ARDOUR::Send.

Definition at line 173 of file processor.cc.

int Processor::set_state_2X ( const XMLNode node,
int  version 
)
protectedvirtual

Reimplemented in ARDOUR::IOProcessor, and ARDOUR::Send.

Definition at line 137 of file processor.cc.

void Processor::set_ui ( void *  p)

Definition at line 275 of file processor.cc.

void Processor::set_window_proxy ( ProcessorWindowProxy wp)

Definition at line 281 of file processor.cc.

virtual framecnt_t ARDOUR::Processor::signal_latency ( ) const
inlinevirtual

Implements ARDOUR::Latent.

Reimplemented in ARDOUR::PluginInsert, and ARDOUR::PortInsert.

Definition at line 68 of file processor.h.

virtual void ARDOUR::Processor::silence ( framecnt_t  )
inlinevirtual

Reimplemented in ARDOUR::IOProcessor, and ARDOUR::PluginInsert.

Definition at line 77 of file processor.h.

XMLNode & Processor::state ( bool  full)
virtual
ProcessorWindowProxy* ARDOUR::Processor::window_proxy ( ) const
inline

Definition at line 118 of file processor.h.

Member Data Documentation

bool ARDOUR::Processor::_active
protected

Definition at line 128 of file processor.h.

bool ARDOUR::Processor::_configured
protected

Definition at line 130 of file processor.h.

ChanCount ARDOUR::Processor::_configured_input
protected

Definition at line 131 of file processor.h.

ChanCount ARDOUR::Processor::_configured_output
protected

Definition at line 132 of file processor.h.

bool ARDOUR::Processor::_display_to_user
protected

Definition at line 133 of file processor.h.

bool ARDOUR::Processor::_next_ab_is_active
protected

Definition at line 129 of file processor.h.

SessionObject* ARDOUR::Processor::_owner
protected

Definition at line 137 of file processor.h.

int ARDOUR::Processor::_pending_active
protected

Definition at line 127 of file processor.h.

bool ARDOUR::Processor::_pre_fader
protected

true if this processor is currently placed before the Amp, otherwise false

Definition at line 134 of file processor.h.

void* ARDOUR::Processor::_ui_pointer
protected

Definition at line 135 of file processor.h.

ProcessorWindowProxy* ARDOUR::Processor::_window_proxy
protected

Definition at line 136 of file processor.h.

PBD::Signal0<void> ARDOUR::Processor::ActiveChanged

Definition at line 112 of file processor.h.

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

Definition at line 113 of file processor.h.

const string Processor::state_node_name = "Processor"
static

Definition at line 49 of file processor.h.


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