/*
- Copyright (C) 2000 Paul Davis
+ Copyright (C) 2000 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#include <string>
#include <vector>
#include <cmath>
-#include <sigc++/signal.h>
#include <jack/jack.h>
#include <glibmm/thread.h>
-#include <pbd/fastlog.h>
-#include <pbd/undo.h>
-#include <pbd/statefuldestructible.h>
-#include <pbd/controllable.h>
-
-#include <ardour/ardour.h>
-#include <ardour/utils.h>
-#include <ardour/curve.h>
-#include <ardour/types.h>
-#include <ardour/data_type.h>
-#include <ardour/port_set.h>
-#include <ardour/chan_count.h>
-
-using std::string;
-using std::vector;
+#include "pbd/fastlog.h"
+#include "pbd/undo.h"
+#include "pbd/statefuldestructible.h"
+#include "pbd/controllable.h"
+
+#include "ardour/ardour.h"
+#include "ardour/automatable_controls.h"
+#include "ardour/automation_control.h"
+#include "ardour/bundle.h"
+#include "ardour/chan_count.h"
+#include "ardour/data_type.h"
+#include "ardour/latent.h"
+#include "ardour/port_set.h"
+#include "ardour/session_object.h"
+#include "ardour/types.h"
+#include "ardour/utils.h"
class XMLNode;
namespace ARDOUR {
-class Session;
+class Amp;
class AudioEngine;
-class Connection;
-class Panner;
-class PeakMeter;
-class Port;
class AudioPort;
-class MidiPort;
class BufferSet;
+class Bundle;
+class MidiPort;
+class PeakMeter;
+class Port;
+class Processor;
+class Session;
+class UserBundle;
-/** A collection of input and output ports with connections.
+/** A collection of ports (all input or all output) with connections.
*
* An IO can contain ports of varying types, making routes/inserts/etc with
* varied combinations of types (eg MIDI and audio) possible.
*/
-class IO : public PBD::StatefulDestructible
+class IO : public SessionObject, public Latent
{
-
public:
- static const string state_node_name;
+ static const std::string state_node_name;
- IO (Session&, string name,
- int input_min = -1, int input_max = -1,
- int output_min = -1, int output_max = -1,
- DataType default_type = DataType::AUDIO);
-
+ enum Direction {
+ Input,
+ Output
+ };
+
+ IO (Session&, const std::string& name, Direction, DataType default_type = DataType::AUDIO);
IO (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
-
+
virtual ~IO();
- ChanCount input_minimum() const { return _input_minimum; }
- ChanCount input_maximum() const { return _input_maximum; }
- ChanCount output_minimum() const { return _output_minimum; }
- ChanCount output_maximum() const { return _output_maximum; }
-
- void set_input_minimum (ChanCount n);
- void set_input_maximum (ChanCount n);
- void set_output_minimum (ChanCount n);
- void set_output_maximum (ChanCount n);
-
+ Direction direction() const { return _direction; }
+
DataType default_type() const { return _default_type; }
void set_default_type(DataType t) { _default_type = t; }
- const string& name() const { return _name; }
- virtual int set_name (string str, void *src);
-
- virtual void silence (nframes_t, nframes_t offset);
-
- void collect_input (BufferSet& bufs, nframes_t nframes, nframes_t offset);
- void deliver_output (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame,
- nframes_t nframes, nframes_t offset);
- void just_meter_input (nframes_t start_frame, nframes_t end_frame,
- nframes_t nframes, nframes_t offset);
-
- virtual void set_gain (gain_t g, void *src);
- void inc_gain (gain_t delta, void *src);
- gain_t gain () const { return _desired_gain; }
- virtual gain_t effective_gain () const;
-
- void set_phase_invert (bool yn, void *src);
- bool phase_invert() const { return _phase_invert; }
-
- Panner& panner() { return *_panner; }
- PeakMeter& peak_meter() { return *_meter; }
- const Panner& panner() const { return *_panner; }
-
- int ensure_io (ChanCount in, ChanCount out, bool clear, void *src);
-
- int use_input_connection (Connection&, void *src);
- int use_output_connection (Connection&, void *src);
-
- Connection *input_connection() const { return _input_connection; }
- Connection *output_connection() const { return _output_connection; }
+ bool active() const { return _active; }
+ void set_active(bool yn) { _active = yn; }
- int add_input_port (string source, void *src, DataType type = DataType::NIL);
- int add_output_port (string destination, void *src, DataType type = DataType::NIL);
+ bool set_name (const std::string& str);
- int remove_input_port (Port *, void *src);
- int remove_output_port (Port *, void *src);
+ virtual void silence (nframes_t);
- int set_input (Port *, void *src);
+ int ensure_io (ChanCount cnt, bool clear, void *src);
- int connect_input (Port *our_port, string other_port, void *src);
- int connect_output (Port *our_port, string other_port, void *src);
+ int connect_ports_to_bundle (boost::shared_ptr<Bundle>, void *);
+ int disconnect_ports_from_bundle (boost::shared_ptr<Bundle>, void *);
- int disconnect_input (Port *our_port, string other_port, void *src);
- int disconnect_output (Port *our_port, string other_port, void *src);
+ BundleList bundles_connected ();
- int disconnect_inputs (void *src);
- int disconnect_outputs (void *src);
+ boost::shared_ptr<Bundle> bundle () { return _bundle; }
- nframes_t output_latency() const;
- nframes_t input_latency() const;
- void set_port_latency (nframes_t);
+ int add_port (std::string connection, void *src, DataType type = DataType::NIL);
+ int remove_port (Port *, void *src);
+ int connect (Port *our_port, std::string other_port, void *src);
+ int disconnect (Port *our_port, std::string other_port, void *src);
+ int disconnect (void *src);
+ bool connected_to (boost::shared_ptr<const IO>) const;
+ bool connected () const;
+ bool physically_connected () const;
+
+ nframes_t signal_latency() const { return _own_latency; }
+ nframes_t latency() const;
+ void set_port_latency (nframes_t);
- const PortSet& inputs() const { return _inputs; }
- const PortSet& outputs() const { return _outputs; }
+ void update_port_total_latencies ();
- Port *output (uint32_t n) const {
- if (n < _outputs.num_ports()) {
- return _outputs.port(n);
- } else {
- return 0;
- }
- }
+ PortSet& ports() { return _ports; }
+ const PortSet& ports() const { return _ports; }
- Port *input (uint32_t n) const {
- if (n < _inputs.num_ports()) {
- return _inputs.port(n);
+ Port *nth (uint32_t n) const {
+ if (n < _ports.num_ports()) {
+ return _ports.port(n);
} else {
return 0;
}
}
- AudioPort* audio_input(uint32_t n) const;
- AudioPort* audio_output(uint32_t n) const;
- MidiPort* midi_input(uint32_t n) const;
- MidiPort* midi_output(uint32_t n) const;
-
- const ChanCount& n_inputs () const { return _inputs.count(); }
- const ChanCount& n_outputs () const { return _outputs.count(); }
+ Port* port_by_name (const std::string& str) const;
- void attach_buffers(ChanCount ignored);
+ AudioPort* audio(uint32_t n) const;
+ MidiPort* midi(uint32_t n) const;
- sigc::signal<void,IOChange,void*> input_changed;
- sigc::signal<void,IOChange,void*> output_changed;
+ const ChanCount& n_ports () const { return _ports.count(); }
- sigc::signal<void,void*> gain_changed;
- sigc::signal<void,void*> name_changed;
+ PBD::Signal2<void,IOChange,void*> changed;
virtual XMLNode& state (bool full);
XMLNode& get_state (void);
- int set_state (const XMLNode&);
+ int set_state (const XMLNode&, int version);
+ int set_state_2X (const XMLNode&, int, bool);
static int disable_connecting (void);
-
static int enable_connecting (void);
-
static int disable_ports (void);
-
static int enable_ports (void);
- static int disable_panners (void);
-
- static int reset_panners (void);
-
- static sigc::signal<int> PortsLegal;
- static sigc::signal<int> PannersLegal;
- static sigc::signal<int> ConnectingLegal;
- static sigc::signal<void,ChanCount> MoreChannels;
- static sigc::signal<int> PortsCreated;
-
- PBD::Controllable& gain_control() {
- return _gain_control;
- }
-
- static void update_meters();
-
- private:
-
- static sigc::signal<void> Meter;
- static Glib::StaticMutex m_meter_signal_lock;
- sigc::connection m_meter_connection;
-
- public:
-
- /* automation */
-
- static void set_automation_interval (nframes_t frames) {
- _automation_interval = frames;
- }
-
- static nframes_t automation_interval() {
- return _automation_interval;
- }
-
- void clear_automation ();
-
- bool gain_automation_recording() const {
- return (_gain_automation_curve.automation_state() & (Write|Touch));
- }
-
- bool gain_automation_playback() const {
- return (_gain_automation_curve.automation_state() & Play) ||
- ((_gain_automation_curve.automation_state() & Touch) &&
- !_gain_automation_curve.touching());
- }
-
- virtual void set_gain_automation_state (AutoState);
- AutoState gain_automation_state() const { return _gain_automation_curve.automation_state(); }
- sigc::signal<void> gain_automation_state_changed;
+ static PBD::Signal1<void,ChanCount> PortCountChanged; // emitted when the number of ports changes
- virtual void set_gain_automation_style (AutoStyle);
- AutoStyle gain_automation_style () const { return _gain_automation_curve.automation_style(); }
- sigc::signal<void> gain_automation_style_changed;
+ static std::string name_from_state (const XMLNode&);
+ static void set_name_in_state (XMLNode&, const std::string&);
- virtual void transport_stopped (nframes_t now);
- void automation_snapshot (nframes_t now);
+ /* we have to defer/order port connection. this is how we do it.
+ */
- ARDOUR::Curve& gain_automation_curve () { return _gain_automation_curve; }
+ static PBD::Signal0<int> ConnectingLegal;
+ static bool connecting_legal;
- void start_gain_touch ();
- void end_gain_touch ();
+ XMLNode *pending_state_node;
+ int pending_state_node_version;
+ bool pending_state_node_in;
- void start_pan_touch (uint32_t which);
- void end_pan_touch (uint32_t which);
+ /* three utility functions - this just seems to be simplest place to put them */
- void defer_pan_reset ();
- void allow_pan_reset ();
+ void collect_input (BufferSet& bufs, nframes_t nframes, ChanCount offset);
+ void process_input (boost::shared_ptr<Processor>, sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
+ void copy_to_outputs (BufferSet& bufs, DataType type, nframes_t nframes, nframes_t offset);
- /* the session calls this for master outs before
- anyone else. controls outs too, at some point.
- */
+ /* AudioTrack::deprecated_use_diskstream_connections() needs these */
- XMLNode *pending_state_node;
- int ports_became_legal ();
+ int set_ports (const std::string& str);
private:
mutable Glib::Mutex io_lock;
protected:
- Session& _session;
- Panner* _panner;
- BufferSet* _output_buffers; //< Set directly to output port buffers
- gain_t _gain;
- gain_t _effective_gain;
- gain_t _desired_gain;
- Glib::Mutex declick_lock;
- PortSet _outputs;
- PortSet _inputs;
- PeakMeter* _meter;
- string _name;
- Connection* _input_connection;
- Connection* _output_connection;
- bool no_panner_reset;
- bool _phase_invert;
- XMLNode* deferred_state;
- DataType _default_type;
-
- virtual void set_deferred_state() {}
-
- void reset_panner ();
-
- virtual uint32_t pans_required() const
- { return _inputs.count().n_audio(); }
-
- struct GainControllable : public PBD::Controllable {
- GainControllable (std::string name, IO& i) : Controllable (name), io (i) {}
-
- void set_value (float val);
- float get_value (void) const;
-
- IO& io;
- };
-
- GainControllable _gain_control;
-
- nframes_t last_automation_snapshot;
- static nframes_t _automation_interval;
-
- AutoState _gain_automation_state;
- AutoStyle _gain_automation_style;
-
- bool apply_gain_automation;
- Curve _gain_automation_curve;
-
- Glib::Mutex automation_lock;
-
- virtual int set_automation_state (const XMLNode&);
- virtual XMLNode& get_automation_state ();
- virtual int load_automation (std::string path);
-
- /* AudioTrack::deprecated_use_diskstream_connections() needs these */
-
- int set_inputs (const string& str);
- int set_outputs (const string& str);
-
- static bool connecting_legal;
- static bool ports_legal;
-
- BufferSet& output_buffers() { return *_output_buffers; }
+ PortSet _ports;
+ Direction _direction;
+ DataType _default_type;
+ bool _active;
private:
-
- /* are these the best variable names ever, or what? */
-
- sigc::connection input_connection_configuration_connection;
- sigc::connection output_connection_configuration_connection;
- sigc::connection input_connection_connection_connection;
- sigc::connection output_connection_connection_connection;
-
- static bool panners_legal;
-
int connecting_became_legal ();
- int panners_became_legal ();
- sigc::connection connection_legal_c;
- sigc::connection port_legal_c;
- sigc::connection panner_legal_c;
+ PBD::ScopedConnection connection_legal_c;
- ChanCount _input_minimum;
- ChanCount _input_maximum;
- ChanCount _output_minimum;
- ChanCount _output_maximum;
+ boost::shared_ptr<Bundle> _bundle; ///< a bundle representing our ports
+ struct UserBundleInfo {
+ UserBundleInfo (IO*, boost::shared_ptr<UserBundle> b);
+ boost::shared_ptr<UserBundle> bundle;
+ PBD::ScopedConnection changed;
+ };
+
+ std::vector<UserBundleInfo*> _bundles_connected; ///< user bundles connected to our ports
- static int parse_io_string (const string&, vector<string>& chns);
+ static int parse_io_string (const std::string&, std::vector<std::string>& chns);
+ static int parse_gain_string (const std::string&, std::vector<std::string>& chns);
- static int parse_gain_string (const string&, vector<string>& chns);
-
- int set_sources (vector<string>&, void *src, bool add);
- int set_destinations (vector<string>&, void *src, bool add);
+ int ensure_ports (ChanCount, bool clear, bool lockit, void *src);
- int ensure_inputs (ChanCount, bool clear, bool lockit, void *src);
- int ensure_outputs (ChanCount, bool clear, bool lockit, void *src);
+ void check_bundles_connected ();
+ void check_bundles (std::vector<UserBundleInfo*>&, const PortSet&);
- void drop_input_connection ();
- void drop_output_connection ();
+ void bundle_changed (Bundle::Change);
- void input_connection_configuration_changed ();
- void input_connection_connection_changed (int);
- void output_connection_configuration_changed ();
- void output_connection_connection_changed (int);
+ int get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c);
+ int get_port_counts_2X (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c);
+ int create_ports (const XMLNode&, int version);
+ int make_connections (const XMLNode&, int, bool);
+ int make_connections_2X (const XMLNode &, int, bool);
- int create_ports (const XMLNode&);
- int make_connections (const XMLNode&);
+ boost::shared_ptr<Bundle> find_possible_bundle (const std::string &desired_name);
- void setup_peak_meters ();
- void meter ();
+ bool ensure_ports_locked (ChanCount, bool clear, void *src);
- bool ensure_inputs_locked (ChanCount, bool clear, void *src);
- bool ensure_outputs_locked (ChanCount, bool clear, void *src);
+ std::string build_legal_port_name (DataType type);
+ int32_t find_port_hole (const char* base);
- int32_t find_input_port_hole ();
- int32_t find_output_port_hole ();
+ void setup_bundle ();
+ std::string bundle_channel_name (uint32_t, uint32_t) const;
};
} // namespace ARDOUR