Skip to content

Commit 1bf769a

Browse files
relic-serelic-se
committed
Initial setup of multi-tap delay effect.
1 parent 4a16ed1 commit 1bf769a

File tree

7 files changed

+669
-0
lines changed

7 files changed

+669
-0
lines changed

‎ports/unix/variants/coverage/mpconfigvariant.mk

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ SRC_BITMAP := \
3636
shared-bindings/audiodelays/Echo.c \
3737
shared-bindings/audiodelays/Chorus.c \
3838
shared-bindings/audiodelays/PitchShift.c \
39+
shared-bindings/audiodelays/MultiTapDelay.c \
3940
shared-bindings/audiodelays/__init__.c \
4041
shared-bindings/audiofilters/Distortion.c \
4142
shared-bindings/audiofilters/Filter.c \
@@ -80,6 +81,7 @@ SRC_BITMAP := \
8081
shared-module/audiodelays/Echo.c \
8182
shared-module/audiodelays/Chorus.c \
8283
shared-module/audiodelays/PitchShift.c \
84+
shared-module/audiodelays/MultiTapDelay.c \
8385
shared-module/audiodelays/__init__.c \
8486
shared-module/audiofilters/Distortion.c \
8587
shared-module/audiofilters/Filter.c \

‎py/circuitpy_defns.mk

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -666,6 +666,7 @@ SRC_SHARED_MODULE_ALL = \
666666
audiodelays/Echo.c \
667667
audiodelays/Chorus.c \
668668
audiodelays/PitchShift.c \
669+
audiodelays/MultiTapDelay.c \
669670
audiodelays/__init__.c \
670671
audiofilters/Distortion.c \
671672
audiofilters/Filter.c \

‎shared-bindings/audiodelays/MultiTapDelay.c

Lines changed: 278 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,278 @@
1+
// This file is part of the CircuitPython project: https://circuitpython.org
2+
//
3+
// SPDX-FileCopyrightText: Copyright (c) 2025 Cooper Dalrymple
4+
//
5+
// SPDX-License-Identifier: MIT
6+
7+
#include <stdint.h>
8+
9+
#include "shared-bindings/audiodelays/MultiTapDelay.h"
10+
#include "shared-bindings/audiocore/__init__.h"
11+
#include "shared-module/audiodelays/MultiTapDelay.h"
12+
13+
#include "shared/runtime/context_manager_helpers.h"
14+
#include "py/binary.h"
15+
#include "py/objproperty.h"
16+
#include "py/runtime.h"
17+
#include "shared-bindings/util.h"
18+
#include "shared-module/synthio/block.h"
19+
20+
//| class MultiTapDelay:
21+
//| """A delay with multiple buffer positions to create a rhythmic effect."""
22+
//|
23+
//| def __init__(
24+
//| self,
25+
//| max_delay_ms: int = 500,
26+
//| delay_ms: synthio.BlockInput = 250.0,
27+
//| decay: synthio.BlockInput = 0.7,
28+
//| mix: synthio.BlockInput = 0.25,
29+
//| buffer_size: int = 512,
30+
//| sample_rate: int = 8000,
31+
//| bits_per_sample: int = 16,
32+
//| samples_signed: bool = True,
33+
//| channel_count: int = 1,
34+
//| ) -> None:
35+
//| """Create a MultiTapDelay effect where you hear the original sample play back, at a lesser volume after
36+
//| a set number of millisecond delay. The delay timing of the echo can be changed at runtime
37+
//| with the delay_ms parameter but the delay can never exceed the max_delay_ms parameter. The
38+
//| maximum delay you can set is limited by available memory.
39+
//|
40+
//| Each time the echo plays back the volume is reduced by the decay setting (echo * decay).
41+
//|
42+
//| The mix parameter allows you to change how much of the unchanged sample passes through to
43+
//| the output to how much of the effect audio you hear as the output.
44+
//|
45+
//| :param int max_delay_ms: The maximum time the echo can be in milliseconds
46+
//| :param float delay_ms: The current time of the echo delay in milliseconds. Must be less the max_delay_ms
47+
//| :param synthio.BlockInput decay: The rate the echo fades. 0.0 = instant; 1.0 = never.
48+
//| :param synthio.BlockInput mix: The mix as a ratio of the sample (0.0) to the effect (1.0).
49+
//| :param int buffer_size: The total size in bytes of each of the two playback buffers to use
50+
//| :param int sample_rate: The sample rate to be used
51+
//| :param int channel_count: The number of channels the source samples contain. 1 = mono; 2 = stereo.
52+
//| :param int bits_per_sample: The bits per sample of the effect
53+
//| :param bool samples_signed: Effect is signed (True) or unsigned (False)
54+
//|
55+
//| Playing adding a multi-tap delay to a synth::
56+
//|
57+
//| import time
58+
//| import board
59+
//| import audiobusio
60+
//| import synthio
61+
//| import audiodelays
62+
//|
63+
//| audio = audiobusio.I2SOut(bit_clock=board.GP20, word_select=board.GP21, data=board.GP22)
64+
//| synth = synthio.Synthesizer(channel_count=1, sample_rate=44100)
65+
//| effect = audiodelays.MultiTapDelay(max_delay_ms=1000, delay_ms=850, decay=0.65, buffer_size=1024, channel_count=1, sample_rate=44100, mix=0.7, freq_shift=False)
66+
//| effect.play(synth)
67+
//| audio.play(effect)
68+
//|
69+
//| note = synthio.Note(261)
70+
//| while True:
71+
//| synth.press(note)
72+
//| time.sleep(0.25)
73+
//| synth.release(note)
74+
//| time.sleep(5)"""
75+
//| ...
76+
//|
77+
static mp_obj_t audiodelays_multi_tap_delay_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
78+
enum { ARG_max_delay_ms, ARG_delay_ms, ARG_decay, ARG_mix, ARG_buffer_size, ARG_sample_rate, ARG_bits_per_sample, ARG_samples_signed, ARG_channel_count, ARG_freq_shift, };
79+
static const mp_arg_t allowed_args[] = {
80+
{ MP_QSTR_max_delay_ms, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 500 } },
81+
{ MP_QSTR_delay_ms, MP_ARG_OBJ | MP_ARG_KW_ONLY, {.u_obj = MP_ROM_INT(250) } },
82+
{ MP_QSTR_decay, MP_ARG_OBJ | MP_ARG_KW_ONLY, {.u_obj = MP_OBJ_NULL} },
83+
{ MP_QSTR_mix, MP_ARG_OBJ | MP_ARG_KW_ONLY, {.u_obj = MP_OBJ_NULL} },
84+
{ MP_QSTR_buffer_size, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 512} },
85+
{ MP_QSTR_sample_rate, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 8000} },
86+
{ MP_QSTR_bits_per_sample, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 16} },
87+
{ MP_QSTR_samples_signed, MP_ARG_BOOL | MP_ARG_KW_ONLY, {.u_bool = true} },
88+
{ MP_QSTR_channel_count, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 1 } },
89+
};
90+
91+
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
92+
mp_arg_parse_all_kw_array(n_args, n_kw, all_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
93+
94+
mp_int_t max_delay_ms = mp_arg_validate_int_range(args[ARG_max_delay_ms].u_int, 1, 4000, MP_QSTR_max_delay_ms);
95+
96+
mp_int_t channel_count = mp_arg_validate_int_range(args[ARG_channel_count].u_int, 1, 2, MP_QSTR_channel_count);
97+
mp_int_t sample_rate = mp_arg_validate_int_min(args[ARG_sample_rate].u_int, 1, MP_QSTR_sample_rate);
98+
mp_int_t bits_per_sample = args[ARG_bits_per_sample].u_int;
99+
if (bits_per_sample != 8 && bits_per_sample != 16) {
100+
mp_raise_ValueError(MP_ERROR_TEXT("bits_per_sample must be 8 or 16"));
101+
}
102+
103+
audiodelays_multi_tap_delay_obj_t *self = mp_obj_malloc(audiodelays_multi_tap_delay_obj_t, &audiodelays_multi_tap_delay_type);
104+
common_hal_audiodelays_multi_tap_delay_construct(self, max_delay_ms, args[ARG_delay_ms].u_obj, args[ARG_decay].u_obj, args[ARG_mix].u_obj, args[ARG_buffer_size].u_int, bits_per_sample, args[ARG_samples_signed].u_bool, channel_count, sample_rate);
105+
106+
return MP_OBJ_FROM_PTR(self);
107+
}
108+
109+
//| def deinit(self) -> None:
110+
//| """Deinitialises the MultiTapDelay."""
111+
//| ...
112+
//|
113+
static mp_obj_t audiodelays_multi_tap_delay_deinit(mp_obj_t self_in) {
114+
audiodelays_multi_tap_delay_obj_t *self = MP_OBJ_TO_PTR(self_in);
115+
common_hal_audiodelays_multi_tap_delay_deinit(self);
116+
return mp_const_none;
117+
}
118+
static MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_multi_tap_delay_deinit_obj, audiodelays_multi_tap_delay_deinit);
119+
120+
static void check_for_deinit(audiodelays_multi_tap_delay_obj_t *self) {
121+
audiosample_check_for_deinit(&self->base);
122+
}
123+
124+
//| def __enter__(self) -> MultiTapDelay:
125+
//| """No-op used by Context Managers."""
126+
//| ...
127+
//|
128+
// Provided by context manager helper.
129+
130+
//| def __exit__(self) -> None:
131+
//| """Automatically deinitializes when exiting a context. See
132+
//| :ref:`lifetime-and-contextmanagers` for more info."""
133+
//| ...
134+
//|
135+
// Provided by context manager helper.
136+
137+
138+
//| delay_ms: float
139+
//| """Maximum time to delay the incoming signal in milliseconds."""
140+
//|
141+
static mp_obj_t audiodelays_multi_tap_delay_obj_get_delay_ms(mp_obj_t self_in) {
142+
audiodelays_multi_tap_delay_obj_t *self = MP_OBJ_TO_PTR(self_in);
143+
return mp_obj_new_float(common_hal_audiodelays_multi_tap_delay_get_delay_ms(self));
144+
}
145+
MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_multi_tap_delay_get_delay_ms_obj, audiodelays_multi_tap_delay_obj_get_delay_ms);
146+
147+
static mp_obj_t audiodelays_multi_tap_delay_obj_set_delay_ms(mp_obj_t self_in, mp_obj_t delay_ms_in) {
148+
audiodelays_multi_tap_delay_obj_t *self = MP_OBJ_TO_PTR(self_in);
149+
common_hal_audiodelays_multi_tap_delay_set_delay_ms(self, delay_ms_in);
150+
return mp_const_none;
151+
}
152+
MP_DEFINE_CONST_FUN_OBJ_2(audiodelays_multi_tap_delay_set_delay_ms_obj, audiodelays_multi_tap_delay_obj_set_delay_ms);
153+
154+
MP_PROPERTY_GETSET(audiodelays_multi_tap_delay_delay_ms_obj,
155+
(mp_obj_t)&audiodelays_multi_tap_delay_get_delay_ms_obj,
156+
(mp_obj_t)&audiodelays_multi_tap_delay_set_delay_ms_obj);
157+
158+
//| decay: synthio.BlockInput
159+
//| """The rate the echo fades between 0 and 1 where 0 is instant and 1 is never."""
160+
static mp_obj_t audiodelays_multi_tap_delay_obj_get_decay(mp_obj_t self_in) {
161+
return common_hal_audiodelays_multi_tap_delay_get_decay(self_in);
162+
}
163+
MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_multi_tap_delay_get_decay_obj, audiodelays_multi_tap_delay_obj_get_decay);
164+
165+
static mp_obj_t audiodelays_multi_tap_delay_obj_set_decay(mp_obj_t self_in, mp_obj_t decay_in) {
166+
audiodelays_multi_tap_delay_obj_t *self = MP_OBJ_TO_PTR(self_in);
167+
common_hal_audiodelays_multi_tap_delay_set_decay(self, decay_in);
168+
return mp_const_none;
169+
}
170+
MP_DEFINE_CONST_FUN_OBJ_2(audiodelays_multi_tap_delay_set_decay_obj, audiodelays_multi_tap_delay_obj_set_decay);
171+
172+
MP_PROPERTY_GETSET(audiodelays_multi_tap_delay_decay_obj,
173+
(mp_obj_t)&audiodelays_multi_tap_delay_get_decay_obj,
174+
(mp_obj_t)&audiodelays_multi_tap_delay_set_decay_obj);
175+
176+
//| mix: synthio.BlockInput
177+
//| """The rate the echo mix between 0 and 1 where 0 is only sample, 0.5 is an equal mix of the sample and the effect and 1 is all effect."""
178+
static mp_obj_t audiodelays_multi_tap_delay_obj_get_mix(mp_obj_t self_in) {
179+
return common_hal_audiodelays_multi_tap_delay_get_mix(self_in);
180+
}
181+
MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_multi_tap_delay_get_mix_obj, audiodelays_multi_tap_delay_obj_get_mix);
182+
183+
static mp_obj_t audiodelays_multi_tap_delay_obj_set_mix(mp_obj_t self_in, mp_obj_t mix_in) {
184+
audiodelays_multi_tap_delay_obj_t *self = MP_OBJ_TO_PTR(self_in);
185+
common_hal_audiodelays_multi_tap_delay_set_mix(self, mix_in);
186+
return mp_const_none;
187+
}
188+
MP_DEFINE_CONST_FUN_OBJ_2(audiodelays_multi_tap_delay_set_mix_obj, audiodelays_multi_tap_delay_obj_set_mix);
189+
190+
MP_PROPERTY_GETSET(audiodelays_multi_tap_delay_mix_obj,
191+
(mp_obj_t)&audiodelays_multi_tap_delay_get_mix_obj,
192+
(mp_obj_t)&audiodelays_multi_tap_delay_set_mix_obj);
193+
194+
195+
196+
//| playing: bool
197+
//| """True when the effect is playing a sample. (read-only)"""
198+
//|
199+
static mp_obj_t audiodelays_multi_tap_delay_obj_get_playing(mp_obj_t self_in) {
200+
audiodelays_multi_tap_delay_obj_t *self = MP_OBJ_TO_PTR(self_in);
201+
check_for_deinit(self);
202+
return mp_obj_new_bool(common_hal_audiodelays_multi_tap_delay_get_playing(self));
203+
}
204+
MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_multi_tap_delay_get_playing_obj, audiodelays_multi_tap_delay_obj_get_playing);
205+
206+
MP_PROPERTY_GETTER(audiodelays_multi_tap_delay_playing_obj,
207+
(mp_obj_t)&audiodelays_multi_tap_delay_get_playing_obj);
208+
209+
//| def play(self, sample: circuitpython_typing.AudioSample, *, loop: bool = False) -> None:
210+
//| """Plays the sample once when loop=False and continuously when loop=True.
211+
//| Does not block. Use `playing` to block.
212+
//|
213+
//| The sample must match the encoding settings given in the constructor."""
214+
//| ...
215+
//|
216+
static mp_obj_t audiodelays_multi_tap_delay_obj_play(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
217+
enum { ARG_sample, ARG_loop };
218+
static const mp_arg_t allowed_args[] = {
219+
{ MP_QSTR_sample, MP_ARG_OBJ | MP_ARG_REQUIRED, {} },
220+
{ MP_QSTR_loop, MP_ARG_BOOL | MP_ARG_KW_ONLY, {.u_bool = false} },
221+
};
222+
audiodelays_multi_tap_delay_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
223+
check_for_deinit(self);
224+
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
225+
mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
226+
227+
228+
mp_obj_t sample = args[ARG_sample].u_obj;
229+
common_hal_audiodelays_multi_tap_delay_play(self, sample, args[ARG_loop].u_bool);
230+
231+
return mp_const_none;
232+
}
233+
MP_DEFINE_CONST_FUN_OBJ_KW(audiodelays_multi_tap_delay_play_obj, 1, audiodelays_multi_tap_delay_obj_play);
234+
235+
//| def stop(self) -> None:
236+
//| """Stops playback of the sample. The echo continues playing."""
237+
//| ...
238+
//|
239+
//|
240+
static mp_obj_t audiodelays_multi_tap_delay_obj_stop(mp_obj_t self_in) {
241+
audiodelays_multi_tap_delay_obj_t *self = MP_OBJ_TO_PTR(self_in);
242+
243+
common_hal_audiodelays_multi_tap_delay_stop(self);
244+
return mp_const_none;
245+
}
246+
MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_multi_tap_delay_stop_obj, audiodelays_multi_tap_delay_obj_stop);
247+
248+
static const mp_rom_map_elem_t audiodelays_multi_tap_delay_locals_dict_table[] = {
249+
// Methods
250+
{ MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&audiodelays_multi_tap_delay_deinit_obj) },
251+
{ MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&default___enter___obj) },
252+
{ MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&default___exit___obj) },
253+
{ MP_ROM_QSTR(MP_QSTR_play), MP_ROM_PTR(&audiodelays_multi_tap_delay_play_obj) },
254+
{ MP_ROM_QSTR(MP_QSTR_stop), MP_ROM_PTR(&audiodelays_multi_tap_delay_stop_obj) },
255+
256+
// Properties
257+
{ MP_ROM_QSTR(MP_QSTR_playing), MP_ROM_PTR(&audiodelays_multi_tap_delay_playing_obj) },
258+
{ MP_ROM_QSTR(MP_QSTR_delay_ms), MP_ROM_PTR(&audiodelays_multi_tap_delay_delay_ms_obj) },
259+
{ MP_ROM_QSTR(MP_QSTR_decay), MP_ROM_PTR(&audiodelays_multi_tap_delay_decay_obj) },
260+
{ MP_ROM_QSTR(MP_QSTR_mix), MP_ROM_PTR(&audiodelays_multi_tap_delay_mix_obj) },
261+
AUDIOSAMPLE_FIELDS,
262+
};
263+
static MP_DEFINE_CONST_DICT(audiodelays_multi_tap_delay_locals_dict, audiodelays_multi_tap_delay_locals_dict_table);
264+
265+
static const audiosample_p_t audiodelays_multi_tap_delay_proto = {
266+
MP_PROTO_IMPLEMENT(MP_QSTR_protocol_audiosample)
267+
.reset_buffer = (audiosample_reset_buffer_fun)audiodelays_multi_tap_delay_reset_buffer,
268+
.get_buffer = (audiosample_get_buffer_fun)audiodelays_multi_tap_delay_get_buffer,
269+
};
270+
271+
MP_DEFINE_CONST_OBJ_TYPE(
272+
audiodelays_multi_tap_delay_type,
273+
MP_QSTR_MultiTapDelay,
274+
MP_TYPE_FLAG_HAS_SPECIAL_ACCESSORS,
275+
make_new, audiodelays_multi_tap_delay_make_new,
276+
locals_dict, &audiodelays_multi_tap_delay_locals_dict,
277+
protocol, &audiodelays_multi_tap_delay_proto
278+
);

‎shared-bindings/audiodelays/MultiTapDelay.h

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// This file is part of the CircuitPython project: https://circuitpython.org
2+
//
3+
// SPDX-FileCopyrightText: Copyright (c) 2025 Cooper Dalrymple
4+
//
5+
// SPDX-License-Identifier: MIT
6+
7+
#pragma once
8+
9+
#include "shared-module/audiodelays/MultiTapDelay.h"
10+
11+
extern const mp_obj_type_t audiodelays_multi_tap_delay_type;
12+
13+
void common_hal_audiodelays_multi_tap_delay_construct(audiodelays_multi_tap_delay_obj_t *self, uint32_t max_delay_ms,
14+
mp_obj_t delay_ms, mp_obj_t decay, mp_obj_t mix,
15+
uint32_t buffer_size, uint8_t bits_per_sample, bool samples_signed,
16+
uint8_t channel_count, uint32_t sample_rate);
17+
18+
void common_hal_audiodelays_multi_tap_delay_deinit(audiodelays_multi_tap_delay_obj_t *self);
19+
20+
mp_float_t common_hal_audiodelays_multi_tap_delay_get_delay_ms(audiodelays_multi_tap_delay_obj_t *self);
21+
void common_hal_audiodelays_multi_tap_delay_set_delay_ms(audiodelays_multi_tap_delay_obj_t *self, mp_obj_t delay_ms);
22+
23+
mp_obj_t common_hal_audiodelays_multi_tap_delay_get_decay(audiodelays_multi_tap_delay_obj_t *self);
24+
void common_hal_audiodelays_multi_tap_delay_set_decay(audiodelays_multi_tap_delay_obj_t *self, mp_obj_t decay);
25+
26+
mp_obj_t common_hal_audiodelays_multi_tap_delay_get_mix(audiodelays_multi_tap_delay_obj_t *self);
27+
void common_hal_audiodelays_multi_tap_delay_set_mix(audiodelays_multi_tap_delay_obj_t *self, mp_obj_t arg);
28+
29+
bool common_hal_audiodelays_multi_tap_delay_get_playing(audiodelays_multi_tap_delay_obj_t *self);
30+
void common_hal_audiodelays_multi_tap_delay_play(audiodelays_multi_tap_delay_obj_t *self, mp_obj_t sample, bool loop);
31+
void common_hal_audiodelays_multi_tap_delay_stop(audiodelays_multi_tap_delay_obj_t *self);

‎shared-bindings/audiodelays/__init__.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
#include "shared-bindings/audiodelays/Echo.h"
1414
#include "shared-bindings/audiodelays/Chorus.h"
1515
#include "shared-bindings/audiodelays/PitchShift.h"
16+
#include "shared-bindings/audiodelays/MultiTapDelay.h"
1617

1718
//| """Support for audio delay effects
1819
//|
@@ -25,6 +26,7 @@ static const mp_rom_map_elem_t audiodelays_module_globals_table[] = {
2526
{ MP_ROM_QSTR(MP_QSTR_Echo), MP_ROM_PTR(&audiodelays_echo_type) },
2627
{ MP_ROM_QSTR(MP_QSTR_Chorus), MP_ROM_PTR(&audiodelays_chorus_type) },
2728
{ MP_ROM_QSTR(MP_QSTR_PitchShift), MP_ROM_PTR(&audiodelays_pitch_shift_type) },
29+
{ MP_ROM_QSTR(MP_QSTR_MultiTapDelay), MP_ROM_PTR(&audiodelays_multi_tap_delay_type) },
2830
};
2931

3032
static MP_DEFINE_CONST_DICT(audiodelays_module_globals, audiodelays_module_globals_table);

0 commit comments

Comments
 (0)