Codecs Documentation

Author: pschatzmann

src/AudioCodecs/AudioCodecs.h

@@ -6,6 +6,18 @@
  * @brief Audio Coder and Decoder  
 **/
 
+/** 
+ * @defgroup encoder Encoder
+ * @ingroup codecs
+ * @brief Audio Encoder 
+**/
+
+/** 
+ * @defgroup decoder Decoder
+ * @ingroup codecs
+ * @brief Audio Decoder 
+**/
+
 #include "AudioCodecs/CodecWAV.h"
 #include "AudioCodecs/CodecCopy.h"
 #include "AudioCodecs/Codec8Bit.h"

src/AudioCodecs/Codec8Bit.h

@@ -2,20 +2,15 @@
 
 #include "AudioCodecs/AudioEncoded.h"
 
-/** 
- * @defgroup codecs8bit 8Bit
- * @ingroup codecs
- * @brief Codec for 8 bit data  
-**/
-
 namespace audio_tools {
 
 /**
  * @brief Decoder8Bit - Converts an 8 Bit Stream into 16Bits
  * Most microcontrollers can not output 8 bit data directly. 8 bit data however is very
  * memory efficient and helps if you need to store audio on constrained resources. This 
  * decoder translates 8bit data into 16bit data.
- * @ingroup codecs8bit
+ * @ingroup codecs
+ * @ingroup decoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -124,7 +119,8 @@ class Decoder8Bit : public AudioDecoder {
  * Most microcontrollers can not process 8 bit audio data directly. 8 bit data however is very
  * memory efficient and helps if you need to store audio on constrained resources. This 
  * encoder translates 16bit data into 8bit data.
- * @ingroup codecs8bit
+ * @ingroup codecs
+ * @ingroup encoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */

src/AudioCodecs/CodecAACFDK.h

@@ -4,11 +4,6 @@
 #include "AACDecoderFDK.h"
 #include "AACEncoderFDK.h"
 
-/** 
- * @defgroup fdk fdk
- * @ingroup codecs
- * @brief FTK AAC Decoder  
-**/
 
 namespace audio_tools {
 
@@ -19,7 +14,8 @@ AudioInfoDependent *audioChangeFDK = nullptr;
  * @brief Audio Decoder which decodes AAC into a PCM stream
  * This is basically just a wrapper using https://github.com/pschatzmann/arduino-fdk-aac
  * which uses AudioInfo and provides the handlig of AudioInfo changes.
- * @ingroup fdk
+ * @ingroup codecs
+ * @ingroup decoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -123,7 +119,8 @@ class AACDecoderFDK : public AudioDecoder  {
 /**
  * @brief Encodes PCM data to the AAC format and writes the result to a stream
  * This is basically just a wrapper using https://github.com/pschatzmann/arduino-fdk-aac
- * @ingroup fdk
+ * @ingroup codecs
+ * @ingroup encoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */

src/AudioCodecs/CodecAACHelix.h

@@ -4,12 +4,6 @@
 #include "AudioCodecs/AudioEncoded.h"
 #include "AACDecoderHelix.h"
 
-/** 
- * @defgroup helix Helix
- * @ingroup codecs
- * @brief Helix Decoder  
-**/
-
 namespace audio_tools {
 
 // audio change notification target
@@ -18,7 +12,8 @@ AudioInfoDependent *audioChangeAACHelix=nullptr;
 /**
  * @brief AAC Decoder using libhelix: https://github.com/pschatzmann/arduino-libhelix
  * This is basically just a simple wrapper to provide AudioInfo and AudioInfoDependent
- * @ingroup helix
+ * @ingroup codecs
+ * @ingroup decoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */

src/AudioCodecs/CodecAPTX.h

@@ -13,18 +13,13 @@
 #include "AudioBasic/Int24x.h"
 #include "openaptx.h"
 
-/** 
- * @defgroup aptx AptX
- * @ingroup codecs
- * @brief AptX Codec  
-**/
-
 namespace audio_tools {
 
 /**
  * @brief Decoder for OpenAptx. Depends on
  * https://github.com/pschatzmann/libopenaptx
- * @ingroup aptx
+ * @ingroup codecs
+ * @ingroup decoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -185,7 +180,8 @@ class APTXDecoder : public AudioDecoder {
 /**
  * @brief Encoder for OpenAptx - Depends on
  * https://github.com/pschatzmann/libopenaptx
- * @ingroup aptx
+ * @ingroup codecs
+ * @ingroup encoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */

src/AudioCodecs/CodecBase64.h

@@ -6,12 +6,6 @@
 
 namespace audio_tools {
 
-/** 
- * @defgroup codecsbase64 Base64
- * @ingroup codecs
- * @brief Codec for 8 bit data  
-**/
-
 
 enum Base46Logic { NoCR, CRforFrame, CRforWrite };
 static char encoding_table[] = {
@@ -36,7 +30,8 @@ static const int B64index[256] = {
  * data stream. Decoding only gives a valid result if we start at a limit of 4
  * bytes. We therefore use by default a newline to determine a valid start
  * boundary.
- * @ingroup codecsbase64
+ * @ingroup codecs
+ * @ingroup decoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -178,7 +173,8 @@ class DecoderBase64 : public AudioDecoder {
  * By default each audio frame is followed by a new line, so that we can
  * easily resynchronize the reading of a data stream. The generation
  * of the new line can be configured with the setNewLine() method.
- * @ingroup codecsbase64
+ * @ingroup codecs
+ * @ingroup encoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */

src/AudioCodecs/CodecCodec2.h

@@ -21,12 +21,6 @@
 #include "codec2.h"
 
 
-/**
- * @defgroup codec2 Codec2
- * @ingroup codecs
- * @brief Codec2
- **/
-
 namespace audio_tools {
 
 /// Convert bits per sample to Codec2 mode
@@ -59,7 +53,8 @@ int getCodec2Mode(int bits_per_second) {
 /**
  * @brief Decoder for Codec2. Depends on
  * https://github.com/pschatzmann/arduino-libcodec2.
- * @ingroup codec2
+ * @ingroup codecs
+ * @ingroup decoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -190,7 +185,8 @@ class Codec2Decoder : public AudioDecoder {
 /**
  * @brief Encoder for Codec2 - Depends on
  * https://github.com/pschatzmann/arduino-libcodec2.
- * @ingroup codec2
+ * @ingroup codecs
+ * @ingroup encoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */

src/AudioCodecs/CodecCopy.h

@@ -4,17 +4,13 @@
 #ifdef ARDUINO
 #include "Print.h"
 #endif
-/** 
- * @defgroup codec-copy Copy
- * @ingroup codecs
- * @brief Copies data as is   
-**/
 
 namespace audio_tools {
 
 /**
  * @brief Dummy Decoder which just copies the provided data to the output
- * @ingroup codec-copy
+ * @ingroup codecs
+ * @ingroup decoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -56,7 +52,8 @@ class CopyDecoder : public AudioDecoder {
 
 /**
  * @brief Dummy Encoder which just copies the provided data to the output
- * @ingroup codec-copy
+ * @ingroup codecs
+ * @ingroup encoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */

src/AudioCodecs/CodecFLAC.h

@@ -20,20 +20,15 @@
 #define FLAC_BUFFER_SIZE (8 * 1024)
 #endif
 
-/** 
- * @defgroup codec-flac FLAC
- * @ingroup codecs
- * @brief FLAC Codec   
-**/
-
 
 namespace audio_tools {
 
 /**
  * @brief Decoder for FLAC. Depends on https://github.com/pschatzmann/arduino-libflac. We support an efficient streaming API and an very memory intensitiv standard interface. So 
  * you should prefer the streaming interface where you call setOutputStream() before the begin and copy() in the loop.
  * Validated with http://www.2l.no/hires/
- * @ingroup codec-flac
+ * @ingroup codecs
+ * @ingroup decoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -266,7 +261,8 @@ class FLACDecoder : public StreamingDecoder {
 
 /**
  * @brief FLACEncoder
- * @ingroup codec-flac
+ * @ingroup codecs
+ * @ingroup encoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */

src/AudioCodecs/CodecFloat.h

@@ -2,18 +2,13 @@
 
 #include "AudioCodecs/AudioEncoded.h"
 
-/** 
- * @defgroup codec-float Floats
- * @ingroup codecs ml
- * @brief Converts between int16_t and floats   
-**/
-
 
 namespace audio_tools {
 
 /**
  * @brief DecoderFloat - Converts Stream of floats into 2 byte integers
- * @ingroup codec-float
+ * @ingroup codecs
+ * @ingroup decoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
@@ -110,7 +105,8 @@ class DecoderFloat : public AudioDecoder {
 /**
  * @brief EncoderFloats - Encodes 16 bit PCM data stream to floats
  * data. 
- * @ingroup codec-float
+ * @ingroup codecs
+ * @ingroup encoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */