Renamed all misspelled pcm from pwm

Author: pschatzmann

README.md

@@ -18,10 +18,10 @@ The API provides the decoded data to a Arduino Stream or alternatively to a call
 
 using namespace libhelix;
 
-void dataCallback(MP3FrameInfo &info, int16_t *pwm_buffer, size_t len) {
+void dataCallback(MP3FrameInfo &info, int16_t *pcm_buffer, size_t len) {
     for (int i=0; i<len; i+=info.channels){
         for (int j=0;j<info.channels;j++){
-            Serial.print(pwm_buffer[i+j]);
+            Serial.print(pcm_buffer[i+j]);
             Serial.print(" ");
         }
         Serial.println();
@@ -83,7 +83,7 @@ These values are working in most of the cases, but in some exceptional cases you
 
 Alternatively you can set the values in your sketch by calling the following methods:
 ```
-setMaxPWMSize(int size)
+setMaxPCMSize(int size)
 setMaxFrameSize(int size)
 ```
 

docs/html/_a_a_c_decoder_helix_8h_source.html

@@ -88,14 +88,14 @@
   <tr bgcolor="#f0f0f0"><td class="entry"><b>in</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>infoCallback</b> (defined in <a class="el" href="class_a_a_c_decoder_helix.html">AACDecoderHelix</a>)</td><td class="entry"><a class="el" href="class_a_a_c_decoder_helix.html">AACDecoderHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
   <tr bgcolor="#f0f0f0"><td class="entry"><b>max_frame_size</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
-  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>max_pwm_size</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>max_pcm_size</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
   <tr><td class="entry"><a class="el" href="class_a_a_c_decoder_helix.html#a71e097989effc0c21e97014b86d35b33">maxFrameSize</a>()</td><td class="entry"><a class="el" href="class_a_a_c_decoder_helix.html">AACDecoderHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_a_a_c_decoder_helix.html#a9e5c2964d9fd5c3c973aa59461159adf">maxPWMSize</a>()</td><td class="entry"><a class="el" href="class_a_a_c_decoder_helix.html">AACDecoderHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_a_a_c_decoder_helix.html#a9e5c2964d9fd5c3c973aa59461159adf">maxPCMSize</a>()</td><td class="entry"><a class="el" href="class_a_a_c_decoder_helix.html">AACDecoderHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="class_common_helix.html#aefed13d6943ba19af5dea2a9b2f6d853">operator bool</a>()</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>out</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
   <tr bgcolor="#f0f0f0"><td class="entry"><b>provideResult</b>(_AACFrameInfo_t &amp;info) (defined in <a class="el" href="class_a_a_c_decoder_helix.html">AACDecoderHelix</a>)</td><td class="entry"><a class="el" href="class_a_a_c_decoder_helix.html">AACDecoderHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
-  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>pwm_buffer</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
-  <tr bgcolor="#f0f0f0"><td class="entry"><b>pwmCallback</b> (defined in <a class="el" href="class_a_a_c_decoder_helix.html">AACDecoderHelix</a>)</td><td class="entry"><a class="el" href="class_a_a_c_decoder_helix.html">AACDecoderHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>pcm_buffer</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>pcmCallback</b> (defined in <a class="el" href="class_a_a_c_decoder_helix.html">AACDecoderHelix</a>)</td><td class="entry"><a class="el" href="class_a_a_c_decoder_helix.html">AACDecoderHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_common_helix.html#aab2967a6340b4c35f2fe80a3b9ea2f66">setMaxFrameSize</a>(size_t len)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
   <tr><td class="entry"><a class="el" href="class_common_helix.html#ac08d7221e4668a84b5ca02e0d69d1f4d">setMaxPWMSize</a>(size_t len)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_common_helix.html#a27342368d7514d51ef6006ffa944b14e">synchronizeFrame</a>()</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>

docs/html/_common_helix_8h_source.html

@@ -122,8 +122,8 @@
 <tr class="memdesc:a71e097989effc0c21e97014b86d35b33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the maximum frame size - this is allocated on the heap and you can reduce the heap size my minimizing this value. <br /></td></tr>
 <tr class="separator:a71e097989effc0c21e97014b86d35b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a9e5c2964d9fd5c3c973aa59461159adf"><td class="memItemLeft" align="right" valign="top"><a id="a9e5c2964d9fd5c3c973aa59461159adf"></a>
-size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_a_c_decoder_helix.html#a9e5c2964d9fd5c3c973aa59461159adf">maxPWMSize</a> ()</td></tr>
-<tr class="memdesc:a9e5c2964d9fd5c3c973aa59461159adf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the maximum pwm buffer size - this is allocated on the heap and you can reduce the heap size my minimizing this value. <br /></td></tr>
+size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_a_c_decoder_helix.html#a9e5c2964d9fd5c3c973aa59461159adf">maxPCMSize</a> ()</td></tr>
+<tr class="memdesc:a9e5c2964d9fd5c3c973aa59461159adf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the maximum pcm buffer size - this is allocated on the heap and you can reduce the heap size my minimizing this value. <br /></td></tr>
 <tr class="separator:a9e5c2964d9fd5c3c973aa59461159adf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:afbcf7f806b167a3c3d7bffc4e3a0a287"><td class="memItemLeft" align="right" valign="top"><a id="afbcf7f806b167a3c3d7bffc4e3a0a287"></a>
 int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_a_c_decoder_helix.html#afbcf7f806b167a3c3d7bffc4e3a0a287">findSynchWord</a> (int offset=0)</td></tr>
@@ -147,7 +147,7 @@
 <tr class="separator:aab2967a6340b4c35f2fe80a3b9ea2f66 inherit pro_methods_class_common_helix"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ac08d7221e4668a84b5ca02e0d69d1f4d inherit pro_methods_class_common_helix"><td class="memItemLeft" align="right" valign="top"><a id="ac08d7221e4668a84b5ca02e0d69d1f4d"></a>
 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_common_helix.html#ac08d7221e4668a84b5ca02e0d69d1f4d">setMaxPWMSize</a> (size_t len)</td></tr>
-<tr class="memdesc:ac08d7221e4668a84b5ca02e0d69d1f4d inherit pro_methods_class_common_helix"><td class="mdescLeft">&#160;</td><td class="mdescRight">Define your optimized maximum pwm buffer size. <br /></td></tr>
+<tr class="memdesc:ac08d7221e4668a84b5ca02e0d69d1f4d inherit pro_methods_class_common_helix"><td class="mdescLeft">&#160;</td><td class="mdescRight">Define your optimized maximum pcm buffer size. <br /></td></tr>
 <tr class="separator:ac08d7221e4668a84b5ca02e0d69d1f4d inherit pro_methods_class_common_helix"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ace99e1cf9aff1dd38dbb32303969049d inherit pro_methods_class_common_helix"><td class="memItemLeft" align="right" valign="top"><a id="ace99e1cf9aff1dd38dbb32303969049d"></a>
 size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_common_helix.html#ace99e1cf9aff1dd38dbb32303969049d">appendToBuffer</a> (const void *in_ptr, int in_size)</td></tr>
@@ -178,7 +178,7 @@
 _AACFrameInfo_t&#160;</td><td class="memItemRight" valign="bottom"><b>_AACFrameInfo_t</b></td></tr>
 <tr class="separator:ac7edd4dd0f86a61653e88e74be8ee357"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aad48ac2b58a11ca60a60a0e5ad217f51"><td class="memItemLeft" align="right" valign="top"><a id="aad48ac2b58a11ca60a60a0e5ad217f51"></a>
-AACDataCallback&#160;</td><td class="memItemRight" valign="bottom"><b>pwmCallback</b> = nullptr</td></tr>
+AACDataCallback&#160;</td><td class="memItemRight" valign="bottom"><b>pcmCallback</b> = nullptr</td></tr>
 <tr class="separator:aad48ac2b58a11ca60a60a0e5ad217f51"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0d2f5f213ad83b1fd49b6d7e59930e7e"><td class="memItemLeft" align="right" valign="top"><a id="a0d2f5f213ad83b1fd49b6d7e59930e7e"></a>
 AACInfoCallback&#160;</td><td class="memItemRight" valign="bottom"><b>infoCallback</b> = nullptr</td></tr>
@@ -200,13 +200,13 @@
 uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><b>frame_buffer</b> = nullptr</td></tr>
 <tr class="separator:afa45ba13b15c1e8fde9c0a0607642b71 inherit pro_attribs_class_common_helix"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0458b1899a094e836ec9586359d7af27 inherit pro_attribs_class_common_helix"><td class="memItemLeft" align="right" valign="top"><a id="a0458b1899a094e836ec9586359d7af27"></a>
-short *&#160;</td><td class="memItemRight" valign="bottom"><b>pwm_buffer</b> = nullptr</td></tr>
+short *&#160;</td><td class="memItemRight" valign="bottom"><b>pcm_buffer</b> = nullptr</td></tr>
 <tr class="separator:a0458b1899a094e836ec9586359d7af27 inherit pro_attribs_class_common_helix"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a666e7e1837c19708a68d4a44bfd12187 inherit pro_attribs_class_common_helix"><td class="memItemLeft" align="right" valign="top"><a id="a666e7e1837c19708a68d4a44bfd12187"></a>
 size_t&#160;</td><td class="memItemRight" valign="bottom"><b>max_frame_size</b> = 0</td></tr>
 <tr class="separator:a666e7e1837c19708a68d4a44bfd12187 inherit pro_attribs_class_common_helix"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a08f9f1446aa9cdcd929b31159e1fdd72 inherit pro_attribs_class_common_helix"><td class="memItemLeft" align="right" valign="top"><a id="a08f9f1446aa9cdcd929b31159e1fdd72"></a>
-size_t&#160;</td><td class="memItemRight" valign="bottom"><b>max_pwm_size</b> = 0</td></tr>
+size_t&#160;</td><td class="memItemRight" valign="bottom"><b>max_pcm_size</b> = 0</td></tr>
 <tr class="separator:a08f9f1446aa9cdcd929b31159e1fdd72 inherit pro_attribs_class_common_helix"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4cb844b8e466a00c4cf5cb2ededaa8a0 inherit pro_attribs_class_common_helix"><td class="memItemLeft" align="right" valign="top"><a id="a4cb844b8e466a00c4cf5cb2ededaa8a0"></a>
 size_t&#160;</td><td class="memItemRight" valign="bottom"><b>frame_counter</b> = 0</td></tr>

docs/html/_m_p3_decoder_helix_8h_source.html

@@ -82,12 +82,12 @@
   <tr><td class="entry"><a class="el" href="class_common_helix.html#adcd7672475ef7ca375d034c54a189873">frameRange</a>()</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>in</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
   <tr bgcolor="#f0f0f0"><td class="entry"><b>max_frame_size</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
-  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>max_pwm_size</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>max_pcm_size</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
   <tr><td class="entry"><a class="el" href="class_common_helix.html#a7a4bdd6a14c3728cfbb1ae5ab90f3224">maxFrameSize</a>()=0</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_common_helix.html#a83c19f941b06e701f07a87850706fe45">maxPWMSize</a>()=0</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_common_helix.html#a83c19f941b06e701f07a87850706fe45">maxPCMSize</a>()=0</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="class_common_helix.html#aefed13d6943ba19af5dea2a9b2f6d853">operator bool</a>()</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>out</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
-  <tr bgcolor="#f0f0f0"><td class="entry"><b>pwm_buffer</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>pcm_buffer</b> (defined in <a class="el" href="class_common_helix.html">CommonHelix</a>)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_common_helix.html#aab2967a6340b4c35f2fe80a3b9ea2f66">setMaxFrameSize</a>(size_t len)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
   <tr><td class="entry"><a class="el" href="class_common_helix.html#ac08d7221e4668a84b5ca02e0d69d1f4d">setMaxPWMSize</a>(size_t len)</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_common_helix.html#a27342368d7514d51ef6006ffa944b14e">synchronizeFrame</a>()</td><td class="entry"><a class="el" href="class_common_helix.html">CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>