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 #include "pbd/xml++.h"
  23
  24 #include "ardour/audio_port.h"
  25 #include "ardour/audioengine.h"
  26 #include "ardour/delivery.h"
  27 #include "ardour/io.h"
  28 #include "ardour/mtdm.h"
  29 #include "ardour/port_insert.h"
  30 #include "ardour/session.h"
  31 #include "ardour/types.h"
  32
  33 #include "pbd/i18n.h"
  34
  35 using namespace std;
  36 using namespace ARDOUR;
  37 using namespace PBD;
  38
  39 string
  40 PortInsert::name_and_id_new_insert (Session& s, uint32_t& bitslot)
  41 {
  42         bitslot = s.next_insert_id ();
  43         return string_compose (_("insert %1"), bitslot+ 1);
  44 }
  45
  46 PortInsert::PortInsert (Session& s, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster> mm)
  47         : IOProcessor (s, true, true, name_and_id_new_insert (s, _bitslot), "", DataType::AUDIO, true)
  48         , _out (new Delivery (s, _output, pannable, mm, _name, Delivery::Insert))
  49 {
  50         _mtdm = 0;
  51         _latency_detect = false;
  52         _latency_flush_samples = 0;
  53         _measured_latency = 0;
  54 }
  55
  56 PortInsert::~PortInsert ()
  57 {
  58         _session.unmark_insert_id (_bitslot);
  59         delete _mtdm;
  60 }
  61
  62 void
  63 PortInsert::set_pre_fader (bool p)
  64 {
  65         Processor::set_pre_fader (p);
  66         _out->set_pre_fader (p);
  67 }
  68
  69 void
  70 PortInsert::start_latency_detection ()
  71 {
  72         delete _mtdm;
  73         _mtdm = new MTDM (_session.sample_rate());
  74         _latency_flush_samples = 0;
  75         _latency_detect = true;
  76         _measured_latency = 0;
  77 }
  78
  79 void
  80 PortInsert::stop_latency_detection ()
  81 {
  82         _latency_flush_samples = signal_latency() + _session.engine().samples_per_cycle();
  83         _latency_detect = false;
  84 }
  85
  86 void
  87 PortInsert::set_measured_latency (samplecnt_t n)
  88 {
  89         _measured_latency = n;
  90 }
  91
  92 samplecnt_t
  93 PortInsert::latency() const
  94 {
  95         /* because we deliver and collect within the same cycle,
  96            all I/O is necessarily delayed by at least samples_per_cycle().
  97
  98            if the return port for insert has its own latency, we
  99            need to take that into account too.
 100         */
 101
 102         if (_measured_latency == 0) {
 103                 return _session.engine().samples_per_cycle() + _input->latency();
 104         } else {
 105                 return _measured_latency;
 106         }
 107 }
 108
 109 void
 110 PortInsert::run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool)
 111 {
 112         if (_output->n_ports().n_total() == 0) {
 113                 return;
 114         }
 115
 116         if (_latency_detect) {
 117
 118                 if (_input->n_ports().n_audio() != 0) {
 119
 120                         AudioBuffer& outbuf (_output->ports().nth_audio_port(0)->get_audio_buffer (nframes));
 121                         Sample* in = _input->ports().nth_audio_port(0)->get_audio_buffer (nframes).data();
 122                         Sample* out = outbuf.data();
 123
 124                         _mtdm->process (nframes, in, out);
 125
 126                         outbuf.set_written (true);
 127                 }
 128
 129                 return;
 130
 131         } else if (_latency_flush_samples) {
 132
 133                 /* wait for the entire input buffer to drain before picking up input again so that we can't
 134                    hear the remnants of whatever MTDM pumped into the pipeline.
 135                 */
 136
 137                 silence (nframes, start_sample);
 138
 139                 if (_latency_flush_samples > nframes) {
 140                         _latency_flush_samples -= nframes;
 141                 } else {
 142                         _latency_flush_samples = 0;
 143                 }
 144
 145                 return;
 146         }
 147
 148         if (!_active && !_pending_active) {
 149                 /* deliver silence */
 150                 silence (nframes, start_sample);
 151                 goto out;
 152         }
 153
 154         _out->run (bufs, start_sample, end_sample, speed, nframes, true);
 155         _input->collect_input (bufs, nframes, ChanCount::ZERO);
 156
 157   out:
 158         _active = _pending_active;
 159 }
 160
 161 XMLNode&
 162 PortInsert::state ()
 163 {
 164         XMLNode& node = IOProcessor::state ();
 165         node.set_property ("type", "port");
 166         node.set_property ("bitslot", _bitslot);
 167         node.set_property ("latency", _measured_latency);
 168         node.set_property ("block-size", _session.get_block_size());
 169
 170         return node;
 171 }
 172
 173 int
 174 PortInsert::set_state (const XMLNode& node, int version)
 175 {
 176         XMLNodeList nlist = node.children();
 177         XMLNodeIterator niter;
 178         XMLPropertyList plist;
 179
 180         const XMLNode* insert_node = &node;
 181
 182         // legacy sessions: search for child Redirect node
 183         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 184                 if ((*niter)->name() == "Redirect") {
 185                         insert_node = *niter;
 186                         break;
 187                 }
 188         }
 189
 190         IOProcessor::set_state (*insert_node, version);
 191
 192         std::string type_str;
 193         if (!node.get_property ("type", type_str)) {
 194                 error << _("XML node describing port insert is missing the `type' field") << endmsg;
 195                 return -1;
 196         }
 197
 198         if (type_str != "port") {
 199                 error << _("non-port insert XML used for port plugin insert") << endmsg;
 200                 return -1;
 201         }
 202
 203         uint32_t blocksize = 0;
 204         node.get_property ("block-size", blocksize);
 205
 206         //if the jack period is the same as when the value was saved, we can recall our latency..
 207         if ( (_session.get_block_size() == blocksize) ) {
 208                 node.get_property ("latency", _measured_latency);
 209         }
 210
 211         if (!node.property ("ignore-bitslot")) {
 212                 uint32_t bitslot;
 213                 if (node.get_property ("bitslot", bitslot)) {
 214                         _session.unmark_insert_id (_bitslot);
 215                         _bitslot = bitslot;
 216                         _session.mark_insert_id (_bitslot);
 217                 } else {
 218                         _bitslot = _session.next_insert_id();
 219                 }
 220         }
 221
 222         return 0;
 223 }
 224
 225 ARDOUR::samplecnt_t
 226 PortInsert::signal_latency() const
 227 {
 228         /* because we deliver and collect within the same cycle,
 229            all I/O is necessarily delayed by at least samples_per_cycle().
 230
 231            if the return port for insert has its own latency, we
 232            need to take that into account too.
 233         */
 234
 235         if (_measured_latency == 0) {
 236                 return _session.engine().samples_per_cycle() + _input->signal_latency();
 237         } else {
 238                 return _measured_latency;
 239         }
 240 }
 241
 242 /** Caller must hold process lock */
 243 bool
 244 PortInsert::configure_io (ChanCount in, ChanCount out)
 245 {
 246 #ifndef PLATFORM_WINDOWS
 247         assert (!AudioEngine::instance()->process_lock().trylock());
 248 #endif
 249
 250         /* for an insert, processor input corresponds to IO output, and vice versa */
 251
 252         if (_input->ensure_io (in, false, this) != 0) {
 253                 return false;
 254         }
 255
 256         if (_output->ensure_io (out, false, this) != 0) {
 257                 return false;
 258         }
 259
 260         return Processor::configure_io (in, out);
 261 }
 262
 263 bool
 264 PortInsert::can_support_io_configuration (const ChanCount& in, ChanCount& out)
 265 {
 266         out = in;
 267         return true;
 268 }
 269
 270 bool
 271 PortInsert::set_name (const std::string& name)
 272 {
 273         bool ret = Processor::set_name (name);
 274
 275         ret = (ret && _input->set_name (name) && _output->set_name (name));
 276
 277         return ret;
 278 }
 279
 280 void
 281 PortInsert::activate ()
 282 {
 283         IOProcessor::activate ();
 284
 285         _out->activate ();
 286 }
 287
 288 void
 289 PortInsert::deactivate ()
 290 {
 291         IOProcessor::deactivate ();
 292
 293         _out->deactivate ();
 294 }