Moving to audiofreeverb and renaming to Freeverb

Author: gamblor21

py/circuitpy_defns.mk

@@ -137,6 +137,9 @@ endif
 ifeq ($(CIRCUITPY_AUDIOFILTERS),1)
 SRC_PATTERNS += audiofilters/%
 endif
+ifeq ($(CIRCUITPY_AUDIOFREEVERB),1)
+SRC_PATTERNS += audiofreeverb/%
+endif
 ifeq ($(CIRCUITPY_AUDIOMIXER),1)
 SRC_PATTERNS += audiomixer/%
 endif
@@ -633,11 +636,12 @@ SRC_SHARED_MODULE_ALL = \
 	audiocore/__init__.c \
 	audiodelays/Echo.c \
 	audiodelays/PitchShift.c \
-	audiodelays/Reverb.c \
 	audiodelays/__init__.c \
 	audiofilters/Distortion.c \
 	audiofilters/Filter.c \
 	audiofilters/__init__.c \
+	audiofreeverb/__init__.c \
+	audiofreeverb/Freeverb.c \
 	audioio/__init__.c \
 	audiomixer/Mixer.c \
 	audiomixer/MixerVoice.c \

py/circuitpy_mpconfig.mk

@@ -146,6 +146,8 @@ CIRCUITPY_AUDIODELAYS ?= $(CIRCUITPY_AUDIOEFFECTS)
 CFLAGS += -DCIRCUITPY_AUDIODELAYS=$(CIRCUITPY_AUDIODELAYS)
 CIRCUITPY_AUDIOFILTERS ?= $(CIRCUITPY_AUDIOEFFECTS)
 CFLAGS += -DCIRCUITPY_AUDIOFILTERS=$(CIRCUITPY_AUDIOFILTERS)
+CIRCUITPY_AUDIOFREEVERB ?= $(CIRCUITPY_AUDIOEFFECTS)
+CFLAGS += -DCIRCUITPY_AUDIOFREEVERB=$(CIRCUITPY_AUDIOFREEVERB)
 
 CIRCUITPY_AURORA_EPAPER ?= 0
 CFLAGS += -DCIRCUITPY_AURORA_EPAPER=$(CIRCUITPY_AURORA_EPAPER)

shared-bindings/audiodelays/Reverb.h

@@ -12,7 +12,6 @@
 #include "shared-bindings/audiodelays/__init__.h"
 #include "shared-bindings/audiodelays/Echo.h"
 #include "shared-bindings/audiodelays/PitchShift.h"
-#include "shared-bindings/audiodelays/Reverb.h"
 
 
 //| """Support for audio delay effects
@@ -25,7 +24,6 @@ static const mp_rom_map_elem_t audiodelays_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_audiodelays) },
     { MP_ROM_QSTR(MP_QSTR_Echo), MP_ROM_PTR(&audiodelays_echo_type) },
     { MP_ROM_QSTR(MP_QSTR_PitchShift), MP_ROM_PTR(&audiodelays_pitch_shift_type) },
-    { MP_ROM_QSTR(MP_QSTR_Reverb), MP_ROM_PTR(&audiodelays_reverb_type) },
 };
 
 static MP_DEFINE_CONST_DICT(audiodelays_module_globals, audiodelays_module_globals_table);

shared-bindings/audiodelays/__init__.c

@@ -6,9 +6,9 @@
 
 #include <stdint.h>
 
-#include "shared-bindings/audiodelays/Reverb.h"
+#include "shared-bindings/audiofreeverb/Freeverb.h"
 #include "shared-bindings/audiocore/__init__.h"
-#include "shared-module/audiodelays/Reverb.h"
+#include "shared-module/audiofreeverb/Freeverb.h"
 
 #include "shared/runtime/context_manager_helpers.h"
 #include "py/binary.h"
@@ -17,8 +17,8 @@
 #include "shared-bindings/util.h"
 #include "shared-module/synthio/block.h"
 
-//| class Reverb:
-//|     """An Reverb effect"""
+//| class Freeverb:
+//|     """An Freeverb effect"""
 //|
 //|     def __init__(
 //|         self,
@@ -44,20 +44,20 @@
 //|         :param int buffer_size: The total size in bytes of each of the two playback buffers to use
 //|         :param int sample_rate: The sample rate to be used
 //|         :param int channel_count: The number of channels the source samples contain. 1 = mono; 2 = stereo.
-//|         :param int bits_per_sample: The bits per sample of the effect. Reverb requires 16 bits.
-//|         :param bool samples_signed: Effect is signed (True) or unsigned (False). Reverb requires signed (True).
+//|         :param int bits_per_sample: The bits per sample of the effect. Freeverb requires 16 bits.
+//|         :param bool samples_signed: Effect is signed (True) or unsigned (False). Freeverb requires signed (True).
 //|
-//|         Playing adding an reverb to a synth::
+//|         Playing adding reverb to a synth::
 //|
 //|           import time
 //|           import board
 //|           import audiobusio
 //|           import synthio
-//|           import audiodelays
+//|           import audiofreeverb
 //|
 //|           audio = audiobusio.I2SOut(bit_clock=board.GP20, word_select=board.GP21, data=board.GP22)
 //|           synth = synthio.Synthesizer(channel_count=1, sample_rate=44100)
-//|           reverb = audiodelays.Reverb(roomsize=0.7, damp=0.3, buffer_size=1024, channel_count=1, sample_rate=44100, mix=0.7)
+//|           reverb = audiofreeverb.Freeverb(roomsize=0.7, damp=0.3, buffer_size=1024, channel_count=1, sample_rate=44100, mix=0.7)
 //|           reverb.play(synth)
 //|           audio.play(reverb)
 //|
@@ -69,7 +69,7 @@
 //|               time.sleep(5)"""
 //|         ...
 //|
-static mp_obj_t audiodelays_reverb_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
+static mp_obj_t audiofreeverb_freeverb_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
     enum { ARG_roomsize, ARG_damp, ARG_mix, 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_roomsize, MP_ARG_OBJ | MP_ARG_KW_ONLY,  {.u_obj = MP_OBJ_NULL} },
@@ -95,28 +95,28 @@ static mp_obj_t audiodelays_reverb_make_new(const mp_obj_type_t *type, size_t n_
         mp_raise_ValueError(MP_ERROR_TEXT("bits_per_sample must be 16"));
     }
 
-    audiodelays_reverb_obj_t *self = mp_obj_malloc(audiodelays_reverb_obj_t, &audiodelays_reverb_type);
-    common_hal_audiodelays_reverb_construct(self, args[ARG_roomsize].u_obj, args[ARG_damp].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);
+    audiofreeverb_freeverb_obj_t *self = mp_obj_malloc(audiofreeverb_freeverb_obj_t, &audiofreeverb_freeverb_type);
+    common_hal_audiofreeverb_freeverb_construct(self, args[ARG_roomsize].u_obj, args[ARG_damp].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);
 
     return MP_OBJ_FROM_PTR(self);
 }
 
 //|     def deinit(self) -> None:
-//|         """Deinitialises the Reverb."""
+//|         """Deinitialises the Freeverb."""
 //|         ...
 //|
-static mp_obj_t audiodelays_reverb_deinit(mp_obj_t self_in) {
-    audiodelays_reverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
-    common_hal_audiodelays_reverb_deinit(self);
+static mp_obj_t audiofreeverb_freeverb_deinit(mp_obj_t self_in) {
+    audiofreeverb_freeverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    common_hal_audiofreeverb_freeverb_deinit(self);
     return mp_const_none;
 }
-static MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_reverb_deinit_obj, audiodelays_reverb_deinit);
+static MP_DEFINE_CONST_FUN_OBJ_1(audiofreeverb_freeverb_deinit_obj, audiofreeverb_freeverb_deinit);
 
-static void check_for_deinit(audiodelays_reverb_obj_t *self) {
+static void check_for_deinit(audiofreeverb_freeverb_obj_t *self) {
     audiosample_check_for_deinit(&self->base);
 }
 
-//|     def __enter__(self) -> Reverb:
+//|     def __enter__(self) -> Freeverb:
 //|         """No-op used by Context Managers."""
 //|         ...
 //|
@@ -131,70 +131,70 @@ static void check_for_deinit(audiodelays_reverb_obj_t *self) {
 
 //|     roomsize: synthio.BlockInput
 //|     """Apparent size of the room 0.0-1.0"""
-static mp_obj_t audiodelays_reverb_obj_get_roomsize(mp_obj_t self_in) {
-    return common_hal_audiodelays_reverb_get_roomsize(self_in);
+static mp_obj_t audiofreeverb_freeverb_obj_get_roomsize(mp_obj_t self_in) {
+    return common_hal_audiofreeverb_freeverb_get_roomsize(self_in);
 }
-MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_reverb_get_roomsize_obj, audiodelays_reverb_obj_get_roomsize);
+MP_DEFINE_CONST_FUN_OBJ_1(audiofreeverb_freeverb_get_roomsize_obj, audiofreeverb_freeverb_obj_get_roomsize);
 
-static mp_obj_t audiodelays_reverb_obj_set_roomsize(mp_obj_t self_in, mp_obj_t roomsize) {
-    audiodelays_reverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
-    common_hal_audiodelays_reverb_set_roomsize(self, roomsize);
+static mp_obj_t audiofreeverb_freeverb_obj_set_roomsize(mp_obj_t self_in, mp_obj_t roomsize) {
+    audiofreeverb_freeverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    common_hal_audiofreeverb_freeverb_set_roomsize(self, roomsize);
     return mp_const_none;
 }
-MP_DEFINE_CONST_FUN_OBJ_2(audiodelays_reverb_set_roomsize_obj, audiodelays_reverb_obj_set_roomsize);
+MP_DEFINE_CONST_FUN_OBJ_2(audiofreeverb_freeverb_set_roomsize_obj, audiofreeverb_freeverb_obj_set_roomsize);
 
-MP_PROPERTY_GETSET(audiodelays_reverb_roomsize_obj,
-    (mp_obj_t)&audiodelays_reverb_get_roomsize_obj,
-    (mp_obj_t)&audiodelays_reverb_set_roomsize_obj);
+MP_PROPERTY_GETSET(audiofreeverb_freeverb_roomsize_obj,
+    (mp_obj_t)&audiofreeverb_freeverb_get_roomsize_obj,
+    (mp_obj_t)&audiofreeverb_freeverb_set_roomsize_obj);
 
 //|     damp: synthio.BlockInput
 //|     """How much the high frequencies are dampened in the area. 0.0-1.0"""
-static mp_obj_t audiodelays_reverb_obj_get_damp(mp_obj_t self_in) {
-    return common_hal_audiodelays_reverb_get_damp(self_in);
+static mp_obj_t audiofreeverb_freeverb_obj_get_damp(mp_obj_t self_in) {
+    return common_hal_audiofreeverb_freeverb_get_damp(self_in);
 }
-MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_reverb_get_damp_obj, audiodelays_reverb_obj_get_damp);
+MP_DEFINE_CONST_FUN_OBJ_1(audiofreeverb_freeverb_get_damp_obj, audiofreeverb_freeverb_obj_get_damp);
 
-static mp_obj_t audiodelays_reverb_obj_set_damp(mp_obj_t self_in, mp_obj_t damp) {
-    audiodelays_reverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
-    common_hal_audiodelays_reverb_set_damp(self, damp);
+static mp_obj_t audiofreeverb_freeverb_obj_set_damp(mp_obj_t self_in, mp_obj_t damp) {
+    audiofreeverb_freeverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    common_hal_audiofreeverb_freeverb_set_damp(self, damp);
     return mp_const_none;
 }
-MP_DEFINE_CONST_FUN_OBJ_2(audiodelays_reverb_set_damp_obj, audiodelays_reverb_obj_set_damp);
+MP_DEFINE_CONST_FUN_OBJ_2(audiofreeverb_freeverb_set_damp_obj, audiofreeverb_freeverb_obj_set_damp);
 
-MP_PROPERTY_GETSET(audiodelays_reverb_damp_obj,
-    (mp_obj_t)&audiodelays_reverb_get_damp_obj,
-    (mp_obj_t)&audiodelays_reverb_set_damp_obj);
+MP_PROPERTY_GETSET(audiofreeverb_freeverb_damp_obj,
+    (mp_obj_t)&audiofreeverb_freeverb_get_damp_obj,
+    (mp_obj_t)&audiofreeverb_freeverb_set_damp_obj);
 
 //|     mix: synthio.BlockInput
 //|     """The rate the reverb mix between 0 and 1 where 0 is only sample and 1 is all effect."""
-static mp_obj_t audiodelays_reverb_obj_get_mix(mp_obj_t self_in) {
-    return common_hal_audiodelays_reverb_get_mix(self_in);
+static mp_obj_t audiofreeverb_freeverb_obj_get_mix(mp_obj_t self_in) {
+    return common_hal_audiofreeverb_freeverb_get_mix(self_in);
 }
-MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_reverb_get_mix_obj, audiodelays_reverb_obj_get_mix);
+MP_DEFINE_CONST_FUN_OBJ_1(audiofreeverb_freeverb_get_mix_obj, audiofreeverb_freeverb_obj_get_mix);
 
-static mp_obj_t audiodelays_reverb_obj_set_mix(mp_obj_t self_in, mp_obj_t mix_in) {
-    audiodelays_reverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
-    common_hal_audiodelays_reverb_set_mix(self, mix_in);
+static mp_obj_t audiofreeverb_freeverb_obj_set_mix(mp_obj_t self_in, mp_obj_t mix_in) {
+    audiofreeverb_freeverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    common_hal_audiofreeverb_freeverb_set_mix(self, mix_in);
     return mp_const_none;
 }
-MP_DEFINE_CONST_FUN_OBJ_2(audiodelays_reverb_set_mix_obj, audiodelays_reverb_obj_set_mix);
+MP_DEFINE_CONST_FUN_OBJ_2(audiofreeverb_freeverb_set_mix_obj, audiofreeverb_freeverb_obj_set_mix);
 
-MP_PROPERTY_GETSET(audiodelays_reverb_mix_obj,
-    (mp_obj_t)&audiodelays_reverb_get_mix_obj,
-    (mp_obj_t)&audiodelays_reverb_set_mix_obj);
+MP_PROPERTY_GETSET(audiofreeverb_freeverb_mix_obj,
+    (mp_obj_t)&audiofreeverb_freeverb_get_mix_obj,
+    (mp_obj_t)&audiofreeverb_freeverb_set_mix_obj);
 
 //|     playing: bool
 //|     """True when the effect is playing a sample. (read-only)"""
 //|
-static mp_obj_t audiodelays_reverb_obj_get_playing(mp_obj_t self_in) {
-    audiodelays_reverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
+static mp_obj_t audiofreeverb_freeverb_obj_get_playing(mp_obj_t self_in) {
+    audiofreeverb_freeverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
-    return mp_obj_new_bool(common_hal_audiodelays_reverb_get_playing(self));
+    return mp_obj_new_bool(common_hal_audiofreeverb_freeverb_get_playing(self));
 }
-MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_reverb_get_playing_obj, audiodelays_reverb_obj_get_playing);
+MP_DEFINE_CONST_FUN_OBJ_1(audiofreeverb_freeverb_get_playing_obj, audiofreeverb_freeverb_obj_get_playing);
 
-MP_PROPERTY_GETTER(audiodelays_reverb_playing_obj,
-    (mp_obj_t)&audiodelays_reverb_get_playing_obj);
+MP_PROPERTY_GETTER(audiofreeverb_freeverb_playing_obj,
+    (mp_obj_t)&audiofreeverb_freeverb_get_playing_obj);
 
 //|     def play(self, sample: circuitpython_typing.AudioSample, *, loop: bool = False) -> None:
 //|         """Plays the sample once when loop=False and continuously when loop=True.
@@ -203,66 +203,66 @@ MP_PROPERTY_GETTER(audiodelays_reverb_playing_obj,
 //|         The sample must match the encoding settings given in the constructor."""
 //|         ...
 //|
-static mp_obj_t audiodelays_reverb_obj_play(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+static mp_obj_t audiofreeverb_freeverb_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} },
     };
-    audiodelays_reverb_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
+    audiofreeverb_freeverb_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_audiodelays_reverb_play(self, sample, args[ARG_loop].u_bool);
+    common_hal_audiofreeverb_freeverb_play(self, sample, args[ARG_loop].u_bool);
 
     return mp_const_none;
 }
-MP_DEFINE_CONST_FUN_OBJ_KW(audiodelays_reverb_play_obj, 1, audiodelays_reverb_obj_play);
+MP_DEFINE_CONST_FUN_OBJ_KW(audiofreeverb_freeverb_play_obj, 1, audiofreeverb_freeverb_obj_play);
 
 //|     def stop(self) -> None:
 //|         """Stops playback of the sample. The reverb continues playing."""
 //|         ...
 //|
 //|
-static mp_obj_t audiodelays_reverb_obj_stop(mp_obj_t self_in) {
-    audiodelays_reverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
+static mp_obj_t audiofreeverb_freeverb_obj_stop(mp_obj_t self_in) {
+    audiofreeverb_freeverb_obj_t *self = MP_OBJ_TO_PTR(self_in);
 
-    common_hal_audiodelays_reverb_stop(self);
+    common_hal_audiofreeverb_freeverb_stop(self);
     return mp_const_none;
 }
-MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_reverb_stop_obj, audiodelays_reverb_obj_stop);
+MP_DEFINE_CONST_FUN_OBJ_1(audiofreeverb_freeverb_stop_obj, audiofreeverb_freeverb_obj_stop);
 
-static const mp_rom_map_elem_t audiodelays_reverb_locals_dict_table[] = {
+static const mp_rom_map_elem_t audiofreeverb_freeverb_locals_dict_table[] = {
     // Methods
-    { MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&audiodelays_reverb_deinit_obj) },
+    { MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&audiofreeverb_freeverb_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_play), MP_ROM_PTR(&audiodelays_reverb_play_obj) },
-    { MP_ROM_QSTR(MP_QSTR_stop), MP_ROM_PTR(&audiodelays_reverb_stop_obj) },
+    { MP_ROM_QSTR(MP_QSTR_play), MP_ROM_PTR(&audiofreeverb_freeverb_play_obj) },
+    { MP_ROM_QSTR(MP_QSTR_stop), MP_ROM_PTR(&audiofreeverb_freeverb_stop_obj) },
 
     // Properties
-    { MP_ROM_QSTR(MP_QSTR_playing), MP_ROM_PTR(&audiodelays_reverb_playing_obj) },
-    { MP_ROM_QSTR(MP_QSTR_roomsize), MP_ROM_PTR(&audiodelays_reverb_roomsize_obj) },
-    { MP_ROM_QSTR(MP_QSTR_damp), MP_ROM_PTR(&audiodelays_reverb_damp_obj) },
-    { MP_ROM_QSTR(MP_QSTR_mix), MP_ROM_PTR(&audiodelays_reverb_mix_obj) },
+    { MP_ROM_QSTR(MP_QSTR_playing), MP_ROM_PTR(&audiofreeverb_freeverb_playing_obj) },
+    { MP_ROM_QSTR(MP_QSTR_roomsize), MP_ROM_PTR(&audiofreeverb_freeverb_roomsize_obj) },
+    { MP_ROM_QSTR(MP_QSTR_damp), MP_ROM_PTR(&audiofreeverb_freeverb_damp_obj) },
+    { MP_ROM_QSTR(MP_QSTR_mix), MP_ROM_PTR(&audiofreeverb_freeverb_mix_obj) },
     AUDIOSAMPLE_FIELDS,
 };
-static MP_DEFINE_CONST_DICT(audiodelays_reverb_locals_dict, audiodelays_reverb_locals_dict_table);
+static MP_DEFINE_CONST_DICT(audiofreeverb_freeverb_locals_dict, audiofreeverb_freeverb_locals_dict_table);
 
-static const audiosample_p_t audiodelays_reverb_proto = {
+static const audiosample_p_t audiofreeverb_freeverb_proto = {
     MP_PROTO_IMPLEMENT(MP_QSTR_protocol_audiosample)
-    .reset_buffer = (audiosample_reset_buffer_fun)audiodelays_reverb_reset_buffer,
-    .get_buffer = (audiosample_get_buffer_fun)audiodelays_reverb_get_buffer,
+    .reset_buffer = (audiosample_reset_buffer_fun)audiofreeverb_freeverb_reset_buffer,
+    .get_buffer = (audiosample_get_buffer_fun)audiofreeverb_freeverb_get_buffer,
 };
 
 MP_DEFINE_CONST_OBJ_TYPE(
-    audiodelays_reverb_type,
-    MP_QSTR_Reverb,
+    audiofreeverb_freeverb_type,
+    MP_QSTR_freeverb,
     MP_TYPE_FLAG_HAS_SPECIAL_ACCESSORS,
-    make_new, audiodelays_reverb_make_new,
-    locals_dict, &audiodelays_reverb_locals_dict,
-    protocol, &audiodelays_reverb_proto
+    make_new, audiofreeverb_freeverb_make_new,
+    locals_dict, &audiofreeverb_freeverb_locals_dict,
+    protocol, &audiofreeverb_freeverb_proto
     );