Espressif DSP Library

ESP-DSP is the official DSP library for ESP32 and ESP32-S3 chips.

Overview

ESP-DSP is intended to be used as an ESP-IDF component. For the introduction to ESP-IDF, refer to the ESP-IDF Programming Guide.

The ESP-DSP library includes implementations of the following functions:

• Matrix multiplication: reference
• Dot product: reference, example
• FFT: reference, example
• IIR: reference, example
• FIR: reference
• Vector math operations: reference
• Kalman filter: reference

Many of the library functions are written in assembly and are optimized for the CPU configuration used in the ESP32. In addition to the optimized implementations, reference implementations written in ANSI C are provided.

Function implementations are provided for single precision floating point (32-bit float), and 16-bit signed integers.

Documentation

• ESP-DSP Overview
• ESP-DSP API Reference
• ESP-DSP Benchmarks

Documentation found in the above links is automatically generated from the contents of this repository. If you find that some information is missing or incomplete, please report an issue.

Installation and Usage

The ESP-DSP library is a component for the ESP-IDF build system.

The recommended way to use the component is to install it from the IDF Component Registry.

Adding ESP-DSP component to an existing project

In the project directory, run:

idf.py add-dependency "espressif/esp-dsp"

This will add the esp-dsp component as a dependency to the main component of your project. You can also add it by editing the idf_component.yml file manually.

Downloading ESP-DSP examples

You can download the example projects from the IDF Component Registry website or use the idf.py create-project-from-example command. For example:

idf.py create-project-from-example "espressif/esp-dsp:basic_math"

Please refer to the IDF Component Registry for the download links and the instructions.

You can also use Git to clone this repository and find all the examples in the examples/ subdirectory. For the list of the examples, please see README.md in the examples directory.

Building and running ESP-DSP examples

Build, flash and monitor as this is usually done for ESP-IDF projects:

idf.py -p PORT flash monitor

where PORT is the UART port name of your development board, such as /dev/ttyUSB0 or COM1.

Note that you need to set up ESP-IDF before building the project. Refer to the ESP-IDF Getting Started Guide if you don't have the environment set up yet.

Reporting Issues

If you have found an issue in ESP-DSP, or wish to submit an enhancement request, please use the Issues section on Github.

For general questions related to this library, please use the esp32.com forum.

Contributing to ESP-DSP

Please check CONTRIBUTING.md if you'd like to contribute to ESP-DSP.

Copyrights and License

All original source code in this repository is Copyright (C) 2018-2023 Espressif Systems. This source code is licensed under the Apache License 2.0 as described in the file LICENSE.