NO-OP: a ToDo comment for discussion
[ardour.git] / libs / ardour / export_channel.cc
index f36716761b80f1fa8ab7af976b056138a8ddcf82..66fec3a53b4127057070b83d41f4e2e954ec8deb 100644 (file)
 
 #include "pbd/error.h"
 
+#include "pbd/i18n.h"
+
 using namespace ARDOUR;
 
 PortExportChannel::PortExportChannel ()
-       : buffer_size(0)
+       : _buffer_size (0)
+{
+}
+
+PortExportChannel::~PortExportChannel ()
 {
+       _delaylines.clear ();
 }
 
-void PortExportChannel::set_max_buffer_size(framecnt_t frames)
+void PortExportChannel::set_max_buffer_size(samplecnt_t samples)
 {
-       buffer_size = frames;
-       buffer.reset (new Sample[frames]);
+       _buffer_size = samples;
+       _buffer.reset (new Sample[samples]);
+
+       _delaylines.clear ();
+
+       for (PortSet::const_iterator it = ports.begin(); it != ports.end(); ++it) {
+               boost::shared_ptr<AudioPort> p = it->lock ();
+               if (!p) { continue; }
+               samplecnt_t latency = p->private_latency_range (true).max;
+               PBD::RingBuffer<Sample>* rb = new PBD::RingBuffer<Sample> (latency + 1 + _buffer_size);
+               for (samplepos_t i = 0; i < latency; ++i) {
+                       Sample zero = 0;
+                       rb->write (&zero, 1);
+               }
+               _delaylines.push_back (boost::shared_ptr<PBD::RingBuffer<Sample> >(rb));
+       }
 }
 
 bool
@@ -54,29 +75,41 @@ PortExportChannel::operator< (ExportChannel const & other) const
 }
 
 void
-PortExportChannel::read (Sample const *& data, framecnt_t frames) const
+PortExportChannel::read (Sample const *& data, samplecnt_t samples) const
 {
-       assert(buffer);
-       assert(frames <= buffer_size);
-
-       if (ports.size() == 1) {
-               data = (*ports.begin())->get_audio_buffer(frames).data();
+       assert(_buffer);
+       assert(samples <= _buffer_size);
+
+       if (ports.size() == 1 && _delaylines.size() ==1 && _delaylines.front()->bufsize () == _buffer_size + 1) {
+               boost::shared_ptr<AudioPort> p = ports.begin()->lock ();
+               AudioBuffer& ab (p->get_audio_buffer(samples)); // unsets AudioBuffer::_written
+               data = ab.data();
+               ab.set_written (true);
                return;
        }
-       
-       memset (buffer.get(), 0, frames * sizeof (Sample));
 
-       for (PortSet::const_iterator it = ports.begin(); it != ports.end(); ++it) {
-               if (*it != 0) {
-                       Sample* port_buffer = (*it)->get_audio_buffer(frames).data();
+       memset (_buffer.get(), 0, samples * sizeof (Sample));
 
-                       for (uint32_t i = 0; i < frames; ++i) {
-                               buffer[i] += (float) port_buffer[i];
-                       }
+       std::list <boost::shared_ptr<PBD::RingBuffer<Sample> > >::const_iterator di = _delaylines.begin ();
+       for (PortSet::const_iterator it = ports.begin(); it != ports.end(); ++it) {
+               boost::shared_ptr<AudioPort> p = it->lock ();
+               if (!p) {
+                       continue;
+               }
+               AudioBuffer& ab (p->get_audio_buffer(samples)); // unsets AudioBuffer::_written
+               Sample* port_buffer = ab.data();
+               ab.set_written (true);
+               (*di)->write (port_buffer, samples);
+               // TODO optimze, get_read_vector()
+               for (uint32_t i = 0; i < samples; ++i) {
+                       Sample spl;
+                       (*di)->read (&spl, 1);
+                       _buffer[i] += spl;
                }
+               ++di;
        }
 
-       data = buffer.get();
+       data = _buffer.get();
 }
 
 void
@@ -84,8 +117,9 @@ PortExportChannel::get_state (XMLNode * node) const
 {
        XMLNode * port_node;
        for (PortSet::const_iterator it = ports.begin(); it != ports.end(); ++it) {
-               if ((port_node = node->add_child ("Port"))) {
-                       port_node->add_property ("name", (*it)->name());
+               boost::shared_ptr<Port> p = it->lock ();
+               if (p && (port_node = node->add_child ("Port"))) {
+                       port_node->set_property ("name", p->name());
                }
        }
 }
@@ -93,12 +127,11 @@ PortExportChannel::get_state (XMLNode * node) const
 void
 PortExportChannel::set_state (XMLNode * node, Session & session)
 {
-       XMLProperty * prop;
        XMLNodeList xml_ports = node->children ("Port");
        for (XMLNodeList::iterator it = xml_ports.begin(); it != xml_ports.end(); ++it) {
-               if ((prop = (*it)->property ("name"))) {
-                       std::string const & name = prop->value();
-                       AudioPort * port = dynamic_cast<AudioPort *> (session.engine().get_port_by_name (name));
+               std::string name;
+               if ((*it)->get_property ("name", name)) {
+                       boost::shared_ptr<AudioPort> port = boost::dynamic_pointer_cast<AudioPort> (session.engine().get_port_by_name (name));
                        if (port) {
                                ports.insert (port);
                        } else {
@@ -108,14 +141,14 @@ PortExportChannel::set_state (XMLNode * node, Session & session)
        }
 }
 
-RegionExportChannelFactory::RegionExportChannelFactory (Session * session, AudioRegion const & region, AudioTrack & track, Type type) :
-  region (region),
-  track (track),
-  type (type),
-  frames_per_cycle (session->engine().frames_per_cycle ()),
-  buffers_up_to_date (false),
-  region_start (region.position()),
-  position (region_start)
+RegionExportChannelFactory::RegionExportChannelFactory (Session * session, AudioRegion const & region, AudioTrack & track, Type type)
+       : region (region)
+       , track (track)
+       , type (type)
+       , samples_per_cycle (session->engine().samples_per_cycle ())
+       , buffers_up_to_date (false)
+       , region_start (region.position())
+       , position (region_start)
 {
        switch (type) {
          case Raw:
@@ -124,9 +157,9 @@ RegionExportChannelFactory::RegionExportChannelFactory (Session * session, Audio
          case Fades:
                n_channels = region.n_channels();
 
-               mixdown_buffer.reset (new Sample [frames_per_cycle]);
-               gain_buffer.reset (new Sample [frames_per_cycle]);
-               memset (gain_buffer.get(), 1.0, sizeof (Sample) * frames_per_cycle);
+               mixdown_buffer.reset (new Sample [samples_per_cycle]);
+               gain_buffer.reset (new Sample [samples_per_cycle]);
+               std::fill_n (gain_buffer.get(), samples_per_cycle, Sample (1.0));
 
                break;
          case Processed:
@@ -138,7 +171,7 @@ RegionExportChannelFactory::RegionExportChannelFactory (Session * session, Audio
 
        session->ProcessExport.connect_same_thread (export_connection, boost::bind (&RegionExportChannelFactory::new_cycle_started, this, _1));
 
-       buffers.ensure_buffers (DataType::AUDIO, n_channels, frames_per_cycle);
+       buffers.ensure_buffers (DataType::AUDIO, n_channels, samples_per_cycle);
        buffers.set_count (ChanCount (DataType::AUDIO, n_channels));
 }
 
@@ -154,13 +187,13 @@ RegionExportChannelFactory::create (uint32_t channel)
 }
 
 void
-RegionExportChannelFactory::read (uint32_t channel, Sample const *& data, framecnt_t frames_to_read)
+RegionExportChannelFactory::read (uint32_t channel, Sample const *& data, samplecnt_t samples_to_read)
 {
        assert (channel < n_channels);
-       assert (frames_to_read <= frames_per_cycle);
+       assert (samples_to_read <= samples_per_cycle);
 
        if (!buffers_up_to_date) {
-               update_buffers(frames_to_read);
+               update_buffers(samples_to_read);
                buffers_up_to_date = true;
        }
 
@@ -168,31 +201,32 @@ RegionExportChannelFactory::read (uint32_t channel, Sample const *& data, framec
 }
 
 void
-RegionExportChannelFactory::update_buffers (framecnt_t frames)
+RegionExportChannelFactory::update_buffers (samplecnt_t samples)
 {
-       assert (frames <= frames_per_cycle);
+       assert (samples <= samples_per_cycle);
 
        switch (type) {
          case Raw:
                for (size_t channel = 0; channel < n_channels; ++channel) {
-                       region.read (buffers.get_audio (channel).data(), position - region_start, frames, channel);
+                       region.read (buffers.get_audio (channel).data(), position - region_start, samples, channel);
                }
                break;
          case Fades:
                assert (mixdown_buffer && gain_buffer);
                for (size_t channel = 0; channel < n_channels; ++channel) {
-                       memset (mixdown_buffer.get(), 0, sizeof (Sample) * frames);
-                       region.read_at (buffers.get_audio (channel).data(), mixdown_buffer.get(), gain_buffer.get(), position, frames, channel);
+                       memset (mixdown_buffer.get(), 0, sizeof (Sample) * samples);
+                       buffers.get_audio (channel).silence(samples);
+                       region.read_at (buffers.get_audio (channel).data(), mixdown_buffer.get(), gain_buffer.get(), position, samples, channel);
                }
                break;
-         case Processed:
-               track.export_stuff (buffers, position, frames);
+       case Processed:
+               track.export_stuff (buffers, position, samples, track.main_outs(), true, true, false);
                break;
-         default:
+       default:
                throw ExportFailed ("Unhandled type in ExportChannelFactory::update_buffers");
        }
 
-       position += frames;
+       position += samples;
 }
 
 
@@ -209,9 +243,9 @@ RouteExportChannel::~RouteExportChannel()
 }
 
 void
-RouteExportChannel::create_from_route(std::list<ExportChannelPtr> & result, Route & route)
+RouteExportChannel::create_from_route(std::list<ExportChannelPtr> & result, boost::shared_ptr<Route> route)
 {
-       boost::shared_ptr<CapturingProcessor> processor = route.add_export_point();
+       boost::shared_ptr<CapturingProcessor> processor = route->add_export_point();
        uint32_t channels = processor->input_streams().n_audio();
 
        boost::shared_ptr<ProcessorRemover> remover (new ProcessorRemover (route, processor));
@@ -222,30 +256,34 @@ RouteExportChannel::create_from_route(std::list<ExportChannelPtr> & result, Rout
 }
 
 void
-RouteExportChannel::set_max_buffer_size(framecnt_t frames)
+RouteExportChannel::set_max_buffer_size(samplecnt_t samples)
 {
        if (processor) {
-               processor->set_block_size (frames);
+               processor->set_block_size (samples);
        }
 }
 
 void
-RouteExportChannel::read (Sample const *& data, framecnt_t frames) const
+RouteExportChannel::read (Sample const *& data, samplecnt_t samples) const
 {
        assert(processor);
        AudioBuffer const & buffer = processor->get_capture_buffers().get_audio (channel);
-       assert (frames <= (framecnt_t) buffer.size());
+#ifndef NDEBUG
+       (void) samples;
+#else
+       assert (samples <= (samplecnt_t) buffer.capacity());
+#endif
        data = buffer.data();
 }
 
 void
-RouteExportChannel::get_state (XMLNode * node) const
+RouteExportChannel::get_state (XMLNode *) const
 {
        // TODO
 }
 
 void
-RouteExportChannel::set_state (XMLNode * node, Session & session)
+RouteExportChannel::set_state (XMLNode *, Session &)
 {
        // TODO
 }
@@ -266,5 +304,5 @@ RouteExportChannel::operator< (ExportChannel const & other) const
 
 RouteExportChannel::ProcessorRemover::~ProcessorRemover()
 {
-       route.remove_processor (processor);
+       route->remove_processor (processor);
 }