idf logging support outside of Arduino

pschatzmann · pschatzmann · commit af9091a6032a · 2025-03-07T19:01:13.000+01:00
diff --git a/docs/html/_a_a_c_decoder_helix_8h_source.html b/docs/html/_a_a_c_decoder_helix_8h_source.html
diff --git a/docs/html/_common_helix_8h_source.html b/docs/html/_common_helix_8h_source.html
diff --git a/docs/html/_config_helix_8h_source.html b/docs/html/_config_helix_8h_source.html
@@ -106,7 +106,7 @@
 <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#define ALLOCATOR libhelix::AllocatorExt</span></div>
 <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160; </div>
 <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">// Logging: Activate/Deactivate logging</span></div>
-<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#if ! defined(HELIX_LOGGING_ACTIVE) &amp;&amp; defined(ARDUINO)</span></div>
+<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#if !defined(HELIX_LOGGING_ACTIVE) </span></div>
 <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#  define HELIX_LOGGING_ACTIVE true</span></div>
 <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">#endif</span></div>
 <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160; </div>
@@ -122,9 +122,17 @@
 <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="preprocessor">#  define HELIX_LOGGING_OUT Serial</span></div>
 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="preprocessor">#endif</span></div>
 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160; </div>
-<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor">#ifndef HELIX_LOG_SIZE</span></div>
-<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">#  define HELIX_LOG_SIZE 256</span></div>
-<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">#if HELIX_LOGGING_ACTIVE &amp;&amp; defined(ESP32) &amp;&amp; !defined(ARDUINO)</span></div>
+<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="preprocessor">#  define USE_IDF_LOGGER</span></div>
+<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160; </div>
+<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">#ifndef HELIX_LOG_SIZE</span></div>
+<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="preprocessor">#  define HELIX_LOG_SIZE 256</span></div>
+<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160; </div>
+<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="preprocessor">#ifndef ESP8266</span></div>
+<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="preprocessor">#  define HELIX_FEATURE_AUDIO_CODEC_AAC_SBR</span></div>
+<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="preprocessor">#endif</span></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
diff --git a/docs/html/_m_p3_decoder_helix_8h_source.html b/docs/html/_m_p3_decoder_helix_8h_source.html
diff --git a/docs/html/index.html b/docs/html/index.html
@@ -107,7 +107,7 @@ <h1><a class="anchor" id="autotoc_md1"></a>
 Installation</h1>
 <p>For Arduino, you can download the library as zip and call include Library -&gt; zip library. Or you can git clone this project into the Arduino libraries folder e.g. with</p>
 <div class="fragment"><div class="line">cd  ~/Documents/Arduino/libraries</div>
-<div class="line">git clone pschatzmann/arduino-libhelix.git</div>
+<div class="line">git clone https://github.com/pschatzmann/arduino-libhelix.git</div>
 </div><!-- fragment --><p>This project can also be built and executed on your desktop with cmake:</p>
 <div class="fragment"><div class="line">cd arduino-libhelix</div>
 <div class="line">mkdir build</div>
@@ -135,6 +135,8 @@ <h1><a class="anchor" id="autotoc_md5"></a>
 Documentation</h1>
 <ul>
 <li>The <a href="https://pschatzmann.github.io/arduino-libhelix/html/annotated.html">Class Documentation can be found here</a></li>
+<li>aac <a href="https://github.com/pschatzmann/arduino-libhelix/blob/main/src/libhelix-aac/readme.txt">readme.txt</a></li>
+<li>mp3 <a href="https://github.com/pschatzmann/arduino-libhelix/blob/main/src/libhelix-mp3/readme.txt">readme.txt</a></li>
 <li>I also suggest that you have a look at <a href="https://www.pschatzmann.ch/home/tag/codecs/">my related blogs</a></li>
 </ul>
 <p>I recommend to use this library together with my <a href="https://github.com/pschatzmann/arduino-audio-tools">Arduino Audio Tools</a>. This is just one of many codecs that I have collected so far: Further details can be found in the <a href="https://github.com/pschatzmann/arduino-audio-tools/wiki/Encoding-and-Decoding-of-Audio">Encoding and Decoding Wiki</a> of the Audio Tools.</p>
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
diff --git a/src/utils/helix_log_idf.h 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
@@ -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
+
