esp32s2: audiobusio: move i2s_common inside

Originally, I believed the implementation might be shared with AudioOut,
as on the ESP32 (non-S2) the I2S peripheral was also used to drive the DAC.
However, this is not the case on ESP32-S2 and appears it will not be
the case with the ESP32-S3 or -C3, to the extent that there's skeletal
support for either of them in esp-idf master branch.

However, it could still be shared by I2SIn or PDMIn (the latter being
hypothetically implemented as I2SIn + digital postprocessing like we did
in the atmel-sam port, to my understanding), so I moved it to
the common-hal folder.

Author: jepler

ports/esp32s2/Makefile

@@ -175,7 +175,6 @@ CFLAGS += -DCFG_TUSB_MCU=OPT_MCU_ESP32S2 -DCFG_TUSB_OS=OPT_OS_FREERTOS -DCFG_TUD
 SRC_C += \
 	background.c \
 	fatfs_port.c \
-	i2s_common.c \
 	mphalport.c \
 	bindings/espidf/__init__.c \
 	boards/$(BOARD)/board.c \

ports/esp32s2/common-hal/audiobusio/I2SOut.h

@@ -29,7 +29,7 @@
 #include "supervisor/background_callback.h"
 #include "common-hal/microcontroller/Pin.h"
 
-#include "i2s_common.h"
+#include "common-hal/audiobusio/__init__.h"
 
 // Some boards don't implement I2SOut, so suppress any routines from here.
 #if CIRCUITPY_AUDIOBUSIO_I2SOUT

ports/esp32s2/common-hal/audiobusio/__init__.c

@@ -0,0 +1,245 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 Jeff Epler for Adafruit Industries
+ *
+ * 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 <string.h>
+
+#include "py/runtime.h"
+
+#include "common-hal/audiobusio/__init__.h"
+#include "bindings/espidf/__init__.h"
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+
+#include "shared-module/audiocore/__init__.h"
+
+#define I2S_QUEUE_SIZE (3)
+
+static i2s_t *i2s_instance[I2S_NUM_MAX];
+static QueueHandle_t i2s_queues[I2S_NUM_MAX];
+static TaskHandle_t i2s_tasks[I2S_NUM_MAX];
+
+static int8_t port_i2s_allocate(void) {
+#if defined(I2S_NUM_1)
+    if(!i2s_instance[1]) return 1;
+#endif
+    if(!i2s_instance[0]) return 0;
+
+    mp_raise_RuntimeError(translate("Peripheral in use"));
+}
+
+void port_i2s_reset_instance(int i) {
+    assert(i >= 0 && i < I2S_NUM_MAX);
+    if (i2s_tasks[i]) {
+        vTaskDelete(i2s_tasks[i]);
+    }
+    i2s_tasks[i] = NULL;
+
+    (void)i2s_driver_uninstall(i);
+    i2s_instance[i] = NULL;
+}
+
+void i2s_reset(void) {
+    for (int i=0; i < I2S_NUM_MAX; i++) {
+        port_i2s_reset_instance(i);
+    }
+}
+
+static void i2s_fill_buffer(i2s_t *self) {
+    if (self->instance < 0 || self->instance >= I2S_NUM_MAX) {
+        return;
+    }
+#define STACK_BUFFER_SIZE (512)
+    int16_t signed_samples[STACK_BUFFER_SIZE / sizeof(int16_t)];
+
+    if (!self->playing || self->paused || !self->sample || self->stopping) {
+        memset(signed_samples, 0, sizeof(signed_samples));
+
+        size_t bytes_written = 0;
+        do {
+            CHECK_ESP_RESULT(i2s_write(self->instance, signed_samples, sizeof(signed_samples), &bytes_written, 0));
+        } while (bytes_written != 0);
+        return;
+    }
+    while (!self->stopping) {
+        if (self->sample_data == self->sample_end) {
+            uint32_t sample_buffer_length;
+            audioio_get_buffer_result_t get_buffer_result =
+                audiosample_get_buffer(self->sample, false, 0,
+                                       &self->sample_data, &sample_buffer_length);
+            self->sample_end = self->sample_data + sample_buffer_length;
+            if (get_buffer_result == GET_BUFFER_DONE) {
+                if (self->loop) {
+                    audiosample_reset_buffer(self->sample, false, 0);
+                } else {
+                    self->stopping = true;
+                    break;
+                }
+            }
+            if (get_buffer_result == GET_BUFFER_ERROR || sample_buffer_length == 0) {
+                self->stopping = true;
+                break;
+            }
+        }
+        size_t bytes_written = 0;
+        size_t bytecount = self->sample_end - self->sample_data;
+        if (self->samples_signed && self->channel_count == 2) {
+            if (self->bytes_per_sample == 2) {
+                CHECK_ESP_RESULT(i2s_write(self->instance, self->sample_data, bytecount, &bytes_written, 0));
+            } else {
+                CHECK_ESP_RESULT(i2s_write_expand(self->instance, self->sample_data, bytecount, 8, 16, &bytes_written, 0));
+            }
+        } else {
+            const size_t bytes_per_output_frame = 4;
+            size_t bytes_per_input_frame = self->channel_count * self->bytes_per_sample;
+            size_t framecount = MIN(STACK_BUFFER_SIZE / bytes_per_output_frame, bytecount / bytes_per_input_frame);
+            if (self->samples_signed) {
+                assert(self->channel_count == 1);
+                if (self->bytes_per_sample == 1) {
+                    audiosample_convert_s8m_s16s(signed_samples, (int8_t*)(void*)self->sample_data, framecount);
+                } else {
+                    audiosample_convert_s16m_s16s(signed_samples, (int16_t*)(void*)self->sample_data, framecount);
+                }
+            } else {
+                if (self->channel_count == 1) {
+                    if (self->bytes_per_sample == 1) {
+                        audiosample_convert_u8m_s16s(signed_samples, (uint8_t*)(void*)self->sample_data, framecount);
+                    } else {
+                        audiosample_convert_u16m_s16s(signed_samples, (uint16_t*)(void*)self->sample_data, framecount);
+                    }
+                } else {
+                    if (self->bytes_per_sample == 1) {
+                        audiosample_convert_u8s_s16s(signed_samples, (uint8_t*)(void*)self->sample_data, framecount);
+                    } else {
+                        audiosample_convert_u16s_s16s(signed_samples, (uint16_t*)(void*)self->sample_data, framecount);
+                    }
+                }
+            }
+            size_t expanded_bytes_written = 0;
+            CHECK_ESP_RESULT(i2s_write(self->instance, signed_samples, bytes_per_output_frame*framecount, &expanded_bytes_written, 0));
+            assert(expanded_bytes_written % 4 == 0);
+            bytes_written = expanded_bytes_written / bytes_per_output_frame * bytes_per_input_frame;
+        }
+        self->sample_data += bytes_written;
+        // We have filled the DMA buffer
+        if (!bytes_written) {
+            break;
+        }
+    }
+}
+
+static void i2s_callback_fun(void *self_in) {
+    i2s_t *self = self_in;
+    i2s_fill_buffer(self);
+}
+
+static void i2s_event_task(void *self_in) {
+    i2s_t *self = self_in;
+    while(true) {
+        i2s_event_type_t event;
+        BaseType_t result = xQueueReceive(i2s_queues[self->instance], &event, portMAX_DELAY);
+        if (result && event == I2S_EVENT_TX_DONE) {
+            background_callback_add(&self->callback, i2s_callback_fun, self_in);
+        }
+    }
+}
+
+void port_i2s_allocate_init(i2s_t *self, bool left_justified) {
+    self->instance = port_i2s_allocate();
+
+    i2s_config_t i2s_config = {
+        .mode = I2S_MODE_MASTER | I2S_MODE_TX,
+        .sample_rate = 44100,
+        .bits_per_sample = 16,
+        .channel_format = I2S_CHANNEL_FMT_RIGHT_LEFT,
+        .communication_format = left_justified ? I2S_COMM_FORMAT_STAND_I2S : I2S_COMM_FORMAT_STAND_I2S,
+        .dma_buf_count = 2,
+        .dma_buf_len = 128, // in _frames_, so 128 is 512 bytes per dma buf
+        .use_apll = false,
+    };
+    CHECK_ESP_RESULT(i2s_driver_install(self->instance, &i2s_config, I2S_QUEUE_SIZE, &i2s_queues[self->instance]));
+
+    if (!xTaskCreate(i2s_event_task, "I2S_task", 3 * configMINIMAL_STACK_SIZE, self, CONFIG_PTHREAD_TASK_PRIO_DEFAULT, &i2s_tasks[self->instance])) {
+        mp_raise_OSError_msg(translate("xTaskCreate failed"));
+    }
+    i2s_instance[self->instance] = self;
+
+}
+
+
+void port_i2s_play(i2s_t *self, mp_obj_t sample, bool loop) {
+    self->sample = sample;
+    self->loop = loop;
+    self->bytes_per_sample = audiosample_bits_per_sample(sample) / 8;
+    self->channel_count = audiosample_channel_count(sample);
+    bool single_buffer;
+    bool samples_signed;
+    uint32_t max_buffer_length;
+    uint8_t spacing;
+    audiosample_get_buffer_structure(sample, false, &single_buffer, &samples_signed,
+                                     &max_buffer_length, &spacing);
+    self->samples_signed = samples_signed;
+    self->playing = true;
+    self->paused = false;
+    self->stopping = false;
+    self->sample_data = self->sample_end = NULL;
+    // We always output stereo so output twice as many bits.
+    // uint16_t bits_per_sample_output = bits_per_sample * 2;
+
+    audiosample_reset_buffer(self->sample, false, 0);
+
+    CHECK_ESP_RESULT(i2s_set_sample_rates(self->instance, audiosample_sample_rate(sample)));
+
+    background_callback_add(&self->callback, i2s_callback_fun, self);
+}
+
+bool port_i2s_playing(i2s_t *self) {
+    return self->playing && !self->stopping;
+}
+
+bool port_i2s_paused(i2s_t *self) {
+    return self->paused;
+}
+
+void port_i2s_stop(i2s_t *self) {
+    self->sample = NULL;
+    self->paused = false;
+    self->playing = false;
+    self->stopping = false;
+}
+
+void port_i2s_pause(i2s_t *self) {
+    if (!self->paused) {
+        self->paused = true;
+        CHECK_ESP_RESULT(i2s_stop(self->instance));
+    }
+}
+
+void port_i2s_resume(i2s_t *self) {
+    if (self->paused) {
+        self->paused = false;
+        CHECK_ESP_RESULT(i2s_start(self->instance));
+    }
+}

ports/esp32s2/common-hal/audiobusio/__init__.h

@@ -0,0 +1,61 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 Jeff Epler for Adafruit Industries
+ *
+ * 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.
+ */
+
+#pragma once
+
+#include "py/obj.h"
+
+#include "supervisor/background_callback.h"
+
+#include "driver/i2s.h"
+
+typedef struct {
+    mp_obj_t *sample;
+    bool left_justified;
+    bool loop;
+    bool paused;
+    bool playing;
+    bool stopping;
+    bool samples_signed;
+    int8_t bytes_per_sample;
+    int8_t channel_count;
+    int8_t instance;
+    uint16_t buffer_length;
+    uint8_t *sample_data, *sample_end;
+    i2s_config_t i2s_config;
+    background_callback_t callback;
+} i2s_t;
+
+
+void port_i2s_allocate_init(i2s_t *self, bool left_justified);
+void port_i2s_reset_instance(int i);
+void i2s_reset(void);
+void port_i2s_play(i2s_t *self, mp_obj_t sample, bool loop);
+void port_i2s_stop(i2s_t *self);
+bool port_i2s_playing(i2s_t *self);
+bool port_i2s_paused(i2s_t *self);
+void port_i2s_pause(i2s_t *self);
+void port_i2s_resume(i2s_t *self);