Components/driver/include/driver/i2s.h

Go to the documentation of this file.

#pragma once

#include <stdint.h>
#include <stddef.h>
#include <esp_attr.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef union {
    uint32_t u32;
    struct {
        int16_t left;
        int16_t right;
    };
} i2s_sample_t;

typedef enum {
    I2S_BITS_PER_SAMPLE_8BIT = 8,   
    I2S_BITS_PER_SAMPLE_16BIT = 16, 
    I2S_BITS_PER_SAMPLE_24BIT = 24, 
} i2s_bits_per_sample_t;

typedef enum {
    I2S_CHANNEL_MONO = 1,  
    I2S_CHANNEL_STEREO = 2 
} i2s_channel_t;

typedef enum {
    I2S_COMM_FORMAT_I2S = 0x01,     
    I2S_COMM_FORMAT_I2S_MSB = 0x01, 
    I2S_COMM_FORMAT_I2S_LSB = 0x03, 
} i2s_comm_format_t;

typedef enum {
    I2S_CHANNEL_FMT_RIGHT_LEFT = 0x00,
    I2S_CHANNEL_FMT_ALL_RIGHT,
    I2S_CHANNEL_FMT_ALL_LEFT,
    I2S_CHANNEL_FMT_ONLY_RIGHT,
    I2S_CHANNEL_FMT_ONLY_LEFT,
} i2s_channel_fmt_t;

typedef enum {
    I2S_MODE_DISABLED,
    I2S_MODE_MASTER,
    I2S_MODE_SLAVE,
} i2s_mode_t;

typedef enum {
    I2S_EVENT_DMA_ERROR,
    I2S_EVENT_TX_DONE, 
    I2S_EVENT_RX_DONE, 
    I2S_EVENT_MAX,   
} i2s_event_type_t;

typedef void (*i2s_callback_t)(void* param, i2s_event_type_t event);

typedef struct {
    i2s_mode_t mode;                        
    i2s_bits_per_sample_t bits_per_sample;  
    i2s_channel_fmt_t channel_format;       
    i2s_comm_format_t communication_format; 
    uint16_t dma_buf_len;                   
    uint8_t dma_buf_count;                  
    uint8_t callback_threshold;             
} i2s_module_config_t;

typedef struct {
    i2s_module_config_t tx;  
    i2s_module_config_t rx;  
    unsigned sample_rate;   
    bool tx_desc_auto_clear; 
    bool auto_start;         
    i2s_callback_t callback; 
    void* param;             
    uint8_t bits_mod;        
} i2s_config_t;

bool i2s_driver_install(const i2s_config_t* config);

void i2s_driver_uninstall();

bool i2s_start();

bool i2s_stop();

bool i2s_set_sample_rates(uint32_t rate);

bool i2s_set_dividers(uint8_t bck_div, uint8_t mclk_div);

float i2s_get_real_rate();

typedef struct {
    union {
        void* buffer;
        i2s_sample_t* samples;
    };
    size_t size; 
    // debugging
    uint16_t buf;
    uint16_t pos;
} i2s_buffer_info_t;

typedef unsigned TickType_t;

bool IRAM_ATTR i2s_dma_read(i2s_buffer_info_t* info, size_t max_bytes);

bool IRAM_ATTR i2s_dma_write(i2s_buffer_info_t* info, size_t max_bytes);

size_t i2s_write(const void* src, size_t size, TickType_t ticks_to_wait);

size_t i2s_read(void* dest, size_t size, TickType_t ticks_to_wait);

bool i2s_zero_dma_buffer();

typedef enum {
    I2S_PIN_BCK_OUT = 0x01,  
    I2S_PIN_WS_OUT = 0x02,   
    I2S_PIN_DATA_OUT = 0x04, 
    I2S_PIN_BC_IN = 0x10,   
    I2S_PIN_WS_IN = 0x20,   
    I2S_PIN_DATA_IN = 0x40,  
} i2s_pin_t;

typedef uint8_t i2s_pin_set_t;

void i2s_set_pins(i2s_pin_set_t pins, bool enable);

bool i2s_enable_loopback(bool enable);

typedef struct {
    uint16_t size;
    uint16_t used;
} i2s_buffer_stat_t;

bool i2s_stat_tx(i2s_buffer_stat_t* stat);

bool i2s_stat_rx(i2s_buffer_stat_t* stat);

//unsigned i2s_rx_available();


#ifdef __cplusplus
}
#endif