jason-mao/gmf_io

readme

# ESP-GMF-IO

- [![Component Registry](https://components.espressif.com/components/espressif/esp_gmf_io/badge.svg)](https://components.espressif.com/components/espressif/esp_gmf_io)

## 简介

GMF IO 是 ESPressif 提供的 GMF 输入和输出流的集合。IO 流有读写两个数据流方向，输入类型为可读，输出类型为可写。IO 流对数据传输类型进行了分类，分别是字节访问和块访问类型，一般来说，字节访问类型传递数据是数据拷贝，块访问的数据传递是地址传递，无数据拷贝。另外，IO 流还提供了线程的配置可选项，使一些 IO Stream 可以建立自己独立的线程。目前已支持的 IO 流参见下表。

| 名称 | 数据流方向   | Thread | 数据类型| 依赖的组件  | 备注 |
| :----: | :----: | :----: | :----: | :----: |:----: |
|  File | RW  |  NO |  Byte  |NA  | NA |
|  HTTP |  RW | YES | Block | NA  | Not support HTTP Live Stream |
|  Codec Dev IO |  RW | NO | Byte | [ESP codec dev](https://components.espressif.com/components/espressif/esp_codec_dev/versions/1.3.1)  | NA |
|  Embed Flash |  R | NO | Byte | NA  | NA |
|  I2S PDM |  RW | NO | Byte | NA  | NA |

## Usage
GMF IO 一般与 Element 组成 Pipeline 进行使用，也可以独立使用。在 Pipeline 中，IO stream 与 Element 的 Port 连接，独立使用时调用 IO stream 使用 GMF_IO 接口。 示例代码请参考 test_app。