PWMDriverBase.h

Go to the documentation of this file.

#pragma once
 
#include "AudioToolsConfig.h"
#ifdef USE_PWM
 
#include "AudioTools/CoreAudio/AudioBasic/Collections.h"
#include "AudioTools.h"
#include "AudioTools/CoreAudio/AudioLogger.h"
#include "AudioTools/CoreAudio/AudioOutput.h"
#include "AudioTools/CoreAudio/AudioTypes.h"
 
#define READ_ERROR_MSG "Could not read full data"
 
namespace audio_tools {
 
// forward declarations
// Callback for user
typedef bool (*PWMCallbackType)(uint8_t channels, int16_t *data);
// Callback used by system
static void defaultPWMAudioOutputCallback();
// Driver classes
class PWMDriverESP32;
class PWMDriverRP2040;
class PWMDriverMBED;
class PWMDriverSTM32;
 
struct PWMConfig : public AudioInfo {
  PWMConfig() {
    // default basic information
    sample_rate = 8000u;  // sample rate in Hz
    channels = 1;
    bits_per_sample = 16;
  }
 
  uint16_t buffer_size = PWM_BUFFER_SIZE;
  uint8_t buffers = PWM_BUFFER_COUNT;
 
  uint32_t pwm_frequency = 0;  // audable range is from 20 to
  uint8_t resolution = 8;  
  uint8_t timer_id = 0;    
 
  uint16_t dead_time_us = 0;
 
  uint32_t max_sample_rate = PWM_MAX_SAMPLE_RATE;
 
#ifndef __AVR__
  uint16_t start_pin = PIN_PWM_START;
 
  template <typename T, int N>
  void setPins(T (&a)[N]) {
    pins_data.clear();
    pins_data.resize(N);
    for (int i = 0; i < N; ++i) {
      pins_data[i] = a[i];  // reset all elements
    }
  }
 
  void setPins(Pins &pins) {
    pins_data.clear();
    for (int i = 0; i < pins.size(); i++) {
      pins_data.push_back(pins[i]);
    }
  }
 
  Pins &pins() {
    if (pins_data.size() == 0) {
      pins_data.resize(channels);
      for (int j = 0; j < channels; j++) {
        pins_data[j] = start_pin + j;
      }
    }
    return pins_data;
  }
 
#endif
 
  void logConfig() {
    LOGI("sample_rate: %d", (int) sample_rate);
    LOGI("channels: %d", channels);
    LOGI("bits_per_sample: %u", bits_per_sample);
    LOGI("buffer_size: %u", buffer_size);
    LOGI("buffer_count: %u", buffers);
    LOGI("pwm_frequency: %u", (unsigned)pwm_frequency);
    LOGI("resolution: %d", resolution);
    LOGI("dead_time_us: %u", dead_time_us);
    // LOGI("timer_id: %d", timer_id);
  }
 
 protected:
  Pins pins_data;
};
 
class DriverPWMBase {
 public:
  DriverPWMBase() = default;
  virtual ~DriverPWMBase() { end(); }
 
  PWMConfig &audioInfo() { return audio_config; }
 
  virtual PWMConfig defaultConfig() {
    PWMConfig cfg;
    return cfg;
  }
 
  // restart with prior definitions
  bool begin(PWMConfig cfg) {
    TRACEI();
 
    decimation_factor = 0;
    audio_config = cfg;
    decimate.setChannels(cfg.channels);
    decimate.setBits(cfg.bits_per_sample);
    decimate.setFactor(decimation());
    frame_size = audio_config.channels * (audio_config.bits_per_sample / 8);
    if (audio_config.channels > maxChannels()) {
      LOGE("Only max %d channels are supported!", maxChannels());
      return false;
    }
 
    if (buffer == nullptr) {
      LOGI("->Allocating new buffer %d * %d bytes", audio_config.buffers,
           audio_config.buffer_size);
      // buffer = new NBuffer<uint8_t>(audio_config.buffer_size,
      // audio_config.buffers);
      buffer = new RingBuffer<uint8_t>(audio_config.buffer_size *
                                       audio_config.buffers);
    }
 
    // initialize if necessary
    if (!isTimerStarted() || !cfg.equals(actual_info)) {
      audio_config.logConfig();
      actual_info = cfg;
      setupPWM();
      setupTimer();
    }
 
    // reset class variables
    underflow_count = 0;
    underflow_per_second = 0;
    frame_count = 0;
    frames_per_second = 0;
 
    LOGI("->Buffer available: %d", buffer->available());
    LOGI("->Buffer available for write: %d", buffer->availableForWrite());
    LOGI("->is_timer_started: %s ", isTimerStarted() ? "true" : "false");
    return true;
  }
 
  virtual int availableForWrite() {
    // return is_blocking_write
    //            ? audio_config.buffer_size
    //            : buffer->availableForWrite() / frame_size * frame_size;
    // we must not write anything bigger then the buffer size
    return buffer->size() / frame_size * frame_size;
  }
 
  // blocking write for an array: we expect a singed value and convert it into a
  // unsigned
  virtual size_t write(const uint8_t *data, size_t len) {
    size_t size = len;
 
    // only allow full frame
    size = (size / frame_size) * frame_size;
    LOGD("adjusted size: %d", (int)size);
 
    if (isDecimateActive()) {
      size = decimate.convert((uint8_t *)data, size);
      LOGD("decimated size: %d", (int)size);
    }
 
    if (is_blocking_write && buffer->availableForWrite() < size) {
      LOGD("Waiting for buffer to be available");
      while (buffer->availableForWrite() < size) delay(5);
    } else {
      size = min((size_t)availableForWrite(), size);
    }
 
    size_t result = buffer->writeArray(data, size);
    if (result != size) {
      LOGW("Could not write all data: %u -> %d", (unsigned)size, result);
    }
    // activate the timer now - if not already done
    if (!is_timer_started) startTimer();
 
    // adjust the result by the descimation
    if (isDecimateActive()) {
      result = result * decimation();
    }
    //LOGD("write %u -> %u", len, result);
    return result;
  }
 
  // When the timer does not have enough data we increase the underflow_count;
  uint32_t underflowsPerSecond() { return underflow_per_second; }
  // provides the effectivly measured output frames per second
  uint32_t framesPerSecond() { return frames_per_second; }
 
  inline void updateStatistics() {
    frame_count++;
    if (millis() >= time_1_sec) {
      time_1_sec = millis() + 1000;
      frames_per_second = frame_count;
      underflow_per_second = underflow_count;
      underflow_count = 0;
      frame_count = 0;
    }
  }
 
  bool isTimerStarted() { return is_timer_started; }
 
  virtual void setupPWM() = 0;
  virtual void setupTimer() = 0;
  virtual void startTimer() = 0;
  virtual int maxChannels() = 0;
  virtual int maxOutputValue() = 0;
  virtual void end() {};
 
  virtual void pwmWrite(int channel, int value) = 0;
 
  void setBuffer(BaseBuffer<uint8_t> *buffer) { this->buffer = buffer; }
 
  virtual int effectiveOutputSampleRate() {
    return audio_config.sample_rate / decimation();
  }
 
 protected:
  PWMConfig audio_config;
  AudioInfo actual_info;
  BaseBuffer<uint8_t> *buffer = nullptr;
  uint32_t underflow_count = 0;
  uint32_t underflow_per_second = 0;
  uint32_t frame_count = 0;
  uint32_t frames_per_second = 0;
  uint32_t frame_size = 0;
  uint32_t time_1_sec;
  bool is_timer_started = false;
  bool is_blocking_write = true;
  Decimate decimate;
  int decimation_factor = 0;
 
  void deleteBuffer() {
    // delete buffer if necessary
    if (buffer != nullptr) {
      delete buffer;
      buffer = nullptr;
    }
  }
 
  void playNextFrame() {
    if (isTimerStarted() && buffer != nullptr) {
      // TRACED();
      int required = (audio_config.bits_per_sample / 8) * audio_config.channels;
      if (buffer->available() >= required) {
        for (int j = 0; j < audio_config.channels; j++) {
          int value = nextValue();
          pwmWrite(j, value);
        }
      } else {
        underflow_count++;
      }
      updateStatistics();
    }
  }
 
  virtual int nextValue() {
    int result = 0;
    switch (audio_config.bits_per_sample) {
      case 8: {
        int8_t value;
        if (buffer->readArray((uint8_t *)&value, 1) != 1) {
          LOGE(READ_ERROR_MSG);
        }
        result = map(value, -NumberConverter::maxValue(8),
                     NumberConverter::maxValue(8), 0, maxOutputValue());
        break;
      }
      case 16: {
        int16_t value;
        if (buffer->readArray((uint8_t *)&value, 2) != 2) {
          LOGE(READ_ERROR_MSG);
        }
        result = map(value, -NumberConverter::maxValue(16),
                     NumberConverter::maxValue(16), 0, maxOutputValue());
        break;
      }
      case 24: {
        int24_t value;
        if (buffer->readArray((uint8_t *)&value, 3) != 3) {
          LOGE(READ_ERROR_MSG);
        }
        result = map((int32_t)value, -NumberConverter::maxValue(24),
                     NumberConverter::maxValue(24), 0, maxOutputValue());
        break;
      }
      case 32: {
        int32_t value;
        if (buffer->readArray((uint8_t *)&value, 4) != 4) {
          LOGE(READ_ERROR_MSG);
        }
        result = map(value, -NumberConverter::maxValue(32),
                     NumberConverter::maxValue(32), 0, maxOutputValue());
        break;
      }
    }
    return result;
  }
 
  virtual int maxSampleRate() { return audio_config.max_sample_rate; }
 
  virtual bool isDecimateActive() {
    return audio_config.sample_rate >= audio_config.max_sample_rate;
  }
 
  virtual int decimation() { 
    if (decimation_factor == 0){
      for (int j = 1; j < 20; j++){
          if (audio_config.sample_rate / j <= audio_config.max_sample_rate){
            decimation_factor = j;
            LOGI("Decimation factor: %d" ,j);
            return j;
          }
      }
      decimation_factor = 1;
      LOGI("Decimation factor: %d", (int)decimation_factor);
    }
  
    return decimation_factor; 
  }
};
 
}  // namespace audio_tool
 
#endif