Metadata Selection

Author: pschatzmann

src/AudioDevices/ESP32AudioKit/AudioKit.h

@@ -383,7 +383,7 @@ class AudioKitStream : public AudioStream {
    * @return true
    * @return false
    */
-  virtual bool begin() { begin(defaultConfig()); }
+  virtual bool begin() { return begin(defaultConfig()); }
 
   /**
    * @brief Starts the processing
@@ -394,6 +394,7 @@ class AudioKitStream : public AudioStream {
    */
   virtual bool begin(ConfigES8388 cfg) {
     LOGI(LOG_METHOD);
+    bool result = true;
     this->cfg = cfg;
     bool isDac = cfg.rx_tx_mode == TX_MODE;
     bool isAdc = cfg.rx_tx_mode == RX_MODE;
@@ -411,23 +412,29 @@ class AudioKitStream : public AudioStream {
     }
 
     if (!initES8388(!cfg.is_master, isDac, isAdc)) {
+      result = false;
       LOGE("Error: initES8388 failed");
     }
     if (!configClock(cfg.clock_config)) {
+      result = false;
       LOGE("Error: configClock failed");
     }
     if (!setBitsPerSample(module_value, cfg.bits_per_sample)) {
+      result = false;
       LOGE("Error: setBitsPerSample failed");
     }
     if (!setFormat(module_value, cfg.i2s_format)) {
+      result = false;
       LOGE("Error: setFormat failed");
     }
     if (cfg.rx_tx_mode == RX_MODE) {
       if (!configAdcInput(cfg.input_device)) {
+        result = false;
         LOGE("Error: configAdcInput failed");
       }
     } else {
       if (!configDacOutput(cfg.output_device)) {
+        result = false;
         LOGE("Error: configDacOutput failed");
       }
     }
@@ -438,6 +445,7 @@ class AudioKitStream : public AudioStream {
     // set initial volume
     actionVolume = cfg.default_volume;
     if (!setVoiceVolume(actionVolume)) {
+      result = false;
       LOGE("setVoiceVolume failed");
     }
 
@@ -451,7 +459,9 @@ class AudioKitStream : public AudioStream {
     // start module
     if (!start(module_value)) {
       LOGE("start failed");
+      result = false;
     }
+    return result;
   }
 
   /**
@@ -616,7 +626,7 @@ class AudioKitStream : public AudioStream {
    * @return true
    * @return false
    */
-  bool incrementVoiceVolume(int inc) {
+  void incrementVoiceVolume(int inc) {
     actionVolume += inc;
     setVoiceVolume(actionVolume);
   }
@@ -1131,6 +1141,7 @@ class AudioKitStream : public AudioStream {
       case I2S_PCM_SHORT:
         return setFormat(module, ES_I2S_DSP);
     }
+    return false;
   }
   /**
    * @brief Configure ES8388 I2S format

src/AudioMetaData/AbstractMetaData.h

@@ -4,6 +4,8 @@
 
 namespace audio_tools {
 
+enum ID3TypeSelection { SELECT_ID3V1=0b001, SELECT_ID3V2=0b010, SELECT_ID3=0b011, SELECT_ICY=0b100, SELECT_ANY=0b111 };
+
 /// Type of meta info
 enum MetaDataType { Title, Artist, Album, Genre, Name, Description };
 

src/AudioMetaData/MetaDataID3.h

@@ -365,6 +365,11 @@ class MetaDataID3V2 : public MetaDataID3Base  {
         return frame_header;
     }
 
+    /// returns true if the tag has been provided
+    bool isProcessed() {
+        return tag_processed;
+    }
+
   protected:
     ID3v2 tagv2;
     bool tag_active = false;
@@ -511,7 +516,6 @@ class MetaDataID3V2 : public MetaDataID3Base  {
 
 };
 
-
 /**
  * @brief Simple ID3 Meta Data Parser which supports ID3 V1 and V2 and implements the Stream interface. You just need to set the callback(s) to receive the result 
  * and copy the audio data to this stream.
@@ -533,6 +537,10 @@ class MetaDataID3 : public AbstractMetaData {
         id3v2.setCallback(fn);        
     }
 
+    void setFilter(ID3TypeSelection sel) {
+        this->filter = sel;
+    }
+
     void begin() {
         LOGI(LOG_METHOD);
         id3v1.begin();
@@ -548,15 +556,17 @@ class MetaDataID3 : public AbstractMetaData {
     /// Provide tha audio data to the API to parse for Meta Data
     virtual size_t write(const uint8_t *data, size_t length){
         LOGD(LOG_METHOD);
-        id3v1.write(data, length);
-        id3v2.write(data, length);
+        if (filter & SELECT_ID3V2) id3v2.write(data, length);
+        if (!id3v2.isProcessed()) {
+            if (filter & SELECT_ID3V1) id3v1.write(data, length);
+        }
         return length;
     }
 
-
   protected:
     MetaDataID3V1 id3v1;
     MetaDataID3V2 id3v2;
+    int filter = SELECT_ID3;
 };
 
 } // namespace

src/AudioTools/AudioPlayer.h

@@ -81,7 +81,7 @@ namespace audio_tools {
         virtual bool isAutoNext();
 
         // only the ICYStream supports this
-        virtual bool setMetadataCallback(void (*fn)(MetaDataType info, const char* str, int len)) {
+        virtual bool setMetadataCallback(void (*fn)(MetaDataType info, const char* str, int len), ID3TypeSelection sel=SELECT_ICY) {
             return false;
         }
 
@@ -464,7 +464,7 @@ namespace audio_tools {
         };
 
         // only the ICYStream supports this
-        bool setMetadataCallback(void (*fn)(MetaDataType info, const char* str, int len)) {
+        bool setMetadataCallback(void (*fn)(MetaDataType info, const char* str, int len), ID3TypeSelection sel=SELECT_ICY) {
             LOGI(LOG_METHOD);
             return actual_stream->setMetadataCallback(fn);
         }
@@ -773,7 +773,7 @@ namespace audio_tools {
         }
 
         /// Defines the medatadata callback
-        virtual void setMetadataCallback(void (*callback)(MetaDataType type, const char* str, int len)) {
+        virtual void setMetadataCallback(void (*callback)(MetaDataType type, const char* str, int len), ID3TypeSelection sel=SELECT_ID3) {
             LOGI(LOG_METHOD);
             // setup metadata. 
             if (p_source->setMetadataCallback(callback)){
@@ -783,6 +783,7 @@ namespace audio_tools {
             } else {
                 // metadata is handled here
                 meta_out.setCallback(callback);
+                meta_out.setFilter(sel);
                 meta_active = true;
             }
         }