use a note tracker to resolve notes cut off during render by the end of the region
[ardour.git] / libs / ardour / port_insert.cc
index 46d54cd445aece3647e7c6fee65586575bf4dd1d..49fe4ad3853a32b74d3a49dcfca5e55d4e83b097 100644 (file)
@@ -1,21 +1,23 @@
 /*
-    Copyright (C) 2000,2007 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
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-*/
+ * Copyright (C) 2000-2017 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2007-2012 David Robillard <d@drobilla.net>
+ * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
+ * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
 
 #include <string>
 
@@ -30,7 +32,7 @@
 #include "ardour/session.h"
 #include "ardour/types.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
@@ -47,16 +49,16 @@ PortInsert::PortInsert (Session& s, boost::shared_ptr<Pannable> pannable, boost:
        : IOProcessor (s, true, true, name_and_id_new_insert (s, _bitslot), "", DataType::AUDIO, true)
        , _out (new Delivery (s, _output, pannable, mm, _name, Delivery::Insert))
 {
-        _mtdm = 0;
-        _latency_detect = false;
-        _latency_flush_frames = 0;
-        _measured_latency = 0;
+       _mtdm = 0;
+       _latency_detect = false;
+       _latency_flush_samples = 0;
+       _measured_latency = 0;
 }
 
 PortInsert::~PortInsert ()
 {
-        _session.unmark_insert_id (_bitslot);
-        delete _mtdm;
+       _session.unmark_insert_id (_bitslot);
+       delete _mtdm;
 }
 
 void
@@ -70,30 +72,30 @@ void
 PortInsert::start_latency_detection ()
 {
        delete _mtdm;
-        _mtdm = new MTDM (_session.frame_rate());
-        _latency_flush_frames = 0;
-        _latency_detect = true;
-        _measured_latency = 0;
+       _mtdm = new MTDM (_session.sample_rate());
+       _latency_flush_samples = 0;
+       _latency_detect = true;
+       _measured_latency = 0;
 }
 
 void
 PortInsert::stop_latency_detection ()
 {
-        _latency_flush_frames = signal_latency() + _session.engine().samples_per_cycle();
-        _latency_detect = false;
+       _latency_flush_samples = effective_latency() + _session.engine().samples_per_cycle();
+       _latency_detect = false;
 }
 
 void
-PortInsert::set_measured_latency (framecnt_t n)
+PortInsert::set_measured_latency (samplecnt_t n)
 {
-        _measured_latency = n;
+       _measured_latency = n;
 }
 
-framecnt_t
+samplecnt_t
 PortInsert::latency() const
 {
        /* because we deliver and collect within the same cycle,
-          all I/O is necessarily delayed by at least frames_per_cycle().
+          all I/O is necessarily delayed by at least samples_per_cycle().
 
           if the return port for insert has its own latency, we
           need to take that into account too.
@@ -107,75 +109,65 @@ PortInsert::latency() const
 }
 
 void
-PortInsert::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool)
+PortInsert::run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool)
 {
        if (_output->n_ports().n_total() == 0) {
                return;
        }
 
-        if (_latency_detect) {
+       if (_latency_detect) {
 
-                if (_input->n_ports().n_audio() != 0) {
+               if (_input->n_ports().n_audio() != 0) {
 
-                        AudioBuffer& outbuf (_output->ports().nth_audio_port(0)->get_audio_buffer (nframes));
-                        Sample* in = _input->ports().nth_audio_port(0)->get_audio_buffer (nframes).data();
-                        Sample* out = outbuf.data();
+                       AudioBuffer& outbuf (_output->ports().nth_audio_port(0)->get_audio_buffer (nframes));
+                       Sample* in = _input->ports().nth_audio_port(0)->get_audio_buffer (nframes).data();
+                       Sample* out = outbuf.data();
 
-                        _mtdm->process (nframes, in, out);
+                       _mtdm->process (nframes, in, out);
 
-                        outbuf.set_written (true);
-                }
+                       outbuf.set_written (true);
+               }
 
-                return;
+               return;
 
-        } else if (_latency_flush_frames) {
+       } else if (_latency_flush_samples) {
 
-                /* wait for the entire input buffer to drain before picking up input again so that we can't
-                   hear the remnants of whatever MTDM pumped into the pipeline.
-                */
+               /* wait for the entire input buffer to drain before picking up input again so that we can't
+                * hear the remnants of whatever MTDM pumped into the pipeline.
+                */
 
-                silence (nframes);
+               silence (nframes, start_sample);
 
-                if (_latency_flush_frames > nframes) {
-                        _latency_flush_frames -= nframes;
-                } else {
-                        _latency_flush_frames = 0;
-                }
+               if (_latency_flush_samples > nframes) {
+                       _latency_flush_samples -= nframes;
+               } else {
+                       _latency_flush_samples = 0;
+               }
 
-                return;
-        }
+               return;
+       }
 
        if (!_active && !_pending_active) {
                /* deliver silence */
-               silence (nframes);
+               silence (nframes, start_sample);
                goto out;
        }
 
-       _out->run (bufs, start_frame, end_frame, nframes, true);
+       _out->run (bufs, start_sample, end_sample, speed, nframes, true);
        _input->collect_input (bufs, nframes, ChanCount::ZERO);
 
-  out:
+out:
        _active = _pending_active;
 }
 
 XMLNode&
-PortInsert::get_state(void)
-{
-       return state (true);
-}
-
-XMLNode&
-PortInsert::state (bool full)
+PortInsert::state ()
 {
-       XMLNode& node = IOProcessor::state(full);
-       char buf[32];
-       node.add_property ("type", "port");
-       snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
-       node.add_property ("bitslot", buf);
-        snprintf (buf, sizeof (buf), "%" PRId64, _measured_latency);
-        node.add_property("latency", buf);
-        snprintf (buf, sizeof (buf), "%u", _session.get_block_size());
-        node.add_property("block_size", buf);
+       XMLNode& node = IOProcessor::state ();
+       node.set_property ("type", "port");
+       node.set_property ("bitslot", _bitslot);
+       node.set_property ("latency", _measured_latency);
+       node.set_property ("block-size", _session.get_block_size());
 
        return node;
 }
@@ -186,7 +178,6 @@ PortInsert::set_state (const XMLNode& node, int version)
        XMLNodeList nlist = node.children();
        XMLNodeIterator niter;
        XMLPropertyList plist;
-       const XMLProperty *prop;
 
        const XMLNode* insert_node = &node;
 
@@ -200,56 +191,56 @@ PortInsert::set_state (const XMLNode& node, int version)
 
        IOProcessor::set_state (*insert_node, version);
 
-       if ((prop = node.property ("type")) == 0) {
+       std::string type_str;
+       if (!node.get_property ("type", type_str)) {
                error << _("XML node describing port insert is missing the `type' field") << endmsg;
                return -1;
        }
 
-       if (prop->value() != "port") {
+       if (type_str != "port") {
                error << _("non-port insert XML used for port plugin insert") << endmsg;
                return -1;
        }
 
-        uint32_t blocksize = 0;
-        if ((prop = node.property ("block_size")) != 0) {
-                sscanf (prop->value().c_str(), "%u", &blocksize);
-        }
+       uint32_t blocksize = 0;
+       node.get_property ("block-size", blocksize);
 
-        //if the jack period is the same as when the value was saved, we can recall our latency..
-        if ( (_session.get_block_size() == blocksize) && (prop = node.property ("latency")) != 0) {
-                uint32_t latency = 0;
-                sscanf (prop->value().c_str(), "%u", &latency);
-                _measured_latency = latency;
-        }
+       //if the jack period is the same as when the value was saved, we can recall our latency..
+       if ( (_session.get_block_size() == blocksize) ) {
+               node.get_property ("latency", _measured_latency);
+       }
 
        if (!node.property ("ignore-bitslot")) {
-               if ((prop = node.property ("bitslot")) == 0) {
-                       _bitslot = _session.next_insert_id();
-               } else {
+               uint32_t bitslot;
+               if (node.get_property ("bitslot", bitslot)) {
                        _session.unmark_insert_id (_bitslot);
-                       sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
+                       _bitslot = bitslot;
                        _session.mark_insert_id (_bitslot);
+               } else {
+                       _bitslot = _session.next_insert_id();
                }
        }
 
        return 0;
 }
 
-ARDOUR::framecnt_t
+ARDOUR::samplecnt_t
 PortInsert::signal_latency() const
 {
        /* because we deliver and collect within the same cycle,
-          all I/O is necessarily delayed by at least frames_per_cycle().
-
-          if the return port for insert has its own latency, we
-          need to take that into account too.
-       */
+        * all I/O is necessarily delayed by at least samples_per_cycle().
+        *
+        * if the return port for insert has its own latency, we
+        * need to take that into account too.
+        */
 
-        if (_measured_latency == 0) {
-                return _session.engine().samples_per_cycle() + _input->signal_latency();
-        } else {
-                return _measured_latency;
-        }
+       if (_measured_latency == 0) {
+               return _session.engine().samples_per_cycle()
+                      + _input->connected_latency (false)
+                      + _output->connected_latency (true);
+       } else {
+               return _measured_latency;
+       }
 }
 
 /** Caller must hold process lock */