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.19.tar.gz (29.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_vs1053-1.2.19.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_vs1053-1.2.19.tar.gz
Algorithm Hash digest
SHA256 5e8666fa86d4d40f2974c6f2453b9daffce410013b848ebf5631318dacb35c29
MD5 80be3074fa5bf549dfb3fb235e1b63fa
BLAKE2b-256 a8ea52815fd4d5764e4f33c35bbf39659013216d091ce72200aa821bcf2513f9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vs1053-1.2.19-py3-none-any.whl
Algorithm Hash digest
SHA256 7336a333c9b078a782e45d2504cd1a10245cd80781b53a229a60fbb8d505ef82
MD5 261a4995a4fc4b5d354caa14b007deb6
BLAKE2b-256 f69a6585cd4a6fcef19bca7e700bae70b0509ffa85614f56c22633d8820f2ebb

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