ardour
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | Private Attributes | List of all members
ARDOUR::IOProcessor Class Reference

#include <io_processor.h>

Inheritance diagram for ARDOUR::IOProcessor:
ARDOUR::Processor ARDOUR::SessionObject ARDOUR::Automatable ARDOUR::Latent ARDOUR::SessionHandleRef PBD::StatefulDestructible Evoral::ControlSet PBD::ScopedConnectionList PBD::Stateful PBD::Destructible ARDOUR::Delivery ARDOUR::PortInsert ARDOUR::Return ARDOUR::Send ARDOUR::InternalReturn ARDOUR::InternalSend

Public Member Functions

 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< IOinput ()
 
boost::shared_ptr< const IOinput () const
 
boost::shared_ptr< IOoutput ()
 
boost::shared_ptr< const IOoutput () 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
 
XMLNodestate (bool full_state)
 
int set_state (const XMLNode &, int version)
 
- 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 run (BufferSet &, framepos_t, framepos_t, pframes_t, bool)
 
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 ()
 
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
 
- 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)
 

Static Public Member Functions

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

Public Attributes

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
 

Protected Attributes

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

 IOProcessor (const IOProcessor &)
 
virtual int set_state_2X (const XMLNode &, int)
 

Private Attributes

bool _own_input
 
bool _own_output
 

Additional Inherited Members

- Public Types inherited from Evoral::ControlSet
typedef std::map< Parameter,
boost::shared_ptr< Control > > 
Controls
 
- 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)
 
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)
 

Detailed Description

A mixer strip element (Processor) with 1 or 2 IO elements.

Definition at line 43 of file io_processor.h.

Constructor & Destructor Documentation

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

Definition at line 86 of file io_processor.cc.

ARDOUR::IOProcessor::IOProcessor ( const IOProcessor )
private

Member Function Documentation

void IOProcessor::disconnect ( )

Definition at line 293 of file io_processor.cc.

bool ARDOUR::IOProcessor::does_routing ( ) const
inlinevirtual

Reimplemented from ARDOUR::Processor.

Definition at line 55 of file io_processor.h.

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

Reimplemented in ARDOUR::InternalSend.

Definition at line 287 of file io_processor.cc.

void IOProcessor::increment_port_buffer_offset ( pframes_t  offset)

Definition at line 251 of file io_processor.cc.

boost::shared_ptr<IO> ARDOUR::IOProcessor::input ( )
inline

Definition at line 60 of file io_processor.h.

boost::shared_ptr<const IO> ARDOUR::IOProcessor::input ( ) const
inline

Definition at line 61 of file io_processor.h.

ChanCount IOProcessor::natural_input_streams ( ) const
virtual

Definition at line 265 of file io_processor.cc.

ChanCount IOProcessor::natural_output_streams ( ) const
virtual

Definition at line 259 of file io_processor.cc.

boost::shared_ptr<IO> ARDOUR::IOProcessor::output ( )
inline

Definition at line 62 of file io_processor.h.

boost::shared_ptr<const IO> ARDOUR::IOProcessor::output ( ) const
inline

Definition at line 63 of file io_processor.h.

void IOProcessor::prepare_for_reset ( XMLNode state,
const std::string &  name 
)
static

Set up the XML description of a send so that we will not reset its name or bitslot during ::set_state()

Parameters
stateXML send state.
sessionSession.

Definition at line 310 of file io_processor.cc.

void IOProcessor::set_input ( boost::shared_ptr< IO io)

Definition at line 91 of file io_processor.cc.

bool IOProcessor::set_name ( const std::string &  str)
virtual

Reimplemented from ARDOUR::SessionObject.

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

Definition at line 271 of file io_processor.cc.

void IOProcessor::set_output ( boost::shared_ptr< IO io)

Definition at line 100 of file io_processor.cc.

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

Implements PBD::Stateful.

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

Definition at line 144 of file io_processor.cc.

int IOProcessor::set_state_2X ( const XMLNode node,
int  version 
)
privatevirtual

Reimplemented from ARDOUR::Processor.

Reimplemented in ARDOUR::Send.

Definition at line 233 of file io_processor.cc.

void IOProcessor::silence ( framecnt_t  nframes)
virtual

Reimplemented from ARDOUR::Processor.

Definition at line 243 of file io_processor.cc.

XMLNode & IOProcessor::state ( bool  full_state)
virtual

Reimplemented from ARDOUR::Processor.

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

Definition at line 109 of file io_processor.cc.

Member Data Documentation

boost::shared_ptr<IO> ARDOUR::IOProcessor::_input
protected

Definition at line 83 of file io_processor.h.

boost::shared_ptr<IO> ARDOUR::IOProcessor::_output
protected

Definition at line 84 of file io_processor.h.

bool ARDOUR::IOProcessor::_own_input
private

Definition at line 92 of file io_processor.h.

bool ARDOUR::IOProcessor::_own_output
private

Definition at line 93 of file io_processor.h.

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

Definition at line 75 of file io_processor.h.

PBD::Signal2<void,IOProcessor*,bool> ARDOUR::IOProcessor::AutomationPlaybackChanged

Definition at line 74 of file io_processor.h.


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