Using arduino-audio-driver as ESP-IDF component #28

crosswick · 2024-08-02T10:36:41Z

crosswick
Aug 2, 2024

Hello - I am already very happy that arduino-audio-tools can be used as ESP-IDF component; I was wondering whether it would be possible to do the same with this library.

What I've tried myself already is copy the if-else logic from the arduino-audio-tools CMakeLists.txt:

if (DEFINED ESP_PLATFORM)

    # idf component
    idf_component_register(
        # SRC_DIRS src
        INCLUDE_DIRS src 
        REQUIRES bt esp_common freertos hal log nvs_flash driver
    )

    target_compile_options(${COMPONENT_LIB} INTERFACE -DESP32_CMAKE=1 -Wno-error -Wno-format -fpermissive)

else()

...

which results in this build error:

Compiling .pio/build/esp32dev/console/commands.c.o
In file included from components/arduino-audio-driver/src/Driver.h:5,
                 from components/arduino-audio-driver/src/AudioBoard.h:2,
                 from components/arduino-audio-tools/src/AudioLibs/I2SCodecStream.h:2,
                 from components/arduino-audio-tools/src/AudioLibs/AudioBoardStream.h:4,
                 from src/main.cpp:2:
components/arduino-audio-driver/src/Driver/ad1938/ad1938.h:27:10: fatal error: SPI.h: No such file or directory

I'm not in a big hurry for this functionality seen as I can do a lot of relevant work for now within the Arduino framework.

It sure seems that it would be a great alternative to using ESP-ADF!

pschatzmann · 2024-08-03T00:00:11Z

pschatzmann
Aug 3, 2024
Maintainer

I guess the easiest would be to use Arduino as component: This will give you the missing SPI and Wire functionality.

0 replies

crosswick · 2024-08-03T09:57:16Z

crosswick
Aug 3, 2024
Author

hm alright, when I follow these steps for using Arduino as an ESP-IDF component:
https://espressif-docs.readthedocs-hosted.com/projects/arduino-esp32/en/latest/esp-idf_component.html

which mentions compatibilty with ESP-IDF 4.4, I get this error:

CMake Error at /Users/steven/.platformio/packages/framework-espidf/tools/cmake/build.cmake:552 (message):
  WARNING: Component "idf" not found

  WARNING: Component "idf" not found

  ERROR: Because project depends on idf (>=5.1,<5.2) which doesn't match any
  versions, version solving failed.

So I gues the real compatibility is with v5.1 only... I have the latest v5.3 installed via updating the ESP-IDF platform from within PlatformIO.

Perhaps there's another way to add the missing functionality? Or utilize what's already there in either ESP-IDF or arduino-audio-tools...

0 replies

crosswick · 2024-08-03T13:18:21Z

crosswick
Aug 3, 2024
Author

Incidentally, I'm getting similar errors when using Arduino in PlatformIO, compiling this FFT Real test:
https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/tests/fft/fft-real/fft-real.ino

Processing esp32dev (platform: https://github.com/platformio/platform-espressif32.git; board: esp32dev; framework: arduino)
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Verbose mode can be enabled via `-v, --verbose` option
CONFIGURATION: https://docs.platformio.org/page/boards/espressif32/esp32dev.html
PLATFORM: Espressif 32 (6.8.1+sha.de553ce) > Espressif ESP32 Dev Module
HARDWARE: ESP32 240MHz, 320KB RAM, 4MB Flash
DEBUG: Current (cmsis-dap) External (cmsis-dap, esp-bridge, esp-prog, iot-bus-jtag, jlink, minimodule, olimex-arm-usb-ocd, olimex-arm-usb-ocd-h, olimex-arm-usb-tiny-h, olimex-jtag-tiny, tumpa)
PACKAGES: 
 - framework-arduinoespressif32 @ 3.20017.0 (2.0.17) 
 - tool-esptoolpy @ 1.40501.0 (4.5.1) 
 - toolchain-xtensa-esp32 @ 8.4.0+2021r2-patch5
LDF: Library Dependency Finder -> https://bit.ly/configure-pio-ldf
LDF Modes: Finder ~ chain, Compatibility ~ soft
Found 35 compatible libraries
Scanning dependencies...
Dependency Graph
|-- audio-tools @ 0.9.8+sha.a20ca7a
|-- audio-driver @ 0.0.1+sha.5163330
Building in release mode
Compiling .pio/build/esp32dev/lib512/audio-driver/Driver/ad1938/ad1938.cpp.o
In file included from .pio/libdeps/esp32dev/audio-driver/src/Driver/ad1938/ad1938.cpp:26:
.pio/libdeps/esp32dev/audio-driver/src/Driver/ad1938/ad1938.h:27:10: fatal error: SPI.h: No such file or directory

*************************************************************
* Looking for SPI.h dependency? Check our library registry!
*
* CLI  > platformio lib search "header:SPI.h"
* Web  > https://registry.platformio.org/search?q=header:SPI.h
*
*************************************************************

 #include <SPI.h>
          ^~~~~~~
compilation terminated.
Compiling .pio/build/esp32dev/lib512/audio-driver/Driver/wm8960/mtb_wm8960.cpp.o
*** [.pio/build/esp32dev/lib512/audio-driver/Driver/ad1938/ad1938.cpp.o] Error 1
In file included from .pio/libdeps/esp32dev/audio-driver/src/Driver/wm8960/mtb_wm8960.cpp:12:
.pio/libdeps/esp32dev/audio-driver/src/Driver/wm8960/mtb_wm8960.h:44:12: fatal error: Wire.h: No such file or directory

**************************************************************
* Looking for Wire.h dependency? Check our library registry!
*
* CLI  > platformio lib search "header:Wire.h"
* Web  > https://registry.platformio.org/search?q=header:Wire.h
*
**************************************************************

 #  include <Wire.h>
            ^~~~~~~~
compilation terminated.
*** [.pio/build/esp32dev/lib512/audio-driver/Driver/wm8960/mtb_wm8960.cpp.o] Error 1

3 replies

pschatzmann Aug 3, 2024
Maintainer

You will find the related information in PlatformIO!
Just add the missing dependencies...

crosswick Aug 3, 2024
Author

I'm sorry, I'm quite confused by this - doing a platformio lib search for either SPI.h or Wire.h yields 21 and 15 results, how should I know which one to add?

Also, shouldn't those basic functionalities already be included, for instance by the REQUIRES driver in CMakeLists.txt of arduino-audio-tools?

crosswick Aug 3, 2024
Author

correction - the REQUIRES part is for usage as ESP-IDF component of course.

Still I wonder why a basic usage of this fft test shouldn't just work after following these steps for using Arduino with PlatformIO:
https://github.com/pschatzmann/arduino-audio-tools/wiki/Working-with-PlatformIO

this example does work for instance:
https://github.com/pschatzmann/arduino-audio-tools/tree/main/examples/examples-audiokit/streams-audiokit-fft

pschatzmann · 2024-08-03T14:13:12Z

pschatzmann
Aug 3, 2024
Maintainer

Just google the topic: e.g. I found this for the Wire library

2 replies

crosswick Aug 3, 2024
Author

I see, thank you. I had seen your instruction for adding additional dependencies by adding to lib_deps = in platformio.ini; I assumed things like SPI and Wire would be too basic to have to add there - but that works.

I'll investigate if the same is true for my original challenge in this discussion.

crosswick Aug 3, 2024
Author

it's not unfortunately, adding

lib_deps = SPI

to platformio.ini doesn't remove the fatal error: SPI.h: No such file or directory

pschatzmann · 2024-08-03T18:09:15Z

pschatzmann
Aug 3, 2024
Maintainer

I could not reproduce any of your issues. The following platformio.ini was working w/o giving any errors

[env:esp32dev]
platform = espressif32
board = esp32dev
framework = arduino
lib_deps = https://github.com/pschatzmann/arduino-audio-driver.git
https://github.com/pschatzmann/arduino-audio-tools.git

3 replies

crosswick Aug 3, 2024
Author

this platformio.ini you show is for the arduino framework, so it is not applicable to the issue I started this discussion with: getting an SPI.h error when using arduino-audio-driver as ESP-IDF component.

I tried to retrace my steps with the Arduino issue which seemed similar, see below if needed; it builds for me too now.

I don't know what exactly I was testing earlier, I apologize.

thank you for your help and attention again.

that was when trying to build
https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/tests/fft/fft-real/fft-real.ino
for Arduino, using PlatformIO

Here are my exact steps for this:

read https://github.com/pschatzmann/arduino-audio-tools/wiki/Working-with-PlatformIO for instructions, so:
create new PlatformIO project with
- name: 20240803_arduino_realfft_test
- board: Espressif ESP32 Dev Module
- framework: Arduino
replace contents of platformio.ini with suggested version, adding lib-deps for arduino-audio-driver and lowering debug level to 2:

[platformio]
description = Audio Example
default_envs = esp32dev

[env:esp32dev]
platform = https://github.com/platformio/platform-espressif32.git
board = esp32dev
framework = arduino
lib_deps = https://github.com/pschatzmann/arduino-audio-tools.git, https://github.com/pschatzmann/arduino-audio-driver.git
build_flags = -DCORE_DEBUG_LEVEL=2 -Wno-unused-variable -Wno-unused-but-set-variable -Wno-unused-function -Wno-format-extra-args 
monitor_speed = 115200
monitor_filters = esp32_exception_decoder

replacing the contents of src/main.cpp with the sketch from https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/tests/fft/fft-real/fft-real.ino
compile - no issues. hm what is different in my situation earlier?

from my failing log:

Dependency Graph
|-- audio-tools @ 0.9.8+sha.a20ca7a
|-- audio-driver @ 0.0.1+sha.5163330

so it was including audio-driver, which is not in the fft-real test. perhaps it was still loading because of other main.cpp I was testing in the same workspace... let me add
#include "AudioLibs/AudioBoardStream.h"
AudioBoardStream kit(AudioKitEs8388V1); // Access I2S as stream

crosswick Aug 3, 2024
Author

...slightly losing my mind here, because when I repeat those exact steps again it doesn't build:

Processing esp32dev (platform: https://github.com/platformio/platform-espressif32.git; board: esp32dev; framework: arduino)
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Library Manager: Installing git+https://github.com/pschatzmann/arduino-audio-tools.git
git version 2.37.1 (Apple Git-137.1)
Cloning into '/Users/steven/.platformio/.cache/tmp/pkg-installing-8z0_o7hz'...
remote: Enumerating objects: 1325, done.
remote: Counting objects: 100% (1325/1325), done.
remote: Compressing objects: 100% (1116/1116), done.
remote: Total 1325 (delta 210), reused 848 (delta 90), pack-reused 0
Receiving objects: 100% (1325/1325), 14.90 MiB | 2.27 MiB/s, done.
Resolving deltas: 100% (210/210), done.
Library Manager: audio-tools@0.9.8+sha.9d63174 has been installed!
Library Manager: Installing git+https://github.com/pschatzmann/arduino-audio-driver.git
git version 2.37.1 (Apple Git-137.1)
Cloning into '/Users/steven/.platformio/.cache/tmp/pkg-installing-nrrlzz6c'...
remote: Enumerating objects: 609, done.
remote: Counting objects: 100% (609/609), done.
remote: Compressing objects: 100% (421/421), done.
remote: Total 609 (delta 360), reused 292 (delta 180), pack-reused 0
Receiving objects: 100% (609/609), 621.32 KiB | 689.00 KiB/s, done.
Resolving deltas: 100% (360/360), done.
Library Manager: audio-driver@0.1.0+sha.8779218 has been installed!
Verbose mode can be enabled via `-v, --verbose` option
CONFIGURATION: https://docs.platformio.org/page/boards/espressif32/esp32dev.html
PLATFORM: Espressif 32 (6.8.1+sha.de553ce) > Espressif ESP32 Dev Module
HARDWARE: ESP32 240MHz, 320KB RAM, 4MB Flash
DEBUG: Current (cmsis-dap) External (cmsis-dap, esp-bridge, esp-prog, iot-bus-jtag, jlink, minimodule, olimex-arm-usb-ocd, olimex-arm-usb-ocd-h, olimex-arm-usb-tiny-h, olimex-jtag-tiny, tumpa)
PACKAGES: 
 - framework-arduinoespressif32 @ 3.20017.0 (2.0.17) 
 - tool-esptoolpy @ 1.40501.0 (4.5.1) 
 - toolchain-xtensa-esp32 @ 8.4.0+2021r2-patch5
LDF: Library Dependency Finder -> https://bit.ly/configure-pio-ldf
LDF Modes: Finder ~ chain, Compatibility ~ soft
Found 35 compatible libraries
Scanning dependencies...
Dependency Graph
|-- audio-tools @ 0.9.8+sha.9d63174
|-- audio-driver @ 0.1.0+sha.8779218
Building in release mode
Compiling .pio/build/esp32dev/src/main.cpp.o
Building .pio/build/esp32dev/bootloader.bin
Generating partitions .pio/build/esp32dev/partitions.bin
esptool.py v4.5.1
Creating esp32 image...
Merged 1 ELF section
Successfully created esp32 image.
Compiling .pio/build/esp32dev/lib165/WiFi/WiFi.cpp.o
Compiling .pio/build/esp32dev/lib165/WiFi/WiFiAP.cpp.o
Compiling .pio/build/esp32dev/lib165/WiFi/WiFiClient.cpp.o
Compiling .pio/build/esp32dev/lib165/WiFi/WiFiGeneric.cpp.o
Compiling .pio/build/esp32dev/lib165/WiFi/WiFiMulti.cpp.o
Compiling .pio/build/esp32dev/lib165/WiFi/WiFiSTA.cpp.o
Compiling .pio/build/esp32dev/lib165/WiFi/WiFiScan.cpp.o
Compiling .pio/build/esp32dev/lib165/WiFi/WiFiServer.cpp.o
Compiling .pio/build/esp32dev/lib165/WiFi/WiFiUdp.cpp.o
Compiling .pio/build/esp32dev/lib62c/WiFiClientSecure/WiFiClientSecure.cpp.o
Compiling .pio/build/esp32dev/lib62c/WiFiClientSecure/esp_crt_bundle.c.o
Compiling .pio/build/esp32dev/lib62c/WiFiClientSecure/ssl_client.cpp.o
Compiling .pio/build/esp32dev/lib90f/I2S/I2S.cpp.o
Compiling .pio/build/esp32dev/liba97/Ticker/Ticker.cpp.o
Compiling .pio/build/esp32dev/libc27/SPI/SPI.cpp.o
Archiving .pio/build/esp32dev/lib165/libWiFi.a
Indexing .pio/build/esp32dev/lib165/libWiFi.a
Compiling .pio/build/esp32dev/libf35/audio-tools/AudioTools/AudioRuntime.cpp.o
Archiving .pio/build/esp32dev/liba97/libTicker.a
Indexing .pio/build/esp32dev/liba97/libTicker.a
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/ac101/ac101.c.o
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/ad1938/ad1938.cpp.o
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/cs43l22/cs43l22.c.o
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/es7210/es7210.c.o
/Users/steven/.platformio/packages/framework-arduinoespressif32/libraries/I2S/src/I2S.cpp: In member function 'int I2SClass::_installDriver()':
/Users/steven/.platformio/packages/framework-arduinoespressif32/libraries/I2S/src/I2S.cpp:202:89: warning: 'ADC_ATTEN_DB_11' is deprecated [-Wdeprecated-declarations]
       esp_i2s::adc1_config_channel_atten((esp_i2s::adc1_channel_t)adc_channel, esp_i2s::ADC_ATTEN_DB_11);
                                                                                         ^~~~~~~~~~~~~~~
In file included from /Users/steven/.platformio/packages/framework-arduinoespressif32/tools/sdk/esp32/include/driver/include/driver/adc.h:14,
                 from /Users/steven/.platformio/packages/framework-arduinoespressif32/tools/sdk/esp32/include/driver/include/driver/i2s.h:21,
                 from /Users/steven/.platformio/packages/framework-arduinoespressif32/libraries/I2S/src/I2S.h:26,
                 from /Users/steven/.platformio/packages/framework-arduinoespressif32/libraries/I2S/src/I2S.cpp:21:
/Users/steven/.platformio/packages/framework-arduinoespressif32/tools/sdk/esp32/include/hal/include/hal/adc_types.h:54:5: note: declared here
     ADC_ATTEN_DB_11 __attribute__((deprecated)) = ADC_ATTEN_DB_12,  ///<This is deprecated, it behaves the same as `ADC_ATTEN_DB_12`
     ^~~~~~~~~~~~~~~
/Users/steven/.platformio/packages/framework-arduinoespressif32/libraries/I2S/src/I2S.cpp:204:89: warning: 'ADC_ATTEN_DB_11' is deprecated [-Wdeprecated-declarations]
       esp_i2s::adc2_config_channel_atten((esp_i2s::adc2_channel_t)adc_channel, esp_i2s::ADC_ATTEN_DB_11);
                                                                                         ^~~~~~~~~~~~~~~
In file included from /Users/steven/.platformio/packages/framework-arduinoespressif32/tools/sdk/esp32/include/driver/include/driver/adc.h:14,
                 from /Users/steven/.platformio/packages/framework-arduinoespressif32/tools/sdk/esp32/include/driver/include/driver/i2s.h:21,
                 from /Users/steven/.platformio/packages/framework-arduinoespressif32/libraries/I2S/src/I2S.h:26,
                 from /Users/steven/.platformio/packages/framework-arduinoespressif32/libraries/I2S/src/I2S.cpp:21:
/Users/steven/.platformio/packages/framework-arduinoespressif32/tools/sdk/esp32/include/hal/include/hal/adc_types.h:54:5: note: declared here
     ADC_ATTEN_DB_11 __attribute__((deprecated)) = ADC_ATTEN_DB_12,  ///<This is deprecated, it behaves the same as `ADC_ATTEN_DB_12`
     ^~~~~~~~~~~~~~~
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/es7243/es7243.c.o
Archiving .pio/build/esp32dev/lib62c/libWiFiClientSecure.a
Archiving .pio/build/esp32dev/libc27/libSPI.a
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/es7243e/es7243e.c.o
Indexing .pio/build/esp32dev/lib62c/libWiFiClientSecure.a
Indexing .pio/build/esp32dev/libc27/libSPI.a
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/es8156/es8156.c.o
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/es8311/es8311.c.o
Archiving .pio/build/esp32dev/lib90f/libI2S.a
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/es8374/es8374.c.o
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/es8388/es8388.c.o
Indexing .pio/build/esp32dev/lib90f/libI2S.a
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/tas5805m/tas5805m.c.o
Archiving .pio/build/esp32dev/libf35/libaudio-tools.a
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/wm8960/mtb_wm8960.cpp.o
Indexing .pio/build/esp32dev/libf35/libaudio-tools.a
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/wm8978/WM8978.cpp.o
Compiling .pio/build/esp32dev/lib63d/audio-driver/Driver/wm8994/wm8994.c.o
Compiling .pio/build/esp32dev/lib63d/audio-driver/Utils/I2C.cpp.o
.pio/libdeps/esp32dev/audio-driver/src/Utils/I2C.cpp:1:10: fatal error: Wire.h: No such file or directory

**************************************************************
* Looking for Wire.h dependency? Check our library registry!
*
* CLI  > platformio lib search "header:Wire.h"
* Web  > https://registry.platformio.org/search?q=header:Wire.h
*
**************************************************************

 #include <Wire.h>
          ^~~~~~~~
compilation terminated.
*** [.pio/build/esp32dev/lib63d/audio-driver/Utils/I2C.cpp.o] Error 1
In file included from .pio/libdeps/esp32dev/audio-driver/src/Driver/wm8978/WM8978.cpp:1:
.pio/libdeps/esp32dev/audio-driver/src/Driver/wm8978/WM8978.h:7:10: fatal error: Wire.h: No such file or directory

**************************************************************
* Looking for Wire.h dependency? Check our library registry!
*
* CLI  > platformio lib search "header:Wire.h"
* Web  > https://registry.platformio.org/search?q=header:Wire.h
*
**************************************************************

 #include "Wire.h"
          ^~~~~~~~
compilation terminated.
*** [.pio/build/esp32dev/lib63d/audio-driver/Driver/wm8978/WM8978.cpp.o] Error 1
In file included from .pio/libdeps/esp32dev/audio-driver/src/Driver/wm8960/mtb_wm8960.cpp:12:
.pio/libdeps/esp32dev/audio-driver/src/Driver/wm8960/mtb_wm8960.h:44:12: fatal error: Wire.h: No such file or directory

**************************************************************
* Looking for Wire.h dependency? Check our library registry!
*
* CLI  > platformio lib search "header:Wire.h"
* Web  > https://registry.platformio.org/search?q=header:Wire.h
*
**************************************************************

 #  include <Wire.h>
            ^~~~~~~~
compilation terminated.
*** [.pio/build/esp32dev/lib63d/audio-driver/Driver/wm8960/mtb_wm8960.cpp.o] Error 1
========================================================================================= [FAILED] Took 14.15 seconds =========================================================================================

 *  The terminal process "platformio 'run'" terminated with exit code: 1. 
 *  Terminal will be reused by tasks, press any key to close it.

crosswick Aug 3, 2024
Author

and if I then add , Wire to my lib_deps it again does build. I give up ;)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Using arduino-audio-driver as ESP-IDF component #28

{{title}}

Replies: 5 comments 8 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

Select a reply

Using arduino-audio-driver as ESP-IDF component #28

crosswick Aug 2, 2024

Replies: 5 comments · 8 replies

pschatzmann Aug 3, 2024 Maintainer

crosswick Aug 3, 2024 Author

crosswick Aug 3, 2024 Author

pschatzmann Aug 3, 2024 Maintainer

crosswick Aug 3, 2024 Author

crosswick Aug 3, 2024 Author

pschatzmann Aug 3, 2024 Maintainer

crosswick Aug 3, 2024 Author

crosswick Aug 3, 2024 Author

pschatzmann Aug 3, 2024 Maintainer

crosswick Aug 3, 2024 Author

crosswick Aug 3, 2024 Author

crosswick Aug 3, 2024 Author

crosswick
Aug 2, 2024

Replies: 5 comments 8 replies

pschatzmann
Aug 3, 2024
Maintainer

crosswick
Aug 3, 2024
Author

crosswick
Aug 3, 2024
Author

pschatzmann Aug 3, 2024
Maintainer

crosswick Aug 3, 2024
Author

crosswick Aug 3, 2024
Author

pschatzmann
Aug 3, 2024
Maintainer

crosswick Aug 3, 2024
Author

crosswick Aug 3, 2024
Author

pschatzmann
Aug 3, 2024
Maintainer

crosswick Aug 3, 2024
Author

crosswick Aug 3, 2024
Author

crosswick Aug 3, 2024
Author