libs/ardour/delayline.cc

   1 /*
   2     Copyright (C) 2006, 2013 Paul Davis
   3     Copyright (C) 2013, 2014 Robin Gareus <robin@gareus.org>
   4
   5     This program is free software; you can redistribute it and/or modify it
   6     under the terms of the GNU General Public License as published by the Free
   7     Software Foundation; either version 2 of the License, or (at your option)
   8     any later version.
   9
  10     This program is distributed in the hope that it will be useful, but WITHOUT
  11     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13     for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #include <assert.h>
  21 #include <cmath>
  22
  23 #include "pbd/compose.h"
  24
  25 #include "ardour/debug.h"
  26 #include "ardour/audio_buffer.h"
  27 #include "ardour/midi_buffer.h"
  28 #include "ardour/buffer_set.h"
  29 #include "ardour/delayline.h"
  30
  31 using namespace std;
  32 using namespace PBD;
  33 using namespace ARDOUR;
  34
  35 DelayLine::DelayLine (Session& s, const std::string& name)
  36     : Processor (s, string_compose ("latency-compensation-%1-%2", name, this))
  37                 , _delay(0)
  38                 , _pending_delay(0)
  39                 , _bsiz(0)
  40                 , _pending_bsiz(0)
  41                 , _roff(0)
  42                 , _woff(0)
  43                 , _pending_flush(false)
  44 {
  45 }
  46
  47 DelayLine::~DelayLine ()
  48 {
  49 }
  50
  51 #define FADE_LEN (16)
  52 void
  53 DelayLine::run (BufferSet& bufs, framepos_t /* start_frame */, framepos_t /* end_frame */, double /* speed */, pframes_t nsamples, bool)
  54 {
  55         const uint32_t chn = _configured_output.n_audio();
  56         pframes_t p0 = 0;
  57         uint32_t c;
  58
  59         const frameoffset_t pending_delay = _pending_delay;
  60         const frameoffset_t delay_diff = _delay - pending_delay;
  61         const bool pending_flush = _pending_flush;
  62         _pending_flush = false;
  63
  64         /* run() and set_delay() may be called in parallel by
  65          * different threads.
  66          * if a larger buffer is needed, it is allocated in
  67          * set_delay(), here it is just swap'ed in place
  68          */
  69         if (_pending_bsiz) {
  70                 assert(_pending_bsiz >= _bsiz);
  71
  72                 const size_t boff = _pending_bsiz - _bsiz;
  73                 if (_bsiz > 0) {
  74                         /* write offset is retained. copy existing data to new buffer */
  75                         frameoffset_t wl = _bsiz - _woff;
  76                         memcpy(_pending_buf.get(), _buf.get(), sizeof(Sample) * _woff * chn);
  77                         memcpy(_pending_buf.get() + (_pending_bsiz - wl) * chn, _buf.get() + _woff * chn, sizeof(Sample) * wl * chn);
  78
  79                         /* new buffer is all zero by default, fade into the existing data copied above */
  80                         frameoffset_t wo = _pending_bsiz - wl;
  81                         for (pframes_t pos = 0; pos < FADE_LEN; ++pos) {
  82                                 const gain_t gain = (gain_t)pos / (gain_t)FADE_LEN;
  83                                 for (c = 0; c < _configured_output.n_audio(); ++c) {
  84                                         _pending_buf.get()[ wo * chn + c ] *= gain;
  85                                         wo = (wo + 1) % (_pending_bsiz + 1);
  86                                 }
  87                         }
  88
  89                         /* read-pointer will be moved and may up anywhere..
  90                          * copy current data for smooth fade-out below
  91                          */
  92                         frameoffset_t roold = _roff;
  93                         frameoffset_t ro = _roff;
  94                         if (ro > _woff) {
  95                                 ro += boff;
  96                         }
  97                         ro += delay_diff;
  98                         if (ro < 0) {
  99                                 ro -= (_pending_bsiz + 1) * floor(ro / (float)(_pending_bsiz + 1));
 100                         }
 101                         ro = ro % (_pending_bsiz + 1);
 102                         for (pframes_t pos = 0; pos < FADE_LEN; ++pos) {
 103                                 for (c = 0; c < _configured_output.n_audio(); ++c) {
 104                                         _pending_buf.get()[ ro * chn + c ] = _buf.get()[ roold * chn + c ];
 105                                 }
 106                                 ro = (ro + 1) % (_pending_bsiz + 1);
 107                                 roold = (roold + 1) % (_bsiz + 1);
 108                         }
 109                 }
 110
 111                 if (_roff > _woff) {
 112                         _roff += boff;
 113                 }
 114
 115                 // use shared_array::swap() ??
 116                 _buf = _pending_buf;
 117                 _bsiz = _pending_bsiz;
 118                 _pending_bsiz = 0;
 119                 _pending_buf.reset();
 120         }
 121
 122         /* there may be no buffer when delay == 0.
 123          * we also need to check audio-channels in case all audio-channels
 124          * were removed in which case no new buffer was allocated. */
 125         Sample *buf = _buf.get();
 126         if (buf && _configured_output.n_audio() > 0) {
 127
 128                 assert (_bsiz >= pending_delay);
 129                 const framecnt_t rbs = _bsiz + 1;
 130
 131                 if (pending_delay != _delay || pending_flush) {
 132                         const pframes_t fade_len = (nsamples >= FADE_LEN) ? FADE_LEN : nsamples / 2;
 133
 134                         DEBUG_TRACE (DEBUG::LatencyCompensation,
 135                                         string_compose ("Old %1 delay: %2 bufsiz: %3 offset-diff: %4 write-offset: %5 read-offset: %6\n",
 136                                                 name(), _delay, _bsiz, ((_woff - _roff + rbs) % rbs), _woff, _roff));
 137
 138                         // fade out at old position
 139                         c = 0;
 140                         for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end() && c <= chn; ++i, ++c) {
 141                                 Sample * const data = i->data();
 142                                 frameoffset_t roff = _roff;
 143                                 frameoffset_t woff = _woff;
 144                                 for (pframes_t pos = 0; pos < fade_len; ++pos) {
 145                                         const gain_t gain = (gain_t)(fade_len - pos) / (gain_t)fade_len;
 146                                         buf[ woff * chn + c ] = data[ pos ];
 147                                         data[ pos ] = buf[ roff * chn + c ] * gain;
 148                                         roff = (roff + 1) % rbs;
 149                                         woff = (woff + 1) % rbs;
 150                                 }
 151                         }
 152                         _roff = (_roff + fade_len) % rbs;
 153                         _woff = (_woff + fade_len) % rbs;
 154
 155                         if (pending_flush) {
 156                                 DEBUG_TRACE (DEBUG::LatencyCompensation,
 157                                                 string_compose ("Flush buffer: %1\n", name()));
 158                                 memset(buf, 0, _configured_output.n_audio() * rbs * sizeof (Sample));
 159                         }
 160
 161                         // adjust read pointer
 162                         _roff += _delay - pending_delay;
 163
 164                         if (_roff < 0) {
 165                                 _roff -= rbs * floor(_roff / (float)rbs);
 166                         }
 167                         _roff = _roff % rbs;
 168
 169                         // fade in at new position
 170                         c = 0;
 171                         for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end() && c <= chn; ++i, ++c) {
 172                                 Sample * const data = i->data();
 173                                 frameoffset_t roff = _roff;
 174                                 frameoffset_t woff = _woff;
 175                                 for (pframes_t pos = fade_len; pos < 2 * fade_len; ++pos) {
 176                                         const gain_t gain = (gain_t)(pos - fade_len) / (gain_t)fade_len;
 177                                         buf[ woff * chn + c ] = data[ pos ];
 178                                         data[ pos ] = buf[ roff * chn + c ] * gain;
 179                                         roff = (roff + 1) % rbs;
 180                                         woff = (woff + 1) % rbs;
 181                                 }
 182                         }
 183                         _roff = (_roff + fade_len) % rbs;
 184                         _woff = (_woff + fade_len) % rbs;
 185                         p0  = 2 * fade_len;
 186
 187                         _delay = pending_delay;
 188
 189                         DEBUG_TRACE (DEBUG::LatencyCompensation,
 190                                         string_compose ("New %1 delay: %2 bufsiz: %3 offset-diff: %4 write-offset: %5 read-offset: %6\n",
 191                                                 name(), _delay, _bsiz, ((_woff - _roff + rbs) % rbs), _woff, _roff));
 192                 }
 193
 194                 assert(_delay == ((_woff - _roff + rbs) % rbs));
 195
 196                 c = 0;
 197                 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end() && c <= chn; ++i, ++c) {
 198                         Sample * const data = i->data();
 199                         frameoffset_t roff = _roff;
 200                         frameoffset_t woff = _woff;
 201                         for (pframes_t pos = p0; pos < nsamples; ++pos) {
 202                                 buf[ woff * chn + c ] = data[ pos ];
 203                                 data[ pos ] = buf[ roff * chn + c ];
 204                                 roff = (roff + 1) % rbs;
 205                                 woff = (woff + 1) % rbs;
 206                         }
 207                 }
 208                 _roff = (_roff + nsamples) % rbs;
 209                 _woff = (_woff + nsamples) % rbs;
 210         }
 211
 212         if (_midi_buf.get()) {
 213                 _delay = pending_delay;
 214
 215                 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
 216                         if (i != bufs.midi_begin()) { break; } // XXX only one buffer for now
 217
 218                         MidiBuffer* dly = _midi_buf.get();
 219                         MidiBuffer& mb (*i);
 220                         if (pending_flush) {
 221                                 dly->silence(nsamples);
 222                         }
 223
 224                         // If the delay time changes, iterate over all events in the dly-buffer
 225                         // and adjust the time in-place. <= 0 becomes 0.
 226                         //
 227                         // iterate over all events in dly-buffer and subtract one cycle
 228                         // (nsamples) from the timestamp, bringing them closer to de-queue.
 229                         for (MidiBuffer::iterator m = dly->begin(); m != dly->end(); ++m) {
 230                                 MidiBuffer::TimeType *t = m.timeptr();
 231                                 if (*t > nsamples + delay_diff) {
 232                                         *t -= nsamples + delay_diff;
 233                                 } else {
 234                                         *t = 0;
 235                                 }
 236                         }
 237
 238                         if (_delay != 0) {
 239                                 // delay events in current-buffer, in place.
 240                                 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
 241                                         MidiBuffer::TimeType *t = m.timeptr();
 242                                         *t += _delay;
 243                                 }
 244                         }
 245
 246                         // move events from dly-buffer into current-buffer until nsamples
 247                         // and remove them from the dly-buffer
 248                         for (MidiBuffer::iterator m = dly->begin(); m != dly->end();) {
 249                                 const Evoral::Event<MidiBuffer::TimeType> ev (*m, false);
 250                                 if (ev.time() >= nsamples) {
 251                                         break;
 252                                 }
 253                                 mb.insert_event(ev);
 254                                 m = dly->erase(m);
 255                         }
 256
 257                         /* For now, this is only relevant if there is there's a positive delay.
 258                          * In the future this could also be used to delay 'too early' events
 259                          * (ie '_global_port_buffer_offset + _port_buffer_offset' - midi_port.cc)
 260                          */
 261                         if (_delay != 0) {
 262                                 // move events after nsamples from current-buffer into dly-buffer
 263                                 // and trim current-buffer after nsamples
 264                                 for (MidiBuffer::iterator m = mb.begin(); m != mb.end();) {
 265                                         const Evoral::Event<MidiBuffer::TimeType> ev (*m, false);
 266                                         if (ev.time() < nsamples) {
 267                                                 ++m;
 268                                                 continue;
 269                                         }
 270                                         dly->insert_event(ev);
 271                                         m = mb.erase(m);
 272                                 }
 273                         }
 274                 }
 275         }
 276
 277         _delay = pending_delay;
 278 }
 279
 280 void
 281 DelayLine::set_delay(framecnt_t signal_delay)
 282 {
 283         if (signal_delay < 0) {
 284                 signal_delay = 0;
 285                 cerr << "WARNING: latency compensation is not possible.\n";
 286         }
 287
 288         DEBUG_TRACE (DEBUG::LatencyCompensation,
 289                         string_compose ("%1 set_delay to %2 samples for %3 channels\n",
 290                                 name(), signal_delay, _configured_output.n_audio()));
 291
 292         if (signal_delay <= _bsiz) {
 293                 _pending_delay = signal_delay;
 294                 return;
 295         }
 296
 297         if (_pending_bsiz) {
 298                 if (_pending_bsiz < signal_delay) {
 299                         cerr << "LatComp: buffer resize in progress. "<< name() << "pending: "<< _pending_bsiz <<" want: " << signal_delay <<"\n"; // XXX
 300                 } else {
 301                         _pending_delay = signal_delay;
 302                 }
 303                 return;
 304         }
 305
 306         allocate_pending_buffers (signal_delay);
 307
 308         _pending_delay = signal_delay;
 309
 310         DEBUG_TRACE (DEBUG::LatencyCompensation,
 311                         string_compose ("allocated buffer for %1 of size %2\n",
 312                                 name(), signal_delay));
 313 }
 314
 315 bool
 316 DelayLine::can_support_io_configuration (const ChanCount& in, ChanCount& out)
 317 {
 318         out = in;
 319         return true;
 320 }
 321
 322 void
 323 DelayLine::allocate_pending_buffers (framecnt_t signal_delay)
 324 {
 325         assert (signal_delay >= 0);
 326         const framecnt_t rbs = signal_delay + 1;
 327
 328         if (_configured_output.n_audio() > 0 ) {
 329                 _pending_buf.reset(new Sample[_configured_output.n_audio() * rbs]);
 330                 memset(_pending_buf.get(), 0, _configured_output.n_audio() * rbs * sizeof (Sample));
 331                 _pending_bsiz = signal_delay;
 332         } else {
 333                 _pending_buf.reset();
 334                 _pending_bsiz = 0;
 335         }
 336 }
 337
 338 bool
 339 DelayLine::configure_io (ChanCount in, ChanCount out)
 340 {
 341         if (out != in) { // always 1:1
 342                 return false;
 343         }
 344
 345         if (_configured_output != out) {
 346                 // run() won't be called concurrently, so it's
 347                 // save for replace existing _pending_buf.
 348                 //
 349                 // configure_io is either called with process-lock held
 350                 // from route's configure_io() or by use_target() from the c'tor.
 351                 allocate_pending_buffers (_pending_delay);
 352         }
 353
 354         DEBUG_TRACE (DEBUG::LatencyCompensation,
 355                         string_compose ("configure IO: %1 Ain: %2 Aout: %3 Min: %4 Mout: %5\n",
 356                                 name(), in.n_audio(), out.n_audio(), in.n_midi(), out.n_midi()));
 357
 358         // TODO support multiple midi buffers
 359         if (in.n_midi() > 0 && !_midi_buf) {
 360                 _midi_buf.reset(new MidiBuffer(16384));
 361         }
 362
 363         return Processor::configure_io (in, out);
 364 }
 365
 366 void
 367 DelayLine::flush()
 368 {
 369         _pending_flush = true;
 370 }
 371
 372 XMLNode&
 373 DelayLine::state (bool full_state)
 374 {
 375         XMLNode& node (Processor::state (full_state));
 376         node.set_property("type", "delay");
 377         return node;
 378 }