Fix broken whitespace. I'd apologize for the compile times if it was my fault :D
[ardour.git] / libs / ardour / port_insert.cc
index a46f7a7da3ea5188721e6c5225fbbff8dc9dc95b..c21f04364797e129814c4a2beb124861570b2d36 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000,2007 Paul Davis 
+    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
 
 #include <string>
 
-#include <sigc++/bind.h>
 
 #include "pbd/failed_constructor.h"
 #include "pbd/xml++.h"
 
+#include "ardour/audioengine.h"
+#include "ardour/audio_port.h"
+#include "ardour/buffer_set.h"
 #include "ardour/delivery.h"
-#include "ardour/port_insert.h"
+#include "ardour/mtdm.h"
 #include "ardour/plugin.h"
 #include "ardour/port.h"
+#include "ardour/port_insert.h"
 #include "ardour/route.h"
-#include "ardour/buffer_set.h"
-
-#include "ardour/audioengine.h"
 #include "ardour/session.h"
 #include "ardour/types.h"
 
@@ -41,44 +41,111 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
-PortInsert::PortInsert (Session& s, boost::shared_ptr<MuteMaster> mm)
+PortInsert::PortInsert (Session& s, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster> mm)
        : IOProcessor (s, true, true, string_compose (_("insert %1"), (bitslot = s.next_insert_id()) + 1), "")
-       , _out (new Delivery (s, _output, mm, _name, Delivery::Insert))
+       , _out (new Delivery (s, _output, pannable, mm, _name, Delivery::Insert))
 {
-       ProcessorCreated (this); /* EMIT SIGNAL */
+        _mtdm = 0;
+        _latency_detect = false;
+        _latency_flush_frames = false;
+        _measured_latency = 0;
 }
 
-PortInsert::PortInsert (Session& s, boost::shared_ptr<MuteMaster> mm, const XMLNode& node)
-       : IOProcessor (s, true, true, "unnamed port insert")
-       , _out (new Delivery (s, _output, mm, _name, Delivery::Insert))
+PortInsert::~PortInsert ()
+{
+        _session.unmark_insert_id (bitslot);
+        delete _mtdm;
+}
 
+void
+PortInsert::start_latency_detection ()
 {
-       if (set_state (node)) {
-               throw failed_constructor();
-       }
+        if (_mtdm != 0) {
+                delete _mtdm;
+        }
+
+        _mtdm = new MTDM;
+        _latency_flush_frames = false;
+        _latency_detect = true;
+        _measured_latency = 0;
+}
 
-       ProcessorCreated (this); /* EMIT SIGNAL */
+void
+PortInsert::stop_latency_detection ()
+{
+        _latency_flush_frames = signal_latency() + _session.engine().frames_per_cycle();
+        _latency_detect = false;
 }
 
-PortInsert::~PortInsert ()
+void
+PortInsert::set_measured_latency (framecnt_t n)
+{
+        _measured_latency = n;
+}
+
+framecnt_t
+PortInsert::latency() const
 {
-       GoingAway ();
+       /* 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.
+       */
+
+       if (_measured_latency == 0) {
+               return _session.engine().frames_per_cycle() + _input->latency();
+       } else {
+               return _measured_latency;
+       }
 }
 
 void
-PortInsert::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
+PortInsert::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool)
 {
        if (_output->n_ports().n_total() == 0) {
                return;
        }
 
+        if (_latency_detect) {
+
+                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();
+
+                        _mtdm->process (nframes, in, out);
+
+                        outbuf.is_silent (false);
+                }
+
+                return;
+
+        } else if (_latency_flush_frames) {
+
+                /* 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);
+
+                if (_latency_flush_frames > nframes) {
+                        _latency_flush_frames -= nframes;
+                } else {
+                        _latency_flush_frames = 0;
+                }
+
+                return;
+        }
+
        if (!_active && !_pending_active) {
                /* deliver silence */
                silence (nframes);
                goto out;
        }
 
-       _out->run (bufs, start_frame, end_frame, nframes);
+       _out->run (bufs, start_frame, end_frame, nframes, true);
        _input->collect_input (bufs, nframes, ChanCount::ZERO);
 
   out:
@@ -94,56 +161,73 @@ PortInsert::get_state(void)
 XMLNode&
 PortInsert::state (bool full)
 {
-       XMLNode& node = Processor::state(full);
+       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);
 
        return node;
 }
 
 int
-PortInsert::set_state(const XMLNode& node)
+PortInsert::set_state (const XMLNode& node, int version)
 {
        XMLNodeList nlist = node.children();
        XMLNodeIterator niter;
        XMLPropertyList plist;
        const XMLProperty *prop;
 
+       const XMLNode* insert_node = &node;
+
+       // legacy sessions: search for child Redirect node
+       for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
+               if ((*niter)->name() == "Redirect") {
+                       insert_node = *niter;
+                       break;
+               }
+       }
+
+       IOProcessor::set_state (*insert_node, version);
+
        if ((prop = node.property ("type")) == 0) {
                error << _("XML node describing port insert is missing the `type' field") << endmsg;
                return -1;
        }
-       
+
        if (prop->value() != "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);
+        }
+
+        //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 ((prop = node.property ("bitslot")) == 0) {
                bitslot = _session.next_insert_id();
        } else {
+                _session.unmark_insert_id (bitslot);
                sscanf (prop->value().c_str(), "%" PRIu32, &bitslot);
                _session.mark_insert_id (bitslot);
        }
 
-       const XMLNode* insert_node = &node;
-
-       // legacy sessions: search for child IOProcessor node
-       for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-               if ((*niter)->name() == "IOProcessor") {
-                       insert_node = *niter;
-                       break;
-               }
-       }
-       
-       Processor::set_state (*insert_node);
-
        return 0;
 }
 
-ARDOUR::nframes_t 
+ARDOUR::framecnt_t
 PortInsert::signal_latency() const
 {
        /* because we deliver and collect within the same cycle,
@@ -153,12 +237,19 @@ PortInsert::signal_latency() const
           need to take that into account too.
        */
 
-       return _session.engine().frames_per_cycle() + _input->signal_latency();
+        if (_measured_latency == 0) {
+                return _session.engine().frames_per_cycle() + _input->signal_latency();
+        } else {
+                return _measured_latency;
+        }
 }
 
+/** Caller must hold process lock */
 bool
 PortInsert::configure_io (ChanCount in, ChanCount out)
 {
+       assert (!AudioEngine::instance()->process_lock().trylock());
+
        /* for an insert, processor input corresponds to IO output, and vice versa */
 
        if (_input->ensure_io (in, false, this) != 0) {
@@ -184,7 +275,23 @@ PortInsert::set_name (const std::string& name)
 {
        bool ret = Processor::set_name (name);
 
-       ret = (_input->set_name (name) || _output->set_name (name));
+       ret = (ret && _input->set_name (name) && _output->set_name (name));
 
        return ret;
 }
+
+void
+PortInsert::activate ()
+{
+       IOProcessor::activate ();
+
+       _out->activate ();
+}
+
+void
+PortInsert::deactivate ()
+{
+       IOProcessor::deactivate ();
+
+       _out->deactivate ();
+}