config_checks_esp32.h

/*
 * config_checks_esp32.h
 *
 * This file is part of Mozzi.
 *
 * Copyright 2023-2024 Thomas Friedrichsmeier and the Mozzi Team
 * Copyright 2025 Thomas Combriat and the Mozzi Team
 *
 * Mozzi is licensed under the GNU Lesser General Public Licence (LGPL) Version 2.1 or later.
 *
*/
 
#ifndef CONFIG_CHECK_ESP32_H
#define CONFIG_CHECK_ESP32_H
 
#if not IS_ESP32()
#error This header should be included for ESP32 architecture, only
#endif
 
#include "disable_2pinmode_on_github_workflow.h"
#if !defined(MOZZI_AUDIO_MODE)
#  if CONFIG_IDF_TARGET_ESP32
#    define MOZZI_AUDIO_MODE MOZZI_OUTPUT_INTERNAL_DAC
#  else // only ESP32 carries an internal DAC
#    define MOZZI_AUDIO_MODE MOZZI_OUTPUT_PWM
#  endif
#endif
MOZZI_CHECK_SUPPORTED(MOZZI_AUDIO_MODE, MOZZI_OUTPUT_EXTERNAL_TIMED, MOZZI_OUTPUT_EXTERNAL_CUSTOM, MOZZI_OUTPUT_PDM_VIA_I2S, MOZZI_OUTPUT_I2S_DAC, MOZZI_OUTPUT_INTERNAL_DAC, MOZZI_OUTPUT_PWM)
 
#if !defined(MOZZI_AUDIO_RATE)
#define MOZZI_AUDIO_RATE 32768
#endif
 
#if defined(MOZZI_PWM_RATE)
#error Configuration of MOZZI_PWM_RATE is not currently supported on this platform (always same as MOZZI_AUDIO_RATE)
#endif
 
#if !defined(MOZZI_ANALOG_READ)
#  define MOZZI_ANALOG_READ MOZZI_ANALOG_READ_NONE
#endif
 
MOZZI_CHECK_SUPPORTED(MOZZI_ANALOG_READ, MOZZI_ANALOG_READ_NONE)
MOZZI_CHECK_SUPPORTED(MOZZI_AUDIO_INPUT, MOZZI_AUDIO_INPUT_NONE)
 
#if MOZZI_IS(MOZZI_AUDIO_MODE, MOZZI_OUTPUT_I2S_DAC)
#  if !defined(MOZZI_I2S_FORMAT)
#    define MOZZI_I2S_FORMAT MOZZI_I2S_FORMAT_PLAIN
#  endif
#  if !defined(MOZZI_I2S_PIN_BCK)
#    define MOZZI_I2S_PIN_BCK 26
#  endif
#  if !defined(MOZZI_I2S_PIN_WS)
#    define MOZZI_I2S_PIN_WS 25
#  endif
#  if !defined(MOZZI_I2S_PIN_DATA)
#    define MOZZI_I2S_PIN_DATA 33
#  endif
#  if !defined(MOZZI_I2S_PIN_MCLK)
#    define MOZZI_I2S_PIN_MCLK I2S_GPIO_UNUSED
#  endif
#  if !defined(MOZZI_I2S_BCK_INV)
#    define MOZZI_I2S_BCK_INV 0
#  endif
#  if !defined(MOZZI_I2S_WS_INV)
#    if MOZZI_IS(MOZZI_I2S_FORMAT, MOZZI_I2S_FORMAT_PLAIN)
#      define MOZZI_I2S_WS_INV 0
#    elif MOZZI_IS(MOZZI_I2S_FORMAT, MOZZI_I2S_FORMAT_LSBJ)
#      define MOZZI_I2S_WS_INV 1
#    endif
#  endif
#  if !defined(MOZZI_I2S_MBCK_INV)
#    define MOZZI_I2S_MBCK_INV 0
#  endif
#endif
 
#if MOZZI_IS(MOZZI_AUDIO_MODE, MOZZI_OUTPUT_I2S_DAC, MOZZI_OUTPUT_PDM_VIA_I2S)
#  if !defined(MOZZI_I2S_FORMAT)
#    define MOZZI_I2S_FORMAT MOZZI_I2S_FORMAT_PLAIN
#  endif
#  if !defined(MOZZI_I2S_PIN_BCK)
#    define MOZZI_I2S_PIN_BCK I2S_GPIO_UNUSED
#  endif
#  if !defined(MOZZI_I2S_PIN_WS)
#    define MOZZI_I2S_PIN_WS I2S_GPIO_UNUSED
#  endif
#  if !defined(MOZZI_I2S_PIN_DATA)
#    define MOZZI_I2S_PIN_DATA 33
#  endif
#  if !defined(MOZZI_I2S_PIN_MCLK)
#    define MOZZI_I2S_PIN_MCLK I2S_GPIO_UNUSED
#  endif
#  define MOZZI_I2S_WS_INV 0 // unused but need to be defined
#  define MOZZI_I2S_BCK_INV 0
#  define MOZZI_I2S_MBCK_INV 0
#endif
 
#if MOZZI_IS(MOZZI_AUDIO_MODE/*, MOZZI_OUTPUT_INTERNAL_DAC*/, MOZZI_OUTPUT_I2S_DAC, MOZZI_OUTPUT_PDM_VIA_I2S)
//#  include <driver/i2s.h>
#  if !defined(MOZZI_IS2_PORT)
#    define MOZZI_I2S_PORT I2S_NUM_0
#  endif
#endif
 
#if MOZZI_IS(MOZZI_AUDIO_MODE, MOZZI_OUTPUT_PWM)
#  define MOZZI_AUDIO_BITS 10   // not configurable (could be 8 at AUDIO_RATE, working combinations are not specified on espressif's doc)
#  if !defined(MOZZI_AUDIO_PIN_1)
#    define MOZZI_AUDIO_PIN_1 15
#  endif
#  if !defined(MOZZI_AUDIO_PIN_2)
#    define MOZZI_AUDIO_PIN_2 16
#  endif
#endif
 
#if !defined(MOZZI_AUDIO_BITS)
#  if MOZZI_IS(MOZZI_AUDIO_MODE, MOZZI_OUTPUT_INTERNAL_DAC)
#    define MOZZI_AUDIO_BITS 8
#  else
#    define MOZZI_AUDIO_BITS 16
#  endif
#endif
 
#if MOZZI_IS(MOZZI_AUDIO_MODE, MOZZI_OUTPUT_PDM_VIA_I2S)
#  define MOZZI_I2S_FORMAT MOZZI_I2S_FORMAT_LSBJ  // pdm codes are for LSBJ format
#  if !defined(MOZZI_PDM_RESOLUTION)
#    define MOZZI_PDM_RESOLUTION 8 
#  endif
#else
#  define MOZZI_PDM_RESOLUTION 1  // unconditionally, no other value allowed
#endif
 
 
// All modes besides timed external bypass the output buffer!
#if !MOZZI_IS(MOZZI_AUDIO_MODE, MOZZI_OUTPUT_EXTERNAL_TIMED, MOZZI_OUTPUT_INTERNAL_DAC, MOZZI_OUTPUT_PWM)
#  define BYPASS_MOZZI_OUTPUT_BUFFER true
#endif
 
#define MOZZI__INTERNAL_ANALOG_READ_RESOLUTION 12
 
#endif        //  #ifndef CONFIG_CHECK_ESP32_H