R2ROutput.h

Go to the documentation of this file.

#pragma once
 
#include "AudioToolsConfig.h"
#include "AudioTools/CoreAudio/AudioTimer/AudioTimer.h"
#include "AudioTools/CoreAudio/AudioLogger.h"
#include "AudioTools/CoreAudio/AudioOutput.h"
#include "AudioTools/CoreAudio/Buffers.h"
#include "AudioTools/CoreAudio/AudioBasic/Collections/Vector.h"
namespace audio_tools {
 
class R2RDriverBase {
 public:
  virtual void setupPins(Vector<int> &channel1_pins,
                         Vector<int> &channel2_pins) = 0;
 
  virtual void writePins(int channels, int channel, unsigned uvalue) = 0;
};
 
class R2RDriver : public R2RDriverBase {
 public:
  void setupPins(Vector<int> &channel1_pins,
                         Vector<int> &channel2_pins) override {
    TRACED();
    p_channel1_pins = &channel1_pins;
    p_channel2_pins = &channel2_pins;
 
    for (auto pin : channel1_pins) {
      LOGI("Setup channel1 pin %d", pin);
      pinMode(pin, OUTPUT);
    }
    for (int pin : channel2_pins) {
      LOGI("Setup channel2 pin %d", pin);
      pinMode(pin, OUTPUT);
    }
  };
 
   void writePins(int channels, int channel, unsigned uvalue) override {
    switch (channel) {
      case 0:
        for (int j = 0; j < (*p_channel1_pins).size(); j++) {
          int pin = (*p_channel1_pins)[j];
          if (pin >= 0) digitalWrite(pin, (uvalue >> j) & 1);
        }
        break;
      case 1:
        for (int j = 0; j < (*p_channel2_pins).size(); j++) {
          int pin = (*p_channel2_pins)[j];
          if (pin >= 0) digitalWrite(pin, (uvalue >> j) & 1);
        }
        break;
    }
  }
 
 protected:
  Vector<int> *p_channel1_pins = nullptr;
  Vector<int> *p_channel2_pins = nullptr;
} r2r_driver;
 
class R2RConfig : public AudioInfo {
 public:
  Vector<int> channel1_pins;
  Vector<int> channel2_pins;
  uint16_t buffer_size = DEFAULT_BUFFER_SIZE;
  uint16_t buffer_count = 2;        // double buffer
  R2RDriverBase *driver = &r2r_driver;  // by default use Arduino driver
  bool is_blocking = true;
  int blocking_retry_delay_ms = 5;
  int timer_id = 0;
};
 
class R2ROutput : public AudioOutput {
 public:
  R2RConfig defaultConfig() {
    R2RConfig r;
    return r;
  }
 
  bool begin(R2RConfig c) {
    TRACED();
    cfg = c;
    rcfg = c;
    return begin();
  }
 
  bool begin() override {
    TRACED();
    if (cfg.channels == 0 || cfg.channels > 2) {
      LOGE("channels is %d", cfg.channels);
      return false;
    }
    if (rcfg.channel1_pins.size() == 0) {
      LOGE("channel1_pins not defined");
      return false;
    }
    if (cfg.channels == 2 &&
        rcfg.channel2_pins.size() != rcfg.channel1_pins.size()) {
      LOGE("channel2_pins not defined");
      return false;
    }
    if (rcfg.buffer_size * rcfg.buffer_count == 0) {
      LOGE("buffer_size or buffer_count is 0");
      return false;
    }
    buffer.resize(rcfg.buffer_size, rcfg.buffer_count);
    rcfg.driver->setupPins(rcfg.channel1_pins, rcfg.channel2_pins);
 
    // setup timer
    timer.setCallbackParameter(this);
    timer.setIsSave(true);
    timer.setTimer(rcfg.timer_id);
    return timer.begin(r2r_timer_callback, cfg.sample_rate, HZ);
  }
 
  size_t write(const uint8_t *data, size_t len) override {
    LOGD("write: %d", len);
    size_t result = 0;
    // if buffer has not been allocated (buffer_size==0)
    if (len > rcfg.buffer_size) {
      LOGE("buffer_size %d too small for write size: %d", rcfg.buffer_size,
           len);
      return len;
    }
 
    if (rcfg.is_blocking){
      // write of all bytes
      int open = len;
      while(open > 0){
        int written = buffer.writeArray(data + result, open);
        open -= written;
        result += written;
        if (open > 0){
          delay(rcfg.blocking_retry_delay_ms);
        }
      }
    } else {
      // write as much as possible
      result = buffer.writeArray(data, len);
    }
    // activate output when buffer is half full
    if (!is_active && buffer.bufferCountFilled() >= rcfg.buffer_count / 2) {
      LOGI("is_active = true");
      is_active = true;
    }
 
    return result;
  }
 
 protected:
  TimerAlarmRepeating timer;
  // Double buffer
  NBuffer<uint8_t> buffer{DEFAULT_BUFFER_SIZE, 0};
  R2RConfig rcfg;
 
  void writeValue(int channel) {
    switch (cfg.bits_per_sample) {
      case 8:
        return writeValueT<int8_t>(channel);
      case 16:
        return writeValueT<int16_t>(channel);
      case 24:
        return writeValueT<int24_t>(channel);
      case 32:
        return writeValueT<int32_t>(channel);
    }
  }
 
  template <typename T>
  void writeValueT(int channel) {
    // don't do anything if we do not have enough data
    if (buffer.available() < sizeof(T)) return;
 
    // get next value from buffer
    T value = 0;
    buffer.readArray((uint8_t *)&value, sizeof(T));
    // convert to unsigned
    unsigned uvalue = (int)value + NumberConverter::maxValueT<T>() + 1;
    // scale value
    uvalue = uvalue >> ((sizeof(T) * 8) - rcfg.channel1_pins.size());
    // Serial.println(uvalue);
 
    // output pins
    rcfg.driver->writePins(cfg.channels, channel, uvalue);
  }
 
  static void r2r_timer_callback(void *ptr) {
    R2ROutput *self = (R2ROutput *)ptr;
    if (self->is_active) {
      // output channel 1
      self->writeValue(0);
      // output channel 2
      if (self->cfg.channels == 2) self->writeValue(1);
    };
  }
};
 
}  // namespace audio_tools