arduino-audio-tools
All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Modules Pages
AudioCodecsBase.h
1#pragma once
2
3#include "AudioToolsConfig.h"
4#include "AudioLogger.h"
5#include "AudioTools/CoreAudio/AudioBasic/Collections/Vector.h"
6#include "AudioTools/CoreAudio/AudioTypes.h"
7#include "AudioTools/CoreAudio/BaseStream.h"
8#include "AudioTools/CoreAudio/AudioOutput.h"
9
10namespace audio_tools {
11
19 public:
20 AudioDecoder() = default;
21 virtual ~AudioDecoder() = default;
22 AudioDecoder(AudioDecoder const &) = delete;
23 AudioDecoder &operator=(AudioDecoder const &) = delete;
24
25 AudioInfo audioInfo() override { return info; };
26
28 void setAudioInfo(AudioInfo from) override {
29 TRACED();
30 if (info != from) {
31 notifyAudioChange(from);
32 }
33 info = from;
34 }
36 virtual void setOutput(AudioStream &out_stream) {
37 Print *p_print = &out_stream;
38 setOutput(*p_print);
39 addNotifyAudioChange(out_stream);
40 }
41
43 virtual void setOutput(AudioOutput &out_stream) {
44 Print *p_print = &out_stream;
45 setOutput(*p_print);
46 addNotifyAudioChange(out_stream);
47 }
48
50 virtual void setOutput(Print &out_stream) override { p_print = &out_stream; }
51
53 virtual bool isResultPCM() { return true; }
54 virtual bool begin(AudioInfo info) override {
55 setAudioInfo(info);
56 return begin();
57 }
58 bool begin() override { return true; }
59 void end() override {}
60
62 int id;
63
64 Print* getOutput(){
65 return p_print;
66 }
67
69 virtual size_t writeCodecConfig(const uint8_t* data, size_t len){
70 LOGE("not implemented");
71 return 0;
72 }
73
74 protected:
75 Print *p_print = nullptr;
76 AudioInfo info;
77};
78
87 bool isResultPCM() override { return true; }
88};
89
96class AudioEncoder : public AudioWriter {
97 public:
98 AudioEncoder() = default;
99 virtual ~AudioEncoder() = default;
100 AudioEncoder(AudioEncoder const &) = delete;
101 AudioEncoder &operator=(AudioEncoder const &) = delete;
103 virtual const char *mime() = 0;
105 void setAudioInfo(AudioInfo from) override { info = from; }
106 AudioInfo audioInfo() override { return info; }
107
108 protected:
109 AudioInfo info;
110};
111
113 public:
114 virtual void setBlockSize(int blockSize) = 0;
115};
116
118 public:
119 virtual int blockSize() = 0;
120};
121
130class CodecNOP : public AudioDecoder, public AudioEncoder {
131 public:
132 static CodecNOP *instance() {
133 static CodecNOP self;
134 return &self;
135 }
136
137 virtual bool begin() { return true; }
138 virtual void end() {}
139 virtual void setOutput(Print &out_stream) {}
141 virtual void setAudioInfo(AudioInfo info) {}
142
144 AudioInfo info;
145 return info;
146 }
147 virtual operator bool() { return false; }
148 virtual int readStream(Stream &in) { return 0; };
149
150 // just output silence
151 virtual size_t write(const uint8_t *data, size_t len) {
152 memset((void *)data, 0, len);
153 return len;
154 }
155
156 virtual const char *mime() { return nullptr; }
157};
158
167 public:
169 virtual bool begin() = 0;
170
172 virtual void end() = 0;
173
175 virtual void setOutput(Print &out_stream) { p_print = &out_stream; }
176
178 virtual void setOutput(AudioStream &out_stream) {
179 Print *p_print = &out_stream;
180 setOutput(*p_print);
181 addNotifyAudioChange(out_stream);
182 }
183
185 virtual void setOutput(AudioOutput &out_stream) {
186 Print *p_print = &out_stream;
187 setOutput(*p_print);
188 addNotifyAudioChange(out_stream);
189 }
190
194 void setInput(Stream &inStream) { this->p_input = &inStream; }
195
197 virtual AudioInfo audioInfo() = 0;
198
200 virtual operator bool() = 0;
201
203 virtual bool copy() = 0;
204
206 bool copyAll() {
207 bool result = false;
208 while (copy()) {
209 result = true;
210 }
211 return result;
212 }
213
214 protected:
215 virtual size_t readBytes(uint8_t *data, size_t len) = 0;
216 Print *p_print = nullptr;
217 Stream *p_input = nullptr;
218};
219
227 public:
229 int copySize = DEFAULT_BUFFER_SIZE) {
230 p_decoder = &decoder;
231 if (copySize > 0) resize(copySize);
232 }
234 bool begin() override { return p_input != nullptr && p_decoder->begin(); }
235
237 void end() override { p_decoder->end(); }
238
240 void setOutput(Print &out_stream) override {
241 p_decoder->setOutput(out_stream);
242 }
243
245 AudioInfo audioInfo() override { return p_decoder->audioInfo(); }
246
248 virtual operator bool() override { return *p_decoder; }
249
251 virtual bool copy() override {
252 int read = readBytes(&buffer[0], buffer.size());
253 int written = 0;
254 if (read > 0) written = p_decoder->write(&buffer[0], read);
255 return written > 0;
256 }
257
259 void resize(int bufferSize) { buffer.resize(bufferSize); }
260
261 protected:
262 AudioDecoder *p_decoder = nullptr;
263 Vector<uint8_t> buffer{0};
264
265 size_t readBytes(uint8_t *data, size_t len) override {
266 if (p_input == nullptr) return 0;
267 return p_input->readBytes(data, len);
268 }
269};
270
271} // namespace audio_tools
Definition AudioCodecsBase.h:112
Decoding of encoded audio into PCM data.
Definition AudioCodecsBase.h:18
virtual bool isResultPCM()
Returns true to indicate that the decoding result is PCM data.
Definition AudioCodecsBase.h:53
void setAudioInfo(AudioInfo from) override
for most decoders this is not needed
Definition AudioCodecsBase.h:28
int id
custom id to be used by application
Definition AudioCodecsBase.h:62
virtual void setOutput(AudioStream &out_stream)
Defines where the decoded result is written to.
Definition AudioCodecsBase.h:36
virtual size_t writeCodecConfig(const uint8_t *data, size_t len)
Some decoders need e.g. a magic cookie to provide the relevant info for decoding.
Definition AudioCodecsBase.h:69
virtual void setOutput(Print &out_stream) override
Defines where the decoded result is written to.
Definition AudioCodecsBase.h:50
virtual void setOutput(AudioOutput &out_stream)
Defines where the decoded result is written to.
Definition AudioCodecsBase.h:43
AudioInfo audioInfo() override
provides the actual input AudioInfo
Definition AudioCodecsBase.h:25
Definition AudioCodecsBase.h:117
Encoding of PCM data.
Definition AudioCodecsBase.h:96
void setAudioInfo(AudioInfo from) override
Defines the sample rate, number of channels and bits per sample.
Definition AudioCodecsBase.h:105
virtual const char * mime()=0
Provides the mime type of the encoded result.
AudioInfo audioInfo() override
provides the actual input AudioInfo
Definition AudioCodecsBase.h:106
Supports the subscription to audio change notifications.
Definition AudioTypes.h:148
virtual void addNotifyAudioChange(AudioInfoSupport &bi)
Adds target to be notified about audio changes.
Definition AudioTypes.h:151
Supports changes to the sampling rate, bits and channels.
Definition AudioTypes.h:133
Abstract Audio Ouptut class.
Definition AudioOutput.h:22
Base class for all Audio Streams. It support the boolean operator to test if the object is ready with...
Definition BaseStream.h:119
E.g. used by Encoders and Decoders.
Definition AudioTypes.h:207
Dummy no implmentation Codec. This is used so that we can initialize some pointers to decoders and en...
Definition AudioCodecsBase.h:130
virtual void setOutput(Print &out_stream)
Defines where the decoded result is written to.
Definition AudioCodecsBase.h:139
virtual void addNotifyAudioChange(AudioInfoSupport &bi)
Adds target to be notified about audio changes.
Definition AudioCodecsBase.h:140
virtual const char * mime()
Provides the mime type of the encoded result.
Definition AudioCodecsBase.h:156
virtual void setAudioInfo(AudioInfo info)
for most decoders this is not needed
Definition AudioCodecsBase.h:141
virtual AudioInfo audioInfo()
provides the actual input AudioInfo
Definition AudioCodecsBase.h:143
Parent class for all container formats.
Definition AudioCodecsBase.h:86
Definition NoArduino.h:62
Definition NoArduino.h:142
Converts any AudioDecoder to a StreamingDecoder.
Definition AudioCodecsBase.h:226
virtual bool copy() override
Process a single read operation - to be called in the loop.
Definition AudioCodecsBase.h:251
void setOutput(Print &out_stream) override
Defines the output Stream.
Definition AudioCodecsBase.h:240
void end() override
Releases the reserved memory.
Definition AudioCodecsBase.h:237
void resize(int bufferSize)
Adjust the buffer size: the existing content of the buffer is lost!
Definition AudioCodecsBase.h:259
bool begin() override
Starts the processing.
Definition AudioCodecsBase.h:234
AudioInfo audioInfo() override
Provides the last available MP3FrameInfo.
Definition AudioCodecsBase.h:245
A Streaming Decoder where we provide both the input and output as streams.
Definition AudioCodecsBase.h:166
bool copyAll()
Process all data.
Definition AudioCodecsBase.h:206
virtual bool copy()=0
Process a single read operation - to be called in the loop.
virtual void setOutput(Print &out_stream)
Defines the output Stream.
Definition AudioCodecsBase.h:175
void setInput(Stream &inStream)
Definition AudioCodecsBase.h:194
virtual void setOutput(AudioStream &out_stream)
Defines the output streams and register to be notified.
Definition AudioCodecsBase.h:178
virtual void end()=0
Releases the reserved memory.
virtual void setOutput(AudioOutput &out_stream)
Defines the output streams and register to be notified.
Definition AudioCodecsBase.h:185
virtual AudioInfo audioInfo()=0
Provides the last available MP3FrameInfo.
virtual bool begin()=0
Starts the processing.
Vector implementation which provides the most important methods as defined by std::vector....
Definition Vector.h:21
Generic Implementation of sound input and output for desktop environments using portaudio.
Definition AudioCodecsBase.h:10
Basic Audio information which drives e.g. I2S.
Definition AudioTypes.h:53