MultiDecoder comments

Author: pschatzmann

src/AudioTools/AudioCodecs/MultiDecoder.h

@@ -9,22 +9,24 @@ namespace audio_tools {
 
 /**
  * @brief Manage multiple decoders: the actual decoder is only opened when it
- * has been selected.
+ * has been selected. The relevant decoder is determined dynamically at the first
+ * write from the determined mime type. You can add your own custom mime type
+ * determination logic. 
  * @ingroup codecs
  * @ingroup decoder
  * @author Phil Schatzmann
  * @copyright GPLv3
  */
 class MultiDecoder : public AudioDecoder {
-  //
-  bool begin() {
+  /// Enables the automatic mime type determination
+  bool begin() override {
     mime_detector.begin();
     is_first = true;
     return true;
   }
 
   /// closes the actual decoder
-  void end() {
+  void end() override {
     if (actual_decoder.decoder != nullptr && actual_decoder.is_open) {
       actual_decoder.decoder->end();
     }
@@ -40,7 +42,7 @@ class MultiDecoder : public AudioDecoder {
     decoders.push_back(info);
   }
 
-  // selects the actual decoder by mime type
+  /// selects the actual decoder by mime type - this is usually called automatically from the determined mime type
   bool selectDecoder(const char* mime) {
     bool result = false;
     // do nothing if no change
@@ -63,7 +65,7 @@ class MultiDecoder : public AudioDecoder {
     return result;
   }
 
-  virtual size_t write(const uint8_t* data, size_t len) {
+  size_t write(const uint8_t* data, size_t len) override {
     if (is_first) {
       // select the decoder based on the detemined mime type
       mime_detector.write((uint8_t*)data, len);