cue monitoring for MIDI
[ardour.git] / libs / ardour / port_insert.cc
index 606b055dab8e61413cbc6abd0ee3fb23f04ad783..7427dda42ca632fc666815e3e75af427061302c3 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/port_insert.h"
-#include "ardour/plugin.h"
-#include "ardour/port.h"
-#include "ardour/route.h"
-#include "ardour/buffer_set.h"
-
+#include "ardour/audio_port.h"
 #include "ardour/audioengine.h"
+#include "ardour/delivery.h"
+#include "ardour/io.h"
+#include "ardour/mtdm.h"
+#include "ardour/port_insert.h"
 #include "ardour/session.h"
 #include "ardour/types.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
-PortInsert::PortInsert (Session& s)
-       : IOProcessor (s, string_compose (_("insert %1"), (bitslot = s.next_insert_id()) + 1), "")
+string
+PortInsert::name_and_id_new_insert (Session& s, uint32_t& bitslot)
 {
-       init ();
-       ProcessorCreated (this); /* EMIT SIGNAL */
+       bitslot = s.next_insert_id ();
+       return string_compose (_("insert %1"), bitslot+ 1);
 }
 
-PortInsert::PortInsert (Session& s, const XMLNode& node)
-       : IOProcessor (s, "unnamed port insert")
+PortInsert::PortInsert (Session& s, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster> mm)
+       : IOProcessor (s, true, true, name_and_id_new_insert (s, _bitslot), "", DataType::AUDIO, true)
+       , _out (new Delivery (s, _output, pannable, mm, _name, Delivery::Insert))
 {
-       if (set_state (node)) {
-               throw failed_constructor();
-       }
-
-       ProcessorCreated (this); /* EMIT SIGNAL */
+        _mtdm = 0;
+        _latency_detect = false;
+        _latency_flush_frames = 0;
+        _measured_latency = 0;
 }
 
 PortInsert::~PortInsert ()
 {
-       GoingAway ();
+        _session.unmark_insert_id (_bitslot);
+        delete _mtdm;
 }
 
 void
-PortInsert::init ()
+PortInsert::set_pre_fader (bool p)
+{
+       Processor::set_pre_fader (p);
+       _out->set_pre_fader (p);
+}
+
+void
+PortInsert::start_latency_detection ()
+{
+       delete _mtdm;
+        _mtdm = new MTDM (_session.frame_rate());
+        _latency_flush_frames = 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;
+}
+
+void
+PortInsert::set_measured_latency (framecnt_t n)
+{
+        _measured_latency = n;
+}
+
+framecnt_t
+PortInsert::latency() const
 {
-       if (_io->ensure_io(output_streams(), input_streams(), false, this)) { // sic
-               error << _("PortInsert: cannot create ports") << endmsg;
-               throw failed_constructor();
+       /* 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().samples_per_cycle() + _input->latency();
+       } else {
+               return _measured_latency;
        }
 }
 
 void
-PortInsert::run_in_place (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame, nframes_t nframes)
+PortInsert::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, double speed, pframes_t nframes, bool)
 {
-       if (_io->n_outputs().n_total() == 0) {
+       if (_output->n_ports().n_total() == 0) {
                return;
        }
 
-       if (!active()) {
+        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.set_written (true);
+                }
+
+                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, start_frame);
+
+                if (_latency_flush_frames > nframes) {
+                        _latency_flush_frames -= nframes;
+                } else {
+                        _latency_flush_frames = 0;
+                }
+
+                return;
+        }
+
+       if (!_active && !_pending_active) {
                /* deliver silence */
-               _io->silence (nframes);
-               return;
+               silence (nframes, start_frame);
+               goto out;
        }
 
-       _io->deliver_output (bufs, start_frame, end_frame, nframes);
-       _io->collect_input (bufs, nframes);
+       _out->run (bufs, start_frame, end_frame, speed, nframes, true);
+       _input->collect_input (bufs, nframes, ChanCount::ZERO);
+
+  out:
+       _active = _pending_active;
 }
 
 XMLNode&
@@ -98,55 +168,67 @@ XMLNode&
 PortInsert::state (bool 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);
+       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;
 }
 
 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;
 
-       if ((prop = node.property ("type")) == 0) {
+       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);
+
+       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;
        }
 
-       if ((prop = node.property ("bitslot")) == 0) {
-               bitslot = _session.next_insert_id();
-       } else {
-               sscanf (prop->value().c_str(), "%" PRIu32, &bitslot);
-               _session.mark_insert_id (bitslot);
-       }
+       uint32_t blocksize = 0;
+       node.get_property ("block-size", blocksize);
 
-       const XMLNode* insert_node = &node;
+       //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);
+       }
 
-       // legacy sessions: search for child IOProcessor node
-       for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-               if ((*niter)->name() == "IOProcessor") {
-                       insert_node = *niter;
-                       break;
+       if (!node.property ("ignore-bitslot")) {
+               uint32_t bitslot;
+               if (node.get_property ("bitslot", bitslot)) {
+                       _session.unmark_insert_id (_bitslot);
+                       _bitslot = bitslot;
+                       _session.mark_insert_id (_bitslot);
+               } else {
+                       _bitslot = _session.next_insert_id();
                }
        }
-       
-       IOProcessor::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,
@@ -156,52 +238,63 @@ PortInsert::signal_latency() const
           need to take that into account too.
        */
 
-       return _session.engine().frames_per_cycle() + _io->input_latency();
+        if (_measured_latency == 0) {
+                return _session.engine().samples_per_cycle() + _input->signal_latency();
+        } else {
+                return _measured_latency;
+        }
 }
 
+/** Caller must hold process lock */
 bool
 PortInsert::configure_io (ChanCount in, ChanCount out)
 {
-       /* do not allow configuration to be changed outside the range of
-          the last request config. or something like that.
-       */
-
-       /* this is a bit odd: 
+#ifndef PLATFORM_WINDOWS
+       assert (!AudioEngine::instance()->process_lock().trylock());
+#endif
 
-          the number of inputs we are required to handle corresponds 
-          to the number of output ports we need.
+       /* for an insert, processor input corresponds to IO output, and vice versa */
 
-          the number of outputs we are required to have corresponds
-          to the number of input ports we need.
-       */
-
-       /*_io->set_output_maximum (in);
-       _io->set_output_minimum (in);
-       _io->set_input_maximum (out);
-       _io->set_input_minimum (out);*/
+       if (_input->ensure_io (in, false, this) != 0) {
+               return false;
+       }
 
-       if (_io->ensure_io (out, in, false, this) != 0) {
+       if (_output->ensure_io (out, false, this) != 0) {
                return false;
        }
 
        return Processor::configure_io (in, out);
 }
 
-ChanCount
-PortInsert::output_streams() const
+bool
+PortInsert::can_support_io_configuration (const ChanCount& in, ChanCount& out)
+{
+       out = in;
+       return true;
+}
+
+bool
+PortInsert::set_name (const std::string& name)
 {
-       return _io->n_inputs ();
+       bool ret = Processor::set_name (name);
+
+       ret = (ret && _input->set_name (name) && _output->set_name (name));
+
+       return ret;
 }
 
-ChanCount
-PortInsert::input_streams() const
+void
+PortInsert::activate ()
 {
-       return _io->n_outputs ();
+       IOProcessor::activate ();
+
+       _out->activate ();
 }
 
-bool
-PortInsert::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
+void
+PortInsert::deactivate ()
 {
-       out = in;
-       return true;
+       IOProcessor::deactivate ();
+
+       _out->deactivate ();
 }