libs/ardour/port_insert.cc

   1 /*
   2     Copyright (C) 2000,2007 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 #include <string>
  21
  22
  23 #include "pbd/failed_constructor.h"
  24 #include "pbd/xml++.h"
  25
  26 #include "ardour/audioengine.h"
  27 #include "ardour/audio_port.h"
  28 #include "ardour/buffer_set.h"
  29 #include "ardour/delivery.h"
  30 #include "ardour/mtdm.h"
  31 #include "ardour/plugin.h"
  32 #include "ardour/port.h"
  33 #include "ardour/port_insert.h"
  34 #include "ardour/route.h"
  35 #include "ardour/session.h"
  36 #include "ardour/types.h"
  37
  38 #include "i18n.h"
  39
  40 using namespace std;
  41 using namespace ARDOUR;
  42 using namespace PBD;
  43
  44 PortInsert::PortInsert (Session& s, boost::shared_ptr<MuteMaster> mm)
  45         : IOProcessor (s, true, true, string_compose (_("insert %1"), (bitslot = s.next_insert_id()) + 1), "")
  46         , _out (new Delivery (s, _output, mm, _name, Delivery::Insert))
  47 {
  48         _mtdm = 0;
  49         _latency_detect = false;
  50         _latency_flush_frames = false;
  51         _measured_latency = 0;
  52 }
  53
  54 PortInsert::~PortInsert ()
  55 {
  56         _session.unmark_insert_id (bitslot);
  57         delete _mtdm;
  58 }
  59
  60 void
  61 PortInsert::start_latency_detection ()
  62 {
  63         if (_mtdm != 0) {
  64                 delete _mtdm;
  65         }
  66
  67         _mtdm = new MTDM;
  68         _latency_flush_frames = false;
  69         _latency_detect = true;
  70         _measured_latency = 0;
  71 }
  72
  73 void
  74 PortInsert::stop_latency_detection ()
  75 {
  76         _latency_flush_frames = signal_latency() + _session.engine().frames_per_cycle();
  77         _latency_detect = false;
  78 }
  79
  80 void
  81 PortInsert::set_measured_latency (nframes_t n)
  82 {
  83         _measured_latency = n;
  84 }
  85
  86 void
  87 PortInsert::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes, bool)
  88 {
  89         if (_output->n_ports().n_total() == 0) {
  90                 return;
  91         }
  92
  93         if (_latency_detect) {
  94
  95                 if (_input->n_ports().n_audio() != 0) {
  96
  97                         AudioBuffer& outbuf (_output->ports().nth_audio_port(0)->get_audio_buffer (nframes));
  98                         Sample* in = _input->ports().nth_audio_port(0)->get_audio_buffer (nframes).data();
  99                         Sample* out = outbuf.data();
 100
 101                         _mtdm->process (nframes, in, out);
 102
 103                         outbuf.is_silent (false);
 104                 }
 105
 106                 return;
 107
 108         } else if (_latency_flush_frames) {
 109
 110                 /* wait for the entire input buffer to drain before picking up input again so that we can't
 111                    hear the remnants of whatever MTDM pumped into the pipeline.
 112                 */
 113
 114                 silence (nframes);
 115
 116                 if (_latency_flush_frames > nframes) {
 117                         _latency_flush_frames -= nframes;
 118                 } else {
 119                         _latency_flush_frames = 0;
 120                 }
 121
 122                 return;
 123         }
 124
 125         if (!_active && !_pending_active) {
 126                 /* deliver silence */
 127                 silence (nframes);
 128                 goto out;
 129         }
 130
 131         _out->run (bufs, start_frame, end_frame, nframes, true);
 132         _input->collect_input (bufs, nframes, ChanCount::ZERO);
 133
 134   out:
 135         _active = _pending_active;
 136 }
 137
 138 XMLNode&
 139 PortInsert::get_state(void)
 140 {
 141         return state (true);
 142 }
 143
 144 XMLNode&
 145 PortInsert::state (bool full)
 146 {
 147         XMLNode& node = Processor::state(full);
 148         char buf[32];
 149         node.add_property ("type", "port");
 150         snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
 151         node.add_property ("bitslot", buf);
 152
 153         return node;
 154 }
 155
 156 int
 157 PortInsert::set_state (const XMLNode& node, int version)
 158 {
 159         XMLNodeList nlist = node.children();
 160         XMLNodeIterator niter;
 161         XMLPropertyList plist;
 162         const XMLProperty *prop;
 163
 164         const XMLNode* insert_node = &node;
 165
 166         // legacy sessions: search for child IOProcessor node
 167         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 168                 if ((*niter)->name() == "IOProcessor") {
 169                         insert_node = *niter;
 170                         break;
 171                 }
 172         }
 173
 174         Processor::set_state (*insert_node, version);
 175
 176         if ((prop = node.property ("type")) == 0) {
 177                 error << _("XML node describing port insert is missing the `type' field") << endmsg;
 178                 return -1;
 179         }
 180
 181         if (prop->value() != "port") {
 182                 error << _("non-port insert XML used for port plugin insert") << endmsg;
 183                 return -1;
 184         }
 185
 186         if ((prop = node.property ("bitslot")) == 0) {
 187                 bitslot = _session.next_insert_id();
 188         } else {
 189                 _session.unmark_insert_id (bitslot);
 190                 sscanf (prop->value().c_str(), "%" PRIu32, &bitslot);
 191                 _session.mark_insert_id (bitslot);
 192         }
 193
 194         return 0;
 195 }
 196
 197 ARDOUR::nframes_t
 198 PortInsert::signal_latency() const
 199 {
 200         /* because we deliver and collect within the same cycle,
 201            all I/O is necessarily delayed by at least frames_per_cycle().
 202
 203            if the return port for insert has its own latency, we
 204            need to take that into account too.
 205         */
 206
 207         if (_measured_latency == 0) {
 208                 return _session.engine().frames_per_cycle() + _input->signal_latency();
 209         } else {
 210                 return _measured_latency;
 211         }
 212 }
 213
 214 bool
 215 PortInsert::configure_io (ChanCount in, ChanCount out)
 216 {
 217         /* for an insert, processor input corresponds to IO output, and vice versa */
 218
 219         if (_input->ensure_io (in, false, this) != 0) {
 220                 return false;
 221         }
 222
 223         if (_output->ensure_io (out, false, this) != 0) {
 224                 return false;
 225         }
 226
 227         return Processor::configure_io (in, out);
 228 }
 229
 230 bool
 231 PortInsert::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 232 {
 233         out = in;
 234         return true;
 235 }
 236
 237 bool
 238 PortInsert::set_name (const std::string& name)
 239 {
 240         bool ret = Processor::set_name (name);
 241
 242         ret = (ret && _input->set_name (name) && _output->set_name (name));
 243
 244         return ret;
 245 }
 246
 247 void
 248 PortInsert::activate ()
 249 {
 250         IOProcessor::activate ();
 251
 252         _out->activate ();
 253 }
 254
 255 void
 256 PortInsert::deactivate ()
 257 {
 258         IOProcessor::deactivate ();
 259
 260         _out->deactivate ();
 261 }