espressif/esp_codec_dev

Changelog

# Changelog

## v1.6.1

### Bug Fixed

- Fixed the ES8374 sample format configuration result handling to propagate errors and avoid an `unused-but-set-variable` build failure.

## v1.6.0

### Feature

- Added `esp_codec_dev_mirror_cfg()` and `esp_codec_dev_mirror_read()` for bypass reading during `esp_codec_dev_read()`.
- Added reference counting so multiple `esp_codec_dev` instances can share one physical ES8311/ES8388/ES8389 codec; hardware open/enable runs for the first user and close/disable for the last.
- Added `get_info` to the codec control interface to expose I2C address/port and SPI CS pin for identifying the same physical device.

### Bug Fixed

- Fixed reused codec instance missing configuration normalization (`mclk_div` default, and `use_mclk`/`no_dac_ref` on ES8389), which produced an invalid clock coefficient and all-zero ADC data.
- Fixed `get_coeff` failure handling so an unsupported MCLK/sample-rate combination reports an error instead of using an out-of-range coefficient index.
- Fixed PA control to skip when the codec has no output capability or no PA pin, and to set up the PA pin for shared output instances created on the reuse path.

## v1.5.11

### Bug Fixed

- Fixed ADC codec build error on IDF v6.0 and master

## v1.5.10

### Bug Fixed

- Fixed ES8389 disable and enable issues: use bias standby via `es8389_stop()` instead of full suspend when disabling the codec.
- Fixed ES8156 Playback/Record entries in README and README_CN.

## v1.5.9

### Bug Fixed

- Fixed build failure on ESP-IDF <= 5.4 caused by missing `bclk_div` field in `clk_cfg`.

## v1.5.8

### Bug Fixed

- Fixed open failures when separate ADC and DAC `data_if` instances on the same I2S port use the same audio parameters.
- Fixed I2S clock source reconfiguration using the wrong `data_if` instance when separate RX and TX `data_if` instances share the same I2S port.

## v1.5.7

### Feature

- Added support for resolving TX I2S handle from RX pair channel when only RX handle is provided in full duplex mode.
- Added slot bit width reconfiguration when peer codec on the same I2S port already runs with wider slots.
- Added channel gain setting for ES8389

### Bug Fixed

- Fixed 2ch TDM record wrongly for default right alignment comparing with STD mode.
- Enhanced compatible check for multiple instance of codec_dev use same I2S port.
  - Peer lookup prefers another data_if on the same port with only RX or only TX; if none, it matches the same data_if that has both RX and TX.
- Fixed incorrect ES8389 microphone gain table

## v1.5.6

### Bug Fixed

- Fixed es8311 pop issue when init again without close
- Fixed the esp_adc dependency issue

## v1.5.5

### Feature

- Added internal ADC microphone data interface support through `audio_codec_new_adc_data`.
- Added dummy codec support for PA-only speaker designs, allowing `esp_codec_dev_open/close` to control PA automatically.

## v1.5.4

### Feature

- Added support for I2S clock source configuration, primarily for low-power applications

### Bug Fixed

- Fixed header dependency issue for compatibility with ESP-IDF v6.0

## v1.5.3

### Bug Fixed

- Fixed the ES8389 no-sound playback issue.

## v1.5.2

### Bug Fixed

- Fixed race condition when duplex I2S used by multiple data interface and run open in parallel.

## v1.5.1

### Bug Fixed

- Fixed the register configuration for es8311 when playing 8kHz audio without using MCLK.
- Fixed race condition when record or playback disable and enable during another running.
- Fixed test_app build failed on esp-idf v6.x.
- Added support for duplex I2S TX and RX use multiple codecs (data_if use same port with one channel only).
- Added `esp_codec_dev_dump_reg` to dump codec registers.

## v1.5.0

### Refactor

- Clean up the component dependency, no longer depend on the `driver` component

## v1.4.0

### Bug Fixed

- Fixed name error in some macro definitions for ES7210.
- Fixed link error for `vol_range` redefinition.

## v1.3.6

### Feature

- Added support for CJC8910 codec.

### Bug Fixed

- Added missing ES8389 include in `esp_codec_dev_defaults.h`.

## v1.3.5

### Feature

- Added support for ES8389 codec，see detail datasheet [ES8389](http://www.everest-semi.com/pdf/ES8389%20PB.pdf)
- Added read/write register APIs
- Disabled `CONFIG_CODEC_I2C_BACKWARD_COMPATIBLE` by default.
  For ESP-IDF v5.x users who wish to continue using the legacy `i2c_driver_xx` APIs, please enable this option manually.

### Bug Fixes

- Fixed I2S PDM play noise issue

## v1.3.4

### Bug Fixes

- Enhance ES8311 I2C noise immunity

## v1.3.3

### Bug Fixes

- Fix codec without mute API, set mute wrong behavior

## v1.3.2

### Bug Fixes

- Fix `ES8374` volume register set error
- Fix `ES8388` microphone volume gain set incorrect

## v1.3.1

### Features

- Fix condition `CODEC_I2C_BACKWARD_COMPATIBLE` reversed
- Fix `CODEC_I2C_BACKWARD_COMPATIBLE` set to false build error

## v1.3.0

### Features

- Add configuration `CODEC_I2C_BACKWARD_COMPATIBLE` in Kconfig to allow use of the old I2C driver.
  Default is set to `y` for backward compatibility. To use the new I2C driver, set it to `n` instead.
- Fix send I2C address low byte firstly

## v1.2.0

### Features

- Add IDF v5.3 support
  Using new i2c driver `esp_driver_i2c`, add `bus_handle` configuration for `audio_codec_i2c_cfg_t`.
  User need create the `bus_handle` using API `i2c_new_master_bus` instead of `i2c_driver_install`.
- Change test code to standalone application, user can directly build it under folder [codec_dev_test](test_apps/codec_dev_test)

### Bug Fixes

- Fix I2S work in PDM mode record or play mono channel audio wrongly

## v1.1.0

### Features

- Add driver for AW88298, see detail datasheet [AW88298](https://datasheetspdf.com/download_new.php?id=1513778)

### Bug Fixes

- Fix ES8311 playback fade in for long time

## v1.0.3

### Bug Fixes

- Fix I2S TX and RX work in share mode, need enable TX before RX

## v1.0.2

### Features

- Add I2S TDM support
- Add API to `esp_codec_dev_set_in_channel_gain` to set input channel gain dependently

## v1.0.1

### Bug Fixes

- Fix ES8388 volume register set incorrectly

## v1.0.0

- Initial version of `esp_codec_dev`