From 75268b5e3bc88bbe41b11fe623a1386da3723d76 Mon Sep 17 00:00:00 2001 From: "Earle F. Philhower, III" Date: Sat, 2 Dec 2017 13:01:46 -0800 Subject: [PATCH] Add inline ID3 decoder w/callback interface ID3 tags can now automatically give your app a callback with different tag types without any additional work on your application. See the PlayMP3 example for a very simple example of AudioFileSourceID3's use. --- README.md | 3 + .../PlayMP3FromSPIFFS/PlayMP3FromSPIFFS.ino | 31 ++- examples/PlayMP3FromSPIFFS/data/pno-cs.mp3 | Bin 321002 -> 321664 bytes keywords.txt | 1 + src/AudioFileSourceID3.cpp | 224 ++++++++++++++++++ src/AudioFileSourceID3.h | 52 ++++ 6 files changed, 309 insertions(+), 2 deletions(-) create mode 100644 src/AudioFileSourceID3.cpp create mode 100644 src/AudioFileSourceID3.h diff --git a/README.md b/README.md index 6dadd2d..ce3eb11 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,9 @@ AudioOutputI2SNoDAC *out; ```` +## AudioFileSourceID3 - ID3 stream parser filter with a user-speficied callback +This class, which takes as input any other AudioFileSource and outputs an AudioFileSource suitable for any decoder, automatically parses out ID3 tags from MP3 files. You need to specify a callback function, which will be called as tags are decoded and allow you to update your UI state with this information. See the PlayMP3FromSPIFFS example for more information. + ## AudioGenerator classes AudioGenerator: Base class for all file decoders. Takes a AudioFileSource and an AudioOutput object to get the data from and to write decoded samples to. Call its loop() function as often as you can to ensure the buffers are always kept full and your music won't skip. diff --git a/examples/PlayMP3FromSPIFFS/PlayMP3FromSPIFFS.ino b/examples/PlayMP3FromSPIFFS/PlayMP3FromSPIFFS.ino index afc39b3..f85baa3 100644 --- a/examples/PlayMP3FromSPIFFS/PlayMP3FromSPIFFS.ino +++ b/examples/PlayMP3FromSPIFFS/PlayMP3FromSPIFFS.ino @@ -1,6 +1,7 @@ #include #include #include "AudioFileSourceSPIFFS.h" +#include "AudioFileSourceID3.h" #include "AudioGeneratorMP3.h" #include "AudioOutputI2SNoDAC.h" @@ -13,6 +14,30 @@ AudioGeneratorMP3 *mp3; AudioFileSourceSPIFFS *file; AudioOutputI2SNoDAC *out; +AudioFileSourceID3 *id3; + +void ID3Callback(const char *type, bool unicode, int len, AudioFileSource *src) +{ + Serial.printf("ID3 callback for: %s = [%d bytes] '", type, len); + if (unicode && len > 2) { + char ign[2]; + src->read(&ign, 2); + len -= 2; + } + while (len) { + char a, b; + src->read(&a, 1); + len--; + if (unicode && len) { + src->read(&b, 1); + len--; + } + Serial.printf("%c", a); + } + Serial.printf("'\n"); + Serial.flush(); +} + void setup() { @@ -20,10 +45,13 @@ void setup() Serial.begin(115200); delay(1000); SPIFFS.begin(); + Serial.printf("Sample MP3 playback begins...\n"); file = new AudioFileSourceSPIFFS("/pno-cs.mp3"); + id3 = new AudioFileSourceID3(file); + id3->setCallback(ID3Callback); out = new AudioOutputI2SNoDAC(); mp3 = new AudioGeneratorMP3(); - mp3->begin(file, out); + mp3->begin(id3, out); } void loop() @@ -35,4 +63,3 @@ void loop() delay(1000); } } - diff --git a/examples/PlayMP3FromSPIFFS/data/pno-cs.mp3 b/examples/PlayMP3FromSPIFFS/data/pno-cs.mp3 index 0b1bbc556f5985aaa15ceb231f8a376f5ce1571e..9d9d82ebdab2acc7a95aa1b799cfe5fbe7467342 100644 GIT binary patch delta 152 zcmaELTDak&aH^+^F*5@Yu$P5+h8O`Eyg(d~nV6Ta5S*A>kdqn`;A#jI5(Hw$qLR$w z5(W4C)M5pX)S}c7M;|AkumDIZC#f_SNhZ=Y2q?-5#6|{&2HQ72VX. +*/ + +#include "AudioFileSourceID3.h" + + +// Handle unsync operation in ID3 with custom class +class AudioFileSourceUnsync : public AudioFileSource +{ + public: + AudioFileSourceUnsync(AudioFileSource *src, int len, bool unsync); + virtual ~AudioFileSourceUnsync() override; + virtual uint32_t read(void *data, uint32_t len) override; + + int getByte(); + bool eof(); + + private: + AudioFileSource *src; + int remaining; + bool unsync; + int savedByte; +}; + +AudioFileSourceUnsync::AudioFileSourceUnsync(AudioFileSource *src, int len, bool unsync) +{ + this->src = src; + this->remaining = len; + this->unsync = unsync; + this->savedByte = -1; +} + +AudioFileSourceUnsync::~AudioFileSourceUnsync() +{ +} + +uint32_t AudioFileSourceUnsync::read(void *data, uint32_t len) +{ + uint32_t bytes = 0; + uint8_t *ptr = reinterpret_cast(data); + + // This is only used during ID3 parsing, so no need to optimize here... + while (len--) { + int b = getByte(); + if (b >= 0) { + *(ptr++) = (uint8_t)b; + bytes++; + } + } + return bytes; +} + +int AudioFileSourceUnsync::getByte() +{ + // If we've saved a pre-read character, return it immediately + if (savedByte >= 0) { + int s = savedByte; + savedByte = -1; + return s; + } + + if (remaining <= 0) { + return -1; + } else if (remaining == 1) { + remaining--; + uint8_t c; + if (1 != src->read(&c, 1)) return -1; + else return c; + } else { + uint8_t c; + remaining--; + if (1 != src->read(&c, 1)) return -1; + if (c != 0xff) { + return c; + } + // Saw 0xff, check next byte. If 0 then eat it, OTW return the 0xff + uint8_t d; + remaining--; + if (1 != src->read(&d, 1)) return c; + if (d != 0x00) { + savedByte = d; + } + return c; + } +} + +bool AudioFileSourceUnsync::eof() +{ + if (remaining<=0) return true; + else return false; +} + + + +AudioFileSourceID3::AudioFileSourceID3(AudioFileSource *src) +{ + this->src = src; + this->checked = false; + this->cb = NULL; +} + +AudioFileSourceID3::~AudioFileSourceID3() +{ + src->close(); +} + +uint32_t AudioFileSourceID3::read(void *data, uint32_t len) +{ + if (checked) { + return src->read(data, len); + } + checked = true; + // <10 bytes initial read, not enough space to check header + if (len<10) return src->read(data, len); + + uint8_t *buff = reinterpret_cast(data); + int ret = src->read(data, 10); + if (ret<10) return ret; + + if ((buff[0]!='I') || (buff[1]!='D') || (buff[2]!='3') || (buff[3]>0x04) || (buff[4]!=0)) { + return 10 + src->read(buff+10, len-10); + } + + bool unsync = (buff[5] & 0x80); + bool exthdr = (buff[5] & 0x40); + int id3Size = buff[6]; + id3Size = id3Size << 7; + id3Size |= buff[7]; + id3Size = id3Size << 7; + id3Size |= buff[8]; + id3Size = id3Size << 7; + id3Size |= buff[9]; + AudioFileSourceUnsync id3(src, id3Size-10, unsync); + // Every read from now may be unsync'd + + if (exthdr) { + int ehsz = (id3.getByte()<<24) | (id3.getByte()<<16) | (id3.getByte()<<8) | (id3.getByte()); + for (int j=0; jread(data, len); +} + +bool AudioFileSourceID3::seek(int32_t pos, int dir) +{ + return src->seek(pos, dir); +} + +bool AudioFileSourceID3::close() +{ + return src->close(); +} + +bool AudioFileSourceID3::isOpen() +{ + return src->isOpen(); +} + +uint32_t AudioFileSourceID3::getSize() +{ + return src->getSize(); +} + +uint32_t AudioFileSourceID3::getPos() +{ + return src->getPos(); +} diff --git a/src/AudioFileSourceID3.h b/src/AudioFileSourceID3.h new file mode 100644 index 0000000..a8c2ddd --- /dev/null +++ b/src/AudioFileSourceID3.h @@ -0,0 +1,52 @@ +/* + AudioFileSourceID3 + ID3 filter that extracts any ID3 fields and sends to CB function + + Copyright (C) 2017 Earle F. Philhower, III + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +*/ + +#ifndef _AUDIOFILESOURCEID3_H +#define _AUDIOFILESOURCEID3_H + +#include + +#include "AudioFileSource.h" + +class AudioFileSourceID3 : public AudioFileSource +{ + public: + AudioFileSourceID3(AudioFileSource *src); + virtual ~AudioFileSourceID3() override; + + virtual uint32_t read(void *data, uint32_t len) override; + virtual bool seek(int32_t pos, int dir) override; + virtual bool close() override; + virtual bool isOpen() override; + virtual uint32_t getSize() override; + virtual uint32_t getPos() override; + + typedef void (*callbackFn)(const char *type, bool isUnicode, int len, AudioFileSource *stream); + void setCallback(callbackFn f) { cb = f; } + + private: + AudioFileSource *src; + bool checked; + callbackFn cb; +}; + + +#endif +