Remove separate DistortionMode code files.

relic-se · relic-se · commit 46ebae159818 · 2024-10-31T10:33:09.000-05:00
diff --git a/py/circuitpy_defns.mk b/py/circuitpy_defns.mk
@@ -570,7 +570,6 @@ $(filter $(SRC_PATTERNS), \
 	_bleio/ScanEntry.c \
 	_eve/__init__.c \
 	__future__/__init__.c \
-	audiofilters/DistortionMode.c \
 	camera/ImageFormat.c \
 	canio/Match.c \
 	codeop/__init__.c \
diff --git a/shared-bindings/audiofilters/Distortion.c b/shared-bindings/audiofilters/Distortion.c
@@ -7,15 +7,58 @@
 #include <stdint.h>
 
 #include "shared-bindings/audiofilters/Distortion.h"
-#include "shared-module/audiofilters/Distortion.h"
 
 #include "shared/runtime/context_manager_helpers.h"
 #include "py/binary.h"
+#include "py/enum.h"
 #include "py/objproperty.h"
 #include "py/runtime.h"
 #include "shared-bindings/util.h"
 #include "shared-module/synthio/block.h"
 
+//| 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_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);
+
+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);
+
+static audiofilters_distortion_mode validate_distortion_mode(mp_obj_t obj, qstr arg_name) {
+    return cp_enum_value(&audiofilters_distortion_mode_type, obj, arg_name);
+}
+
 //| class Distortion:
 //|     """A Distortion effect"""
 //|
@@ -71,13 +114,14 @@
 //|               synth.release(note)
 //|               time.sleep(5)"""
 //|         ...
+
 static mp_obj_t audiofilters_distortion_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
     enum { ARG_drive, ARG_pre_gain, ARG_post_gain, ARG_mode, 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_drive, MP_ARG_OBJ | MP_ARG_KW_ONLY,  {.u_obj = MP_OBJ_NULL} },
         { MP_QSTR_pre_gain, MP_ARG_OBJ | MP_ARG_KW_ONLY,  {.u_obj = MP_OBJ_NULL} },
         { MP_QSTR_post_gain, MP_ARG_OBJ | MP_ARG_KW_ONLY,  {.u_obj = MP_OBJ_NULL} },
-        { MP_QSTR_mode, MP_ARG_OBJ | MP_ARG_KW_ONLY,  {.u_obj = MP_ROM_PTR((void *)&distortion_mode_CLIP_obj)} },
+        { MP_QSTR_mode, MP_ARG_OBJ | MP_ARG_KW_ONLY,  {.u_obj = MP_OBJ_NULL} },
         { MP_QSTR_mix, 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 = 512} },
         { MP_QSTR_sample_rate, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 8000} },
@@ -96,11 +140,13 @@ static mp_obj_t audiofilters_distortion_make_new(const mp_obj_type_t *type, size
         mp_raise_ValueError(MP_ERROR_TEXT("bits_per_sample must be 8 or 16"));
     }
     
-    audiofilters_distortion_mode_t mode = validate_distortion_mode(args[ARG_mode].u_obj, MP_QSTR_mode);
+    audiofilters_distortion_mode mode = DISTORTION_MODE_CLIP;
+    if (args[ARG_mode].u_obj != MP_OBJ_NULL) {
+        mode = validate_distortion_mode(args[ARG_mode].u_obj, MP_QSTR_mode);
+    }
 
     audiofilters_distortion_obj_t *self = mp_obj_malloc(audiofilters_distortion_obj_t, &audiofilters_distortion_type);
     common_hal_audiofilters_distortion_construct(self, args[ARG_drive].u_obj, args[ARG_pre_gain].u_obj, args[ARG_post_gain].u_obj, mode, 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);
 }
 
@@ -236,7 +282,7 @@ static mp_obj_t audiofilters_distortion_obj_set_mode(size_t n_args, const mp_obj
     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);
 
-    audiofilters_distortion_mode_t mode = validate_distortion_mode(args[ARG_mode].u_obj, MP_QSTR_mode);
+    audiofilters_distortion_mode mode = validate_distortion_mode(args[ARG_mode].u_obj, MP_QSTR_mode);
     common_hal_audiofilters_distortion_set_mode(self, mode);
 
     return mp_const_none;
diff --git a/shared-bindings/audiofilters/Distortion.h b/shared-bindings/audiofilters/Distortion.h
@@ -6,14 +6,14 @@
 
 #pragma once
 
-#include "shared-bindings/audiofilters/DistortionMode.h"
 #include "shared-module/audiofilters/Distortion.h"
 
 extern const mp_obj_type_t audiofilters_distortion_type;
+extern const mp_obj_type_t audiofilters_distortion_mode_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,
+    audiofilters_distortion_mode 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);
 
@@ -33,8 +33,8 @@ void common_hal_audiofilters_distortion_set_pre_gain(audiofilters_distortion_obj
 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);
+audiofilters_distortion_mode 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 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);
diff --git a/shared-bindings/audiofilters/DistortionMode.c b/shared-bindings/audiofilters/DistortionMode.c
diff --git a/shared-bindings/audiofilters/DistortionMode.h b/shared-bindings/audiofilters/DistortionMode.h
diff --git a/shared-bindings/audiofilters/__init__.c b/shared-bindings/audiofilters/__init__.c
@@ -10,7 +10,6 @@
 #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"
 
diff --git a/shared-module/audiofilters/Distortion.c b/shared-module/audiofilters/Distortion.c
@@ -3,11 +3,13 @@
 // SPDX-FileCopyrightText: Copyright (c) 2024 Cooper Dalrymple
 //
 // SPDX-License-Identifier: MIT
-#include "shared-bindings/audiofilters/Distortion.h"
 
 #include <stdint.h>
+#include "py/obj.h"
 #include "py/runtime.h"
 #include <math.h>
+#include "shared-bindings/audiofilters/Distortion.h"
+#include "shared-module/audiofilters/Distortion.h"
 
 /**
  * Based on Godot's AudioEffectDistortion
@@ -16,9 +18,10 @@
  */
 
 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) {
+    mp_obj_t drive, mp_obj_t pre_gain, mp_obj_t post_gain,
+    audiofilters_distortion_mode 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) {
 
     // Basic settings every effect and audio sample has
     // These are the effects values, not the source sample(s)
@@ -125,11 +128,11 @@ void common_hal_audiofilters_distortion_set_post_gain(audiofilters_distortion_ob
     synthio_block_assign_slot(arg, &self->post_gain, MP_QSTR_post_gain);
 }
 
-audiofilters_distortion_mode_t common_hal_audiofilters_distortion_get_mode(audiofilters_distortion_obj_t *self) {
+audiofilters_distortion_mode common_hal_audiofilters_distortion_get_mode(audiofilters_distortion_obj_t *self) {
     return self->mode;
 }
 
-void common_hal_audiofilters_distortion_set_mode(audiofilters_distortion_obj_t *self, audiofilters_distortion_mode_t arg) {
+void common_hal_audiofilters_distortion_set_mode(audiofilters_distortion_obj_t *self, audiofilters_distortion_mode arg) {
     self->mode = arg;
 }
 
diff --git a/shared-module/audiofilters/Distortion.h b/shared-module/audiofilters/Distortion.h
@@ -7,9 +7,17 @@
 
 #include "py/obj.h"
 
+#include "shared-bindings/audiofilters/Distortion.h"
 #include "shared-module/audiocore/__init__.h"
 #include "shared-module/synthio/block.h"
-#include "shared-bindings/audiofilters/DistortionMode.h"
+
+typedef enum {
+    DISTORTION_MODE_CLIP,
+    DISTORTION_MODE_ATAN,
+    DISTORTION_MODE_LOFI,
+    DISTORTION_MODE_OVERDRIVE,
+    DISTORTION_MODE_WAVESHAPE,
+} audiofilters_distortion_mode;
 
 extern const mp_obj_type_t audiofilters_distortion_type;
 
@@ -18,7 +26,7 @@ typedef struct {
     synthio_block_slot_t drive;
     synthio_block_slot_t pre_gain;
     synthio_block_slot_t post_gain;
-    audiofilters_distortion_mode_t mode;
+    audiofilters_distortion_mode mode;
     synthio_block_slot_t mix;
 
     uint8_t bits_per_sample;
@@ -44,11 +52,9 @@ void audiofilters_distortion_reset_buffer(audiofilters_distortion_obj_t *self,
     uint8_t channel);
 
 audioio_get_buffer_result_t audiofilters_distortion_get_buffer(audiofilters_distortion_obj_t *self,
-    bool single_channel_output,
-    uint8_t channel,
-    uint8_t **buffer,
-    uint32_t *buffer_length);  // length in bytes
+    bool single_channel_output, uint8_t channel,
+    uint8_t **buffer, uint32_t *buffer_length);
 
-void audiofilters_distortion_get_buffer_structure(audiofilters_distortion_obj_t *self, bool single_channel_output,
-    bool *single_buffer, bool *samples_signed,
+void audiofilters_distortion_get_buffer_structure(audiofilters_distortion_obj_t *self,
+    bool single_channel_output, bool *single_buffer, bool *samples_signed,
     uint32_t *max_buffer_length, uint8_t *spacing);
