arduino/arduino-audio-tools
1
0
Fork 0
mirror of https://github.com/pschatzmann/arduino-audio-tools.git synced 2024-09-21 10:27:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Arduino Audio Tools (Music Player, Music Recorder supporting I2S, Microphones, DAC, ADC, A2DP, Url, MP3, AAC, AudioKit, ES8388)
1,948 Commits 2 Branches 23 Tags 337 MiB
Jupyter Notebook 52.6%
C++ 45.7%
CMake 1%
C 0.7%
646c62daa9
Go to file
Phil Schatzmann 646c62daa9 Rename cmake-tests to tests-cmake
2023-05-13 05:56:37 +02:00
.github/workflows doxygen 2023-02-12 10:50:00 +01:00
docs Delete Resources 2023-02-12 22:19:40 +01:00
examples cmake min example 2023-05-13 05:29:30 +02:00
jupyter Jupyterlab README.md 2023-05-01 12:35:43 +02:00
src cmake compile warnings 2023-05-13 05:14:22 +02:00
tests-cmake Rename cmake-tests to tests-cmake 2023-05-13 05:56:37 +02:00
.gitignore Compile warnings 2023-03-30 20:39:12 +02:00
CMakeLists.txt cmake compile warnings 2023-05-13 05:14:22 +02:00
Doxyfile Corrections for RP2040W 2023-02-27 22:29:37 +01:00
library.properties cleanup 2023-04-21 09:55:50 +02:00
License.txt I2S 2021-04-29 11:52:46 +02:00
README.md README.md 2023-05-07 05:27:52 +02:00

README.md

Arduino Audio Tools

Some basic header-only C++ classes that can be used for Audio Processing provided as Arduino and cmake C++ Library:

This functionality provides the glue which makes different audio processing components and libraries work together. We also provide plenty of examples that demonstrate how to implement the different scenarios. The design philosophy is based on the Arduino conventions: we use the begin() and end() methods to start and stop the processing and we propagate the use of Streams. We all know the Arduino Streams: We usually use them to write out print messages and sometimes we use them to read the output from Serial devices. The same thing applies to “Audio Streams”: You can read audio data from “Audio Sources” and you write them to “Audio Sinks”.

As “Audio Sources” we will have e.g.:

As “Audio Sinks” we will have e.g:

Examples

Here is an simple example which streams a file from the Flash Memory and writes it to I2S:

#include "AudioTools.h"
#include "StarWars30.h"

uint8_t channels = 2;
uint16_t sample_rate = 22050;

MemoryStream music(StarWars30_raw, StarWars30_raw_len);
I2SStream i2s;  // Output to I2S
StreamCopy copier(i2s, music); // copies sound into i2s

void setup(){
    Serial.begin(115200);

    auto config = i2s.defaultConfig(TX_MODE);
    config.sample_rate = sample_rate;
    config.channels = channels;
    config.bits_per_sample = 16;
    i2s.begin(config);
}

void loop(){
    copier.copy();
}

Each stream has it's own configuration object that should be passed to the begin method. The defaultConfig() method is providing a default proposal which will usually "just work". Please consult the class documentation for the available configuration parameters. You can also easily adapt any provided examples: If you e.g. replace the I2SStream with the AnalogAudioStream class, you will get analog instead of digital output.

I suggest you continue to read the more detailed introduction.

Further examples can be found in the Wiki.

Dependent on the example you might need to install some addional libaries

AudioPlayer

The library also provides a versatile AudioPlayer. Further information can be found in the Wiki

Logging

The application uses a built in logger (see AudioLogger.h and AudioConfig.h). You can e.g. deactivate the logging by changing USE_AUDIO_LOGGING to false in the AudioConfig.h:

#define USE_AUDIO_LOGGING false
#define LOG_LEVEL AudioLogger::Warning
#define LOG_STREAM Serial

Per default we use the log level warning and the logging output is going to Serial. You can also change this in your sketch by calling AudioLogger begin with the output stream and the log level e.g:

AudioLogger::instance().begin(Serial, AudioLogger::Debug);

Show and Tell

Get some inspiration from projects that were using this library or share your projects with the community.

Documentation

Please use this before you raise any issue or start a discussion!

Installation in Arduino

You can download the library as zip and call include Library -> zip library. Or you can git clone this project into the Arduino libraries folder e.g. with

cd  ~/Documents/Arduino/libraries
git clone pschatzmann/arduino-audio-tools.git

I recommend to use git because you can easily update to the latest version just by executing the git pull command in the project folder. If you want to use the library in PlatformIO, you can find a detailed description in the Wiki.

Sponsor Me

This software is totally free, but you can make me happy by rewarding me with a treat