snapclient/components/audio_sal/audio_mem.c

/*
 * ESPRESSIF MIT License
 *
 * Copyright (c) 2018 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD>
 *
 * Permission is hereby granted for use on all ESPRESSIF SYSTEMS products, in
 * which case, it is 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 "audio_mem.h"
#include "esp_efuse.h"
#include "esp_heap_caps.h"
#include "esp_log.h"
#include "esp_system.h"
#include "sdkconfig.h"
#include "string.h"
#include <stdlib.h>

// #define ENABLE_AUDIO_MEM_TRACE

void *
audio_malloc (size_t size)
{
  void *data = NULL;
#if CONFIG_SPIRAM_BOOT_INIT
  data = heap_caps_malloc (size, MALLOC_CAP_SPIRAM | MALLOC_CAP_8BIT);
#else
  data = malloc (size);
#endif
#ifdef ENABLE_AUDIO_MEM_TRACE
  ESP_LOGI ("AUDIO_MEM", "malloc:%p, size:%d, called:0x%08x", data, size,
            (intptr_t)__builtin_return_address (0) - 2);
#endif
  return data;
}

void
audio_free (void *ptr)
{
  free (ptr);
#ifdef ENABLE_AUDIO_MEM_TRACE
  ESP_LOGI ("AUIDO_MEM", "free:%p, called:0x%08x", ptr,
            (intptr_t)__builtin_return_address (0) - 2);
#endif
}

void *
audio_calloc (size_t nmemb, size_t size)
{
  void *data = NULL;
#if CONFIG_SPIRAM_BOOT_INIT
  data = heap_caps_malloc (nmemb * size, MALLOC_CAP_SPIRAM | MALLOC_CAP_8BIT);
  if (data)
    {
      memset (data, 0, nmemb * size);
    }
#else
  data = calloc (nmemb, size);
#endif
#ifdef ENABLE_AUDIO_MEM_TRACE
  ESP_LOGI ("AUIDO_MEM", "calloc:%p, size:%d, called:0x%08x", data, size,
            (intptr_t)__builtin_return_address (0) - 2);
#endif
  return data;
}

void *
audio_realloc (void *ptr, size_t size)
{
  void *p = NULL;
#if CONFIG_SPIRAM_BOOT_INIT
  p = heap_caps_realloc (ptr, size, MALLOC_CAP_SPIRAM | MALLOC_CAP_8BIT);
#else
  p = heap_caps_realloc (ptr, size, MALLOC_CAP_8BIT);
#endif
#ifdef ENABLE_AUDIO_MEM_TRACE
  ESP_LOGI ("AUDIO_MEM", "realloc,new:%p, ptr:%p size:%d, called:0x%08x", p,
            ptr, size, (intptr_t)__builtin_return_address (0) - 2);
#endif
  return p;
}

char *
audio_strdup (const char *str)
{
#if CONFIG_SPIRAM_BOOT_INIT
  char *copy = heap_caps_malloc (strlen (str) + 1,
                                 MALLOC_CAP_SPIRAM | MALLOC_CAP_8BIT);
#else
  char *copy = malloc (strlen (str) + 1);
#endif
  if (copy)
    {
      strcpy (copy, str);
    }
#ifdef ENABLE_AUDIO_MEM_TRACE
  ESP_LOGI ("AUDIO_MEM", "strdup:%p, size:%d, called:0x%08x", copy,
            strlen (copy), (intptr_t)__builtin_return_address (0) - 2);
#endif
  return copy;
}

void *
audio_calloc_inner (size_t n, size_t size)
{
  void *data = NULL;
#if CONFIG_SPIRAM_BOOT_INIT
  data = heap_caps_calloc_prefer (
      n, size, 2, MALLOC_CAP_DEFAULT | MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT,
      MALLOC_CAP_DEFAULT | MALLOC_CAP_SPIRAM);
#else
  data = heap_caps_calloc (n, size, MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
#endif

#ifdef ENABLE_AUDIO_MEM_TRACE
  ESP_LOGI ("AUIDO_MEM", "calloc_inner:%p, size:%d, called:0x%08x", data, size,
            (intptr_t)__builtin_return_address (0) - 2);
#endif
  return data;
}

void
audio_mem_print (const char *tag, int line, const char *func)
{
#ifdef CONFIG_SPIRAM_BOOT_INIT
  ESP_LOGI (tag,
            "Func:%s, Line:%d, MEM Total:%d Bytes, Inter:%d Bytes, Dram:%d "
            "Bytes\r\n",
            func, line, esp_get_free_heap_size (),
            heap_caps_get_free_size (MALLOC_CAP_INTERNAL),
            heap_caps_get_free_size (MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT));
#else
  ESP_LOGI (tag, "Func:%s, Line:%d, MEM Total:%d Bytes\r\n", func, line,
            esp_get_free_heap_size ());
#endif
}

#if defined(CONFIG_SPIRAM_BOOT_INIT)
bool
audio_mem_spiram_is_enabled (void)
{
  return true;
}
#else
bool
audio_mem_spiram_is_enabled (void)
{
  return false;
}
#endif

#if defined(CONFIG_SPIRAM_BOOT_INIT)                                          \
    && (CONFIG_SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY)
bool
audio_mem_spiram_stack_is_enabled (void)
{
  bool ret = true;
#if CONFIG_IDF_TARGET_ESP32
  uint8_t chip_ver = esp_efuse_get_chip_ver ();
  if (chip_ver < 3)
    {
      ESP_LOGW (
          "AUIDO_MEM",
          "Can't support stack on external memory due to ESP32 chip is %d",
          chip_ver);
      ret = false;
    }
#endif
  return ret;
}
#else
bool
audio_mem_spiram_stack_is_enabled (void)
{
  return false;
}
#endif