Skip to main content

Driver for interacting and playing media files with the VS1053 audio codec over a SPI connection.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

Driver for interacting and playing media files with the VS1053 audio codec over a SPI connection.

NOTE: This is not currently working for audio playback of files. Only sine wave test currently works. The problem is that pure Python code is currently too slow to keep up with feeding data to the VS1053 fast enough. There’s no interrupt support so Python code has to monitor the DREQ line and provide a small buffer of data when ready, but the overhead of the interpreter means we can’t keep up. Optimizing SPI to use DMA transfers could help but ultimately an interrupt-based approach is likely what can make this work better (or C functions built in to custom builds that monitor the DREQ line and feed a buffer of data).

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-vs1053

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-vs1053

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-vs1053

Usage Example

See examples/sdfile_play.py.

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-vs1053-1.2.17.tar.gz (29.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-vs1053-1.2.17.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-vs1053-1.2.17.tar.gz
Algorithm Hash digest
SHA256 9a8228818af5ae1422b92ceae45f70072555f2312e54c8c9b6dd2203173e940e
MD5 abb7dfd68b1e4f93b65f71500a085a76
BLAKE2b-256 06ac2c5ab6d2400aeb3aa5a966a8c3a2b1bd9dac7d7edc1ca1229ec2acdc3eee

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_vs1053-1.2.17-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_vs1053-1.2.17-py3-none-any.whl
Algorithm Hash digest
SHA256 f71784254195c5d44ccf9b657674b4efa0788ae2282819a7b670d1fc37032cd7
MD5 222ccb0f177754a8a3cf8e8e6fe2867e
BLAKE2b-256 5744e300c52f1c8fef26d7bbcef22678d4f19436e24334e17beae7e8d07c45db

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page