save version string with session for informational purposes
[ardour.git] / libs / ardour / ardour / io.h
index 23e4f576df14554d8cc8229cafec1c1c0b9829f8..5511f64dd683b3becf62f58ac146134ab12135f4 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    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 <glibmm/threads.h>
 
 #include "pbd/fastlog.h"
 #include "pbd/undo.h"
-#include "pbd/statefuldestructible.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/latent.h"
 #include "ardour/port_set.h"
 #include "ardour/session_object.h"
+#include "ardour/libardour_visibility.h"
 #include "ardour/types.h"
 #include "ardour/utils.h"
+#include "ardour/buffer_set.h"
 
 class XMLNode;
 
@@ -52,318 +51,209 @@ namespace ARDOUR {
 class Amp;
 class AudioEngine;
 class AudioPort;
-class BufferSet;
 class Bundle;
 class MidiPort;
-class Panner;
 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 SessionObject, public AutomatableControls, public Latent
+class LIBARDOUR_API IO : public SessionObject, public Latent
 {
   public:
        static const std::string state_node_name;
 
-       IO (Session&, const std::string& name, DataType default_type = DataType::AUDIO);
-       IO (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
-       
-       virtual ~IO();
-
-       bool active() const { return _active; }
-       void set_active (bool yn);
-       
-       DataType default_type() const         { return _default_type; }
-       void     set_default_type(DataType t) { _default_type = t; }
-       
-       bool set_name (const std::string& str);
-
-       virtual void silence  (nframes_t);
-
-       void collect_input  (BufferSet& bufs, nframes_t nframes, ChanCount offset=ChanCount::ZERO);
-       void deliver_output (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
-       void just_meter_input (sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
-
-       BufferSet& output_buffers() { return *_output_buffers; }
-
-       gain_t         gain () const { return _gain_control->user_float(); }
-       virtual gain_t effective_gain () const;
-       
-       void set_denormal_protection (bool yn, void *src);
-       bool denormal_protection() const { return _denormal_protection; }
-       
-       void set_phase_invert (bool yn, void *src);
-       bool phase_invert() const { return _phase_invert; }
+       enum Direction {
+               Input,
+               Output
+       };
 
-       void reset_panner ();
-       
-       boost::shared_ptr<Amp> amp() const { return _amp; }
+       IO (Session&, const std::string& name, Direction, DataType default_type = DataType::AUDIO, bool sendish = false);
+       IO (Session&, const XMLNode&, DataType default_type = DataType::AUDIO, bool sendish = false);
 
-       PeakMeter&       peak_meter()       { return *_meter.get(); }
-       const PeakMeter& peak_meter() const { return *_meter.get(); }
-       boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
+       virtual ~IO();
 
-       boost::shared_ptr<Panner> panner() const { return _panner; }
-       
-       int ensure_io (ChanCount in, ChanCount out, bool clear, void *src);
+       Direction direction() const { return _direction; }
 
-       int connect_input_ports_to_bundle (boost::shared_ptr<Bundle>, void *);
-       int disconnect_input_ports_from_bundle (boost::shared_ptr<Bundle>, void *);
-       int connect_output_ports_to_bundle (boost::shared_ptr<Bundle>, void *);
-       int disconnect_output_ports_from_bundle (boost::shared_ptr<Bundle>, void *);
+       DataType default_type() const         { return _default_type; }
+       void     set_default_type(DataType t) { _default_type = t; }
 
-       BundleList bundles_connected_to_inputs ();
-       BundleList bundles_connected_to_outputs ();
+       bool active() const { return _active; }
+       void set_active(bool yn) { _active = yn; }
 
-       boost::shared_ptr<Bundle> bundle_for_inputs () { return _bundle_for_inputs; }
-       boost::shared_ptr<Bundle> bundle_for_outputs () { return _bundle_for_outputs; }
-       
-       int add_input_port (std::string source, void *src, DataType type = DataType::NIL);
-       int add_output_port (std::string destination, void *src, DataType type = DataType::NIL);
+       bool set_name (const std::string& str);
+       void set_pretty_name (const std::string& str);
+       std::string pretty_name () const { return _pretty_name_prefix; }
 
-       int remove_input_port (Port *, void *src);
-       int remove_output_port (Port *, void *src);
+       virtual void silence (framecnt_t);
+       void increment_port_buffer_offset (pframes_t offset);
 
-       int set_input (Port *, void *src);
+       int ensure_io (ChanCount cnt, bool clear, void *src);
 
-       int connect_input (Port *our_port, std::string other_port, void *src);
-       int connect_output (Port *our_port, std::string other_port, void *src);
+       int connect_ports_to_bundle (boost::shared_ptr<Bundle>, bool exclusive, void *);
+       int disconnect_ports_from_bundle (boost::shared_ptr<Bundle>, void *);
 
-       int disconnect_input (Port *our_port, std::string other_port, void *src);
-       int disconnect_output (Port *our_port, std::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; }
 
+       int add_port (std::string connection, void *src, DataType type = DataType::NIL);
+       int remove_port (boost::shared_ptr<Port>, void *src);
+       int connect (boost::shared_ptr<Port> our_port, std::string other_port, void *src);
+       int disconnect (boost::shared_ptr<Port> our_port, std::string other_port, void *src);
+       int disconnect (void *src);
        bool connected_to (boost::shared_ptr<const IO>) const;
+       bool connected_to (const std::string&) const;
+       bool connected () const;
+       bool physically_connected () const;
 
-       nframes_t signal_latency() const { return _own_latency; }
-       nframes_t output_latency() const;
-       nframes_t input_latency() const;
-       void      set_port_latency (nframes_t);
-
-       void update_port_total_latencies ();
+       framecnt_t signal_latency () const { return 0; }
+       framecnt_t latency () const;
 
-       const PortSet& inputs()  const { return _inputs; }
-       const PortSet& outputs() const { return _outputs; }
+       PortSet& ports() { return _ports; }
+       const PortSet& ports() const { return _ports; }
 
-       Port *output (uint32_t n) const {
-               if (n < _outputs.num_ports()) {
-                       return _outputs.port(n);
-               } else {
-                       return 0;
-               }
-       }
+       bool has_port (boost::shared_ptr<Port>) const;
 
-       Port *input (uint32_t n) const {
-               if (n < _inputs.num_ports()) {
-                       return _inputs.port(n);
+       boost::shared_ptr<Port> nth (uint32_t n) const {
+               if (n < _ports.num_ports()) {
+                       return _ports.port(n);
                } else {
-                       return 0;
+                       return boost::shared_ptr<Port> ();
                }
        }
 
-       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;
+       boost::shared_ptr<Port> port_by_name (const std::string& str) const;
 
-       const ChanCount& n_inputs ()  const { return _inputs.count(); }
-       const ChanCount& n_outputs () const { return _outputs.count(); }
+       boost::shared_ptr<AudioPort> audio(uint32_t n) const;
+       boost::shared_ptr<MidiPort>  midi(uint32_t n) const;
 
-       void attach_buffers(ChanCount ignored);
-       
-       sigc::signal<void>                active_changed;
+       const ChanCount& n_ports ()  const { return _ports.count(); }
 
-       sigc::signal<void,IOChange,void*> input_changed;
-       sigc::signal<void,IOChange,void*> output_changed;
+       /* The process lock will be held on emission of this signal if
+        * IOChange contains ConfigurationChanged.  In other cases,
+        * the process lock status is undefined.
+        */
+       PBD::Signal2<void, IOChange, void *> changed;
 
        virtual XMLNode& state (bool full);
        XMLNode& get_state (void);
-       int set_state (const XMLNode&);
-
-       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;
-       /// raised when the number of input or output ports changes
-       static sigc::signal<void,ChanCount> PortCountChanged;
-       static sigc::signal<void,nframes_t> CycleStart;
-
-       static void update_meters();
-       static std::string name_from_state (const XMLNode&);
-       static void set_name_in_state (XMLNode&, const std::string&);
-
-  private: 
-       
-       static sigc::signal<void>   Meter;
-       static Glib::StaticMutex    m_meter_signal_lock;
-       sigc::connection            m_meter_connection;
-
-  public:
-    
-       /* automation */
-
-       struct GainControl : public AutomationControl {
-           GainControl (std::string name, IO* i, const Evoral::Parameter &param,
-                   boost::shared_ptr<AutomationList> al = boost::shared_ptr<AutomationList>() )
-                       : AutomationControl (i->_session, param, al, name )
-                       , _io (i)
-               {}
-        
-           void set_value (float val);
-           float get_value (void) const;
-   
-           IO* _io;
+       int set_state (const XMLNode&, int version);
+       int set_state_2X (const XMLNode&, int, bool);
+       static void prepare_for_reset (XMLNode&, const std::string&);
+
+       class BoolCombiner {
+       public:
+
+               typedef bool result_type;
+
+               template <typename Iter>
+               result_type operator() (Iter first, Iter last) const {
+                       bool r = false;
+                       while (first != last) {
+                               if (*first) {
+                                       r = true;
+                               }
+                               ++first;
+                       }
+
+                       return r;
+               }
        };
 
-       boost::shared_ptr<GainControl> gain_control() {
-               return _gain_control;
-       }
-       boost::shared_ptr<const GainControl> gain_control() const {
-               return _gain_control;
-       }
+       /** Emitted when the port count is about to change.  Objects
+        *  can attach to this, and return `true' if they want to prevent
+        *  the change from happening.
+        */
+       PBD::Signal1<bool, ChanCount, BoolCombiner> PortCountChanging;
 
-       void clear_automation ();
-       
-       void set_parameter_automation_state (Evoral::Parameter, AutoState);
+       static int disable_connecting ();
+       static int enable_connecting ();
 
-       virtual void transport_stopped (nframes_t now);
-       virtual void automation_snapshot (nframes_t now, bool force);
+       static PBD::Signal1<void, ChanCount> PortCountChanged; // emitted when the number of ports changes
 
-       void start_pan_touch (uint32_t which);
-       void end_pan_touch (uint32_t which);
-
-       void defer_pan_reset ();
-       void allow_pan_reset ();
+       static std::string name_from_state (const XMLNode&);
+       static void set_name_in_state (XMLNode&, const std::string&);
 
-       /* the session calls this for master outs before
-          anyone else. controls outs too, at some point.
+       /* we have to defer/order port connection. this is how we do it.
        */
 
+       static PBD::Signal0<int> ConnectingLegal;
+       static bool              connecting_legal;
+
        XMLNode *pending_state_node;
-       int ports_became_legal ();
+       int pending_state_node_version;
+       bool pending_state_node_in;
 
-  private:
-       mutable Glib::Mutex io_lock;
+       /* three utility functions - this just seems to be simplest place to put them */
 
-  protected:
-       BufferSet*          _output_buffers; //< Set directly to output port buffers
-       bool                _active;
-       gain_t              _gain;
-       Glib::Mutex          declick_lock;
-       PortSet             _outputs;
-       PortSet             _inputs;
-       bool                 no_panner_reset;
-       bool                _phase_invert;
-       bool                _denormal_protection;
-       XMLNode*             deferred_state;
-       DataType            _default_type;
-       nframes_t           _output_offset;
-       
-       boost::shared_ptr<Amp>       _amp;
-       boost::shared_ptr<PeakMeter> _meter;
-       boost::shared_ptr<Panner>    _panner;
-
-       virtual void prepare_inputs (nframes_t nframes);
-       virtual void flush_outputs (nframes_t nframes);
-
-       virtual void set_deferred_state() {}
-
-       virtual uint32_t pans_required() const
-               { return _inputs.count().n_audio(); }
-
-       boost::shared_ptr<GainControl> _gain_control;
-
-       virtual void   set_gain (gain_t g, void *src);
-       void           inc_gain (gain_t delta, void *src);
-
-       virtual int load_automation (std::string path);
+       void collect_input (BufferSet& bufs, pframes_t nframes, ChanCount offset);
+       void process_input (boost::shared_ptr<Processor>, framepos_t start_frame, framepos_t end_frame, pframes_t nframes);
+       void copy_to_outputs (BufferSet& bufs, DataType type, pframes_t nframes, framecnt_t offset);
 
        /* AudioTrack::deprecated_use_diskstream_connections() needs these */
 
-       int set_inputs (const std::string& str);
-       int set_outputs (const std::string& str);
-
-       void increment_output_offset (nframes_t);
-       void cycle_start (nframes_t);
-
-       static bool connecting_legal;
-       static bool ports_legal;
+       int set_ports (const std::string& str);
 
   private:
-       static bool panners_legal;
+       mutable Glib::Threads::Mutex io_lock;
 
-       void copy_to_outputs (BufferSet& bufs, DataType type, nframes_t nframes);
+  protected:
+       PortSet   _ports;
+       Direction _direction;
+       DataType _default_type;
+       bool     _active;
+       bool     _sendish;
 
+  private:
        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;
 
-       boost::shared_ptr<Bundle> _bundle_for_inputs; ///< a bundle representing our inputs
-       boost::shared_ptr<Bundle> _bundle_for_outputs; ///< a bundle representing our outputs
+       boost::shared_ptr<Bundle> _bundle; ///< a bundle representing our ports
 
        struct UserBundleInfo {
                UserBundleInfo (IO*, boost::shared_ptr<UserBundle> b);
-               
                boost::shared_ptr<UserBundle> bundle;
-               sigc::connection changed;
+               PBD::ScopedConnection changed;
        };
-       
-       std::vector<UserBundleInfo> _bundles_connected_to_outputs; ///< user bundles connected to our outputs
-       std::vector<UserBundleInfo> _bundles_connected_to_inputs; ///< user bundles connected to our inputs
 
-       static int parse_io_string (const std::string&, std::vector<std::string>& chns);
+       std::vector<UserBundleInfo*> _bundles_connected; ///< user bundles connected to our ports
 
+       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);
-       
-       int set_sources (std::vector<std::string>&, void *src, bool add);
-       int set_destinations (std::vector<std::string>&, void *src, bool add);
 
-       int ensure_inputs (ChanCount, bool clear, bool lockit, void *src);
-       int ensure_outputs (ChanCount, bool clear, bool lockit, void *src);
+       int ensure_ports (ChanCount, bool clear, void *src);
 
-       void check_bundles_connected_to_inputs ();
-       void check_bundles_connected_to_outputs ();
-       void check_bundles (std::vector<UserBundleInfo>&, const PortSet&);
+       void check_bundles_connected ();
 
        void bundle_changed (Bundle::Change);
 
+       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 get_port_counts (const XMLNode& node, ChanCount& in, ChanCount& out,
-                            boost::shared_ptr<Bundle>& ic, boost::shared_ptr<Bundle>& oc);
-       int create_ports (const XMLNode&);
-       int make_connections (const XMLNode&);
-       boost::shared_ptr<Bundle> find_possible_bundle (const std::string &desired_name, const std::string &default_name, const std::string &connection_type_name);
+       boost::shared_ptr<Bundle> find_possible_bundle (const std::string &desired_name);
 
-       virtual void setup_peak_meters ();
-       void meter ();
+       int ensure_ports_locked (ChanCount, bool clear, bool& changed);
 
-       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);
 
-       std::string build_legal_port_name (DataType type, bool for_input);
-       int32_t find_input_port_hole (const char* base);
-       int32_t find_output_port_hole (const char* base);
+       void setup_bundle ();
+       std::string bundle_channel_name (uint32_t, uint32_t, DataType) const;
 
-       void setup_bundles_for_inputs_and_outputs ();
-       void setup_bundle_for_inputs ();
-       void setup_bundle_for_outputs ();
-       std::string bundle_channel_name (uint32_t, uint32_t) const;
+       void apply_pretty_name ();
+       std::string _pretty_name_prefix;
+       BufferSet _buffers;
+       void disconnect_check (boost::shared_ptr<ARDOUR::Port>, boost::shared_ptr<ARDOUR::Port>);
 };
 
 } // namespace ARDOUR