jason-mao/esp_audio_effects

readme

# ESP_AUDIO_EFFECTS

Espressif Audio Effects (ESP_AUDIO_EFFECTS) is the official audio processing module developed by Espressif Systems for SoCs. 

The ESP Audio Effects module provides a series of audio processing algorithms that can be used to modify, enhance, or alter the characteristics of audio signals.  

# Features

- Support algorithms: Automatic Level Control (ALC), Resample, Bit Convert, Channel Convert, Equalizer, Cross Data, Mixer, Fade, Sonic.

# Detailed introduction of each module

The following table links a detailed introduction to each submodule.  

|Module          |         Docs                                            |   
|:--------------:|:-------------------------------------------------------:| 
|ALC             | [alc readme](docs/README_ALC.md)                        |   
|BIT CONVERT     | [bit convert readme](docs/README_BIT_CONVERT.md)        |   
|CHANNEL CONVERT | [channel convert readme](docs/README_CHANNEL_CONVERT.md)| 
|CROSS DATA      | [cross data readme](docs/README_CROSSDATA.md)           | 
|EQ              | [eq readme](docs/README_EQ.md)                          | 
|FADE            | [fade readme](docs/README_FADE.md)                      | 
|MIXER           | [mixer readme](docs/README_MIXER.md)                    | 
|RESAMPLE        | [resample readme](docs/README_RESAMPLE.md)              | 
|SONIC           | [sonic readme](docs/README_SONIC.md)                    | 

#  Audio effects Release and SoC Compatibility

The following table shows audio effects support of Espressif SoCs where ![alt text](docs/_static/yes-icon.png "supported") means supported, and the lable ![alt text](docs/_static/no-icon.png) means not supported. 

|Chip         |         v1.0.0                        |   
|:-----------:|:-------------------------------------:| 
|ESP32        | ![alt text](docs/_static/yes-icon.png)|   
|ESP32-S2     | ![alt text](docs/_static/yes-icon.png)|   
|ESP32-C3     | ![alt text](docs/_static/yes-icon.png)| 
|ESP32-S3     | ![alt text](docs/_static/yes-icon.png)| 
|ESP32-P4     | ![alt text](docs/_static/yes-icon.png)|