codal_port: Add SoundEvent class and move LOUD/QUIET constants there.

dpgeorge · dpgeorge · commit 18eb9de1e88a · 2020-11-17T13:17:09.000+11:00
To capture the current 'loud' and 'quiet' options and give the possibility
to expand it in the future to other types of events.

Usage is now:

    microphone.was_event(SoundEvent.LOUD)
diff --git a/src/codal_port/Makefile b/src/codal_port/Makefile
@@ -65,6 +65,7 @@ SRC_C += \
 	microbit_microphone.c \
 	microbit_pin.c \
 	microbit_pinmode.c \
+	microbit_soundevent.c \
 	microbit_spi.c \
 	microbit_uart.c \
 	modaudio.c \
diff --git a/src/codal_port/microbit_microphone.c b/src/codal_port/microbit_microphone.c
@@ -38,10 +38,10 @@ typedef struct _microbit_microphone_obj_t {
     mp_obj_base_t base;
 } microbit_microphone_obj_t;
 
-static const qstr sound_event_name_map[] = {
-    [SOUND_EVENT_NONE] = MP_QSTR_,
-    [SOUND_EVENT_LOUD] = MP_QSTR_loud,
-    [SOUND_EVENT_QUIET] = MP_QSTR_quiet,
+static const mp_const_obj_t sound_event_obj_map[] = {
+    [SOUND_EVENT_NONE] = MP_ROM_NONE,
+    [SOUND_EVENT_LOUD] = MP_ROM_PTR(&microbit_soundevent_loud_obj),
+    [SOUND_EVENT_QUIET] = MP_ROM_PTR(&microbit_soundevent_quiet_obj),
 };
 
 static uint8_t sound_event_current = 0;
@@ -72,10 +72,9 @@ STATIC void microphone_init(void) {
     microbit_hal_microphone_init();
 }
 
-STATIC uint8_t sound_event_from_obj(mp_obj_t sound_in) {
-    qstr sound = mp_obj_str_get_qstr(sound_in);
-    for (uint8_t i = 0; i < MP_ARRAY_SIZE(sound_event_name_map); ++i) {
-        if (sound == sound_event_name_map[i]) {
+STATIC uint8_t sound_event_from_obj(mp_obj_t sound) {
+    for (uint8_t i = 0; i < MP_ARRAY_SIZE(sound_event_obj_map); ++i) {
+        if (sound == sound_event_obj_map[i]) {
             return i;
         }
     }
@@ -110,7 +109,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_1(microbit_microphone_sound_level_obj, microbit_m
 STATIC mp_obj_t microbit_microphone_current_event(mp_obj_t self_in) {
     (void)self_in;
     microphone_init();
-    return MP_OBJ_NEW_QSTR(sound_event_name_map[sound_event_current]);
+    return (mp_obj_t)sound_event_obj_map[sound_event_current];
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_1(microbit_microphone_current_event_obj, microbit_microphone_current_event);
 
@@ -145,7 +144,7 @@ STATIC mp_obj_t microbit_microphone_get_events(mp_obj_t self_in) {
     mp_obj_tuple_t *o = (mp_obj_tuple_t *)mp_obj_new_tuple(sound_event_history_index, NULL);
     for (size_t i = 0; i < sound_event_history_index; ++i) {
         uint8_t sound = sound_event_history_array[i];
-        o->items[i] = MP_OBJ_NEW_QSTR(sound_event_name_map[sound]);
+        o->items[i] = (mp_obj_t)sound_event_obj_map[sound];
     }
     sound_event_history_index = 0;
     return o;
@@ -159,9 +158,6 @@ STATIC const mp_rom_map_elem_t microbit_microphone_locals_dict_table[] = {
     { MP_ROM_QSTR(MP_QSTR_is_event), MP_ROM_PTR(&microbit_microphone_is_event_obj) },
     { MP_ROM_QSTR(MP_QSTR_was_event), MP_ROM_PTR(&microbit_microphone_was_event_obj) },
     { MP_ROM_QSTR(MP_QSTR_get_events), MP_ROM_PTR(&microbit_microphone_get_events_obj) },
-
-    { MP_ROM_QSTR(MP_QSTR_LOUD), MP_ROM_QSTR(MP_QSTR_loud) },
-    { MP_ROM_QSTR(MP_QSTR_QUIET), MP_ROM_QSTR(MP_QSTR_quiet) },
 };
 STATIC MP_DEFINE_CONST_DICT(microbit_microphone_locals_dict, microbit_microphone_locals_dict_table);
 
diff --git a/src/codal_port/microbit_soundevent.c b/src/codal_port/microbit_soundevent.c
@@ -0,0 +1,61 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 Damien P. George
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "py/runtime.h"
+#include "modmicrobit.h"
+
+struct _microbit_soundevent_obj_t {
+    mp_obj_base_t base;
+    qstr name;
+};
+
+const microbit_soundevent_obj_t microbit_soundevent_loud_obj = {
+    { &microbit_soundevent_type },
+    MP_QSTR_loud,
+};
+
+const microbit_soundevent_obj_t microbit_soundevent_quiet_obj = {
+    { &microbit_soundevent_type },
+    MP_QSTR_quiet,
+};
+
+STATIC void microbit_soundevent_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
+    microbit_soundevent_obj_t *self = (microbit_soundevent_obj_t *)self_in;
+    mp_printf(print, "SoundEvent('%q')", self->name);
+}
+
+STATIC const mp_rom_map_elem_t microbit_soundevent_locals_dict_table[] = {
+    { MP_ROM_QSTR(MP_QSTR_LOUD), MP_ROM_PTR(&microbit_soundevent_loud_obj) },
+    { MP_ROM_QSTR(MP_QSTR_QUIET), MP_ROM_PTR(&microbit_soundevent_quiet_obj) },
+};
+STATIC MP_DEFINE_CONST_DICT(microbit_soundevent_locals_dict, microbit_soundevent_locals_dict_table);
+
+const mp_obj_type_t microbit_soundevent_type = {
+    { &mp_type_type },
+    .name = MP_QSTR_MicroBitSoundEvent,
+    .print = microbit_soundevent_print,
+    .locals_dict = (mp_obj_dict_t *)&microbit_soundevent_locals_dict,
+};
diff --git a/src/codal_port/modmicrobit.c b/src/codal_port/modmicrobit.c
@@ -86,6 +86,7 @@ STATIC const mp_rom_map_elem_t microbit_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_microbit) },
 
     { MP_ROM_QSTR(MP_QSTR_Image), (mp_obj_t)&microbit_image_type },
+    { MP_ROM_QSTR(MP_QSTR_SoundEvent), (mp_obj_t)&microbit_soundevent_type },
 
     { MP_ROM_QSTR(MP_QSTR_display), MP_ROM_PTR(&microbit_display_obj) },
     { MP_ROM_QSTR(MP_QSTR_button_a), (mp_obj_t)&microbit_button_a_obj },
diff --git a/src/codal_port/modmicrobit.h b/src/codal_port/modmicrobit.h
@@ -69,12 +69,15 @@ typedef struct _pinmode {
     release_func release; /* Call this function to release pin */
 } microbit_pinmode_t;
 
+typedef struct _microbit_soundevent_obj_t microbit_soundevent_obj_t;
+
 extern const microbit_pinmode_t microbit_pinmodes[];
 
 extern const mp_obj_type_t microbit_ad_pin_type;
 extern const mp_obj_type_t microbit_dig_pin_type;
 extern const mp_obj_type_t microbit_touch_pin_type;
 extern const mp_obj_type_t microbit_touch_only_pin_type;
+extern const mp_obj_type_t microbit_soundevent_type;
 
 extern const struct _microbit_pin_obj_t microbit_p0_obj;
 extern const struct _microbit_pin_obj_t microbit_p1_obj;
@@ -169,6 +172,9 @@ extern const struct _monochrome_5by5_t microbit_const_image_skull_obj;
 extern const struct _monochrome_5by5_t microbit_const_image_umbrella_obj;
 extern const struct _monochrome_5by5_t microbit_const_image_snake_obj;
 
+extern const microbit_soundevent_obj_t microbit_soundevent_loud_obj;
+extern const microbit_soundevent_obj_t microbit_soundevent_quiet_obj;
+
 extern struct _microbit_display_obj_t microbit_display_obj;
 extern const struct _microbit_accelerometer_obj_t microbit_accelerometer_obj;
 extern const struct _microbit_compass_obj_t microbit_compass_obj;
