I2SDriverESP32V1 Class Reference

Basic I2S API for the ESP32 (using the new API). https://docs.espressif.com/projects/esp-idf/en/v5.0.1/esp32/api-reference/peripherals/i2s.html#i2s-communication-mode. More...

#include <I2SDriverESP32V1.h>

Inheritance diagram for I2SDriverESP32V1:

Classes
struct	DriverCommon
struct	DriverI2S

Public Member Functions
int	available ()
	we assume the data is already available in the buffer
int	availableForWrite ()
bool	begin ()
virtual bool	begin (I2SConfig cfg)=0
bool	begin (I2SConfigESP32V1 cfg)
	starts the DAC
bool	begin (RxTxMode mode)
	starts the DAC with the default config
I2SConfigESP32V1	config ()
	provides the actual configuration
I2SConfigESP32V1	defaultConfig (RxTxMode mode)
	Provides the default configuration.
void	end ()
	stops the I2C and unistalls the driver
size_t	readBytes (void *dest, size_t size_bytes)
bool	setAudioInfo (AudioInfo info)
	Potentially updates the sample rate (if supported)
void	setWaitTimeReadMs (TickType_t ms)
void	setWaitTimeWriteMs (TickType_t ms)
size_t	writeBytes (const void *src, size_t size_bytes)
	writes the data to the I2S interface

Protected Member Functions
bool	begin (I2SConfigESP32V1 cfg, int txPin, int rxPin)
	-> protected methods from I2SDriverESP32V1
DriverCommon &	getDriver (I2SConfigESP32V1 &cfg)
bool	newChannels (I2SConfigESP32V1 &cfg, DriverCommon &driver)

Static Protected Member Functions
static IRAM_ATTR bool	onSentCb (i2s_chan_handle_t handle, i2s_event_data_t *event, void *user_ctx)

Protected Attributes
std::atomic< uint32_t >	bytes_sent_ {0}
std::atomic< uint32_t >	bytes_written_ {0}
I2SConfigESP32V1	cfg = defaultConfig(RXTX_MODE)
uint32_t	dma_capacity_ = 0
audio_tools::I2SDriverESP32V1::DriverI2S	i2s
i2s_std_config_t	i2s_config
bool	is_started = false
i2s_chan_handle_t	rx_chan = nullptr
TickType_t	ticks_to_wait_read = portMAX_DELAY
TickType_t	ticks_to_wait_write = portMAX_DELAY
i2s_chan_handle_t	tx_chan = nullptr

Detailed Description

Basic I2S API for the ESP32 (using the new API). https://docs.espressif.com/projects/esp-idf/en/v5.0.1/esp32/api-reference/peripherals/i2s.html#i2s-communication-mode.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

available()

int available ( )

inlinevirtual

we assume the data is already available in the buffer

Implements I2SDriverBase.

availableForWrite()

int availableForWrite ( )

inlinevirtual

Reports the real free space in the TX DMA queue: capacity minus the backlog of bytes handed to i2s_channel_write() but not yet reported back as sent by the on_sent event callback (see DriverI2S::startChannels and onSentCb below). Falls back to the old constant if the callback was never wired up (e.g. dma_capacity_ still 0 before begin()).

Implements I2SDriverBase.

begin() [1/5]

bool begin ( )

inline

starts the DAC with the current config - if not started yet. If I2S has been started there is no action and we return true

begin() [2/5]

virtual bool begin ( I2SConfig  cfg )

pure virtualinherited

Implemented in I2SDriverESP32.

begin() [3/5]

bool begin ( I2SConfigESP32V1  cfg )

inline

starts the DAC

begin() [4/5]

bool begin ( I2SConfigESP32V1  cfg, int  txPin, int  rxPin  )

inlineprotected

-> protected methods from I2SDriverESP32V1

starts I2S

begin() [5/5]

bool begin ( RxTxMode  mode )

inline

starts the DAC with the default config

config()

I2SConfigESP32V1 config ( )

inlinevirtual

provides the actual configuration

Implements I2SDriverBase.

defaultConfig()

I2SConfigESP32V1 defaultConfig ( RxTxMode  mode )

inlinevirtual

Provides the default configuration.

Implements I2SDriverBase.

end()

void end ( )

inlinevirtual

stops the I2C and unistalls the driver

Implements I2SDriverBase.

getDriver()

DriverCommon & getDriver ( I2SConfigESP32V1 &  cfg )

inlineprotected

newChannels()

bool newChannels ( I2SConfigESP32V1 &  cfg, DriverCommon &  driver  )

inlineprotected

onSentCb()

static IRAM_ATTR bool onSentCb ( i2s_chan_handle_t  handle, i2s_event_data_t *  event, void *  user_ctx  )

inlinestaticprotected

on_sent callback (ISR context): a DMA buffer of event->size bytes has just finished physically transmitting. Nested classes have access to enclosing-class members in C++, so DriverI2S can call this directly.

readBytes()

size_t readBytes ( void *  dest, size_t  size_bytes  )

inlinevirtual

Implements I2SDriverBase.

setAudioInfo()

bool setAudioInfo ( AudioInfo  info )

inlinevirtual

Potentially updates the sample rate (if supported)

Implements I2SDriverBase.

setWaitTimeReadMs()

void setWaitTimeReadMs ( TickType_t  ms )

inline

setWaitTimeWriteMs()

void setWaitTimeWriteMs ( TickType_t  ms )

inline

writeBytes()

size_t writeBytes ( const void *  src, size_t  size_bytes  )

inlinevirtual

writes the data to the I2S interface

Implements I2SDriverBase.

Member Data Documentation

bytes_sent_

std::atomic<uint32_t> bytes_sent_ {0}

protected

bytes_written_

std::atomic<uint32_t> bytes_written_ {0}

protected

cfg

I2SConfigESP32V1 cfg = defaultConfig(RXTX_MODE)

protected

dma_capacity_

uint32_t dma_capacity_ = 0

protected

i2s

audio_tools::I2SDriverESP32V1::DriverI2S i2s

protected

i2s_config

i2s_std_config_t i2s_config

protected

is_started

bool is_started = false

protected

rx_chan

i2s_chan_handle_t rx_chan = nullptr

protected

ticks_to_wait_read

TickType_t ticks_to_wait_read = portMAX_DELAY

protected

ticks_to_wait_write

TickType_t ticks_to_wait_write = portMAX_DELAY

protected

tx_chan

i2s_chan_handle_t tx_chan = nullptr

protected

---

The documentation for this class was generated from the following file:

• src/AudioTools/CoreAudio/AudioI2S/I2SDriverESP32V1.h