arduino-audio-tools
Loading...
Searching...
No Matches
PWMAudioOutput.h
Go to the documentation of this file.
1#pragma once
2#include "AudioToolsConfig.h"
3#if defined(USE_PWM)
4
11// this is experimental at the moment
13#include "PWMConfig.h"
14
15namespace audio_tools {
16
25template<class PWMDriverT = PWMDriver>
27 public:
28 // Default constructor with default driver
29 PWMAudioOutput() = default;
32 if (p_driver->isTimerStarted()) {
33 end();
34 }
35 }
36
38 if (mode != TX_MODE) LOGE("mode not supported: using TX_MODE");
39 return p_driver->defaultConfig();
40 }
41
43
45 void setAudioInfo(AudioInfo info) override {
46 TRACEI();
47 AudioOutput::cfg = info;
49 if (cfg.sample_rate != info.sample_rate || cfg.channels != info.channels ||
53 cfg.channels = info.channels;
54 end();
55 begin(cfg);
56 cfg.logInfo();
57 }
58 }
59
61 AudioInfo result = audioInfo();
63 return result;
64 }
65
68 TRACED();
69 this->audio_config = config;
70 return begin();
71 }
72
78
79 virtual void end() override { p_driver->end(); }
80
81 int availableForWrite() override { return p_driver->availableForWrite(); }
82
83 size_t write(const uint8_t* data, size_t len) override {
84 return p_driver->write(data, len);
85 }
86
89
91 void setBuffer(BaseBuffer<uint8_t>* buffer) { p_driver->setBuffer(buffer); }
92
93 protected:
97};
98
99} // namespace audio_tools
100
101#endif
#define TRACEI()
Definition AudioLoggerIDF.h:32
#define TRACED()
Definition AudioLoggerIDF.h:31
#define LOGE(...)
Definition AudioLoggerIDF.h:30
Abstract Audio Ouptut class.
Definition AudioOutput.h:25
AudioInfo cfg
Definition AudioOutput.h:88
virtual void setAudioInfo(AudioInfo newInfo) override
Defines the input AudioInfo.
Definition AudioOutput.h:49
virtual AudioInfo audioInfo() override
provides the actual input AudioInfo
Definition AudioOutput.h:62
Shared functionality of all buffers.
Definition Buffers.h:23
Common functionality for PWM output. We generate audio using PWM with a frequency that is above the h...
Definition PWMAudioOutput.h:26
uint32_t framesPerSecond()
Definition PWMAudioOutput.h:88
uint32_t underflowsPerSecond()
Definition PWMAudioOutput.h:87
virtual PWMConfig defaultConfig(RxTxMode mode=TX_MODE)
Definition PWMAudioOutput.h:37
PWMDriverBase * driver()
Definition PWMAudioOutput.h:90
void setBuffer(BaseBuffer< uint8_t > *buffer)
Definition PWMAudioOutput.h:91
~PWMAudioOutput()
Definition PWMAudioOutput.h:31
PWMConfig config()
Definition PWMAudioOutput.h:42
bool begin()
Definition PWMAudioOutput.h:73
size_t write(const uint8_t *data, size_t len) override
Definition PWMAudioOutput.h:83
int availableForWrite() override
Definition PWMAudioOutput.h:81
PWMConfig audio_config
Definition PWMAudioOutput.h:94
AudioInfo audioInfoOut() override
Definition PWMAudioOutput.h:60
bool begin(PWMConfig config)
starts the processing using Streams
Definition PWMAudioOutput.h:67
PWMDriver pwm_driver
Definition PWMAudioOutput.h:95
void setAudioInfo(AudioInfo info) override
updates the sample rate dynamically
Definition PWMAudioOutput.h:45
PWMAudioOutput(PWMDriverBase &driver)
Definition PWMAudioOutput.h:30
virtual void end() override
Definition PWMAudioOutput.h:79
PWMDriverBase * p_driver
Definition PWMAudioOutput.h:96
Experimental: Audio output to PWM pins for the AVR. The AVR supports only up to 2 channels.
Definition PWMDriverAVR.h:24
Base Class for all PWM drivers.
Definition PWMDriverBase.h:36
uint32_t framesPerSecond()
Definition PWMDriverBase.h:139
virtual int effectiveOutputSampleRate()
Provides the effective sample rate.
Definition PWMDriverBase.h:168
uint32_t underflowsPerSecond()
Definition PWMDriverBase.h:137
virtual int availableForWrite()
Definition PWMDriverBase.h:92
void setBuffer(BaseBuffer< uint8_t > *buffer)
Definition PWMDriverBase.h:165
virtual PWMConfig defaultConfig()
Definition PWMDriverBase.h:43
bool isTimerStarted()
Definition PWMDriverBase.h:152
virtual size_t write(const uint8_t *data, size_t len)
Definition PWMDriverBase.h:102
bool begin(PWMConfig cfg)
Definition PWMDriverBase.h:49
virtual void end()
Definition PWMDriverBase.h:159
RxTxMode
The Microcontroller is the Audio Source (TX_MODE) or Audio Sink (RX_MODE). RXTX_MODE is Source and Si...
Definition AudioTypes.h:26
@ TX_MODE
Definition AudioTypes.h:26
Generic Implementation of sound input and output for desktop environments using portaudio.
Definition AudioCodecsBase.h:10
size_t writeData(Print *p_out, T *data, int samples, int maxSamples=512)
Definition AudioTypes.h:508
Basic Audio information which drives e.g. I2S.
Definition AudioTypes.h:51
sample_rate_t sample_rate
Sample Rate: e.g 44100.
Definition AudioTypes.h:53
uint16_t channels
Number of channels: 2=stereo, 1=mono.
Definition AudioTypes.h:55
uint8_t bits_per_sample
Number of bits per sample (int16_t = 16 bits)
Definition AudioTypes.h:57
virtual void logInfo(const char *source="")
Definition AudioTypes.h:121
Configuration data for PWM audio output.
Definition PWMConfigAVR.h:10