From cc23764e10f5b9afc4c3a1986a0ebc7e7ac7727e Mon Sep 17 00:00:00 2001 From: Mark Kelly <1787606+kel30a@users.noreply.github.com> Date: Tue, 10 Sep 2024 03:46:50 +1000 Subject: [PATCH 01/30] Update cmakelist.txt file to support compiling in ESP IDF --- CMakeLists.txt | 50 ++++++++++++++++++++++++++++++++------------------ 1 file changed, 32 insertions(+), 18 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 7a42c31..0b7878d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,28 +1,42 @@ cmake_minimum_required(VERSION 3.16) -# set the project name -project(arduino_helix) +if (DEFINED ESP_PLATFORM) + # idf component + idf_component_register( + SRC_DIRS src src/utils src/libhelix-aac src/libhelix-mp3 + INCLUDE_DIRS src src/utils src/libhelix-aac src/libhelix-mp3 + REQUIRES arduino-esp32 + ) -# lots of warnings and all warnings as errors -## add_compile_options(-Wall -Wextra ) -set(CMAKE_CXX_STANDARD 17) + target_compile_options(${COMPONENT_LIB} INTERFACE -Wno-error -Wno-format) + target_compile_options(${COMPONENT_LIB} PRIVATE -DUSE_DEFAULT_STDLIB) + add_compile_definitions(ESP32) +else() -option(MP3_EXAMPLES "build examples" OFF) + # set the project name + project(arduino_helix) -file(GLOB_RECURSE SRC_LIST_C CONFIGURE_DEPENDS "${PROJECT_SOURCE_DIR}/src/*.c" ) -file(GLOB_RECURSE SRC_LIST_CPP CONFIGURE_DEPENDS "${PROJECT_SOURCE_DIR}/src/*.cpp" ) + # lots of warnings and all warnings as errors + ## add_compile_options(-Wall -Wextra ) + set(CMAKE_CXX_STANDARD 17) -# define libraries -add_library (arduino_helix ${SRC_LIST_C} ${SRC_LIST_CPP}) + option(MP3_EXAMPLES "build examples" OFF) -# prevent compile errors -target_compile_options(arduino_helix PRIVATE -DUSE_DEFAULT_STDLIB) + file(GLOB_RECURSE SRC_LIST_C CONFIGURE_DEPENDS "${PROJECT_SOURCE_DIR}/src/*.c" ) + file(GLOB_RECURSE SRC_LIST_CPP CONFIGURE_DEPENDS "${PROJECT_SOURCE_DIR}/src/*.cpp" ) -# define location for header files -target_include_directories(arduino_helix PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src ${CMAKE_CURRENT_SOURCE_DIR}/src/libhelix-mp3 ${CMAKE_CURRENT_SOURCE_DIR}/src/libhelix-aac ) + # define libraries + add_library (arduino_helix ${SRC_LIST_C} ${SRC_LIST_CPP}) -# build examples -if(MP3_EXAMPLES) - add_subdirectory( "${CMAKE_CURRENT_SOURCE_DIR}/examples/output_mp3") - add_subdirectory( "${CMAKE_CURRENT_SOURCE_DIR}/examples/output_aac") + # prevent compile errors + target_compile_options(arduino_helix PRIVATE -DUSE_DEFAULT_STDLIB) + + # define location for header files + target_include_directories(arduino_helix PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src ${CMAKE_CURRENT_SOURCE_DIR}/src/libhelix-mp3 ${CMAKE_CURRENT_SOURCE_DIR}/src/libhelix-aac ) + + # build examples + if(MP3_EXAMPLES) + add_subdirectory( "${CMAKE_CURRENT_SOURCE_DIR}/examples/output_mp3") + add_subdirectory( "${CMAKE_CURRENT_SOURCE_DIR}/examples/output_aac") + endif() endif() \ No newline at end of file From 5f5b6e5ae9ee07d6ecc772c2d56136ad96076958 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Fri, 4 Oct 2024 10:56:17 +0200 Subject: [PATCH 02/30] 0.8.6 in library.properties --- library.properties | 2 +- src/MP3DecoderHelix.h | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/library.properties b/library.properties index 8d8f1a3..ef484b5 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=libhelix -version=0.8.5 +version=0.8.6 author=Phil Schatzmann maintainer= sentence=libhelix audio decoder for Arduino diff --git a/src/MP3DecoderHelix.h b/src/MP3DecoderHelix.h index 9ae0ca5..52d3a2b 100644 --- a/src/MP3DecoderHelix.h +++ b/src/MP3DecoderHelix.h @@ -149,7 +149,10 @@ class MP3DecoderHelix : public CommonHelix { } #if defined(ARDUINO) || defined(HELIX_PRINT) int sampleSize = info.bitsPerSample / 8; - out->write((uint8_t *)pcm_buffer.data(), info.outputSamps * sampleSize); + int toWrite = info.outputSamps * sampleSize; + int written = out->write((uint8_t *)pcm_buffer.data(), toWrite); + // assume blocking write + assert(written == toWrite); #endif } mp3FrameInfo = info; From a83886bc3588f862903f0f886ff6e29f48dc6fc2 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Sun, 20 Oct 2024 19:07:37 +0200 Subject: [PATCH 03/30] Support to resize a vector to 0 --- src/utils/Vector.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/utils/Vector.h b/src/utils/Vector.h index 3a8c2eb..547759a 100644 --- a/src/utils/Vector.h +++ b/src/utils/Vector.h @@ -282,7 +282,14 @@ class Vector { Allocator *p_allocator = &DefaultAllocator; void resize_internal(int newSize, bool copy, bool shrink = false) { - if (newSize <= 0) return; + if (newSize <= 0 && p_data==nullptr) return; + // release memory + if (newSize <= 0) { + deleteArray(p_data, size()); // delete [] this->p_data; + p_data = nullptr; + return; + } + // allocate new memory if (newSize > bufferLen || this->p_data == nullptr || shrink) { T *oldData = p_data; int oldBufferLen = this->bufferLen; From d00adcba976aed781ff979fc85cddaa888b40591 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Mon, 28 Oct 2024 13:44:37 +0100 Subject: [PATCH 04/30] Correct processed bytes in mp3 --- src/MP3DecoderHelix.h | 1 - 1 file changed, 1 deletion(-) diff --git a/src/MP3DecoderHelix.h b/src/MP3DecoderHelix.h index 52d3a2b..1d93a39 100644 --- a/src/MP3DecoderHelix.h +++ b/src/MP3DecoderHelix.h @@ -125,7 +125,6 @@ class MP3DecoderHelix : public CommonHelix { provideResult(info); } else { LOG_HELIX(LogLevelHelix::Info, "MP3Decode rc: %d", rc); - processed = rc; } return processed; } From 41b6b0c31e5f773f5d66f8a2147a7087bb595209 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Mon, 13 Jan 2025 14:08:47 +0100 Subject: [PATCH 05/30] Prevent NPE if output is not defined --- src/AACDecoderHelix.h | 6 +++++- src/MP3DecoderHelix.h | 12 +++++++----- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/src/AACDecoderHelix.h b/src/AACDecoderHelix.h index 8fa43e3..5fd78da 100644 --- a/src/AACDecoderHelix.h +++ b/src/AACDecoderHelix.h @@ -139,7 +139,11 @@ class AACDecoderHelix : public CommonHelix { infoCallback(info, p_caller_ref); } #if defined(ARDUINO) || defined(HELIX_PRINT) - out->write((uint8_t *)pcm_buffer.data(), info.outputSamps * sampleSize); + if (out != nullptr){ + size_t to_write = info.outputSamps * sampleSize; + size_t written = out->write((uint8_t *)pcm_buffer.data(), to_write); + assert(written == to_write); + } #endif } aacFrameInfo = info; diff --git a/src/MP3DecoderHelix.h b/src/MP3DecoderHelix.h index 1d93a39..47ade1f 100644 --- a/src/MP3DecoderHelix.h +++ b/src/MP3DecoderHelix.h @@ -147,11 +147,13 @@ class MP3DecoderHelix : public CommonHelix { infoCallback(info, p_caller_ref); } #if defined(ARDUINO) || defined(HELIX_PRINT) - int sampleSize = info.bitsPerSample / 8; - int toWrite = info.outputSamps * sampleSize; - int written = out->write((uint8_t *)pcm_buffer.data(), toWrite); - // assume blocking write - assert(written == toWrite); + if (out != nullptr){ + int sampleSize = info.bitsPerSample / 8; + int toWrite = info.outputSamps * sampleSize; + int written = out->write((uint8_t *)pcm_buffer.data(), toWrite); + // assume blocking write + assert(written == toWrite); + } #endif } mp3FrameInfo = info; From dbda3e0fbee14d6d79bc3f9faf4f6aae0943aede Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Mon, 17 Feb 2025 18:11:32 +0100 Subject: [PATCH 06/30] flush: decode only complete segments --- src/AACDecoderHelix.h | 1 + src/CommonHelix.h | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/AACDecoderHelix.h b/src/AACDecoderHelix.h index 5fd78da..9a2bf89 100644 --- a/src/AACDecoderHelix.h +++ b/src/AACDecoderHelix.h @@ -104,6 +104,7 @@ class AACDecoderHelix : public CommonHelix { /// decods the data and removes the decoded frame from the buffer int decode() override { + LOG_HELIX(LogLevelHelix::Debug, "decode"); int processed = 0; int available = frame_buffer.available(); int bytes_left = frame_buffer.available(); diff --git a/src/CommonHelix.h b/src/CommonHelix.h index b370c88..2fc6ce3 100644 --- a/src/CommonHelix.h +++ b/src/CommonHelix.h @@ -102,11 +102,14 @@ class CommonHelix { void flush() { int rc = 1; while (rc >= 0) { + // we must start with sych word if (!presync()) break; + // we must end with synch world + if (findSynchWord(3) < 0) break; rc = decode(); if (!resynch(rc)) break; // remove processed data - frame_buffer.clearArray(rc); + if (rc > 0) frame_buffer.clearArray(rc); } } @@ -155,6 +158,7 @@ class CommonHelix { bool rc = true; int pos = findSynchWord(); if (pos > 3) rc = removeInvalidData(pos); + return rc; } From a2b00becd5c2fa12169c824a5fe06fba949bcd10 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Mon, 17 Feb 2025 18:29:35 +0100 Subject: [PATCH 07/30] version 0.8.7 --- library.properties | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/library.properties b/library.properties index ef484b5..0f0ad0e 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=libhelix -version=0.8.6 +version=0.8.7 author=Phil Schatzmann -maintainer= +maintainer= https://github.com/pschatzmann sentence=libhelix audio decoder for Arduino paragraph=libhelix audio decoder for Arduino category=Signal Input/Output From a3abf4e8878d6bcd499ecbf19faa19505a759a8e Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Wed, 26 Feb 2025 10:39:11 +0100 Subject: [PATCH 08/30] Readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 48f7b37..70dc482 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,8 @@ LOGLEVEL_HELIX = LogLevelHelix::Info; ## Documentation - The [Class Documentation can be found here](https://pschatzmann.github.io/arduino-libhelix/html/annotated.html) +- aac [readme.txt](https://github.com/pschatzmann/arduino-libhelix/blob/main/src/libhelix-aac/readme.txt) +- mp3 [readme.txt](https://github.com/pschatzmann/arduino-libhelix/blob/main/src/libhelix-mp3/readme.txt) - I also suggest that you have a look at [my related blogs](https://www.pschatzmann.ch/home/tag/codecs/) I recommend to use this library together with my [Arduino Audio Tools](https://github.com/pschatzmann/arduino-audio-tools). From a5670cc65615cd6886485978df638fefac2c59bf Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Wed, 26 Feb 2025 11:52:47 +0100 Subject: [PATCH 09/30] Move HELIX_FEATURE_AUDIO_CODEC_AAC_SBR to ConfigHelix.h --- src/ConfigHelix.h | 5 +++++ src/libhelix-aac/aaccommon.h | 9 +++++---- src/libhelix-aac/aacdec.h | 4 ---- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/src/ConfigHelix.h b/src/ConfigHelix.h index 0baa6b4..2800512 100644 --- a/src/ConfigHelix.h +++ b/src/ConfigHelix.h @@ -53,4 +53,9 @@ #ifndef HELIX_LOG_SIZE # define HELIX_LOG_SIZE 256 +#endif + +/// the ESP8266 does not have enough memory +#ifndef ESP8266 +# define HELIX_FEATURE_AUDIO_CODEC_AAC_SBR #endif \ No newline at end of file diff --git a/src/libhelix-aac/aaccommon.h b/src/libhelix-aac/aaccommon.h index 8ca4f70..1ddb97d 100644 --- a/src/libhelix-aac/aaccommon.h +++ b/src/libhelix-aac/aaccommon.h @@ -48,12 +48,13 @@ //#include //#include +#include "ConfigHelix.h" #include "utils/helix_pgm.h" -// Can't fit in ESP8266 RAM -//#ifndef ESP8266 -#define AAC_ENABLE_SBR 0 -//#endif +/* define these to enable decoder features */ +#if defined(HELIX_FEATURE_AUDIO_CODEC_AAC_SBR) +# define AAC_ENABLE_SBR +#endif // HELIX_FEATURE_AUDIO_CODEC_AAC_SBR. #pragma GCC optimize ("O3") diff --git a/src/libhelix-aac/aacdec.h b/src/libhelix-aac/aacdec.h index 0f7d91f..86b6a9a 100644 --- a/src/libhelix-aac/aacdec.h +++ b/src/libhelix-aac/aacdec.h @@ -99,10 +99,6 @@ extern "C" { #define AAC_PROFILE_LC 1 #define AAC_PROFILE_SSR 2 -/* define these to enable decoder features */ -#if defined(HELIX_FEATURE_AUDIO_CODEC_AAC_SBR) -#define AAC_ENABLE_SBR -#endif // HELIX_FEATURE_AUDIO_CODEC_AAC_SBR. #define AAC_ENABLE_MPEG4 enum { From ba5aca4a16f01d886c88ea3605f00b667843c7a1 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Thu, 6 Mar 2025 16:58:12 +0100 Subject: [PATCH 10/30] IDF as component --- src/libhelix-aac/noiseless.c | 1 + 1 file changed, 1 insertion(+) diff --git a/src/libhelix-aac/noiseless.c b/src/libhelix-aac/noiseless.c index 5d3a65d..3fac059 100644 --- a/src/libhelix-aac/noiseless.c +++ b/src/libhelix-aac/noiseless.c @@ -45,6 +45,7 @@ **************************************************************************************/ #include "coder.h" +//#pragma GCC diagnostic ignored "-Wstringop-overflow" //#include "profile.h" From 79b657676a67456836ddcf1abede664906216465 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Thu, 6 Mar 2025 16:58:39 +0100 Subject: [PATCH 11/30] IDF as component --- CMakeLists.txt | 2 +- src/CommonHelix.h | 4 ++++ src/MP3DecoderHelix.h | 2 +- src/libhelix-aac/aaccommon.h | 4 +++- src/libhelix-aac/aacdec.h | 2 +- src/libhelix-aac/assembly.h | 2 +- src/libhelix-mp3/assembly.h | 2 +- src/utils/Allocator.h | 17 +++++++++++++---- src/utils/Buffers.h | 7 ++++--- 9 files changed, 29 insertions(+), 13 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 0b7878d..8e024b6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -5,7 +5,7 @@ if (DEFINED ESP_PLATFORM) idf_component_register( SRC_DIRS src src/utils src/libhelix-aac src/libhelix-mp3 INCLUDE_DIRS src src/utils src/libhelix-aac src/libhelix-mp3 - REQUIRES arduino-esp32 + # REQUIRES arduino-esp32 ) target_compile_options(${COMPONENT_LIB} INTERFACE -Wno-error -Wno-format) diff --git a/src/CommonHelix.h b/src/CommonHelix.h index 2fc6ce3..8662e05 100644 --- a/src/CommonHelix.h +++ b/src/CommonHelix.h @@ -92,11 +92,13 @@ class CommonHelix { /// returns true if active operator bool() { return active; } +#ifdef ARDUINO /// Provides the timestamp in ms of last write uint64_t timeOfLastWrite() { return time_last_write; } /// Provides the timestamp in ms of last decoded result uint64_t timeOfLastResult() { return time_last_result; } +#endif /// Decode all open packets void flush() { @@ -212,7 +214,9 @@ class CommonHelix { /// Decoding Loop: We decode the procided data until we run out of data virtual size_t writeChunk(const void *in_ptr, size_t in_size) { LOG_HELIX(LogLevelHelix::Info, "writeChunk %zu", in_size); +#ifdef ARDUINO time_last_write = millis(); +#endif size_t result = frame_buffer.writeArray((uint8_t *)in_ptr, in_size); while (frame_buffer.available() >= minFrameBufferSize()) { diff --git a/src/MP3DecoderHelix.h b/src/MP3DecoderHelix.h index 47ade1f..9c188fc 100644 --- a/src/MP3DecoderHelix.h +++ b/src/MP3DecoderHelix.h @@ -113,7 +113,7 @@ class MP3DecoderHelix : public CommonHelix { int processed = 0; int available = frame_buffer.available(); int bytes_left = frame_buffer.available(); - LOG_HELIX(LogLevelHelix::Info, "decode: %d", frame_buffer.available()); + LOG_HELIX(LogLevelHelix::Info, "decode: %d (left:%d)", available, bytes_left); uint8_t *data = frame_buffer.data(); int rc = MP3Decode(decoder, &data, &bytes_left, (short *)pcm_buffer.data(), mp3_type); diff --git a/src/libhelix-aac/aaccommon.h b/src/libhelix-aac/aaccommon.h index 1ddb97d..f841529 100644 --- a/src/libhelix-aac/aaccommon.h +++ b/src/libhelix-aac/aaccommon.h @@ -56,8 +56,10 @@ # define AAC_ENABLE_SBR #endif // HELIX_FEATURE_AUDIO_CODEC_AAC_SBR. +#ifndef ARDUINO #pragma GCC optimize ("O3") - +#pragma GCC diagnostic ignored "-Wstringop-overflow" +#endif #include "aacdec.h" #include "statname.h" diff --git a/src/libhelix-aac/aacdec.h b/src/libhelix-aac/aacdec.h index 86b6a9a..678454d 100644 --- a/src/libhelix-aac/aacdec.h +++ b/src/libhelix-aac/aacdec.h @@ -68,7 +68,7 @@ # #elif defined(_SOLARIS) && !defined(__GNUC__) # -#elif defined(ARDUINO) +#elif defined(ARDUINO) || defined(ESP32) # #else #error No platform defined. See valid options in aacdec.h diff --git a/src/libhelix-aac/assembly.h b/src/libhelix-aac/assembly.h index 595a8fc..a773cc2 100644 --- a/src/libhelix-aac/assembly.h +++ b/src/libhelix-aac/assembly.h @@ -500,7 +500,7 @@ static __inline Word64 MADD64(Word64 sum64, int x, int y) return sum64; } -#elif defined(ARDUINO) || defined(__GNUC__) && (defined(__powerpc__) || defined(__POWERPC__)) || (defined (_SOLARIS) && !defined (__GNUC__) && !defined (_SOLARISX86)) +#elif defined(ARDUINO) || defined(ESP32) || defined(__GNUC__) && (defined(__powerpc__) || defined(__POWERPC__)) || (defined (_SOLARIS) && !defined (__GNUC__) && !defined (_SOLARISX86)) typedef long long Word64; diff --git a/src/libhelix-mp3/assembly.h b/src/libhelix-mp3/assembly.h index e444885..a38589a 100644 --- a/src/libhelix-mp3/assembly.h +++ b/src/libhelix-mp3/assembly.h @@ -417,7 +417,7 @@ static __inline Word64 SAR64(Word64 x, int n) return (x >> n); } -#elif defined(ARDUINO) || defined(__APPLE__) || defined(__unix__) +#elif defined(ARDUINO) || defined(ESP32) || defined(__APPLE__) || defined(__unix__) static __inline int FASTABS(int x) { diff --git a/src/utils/Allocator.h b/src/utils/Allocator.h index daba3d2..dfc6065 100644 --- a/src/utils/Allocator.h +++ b/src/utils/Allocator.h @@ -2,9 +2,14 @@ #include #include #include "utils/helix_log.h" -#ifdef ESP32 -# include "Arduino.h" +#if defined(ESP32) +# if defined(ARDUINO) +# include "Arduino.h" +# else +# include "esp_heap_caps.h" +# endif #endif + namespace libhelix { /** @@ -93,8 +98,12 @@ class AllocatorExt : public Allocator { void* do_allocate(size_t size) { void* result = nullptr; if (size == 0) size = 1; -#ifdef ESP32 +#if defined(ESP32) +# if defined(ARDUINO) result = ps_malloc(size); +# else + result = heap_caps_malloc(size, MALLOC_CAP_SPIRAM); +# endif #endif if (result == nullptr) result = malloc(size); if (result == nullptr) { @@ -107,7 +116,7 @@ class AllocatorExt : public Allocator { } }; -#ifdef ESP32 +#if defined(ESP32) && defined(ARDUINO) /** * @brief Memory allocateator which uses ps_malloc to allocate the memory in diff --git a/src/utils/Buffers.h b/src/utils/Buffers.h index cb39527..4310ff1 100644 --- a/src/utils/Buffers.h +++ b/src/utils/Buffers.h @@ -6,7 +6,8 @@ #include "utils/Vector.h" #ifndef MIN -#define MIN(a,b) ((a) < (b) ? (a) : (b)) +# define MIN(a,b) (((a)<(b))?(a):(b)) +# define MAX(a,b) (((a)>(b))?(a):(b)) #endif @@ -214,7 +215,7 @@ class SingleBuffer : public BaseBuffer { int available() override { int result = current_write_pos - current_read_pos; - return max(result, 0); + return MAX(result, 0); } int availableForWrite() override { return max_size - current_write_pos; } @@ -258,7 +259,7 @@ class SingleBuffer : public BaseBuffer { /// If we load values directly into the address we need to set the avialeble /// size size_t setAvailable(size_t available_size) { - size_t result = min(available_size, (size_t) max_size); + size_t result = MIN(available_size, (size_t) max_size); current_read_pos = 0; current_write_pos = result; return result; From d979e3d3c22417441a2c5613f0363e4c2f48326e Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Thu, 6 Mar 2025 17:03:49 +0100 Subject: [PATCH 12/30] Buffers: compile error for missing MAX --- src/utils/Buffers.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/utils/Buffers.h b/src/utils/Buffers.h index 4310ff1..a0c37c1 100644 --- a/src/utils/Buffers.h +++ b/src/utils/Buffers.h @@ -7,6 +7,9 @@ #ifndef MIN # define MIN(a,b) (((a)<(b))?(a):(b)) +#endif + +#ifndef MAX # define MAX(a,b) (((a)>(b))?(a):(b)) #endif From 6a06e1bca5c219613003d58dc66c915e9064c9dc Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Thu, 6 Mar 2025 17:20:39 +0100 Subject: [PATCH 13/30] Cleanup Buffers.h --- src/utils/Buffers.h | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/utils/Buffers.h b/src/utils/Buffers.h index a0c37c1..842491a 100644 --- a/src/utils/Buffers.h +++ b/src/utils/Buffers.h @@ -22,10 +22,6 @@ namespace libhelix { -// forward declaration -template -class NBuffer; - /** * @brief Shared functionality of all buffers * @ingroup buffers @@ -295,4 +291,4 @@ class SingleBuffer : public BaseBuffer { }; -} // namespace audio_tools +} // ns From 026daf01b390cdf427997251e0d75fb3524be518 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Thu, 6 Mar 2025 17:25:25 +0100 Subject: [PATCH 14/30] Rev 0.8.8 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 0f0ad0e..d726861 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=libhelix -version=0.8.7 +version=0.8.8 author=Phil Schatzmann maintainer= https://github.com/pschatzmann sentence=libhelix audio decoder for Arduino From af9091a6032aad12226374a34cbb4de7a83a4f8c Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Fri, 7 Mar 2025 19:01:13 +0100 Subject: [PATCH 15/30] idf logging support outside of Arduino --- docs/html/_a_a_c_decoder_helix_8h_source.html | 97 +++--- docs/html/_common_helix_8h_source.html | 286 +++++++++--------- docs/html/_config_helix_8h_source.html | 16 +- docs/html/_m_p3_decoder_helix_8h_source.html | 80 ++--- docs/html/index.html | 4 +- src/AACDecoderHelix.h | 6 +- src/CommonHelix.h | 18 +- src/ConfigHelix.h | 7 +- src/MP3DecoderHelix.h | 8 +- src/utils/Allocator.h | 8 +- src/utils/Buffers.h | 10 +- src/utils/helix_log.h | 20 +- src/utils/helix_log_idf.h | 19 ++ src/utils/helix_log_std.h | 27 ++ 14 files changed, 336 insertions(+), 270 deletions(-) create mode 100644 src/utils/helix_log_idf.h create mode 100644 src/utils/helix_log_std.h diff --git a/docs/html/_a_a_c_decoder_helix_8h_source.html b/docs/html/_a_a_c_decoder_helix_8h_source.html index c924cc3..25ed065 100644 --- a/docs/html/_a_a_c_decoder_helix_8h_source.html +++ b/docs/html/_a_a_c_decoder_helix_8h_source.html @@ -111,7 +111,7 @@
48  _AACFrameInfo audioInfo() { return aacFrameInfo; }
49 
51  virtual void end() override {
-
52  LOG_HELIX(LogLevelHelix::Debug, "end");
+
52  LOGD_HELIX( "end");
53  if (decoder != nullptr) {
54  flush();
55  AACFreeDecoder(decoder);
@@ -162,49 +162,54 @@
103  }
104 
106  int decode() override {
-
107  int processed = 0;
-
108  int available = frame_buffer.available();
-
109  int bytes_left = frame_buffer.available();
-
110  uint8_t *data = frame_buffer.data();
-
111  int rc = AACDecode(decoder, &data, &bytes_left, (short *)pcm_buffer.data());
-
112  if (rc == 0) {
-
113  processed = data - frame_buffer.data();
-
114  // return the decoded result
-
115  _AACFrameInfo info;
-
116  AACGetLastFrameInfo(decoder, &info);
-
117  provideResult(info);
-
118  }
-
119  return processed;
-
120  }
-
121 
-
122  // return the result PCM data
-
123  void provideResult(_AACFrameInfo &info) {
-
124  // increase PCM size if this fails
-
125  int sampleSize = info.bitsPerSample / 8;
-
126  assert(info.outputSamps * sampleSize <= maxPCMSize());
-
127 
-
128  LOG_HELIX(LogLevelHelix::Debug, "==> provideResult: %d samples", info.outputSamps);
-
129  if (info.outputSamps > 0) {
-
130  // provide result
-
131  if (pcmCallback != nullptr) {
-
132  // output via callback
-
133  pcmCallback(info, (short *)pcm_buffer.data(), info.outputSamps,
-
134  p_caller_data);
-
135  } else {
-
136  // output to stream
-
137  if (info.sampRateOut != aacFrameInfo.sampRateOut &&
-
138  infoCallback != nullptr) {
-
139  infoCallback(info, p_caller_ref);
-
140  }
-
141 #if defined(ARDUINO) || defined(HELIX_PRINT)
-
142  out->write((uint8_t *)pcm_buffer.data(), info.outputSamps * sampleSize);
-
143 #endif
-
144  }
-
145  aacFrameInfo = info;
-
146  }
-
147  }
-
148 };
-
149 } // namespace libhelix
+
107  LOGD_HELIX( "decode");
+
108  int processed = 0;
+
109  int available = frame_buffer.available();
+
110  int bytes_left = frame_buffer.available();
+
111  uint8_t *data = frame_buffer.data();
+
112  int rc = AACDecode(decoder, &data, &bytes_left, (short *)pcm_buffer.data());
+
113  if (rc == 0) {
+
114  processed = data - frame_buffer.data();
+
115  // return the decoded result
+
116  _AACFrameInfo info;
+
117  AACGetLastFrameInfo(decoder, &info);
+
118  provideResult(info);
+
119  }
+
120  return processed;
+
121  }
+
122 
+
123  // return the result PCM data
+
124  void provideResult(_AACFrameInfo &info) {
+
125  // increase PCM size if this fails
+
126  int sampleSize = info.bitsPerSample / 8;
+
127  assert(info.outputSamps * sampleSize <= maxPCMSize());
+
128 
+
129  LOGD_HELIX( "==> provideResult: %d samples", info.outputSamps);
+
130  if (info.outputSamps > 0) {
+
131  // provide result
+
132  if (pcmCallback != nullptr) {
+
133  // output via callback
+
134  pcmCallback(info, (short *)pcm_buffer.data(), info.outputSamps,
+
135  p_caller_data);
+
136  } else {
+
137  // output to stream
+
138  if (info.sampRateOut != aacFrameInfo.sampRateOut &&
+
139  infoCallback != nullptr) {
+
140  infoCallback(info, p_caller_ref);
+
141  }
+
142 #if defined(ARDUINO) || defined(HELIX_PRINT)
+
143  if (out != nullptr){
+
144  size_t to_write = info.outputSamps * sampleSize;
+
145  size_t written = out->write((uint8_t *)pcm_buffer.data(), to_write);
+
146  assert(written == to_write);
+
147  }
+
148 #endif
+
149  }
+
150  aacFrameInfo = info;
+
151  }
+
152  }
+
153 };
+
154 } // namespace libhelix
libhelix::AACDecoderHelix
A simple Arduino API for the libhelix AAC decoder. The data us provided with the help of write() call...
Definition: AACDecoderHelix.h:19
libhelix::AACDecoderHelix::audioInfo
_AACFrameInfo audioInfo()
Provides the last available _AACFrameInfo_t.
Definition: AACDecoderHelix.h:48
libhelix::AACDecoderHelix::maxPCMSize
size_t maxPCMSize() override
Definition: AACDecoderHelix.h:66
@@ -215,9 +220,9 @@
libhelix::AACDecoderHelix::maxFrameSize
size_t maxFrameSize() override
Definition: AACDecoderHelix.h:62
libhelix::AACDecoderHelix::findSynchWord
int findSynchWord(int offset=0) override
finds the sync word in the buffer
Definition: AACDecoderHelix.h:97
libhelix::CommonHelix
Common Simple Arduino API.
Definition: CommonHelix.h:33
-
libhelix::CommonHelix::flush
void flush()
Decode all open packets.
Definition: CommonHelix.h:102
+
libhelix::CommonHelix::flush
void flush()
Decode all open packets.
Definition: CommonHelix.h:104
libhelix::CommonHelix::end
virtual void end()
Releases the reserved memory.
Definition: CommonHelix.h:63
-
libhelix::CommonHelix::setMinFrameBufferSize
virtual void setMinFrameBufferSize(int size)
Defines the minimum frame buffer size which is required before starting the decoding.
Definition: CommonHelix.h:243
+
libhelix::CommonHelix::setMinFrameBufferSize
virtual void setMinFrameBufferSize(int size)
Defines the minimum frame buffer size which is required before starting the decoding.
Definition: CommonHelix.h:251
diff --git a/docs/html/_common_helix_8h_source.html b/docs/html/_common_helix_8h_source.html index 169982b..fe0434a 100644 --- a/docs/html/_common_helix_8h_source.html +++ b/docs/html/_common_helix_8h_source.html @@ -128,7 +128,7 @@
68  }
69 
76  virtual size_t write(const void *in_ptr, size_t in_size) {
-
77  LOG_HELIX(LogLevelHelix::Info, "write %zu", in_size);
+
77  LOGI_HELIX( "write %zu", in_size);
78  int open = in_size;
79  size_t processed = 0;
80  uint8_t *data = (uint8_t *)in_ptr;
@@ -145,157 +145,165 @@
91 
93  operator bool() { return active; }
94 
-
96  uint64_t timeOfLastWrite() { return time_last_write; }
-
97 
-
99  uint64_t timeOfLastResult() { return time_last_result; }
-
100 
-
102  void flush() {
-
103  int rc = 1;
-
104  while (rc >= 0) {
-
105  if (!presync()) break;
-
106  rc = decode();
-
107  if (!resynch(rc)) break;
-
108  // remove processed data
-
109  frame_buffer.clearArray(rc);
-
110  }
-
111  }
-
112 
-
115  virtual size_t maxFrameSize() = 0;
-
116 
-
118  void setMaxFrameSize(size_t len) { max_frame_size = len; }
-
119 
-
122  virtual size_t maxPCMSize() = 0;
-
123 
-
125  void setMaxPCMSize(size_t len) { max_pcm_size = len; }
-
126 
-
128  void setReference(void* ref){
-
129  p_caller_ref = ref;
-
130  }
+
95 #ifdef ARDUINO
+
97  uint64_t timeOfLastWrite() { return time_last_write; }
+
98 
+
100  uint64_t timeOfLastResult() { return time_last_result; }
+
101 #endif
+
102 
+
104  void flush() {
+
105  int rc = 1;
+
106  while (rc >= 0) {
+
107  // we must start with sych word
+
108  if (!presync()) break;
+
109  // we must end with synch world
+
110  if (findSynchWord(3) < 0) break;
+
111  rc = decode();
+
112  if (!resynch(rc)) break;
+
113  // remove processed data
+
114  if (rc > 0) frame_buffer.clearArray(rc);
+
115  }
+
116  }
+
117 
+
120  virtual size_t maxFrameSize() = 0;
+
121 
+
123  void setMaxFrameSize(size_t len) { max_frame_size = len; }
+
124 
+
127  virtual size_t maxPCMSize() = 0;
+
128 
+
130  void setMaxPCMSize(size_t len) { max_pcm_size = len; }
131 
-
132  protected:
-
133  bool active = false;
-
134  bool is_raw = false;
-
135  Vector<uint8_t> pcm_buffer{0};
-
136  SingleBuffer<uint8_t> frame_buffer{0};
-
137  size_t max_frame_size = 0;
-
138  size_t max_pcm_size = 0;
-
139  size_t frame_counter = 0;
-
140  int delay_ms = -1;
-
141  int parse_0_count = 0; // keep track of parser returning 0
-
142  int min_frame_buffer_size = 0;
-
143  uint64_t time_last_write = 0;
-
144  uint64_t time_last_result = 0;
-
145  void *p_caller_ref = nullptr;
-
146 
-
147 
-
148 #if defined(ARDUINO) || defined(HELIX_PRINT)
-
149  Print *out = nullptr;
-
150 #endif
+
133  void setReference(void* ref){
+
134  p_caller_ref = ref;
+
135  }
+
136 
+
137  protected:
+
138  bool active = false;
+
139  bool is_raw = false;
+
140  Vector<uint8_t> pcm_buffer{0};
+
141  SingleBuffer<uint8_t> frame_buffer{0};
+
142  size_t max_frame_size = 0;
+
143  size_t max_pcm_size = 0;
+
144  size_t frame_counter = 0;
+
145  int delay_ms = -1;
+
146  int parse_0_count = 0; // keep track of parser returning 0
+
147  int min_frame_buffer_size = 0;
+
148  uint64_t time_last_write = 0;
+
149  uint64_t time_last_result = 0;
+
150  void *p_caller_ref = nullptr;
151 
-
153  bool presync() {
-
154  LOG_HELIX(LogLevelHelix::Debug, "presynch");
-
155  bool rc = true;
-
156  int pos = findSynchWord();
-
157  if (pos > 3) rc = removeInvalidData(pos);
-
158  return rc;
-
159  }
-
160 
-
163  bool resynch(int rc) {
-
164  LOG_HELIX(LogLevelHelix::Debug, "resynch: %d" , rc);
-
165  // reset 0 result counter
-
166  if (rc != 0) parse_0_count = 0;
-
167  if (rc <= 0) {
-
168  if (rc == 0) {
-
169  parse_0_count++;
-
170  int pos = findSynchWord(SYNCH_WORD_LEN);
-
171  LOG_HELIX(LogLevelHelix::Debug, "rc: %d - available %d - pos %d", rc,
-
172  frame_buffer.available(), pos);
-
173  // if we are stuck, request more data and if this does not help we
-
174  // remove the invalid data
-
175  if (parse_0_count > 2) {
-
176  return removeInvalidData(pos);
-
177  }
-
178  return false;
-
179  } else if (rc == -1) {
-
180  // underflow
-
181  LOG_HELIX(LogLevelHelix::Debug, "rc: %d - available %d", rc,
-
182  frame_buffer.available());
-
183  return false;
-
184  } else {
-
185  // generic error handling: remove the data until the next synch word
-
186  int pos = findSynchWord(SYNCH_WORD_LEN + 1);
-
187  removeInvalidData(pos);
-
188  }
-
189  }
-
190  return true;
-
191  }
-
192 
-
195  bool removeInvalidData(int pos) {
-
196  LOG_HELIX(LogLevelHelix::Debug, "removeInvalidData: %d", pos);
-
197  if (pos > 0) {
-
198  LOG_HELIX(LogLevelHelix::Info, "removing: %d bytes", pos);
-
199  frame_buffer.clearArray(pos);
-
200  return true;
-
201  } else if (pos <= 0) {
-
202  frame_buffer.reset();
-
203  return false;
-
204  }
-
205  return true;
-
206  }
-
207 
-
209  virtual size_t writeChunk(const void *in_ptr, size_t in_size) {
-
210  LOG_HELIX(LogLevelHelix::Info, "writeChunk %zu", in_size);
-
211  time_last_write = millis();
-
212  size_t result = frame_buffer.writeArray((uint8_t *)in_ptr, in_size);
+
152 
+
153 #if defined(ARDUINO) || defined(HELIX_PRINT)
+
154  Print *out = nullptr;
+
155 #endif
+
156 
+
158  bool presync() {
+
159  LOGD_HELIX( "presynch");
+
160  bool rc = true;
+
161  int pos = findSynchWord();
+
162  if (pos > 3) rc = removeInvalidData(pos);
+
163 
+
164  return rc;
+
165  }
+
166 
+
169  bool resynch(int rc) {
+
170  LOGD_HELIX( "resynch: %d" , rc);
+
171  // reset 0 result counter
+
172  if (rc != 0) parse_0_count = 0;
+
173  if (rc <= 0) {
+
174  if (rc == 0) {
+
175  parse_0_count++;
+
176  int pos = findSynchWord(SYNCH_WORD_LEN);
+
177  LOGD_HELIX( "rc: %d - available %d - pos %d", rc,
+
178  frame_buffer.available(), pos);
+
179  // if we are stuck, request more data and if this does not help we
+
180  // remove the invalid data
+
181  if (parse_0_count > 2) {
+
182  return removeInvalidData(pos);
+
183  }
+
184  return false;
+
185  } else if (rc == -1) {
+
186  // underflow
+
187  LOGD_HELIX( "rc: %d - available %d", rc,
+
188  frame_buffer.available());
+
189  return false;
+
190  } else {
+
191  // generic error handling: remove the data until the next synch word
+
192  int pos = findSynchWord(SYNCH_WORD_LEN + 1);
+
193  removeInvalidData(pos);
+
194  }
+
195  }
+
196  return true;
+
197  }
+
198 
+
201  bool removeInvalidData(int pos) {
+
202  LOGD_HELIX( "removeInvalidData: %d", pos);
+
203  if (pos > 0) {
+
204  LOGI_HELIX( "removing: %d bytes", pos);
+
205  frame_buffer.clearArray(pos);
+
206  return true;
+
207  } else if (pos <= 0) {
+
208  frame_buffer.reset();
+
209  return false;
+
210  }
+
211  return true;
+
212  }
213 
-
214  while (frame_buffer.available() >= minFrameBufferSize()) {
-
215 
-
216  if (!presync()) break;
-
217  int rc = decode();
-
218  if (!resynch(rc)) break;
-
219  // remove processed data
-
220  frame_buffer.clearArray(rc);
-
221 
-
222  LOG_HELIX(LogLevelHelix::Info, "rc: %d - available %d", rc,
-
223  frame_buffer.available());
-
224 
-
225  }
-
226 
-
227  return result;
-
228  }
-
229 
-
231  virtual int decode() = 0;
+
215  virtual size_t writeChunk(const void *in_ptr, size_t in_size) {
+
216  LOGI_HELIX( "writeChunk %zu", in_size);
+
217 #ifdef ARDUINO
+
218  time_last_write = millis();
+
219 #endif
+
220  size_t result = frame_buffer.writeArray((uint8_t *)in_ptr, in_size);
+
221 
+
222  while (frame_buffer.available() >= minFrameBufferSize()) {
+
223 
+
224  if (!presync()) break;
+
225  int rc = decode();
+
226  if (!resynch(rc)) break;
+
227  // remove processed data
+
228  frame_buffer.clearArray(rc);
+
229 
+
230  LOGI_HELIX( "rc: %d - available %d", rc,
+
231  frame_buffer.available());
232 
-
234  virtual bool allocateDecoder() = 0;
-
235 
-
238  virtual int findSynchWord(int offset = 0) = 0;
-
239 
-
241  virtual int minFrameBufferSize() { return min_frame_buffer_size; }
-
243  virtual void setMinFrameBufferSize(int size) { min_frame_buffer_size = size; }
-
244 };
-
245 
-
246 } // namespace libhelix
+
233  }
+
234 
+
235  return result;
+
236  }
+
237 
+
239  virtual int decode() = 0;
+
240 
+
242  virtual bool allocateDecoder() = 0;
+
243 
+
246  virtual int findSynchWord(int offset = 0) = 0;
+
247 
+
249  virtual int minFrameBufferSize() { return min_frame_buffer_size; }
+
251  virtual void setMinFrameBufferSize(int size) { min_frame_buffer_size = size; }
+
252 };
+
253 
+
254 } // namespace libhelix
libhelix::CommonHelix
Common Simple Arduino API.
Definition: CommonHelix.h:33
-
libhelix::CommonHelix::removeInvalidData
bool removeInvalidData(int pos)
Definition: CommonHelix.h:195
+
libhelix::CommonHelix::removeInvalidData
bool removeInvalidData(int pos)
Definition: CommonHelix.h:201
libhelix::CommonHelix::maxPCMSize
virtual size_t maxPCMSize()=0
-
libhelix::CommonHelix::writeChunk
virtual size_t writeChunk(const void *in_ptr, size_t in_size)
Decoding Loop: We decode the procided data until we run out of data.
Definition: CommonHelix.h:209
-
libhelix::CommonHelix::setMaxFrameSize
void setMaxFrameSize(size_t len)
Define your optimized maximum frame size in bytes.
Definition: CommonHelix.h:118
-
libhelix::CommonHelix::flush
void flush()
Decode all open packets.
Definition: CommonHelix.h:102
+
libhelix::CommonHelix::writeChunk
virtual size_t writeChunk(const void *in_ptr, size_t in_size)
Decoding Loop: We decode the procided data until we run out of data.
Definition: CommonHelix.h:215
+
libhelix::CommonHelix::setMaxFrameSize
void setMaxFrameSize(size_t len)
Define your optimized maximum frame size in bytes.
Definition: CommonHelix.h:123
+
libhelix::CommonHelix::flush
void flush()
Decode all open packets.
Definition: CommonHelix.h:104
libhelix::CommonHelix::findSynchWord
virtual int findSynchWord(int offset=0)=0
-
libhelix::CommonHelix::setReference
void setReference(void *ref)
Define some additional information which will be provided back in the callbacks.
Definition: CommonHelix.h:128
+
libhelix::CommonHelix::setReference
void setReference(void *ref)
Define some additional information which will be provided back in the callbacks.
Definition: CommonHelix.h:133
libhelix::CommonHelix::maxFrameSize
virtual size_t maxFrameSize()=0
libhelix::CommonHelix::end
virtual void end()
Releases the reserved memory.
Definition: CommonHelix.h:63
libhelix::CommonHelix::write
virtual size_t write(const void *in_ptr, size_t in_size)
decodes the next segments from the input. The data can be provided in one big or in small incremental...
Definition: CommonHelix.h:76
-
libhelix::CommonHelix::setMinFrameBufferSize
virtual void setMinFrameBufferSize(int size)
Defines the minimum frame buffer size which is required before starting the decoding.
Definition: CommonHelix.h:243
-
libhelix::CommonHelix::timeOfLastWrite
uint64_t timeOfLastWrite()
Provides the timestamp in ms of last write.
Definition: CommonHelix.h:96
-
libhelix::CommonHelix::timeOfLastResult
uint64_t timeOfLastResult()
Provides the timestamp in ms of last decoded result.
Definition: CommonHelix.h:99
+
libhelix::CommonHelix::setMinFrameBufferSize
virtual void setMinFrameBufferSize(int size)
Defines the minimum frame buffer size which is required before starting the decoding.
Definition: CommonHelix.h:251
+
libhelix::CommonHelix::timeOfLastWrite
uint64_t timeOfLastWrite()
Provides the timestamp in ms of last write.
Definition: CommonHelix.h:97
+
libhelix::CommonHelix::timeOfLastResult
uint64_t timeOfLastResult()
Provides the timestamp in ms of last decoded result.
Definition: CommonHelix.h:100
libhelix::CommonHelix::begin
virtual bool begin()
Starts the processing.
Definition: CommonHelix.h:43
libhelix::CommonHelix::allocateDecoder
virtual bool allocateDecoder()=0
Allocate the decoder.
-
libhelix::CommonHelix::setMaxPCMSize
void setMaxPCMSize(size_t len)
Define your optimized maximum pcm buffer size in bytes.
Definition: CommonHelix.h:125
-
libhelix::CommonHelix::minFrameBufferSize
virtual int minFrameBufferSize()
Provides the actual minimum frame buffer size.
Definition: CommonHelix.h:241
-
libhelix::CommonHelix::resynch
bool resynch(int rc)
Definition: CommonHelix.h:163
+
libhelix::CommonHelix::setMaxPCMSize
void setMaxPCMSize(size_t len)
Define your optimized maximum pcm buffer size in bytes.
Definition: CommonHelix.h:130
+
libhelix::CommonHelix::minFrameBufferSize
virtual int minFrameBufferSize()
Provides the actual minimum frame buffer size.
Definition: CommonHelix.h:249
+
libhelix::CommonHelix::resynch
bool resynch(int rc)
Definition: CommonHelix.h:169
libhelix::CommonHelix::decode
virtual int decode()=0
Decode w/o parsing.
-
libhelix::CommonHelix::presync
bool presync()
make sure that we start with a valid sync: remove ID3 data
Definition: CommonHelix.h:153
+
libhelix::CommonHelix::presync
bool presync()
make sure that we start with a valid sync: remove ID3 data
Definition: CommonHelix.h:158
diff --git a/docs/html/_config_helix_8h_source.html b/docs/html/_config_helix_8h_source.html index 2d83939..5c5eea1 100644 --- a/docs/html/_config_helix_8h_source.html +++ b/docs/html/_config_helix_8h_source.html @@ -106,7 +106,7 @@
35 #define ALLOCATOR libhelix::AllocatorExt
36 
37 // Logging: Activate/Deactivate logging
-
38 #if ! defined(HELIX_LOGGING_ACTIVE) && defined(ARDUINO)
+
38 #if !defined(HELIX_LOGGING_ACTIVE)
39 # define HELIX_LOGGING_ACTIVE true
40 #endif
41 
@@ -122,9 +122,17 @@
51 # define HELIX_LOGGING_OUT Serial
52 #endif
53 
-
54 #ifndef HELIX_LOG_SIZE
-
55 # define HELIX_LOG_SIZE 256
-
56 #endif
+
55 #if HELIX_LOGGING_ACTIVE && defined(ESP32) && !defined(ARDUINO)
+
56 # define USE_IDF_LOGGER
+
57 #endif
+
58 
+
59 #ifndef HELIX_LOG_SIZE
+
60 # define HELIX_LOG_SIZE 256
+
61 #endif
+
62 
+
64 #ifndef ESP8266
+
65 # define HELIX_FEATURE_AUDIO_CODEC_AAC_SBR
+
66 #endif
diff --git a/docs/html/_m_p3_decoder_helix_8h_source.html b/docs/html/_m_p3_decoder_helix_8h_source.html index 469677a..f24e96c 100644 --- a/docs/html/_m_p3_decoder_helix_8h_source.html +++ b/docs/html/_m_p3_decoder_helix_8h_source.html @@ -122,7 +122,7 @@
59  MP3FrameInfo audioInfo() { return mp3FrameInfo; }
60 
62  void end() override {
-
63  LOG_HELIX(LogLevelHelix::Debug, "end");
+
63  LOGD_HELIX( "end");
64 
65  if (decoder != nullptr) {
66  flush();
@@ -169,7 +169,7 @@
113  int processed = 0;
114  int available = frame_buffer.available();
115  int bytes_left = frame_buffer.available();
-
116  LOG_HELIX(LogLevelHelix::Info, "decode: %d", frame_buffer.available());
+
116  LOGI_HELIX( "decode: %d (left:%d)", available, bytes_left);
117  uint8_t *data = frame_buffer.data();
118  int rc = MP3Decode(decoder, &data, &bytes_left, (short *)pcm_buffer.data(),
119  mp3_type);
@@ -180,44 +180,48 @@
124  MP3GetLastFrameInfo(decoder, &info);
125  provideResult(info);
126  } else {
-
127  LOG_HELIX(LogLevelHelix::Info, "MP3Decode rc: %d", rc);
-
128  processed = rc;
-
129  }
-
130  return processed;
-
131  }
-
132 
-
133  // return the resulting PCM data
-
134  void provideResult(MP3FrameInfo &info) {
-
135  // increase PCM size if this fails
-
136  assert(info.outputSamps * sizeof(short) < maxPCMSize());
-
137 
-
138  LOG_HELIX(LogLevelHelix::Debug, "=> provideResult: %d", info.outputSamps);
-
139  if (info.outputSamps > 0) {
-
140  // provide result
-
141  if (pcmCallback != nullptr) {
-
142  // output via callback
-
143  pcmCallback(info, (short *)pcm_buffer.data(), info.outputSamps,
-
144  p_caller_data);
-
145  } else {
-
146  // output to stream
-
147  if (info.samprate != mp3FrameInfo.samprate && infoCallback != nullptr) {
-
148  infoCallback(info, p_caller_ref);
-
149  }
-
150 #if defined(ARDUINO) || defined(HELIX_PRINT)
-
151  int sampleSize = info.bitsPerSample / 8;
-
152  out->write((uint8_t *)pcm_buffer.data(), info.outputSamps * sampleSize);
-
153 #endif
-
154  }
-
155  mp3FrameInfo = info;
-
156  }
-
157  }
-
158 };
-
159 
-
160 } // namespace libhelix
+
127  LOGI_HELIX( "MP3Decode rc: %d", rc);
+
128  }
+
129  return processed;
+
130  }
+
131 
+
132  // return the resulting PCM data
+
133  void provideResult(MP3FrameInfo &info) {
+
134  // increase PCM size if this fails
+
135  assert(info.outputSamps * sizeof(short) < maxPCMSize());
+
136 
+
137  LOGD_HELIX( "=> provideResult: %d", info.outputSamps);
+
138  if (info.outputSamps > 0) {
+
139  // provide result
+
140  if (pcmCallback != nullptr) {
+
141  // output via callback
+
142  pcmCallback(info, (short *)pcm_buffer.data(), info.outputSamps,
+
143  p_caller_data);
+
144  } else {
+
145  // output to stream
+
146  if (info.samprate != mp3FrameInfo.samprate && infoCallback != nullptr) {
+
147  infoCallback(info, p_caller_ref);
+
148  }
+
149 #if defined(ARDUINO) || defined(HELIX_PRINT)
+
150  if (out != nullptr){
+
151  int sampleSize = info.bitsPerSample / 8;
+
152  int toWrite = info.outputSamps * sampleSize;
+
153  int written = out->write((uint8_t *)pcm_buffer.data(), toWrite);
+
154  // assume blocking write
+
155  assert(written == toWrite);
+
156  }
+
157 #endif
+
158  }
+
159  mp3FrameInfo = info;
+
160  }
+
161  }
+
162 };
+
163 
+
164 } // namespace libhelix
libhelix::CommonHelix
Common Simple Arduino API.
Definition: CommonHelix.h:33
-
libhelix::CommonHelix::flush
void flush()
Decode all open packets.
Definition: CommonHelix.h:102
+
libhelix::CommonHelix::flush
void flush()
Decode all open packets.
Definition: CommonHelix.h:104
libhelix::CommonHelix::end
virtual void end()
Releases the reserved memory.
Definition: CommonHelix.h:63
-
libhelix::CommonHelix::setMinFrameBufferSize
virtual void setMinFrameBufferSize(int size)
Defines the minimum frame buffer size which is required before starting the decoding.
Definition: CommonHelix.h:243
+
libhelix::CommonHelix::setMinFrameBufferSize
virtual void setMinFrameBufferSize(int size)
Defines the minimum frame buffer size which is required before starting the decoding.
Definition: CommonHelix.h:251
libhelix::MP3DecoderHelix
A simple Arduino API for the libhelix MP3 decoder. The data is provided with the help of write() call...
Definition: MP3DecoderHelix.h:23
libhelix::MP3DecoderHelix::end
void end() override
Releases the reserved memory.
Definition: MP3DecoderHelix.h:62
libhelix::MP3DecoderHelix::findSynchWord
int findSynchWord(int offset=0) override
Definition: MP3DecoderHelix.h:103
diff --git a/docs/html/index.html b/docs/html/index.html index e3984eb..d489e6e 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -107,7 +107,7 @@

Installation

For Arduino, you can download the library as zip and call include Library -> zip library. Or you can git clone this project into the Arduino libraries folder e.g. with

cd ~/Documents/Arduino/libraries
-
git clone pschatzmann/arduino-libhelix.git
+
git clone https://github.com/pschatzmann/arduino-libhelix.git

This project can also be built and executed on your desktop with cmake:

cd arduino-libhelix
mkdir build
@@ -135,6 +135,8 @@

Documentation

I recommend to use this library together with my Arduino Audio Tools. This is just one of many codecs that I have collected so far: Further details can be found in the Encoding and Decoding Wiki of the Audio Tools.

diff --git a/src/AACDecoderHelix.h b/src/AACDecoderHelix.h index 9a2bf89..fa38c3f 100644 --- a/src/AACDecoderHelix.h +++ b/src/AACDecoderHelix.h @@ -49,7 +49,7 @@ class AACDecoderHelix : public CommonHelix { /// Releases the reserved memory virtual void end() override { - LOG_HELIX(LogLevelHelix::Debug, "end"); + LOGD_HELIX( "end"); if (decoder != nullptr) { flush(); AACFreeDecoder(decoder); @@ -104,7 +104,7 @@ class AACDecoderHelix : public CommonHelix { /// decods the data and removes the decoded frame from the buffer int decode() override { - LOG_HELIX(LogLevelHelix::Debug, "decode"); + LOGD_HELIX( "decode"); int processed = 0; int available = frame_buffer.available(); int bytes_left = frame_buffer.available(); @@ -126,7 +126,7 @@ class AACDecoderHelix : public CommonHelix { int sampleSize = info.bitsPerSample / 8; assert(info.outputSamps * sampleSize <= maxPCMSize()); - LOG_HELIX(LogLevelHelix::Debug, "==> provideResult: %d samples", info.outputSamps); + LOGD_HELIX( "==> provideResult: %d samples", info.outputSamps); if (info.outputSamps > 0) { // provide result if (pcmCallback != nullptr) { diff --git a/src/CommonHelix.h b/src/CommonHelix.h index 8662e05..a22d135 100644 --- a/src/CommonHelix.h +++ b/src/CommonHelix.h @@ -74,7 +74,7 @@ class CommonHelix { * not fit into the buffer it is split up into small pieces that fit */ virtual size_t write(const void *in_ptr, size_t in_size) { - LOG_HELIX(LogLevelHelix::Info, "write %zu", in_size); + LOGI_HELIX( "write %zu", in_size); int open = in_size; size_t processed = 0; uint8_t *data = (uint8_t *)in_ptr; @@ -156,7 +156,7 @@ class CommonHelix { /// make sure that we start with a valid sync: remove ID3 data bool presync() { - LOG_HELIX(LogLevelHelix::Debug, "presynch"); + LOGD_HELIX( "presynch"); bool rc = true; int pos = findSynchWord(); if (pos > 3) rc = removeInvalidData(pos); @@ -167,14 +167,14 @@ class CommonHelix { /// advance on invalid data, returns true if we need to continue the /// processing bool resynch(int rc) { - LOG_HELIX(LogLevelHelix::Debug, "resynch: %d" , rc); + LOGD_HELIX( "resynch: %d" , rc); // reset 0 result counter if (rc != 0) parse_0_count = 0; if (rc <= 0) { if (rc == 0) { parse_0_count++; int pos = findSynchWord(SYNCH_WORD_LEN); - LOG_HELIX(LogLevelHelix::Debug, "rc: %d - available %d - pos %d", rc, + LOGD_HELIX( "rc: %d - available %d - pos %d", rc, frame_buffer.available(), pos); // if we are stuck, request more data and if this does not help we // remove the invalid data @@ -184,7 +184,7 @@ class CommonHelix { return false; } else if (rc == -1) { // underflow - LOG_HELIX(LogLevelHelix::Debug, "rc: %d - available %d", rc, + LOGD_HELIX( "rc: %d - available %d", rc, frame_buffer.available()); return false; } else { @@ -199,9 +199,9 @@ class CommonHelix { /// removes invalid data not starting with a synch word. /// @return Returns true if we still have data to be played bool removeInvalidData(int pos) { - LOG_HELIX(LogLevelHelix::Debug, "removeInvalidData: %d", pos); + LOGD_HELIX( "removeInvalidData: %d", pos); if (pos > 0) { - LOG_HELIX(LogLevelHelix::Info, "removing: %d bytes", pos); + LOGI_HELIX( "removing: %d bytes", pos); frame_buffer.clearArray(pos); return true; } else if (pos <= 0) { @@ -213,7 +213,7 @@ class CommonHelix { /// Decoding Loop: We decode the procided data until we run out of data virtual size_t writeChunk(const void *in_ptr, size_t in_size) { - LOG_HELIX(LogLevelHelix::Info, "writeChunk %zu", in_size); + LOGI_HELIX( "writeChunk %zu", in_size); #ifdef ARDUINO time_last_write = millis(); #endif @@ -227,7 +227,7 @@ class CommonHelix { // remove processed data frame_buffer.clearArray(rc); - LOG_HELIX(LogLevelHelix::Info, "rc: %d - available %d", rc, + LOGI_HELIX( "rc: %d - available %d", rc, frame_buffer.available()); } diff --git a/src/ConfigHelix.h b/src/ConfigHelix.h index 2800512..4b8a127 100644 --- a/src/ConfigHelix.h +++ b/src/ConfigHelix.h @@ -35,7 +35,7 @@ #define ALLOCATOR libhelix::AllocatorExt // Logging: Activate/Deactivate logging -#if ! defined(HELIX_LOGGING_ACTIVE) && defined(ARDUINO) +#if !defined(HELIX_LOGGING_ACTIVE) # define HELIX_LOGGING_ACTIVE true #endif @@ -51,6 +51,11 @@ # define HELIX_LOGGING_OUT Serial #endif +/// Use the IDF logger for ESP32 wieh +#if HELIX_LOGGING_ACTIVE && defined(ESP32) && !defined(ARDUINO) +# define USE_IDF_LOGGER +#endif + #ifndef HELIX_LOG_SIZE # define HELIX_LOG_SIZE 256 #endif diff --git a/src/MP3DecoderHelix.h b/src/MP3DecoderHelix.h index 9c188fc..47d46e7 100644 --- a/src/MP3DecoderHelix.h +++ b/src/MP3DecoderHelix.h @@ -60,7 +60,7 @@ class MP3DecoderHelix : public CommonHelix { /// Releases the reserved memory void end() override { - LOG_HELIX(LogLevelHelix::Debug, "end"); + LOGD_HELIX( "end"); if (decoder != nullptr) { flush(); @@ -113,7 +113,7 @@ class MP3DecoderHelix : public CommonHelix { int processed = 0; int available = frame_buffer.available(); int bytes_left = frame_buffer.available(); - LOG_HELIX(LogLevelHelix::Info, "decode: %d (left:%d)", available, bytes_left); + LOGI_HELIX( "decode: %d (left:%d)", available, bytes_left); uint8_t *data = frame_buffer.data(); int rc = MP3Decode(decoder, &data, &bytes_left, (short *)pcm_buffer.data(), mp3_type); @@ -124,7 +124,7 @@ class MP3DecoderHelix : public CommonHelix { MP3GetLastFrameInfo(decoder, &info); provideResult(info); } else { - LOG_HELIX(LogLevelHelix::Info, "MP3Decode rc: %d", rc); + LOGI_HELIX( "MP3Decode rc: %d", rc); } return processed; } @@ -134,7 +134,7 @@ class MP3DecoderHelix : public CommonHelix { // increase PCM size if this fails assert(info.outputSamps * sizeof(short) < maxPCMSize()); - LOG_HELIX(LogLevelHelix::Debug, "=> provideResult: %d", info.outputSamps); + LOGD_HELIX( "=> provideResult: %d", info.outputSamps); if (info.outputSamps > 0) { // provide result if (pcmCallback != nullptr) { diff --git a/src/utils/Allocator.h b/src/utils/Allocator.h index dfc6065..48680ad 100644 --- a/src/utils/Allocator.h +++ b/src/utils/Allocator.h @@ -68,10 +68,10 @@ class Allocator { virtual void* allocate(size_t size) { void* result = do_allocate(size); if (result == nullptr) { - LOG_HELIX(LogLevelHelix::Error,"Allocateation failed for %zu bytes", size); + LOGE_HELIX("Allocateation failed for %zu bytes", size); while(1); } else { - LOG_HELIX(LogLevelHelix::Debug,"Allocated %zu", size); + LOGD_HELIX("Allocated %zu", size); } return result; } @@ -107,7 +107,7 @@ class AllocatorExt : public Allocator { #endif if (result == nullptr) result = malloc(size); if (result == nullptr) { - LOG_HELIX(LogLevelHelix::Error,"allocateation failed for %zu bytes", size); + LOGE_HELIX("allocateation failed for %zu bytes", size); while(true); } // initialize object @@ -132,7 +132,7 @@ class AllocatorPSRAM : public Allocator { void* result = nullptr; result = ps_calloc(1, size); if (result == nullptr) { - LOG_HELIX(LogLevelHelix::Error,"allocateation failed for %zu bytes", size); + LOGE_HELIX("allocateation failed for %zu bytes", size); while(true); } return result; diff --git a/src/utils/Buffers.h b/src/utils/Buffers.h index 842491a..67ee0df 100644 --- a/src/utils/Buffers.h +++ b/src/utils/Buffers.h @@ -42,14 +42,14 @@ class BaseBuffer { /// reads multiple values virtual int readArray(T data[], int len) { if (data==nullptr){ - LOG_HELIX(LogLevelHelix::Error,"NPE"); + LOGE_HELIX("NPE"); return 0; } int lenResult = MIN(len, available()); for (int j = 0; j < lenResult; j++) { data[j] = read(); } - LOG_HELIX(LogLevelHelix::Debug,"readArray %d -> %d", len, lenResult); + LOGD_HELIX("readArray %d -> %d", len, lenResult); return lenResult; } @@ -65,7 +65,7 @@ class BaseBuffer { /// Fills the buffer data virtual int writeArray(const T data[], int len) { - // LOG_HELIX(LogLevelHelix::Debug,"%s: %d", LOG_METHOD, len); + // LOGD_HELIX("%s: %d", LOG_METHOD, len); // CHECK_MEMORY(); int result = 0; @@ -76,7 +76,7 @@ class BaseBuffer { result = j + 1; } // CHECK_MEMORY(); - LOG_HELIX(LogLevelHelix::Debug,"writeArray %d -> %d", len, result); + LOGD_HELIX("writeArray %d -> %d", len, result); return result; } @@ -93,7 +93,7 @@ class BaseBuffer { /// reads multiple values for array of 2 dimensional frames int readFrames(T data[][2], int len) { - LOG_HELIX(LogLevelHelix::Debug,"%s: %d", LOG_METHOD, len); + LOGD_HELIX("%s: %d", LOG_METHOD, len); // CHECK_MEMORY(); int result = MIN(len, available()); for (int j = 0; j < result; j++) { diff --git a/src/utils/helix_log.h b/src/utils/helix_log.h index e82ec26..7c245e7 100644 --- a/src/utils/helix_log.h +++ b/src/utils/helix_log.h @@ -1,20 +1,8 @@ #pragma once -#include "stdio.h" // for snprintf #include "../ConfigHelix.h" - -#if defined(ARDUINO) && HELIX_LOGGING_ACTIVE -# include "Arduino.h" // for Serial; include Serial.h does not work -#endif - -// Logging Implementation -#if HELIX_LOGGING_ACTIVE == true - extern char log_buffer_helix[HELIX_LOG_SIZE]; - enum class LogLevelHelix {Debug, Info, Warning, Error}; - static LogLevelHelix LOGLEVEL_HELIX = HELIX_LOG_LEVEL; - // We print the log based on the log level - #define LOG_HELIX(level,...) { if(level>=LOGLEVEL_HELIX) { int l = snprintf(log_buffer_helix,512, __VA_ARGS__); HELIX_LOGGING_OUT.print("libhelix - "); HELIX_LOGGING_OUT.write(log_buffer_helix,l); HELIX_LOGGING_OUT.println(); } } +#if defined(USE_IDF_LOGGER) +# include "utils/helix_log_idf.h" #else - // Remove all log statments from the code - #define LOG_HELIX(...) -#endif +# include "utils/helix_log_std.h" +#endif \ No newline at end of file diff --git a/src/utils/helix_log_idf.h b/src/utils/helix_log_idf.h new file mode 100644 index 0000000..0ff8d62 --- /dev/null +++ b/src/utils/helix_log_idf.h @@ -0,0 +1,19 @@ +#pragma once +#include "../ConfigHelix.h" +#include "esp_log.h" + +// Logging Implementation +#if HELIX_LOGGING_ACTIVE + #define TAG_HELIX "libhelix" + #define LOGD_HELIX(...) ESP_LOGD(TAG_HELIX,__VA_ARGS__); + #define LOGI_HELIX(...) ESP_LOGI(TAG_HELIX,__VA_ARGS__); + #define LOGW_HELIX(...) ESP_LOGW(TAG_HELIX,__VA_ARGS__); + #define LOGE_HELIX(...) ESP_LOGE(TAG_HELIX,__VA_ARGS__); +#else + // Remove all log statments from the code + #define LOGD_HELIX(...) + #define LOGI_HELIX(...) + #define LOGW_HELIX(...) + #define LOGE_HELIX(...) +#endif + diff --git a/src/utils/helix_log_std.h b/src/utils/helix_log_std.h new file mode 100644 index 0000000..2b013cc --- /dev/null +++ b/src/utils/helix_log_std.h @@ -0,0 +1,27 @@ +#pragma once +#include "../ConfigHelix.h" +#include "stdio.h" // for snprintf + +#if defined(ARDUINO) +# include "Arduino.h" // for Serial; include Serial.h does not work +#endif + +// Logging Implementation +#if HELIX_LOGGING_ACTIVE + extern char log_buffer_helix[HELIX_LOG_SIZE]; + enum class LogLevelHelix {Debug, Info, Warning, Error}; + static LogLevelHelix LOGLEVEL_HELIX = HELIX_LOG_LEVEL; + // We print the log based on the log level + #define LOG_HELIX(level,...) { if(level>=LOGLEVEL_HELIX) { int l = snprintf(log_buffer_helix,512, __VA_ARGS__); HELIX_LOGGING_OUT.print("libhelix - "); HELIX_LOGGING_OUT.write(log_buffer_helix,l); HELIX_LOGGING_OUT.println(); } } + #define LOGD_HELIX(...) LOG_HELIX(LogLevelHelix::Debug,__VA_ARGS__) + #define LOGI_HELIX(...) LOG_HELIX(LogLevelHelix::Info,__VA_ARGS__) + #define LOGW_HELIX(...) LOG_HELIX(LogLevelHelix::Warning,__VA_ARGS__) + #define LOGE_HELIX(...) LOG_HELIX(LogLevelHelix::Error,__VA_ARGS__) +#else + // Remove all log statments from the code + #define LOGD_HELIX(...) + #define LOGI_HELIX(...) + #define LOGW_HELIX(...) + #define LOGE_HELIX(...) +#endif + From fbca5ac4149d7cc2543fcdfb00ab8c355e4615ef Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Sat, 8 Mar 2025 16:55:57 +0100 Subject: [PATCH 16/30] v0.1.2 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index d726861..b302fd2 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=libhelix -version=0.8.8 +version=0.1.2 author=Phil Schatzmann maintainer= https://github.com/pschatzmann sentence=libhelix audio decoder for Arduino From 27197c6df35cc132d3875fe00203af6f6bdfb16a Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Sat, 8 Mar 2025 16:56:49 +0100 Subject: [PATCH 17/30] v0.8.9 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index b302fd2..cc35d68 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=libhelix -version=0.1.2 +version=0.8.9 author=Phil Schatzmann maintainer= https://github.com/pschatzmann sentence=libhelix audio decoder for Arduino From ffb9452ee9ab45588062527c64f7339d9ccfc7cc Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Sun, 9 Mar 2025 03:41:06 +0100 Subject: [PATCH 18/30] github config --- .github/FUNDING.yml | 14 ++++++ .github/ISSUE_TEMPLATE/Issue-report.yml | 58 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + 3 files changed, 73 insertions(+) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/Issue-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..3fa32fb --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,14 @@ +# These are supported funding model platforms + +github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +patreon: # Replace with a single Patreon username +open_collective: # Replace with a single Open Collective username +ko_fi: # Replace with a single Ko-fi username +tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: # Replace with a single Liberapay username +issuehunt: # Replace with a single IssueHunt username +lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry +polar: # Replace with a single Polar username +buy_me_a_coffee: philschatzh +custom: ['https://www.paypal.com/paypalme/pschatzmann?country.x=CH&locale.x=en_US'] diff --git a/.github/ISSUE_TEMPLATE/Issue-report.yml b/.github/ISSUE_TEMPLATE/Issue-report.yml new file mode 100644 index 0000000..37c3236 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Issue-report.yml @@ -0,0 +1,58 @@ +name: Bug report +description: Report only a bugs here! +body: + - type: markdown + attributes: + value: | + * Before reporting a new bug please check and search the [list of existing issues](https://github.com/pschatzmann/arduino-audio-tools/issues?q=) + * Please check [the Readme](https://github.com/pschatzmann/arduino-audio-tools) and [Wiki](https://github.com/pschatzmann/arduino-audio-tools/wiki) + * Don't forget to check [the discusions](https://github.com/pschatzmann/arduino-audio-tools/discussions) + * If still experiencing the issue, please provide as many details as possible below about your hardware, computer setup and code. + - type: textarea + id: Description + attributes: + label: Problem Description + description: Please describe your problem here and expected behaviour + placeholder: ex. Can't connect/weird behaviour/wrong function/missing parameter.. + validations: + required: true + - type: textarea + id: Board + attributes: + label: Device Description + description: What development board are you using + placeholder: e.g. ESP32 Wroom, Desktop Build, RP2040 + validations: + required: true + - type: textarea + id: sketch + attributes: + label: Sketch + description: Please provide full minimal sketch/code which can be run to reproduce your issue + placeholder: ex. Related part of the code to replicate the issue + render: cpp + validations: + required: true + + - type: textarea + id: other-remarks + attributes: + label: Other Steps to Reproduce + description: Is there any other information you can think of which will help us reproduce this problem? Any additional info can be added as well. + placeholder: ex. I also tried on other OS, HW...it works correctly on that setup. + + - type: textarea + id: sceanario + attributes: + label: What is your development environment (with Arduino Core Version information) + description: Please provide the information about your development/runtime environment + placeholder: Arduino ESP 2.0.14, Desktop Build, IDF 5.3.2, STM32-Cube MX, PlatformIO ESP32 6.10.0, JupyterLab + + - type: checkboxes + id: confirmation + attributes: + label: I have checked existing issues, discussions and online documentation + description: You agree to check all the resources above before opening a new issue. + options: + - label: I confirm I have checked existing issues, discussions and online documentation + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false From b74fe09b109f02099d2b298bb589524a9cf85fd3 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Tue, 11 Mar 2025 08:40:10 +0100 Subject: [PATCH 19/30] __has_include ("Arduino.h") --- src/CommonHelix.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/CommonHelix.h b/src/CommonHelix.h index a22d135..9020897 100644 --- a/src/CommonHelix.h +++ b/src/CommonHelix.h @@ -1,5 +1,5 @@ #pragma once -#if defined(ARDUINO) +#if defined(ARDUINO) && __has_include ("Arduino.h") # include "Arduino.h" #else // remove delay statment if used outside of arduino From a5177dea93136d4f6007cbdd8dcbe4b812b37fd6 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Tue, 11 Mar 2025 08:55:21 +0100 Subject: [PATCH 20/30] __has_include ("Arduino.h") --- src/utils/helix_log_std.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utils/helix_log_std.h b/src/utils/helix_log_std.h index 2b013cc..0612a76 100644 --- a/src/utils/helix_log_std.h +++ b/src/utils/helix_log_std.h @@ -2,7 +2,7 @@ #include "../ConfigHelix.h" #include "stdio.h" // for snprintf -#if defined(ARDUINO) +#if defined(ARDUINO) && __has_include ("Arduino.h") # include "Arduino.h" // for Serial; include Serial.h does not work #endif From 4c8e4b3ec93eb107e9b1c9c0a6b7f15df7202fec Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Tue, 11 Mar 2025 10:32:56 +0100 Subject: [PATCH 21/30] HELIX_LOGGING_ACTIVE 0 for desktop builds --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 8e024b6..bc65c85 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -29,7 +29,7 @@ else() add_library (arduino_helix ${SRC_LIST_C} ${SRC_LIST_CPP}) # prevent compile errors - target_compile_options(arduino_helix PRIVATE -DUSE_DEFAULT_STDLIB) + target_compile_options(arduino_helix PRIVATE -DUSE_DEFAULT_STDLIB -DHELIX_LOGGING_ACTIVE=0) # define location for header files target_include_directories(arduino_helix PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src ${CMAKE_CURRENT_SOURCE_DIR}/src/libhelix-mp3 ${CMAKE_CURRENT_SOURCE_DIR}/src/libhelix-aac ) From caa71f358278bf3be92c1fdb74e450411df5e1a1 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Tue, 11 Mar 2025 10:34:59 +0100 Subject: [PATCH 22/30] HELIX_LOGGING_OUT for desktop builds --- src/ConfigHelix.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ConfigHelix.h b/src/ConfigHelix.h index 4b8a127..83423d6 100644 --- a/src/ConfigHelix.h +++ b/src/ConfigHelix.h @@ -47,7 +47,7 @@ # define LOG_METHOD __PRETTY_FUNCTION__ #endif -#ifndef HELIX_LOGGING_OUT +#if HELIX_LOGGING_ACTIVE && !defined(HELIX_LOGGING_OUT) # define HELIX_LOGGING_OUT Serial #endif From cfea0dced8d35940067c265b656438bb7bb9426b Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Mon, 17 Mar 2025 08:08:45 +0100 Subject: [PATCH 23/30] Limit pcm write size to 1k (default value) --- src/AACDecoderHelix.h | 5 ++- src/CommonHelix.h | 81 ++++++++++++++++++++++++++----------------- src/MP3DecoderHelix.h | 4 +-- 3 files changed, 52 insertions(+), 38 deletions(-) diff --git a/src/AACDecoderHelix.h b/src/AACDecoderHelix.h index fa38c3f..1860e91 100644 --- a/src/AACDecoderHelix.h +++ b/src/AACDecoderHelix.h @@ -141,9 +141,8 @@ class AACDecoderHelix : public CommonHelix { } #if defined(ARDUINO) || defined(HELIX_PRINT) if (out != nullptr){ - size_t to_write = info.outputSamps * sampleSize; - size_t written = out->write((uint8_t *)pcm_buffer.data(), to_write); - assert(written == to_write); + size_t toWrite = info.outputSamps * sampleSize; + writeToOut((uint8_t *)pcm_buffer.data(), toWrite); } #endif } diff --git a/src/CommonHelix.h b/src/CommonHelix.h index 9020897..d553c40 100644 --- a/src/CommonHelix.h +++ b/src/CommonHelix.h @@ -1,19 +1,19 @@ #pragma once -#if defined(ARDUINO) && __has_include ("Arduino.h") -# include "Arduino.h" +#if defined(ARDUINO) && __has_include("Arduino.h") +#include "Arduino.h" #else // remove delay statment if used outside of arduino #include -# define delay(ms) +#define delay(ms) #endif // Not all processors support assert #ifndef assert -# ifdef NDEBUG -# define assert(condition) ((void)0) -# else -# define assert(condition) /*implementation defined*/ -# endif +#ifdef NDEBUG +#define assert(condition) ((void)0) +#else +#define assert(condition) /*implementation defined*/ +#endif #endif #include "ConfigHelix.h" @@ -74,7 +74,7 @@ class CommonHelix { * not fit into the buffer it is split up into small pieces that fit */ virtual size_t write(const void *in_ptr, size_t in_size) { - LOGI_HELIX( "write %zu", in_size); + LOGI_HELIX("write %zu", in_size); int open = in_size; size_t processed = 0; uint8_t *data = (uint8_t *)in_ptr; @@ -106,12 +106,12 @@ class CommonHelix { while (rc >= 0) { // we must start with sych word if (!presync()) break; - // we must end with synch world + // we must end with synch world if (findSynchWord(3) < 0) break; rc = decode(); if (!resynch(rc)) break; // remove processed data - if (rc > 0) frame_buffer.clearArray(rc); + if (rc > 0) frame_buffer.clearArray(rc); } } @@ -129,10 +129,14 @@ class CommonHelix { /// Define your optimized maximum pcm buffer size in bytes void setMaxPCMSize(size_t len) { max_pcm_size = len; } - /// Define some additional information which will be provided back in the callbacks - void setReference(void* ref){ - p_caller_ref = ref; - } + /// Define some additional information which will be provided back in the + /// callbacks + void setReference(void *ref) { p_caller_ref = ref; } + +#if defined(ARDUINO) || defined(HELIX_PRINT) + /// Defines the max chunk size that is wrtten to out (Arduino only) + void setMaxPCMWriteSize(int size) { max_write_size = size; } +#endif protected: bool active = false; @@ -142,21 +146,21 @@ class CommonHelix { size_t max_frame_size = 0; size_t max_pcm_size = 0; size_t frame_counter = 0; + size_t max_write_size = 1024; int delay_ms = -1; - int parse_0_count = 0; // keep track of parser returning 0 + int parse_0_count = 0; // keep track of parser returning 0 int min_frame_buffer_size = 0; uint64_t time_last_write = 0; uint64_t time_last_result = 0; void *p_caller_ref = nullptr; - #if defined(ARDUINO) || defined(HELIX_PRINT) Print *out = nullptr; #endif /// make sure that we start with a valid sync: remove ID3 data bool presync() { - LOGD_HELIX( "presynch"); + LOGD_HELIX("presynch"); bool rc = true; int pos = findSynchWord(); if (pos > 3) rc = removeInvalidData(pos); @@ -167,15 +171,15 @@ class CommonHelix { /// advance on invalid data, returns true if we need to continue the /// processing bool resynch(int rc) { - LOGD_HELIX( "resynch: %d" , rc); + LOGD_HELIX("resynch: %d", rc); // reset 0 result counter if (rc != 0) parse_0_count = 0; if (rc <= 0) { if (rc == 0) { parse_0_count++; int pos = findSynchWord(SYNCH_WORD_LEN); - LOGD_HELIX( "rc: %d - available %d - pos %d", rc, - frame_buffer.available(), pos); + LOGD_HELIX("rc: %d - available %d - pos %d", rc, + frame_buffer.available(), pos); // if we are stuck, request more data and if this does not help we // remove the invalid data if (parse_0_count > 2) { @@ -184,8 +188,7 @@ class CommonHelix { return false; } else if (rc == -1) { // underflow - LOGD_HELIX( "rc: %d - available %d", rc, - frame_buffer.available()); + LOGD_HELIX("rc: %d - available %d", rc, frame_buffer.available()); return false; } else { // generic error handling: remove the data until the next synch word @@ -199,9 +202,9 @@ class CommonHelix { /// removes invalid data not starting with a synch word. /// @return Returns true if we still have data to be played bool removeInvalidData(int pos) { - LOGD_HELIX( "removeInvalidData: %d", pos); + LOGD_HELIX("removeInvalidData: %d", pos); if (pos > 0) { - LOGI_HELIX( "removing: %d bytes", pos); + LOGI_HELIX("removing: %d bytes", pos); frame_buffer.clearArray(pos); return true; } else if (pos <= 0) { @@ -213,28 +216,41 @@ class CommonHelix { /// Decoding Loop: We decode the procided data until we run out of data virtual size_t writeChunk(const void *in_ptr, size_t in_size) { - LOGI_HELIX( "writeChunk %zu", in_size); + LOGI_HELIX("writeChunk %zu", in_size); #ifdef ARDUINO time_last_write = millis(); #endif size_t result = frame_buffer.writeArray((uint8_t *)in_ptr, in_size); while (frame_buffer.available() >= minFrameBufferSize()) { - if (!presync()) break; int rc = decode(); if (!resynch(rc)) break; // remove processed data frame_buffer.clearArray(rc); - - LOGI_HELIX( "rc: %d - available %d", rc, - frame_buffer.available()); + LOGI_HELIX("rc: %d - available %d", rc, frame_buffer.available()); } return result; } +#if defined(ARDUINO) || defined(HELIX_PRINT) + size_t writeToOut(uint8_t *data, size_t len) { + size_t to_write = len; + size_t written = 0; + while (to_write > 0) { + size_t result = out->write(data + written, MIN(to_write, 1024)); + to_write -= result; + written += result; + } + if (len != written) + LOGE_HELIX("Could not write result to out: %d of %d written", written, + len); + return written; + } +#endif + /// Decode w/o parsing virtual int decode() = 0; @@ -245,9 +261,10 @@ class CommonHelix { /// indicated offset) virtual int findSynchWord(int offset = 0) = 0; - /// Provides the actual minimum frame buffer size + /// Provides the actual minimum frame buffer size virtual int minFrameBufferSize() { return min_frame_buffer_size; } - /// Defines the minimum frame buffer size which is required before starting the decoding + /// Defines the minimum frame buffer size which is required before starting + /// the decoding virtual void setMinFrameBufferSize(int size) { min_frame_buffer_size = size; } }; diff --git a/src/MP3DecoderHelix.h b/src/MP3DecoderHelix.h index 47d46e7..bc05803 100644 --- a/src/MP3DecoderHelix.h +++ b/src/MP3DecoderHelix.h @@ -150,9 +150,7 @@ class MP3DecoderHelix : public CommonHelix { if (out != nullptr){ int sampleSize = info.bitsPerSample / 8; int toWrite = info.outputSamps * sampleSize; - int written = out->write((uint8_t *)pcm_buffer.data(), toWrite); - // assume blocking write - assert(written == toWrite); + writeToOut((uint8_t *)pcm_buffer.data(), toWrite); } #endif } From a1bac798968aeb13e208d07f480ec20102ca2137 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Wed, 19 Mar 2025 00:55:19 +0100 Subject: [PATCH 24/30] compile error in examples --- src/utils/Buffers.h | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/utils/Buffers.h b/src/utils/Buffers.h index 67ee0df..3e71253 100644 --- a/src/utils/Buffers.h +++ b/src/utils/Buffers.h @@ -148,8 +148,6 @@ class BaseBuffer { protected: void setWritePos(int pos){}; - - friend NBuffer; }; /** From d4d2151c43885b39a5cae2580026994a8d54219e Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Thu, 20 Mar 2025 22:13:11 +0100 Subject: [PATCH 25/30] Compile Warning --- src/CommonHelix.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/CommonHelix.h b/src/CommonHelix.h index d553c40..1525645 100644 --- a/src/CommonHelix.h +++ b/src/CommonHelix.h @@ -245,8 +245,8 @@ class CommonHelix { written += result; } if (len != written) - LOGE_HELIX("Could not write result to out: %d of %d written", written, - len); + LOGE_HELIX("Could not write result to out: %d of %d written", (int)written, + (int)len); return written; } #endif From 36561507e3b942aeebd55411ac4e1bda6a1e20d9 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Sun, 27 Apr 2025 03:10:50 +0200 Subject: [PATCH 26/30] Compile warning --- src/utils/helix_log_std.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utils/helix_log_std.h b/src/utils/helix_log_std.h index 0612a76..5914b66 100644 --- a/src/utils/helix_log_std.h +++ b/src/utils/helix_log_std.h @@ -12,7 +12,7 @@ enum class LogLevelHelix {Debug, Info, Warning, Error}; static LogLevelHelix LOGLEVEL_HELIX = HELIX_LOG_LEVEL; // We print the log based on the log level - #define LOG_HELIX(level,...) { if(level>=LOGLEVEL_HELIX) { int l = snprintf(log_buffer_helix,512, __VA_ARGS__); HELIX_LOGGING_OUT.print("libhelix - "); HELIX_LOGGING_OUT.write(log_buffer_helix,l); HELIX_LOGGING_OUT.println(); } } + #define LOG_HELIX(level,...) { if(level>=LOGLEVEL_HELIX) { int l = snprintf(log_buffer_helix, HELIX_LOG_SIZE, __VA_ARGS__); HELIX_LOGGING_OUT.print("libhelix - "); HELIX_LOGGING_OUT.write(log_buffer_helix,l); HELIX_LOGGING_OUT.println(); } } #define LOGD_HELIX(...) LOG_HELIX(LogLevelHelix::Debug,__VA_ARGS__) #define LOGI_HELIX(...) LOG_HELIX(LogLevelHelix::Info,__VA_ARGS__) #define LOGW_HELIX(...) LOG_HELIX(LogLevelHelix::Warning,__VA_ARGS__) From 0f364925249dac7733e9328b8d61a5c0b432d3c3 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Sun, 27 Apr 2025 03:42:22 +0200 Subject: [PATCH 27/30] remove #pragma GCC --- src/libhelix-aac/aaccommon.h | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/libhelix-aac/aaccommon.h b/src/libhelix-aac/aaccommon.h index f841529..eb33e4b 100644 --- a/src/libhelix-aac/aaccommon.h +++ b/src/libhelix-aac/aaccommon.h @@ -56,10 +56,6 @@ # define AAC_ENABLE_SBR #endif // HELIX_FEATURE_AUDIO_CODEC_AAC_SBR. -#ifndef ARDUINO -#pragma GCC optimize ("O3") -#pragma GCC diagnostic ignored "-Wstringop-overflow" -#endif #include "aacdec.h" #include "statname.h" From b331f4cc040e35a104e71370042aaba75d8433b7 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Sun, 27 Apr 2025 04:10:47 +0200 Subject: [PATCH 28/30] Wstringop-overflow --- src/libhelix-aac/aaccommon.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/libhelix-aac/aaccommon.h b/src/libhelix-aac/aaccommon.h index eb33e4b..f48389b 100644 --- a/src/libhelix-aac/aaccommon.h +++ b/src/libhelix-aac/aaccommon.h @@ -56,6 +56,10 @@ # define AAC_ENABLE_SBR #endif // HELIX_FEATURE_AUDIO_CODEC_AAC_SBR. +#if !defined(ARDUINO) && defined(__GNUC__) +#pragma GCC diagnostic ignored "-Wstringop-overflow" +#endif + #include "aacdec.h" #include "statname.h" From d56a4f50446e56680d670d89334b5ee05a193365 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Sun, 27 Apr 2025 05:03:16 +0200 Subject: [PATCH 29/30] Missing override in buffers --- src/utils/Buffers.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utils/Buffers.h b/src/utils/Buffers.h index 3e71253..68e657d 100644 --- a/src/utils/Buffers.h +++ b/src/utils/Buffers.h @@ -263,7 +263,7 @@ class SingleBuffer : public BaseBuffer { } - size_t size() { return max_size; } + size_t size() override { return max_size; } void resize(int size) { if (buffer.size() != size) { From 89010a9beb077756be17b98d81336c5bf5990654 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Sun, 27 Apr 2025 05:26:40 +0200 Subject: [PATCH 30/30] Compile warnings --- .gitignore | 5 +---- src/libhelix-aac/aaccommon.h | 10 ++++++++-- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index bf2eee5..9457897 100644 --- a/.gitignore +++ b/.gitignore @@ -3,10 +3,7 @@ # VS code .vscode/* -!.vscode/settings.json -!.vscode/tasks.json -!.vscode/launch.json -!.vscode/extensions.json +.vscode/settings.json *.code-workspace # Local History for Visual Studio Code diff --git a/src/libhelix-aac/aaccommon.h b/src/libhelix-aac/aaccommon.h index f48389b..1b95c69 100644 --- a/src/libhelix-aac/aaccommon.h +++ b/src/libhelix-aac/aaccommon.h @@ -56,8 +56,14 @@ # define AAC_ENABLE_SBR #endif // HELIX_FEATURE_AUDIO_CODEC_AAC_SBR. -#if !defined(ARDUINO) && defined(__GNUC__) -#pragma GCC diagnostic ignored "-Wstringop-overflow" +#if !defined(ARDUINO) +# if defined(__clang__) +// n/a +# elif defined(__GNUC__) || defined(__GNUG__) +# pragma GCC diagnostic ignored "-Wstringop-overflow" +# elif defined(_MSC_VER) +// n/a +# endif #endif #include "aacdec.h"