-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathadafruit_vs1053.py
262 lines (222 loc) · 9.65 KB
/
adafruit_vs1053.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# SPDX-FileCopyrightText: 2017 Tony DiCola for Adafruit Industries
#
# SPDX-License-Identifier: MIT
"""
`adafruit_vs1053`
====================================================
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).
* Author(s): Tony DiCola
Implementation Notes
--------------------
**Hardware:**
* `Adafruit Music Maker FeatherWing - Synth Player <https://www.adafruit.com/product/3357>`_
* `Music Maker FeatherWing w/ Amp - Synth Player <https://www.adafruit.com/product/3436>`_
* `VS1053B MP3/WAV/OGG/MIDI Player & Recorder (CODEC) Chip <https://www.adafruit.com/product/1681>`_
* `VS1053 Codec + MicroSD Breakout - Play + Record - v4 <https://www.adafruit.com/product/1381>`_
**Software and Dependencies:**
* Adafruit CircuitPython firmware for the supported boards:
https://github.com/adafruit/circuitpython/releases
* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
"""
import time
import digitalio
from adafruit_bus_device.spi_device import SPIDevice
from micropython import const
try:
from typing import Optional
from busio import SPI
from circuitpython_typing import ReadableBuffer
from microcontroller import Pin
except ImportError:
pass
__version__ = "0.0.0+auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_VS1053.git"
_COMMAND_BAUDRATE = const(250000) # Speed for command transfers (MUST be slow)
_DATA_BAUDRATE = const(8000000) # Speed for data transfers (fast!)
_VS1053_SCI_READ = const(0x03)
_VS1053_SCI_WRITE = const(0x02)
_VS1053_REG_MODE = const(0x00)
_VS1053_REG_STATUS = const(0x01)
_VS1053_REG_BASS = const(0x02)
_VS1053_REG_CLOCKF = const(0x03)
_VS1053_REG_DECODETIME = const(0x04)
_VS1053_REG_AUDATA = const(0x05)
_VS1053_REG_WRAM = const(0x06)
_VS1053_REG_WRAMADDR = const(0x07)
_VS1053_REG_HDAT0 = const(0x08)
_VS1053_REG_HDAT1 = const(0x09)
_VS1053_REG_VOLUME = const(0x0B)
_VS1053_GPIO_DDR = const(0xC017)
_VS1053_GPIO_IDATA = const(0xC018)
_VS1053_GPIO_ODATA = const(0xC019)
_VS1053_INT_ENABLE = const(0xC01A)
_VS1053_MODE_SM_DIFF = const(0x0001)
_VS1053_MODE_SM_LAYER12 = const(0x0002)
_VS1053_MODE_SM_RESET = const(0x0004)
_VS1053_MODE_SM_CANCEL = const(0x0008)
_VS1053_MODE_SM_EARSPKLO = const(0x0010)
_VS1053_MODE_SM_TESTS = const(0x0020)
_VS1053_MODE_SM_STREAM = const(0x0040)
_VS1053_MODE_SM_SDINEW = const(0x0800)
_VS1053_MODE_SM_ADPCM = const(0x1000)
_VS1053_MODE_SM_LINE1 = const(0x4000)
_VS1053_MODE_SM_CLKRANGE = const(0x8000)
class VS1053:
"""Class-level buffer for read and write commands."""
# This is NOT thread/re-entrant safe (by design, for less memory hit).
_SCI_SPI_BUFFER = bytearray(4)
def __init__( # pylint: disable=invalid-name
self, spi: SPI, cs: Pin, xdcs: Pin, dreq: Pin
) -> None:
# Create SPI device for VS1053
self._cs = digitalio.DigitalInOut(cs)
self._vs1053_spi = SPIDevice(spi, self._cs, baudrate=_COMMAND_BAUDRATE, polarity=0, phase=0)
# Setup control lines.
self._xdcs = digitalio.DigitalInOut(xdcs)
self._xdcs.switch_to_output(value=True)
self._dreq = digitalio.DigitalInOut(dreq)
self._dreq.switch_to_input()
# Reset chip.
self.reset()
# Check version is 4 (VS1053 ID).
if self.version != 4:
raise RuntimeError(
f"Expected version 4 (VS1053) but got: {self.version} Check wiring!"
)
def _sci_write(self, address: int, value: int) -> None:
# Write a 16-bit big-endian value to the provided 8-bit address.
self._SCI_SPI_BUFFER[0] = _VS1053_SCI_WRITE
self._SCI_SPI_BUFFER[1] = address & 0xFF
self._SCI_SPI_BUFFER[2] = (value >> 8) & 0xFF
self._SCI_SPI_BUFFER[3] = value & 0xFF
with self._vs1053_spi as spi:
# pylint: disable=no-member
spi.configure(baudrate=_COMMAND_BAUDRATE)
spi.write(self._SCI_SPI_BUFFER)
def _sci_read(self, address: int) -> int:
# Read a 16-bit big-endian value from the provided 8-bit address.
# Write a 16-bit big-endian value to the provided 8-bit address.
self._SCI_SPI_BUFFER[0] = _VS1053_SCI_READ
self._SCI_SPI_BUFFER[1] = address & 0xFF
with self._vs1053_spi as spi:
# pylint: disable=no-member
spi.configure(baudrate=_COMMAND_BAUDRATE)
spi.write(self._SCI_SPI_BUFFER, end=2)
time.sleep(0.00001) # Delay 10 microseconds (at least)
spi.readinto(self._SCI_SPI_BUFFER, end=2)
# pylint: enable=no-member
return (self._SCI_SPI_BUFFER[0] << 8) | self._SCI_SPI_BUFFER[1]
def soft_reset(self) -> None:
"""Perform a quick soft reset of the VS1053."""
self._sci_write(_VS1053_REG_MODE, _VS1053_MODE_SM_SDINEW | _VS1053_MODE_SM_RESET)
time.sleep(0.1)
def reset(self) -> None:
"""Perform a longer full reset with clock and volume reset too."""
self._xdcs.value = True
self.soft_reset()
time.sleep(0.1)
self._sci_write(_VS1053_REG_CLOCKF, 0x6000)
self.set_volume(40, 40)
def set_volume(self, left: int, right: int) -> None:
"""Set the volume of the left and right channels to the provided byte
value (0-255), the lower the louder.
"""
volume = ((left & 0xFF) << 8) | (right & 0xFF)
self._sci_write(_VS1053_REG_VOLUME, volume)
@property
def ready_for_data(self) -> bool:
"""Return True if the VS1053 is ready to accept data, false otherwise."""
return self._dreq.value
@property
def version(self) -> int:
"""Return the status register version value."""
return (self._sci_read(_VS1053_REG_STATUS) >> 4) & 0x0F
@property
def decode_time(self) -> int:
"""Return the decode time register value. This is the amount of time
the current file has been played back in seconds."""
return self._sci_read(_VS1053_REG_DECODETIME)
@decode_time.setter
def decode_time(self, value: int) -> None:
"""Set the decode time register value."""
# From datasheet, set twice to ensure it is correctly set (pg. 43)
self._sci_write(_VS1053_REG_DECODETIME, value)
@property
def byte_rate(self) -> int:
"""Return the bit rate in bytes per second (computed each second).
Useful to know if a song is being played and how fast it's happening.
"""
self._sci_write(_VS1053_REG_WRAMADDR, 0x1E05)
return self._sci_read(_VS1053_REG_WRAM)
def start_playback(self) -> None:
"""Prepare for playback of a file. After calling this check the
ready_for_data property continually until true and then send in
buffers of music data to the play_data function.
"""
# Reset playback.
self._sci_write(_VS1053_REG_MODE, _VS1053_MODE_SM_LINE1 | _VS1053_MODE_SM_SDINEW)
# Resync.
self._sci_write(_VS1053_REG_WRAMADDR, 0x1E29)
self._sci_write(_VS1053_REG_WRAM, 0)
# Set time to zero.
self.decode_time = 0
def stop_playback(self) -> None:
"""Stop any playback of audio."""
self._sci_write(
_VS1053_REG_MODE,
_VS1053_MODE_SM_LINE1 | _VS1053_MODE_SM_SDINEW | _VS1053_MODE_SM_CANCEL,
)
def play_data(self, data_buffer: ReadableBuffer, start: int = 0, end: Optional[int] = None):
"""Send a buffer of file data to the VS1053 for playback. Make sure
the ready_for_data property is True before calling!
"""
try:
if end is None:
end = len(data_buffer)
self._xdcs.value = False
with self._vs1053_spi as spi:
# pylint: disable=no-member
spi.configure(baudrate=_DATA_BAUDRATE)
spi.write(data_buffer, start=start, end=end)
# pylint: enable=no-member
finally:
self._xdcs.value = True
def sine_test(self, n: int, seconds: float) -> None:
"""Play a sine wave for the specified number of seconds. Useful to
test the VS1053 is working.
"""
self.reset()
mode = self._sci_read(_VS1053_REG_MODE)
mode |= 0x0020
self._sci_write(_VS1053_REG_MODE, mode)
while not self.ready_for_data:
pass
try:
self._xdcs.value = False
with self._vs1053_spi as spi:
# pylint: disable=no-member
spi.configure(baudrate=_DATA_BAUDRATE)
spi.write(bytes([0x53, 0xEF, 0x6E, n & 0xFF, 0x00, 0x00, 0x00, 0x00]))
# pylint: enable=no-member
finally:
self._xdcs.value = True
time.sleep(seconds)
try:
self._xdcs.value = False
with self._vs1053_spi as spi:
# pylint: disable=no-member
spi.configure(baudrate=_DATA_BAUDRATE)
spi.write(bytes([0x45, 0x78, 0x69, 0x74, 0x00, 0x00, 0x00, 0x00]))
# pylint: enable=no-member
finally:
self._xdcs.value = True