Initial audio effects commit

Author: gamblor21

locale/circuitpython.pot

@@ -2500,7 +2500,7 @@ msgstr ""
 msgid "bits must be 32 or less"
 msgstr ""
 
-#: shared-bindings/audiomixer/Mixer.c
+#: shared-bindings/audioeffects/Echo.c shared-bindings/audiomixer/Mixer.c
 msgid "bits_per_sample must be 8 or 16"
 msgstr ""
 
@@ -2847,6 +2847,10 @@ msgstr ""
 msgid "data type not understood"
 msgstr ""
 
+#: shared-bindings/audioeffects/Echo.c
+msgid "decay must be between 0 and 1"
+msgstr ""
+
 #: py/parsenum.c
 msgid "decimal numbers not supported"
 msgstr ""
@@ -3242,7 +3246,7 @@ msgstr ""
 msgid "input must be a dense ndarray"
 msgstr ""
 
-#: extmod/ulab/code/user/user.c
+#: extmod/ulab/code/user/user.c shared-bindings/_eve/__init__.c
 msgid "input must be an ndarray"
 msgstr ""
 

ports/raspberrypi/mpconfigport.mk

@@ -22,7 +22,7 @@ CIRCUITPY_PWMIO ?= 1
 CIRCUITPY_RGBMATRIX ?= $(CIRCUITPY_DISPLAYIO)
 CIRCUITPY_ROTARYIO ?= 1
 CIRCUITPY_ROTARYIO_SOFTENCODER = 1
-CIRCUITPY_SYNTHIO_MAX_CHANNELS = 12
+CIRCUITPY_SYNTHIO_MAX_CHANNELS = 24
 CIRCUITPY_USB_HOST ?= 1
 CIRCUITPY_USB_VIDEO ?= 1
 

py/circuitpy_defns.mk

@@ -131,6 +131,9 @@ endif
 ifeq ($(CIRCUITPY_AUDIOCORE),1)
 SRC_PATTERNS += audiocore/%
 endif
+ifeq ($(CIRCUITPY_AUDIOEFFECTS),1)
+SRC_PATTERNS += audioeffects/%
+endif
 ifeq ($(CIRCUITPY_AUDIOMIXER),1)
 SRC_PATTERNS += audiomixer/%
 endif
@@ -617,6 +620,8 @@ SRC_SHARED_MODULE_ALL = \
 	audiocore/RawSample.c \
 	audiocore/WaveFile.c \
 	audiocore/__init__.c \
+	audioeffects/Echo.c \
+	audioeffects/__init__.c \
 	audioio/__init__.c \
 	audiomixer/Mixer.c \
 	audiomixer/MixerVoice.c \
@@ -857,6 +862,7 @@ $(filter $(SRC_PATTERNS), \
 	displayio/display_core.c \
 	os/getenv.c \
 	usb/utf16le.c \
+	audioeffects/effects_utils.c \
 )
 
 SRC_COMMON_HAL_INTERNAL = \

py/circuitpy_mpconfig.mk

@@ -141,6 +141,9 @@ CFLAGS += -DCIRCUITPY_AUDIOCORE_DEBUG=$(CIRCUITPY_AUDIOCORE_DEBUG)
 CIRCUITPY_AUDIOMP3 ?= $(call enable-if-all,$(CIRCUITPY_FULL_BUILD) $(CIRCUITPY_AUDIOCORE))
 CFLAGS += -DCIRCUITPY_AUDIOMP3=$(CIRCUITPY_AUDIOMP3)
 
+CIRCUITPY_AUDIOEFFECTS ?= 0
+CFLAGS += -DCIRCUITPY_AUDIOEFFECTS=$(CIRCUITPY_AUDIOEFFECTS)
+
 CIRCUITPY_AURORA_EPAPER ?= 0
 CFLAGS += -DCIRCUITPY_AURORA_EPAPER=$(CIRCUITPY_AURORA_EPAPER)
 

shared-bindings/audioeffects/Echo.c

@@ -0,0 +1,245 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2024 Mark Komus
+//
+// SPDX-License-Identifier: MIT
+
+#include <stdint.h>
+
+#include "shared-bindings/audioeffects/Echo.h"
+#include "shared-module/audioeffects/Echo.h"
+
+#include "shared/runtime/context_manager_helpers.h"
+#include "py/binary.h"
+#include "py/objproperty.h"
+#include "py/runtime.h"
+#include "shared-bindings/util.h"
+
+#define DECAY_DEFAULT 0.7f
+
+//| class Echo:
+//|     """An Echo effect"""
+//|
+static mp_obj_t audioeffects_echo_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
+    enum { ARG_delay_ms, ARG_decay, ARG_buffer_size, ARG_sample_rate, ARG_bits_per_sample, ARG_samples_signed, ARG_channel_count, };
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_delay_ms, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 50 } },
+        { MP_QSTR_decay, MP_ARG_OBJ | MP_ARG_KW_ONLY,  {.u_obj = MP_OBJ_NULL} },
+        { MP_QSTR_buffer_size, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 1024} },
+        { MP_QSTR_sample_rate, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 8000} },
+        { MP_QSTR_bits_per_sample, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 16} },
+        { MP_QSTR_samples_signed, MP_ARG_BOOL | MP_ARG_KW_ONLY, {.u_bool = true} },
+        { MP_QSTR_channel_count, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 1 } },
+    };
+
+    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);
+
+    mp_int_t delay_ms = mp_arg_validate_int_range(args[ARG_delay_ms].u_int, 1, 4000, MP_QSTR_delay_ms);
+
+    mp_float_t decay = (args[ARG_decay].u_obj == MP_OBJ_NULL)
+        ? (mp_float_t)DECAY_DEFAULT
+        : mp_obj_get_float(args[ARG_decay].u_obj);
+    mp_arg_validate_float_range(decay, 0.0f, 1.0f, MP_QSTR_decay);
+
+    mp_int_t channel_count = mp_arg_validate_int_range(args[ARG_channel_count].u_int, 1, 2, MP_QSTR_channel_count);
+    mp_int_t sample_rate = mp_arg_validate_int_min(args[ARG_sample_rate].u_int, 1, MP_QSTR_sample_rate);
+    mp_int_t bits_per_sample = args[ARG_bits_per_sample].u_int;
+    if (bits_per_sample != 8 && bits_per_sample != 16) {
+        mp_raise_ValueError(MP_ERROR_TEXT("bits_per_sample must be 8 or 16"));
+    }
+
+    audioeffects_echo_obj_t *self = mp_obj_malloc(audioeffects_echo_obj_t, &audioeffects_echo_type);
+    common_hal_audioeffects_echo_construct(self, delay_ms, decay, args[ARG_buffer_size].u_int, bits_per_sample, args[ARG_samples_signed].u_bool, channel_count, sample_rate);
+
+    return MP_OBJ_FROM_PTR(self);
+}
+
+//|     def deinit(self) -> None:
+//|         """Deinitialises the Echo and releases any hardware resources for reuse."""
+//|         ...
+static mp_obj_t audioeffects_echo_deinit(mp_obj_t self_in) {
+    audioeffects_echo_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    common_hal_audioeffects_echo_deinit(self);
+    return mp_const_none;
+}
+static MP_DEFINE_CONST_FUN_OBJ_1(audioeffects_echo_deinit_obj, audioeffects_echo_deinit);
+
+static void check_for_deinit(audioeffects_echo_obj_t *self) {
+    if (common_hal_audioeffects_echo_deinited(self)) {
+        raise_deinited_error();
+    }
+}
+
+//|     def __enter__(self) -> Echo:
+//|         """No-op used by Context Managers."""
+//|         ...
+//  Provided by context manager helper.
+
+//|     def __exit__(self) -> None:
+//|         """Automatically deinitializes the hardware when exiting a context. See
+//|         :ref:`lifetime-and-contextmanagers` for more info."""
+//|         ...
+static mp_obj_t audioeffects_echo_obj___exit__(size_t n_args, const mp_obj_t *args) {
+    (void)n_args;
+    common_hal_audioeffects_echo_deinit(args[0]);
+    return mp_const_none;
+}
+static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audioeffects_echo___exit___obj, 4, 4, audioeffects_echo_obj___exit__);
+
+
+//|     delay_ms: int
+//|     """Delay of the echo in microseconds. (read-only)"""
+//|
+static mp_obj_t audioeffects_echo_obj_get_delay_ms(mp_obj_t self_in) {
+    audioeffects_echo_obj_t *self = MP_OBJ_TO_PTR(self_in);
+
+    return mp_obj_new_float(common_hal_audioeffects_echo_get_delay_ms(self));
+
+}
+MP_DEFINE_CONST_FUN_OBJ_1(audioeffects_echo_get_delay_ms_obj, audioeffects_echo_obj_get_delay_ms);
+
+static mp_obj_t audioeffects_echo_obj_set_delay_ms(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+    enum { ARG_delay_ms };
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_delay_ms, MP_ARG_INT | MP_ARG_REQUIRED, {} },
+    };
+    audioeffects_echo_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
+    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+    mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+    mp_int_t delay_ms = mp_arg_validate_int_range(args[ARG_delay_ms].u_int, 1, 4000, MP_QSTR_delay_ms);
+
+    common_hal_audioeffects_echo_set_delay_ms(self, delay_ms);
+
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_KW(audioeffects_echo_set_delay_ms_obj, 1, audioeffects_echo_obj_set_delay_ms);
+
+MP_PROPERTY_GETSET(audioeffects_echo_delay_ms_obj,
+    (mp_obj_t)&audioeffects_echo_get_delay_ms_obj,
+    (mp_obj_t)&audioeffects_echo_set_delay_ms_obj);
+
+
+
+//|     decay: float
+//|     """The rate the echo decays between 0 and 1."""
+static mp_obj_t audioeffects_echo_obj_get_decay(mp_obj_t self_in) {
+    return mp_obj_new_float(common_hal_audioeffects_echo_get_decay(self_in));
+}
+MP_DEFINE_CONST_FUN_OBJ_1(audioeffects_echo_get_decay_obj, audioeffects_echo_obj_get_decay);
+
+static mp_obj_t audioeffects_echo_obj_set_decay(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+    enum { ARG_decay };
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_decay,     MP_ARG_OBJ | MP_ARG_REQUIRED, {} },
+    };
+    audioeffects_echo_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
+    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+    mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+    mp_float_t decay = mp_obj_get_float(args[ARG_decay].u_obj);
+
+    if (decay > 1 || decay < 0) {
+        mp_raise_ValueError(MP_ERROR_TEXT("decay must be between 0 and 1"));
+    }
+
+    common_hal_audioeffects_echo_set_decay(self, decay);
+
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_KW(audioeffects_echo_set_decay_obj, 1, audioeffects_echo_obj_set_decay);
+
+MP_PROPERTY_GETSET(audioeffects_echo_decay_obj,
+    (mp_obj_t)&audioeffects_echo_get_decay_obj,
+    (mp_obj_t)&audioeffects_echo_set_decay_obj);
+
+
+//|     playing: bool
+//|     """True when any voice is being output. (read-only)"""
+static mp_obj_t audioeffects_echo_obj_get_playing(mp_obj_t self_in) {
+    audioeffects_echo_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    check_for_deinit(self);
+    return mp_obj_new_bool(common_hal_audioeffects_echo_get_playing(self));
+}
+MP_DEFINE_CONST_FUN_OBJ_1(audioeffects_echo_get_playing_obj, audioeffects_echo_obj_get_playing);
+
+MP_PROPERTY_GETTER(audioeffects_echo_playing_obj,
+    (mp_obj_t)&audioeffects_echo_get_playing_obj);
+
+//|     def play(
+//|         self, sample: circuitpython_typing.AudioSample, *, voice: int = 0, loop: bool = False
+//|     ) -> None:
+//|         """Plays the sample once when loop=False and continuously when loop=True.
+//|         Does not block. Use `playing` to block.
+//|
+//|         Sample must be an `audiocore.WaveFile`, `audiocore.RawSample`, `audiomixer.Mixer` or `audiomp3.MP3Decoder`.
+//|
+//|         The sample must match the Effect's encoding settings given in the constructor."""
+//|         ...
+static mp_obj_t audioeffects_echo_obj_play(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+    enum { ARG_sample, ARG_loop };
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_sample,    MP_ARG_OBJ | MP_ARG_REQUIRED, {} },
+        { MP_QSTR_loop,      MP_ARG_BOOL | MP_ARG_KW_ONLY, {.u_bool = false} },
+    };
+    audioeffects_echo_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
+    check_for_deinit(self);
+    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+    mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+
+    mp_obj_t sample = args[ARG_sample].u_obj;
+    common_hal_audioeffects_echo_play(self, sample, args[ARG_loop].u_bool);
+
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_KW(audioeffects_echo_play_obj, 1, audioeffects_echo_obj_play);
+
+//|     def stop_voice(self, voice: int = 0) -> None:
+//|         """Stops playback of the sample."""
+//|         ...
+//|
+static mp_obj_t audioeffects_echo_obj_stop(mp_obj_t self_in) {
+    audioeffects_echo_obj_t *self = MP_OBJ_TO_PTR(self_in);
+
+    common_hal_audioeffects_echo_stop(self);
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_1(audioeffects_echo_stop_obj, audioeffects_echo_obj_stop);
+
+
+
+static const mp_rom_map_elem_t audioeffects_echo_locals_dict_table[] = {
+    // Methods
+    { MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&audioeffects_echo_deinit_obj) },
+    { MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&default___enter___obj) },
+    { MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&audioeffects_echo___exit___obj) },
+    { MP_ROM_QSTR(MP_QSTR_play), MP_ROM_PTR(&audioeffects_echo_play_obj) },
+    { MP_ROM_QSTR(MP_QSTR_stop), MP_ROM_PTR(&audioeffects_echo_stop_obj) },
+
+    // Properties
+    { MP_ROM_QSTR(MP_QSTR_playing), MP_ROM_PTR(&audioeffects_echo_playing_obj) },
+    { MP_ROM_QSTR(MP_QSTR_delay_ms), MP_ROM_PTR(&audioeffects_echo_delay_ms_obj) },
+    { MP_ROM_QSTR(MP_QSTR_decay), MP_ROM_PTR(&audioeffects_echo_decay_obj) },
+};
+static MP_DEFINE_CONST_DICT(audioeffects_echo_locals_dict, audioeffects_echo_locals_dict_table);
+
+static const audiosample_p_t audioeffects_echo_proto = {
+    MP_PROTO_IMPLEMENT(MP_QSTR_protocol_audiosample)
+    .sample_rate = (audiosample_sample_rate_fun)common_hal_audioeffects_echo_get_sample_rate,
+    .bits_per_sample = (audiosample_bits_per_sample_fun)common_hal_audioeffects_echo_get_bits_per_sample,
+    .channel_count = (audiosample_channel_count_fun)common_hal_audioeffects_echo_get_channel_count,
+    .reset_buffer = (audiosample_reset_buffer_fun)audioeffects_echo_reset_buffer,
+    .get_buffer = (audiosample_get_buffer_fun)audioeffects_echo_get_buffer,
+    .get_buffer_structure = (audiosample_get_buffer_structure_fun)audioeffects_echo_get_buffer_structure,
+};
+
+MP_DEFINE_CONST_OBJ_TYPE(
+    audioeffects_echo_type,
+    MP_QSTR_Echo,
+    MP_TYPE_FLAG_HAS_SPECIAL_ACCESSORS,
+    make_new, audioeffects_echo_make_new,
+    locals_dict, &audioeffects_echo_locals_dict,
+    protocol, &audioeffects_echo_proto
+    );

shared-bindings/audioeffects/Echo.h

@@ -0,0 +1,33 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2024 Mark Komus
+//
+// SPDX-License-Identifier: MIT
+
+#pragma once
+
+#include "shared-module/audioeffects/Echo.h"
+
+extern const mp_obj_type_t audioeffects_echo_type;
+
+void common_hal_audioeffects_echo_construct(audioeffects_echo_obj_t *self,
+    uint32_t delay_ms, mp_float_t decay,
+    uint32_t buffer_size, uint8_t bits_per_sample, bool samples_signed,
+    uint8_t channel_count, uint32_t sample_rate);
+
+void common_hal_audioeffects_echo_deinit(audioeffects_echo_obj_t *self);
+bool common_hal_audioeffects_echo_deinited(audioeffects_echo_obj_t *self);
+
+uint32_t common_hal_audioeffects_echo_get_sample_rate(audioeffects_echo_obj_t *self);
+uint8_t common_hal_audioeffects_echo_get_channel_count(audioeffects_echo_obj_t *self);
+uint8_t common_hal_audioeffects_echo_get_bits_per_sample(audioeffects_echo_obj_t *self);
+
+uint32_t common_hal_audioeffects_echo_get_delay_ms(audioeffects_echo_obj_t *self);
+void common_hal_audioeffects_echo_set_delay_ms(audioeffects_echo_obj_t *self, uint32_t delay_ms);
+
+mp_float_t common_hal_audioeffects_echo_get_decay(audioeffects_echo_obj_t *self);
+void common_hal_audioeffects_echo_set_decay(audioeffects_echo_obj_t *self, mp_float_t decay);
+
+bool common_hal_audioeffects_echo_get_playing(audioeffects_echo_obj_t *self);
+void common_hal_audioeffects_echo_play(audioeffects_echo_obj_t *self, mp_obj_t sample, bool loop);
+void common_hal_audioeffects_echo_stop(audioeffects_echo_obj_t *self);

shared-bindings/audioeffects/__init__.c

@@ -0,0 +1,33 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2024 Mark Komus
+//
+// SPDX-License-Identifier: MIT
+
+#include <stdint.h>
+
+#include "py/obj.h"
+#include "py/runtime.h"
+
+#include "shared-bindings/audioeffects/__init__.h"
+#include "shared-bindings/audioeffects/Echo.h"
+
+//| """Support for audio effects
+//|
+//| The `audioeffects` module contains classes to provide access to audio effects.
+//|
+//| """
+
+static const mp_rom_map_elem_t audioeffects_module_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_audioeffects) },
+    { MP_ROM_QSTR(MP_QSTR_Echo), MP_ROM_PTR(&audioeffects_echo_type) },
+};
+
+static MP_DEFINE_CONST_DICT(audioeffects_module_globals, audioeffects_module_globals_table);
+
+const mp_obj_module_t audioeffects_module = {
+    .base = { &mp_type_module },
+    .globals = (mp_obj_dict_t *)&audioeffects_module_globals,
+};
+
+MP_REGISTER_MODULE(MP_QSTR_audioeffects, audioeffects_module);

shared-bindings/audioeffects/__init__.h

@@ -0,0 +1,7 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2024 Mark Komus
+//
+// SPDX-License-Identifier: MIT
+
+#pragma once