1. makefile for mp to build the adf components

2. create audio module
3. create audio.player
4. create audio.recorder
5. examples for micropython

Author: JosephTang

.gitignore

@@ -44,3 +44,5 @@ docs/_static/NotoSansSC-Regular.otf
 *.gcno
 coverage.info
 coverage_report/
+
+.vscode

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "components/esp-sr"]
 	path = components/esp-sr
 	url = https://github.com/espressif/esp-sr.git
+[submodule "micropython_adf/micropython"]
+	path = micropython_adf/micropython
+	url = https://github.com/micropython/micropython.git

components/audio_stream/i2s_stream.c

@@ -51,6 +51,7 @@ typedef struct i2s_stream {
     bool                use_alc;
     void                *volume_handle;
     int                 volume;
+    bool                uninstall_drv;
 } i2s_stream_t;
 
 static esp_err_t i2s_mono_fix(int bits, uint8_t *sbuff, uint32_t len)
@@ -145,7 +146,9 @@ static esp_err_t _i2s_open(audio_element_handle_t self)
 static esp_err_t _i2s_destroy(audio_element_handle_t self)
 {
     i2s_stream_t *i2s = (i2s_stream_t *)audio_element_getdata(self);
-    i2s_driver_uninstall(i2s->config.i2s_port);
+    if (i2s->uninstall_drv) {
+        i2s_driver_uninstall(i2s->config.i2s_port);
+    }
     audio_free(i2s);
     return ESP_OK;
 }
@@ -335,6 +338,7 @@ audio_element_handle_t i2s_stream_init(i2s_stream_cfg_t *config)
     i2s->type = config->type;
     i2s->use_alc = config->use_alc;
     i2s->volume = config->volume;
+    i2s->uninstall_drv = config->uninstall_drv;
 
     if (config->type == AUDIO_STREAM_READER) {
         cfg.read = _i2s_read;

components/audio_stream/include/i2s_stream.h

@@ -48,6 +48,7 @@ typedef struct {
     int                     task_core;          /*!< Task running in core (0 or 1) */
     int                     task_prio;          /*!< Task priority (based on freeRTOS priority) */
     int                     multi_out_num;      /*!< The number of multiple output */
+    bool                    uninstall_drv;      /*!< whether uninstall the i2s driver when stream destroyed*/
 } i2s_stream_cfg_t;
 
 #define I2S_STREAM_TASK_STACK           (3072+512)
@@ -78,6 +79,7 @@ typedef struct {
     .use_alc = false,                                                           \
     .volume = 0,                                                                \
     .multi_out_num = 0,                                                         \
+    .uninstall_drv = true,                                                      \
 }
 
 

micropython_adf/README.md

@@ -0,0 +1,176 @@
+# Integrate the ADF components as parts of MicroPython
+
+## Prepare
+
+To use this integration, please read the [documents](https://github.com/micropython/micropython) of `MicroPython` and the [README](https://github.com/micropython/micropython/tree/master/ports/esp32) of `MicroPython port for ESP32` first.
+
+## Build and flash
+
+To build the project, please follow the steps below:
+
+* Clone `ESP-ADF`, `ESP-IDF`, into your workspace and update all the submodules.
+* MicroPython support HASH 'f301170c7cb50fdb9250a6e4b89682f9c0e543cb'.
+* ESP-IDF support HASH '6ccb4cf5b7d1fdddb8c2492f9cbc926abaf230df'.
+* `export ADF_PATH={ your ESP-ADF's path }`
+* `export IDF_PATH={ your ESP-IDF's path }`
+* `cd ${ADF_PATH}/micropyton_adf/micropython`, and apply the patch of `${ADF_PATH}/micropyton_adf/mpmake.patch`.
+* select your audio board in `${ADF_PATH}/micropyton_adf/sdkconfig.adf`.
+* `cd ${ADF_PATH}/micropyton_adf/micropython/mpy-cross`, run `make -j8`.
+* `cd ${ADF_PATH}/micropyton_adf/micropython/ports/esp32`, run `make deploy -j8 BOARD=GENERIC_SPIRAM BAUD=921600 PORT={ your uart port }`.
+
+## Libraries
+
+### `audio` - player and recorder
+
+This module implements player and recorder
+
+- player: encapsulates the ADF esp_audio, support local and online resources.
+- recorder: record and encoding the voice into file.
+
+NOTICE:
+> This a beta release as version '0.5-beta1',
+> Classes and methods may be changed by further release.
+
+#### Constructors
+
+- `class audio.player([state_callback])`
+
+  Create a player, `state_callback` is a monitor of player state, when state changed, this callback will be invoked.
+
+  ```python
+  def cb(state):
+      print(state) #'{{'media_src': 0, 'err_msg': 0, 'status': 1}}', media_src is reserved.
+
+  p = audio.player(cb)
+  # play music
+  ```
+
+- `class audio.recorder()`
+
+  Create recorder.
+
+  ```python
+  r = audio.recorder()
+  ```
+
+#### Functions
+
+- `audio.verno()`
+
+  version of audio module
+
+  ```python
+  >>> audio.verno()
+  '0.5-beta1'
+  ```
+
+- `audio.mem_info()`
+
+  Show memory usage.
+
+  ```Python
+  >>> audio.mem_info()
+  {'dram': 176596, 'inter': 212472, 'mem_total': 1197704}
+  ```
+
+#### Constants
+
+Audio error type:
+
+- `audio.AUDIO_OK`: ESP_ERR_AUDIO_NO_ERROR
+- `audio.AUDIO_FAIL` : ESP_ERR_AUDIO_FAIL
+- `audio.AUDIO_NO_INPUT_STREAM` : ESP_ERR_AUDIO_NO_INPUT_STREAM
+- `audio.AUDIO_NO_OUTPUT_STREAM` : ESP_ERR_AUDIO_NO_OUTPUT_STREAM
+- `audio.AUDIO_NO_CODEC` : ESP_ERR_AUDIO_NO_CODEC
+- `audio.AUDIO_HAL_FAIL` : ESP_ERR_AUDIO_HAL_FAIL
+- `audio.AUDIO_MEMORY_LACK` : ESP_ERR_AUDIO_MEMORY_LACK
+- `audio.AUDIO_INVALID_URI` : ESP_ERR_AUDIO_INVALID_URI
+- `audio.AUDIO_INVALID_PARAMETER` : ESP_ERR_AUDIO_INVALID_PARAMETER
+- `audio.AUDIO_NOT_READY` : ESP_ERR_AUDIO_NOT_READY
+- `audio.AUDIO_TIMEOUT` : ESP_ERR_AUDIO_TIMEOUT
+- `audio.AUDIO_ALREADY_EXISTS` : ESP_ERR_AUDIO_ALREADY_EXISTS
+- `audio.AUDIO_LINK_FAIL` : ESP_ERR_AUDIO_LINK_FAIL
+- `audio.AUDIO_OPEN` : ESP_ERR_AUDIO_OPEN
+- `audio.AUDIO_INPUT` : ESP_ERR_AUDIO_INPUT
+- `audio.AUDIO_PROCESS` : ESP_ERR_AUDIO_PROCESS
+- `audio.AUDIO_OUTPUT` : ESP_ERR_AUDIO_OUTPUT
+- `audio.AUDIO_CLOSE` : ESP_ERR_AUDIO_CLOSE
+
+### class `audio.player`
+
+Audio player now can support `mp3`,`amr` and `wav`, if more types are needed, please add the decoder in function `audio_player_create`.
+
+#### Methods
+
+- `player.play(uri, pos=0, sync=False)`
+  Play the `uri` from specified position. if `sync = True`, the thread will be suspended until the music finished. `uri` formated as "file://sdcard/test.wav" or "https://dl.espressif.com/dl/audio/ff-16b-2c-44100hz.mp3".
+
+- `player.stop(termination=player.TERMINATION_NOW)`
+  Stop the player
+
+- `player.pause()`
+  Pause the player
+
+- `player.resume()`
+  Resume the player
+
+- `player.set_vol(vol)`
+  Set the volume of the audio board.
+
+- `player.get_vol()`
+  Get the volume of the audio board.
+
+- `player.get_state()`
+  Get the state of the player.
+
+  ```python
+  >>> p = audio.player(None)
+  >>> p.get_state()
+  {'media_src': 0, 'err_msg': 0, 'status': 0}
+  ```
+
+- `player.pos()`
+  Get the position in bytes of currently played music.
+
+- `player.time()`
+  Get the position in microseconds of currently played music.
+
+#### Constants
+
+Player termination type:
+
+- `TERMINATION_NOW`: TERMINATION_TYPE_NOW
+- `TERMINATION_DONE`: TERMINATION_TYPE_DONE
+
+Player status type:
+
+- `STATUS_UNKNOWN`: AUDIO_STATUS_UNKNOWN
+- `STATUS_RUNNING`: AUDIO_STATUS_RUNNING
+- `STATUS_PAUSED`: AUDIO_STATUS_PAUSED
+- `STATUS_STOPPED`: AUDIO_STATUS_STOPPED
+- `STATUS_FINISHED`: AUDIO_STATUS_FINISHED
+- `STATUS_ERROR`: AUDIO_STATUS_ERROR
+
+### class `audio.recorder`
+
+#### Methods
+
+- `recorder.start(path, format=PCM, maxtime=0, endcb=None)`
+  Start the recorder and save the voice into `path` with encoding the date as `format`.
+  If `maxtime` > 0, recorder will stop automatic when the duration passed, `endcb` will be invoked if not `None`.
+  If `maxtime` == 0, recorder will work until `recorder.stop()` is called.
+
+- `recorder.stop()`
+  Stop recording.
+
+- `recorder.is_running()`
+  Get the state of recorder, `Bool`.
+
+#### Constants
+
+format of final data:
+
+- `recorder.PCM`
+- `recorder.AMR`
+- `recorder.MP3`
+- `recorder.WAV`