MicroMDAEPiano/effect_modulated_delay.cpp

/* Audio Library for Teensy 3.X
   Copyright (c) 2014, Pete (El Supremo)
   Copyright (c) 2019, Holger Wirtz

   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to deal
   in the Software without restriction, including without limitation the rights
   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
*/

#include <Arduino.h>
#include <Audio.h>
#include "limits.h"
#include "effect_modulated_delay.h"
#include "interpolation.h"
#include "config.h"

/******************************************************************/

// Based on;      A u d i o E f f e c t C h o r u s
// Written by Pete (El Supremo) Jan 2014
// 140529 - change to handle mono stream - change modify() to voices()
// 140219 - correct storage class (not static)
// 190527 - added modulation input (by Holger Wirtz)

boolean AudioEffectModulatedDelay::begin(short *delayline, int d_length)
{
#if 0
  Serial.print("AudioEffectModulatedDelay.begin(Chorus delay line length = ");
  Serial.print(d_length);
  Serial.println(")");
#endif

  _delayline = NULL;
  _delay_length = 0;
  _circ_idx = 0;

  if (delayline == NULL) {
    return (false);
  }
  if (d_length < 10) {
    return (false);
  }

  _delayline = delayline;
  _delay_length = _max_delay_length = d_length;
  _delay_length_half = _delay_length / 2;

  memset(_delayline, 0, sizeof(int16_t)*_delay_length);

  return (true);
}

void AudioEffectModulatedDelay::update(void)
{
  audio_block_t *block;
  audio_block_t *modulation;

  int16_t *bp;
  int16_t *mp;
  float mod_idx;

  if (_delayline == NULL)
    return;

#ifdef INTERPOLATE
  interpolation modulation_interpolate;
#endif

  block = receiveWritable(0);
  modulation = receiveReadOnly(1);

#ifdef INTERPOLATE
  int8_t j;
  float x[INTERPOLATION_WINDOW_SIZE];
  float y[INTERPOLATION_WINDOW_SIZE];
  modulation_interpolate.valuelenXY(INTERPOLATION_WINDOW_SIZE);
  modulation_interpolate.valueX(x);
  modulation_interpolate.valueY(y);
#endif

  bp = block->data;
  mp = modulation->data;

  if (block && modulation)
  {
    for (uint16_t i = 0; i < AUDIO_BLOCK_SAMPLES; i++)
    {
      // write data into circular buffer
      if (_circ_idx >= _delay_length)
        _circ_idx = 0;
      _delayline[_circ_idx] = *bp;

      // calculate modulation index
      mod_idx = float(*mp) / SHRT_MAX * _delay_length_half; // calculate an index with modulation as a float(!!!)

#ifdef INTERPOLATE
      // get x/y values around mod_idx
      uint8_t c = 0;
      int16_t c_mod_idx = int(mod_idx + 0.5) + _circ_idx;
      for (j = INTERPOLATION_WINDOW_SIZE / -2; j <= INTERPOLATION_WINDOW_SIZE / 2; j++)
      {
        int16_t jc_mod_idx = (c_mod_idx + j) % _delay_length;
        if (jc_mod_idx < 0)
          y[c] = float(_delayline[_delay_length + jc_mod_idx]);
        else
          y[c] = float(_delayline[jc_mod_idx]);
        x[c] = float(c);
        c++; // because 42 is the answer! ;-)
      }

      modulation_interpolate.valueI(mod_idx - int(mod_idx + 0.5));

#if INTERPOLATE == LINEAR
      *bp = int(modulation_interpolate.LinearInterpolate() + 0.5);
#elif INTERPOLATE == QUDRATIC
      *bp = int(modulation_interpolate.QuadraticInterpolate() + 0.5);
#elif INTERPOLATE == COSINE
      *bp = int(modulation_interpolate.CosineInterpolate() + 0.5);
#elif INTERPOLATE == CUBIC
      *bp = int(modulation_interpolate.CubicInterpolate() + 0.5);
#elif INTERPOLATE == LAGRANGE
      *bp = int(modulation_interpolate.LagrangeInterpolate() + 0.5);
#else
      // No interpolation - should sound really bad...
      int16_t c_mod_idx = int(mod_idx + 0.5) + _circ_idx;
      if (c_mod_idx < 0)
        *bp = _delayline[_delay_length + c_mod_idx];
      else
        *bp = _delayline[c_mod_idx];
#endif
#else
      // No interpolation - should sound really bad...
      int16_t c_mod_idx = int(mod_idx + 0.5) + _circ_idx;
      if (c_mod_idx < 0)
        *bp = _delayline[_delay_length + c_mod_idx];
      else
        *bp = _delayline[c_mod_idx];
#endif

      bp++;
      mp++;
      _circ_idx++;
    }
  }

  if (block)
  {
    transmit(block, 0);
    release(block);
  }

  if (modulation)
    release(modulation);
}

void AudioEffectModulatedDelay::setDelayLength(float milliseconds)
{
  _delay_length = min(AUDIO_SAMPLE_RATE / milliseconds, _max_delay_length);
  _delay_length_half = _delay_length / 2;
}

float AudioEffectModulatedDelay::getMaxDelayLength(void)
{
  return (AUDIO_SAMPLE_RATE / _max_delay_length);
}