Merge pull request #12 from pschatzmann/development

Development

Author: pschatzmann

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "(gdb) Launch",
+            "type": "cppdbg",
+            "request": "launch",
+            "program": "${workspaceFolder}/build/examples/output_aac/aac",
+            "args": [],
+            "stopAtEntry": false,
+            "cwd": "${fileDirname}",
+            "environment": [],
+            "externalConsole": false,
+            "MIMode": "gdb",
+            "setupCommands": [
+                {
+                    "description": "Enable pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                },
+                {
+                    "description": "Set Disassembly Flavor to Intel",
+                    "text": "-gdb-set disassembly-flavor intel",
+                    "ignoreFailures": true
+                }
+            ]
+        }
+    ]
+}

CMakeLists.txt

@@ -8,9 +8,10 @@ project(arduino_helix)
 set(CMAKE_CXX_STANDARD 17)
 
 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 libraries
-add_library (arduino_helix ${SRC_LIST_C})
+add_library (arduino_helix ${SRC_LIST_C} ${SRC_LIST_CPP})
 
 # prevent compile errors
 target_compile_options(arduino_helix PRIVATE -DUSE_DEFAULT_STDLIB)

README.md

@@ -10,7 +10,9 @@ The Helix MP3 decoder provides Layer 3 support for MPEG-1, MPEG-2, and MPEG-2.5.
 
 ## API Example
 
-The API provides the decoded data to a Arduino Stream or alternatively to a callback function. Here is a MP3 example using the callback:
+The API provides the decoded data to a __Arduino Stream__ or alternatively to a callback function. The platform dependent I2S implementations usually implement I2S as subclass of Stream, so you can just provide the corresponding I2S object to the constructor.
+
+Here is a MP3 example using the callback:
 
 ```
 #include "MP3DecoderHelix.h"
@@ -87,11 +89,23 @@ setMaxPCMSize(int size)
 setMaxFrameSize(int size)
 ```
 
+## Memory Management
+
+On the ESP32 we support PSRAM: just activate it in the Arduino Tools menu and all the memory will be allocated in PSRAM.
+
+## Logging
+
+You can define the log level as Debug, Info, Warning, Error
+```
+LOGLEVEL_HELIX = LogLevelHelix::Info;
+```
+
+
 
 ## Documentation
 
 - The [Class Documentation can be found here](https://pschatzmann.github.io/arduino-libhelix/html/annotated.html)
-- I also suggest that you have a look at [my related Blog](https://www.pschatzmann.ch/home/2021/08/13/audio-decoders-for-microcontrollers/)
+- 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). 
 This is just one of many codecs that I have collected so far: Further details can be found in the [Encoding and Decoding Wiki](https://github.com/pschatzmann/arduino-audio-tools/wiki/Encoding-and-Decoding-of-Audio) of the Audio Tools.

docs/html/_a_a_c_decoder_helix_8h_source.html

@@ -68,10 +68,9 @@
 <div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
 <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
 <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>libhelix</b></td><td class="desc"></td></tr>
-<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibhelix_1_1_a_a_c_decoder_helix.html" target="_self">AACDecoderHelix</a></td><td class="desc">A simple Arduino API for the libhelix AAC decoder. The data us provided with the help of <a class="el" href="classlibhelix_1_1_common_helix.html#a819f83e0c2bdcac195c2170c205bd0f3" title="decodes the next segments from the intput. The data can be provided in one short or in small incremen...">write()</a> calls. The decoded result is available either via a callback method or via an output stream </td></tr>
-<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlibhelix_1_1_range.html" target="_self">Range</a></td><td class="desc"><a class="el" href="structlibhelix_1_1_range.html" title="Range with a start and an end.">Range</a> with a start and an end </td></tr>
-<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibhelix_1_1_common_helix.html" target="_self">CommonHelix</a></td><td class="desc">Common Simple Arduino API </td></tr>
-<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibhelix_1_1_m_p3_decoder_helix.html" target="_self">MP3DecoderHelix</a></td><td class="desc">A simple Arduino API for the libhelix MP3 decoder. The data is provided with the help of <a class="el" href="classlibhelix_1_1_common_helix.html#a819f83e0c2bdcac195c2170c205bd0f3" title="decodes the next segments from the intput. The data can be provided in one short or in small incremen...">write()</a> calls. The decoded result is available either via a callback method or via an output stream </td></tr>
+<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibhelix_1_1_a_a_c_decoder_helix.html" target="_self">AACDecoderHelix</a></td><td class="desc">A simple Arduino API for the libhelix AAC decoder. The data us provided with the help of <a class="el" href="classlibhelix_1_1_common_helix.html#a819f83e0c2bdcac195c2170c205bd0f3" title="decodes the next segments from the input. The data can be provided in one short or in small increment...">write()</a> calls. The decoded result is available either via a callback method or via an output stream </td></tr>
+<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibhelix_1_1_common_helix.html" target="_self">CommonHelix</a></td><td class="desc">Common Simple Arduino API </td></tr>
+<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibhelix_1_1_m_p3_decoder_helix.html" target="_self">MP3DecoderHelix</a></td><td class="desc">A simple Arduino API for the libhelix MP3 decoder. The data is provided with the help of <a class="el" href="classlibhelix_1_1_common_helix.html#a819f83e0c2bdcac195c2170c205bd0f3" title="decodes the next segments from the input. The data can be provided in one short or in small increment...">write()</a> calls. The decoded result is available either via a callback method or via an output stream </td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

docs/html/_common_helix_8h_source.html

@@ -65,7 +65,7 @@
 <div class="title">Class Index</div>  </div>
 </div><!--header-->
 <div class="contents">
-<div class="qindex"><a class="qindex" href="#letter_A">A</a>&#160;|&#160;<a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_M">M</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a></div>
+<div class="qindex"><a class="qindex" href="#letter_A">A</a>&#160;|&#160;<a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_M">M</a></div>
 <div class="classindex">
 <dl class="classindex even">
 <dt class="alphachar"><a name="letter_A">A</a></dt>
@@ -76,9 +76,6 @@
 <dl class="classindex even">
 <dt class="alphachar"><a name="letter_M">M</a></dt>
 <dd><a class="el" href="classlibhelix_1_1_m_p3_decoder_helix.html">MP3DecoderHelix</a> (libhelix)</dd></dl>
-<dl class="classindex odd">
-<dt class="alphachar"><a name="letter_R">R</a></dt>
-<dd><a class="el" href="structlibhelix_1_1_range.html">Range</a> (libhelix)</dd></dl>
 </div>
 </div><!-- contents -->
 <!-- start footer part -->