Struct esp_idf_svc::hal::i2s::config::PdmRxSlotConfig

pub struct PdmRxSlotConfig { /* private fields */ }

PDM mode channel receive slot configuration.

Note

The slot_mode and slot_mask cause data to be interpreted in different ways, as noted below. WS is the “word select” signal, sometimes called LRCLK (left/right clock).

Assuming the received data contains the following samples (when converted from PDM to PCM), where a sample may be 8, 16, 24, or 32 bits, depending on data_bit_width:

WS Low	WS High	WS Low	WS High	WS Low	WS High	WS Low	WS High
11	12	13	14	15	16	17	18	…

The actual data in the buffer will be (1-4 bytes, depending on data_bit_width):

slot_mode	slot_mask	Buffer Contents
		d[0]	d[1]	d[2]	d[3]	d[4]	d[5]	d[6]	d[7]
Mono	Left	11	13	15	17	19	21	23	25
	Right	12	14	16	18	20	22	24	26
	Both	Unspecified behavior
Stereo (ESP32)	Any	11	12	13	14	15	16	17	18
Stereo (ESP32-S3)	Any	12	11	14	13	16	15	18	17

Note that, on the ESP32-S3, the right channel is received first. This can be switched by setting PdmRxGpioConfig::clk_invert to true in the merged PdmRxConfig.

For details, refer to the ESP-IDF Programming Guide PDM Rx Usage details for your specific microcontroller:

• ESP32
• ESP32-S3

Other microcontrollers do not support PDM receive mode, or do not have a PDM-to-PCM peripheral that allows for decoding the PDM data as required by ESP-IDF.

Implementations

impl PdmRxSlotConfig

pub fn from_bits_per_sample_and_slot_mode( bits_per_sample: DataBitWidth, slot_mode: SlotMode, ) -> PdmRxSlotConfig

Configure the PDM mode channel receive slot configuration for the specified bits per sample and slot mode in 2 slots.

pub fn data_bit_width(self, data_bit_width: DataBitWidth) -> PdmRxSlotConfig

Update the data bit width on this PDM receive slot configuration.

pub fn slot_bit_width(self, slot_bit_width: SlotBitWidth) -> PdmRxSlotConfig

Update the slot bit width on this PDM receive slot configuration.

pub fn slot_mode_mask( self, slot_mode: SlotMode, slot_mask: PdmSlotMask, ) -> PdmRxSlotConfig

Update the slot mode and mask on this PDM receive slot configuration.

Trait Implementations

impl Clone for PdmRxSlotConfig

fn clone(&self) -> PdmRxSlotConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PdmRxSlotConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for PdmRxSlotConfig

fn eq(&self, other: &PdmRxSlotConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PdmRxSlotConfig

impl Eq for PdmRxSlotConfig

impl StructuralPartialEq for PdmRxSlotConfig