Logger

Author: pschatzmann

README.md

@@ -2,7 +2,7 @@
 
 Some basic C++ classes that can be used for Audio Processing privided as Arduino Library
 
-- Additional Stream implementations: MemoryStream, UrlStream [ESP32 only]
+- Additional Stream implementations: MemoryStream - ESP32 only: UrlStream, I2SStream
 - a simple I2S class (to read and write to the internal I2S) [ESP32 only]
 - a simple ADC class (to read analog data with the help of I2S) [ESP32 only]
 - Converters

src/AudioOutputWithCallback.h

@@ -24,6 +24,7 @@ class AudioOutputWithCallback : public AudioOutput
         delete buffer_ptr;
     }
 
+    /// Activates the output
     virtual bool begin() { 
         active = true;
         return true;

src/AudioTools/AudioLogger.h

@@ -31,10 +31,9 @@ class AudioLogger {
             Error
         };
 
-        AudioLogger(){}
 
         /// activate the logging
-        void begin(Stream& out, LogLevel level=SOUND_LOG_LEVEL){
+        void begin(Stream& out, LogLevel level=SOUND_LOG_LEVEL) {
             this->log_stream_ptr = &out;
             this->log_level = level;
         }
@@ -45,27 +44,27 @@ class AudioLogger {
         }
 
         /// logs an error
-        void error(const char *str, const char* str1=nullptr, const char* str2=nullptr){
+        void error(const char *str, const char* str1=nullptr, const char* str2=nullptr) const {
             log(Error, str, str1, str2);
         }
 
         /// logs an info message    
-        void info(const char *str, const char* str1=nullptr, const char* str2=nullptr){
+        void info(const char *str, const char* str1=nullptr, const char* str2=nullptr) const {
             log(Info, str, str1, str2);
         }
 
         /// logs an warning    
-        void warning(const char *str, const char* str1=nullptr, const char* str2=nullptr){
+        void warning(const char *str, const char* str1=nullptr, const char* str2=nullptr) const {
             log(Warning, str, str1, str2);
         }
 
         /// writes an debug message    
-        void debug(const char *str, const char* str1=nullptr, const char* str2=nullptr){
+        void debug(const char *str, const char* str1=nullptr, const char* str2=nullptr) const {
             log(Debug, str, str1, str2);
         }
 
         /// printf support
-        int printf(LogLevel current_level, const char* fmt, ...) {
+        int printf(LogLevel current_level, const char* fmt, ...) const {
             int len = 0;
             if (log_stream_ptr!=nullptr && current_level >= log_level){
                 char serial_printf_buffer[PRINTF_BUFFER_SIZE] = {0};
@@ -80,7 +79,7 @@ class AudioLogger {
 
 
         /// write an message to the log
-        void log(LogLevel current_level, const char *str, const char* str1=nullptr, const char* str2=nullptr){
+        void log(LogLevel current_level, const char *str, const char* str1=nullptr, const char* str2=nullptr) const {
             if (log_stream_ptr!=nullptr){
                 if (current_level >= log_level){
                     log_stream_ptr->print((char*)str);
@@ -98,13 +97,25 @@ class AudioLogger {
             }
         }
 
+        /// provides the singleton instance
+        static AudioLogger &instance(){
+            static AudioLogger *ptr;
+            if (ptr==nullptr){
+                ptr = new AudioLogger;
+            }
+            return *ptr;
+        }
+
+
     protected:
         Stream *log_stream_ptr;
         LogLevel log_level;  
 
+        AudioLogger(){
 
-};
+        }
 
-AudioLogger Logger;
+
+};
 
 }    

src/AudioTools/Streams.h

@@ -221,6 +221,7 @@ class UrlStream : public Stream {
         uint16_t read_buffer_size;
         uint16_t read_pos;
         uint16_t read_size;
+        const AudioLogger &Logger = AudioLogger::instance();
 
 
         inline void fillBuffer() {

src/AudioWAV.h

@@ -8,6 +8,7 @@
 
 namespace audio_tools {
 
+const AudioLogger& WAVLogger = AudioLogger::instance();
 
 /**
  * @brief Sound information which is available in the WAV header
@@ -41,7 +42,7 @@ class WAVHeader  {
         };
 
         void begin(uint8_t* buffer, size_t len){
-            Logger.printf(AudioLogger::Info,"WAVHeader len: ", len);
+            WAVLogger.printf(AudioLogger::Info,"WAVHeader len: ", len);
 
             this->buffer = buffer;
             this->len = len;
@@ -149,11 +150,11 @@ class WAVHeader  {
         size_t sound_pos = 0;
 
         void logInfo(){
-            Logger.printf(AudioLogger::Info,"WAVHeader sound_pos: ", sound_pos);
-            Logger.printf(AudioLogger::Info,"WAVHeader channels: ", headerInfo.channels);
-            Logger.printf(AudioLogger::Info,"WAVHeader bits_per_sample: ", headerInfo.bits_per_sample);
-            Logger.printf(AudioLogger::Info,"WAVHeader sample_rate: ", headerInfo.sample_rate);
-            Logger.printf(AudioLogger::Info,"WAVHeader format: ", headerInfo.format);
+            WAVLogger.printf(AudioLogger::Info,"WAVHeader sound_pos: ", sound_pos);
+            WAVLogger.printf(AudioLogger::Info,"WAVHeader channels: ", headerInfo.channels);
+            WAVLogger.printf(AudioLogger::Info,"WAVHeader bits_per_sample: ", headerInfo.bits_per_sample);
+            WAVLogger.printf(AudioLogger::Info,"WAVHeader sample_rate: ", headerInfo.sample_rate);
+            WAVLogger.printf(AudioLogger::Info,"WAVHeader format: ", headerInfo.format);
         }
 
         uint32_t read_tag() {
@@ -245,16 +246,16 @@ class WAVDecoder {
                     isFirst = false;
                     isValid = header.audioInfo().is_valid;
 
-                    Logger.printf(AudioLogger::Info,"WAV sample_rate: ", header.audioInfo().sample_rate);
-                    Logger.printf(AudioLogger::Info,"WAV data_length: ", header.audioInfo().data_length);
-                    Logger.printf(AudioLogger::Info,"WAV is_streamed: ", header.audioInfo().is_streamed);
-                    Logger.printf(AudioLogger::Info,"WAVis_valid: ", header.audioInfo().is_valid);
+                    WAVLogger.printf(AudioLogger::Info,"WAV sample_rate: ", header.audioInfo().sample_rate);
+                    WAVLogger.printf(AudioLogger::Info,"WAV data_length: ", header.audioInfo().data_length);
+                    WAVLogger.printf(AudioLogger::Info,"WAV is_streamed: ", header.audioInfo().is_streamed);
+                    WAVLogger.printf(AudioLogger::Info,"WAVis_valid: ", header.audioInfo().is_valid);
 
                     // check format
                     int format = header.audioInfo().format;
                     isValid = format == WAV_FORMAT_PCM;
                     if (format != WAV_FORMAT_PCM){
-                        Logger.printf(AudioLogger::Error,"WAV format not supported: ", format);
+                        WAVLogger.printf(AudioLogger::Error,"WAV format not supported: ", format);
                         isValid = false;
                     } else {
                         // update sampling rate if the target supports it
@@ -267,7 +268,7 @@ class WAVDecoder {
                         }
 
                         // write prm data from first record
-                        Logger.printf(AudioLogger::Info,"WAVDecoder writing first sound data");
+                        WAVLogger.printf(AudioLogger::Info,"WAVDecoder writing first sound data");
                         out->write(sound_ptr, len);
                     }
                 }