Added Distortion and DistortionMode classes to audiofilters module based on Godot's AudioEffectDistortion class.

Author: relic-se

py/circuitpy_defns.mk

@@ -570,6 +570,7 @@ $(filter $(SRC_PATTERNS), \
 	_bleio/ScanEntry.c \
 	_eve/__init__.c \
 	__future__/__init__.c \
+	audiofilters/DistortionMode.c \
 	camera/ImageFormat.c \
 	canio/Match.c \
 	codeop/__init__.c \
@@ -626,6 +627,7 @@ SRC_SHARED_MODULE_ALL = \
 	audiodelays/Echo.c \
 	audiodelays/__init__.c \
 	audiofilters/Filter.c \
+	audiofilters/Distortion.c \
 	audiofilters/__init__.c \
 	audioio/__init__.c \
 	audiomixer/Mixer.c \

shared-bindings/audiofilters/Distortion.c

@@ -0,0 +1,44 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2024 Cooper Dalrymple
+//
+// SPDX-License-Identifier: MIT
+
+#pragma once
+
+#include "shared-bindings/audiofilters/DistortionMode.h"
+#include "shared-module/audiofilters/Distortion.h"
+
+extern const mp_obj_type_t audiofilters_distortion_type;
+
+void common_hal_audiofilters_distortion_construct(audiofilters_distortion_obj_t *self,
+    mp_obj_t drive, mp_obj_t pre_gain, mp_obj_t post_gain,
+    audiofilters_distortion_mode_t mode, mp_obj_t mix,
+    uint32_t buffer_size, uint8_t bits_per_sample, bool samples_signed,
+    uint8_t channel_count, uint32_t sample_rate);
+
+void common_hal_audiofilters_distortion_deinit(audiofilters_distortion_obj_t *self);
+bool common_hal_audiofilters_distortion_deinited(audiofilters_distortion_obj_t *self);
+
+uint32_t common_hal_audiofilters_distortion_get_sample_rate(audiofilters_distortion_obj_t *self);
+uint8_t common_hal_audiofilters_distortion_get_channel_count(audiofilters_distortion_obj_t *self);
+uint8_t common_hal_audiofilters_distortion_get_bits_per_sample(audiofilters_distortion_obj_t *self);
+
+mp_obj_t common_hal_audiofilters_distortion_get_drive(audiofilters_distortion_obj_t *self);
+void common_hal_audiofilters_distortion_set_drive(audiofilters_distortion_obj_t *self, mp_obj_t arg);
+
+mp_obj_t common_hal_audiofilters_distortion_get_pre_gain(audiofilters_distortion_obj_t *self);
+void common_hal_audiofilters_distortion_set_pre_gain(audiofilters_distortion_obj_t *self, mp_obj_t arg);
+
+mp_obj_t common_hal_audiofilters_distortion_get_post_gain(audiofilters_distortion_obj_t *self);
+void common_hal_audiofilters_distortion_set_post_gain(audiofilters_distortion_obj_t *self, mp_obj_t arg);
+
+audiofilters_distortion_mode_t common_hal_audiofilters_distortion_get_mode(audiofilters_distortion_obj_t *self);
+void common_hal_audiofilters_distortion_set_mode(audiofilters_distortion_obj_t *self, audiofilters_distortion_mode_t mode);
+
+mp_obj_t common_hal_audiofilters_distortion_get_mix(audiofilters_distortion_obj_t *self);
+void common_hal_audiofilters_distortion_set_mix(audiofilters_distortion_obj_t *self, mp_obj_t arg);
+
+bool common_hal_audiofilters_distortion_get_playing(audiofilters_distortion_obj_t *self);
+void common_hal_audiofilters_distortion_play(audiofilters_distortion_obj_t *self, mp_obj_t sample, bool loop);
+void common_hal_audiofilters_distortion_stop(audiofilters_distortion_obj_t *self);

shared-bindings/audiofilters/Distortion.h

@@ -0,0 +1,50 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2024 Cooper Dalrymple
+//
+// SPDX-License-Identifier: MIT
+
+#include "py/enum.h"
+
+#include "shared-bindings/audiofilters/DistortionMode.h"
+
+MAKE_ENUM_VALUE(audiofilters_distortion_mode_type, distortion_mode, CLIP, DISTORTION_MODE_CLIP);
+MAKE_ENUM_VALUE(audiofilters_distortion_mode_type, distortion_mode, ATAN, DISTORTION_MODE_ATAN);
+MAKE_ENUM_VALUE(audiofilters_distortion_mode_type, distortion_mode, LOFI, DISTORTION_MODE_LOFI);
+MAKE_ENUM_VALUE(audiofilters_distortion_mode_type, distortion_mode, OVERDRIVE, DISTORTION_MODE_OVERDRIVE);
+MAKE_ENUM_VALUE(audiofilters_distortion_mode_type, distortion_mode, WAVESHAPE, DISTORTION_MODE_WAVESHAPE);
+
+//| class DistortionMode:
+//|     """The method of distortion used by the `audiofilters.Distortion` effect."""
+//|
+//|     CLIP: DistortionMode
+//|     """Digital distortion effect which cuts off peaks at the top and bottom of the waveform."""
+//|
+//|     ATAN: DistortionMode
+//|     """"""
+//|
+//|     LOFI: DistortionMode
+//|     """Low-resolution digital distortion effect (bit depth reduction). You can use it to emulate the sound of early digital audio devices."""
+//|
+//|     OVERDRIVE: DistortionMode
+//|     """Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers. The `audiofilters.Distortion.drive` property has no effect in this mode."""
+//|
+//|     WAVESHAPE: DistortionMode
+//|     """Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound."""
+//|
+MAKE_ENUM_MAP(audiofilters_distortion_mode) {
+    MAKE_ENUM_MAP_ENTRY(distortion_mode, CLIP),
+    MAKE_ENUM_MAP_ENTRY(distortion_mode, ATAN),
+    MAKE_ENUM_MAP_ENTRY(distortion_mode, LOFI),
+    MAKE_ENUM_MAP_ENTRY(distortion_mode, OVERDRIVE),
+    MAKE_ENUM_MAP_ENTRY(distortion_mode, WAVESHAPE),
+};
+static MP_DEFINE_CONST_DICT(audiofilters_distortion_mode_locals_dict, audiofilters_distortion_mode_locals_table);
+
+MAKE_PRINTER(audiofilters, audiofilters_distortion_mode);
+
+MAKE_ENUM_TYPE(audiofilters, DistortionMode, audiofilters_distortion_mode);
+
+audiofilters_distortion_mode_t validate_distortion_mode(mp_obj_t obj, qstr arg_name) {
+    return cp_enum_value(&audiofilters_distortion_mode_type, obj, arg_name);
+}

shared-bindings/audiofilters/DistortionMode.c

@@ -0,0 +1,22 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2024 Cooper Dalrymple
+//
+// SPDX-License-Identifier: MIT
+
+#pragma once
+
+#include "py/enum.h"
+
+typedef enum audiofilters_distortion_mode_e {
+    DISTORTION_MODE_CLIP,
+    DISTORTION_MODE_ATAN,
+    DISTORTION_MODE_LOFI,
+    DISTORTION_MODE_OVERDRIVE,
+    DISTORTION_MODE_WAVESHAPE,
+} audiofilters_distortion_mode_t;
+
+extern const cp_enum_obj_t distortion_mode_CLIP_obj;
+extern const mp_obj_type_t audiofilters_distortion_mode_type;
+
+extern audiofilters_distortion_mode_t validate_distortion_mode(mp_obj_t obj, qstr arg_name);

shared-bindings/audiofilters/DistortionMode.h

@@ -10,6 +10,8 @@
 #include "py/runtime.h"
 
 #include "shared-bindings/audiofilters/__init__.h"
+#include "shared-bindings/audiofilters/DistortionMode.h"
+#include "shared-bindings/audiofilters/Distortion.h"
 #include "shared-bindings/audiofilters/Filter.h"
 
 //| """Support for audio filter effects
@@ -21,6 +23,10 @@
 static const mp_rom_map_elem_t audiofilters_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_audiofilters) },
     { MP_ROM_QSTR(MP_QSTR_Filter), MP_ROM_PTR(&audiofilters_filter_type) },
+    { MP_ROM_QSTR(MP_QSTR_Distortion), MP_ROM_PTR(&audiofilters_distortion_type) },
+
+    // Enum-like Classes.
+    { MP_ROM_QSTR(MP_QSTR_DistortionMode), MP_ROM_PTR(&audiofilters_distortion_mode_type) },
 };
 
 static MP_DEFINE_CONST_DICT(audiofilters_module_globals, audiofilters_module_globals_table);