README_zh.md · miaochuang/drivers_peripheral_format

# Format<a name="ZH-CN_TOPIC_0000001131858907"></a>

-   [简介](#section11660541593)
-   [目录](#section161941989596)
    -   [接口说明](#section1551164914237)
    -   [使用说明](#section129654513264)

-   [相关仓](#section1371113476307)

## 简介<a name="section11660541593"></a>

该仓下主要包含Format模块HDI（Hardware Driver Interface）接口定义及其实现，对上层提供媒体文件复用和解复用的驱动能力接口，HDI接口主要提供如下功能：

-   创建、销毁复用和解复用器对象；
-   启停复用和解复用器
-   获取片源属性；
-   获取片源流数据帧信息
-   添加流和数据帧到复用器。

## 目录<a name="section161941989596"></a>

该仓下源代码目录结构如下所示

```
/drivers/peripheral/format
├── interfaces         # format模块对上层服务提供的驱动能力接口
│   └── include       # format模块对外提供的接口定义
```

### 接口说明<a name="section1551164914237"></a>

Format驱动提供给framework层可直接调用的能力接口，主要功能有：创建、销毁复用器和解复用器对象，启停复用和解复用操作、获取片源属性、从片源读取数据帧处理、添加流和数据帧到复用器、事件上报等

提供的部分接口说明如[表1 Format HDI接口列表](#table1513255710559)所示：

**表 1**  Format HDI接口列表

<a name="table1513255710559"></a>
<table><thead align="left"><tr id="row171321857155517"><th class="cellrowborder" align="center" valign="top" width="12.821282128212822%" id="mcps1.2.4.1.1"><a name="p6132957115511"></a><a name="p6132957115511"></a>头文件
</th>
<th class="cellrowborder" align="center" valign="top" width="62.16621662166217%" id="mcps1.2.4.1.2"><a name="p14132125715552"></a><a name="p14132125715552"></a>接口名称
</th>
<th class="cellrowborder" align="center" valign="top" width="25.012501250125013%" id="mcps1.2.4.1.3"><a name="p18132205755516"></a><a name="p18132205755516"></a>功能描述
</th>
</tr>
</thead>
<tbody><tr id="row1267017500274"><td class="cellrowborder" rowspan="34" align="left" valign="top" width="12.821282128212822%" headers="mcps1.2.4.1.1 "><a name="p15674038913"></a><a name="p15674038913"></a>
<a name="p169466917181"></a><a name="p169466917181"></a>
<a name="p12106161012185"></a><a name="p12106161012185"></a>
<a name="p7255161017181"></a><a name="p7255161017181"></a>
<a name="p1839901041815"></a><a name="p1839901041815"></a>
<a name="p4540171015188"></a><a name="p4540171015188"></a>
<a name="p368816102189"></a><a name="p368816102189"></a>
<a name="p679481051814"></a><a name="p679481051814"></a>
<a name="p7399191241817"></a><a name="p7399191241817"></a>
<a name="p11902121271818"></a><a name="p11902121271818"></a>
<a name="p1296415129182"></a><a name="p1296415129182"></a>
<a name="p1742101311180"></a><a name="p1742101311180"></a>
<a name="p171041613101815"></a><a name="p171041613101815"></a>
<a name="p10172141314183"></a><a name="p10172141314183"></a>
<a name="p723216132180"></a><a name="p723216132180"></a>
<a name="p825185015460"></a><a name="p825185015460"></a>format_interface.h
<a name="p2133757135510"></a><a name="p2133757135510"></a>
<a name="p14171441118"></a><a name="p14171441118"></a>
<a name="p57063567463"></a><a name="p57063567463"></a>
<a name="p1285144710118"></a><a name="p1285144710118"></a>
<a name="p854114711117"></a><a name="p854114711117"></a>
<a name="p15741647517"></a><a name="p15741647517"></a>
<a name="p7909447418"></a><a name="p7909447418"></a>
<a name="p12525910165811"></a><a name="p12525910165811"></a>
<a name="p942322013262"></a><a name="p942322013262"></a>
<a name="p1040515339526"></a><a name="p1040515339526"></a>
<a name="p19405533115216"></a><a name="p19405533115216"></a>
</td>
<td class="cellrowborder" valign="top" width="62.16621662166217%" headers="mcps1.2.4.1.2 "><a name="p6264341172811"></a><a name="p6264341172811"></a>void FormatInit(void);
</td>
<td class="cellrowborder" valign="top" width="25.012501250125013%" headers="mcps1.2.4.1.3 "><a name="p13264114182817"></a><a name="p13264114182817"></a>模块初始化处理
</td>
</tr>
<tr id="row2661171172814"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p126514172811"></a><a name="p126514172811"></a>void FormatDeInit(void);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p15265164122819"></a><a name="p15265164122819"></a>模块去初始化处理
</td>
</tr>
<tr id="row4385112822818"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p10265134111284"></a><a name="p10265134111284"></a>int32_t FormatDemuxerCreate(const FormatSource *source, void **handle);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p726554110289"></a><a name="p726554110289"></a>创建解复用器对象
</td>
</tr>
<tr id="row181371630162816"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p426517411284"></a><a name="p426517411284"></a>int32_t FormatDemuxerSetParameter(const void *handle, int32_t trackId, const ParameterItem *metaData, int32_t metaDataCnt);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p1926512413287"></a><a name="p1926512413287"></a>扩展接口，设置解复用器属性信息
</td>
</tr>
<tr id="row01531026142811"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p182651741162812"></a><a name="p182651741162812"></a>int32_t FormatDemuxerGetParameter(const void *handle, int32_t trackId, ParameterItem *metaData);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p142651241152813"></a><a name="p142651241152813"></a>扩展接口，获取解复用器属性信息
</td>
</tr>
<tr id="row11460182372815"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p1626534118284"></a><a name="p1626534118284"></a>int32_t FormatDemuxerSetCallBack(void *handle, const FormatCallback *callBack);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p72661241112817"></a><a name="p72661241112817"></a>设置回调函数接口，用于事件上报
</td>
</tr>
<tr id="row61462216285"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p526624122817"></a><a name="p526624122817"></a>int32_t FormatDemuxerSetBufferConfig(void *handle, const FormatBufferSetting *setting);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p14266114119283"></a><a name="p14266114119283"></a>设置解复用器数据帧缓存大小信息（可选）
</td>
</tr>
<tr id="row791355812713"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p15266144111283"></a><a name="p15266144111283"></a>int32_t FormatDemuxerGetBufferConfig(const void *handle, FormatBufferSetting *setting);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p162661841172812"></a><a name="p162661841172812"></a>获取解复用器数据帧缓存大小信息（可选）
</td>
</tr>
<tr id="row3731175622711"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p1526664162814"></a><a name="p1526664162814"></a>int32_t FormatDemuxerPrepare(void *handle);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p6266941142816"></a><a name="p6266941142816"></a>准备工作处理，完成片源属性探测处理
</td>
</tr>
<tr id="row131131754172718"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p5266104113281"></a><a name="p5266104113281"></a>int32_t FormatDemuxerGetFileInfo(void *handle, FileInfo *info);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p13266341202815"></a><a name="p13266341202815"></a>获取片源属性。
</td>
</tr>
<tr id="row133541652202712"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p1826619419281"></a><a name="p1826619419281"></a>int32_t FormatDemuxerSelectTrack(const void *handle, int32_t programId, int32_t trackId);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p182671341102811"></a><a name="p182671341102811"></a>选择某个轨道。（通过FormatDemuxerReadFrame接口可以读取到对应轨道数据帧）
</td>
</tr>
<tr id="row148624820271"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p17267341102812"></a><a name="p17267341102812"></a>int32_t FormatDemuxerUnselectTrack(const void *handle, int32_t programId, int32_t trackId);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p1267141192812"></a><a name="p1267141192812"></a>不选择某个轨道。（通过FormatDemuxerReadFrame接口不会读取到对应轨道数据帧）
</td>
</tr>
<tr id="row1676314450275"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p02671641122810"></a><a name="p02671641122810"></a>int32_t FormatDemuxerStart(void *handle);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p3267104112289"></a><a name="p3267104112289"></a>启动工作。调用该接口后可读取到数据帧处理
</td>
</tr>
<tr id="row194281341102710"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p1526719418280"></a><a name="p1526719418280"></a>int32_t FormatDemuxerGetSelectedTrack(const void *handle, int32_t *programId, int32_t trackId[], int32_t *nums);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p142671441122820"></a><a name="p142671441122820"></a>获取当前已选择的轨道
</td>
</tr>
<tr id="row560213915277"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p1268641112812"></a><a name="p1268641112812"></a>int32_t FormatDemuxerReadFrame(const void *handle, FormatFrame *frame, int32_t timeOutMs);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p18268174192819"></a><a name="p18268174192819"></a>读取数据帧
</td>
</tr>
<tr id="row933244161410"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p15483141102218"></a><a name="p15483141102218"></a>int32_t FormatDemuxerFreeFrame(void *handle, FormatFrame *frame);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p15484194152211"></a><a name="p15484194152211"></a>释放数据帧
</td>
</tr>
<tr id="row182432045121416"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p0484241102215"></a><a name="p0484241102215"></a>int32_t FormatDemuxerSeek(const void *handle, int32_t streamIndex, int64_t timeStampUs, FormatSeekMode mode);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p10484641162215"></a><a name="p10484641162215"></a>拖动到指定位置附近
</td>
</tr>
<tr id="row122643187161"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p14842418228"></a><a name="p14842418228"></a>int32_t FormatDemuxerStop(void *handle);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p9484124132212"></a><a name="p9484124132212"></a>解复用器停止工作
</td>
</tr>
<tr id="row1168154414167"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p948418417222"></a><a name="p948418417222"></a>int32_t FormatDemuxerDestory(void *handle);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p6484174172215"></a><a name="p6484174172215"></a>销毁解复用器对象
</td>
</tr>
<tr id="row565634691619"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p124840414221"></a><a name="p124840414221"></a>int32_t FormatMuxerCreate(void **handle, FormatOutputConfig *outputConfig);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p184841741192215"></a><a name="p184841741192215"></a>创建复用器对象
</td>
</tr>
<tr id="row1586205081614"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p1348474117228"></a><a name="p1348474117228"></a>int32_t FormatMuxerDestory(const void *handle);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p848464120229"></a><a name="p848464120229"></a>销毁复用器对象
</td>
</tr>
<tr id="row1815361272220"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p1948574113229"></a><a name="p1948574113229"></a>int32_t FormatMuxerAddTrack(void *handle, const TrackSource *trackSource);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p1248524162220"></a><a name="p1248524162220"></a>添加复用器流
</td>
</tr>
<tr id="row14720016182214"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p12485184152211"></a><a name="p12485184152211"></a>int32_t FormatMuxerSetCallBack(void *handle, const FormatCallback *callBack);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p5485114114229"></a><a name="p5485114114229"></a>设置复用器回调函数
</td>
</tr>
<tr id="row1466424191620"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p164854415224"></a><a name="p164854415224"></a>int32_t FormatMuxerSetOrientation(void *handle, int degrees);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p948534113222"></a><a name="p948534113222"></a>设置视频角度信息
</td>
</tr>
<tr id="row99291794226"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p10485154119227"></a><a name="p10485154119227"></a>int32_t FormatMuxerSetLocation(const void *handle, int latitude, int longitude);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p144851241102210"></a><a name="p144851241102210"></a>设置地理位置信息
</td>
</tr>
<tr id="row21561639131614"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p24851941172211"></a><a name="p24851941172211"></a>int32_t FormatMuxerSetMaxFileSize(void *handle, int64_t bytes);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p12485124132219"></a><a name="p12485124132219"></a>设置复用器生成文件最大SIZE
</td>
</tr>
<tr id="row1024914496149"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p9485164152218"></a><a name="p9485164152218"></a>int32_t FormatMuxerSetMaxFileDuration(void *handle, int64_t durationUs);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p1548519411228"></a><a name="p1548519411228"></a>设置复用器生成文件最大时长
</td>
</tr>
<tr id="row5647191181614"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p948515417222"></a><a name="p948515417222"></a>int32_t FormatMuxerSetFileSplitDuration(const void *handle, ManualSplitType type, int64_t timestampUs, uint32_t durationUs);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p9486441142216"></a><a name="p9486441142216"></a>设置手动切分片信息
</td>
</tr>
<tr id="row96242146164"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p1448614116229"></a><a name="p1448614116229"></a>int32_t FormatMuxerStart(void *handle);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p448624162217"></a><a name="p448624162217"></a>复用器启动工作
</td>
</tr>
<tr id="row4719558166"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p448664112224"></a><a name="p448664112224"></a>int32_t FormatMuxerWriteFrame(const void *handle, const FormatFrame *frameData);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p114869411222"></a><a name="p114869411222"></a>写入数据帧
</td>
</tr>
<tr id="row18785159171611"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p148624112222"></a><a name="p148624112222"></a>int32_t FormatMuxerSetNextOutputFile(const void *handle, int32_t fd);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p6486164113221"></a><a name="p6486164113221"></a>设置下一个输出文件句柄fd
</td>
</tr>
<tr id="row119401052191419"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p14486204116224"></a><a name="p14486204116224"></a>int32_t FormatMuxerStop(const void *handle, bool block);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p648612417226"></a><a name="p648612417226"></a>复用器停止工作
</td>
</tr>
<tr id="row1244610316169"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p14861341192214"></a><a name="p14861341192214"></a>int32_t FormatMuxerSetParameter(void *handle, int32_t trackId, const ParameterItem *item, int32_t itemNum);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p1486134102210"></a><a name="p1486134102210"></a>扩展接口，设置复用器属性
</td>
</tr>
<tr id="row17305165551410"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><a name="p1448654102214"></a><a name="p1448654102214"></a>int32_t FormatMuxerGetParameter(void *handle, int32_t trackId, ParameterItem *item, int32_t itemNum);
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><a name="p348617419229"></a><a name="p348617419229"></a>扩展接口，获取复用器属性
</td>
</tr>
</tbody>
</table>

### 使用说明<a name="section129654513264"></a>

该仓核心功能包括两个方面：

-   提供Format HDI接口供framework层调用，实现片源复用与解复用功能。
-   作为标准南向接口，保证南向OEM产商实现HDI-adapter的规范性，保证生态良性演进。

具体接口调用及实现，以接口注释为准。

## 相关仓<a name="section1371113476307"></a>

驱动子系统

**hmf/drivers/peripheral/Format**

miaochuang/drivers_peripheral_format

About

Releases

Contributors

Activities