Merge pull request #10900 from todbot/audiotools_speedchanger2

tannewt · web-flow · commit b13a8422db1b · 2026-03-31T09:14:33.000-07:00
add new audiotools.SpeedChanger module for WAV/MP3 speed changing
diff --git a/ports/raspberrypi/mpconfigport.mk b/ports/raspberrypi/mpconfigport.mk
@@ -11,6 +11,7 @@ CIRCUITPY_FLOPPYIO ?= 1
 CIRCUITPY_FRAMEBUFFERIO ?= $(CIRCUITPY_DISPLAYIO)
 CIRCUITPY_FULL_BUILD ?= 1
 CIRCUITPY_AUDIOMP3 ?= 1
+CIRCUITPY_AUDIOSPEED ?= 1
 CIRCUITPY_BITOPS ?= 1
 CIRCUITPY_HASHLIB ?= 1
 CIRCUITPY_HASHLIB_MBEDTLS ?= 1
diff --git a/ports/zephyr-cp/boards/adafruit/feather_nrf52840_zephyr/autogen_board_info.toml b/ports/zephyr-cp/boards/adafruit/feather_nrf52840_zephyr/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/native/native_sim/autogen_board_info.toml b/ports/zephyr-cp/boards/native/native_sim/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/native/nrf5340bsim/autogen_board_info.toml b/ports/zephyr-cp/boards/native/nrf5340bsim/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/nordic/nrf5340dk/autogen_board_info.toml b/ports/zephyr-cp/boards/nordic/nrf5340dk/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/nordic/nrf54h20dk/autogen_board_info.toml b/ports/zephyr-cp/boards/nordic/nrf54h20dk/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/nordic/nrf54l15dk/autogen_board_info.toml b/ports/zephyr-cp/boards/nordic/nrf54l15dk/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/nordic/nrf7002dk/autogen_board_info.toml b/ports/zephyr-cp/boards/nordic/nrf7002dk/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/nxp/frdm_mcxn947/autogen_board_info.toml b/ports/zephyr-cp/boards/nxp/frdm_mcxn947/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/nxp/frdm_rw612/autogen_board_info.toml b/ports/zephyr-cp/boards/nxp/frdm_rw612/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/nxp/mimxrt1170_evk/autogen_board_info.toml b/ports/zephyr-cp/boards/nxp/mimxrt1170_evk/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/renesas/da14695_dk_usb/autogen_board_info.toml b/ports/zephyr-cp/boards/renesas/da14695_dk_usb/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/renesas/ek_ra6m5/autogen_board_info.toml b/ports/zephyr-cp/boards/renesas/ek_ra6m5/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/renesas/ek_ra8d1/autogen_board_info.toml b/ports/zephyr-cp/boards/renesas/ek_ra8d1/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/st/nucleo_n657x0_q/autogen_board_info.toml b/ports/zephyr-cp/boards/st/nucleo_n657x0_q/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/st/nucleo_u575zi_q/autogen_board_info.toml b/ports/zephyr-cp/boards/st/nucleo_u575zi_q/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/st/stm32h750b_dk/autogen_board_info.toml b/ports/zephyr-cp/boards/st/stm32h750b_dk/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/st/stm32h7b3i_dk/autogen_board_info.toml b/ports/zephyr-cp/boards/st/stm32h7b3i_dk/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/ports/zephyr-cp/boards/st/stm32wba65i_dk1/autogen_board_info.toml b/ports/zephyr-cp/boards/st/stm32wba65i_dk1/autogen_board_info.toml
@@ -24,6 +24,7 @@ audioio = false
 audiomixer = false
 audiomp3 = false
 audiopwmio = false
+audiospeed = false
 aurora_epaper = false
 bitbangio = false
 bitmapfilter = true # Zephyr board has busio
diff --git a/py/circuitpy_defns.mk b/py/circuitpy_defns.mk
@@ -146,6 +146,9 @@ endif
 ifeq ($(CIRCUITPY_AUDIOMP3),1)
 SRC_PATTERNS += audiomp3/%
 endif
+ifeq ($(CIRCUITPY_AUDIOSPEED),1)
+SRC_PATTERNS += audiospeed/%
+endif
 ifeq ($(CIRCUITPY_AURORA_EPAPER),1)
 SRC_PATTERNS += aurora_epaper/%
 endif
@@ -693,6 +696,8 @@ SRC_SHARED_MODULE_ALL = \
 	audiocore/RawSample.c \
 	audiocore/WaveFile.c \
 	audiocore/__init__.c \
+	audiospeed/SpeedChanger.c \
+	audiospeed/__init__.c \
 	audiodelays/Echo.c \
 	audiodelays/Chorus.c \
 	audiodelays/PitchShift.c \
diff --git a/shared-bindings/audiospeed/SpeedChanger.c b/shared-bindings/audiospeed/SpeedChanger.c
@@ -0,0 +1,138 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2026 Tod Kurt
+//
+// SPDX-License-Identifier: MIT
+
+#include <stdint.h>
+
+#include "shared/runtime/context_manager_helpers.h"
+#include "py/objproperty.h"
+#include "py/runtime.h"
+#include "shared-bindings/audiospeed/SpeedChanger.h"
+#include "shared-bindings/audiocore/__init__.h"
+#include "shared-bindings/util.h"
+#include "shared-module/audiospeed/SpeedChanger.h"
+
+// Convert a Python float to 16.16 fixed-point rate
+static uint32_t rate_to_fp(mp_obj_t rate_obj) {
+    mp_float_t rate = mp_arg_validate_obj_float_range(rate_obj, 0.001, 1000.0, MP_QSTR_rate);
+    return (uint32_t)(rate * (1 << 16));
+}
+
+// Convert 16.16 fixed-point rate to Python float
+static mp_obj_t fp_to_rate(uint32_t rate_fp) {
+    return mp_obj_new_float((mp_float_t)rate_fp / (1 << 16));
+}
+
+//| class SpeedChanger:
+//|     """Wraps an audio sample to play it back at a different speed.
+//|
+//|     Uses nearest-neighbor resampling with a fixed-point phase accumulator
+//|     for CPU-efficient variable-speed playback."""
+//|
+//|     def __init__(self, source: circuitpython_typing.AudioSample, rate: float = 1.0) -> None:
+//|         """Create a SpeedChanger that wraps ``source``.
+//|
+//|         :param audiosample source: The audio source to resample.
+//|         :param float rate: Playback speed multiplier. 1.0 = normal, 2.0 = double speed,
+//|           0.5 = half speed. Must be positive.
+//|
+//|         Playing a wave file at 1.5x speed::
+//|
+//|           import board
+//|           import audiocore
+//|           import audiospeed
+//|           import audioio
+//|
+//|           wav = audiocore.WaveFile("drum.wav")
+//|           fast = audiospeed.SpeedChanger(wav, rate=1.5)
+//|           audio = audioio.AudioOut(board.A0)
+//|           audio.play(fast)
+//|
+//|           # Change speed during playback:
+//|           fast.rate = 2.0   # double speed
+//|           fast.rate = 0.5   # half speed
+//|         """
+//|         ...
+//|
+static mp_obj_t audiospeed_speedchanger_make_new(const mp_obj_type_t *type,
+    size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
+    enum { ARG_source, ARG_rate };
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_source, MP_ARG_REQUIRED | MP_ARG_OBJ },
+        { MP_QSTR_rate, MP_ARG_OBJ, {.u_rom_obj = MP_ROM_NONE} },
+    };
+    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+    mp_arg_parse_all_kw_array(n_args, n_kw, all_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+    // Validate source implements audiosample protocol
+    mp_obj_t source = args[ARG_source].u_obj;
+    audiosample_check(source);
+
+    uint32_t rate_fp = 1 << 16; // default 1.0
+    if (args[ARG_rate].u_obj != mp_const_none) {
+        rate_fp = rate_to_fp(args[ARG_rate].u_obj);
+    }
+
+    audiospeed_speedchanger_obj_t *self = mp_obj_malloc(audiospeed_speedchanger_obj_t, &audiospeed_speedchanger_type);
+    common_hal_audiospeed_speedchanger_construct(self, source, rate_fp);
+    return MP_OBJ_FROM_PTR(self);
+}
+
+//|     def deinit(self) -> None:
+//|         """Deinitialises the SpeedChanger and releases all memory resources for reuse."""
+//|         ...
+//|
+static mp_obj_t audiospeed_speedchanger_deinit(mp_obj_t self_in) {
+    audiospeed_speedchanger_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    common_hal_audiospeed_speedchanger_deinit(self);
+    return mp_const_none;
+}
+static MP_DEFINE_CONST_FUN_OBJ_1(audiospeed_speedchanger_deinit_obj, audiospeed_speedchanger_deinit);
+
+//|     rate: float
+//|     """Playback speed multiplier. Can be changed during playback."""
+//|
+static mp_obj_t audiospeed_speedchanger_obj_get_rate(mp_obj_t self_in) {
+    audiospeed_speedchanger_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    audiosample_check_for_deinit(&self->base);
+    return fp_to_rate(common_hal_audiospeed_speedchanger_get_rate(self));
+}
+MP_DEFINE_CONST_FUN_OBJ_1(audiospeed_speedchanger_get_rate_obj, audiospeed_speedchanger_obj_get_rate);
+
+static mp_obj_t audiospeed_speedchanger_obj_set_rate(mp_obj_t self_in, mp_obj_t rate_obj) {
+    audiospeed_speedchanger_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    audiosample_check_for_deinit(&self->base);
+    common_hal_audiospeed_speedchanger_set_rate(self, rate_to_fp(rate_obj));
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_2(audiospeed_speedchanger_set_rate_obj, audiospeed_speedchanger_obj_set_rate);
+
+MP_PROPERTY_GETSET(audiospeed_speedchanger_rate_obj,
+    (mp_obj_t)&audiospeed_speedchanger_get_rate_obj,
+    (mp_obj_t)&audiospeed_speedchanger_set_rate_obj);
+
+static const mp_rom_map_elem_t audiospeed_speedchanger_locals_dict_table[] = {
+    { MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&audiospeed_speedchanger_deinit_obj) },
+    { MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&default___enter___obj) },
+    { MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&default___exit___obj) },
+    { MP_ROM_QSTR(MP_QSTR_rate), MP_ROM_PTR(&audiospeed_speedchanger_rate_obj) },
+    AUDIOSAMPLE_FIELDS,
+};
+static MP_DEFINE_CONST_DICT(audiospeed_speedchanger_locals_dict, audiospeed_speedchanger_locals_dict_table);
+
+static const audiosample_p_t audiospeed_speedchanger_proto = {
+    MP_PROTO_IMPLEMENT(MP_QSTR_protocol_audiosample)
+    .reset_buffer = (audiosample_reset_buffer_fun)audiospeed_speedchanger_reset_buffer,
+    .get_buffer = (audiosample_get_buffer_fun)audiospeed_speedchanger_get_buffer,
+};
+
+MP_DEFINE_CONST_OBJ_TYPE(
+    audiospeed_speedchanger_type,
+    MP_QSTR_SpeedChanger,
+    MP_TYPE_FLAG_HAS_SPECIAL_ACCESSORS,
+    make_new, audiospeed_speedchanger_make_new,
+    locals_dict, &audiospeed_speedchanger_locals_dict,
+    protocol, &audiospeed_speedchanger_proto
+    );
diff --git a/shared-bindings/audiospeed/SpeedChanger.h b/shared-bindings/audiospeed/SpeedChanger.h
@@ -0,0 +1,17 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2026 Tod Kurt
+//
+// SPDX-License-Identifier: MIT
+
+#pragma once
+
+#include "shared-module/audiospeed/SpeedChanger.h"
+
+extern const mp_obj_type_t audiospeed_speedchanger_type;
+
+void common_hal_audiospeed_speedchanger_construct(audiospeed_speedchanger_obj_t *self,
+    mp_obj_t source, uint32_t rate_fp);
+void common_hal_audiospeed_speedchanger_deinit(audiospeed_speedchanger_obj_t *self);
+void common_hal_audiospeed_speedchanger_set_rate(audiospeed_speedchanger_obj_t *self, uint32_t rate_fp);
+uint32_t common_hal_audiospeed_speedchanger_get_rate(audiospeed_speedchanger_obj_t *self);
diff --git a/shared-bindings/audiospeed/__init__.c b/shared-bindings/audiospeed/__init__.c
@@ -0,0 +1,28 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2026 Tod Kurt
+//
+// SPDX-License-Identifier: MIT
+
+#include <stdint.h>
+
+#include "py/obj.h"
+#include "py/runtime.h"
+
+#include "shared-bindings/audiospeed/SpeedChanger.h"
+
+//| """Audio processing tools"""
+
+static const mp_rom_map_elem_t audiospeed_module_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_audiospeed) },
+    { MP_ROM_QSTR(MP_QSTR_SpeedChanger), MP_ROM_PTR(&audiospeed_speedchanger_type) },
+};
+
+static MP_DEFINE_CONST_DICT(audiospeed_module_globals, audiospeed_module_globals_table);
+
+const mp_obj_module_t audiospeed_module = {
+    .base = { &mp_type_module },
+    .globals = (mp_obj_dict_t *)&audiospeed_module_globals,
+};
+
+MP_REGISTER_MODULE(MP_QSTR_audiospeed, audiospeed_module);
diff --git a/shared-bindings/audiospeed/__init__.h b/shared-bindings/audiospeed/__init__.h
@@ -0,0 +1,7 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2026 Tod Kurt
+//
+// SPDX-License-Identifier: MIT
+
+#pragma once
diff --git a/shared-module/audiospeed/SpeedChanger.c b/shared-module/audiospeed/SpeedChanger.c
diff --git a/shared-module/audiospeed/SpeedChanger.h b/shared-module/audiospeed/SpeedChanger.h
diff --git a/shared-module/audiospeed/__init__.c b/shared-module/audiospeed/__init__.c
diff --git a/shared-module/audiospeed/__init__.h b/shared-module/audiospeed/__init__.h
