libs/ardour/ardour/io.h

   1 /*
   2     Copyright (C) 2000 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_io_h__
  21 #define __ardour_io_h__
  22
  23 #include <string>
  24 #include <vector>
  25 #include <cmath>
  26 #include <jack/jack.h>
  27
  28 #include <glibmm/thread.h>
  29
  30 #include "pbd/fastlog.h"
  31 #include "pbd/undo.h"
  32 #include "pbd/statefuldestructible.h"
  33 #include "pbd/controllable.h"
  34
  35 #include "ardour/ardour.h"
  36 #include "ardour/automation_control.h"
  37 #include "ardour/bundle.h"
  38 #include "ardour/chan_count.h"
  39 #include "ardour/data_type.h"
  40 #include "ardour/latent.h"
  41 #include "ardour/port_set.h"
  42 #include "ardour/session_object.h"
  43 #include "ardour/types.h"
  44 #include "ardour/utils.h"
  45 #include "ardour/buffer_set.h"
  46
  47 class XMLNode;
  48
  49 namespace ARDOUR {
  50
  51 class Amp;
  52 class AudioEngine;
  53 class AudioPort;
  54 class Bundle;
  55 class MidiPort;
  56 class PeakMeter;
  57 class Port;
  58 class Processor;
  59 class Session;
  60 class UserBundle;
  61
  62 /** A collection of ports (all input or all output) with connections.
  63  *
  64  * An IO can contain ports of varying types, making routes/inserts/etc with
  65  * varied combinations of types (eg MIDI and audio) possible.
  66  */
  67 class IO : public SessionObject, public Latent
  68 {
  69   public:
  70         static const std::string state_node_name;
  71
  72         enum Direction {
  73                 Input,
  74                 Output
  75         };
  76
  77         IO (Session&, const std::string& name, Direction, DataType default_type = DataType::AUDIO);
  78         IO (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
  79
  80         virtual ~IO();
  81
  82         Direction direction() const { return _direction; }
  83
  84         DataType default_type() const         { return _default_type; }
  85         void     set_default_type(DataType t) { _default_type = t; }
  86
  87         bool active() const { return _active; }
  88         void set_active(bool yn) { _active = yn; }
  89
  90         bool set_name (const std::string& str);
  91
  92         virtual void silence (framecnt_t);
  93         void increment_port_buffer_offset (pframes_t offset);
  94
  95         int ensure_io (ChanCount cnt, bool clear, void *src);
  96
  97         int connect_ports_to_bundle (boost::shared_ptr<Bundle>, void *);
  98         int disconnect_ports_from_bundle (boost::shared_ptr<Bundle>, void *);
  99
 100         BundleList bundles_connected ();
 101
 102         boost::shared_ptr<Bundle> bundle () { return _bundle; }
 103
 104         int add_port (std::string connection, void *src, DataType type = DataType::NIL);
 105         int remove_port (Port *, void *src);
 106         int connect (Port *our_port, std::string other_port, void *src);
 107         int disconnect (Port *our_port, std::string other_port, void *src);
 108         int disconnect (void *src);
 109         bool connected_to (boost::shared_ptr<const IO>) const;
 110         bool connected () const;
 111         bool physically_connected () const;
 112
 113         framecnt_t signal_latency () const { return _own_latency; }
 114         framecnt_t latency () const;
 115
 116         PortSet& ports() { return _ports; }
 117         const PortSet& ports() const { return _ports; }
 118
 119         bool has_port (Port *) const;
 120
 121         Port *nth (uint32_t n) const {
 122                 if (n < _ports.num_ports()) {
 123                         return _ports.port(n);
 124                 } else {
 125                         return 0;
 126                 }
 127         }
 128
 129         Port* port_by_name (const std::string& str) const;
 130
 131         AudioPort* audio(uint32_t n) const;
 132         MidiPort*  midi(uint32_t n) const;
 133
 134         const ChanCount& n_ports ()  const { return _ports.count(); }
 135
 136         /* The process lock will be held on emission of this signal if
 137          * IOChange contains ConfigurationChanged.  In other cases,
 138          * the process lock status is undefined.
 139          */
 140         PBD::Signal2<void, IOChange, void *> changed;
 141
 142         virtual XMLNode& state (bool full);
 143         XMLNode& get_state (void);
 144         int set_state (const XMLNode&, int version);
 145         int set_state_2X (const XMLNode&, int, bool);
 146
 147         class BoolCombiner {
 148         public:
 149
 150                 typedef bool result_type;
 151
 152                 template <typename Iter>
 153                 bool operator() (Iter first, Iter last) const {
 154                         bool r = false;
 155                         while (first != last) {
 156                                 if (*first) {
 157                                         r = true;
 158                                 }
 159                                 ++first;
 160                         }
 161
 162                         return r;
 163                 }
 164         };
 165
 166         /** Emitted when the port count is about to change.  Objects
 167          *  can attach to this, and return `true' if they want to prevent
 168          *  the change from happening.
 169          */
 170         PBD::Signal1<bool, ChanCount, BoolCombiner> PortCountChanging;
 171
 172         static int  disable_connecting (void);
 173         static int  enable_connecting (void);
 174         static int  disable_ports (void);
 175         static int  enable_ports (void);
 176
 177         static PBD::Signal1<void,ChanCount> PortCountChanged; // emitted when the number of ports changes
 178
 179         static std::string name_from_state (const XMLNode&);
 180         static void set_name_in_state (XMLNode&, const std::string&);
 181
 182         /* we have to defer/order port connection. this is how we do it.
 183         */
 184
 185         static PBD::Signal0<int> ConnectingLegal;
 186         static bool              connecting_legal;
 187
 188         XMLNode *pending_state_node;
 189         int pending_state_node_version;
 190         bool pending_state_node_in;
 191
 192         /* three utility functions - this just seems to be simplest place to put them */
 193
 194         void collect_input (BufferSet& bufs, pframes_t nframes, ChanCount offset);
 195         void process_input (boost::shared_ptr<Processor>, framepos_t start_frame, framepos_t end_frame, pframes_t nframes);
 196         void copy_to_outputs (BufferSet& bufs, DataType type, pframes_t nframes, framecnt_t offset);
 197
 198         /* AudioTrack::deprecated_use_diskstream_connections() needs these */
 199
 200         int set_ports (const std::string& str);
 201
 202   private:
 203         mutable Glib::Mutex io_lock;
 204
 205   protected:
 206         PortSet   _ports;
 207         Direction _direction;
 208         DataType _default_type;
 209         bool     _active;
 210
 211   private:
 212         int connecting_became_legal ();
 213         PBD::ScopedConnection connection_legal_c;
 214
 215         boost::shared_ptr<Bundle> _bundle; ///< a bundle representing our ports
 216
 217         struct UserBundleInfo {
 218             UserBundleInfo (IO*, boost::shared_ptr<UserBundle> b);
 219             boost::shared_ptr<UserBundle> bundle;
 220             PBD::ScopedConnection changed;
 221         };
 222
 223         std::vector<UserBundleInfo*> _bundles_connected; ///< user bundles connected to our ports
 224
 225         static int parse_io_string (const std::string&, std::vector<std::string>& chns);
 226         static int parse_gain_string (const std::string&, std::vector<std::string>& chns);
 227
 228         int ensure_ports (ChanCount, bool clear, void *src);
 229
 230         void check_bundles_connected ();
 231         void check_bundles (std::vector<UserBundleInfo*>&, const PortSet&);
 232
 233         void bundle_changed (Bundle::Change);
 234
 235         int get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c);
 236         int get_port_counts_2X (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c);
 237         int create_ports (const XMLNode&, int version);
 238         int make_connections (const XMLNode&, int, bool);
 239         int make_connections_2X (const XMLNode &, int, bool);
 240
 241         boost::shared_ptr<Bundle> find_possible_bundle (const std::string &desired_name);
 242
 243         bool ensure_ports_locked (ChanCount, bool clear, void *src);
 244
 245         std::string build_legal_port_name (DataType type);
 246         int32_t find_port_hole (const char* base);
 247
 248         void setup_bundle ();
 249         std::string bundle_channel_name (uint32_t, uint32_t, DataType) const;
 250
 251         BufferSet _buffers;
 252 };
 253
 254 } // namespace ARDOUR
 255
 256 #endif /*__ardour_io_h__ */