Skip to content

Commit f643d46

Browse files
committed
Base64
1 parent 1fdedc8 commit f643d46

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

src/AudioCodecs/CodecBase64.h

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,21 @@
66

77
namespace audio_tools {
88

9+
/**
10+
* @defgroup codecsbase64 Base64
11+
* @ingroup codecs
12+
* @brief Codec for 8 bit data
13+
**/
14+
15+
916
enum Base46Logic { NoCR, CRforFrame, CRforWrite };
1017

1118
/**
1219
* @brief DecoderBase64 - Converts a Base64 encoded Stream into the original
1320
* data stream. Decoding only gives a valid result if we start at a limit of 4
1421
* bytes. We therefore use by default a newline to determine a valid start
1522
* boundary.
16-
* @ingroup codecs8bit
23+
* @ingroup codecsbase64
1724
* @author Phil Schatzmann
1825
* @copyright GPLv3
1926
*/
@@ -160,13 +167,11 @@ const int DecoderBase64::B64index[256] = {
160167
37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51};
161168

162169
/**
163-
* @brief EncoderBase64s - Condenses 16 bit PCM data buffeream to 8 bits
164-
* data.
165-
* Most microcontrollers can not process 8 bit audio data directly. 8 bit data
166-
* however is very memory efficient and helps if you need to store audio on
167-
* conbufferained resources. This encoder translates 16bit data into 8bit
168-
* data.
169-
* @ingroup codecs8bit
170+
* @brief EncoderBase64s - Encodes the input data into a Base64 string.
171+
* By default each audio frame is followed by a new line, so that we can
172+
* easily resynchronize the reading of a data stream. The generation
173+
* of the new line can be configured with the setNewLine() method.
174+
* @ingroup codecsbase64
170175
* @author Phil Schatzmann
171176
* @copyright GPLv3
172177
*/

0 commit comments

Comments
 (0)