cmodule/m5unified: Add Mic.recordWavFile method.

Signed-off-by: lbuque <[email protected]>

Author: lbuque

m5stack/Makefile

@@ -298,7 +298,7 @@ patch:
 	$(call Package/patche,$(abspath ./../micropython),$(abspath ./patches/0005-micropython-fix-SDCard-16223.patch))
 	$(call Package/patche,$(abspath ./../micropython),$(abspath ./patches/0006-modtime-add-timezone-method.patch))
 	$(call Package/patche,$(abspath $(IDF_PATH)),$(abspath ./patches/1003-WIP-Compatible-with-esp-adf-v2.7.diff))
-	$(call Package/patche,$(abspath ./components/M5Unified/M5Unified),$(abspath ./patches/2003-Support-LTR553.patch))
+	$(call Package/patche,$(abspath ./components/M5Unified/M5Unified),$(abspath ./patches/2005-Support-LTR553.patch))
 	$(call Package/patche,$(abspath $(ADF_PATH)),$(abspath ./patches/3002-Modify-i2s_stream_idf5.patch))
 	$(call Package/patche,$(abspath ./components/epdiy),$(abspath ./patches/4001-Avoid-epdiy-compilation-failure-on-esp32-c6.patch))
 
@@ -309,6 +309,6 @@ unpatch:
 	$(call Package/unpatche,$(abspath ./../micropython),$(abspath ./patches/0005-micropython-fix-SDCard-16223.patch))
 	$(call Package/unpatche,$(abspath ./../micropython),$(abspath ./patches/0004-micropython-1.24-machine-adc-v5.x.diff))
 	$(call Package/unpatche,$(abspath $(IDF_PATH)),$(abspath ./patches/1003-WIP-Compatible-with-esp-adf-v2.7.diff))
-	$(call Package/unpatche,$(abspath ./components/M5Unified/M5Unified),$(abspath ./patches/2003-Support-LTR553.patch))
+	$(call Package/unpatche,$(abspath ./components/M5Unified/M5Unified),$(abspath ./patches/2005-Support-LTR553.patch))
 	$(call Package/unpatche,$(abspath $(ADF_PATH)),$(abspath ./patches/3002-Modify-i2s_stream_idf5.patch))
 	$(call Package/unpatche,$(abspath ./components/epdiy),$(abspath ./patches/4001-Avoid-epdiy-compilation-failure-on-esp32-c6.patch))

m5stack/cmodules/m5unified/m5unified_mic.c

@@ -14,6 +14,7 @@ MAKE_METHOD_0(mic, isEnabled);
 MAKE_METHOD_0(mic, isRecording);
 MAKE_METHOD_KW(mic, setSampleRate, 1);
 MAKE_METHOD_KW(mic, record, 1);
+MAKE_METHOD_KW(mic, recordWavFile, 1);
 
 static const mp_rom_map_elem_t mic_member_table[] = {
     MAKE_TABLE(mic, config),
@@ -24,6 +25,7 @@ static const mp_rom_map_elem_t mic_member_table[] = {
     MAKE_TABLE(mic, isRecording),
     MAKE_TABLE(mic, setSampleRate),
     MAKE_TABLE(mic, record),
+    MAKE_TABLE(mic, recordWavFile),
 };
 
 static MP_DEFINE_CONST_DICT(mic_member, mic_member_table);

m5stack/components/M5Unified/M5Unified

@@ -0,0 +1,74 @@
+/*
+ * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
+ *
+ * SPDX-License-Identifier: Unlicense OR CC0-1.0
+ */
+#pragma once
+
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Header structure for WAV file with only one data chunk
+ *
+ * @note See this for reference: http://soundfile.sapp.org/doc/WaveFormat/
+ *
+ * @note Assignment to variables in this struct directly is only possible for little endian architectures
+ *       (including Xtensa & RISC-V)
+ */
+typedef struct {
+    struct {
+        char chunk_id[4]; /*!< Contains the letters "RIFF" in ASCII form */
+        uint32_t chunk_size; /*!< This is the size of the rest of the chunk following this number */
+        char chunk_format[4]; /*!< Contains the letters "WAVE" */
+    } descriptor_chunk; /*!< Canonical WAVE format starts with the RIFF header */
+    struct {
+        char subchunk_id[4]; /*!< Contains the letters "fmt " */
+        uint32_t subchunk_size; /*!< This is the size of the rest of the Subchunk which follows this number */
+        uint16_t audio_format; /*!< PCM = 1, values other than 1 indicate some form of compression */
+        uint16_t num_of_channels; /*!< Mono = 1, Stereo = 2, etc. */
+        uint32_t sample_rate; /*!< 8000, 44100, etc. */
+        uint32_t byte_rate; /*!< ==SampleRate * NumChannels * BitsPerSample s/ 8 */
+        uint16_t block_align; /*!< ==NumChannels * BitsPerSample / 8 */
+        uint16_t bits_per_sample; /*!< 8 bits = 8, 16 bits = 16, etc. */
+    } fmt_chunk; /*!< The "fmt " subchunk describes the sound data's format */
+    struct {
+        char subchunk_id[4]; /*!< Contains the letters "data" */
+        uint32_t subchunk_size; /*!< ==NumSamples * NumChannels * BitsPerSample / 8 */
+        int16_t data[0]; /*!< Holds raw audio data */
+    } data_chunk; /*!< The "data" subchunk contains the size of the data and the actual sound */
+} wav_header_t;
+
+/**
+ * @brief Default header for PCM format WAV files
+ *
+ */
+#define WAV_HEADER_PCM_DEFAULT(wav_sample_size, wav_sample_bits, wav_sample_rate, wav_channel_num) { \
+        .descriptor_chunk = { \
+            .chunk_id = {'R', 'I', 'F', 'F'}, \
+            .chunk_size = (wav_sample_size) + sizeof(wav_header_t) - 8, \
+            .chunk_format = {'W', 'A', 'V', 'E'} \
+        }, \
+        .fmt_chunk = { \
+            .subchunk_id = {'f', 'm', 't', ' '}, \
+            .subchunk_size = 16, /* 16 for PCM */ \
+            .audio_format = 1, /* 1 for PCM */ \
+            .num_of_channels = (wav_channel_num), \
+            .sample_rate = (wav_sample_rate), \
+            .byte_rate = (wav_sample_bits) * (wav_sample_rate) * (wav_channel_num) / 8, \
+            .block_align = (uint16_t)((wav_sample_bits) * (wav_channel_num) / 8), \
+            .bits_per_sample = (wav_sample_bits) \
+        }, \
+        .data_chunk = { \
+            .subchunk_id = {'d', 'a', 't', 'a'}, \
+            .subchunk_size = (wav_sample_size) \
+        } \
+}
+
+#ifdef __cplusplus
+}
+#endif

m5stack/components/M5Unified/format_wav.h

@@ -10,6 +10,12 @@ extern "C"
 {
 #include "mpy_m5mic.h"
 #include "mic_config_t.h"
+#include "format_wav.h"
+#include "extmod/vfs_fat.h"
+#include "py/builtin.h"
+#include "py/runtime.h"
+#include "py/stream.h"
+#include "py/mphal.h"
 
 namespace m5
 {
@@ -284,5 +290,77 @@ namespace m5
         return mp_obj_new_bool(ret);
     }
 
+    mp_obj_t mic_recordWavFile(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+        enum {ARG_path, ARG_rate, ARG_time, ARG_stereo};
+        const mp_arg_t allowed_args[] = {
+            /* *FORMAT-OFF* */
+            { MP_QSTR_path,   MP_ARG_OBJ | MP_ARG_REQUIRED, { .u_obj = MP_OBJ_NULL } },
+            { MP_QSTR_rate,   MP_ARG_INT,                   { .u_int = 16000 }       },
+            { MP_QSTR_time,   MP_ARG_INT,                   { .u_int = 5 }           },
+            { MP_QSTR_stereo, MP_ARG_BOOL,                  { .u_bool = false }      },
+            /* *FORMAT-ON* */
+        };
+        mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+        // The first parameter is the Power object, parse from second parameter.
+        mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+        const char *file_path = mp_obj_str_get_str(args[ARG_path].u_obj);
+        uint32_t rate = args[ARG_rate].u_int;
+        uint32_t rec_time = args[ARG_time].u_int;
+        bool stereo = args[ARG_stereo].u_bool;
+        uint16_t channels = stereo ? 2 : 1;
+
+        char ftype[5] = {0};
+        for (size_t i = 0; i < 4; i++) {
+            ftype[i] = tolower((char)file_path[i + strlen(file_path) - 4]);
+        }
+        ftype[4] = '\0';
+
+        mp_obj_t file_args[2];
+        file_args[0] = args[ARG_path].u_obj;
+        file_args[1] = mp_obj_new_str("wb+", strlen("wb+"));
+        mp_obj_t wav_file = mp_vfs_open(2, file_args, (mp_map_t *)&mp_const_empty_map);
+        if (wav_file == mp_const_none) {
+            mp_raise_OSError(MP_ENOENT);
+            // mp_raise_ValueError(MP_ERROR_TEXT("open file failed"));
+        }
+
+        int flash_wr_size = 0;
+        uint32_t byte_rate = rate * 2 * channels; // bit sample size = 16bit, byte rate = sample rate * (bit sample size / 8) * channel
+        uint32_t flash_rec_time = byte_rate * rec_time;
+
+        wav_header_t wav_header = WAV_HEADER_PCM_DEFAULT(flash_rec_time, 16, rate, channels);
+
+        int rlen = mp_stream_posix_write(wav_file, &wav_header, sizeof(wav_header_t));
+        if (rlen != sizeof(wav_header_t)) {
+            mp_stream_close(wav_file);
+            mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("File is too short"));
+        }
+
+        Mic_Class *Mic = getMic(&pos_args[0]);
+
+        constexpr const size_t buf_size = 1024;
+        int16_t rec_data[512];
+
+        // mp_printf(&mp_plat_print, "flash_rec_time: %d\n", flash_rec_time);
+
+        while (flash_wr_size < flash_rec_time) {
+            bool ret = Mic->record(rec_data, buf_size >> 1, rate, stereo);
+
+            while (Mic->isRecording() != 0) {
+                mp_hal_delay_ms(1);
+            }
+            size_t remain = flash_rec_time - flash_wr_size;
+            size_t len = remain > buf_size ? buf_size : remain;
+            int wlen = mp_stream_posix_write(wav_file, rec_data, len);
+            if (wlen != len) {
+                mp_stream_close(wav_file);
+                mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("File is too short"));
+            }
+            flash_wr_size += wlen;
+        }
+        mp_stream_close(wav_file);
+        return mp_obj_new_bool(true);
+    }
 }
 }