Allocator.h

Go to the documentation of this file.

#pragma once
#include <stdlib.h>
#include <string.h>
 
#include "AudioToolsConfig.h"
#include "AudioTools/CoreAudio/AudioLogger.h"
// Some top level functions: stop(), checkMemory()
#include "AudioTools/CoreAudio/AudioRuntime.h"
 
namespace audio_tools {
 
class Allocator {
 public:
  // creates an object
  template <class T>
  T* create() {
    void* addr = allocate(sizeof(T));
    // call constructor
    T* ref = new (addr) T();
    return ref;
  }
 
  template <class T>
  void remove(T* obj) {
    if (obj == nullptr) return;
    obj->~T();
    free((void*)obj);
  }
 
  // creates an array of objects
  template <class T>
  T* createArray(int len) {
    void* addr = allocate(sizeof(T) * len);
    T* addrT = (T*)addr;
    // call constructor
#ifndef NO_INPLACE_INIT_SUPPORT
    for (int j = 0; j < len; j++) new (addrT + j) T();
#else
    T default_value;
    for (int j = 0; j < len; j++) {
      memcpy((uint8_t*)addr + (j * sizeof(T)), &default_value, sizeof(T));
    }
#endif
    return (T*)addr;
  }
 
  // deletes an array of objects
  template <class T>
  void removeArray(T* obj, int len) {
    if (obj == nullptr) return;
    for (int j = 0; j < len; j++) {
      obj[j].~T();
    }
    free((void*)obj);
  }
 
  virtual void* allocate(size_t size) {
    void* result = do_allocate(size);
    if (result == nullptr) {
      LOGE("Allocateation failed for %zu bytes", size);
      stop();
    } else {
      LOGD("Allocated %zu", size);
    }
    return result;
  }
 
  virtual void free(void* memory) {
    if (memory != nullptr) ::free(memory);
  }
 
 protected:
  virtual void* do_allocate(size_t size) {
    return calloc(1, size == 0 ? 1 : size);
  }
};
 
class AllocatorExt : public Allocator {
  void* do_allocate(size_t size) {
    void* result = nullptr;
    if (size == 0) size = 1;
#if defined(USE_PSRAM) && defined(ARDUINO)
    result = ps_malloc(size);
#endif
    if (result == nullptr) result = malloc(size);
    if (result == nullptr) {
      LOGE("allocateation failed for %zu bytes", size);
      stop();
    }
    // initialize object
    memset(result, 0, size);
    return result;
  }
};
 
#if (defined(ESP32)) && defined(ARDUINO)
 
class AllocatorESP32 : public Allocator {
 public:
  AllocatorESP32(int caps = MALLOC_CAP_8BIT | MALLOC_CAP_INTERNAL) {
    this->caps = caps;
  }
  void* do_allocate(size_t size) {
    void* result = nullptr;
    if (size == 0) size = 1;
    result = heap_caps_calloc(1, size, caps);
    if (result == nullptr) {
      LOGE("alloc failed for %zu bytes", size);
      stop();
    }
    return result;
  }
 
 protected:
  int caps = 0;
};
 
static AllocatorESP32 DefaultESP32AllocatorRAM;
 
#endif
 
#if defined(USE_PSRAM) && defined(ARDUINO)
 
class AllocatorPSRAM : public Allocator {
  void* do_allocate(size_t size) {
    if (size == 0) size = 1;
    void* result = nullptr;
    result = ps_calloc(1, size);
    if (result == nullptr) {
      LOGE("allocateation failed for %zu bytes", size);
      stop();
    }
    return result;
  }
};
 
#endif
 
#if defined(IS_ZEPHYR)
#include <zephyr/kernel.h>
 
class AllocatorZephyr : public Allocator {
 public:
  void* do_allocate(size_t size) override {
    if (size == 0) size = 1;
    void* result = k_malloc(size);
    if (result != nullptr) memset(result, 0, size);
    return result;
  }
 
  void free(void* memory) override {
    if (memory != nullptr) k_free(memory);
  }
};
using TAllocatorSTD = AllocatorZephyr;
using TAllocatorExt = AllocatorZephyr;
 
#else // defined(ZEPHYR)
// all non zephyr cases
using TAllocatorSTD = Allocator;
using TAllocatorExt = AllocatorExt;
#endif
 
static TAllocatorExt DefaultAllocator;
static TAllocatorSTD DefaultAllocatorRAM;
 
}  // namespace audio_tools