English | 简体中文
本例程用于说明如何使用sophon-stream快速构建包含了多算法和按类别发往不同分支的复杂应用。
- 检测模型使用retinaface；
- 人脸特征模型使用resnet；
- 人脸识别使用faiss；
- 支持BM1684X(x86 PCIe、SoC)；
- 支持多路视频流；
- 支持多线程。
在scripts目录下提供了相关模型和数据的下载脚本 download.sh。
# 安装unzip，若已安装请跳过，非ubuntu系统视情况使用yum或其他方式安装
sudo apt install unzip
chmod -R +x scripts/
./scripts/download.sh脚本执行完毕后，会在当前目录下生成data目录，其中包含models、face_data、image三个子目录。
下载的模型包括：
./models
└── BM1684X
├── resnet_arcface_fp32_1b.bmodel # resnet人脸特征提取模型
└── retinaface_mobilenet0.25_fp32_1b.bmodel # BM1684X FP32人脸检测模型下载的数据包括：
├── class.names # distributor 分类标签
├── face_data
│ ├── faiss_db_data.txt # 数据库人脸特征
│ └── faiss_index_label.name # 数据库的人脸label
├── images
│ ├── face_data_test # 测试用的数据集
│ └── face_data_train # 生成数据库用的数据如果您在x86/arm平台安装了PCIe加速卡（如SC系列加速卡），可以直接使用它作为开发环境和运行环境。您需要安装libsophon、sophon-opencv和sophon-ffmpeg，具体步骤可参考x86-pcie平台的开发和运行环境搭建或arm-pcie平台的开发和运行环境搭建。
如果您使用SoC平台（如SE、SM系列边缘设备），刷机后在/opt/sophon/下已经预装了相应的libsophon、sophon-opencv和sophon-ffmpeg运行库包，可直接使用它作为运行环境。通常还需要一台x86主机作为开发环境，用于交叉编译C++程序。
程序运行前需要编译可执行文件。
可以直接在PCIe平台上编译程序，具体请参考sophon-stream编译
通常在x86主机上交叉编译程序，您需要在x86主机上使用SOPHON SDK搭建交叉编译环境，将程序所依赖的头文件和库文件打包至sophon_sdk_soc目录中，具体请参考sophon-stream编译。本例程主要依赖libsophon、sophon-opencv和sophon-ffmpeg运行库包。
配置文件位于 ./config目录，结构如下所示：
./config
├── converger.json # 汇聚element配置
├── decode.json # 解码配置
├── distributor_class.json # 每帧按类别分发
├── distributor_frame_class.json # 跳帧按类别分发
├── distributor_frame.json # 跳帧分发full frame
├── distributor_time_class.json # 间隔时间按类别分发（默认）
├── distributor_time.json # 间隔时间分发full frame
├── engine.json # graph配置
├── engine_group.json # 简化的graph配置
├── faiss.json # faiss配置
├── resnet_face.json # resnet 人脸分类
├── retinaface_distributor_resnet_faiss.json # demo配置
├── retinaface_group.json # 简化的retinaface配置文件，管理前处理、推理、后处理三个步骤
├── retinaface_infer.json # retinaface 推理配置
├── retinaface_post.json # retinaface 后处理配置
└── retinaface_pre.json # retinaface 前处理配置其中，retinaface_distributor_resnet_faiss.json是例程的整体配置文件，管理输入码流等信息。在一张图上可以支持多路数据的输入，channels参数配置输入的路数，channel中包含码流url等信息。
配置文件中不指定channel_id属性的情况，会在demo中对每一路数据的channel_id从0开始默认赋值。
{
"channels": [
{
"channel_id": 0,
"url": "../retinaface_distributor_resnet_faiss_converger/data/images/face_data_test",
"source_type": "IMG_DIR",
"loop_num": 1,
"sample_interval": 1,
"fps": -1
},
{
"channel_id": 1,
"url": "../retinaface_distributor_resnet_faiss_converger/data/images/face_data_test",
"source_type": "IMG_DIR",
"loop_num": 1,
"sample_interval": 1,
"fps": -1
},
{
"channel_id": 2,
"url": "../retinaface_distributor_resnet_faiss_converger/data/images/face_data_test",
"source_type": "IMG_DIR",
"loop_num": 1,
"sample_interval": 1,
"fps": -1
},
{
"channel_id": 3,
"url": "../retinaface_distributor_resnet_faiss_converger/data/images/face_data_test",
"source_type": "IMG_DIR",
"loop_num": 1,
"sample_interval": 1,
"fps": -1
}
],
"download_image": true,
"draw_func_name": "draw_retinaface_distributor_resnet_faiss_converger_results",
"engine_config_path": "../retinaface_distributor_resnet_faiss_converger/config/engine_group.json"
}engine.json包含对graph的配置信息，这部分配置确定之后基本不会发生更改。
在该文件内，需要初始化每个element的信息和element之间的连接方式。element_id是唯一的，起到标识身份的作用。element_config指向该element的详细配置文件地址，port_id是该element的输入输出端口编号，多输入或多输出的情况下，输入/输出编号也不可以重复。is_src标志当前端口是否是整张图的输入端口，is_sink标识当前端口是否是整张图的输出端口。 connection是所有element之间的连接方式，通过element_id和port_id确定。
retinaface_group.json等配置文件是对具体某个element的配置细节，设置了模型参数、动态库路径、阈值等信息。该配置文件不需要指定id字段和device_id字段，例程会将engine.json中指定的element_id和device_id传入。其中，thread_number是element内部的工作线程数量，一个线程会对应一个数据队列，多路输入情况下，需要合理设置数据队列数目，来保证线程工作压力均匀且合理。
对于PCIe平台，可以直接在PCIe平台上运行测试；对于SoC平台，需将交叉编译生成的动态链接库、可执行文件、所需的模型和测试数据拷贝到SoC平台中测试。
SoC平台上，动态库、可执行文件、配置文件、模型、视频数据的目录结构关系应与原始sophon-stream仓库中的关系保持一致。
测试的参数及运行方式是一致的，下面主要以PCIe模式进行介绍。
运行可执行文件
./main --demo_config_path=../retinaface_distributor_resnet_faiss_converger/config/retinaface_distributor_resnet_faiss_converger.json运行结果存放在./build/results目录下。本例程默认配置方式为每秒按类别发送到resnet分支，会在结果目录中每秒保存一帧绘制人脸label图像。
由于全流程依赖输入视频fps且画图速度慢，本例程暂不提供性能测试结果，如需各模型推理性能，请到对应模型例程查看。
该例程中，通过对比resnet模型输出的向量与faiss索引库中已有的向量进行对比，返回人脸索引，然后通过索引获取对应的人脸标签。这里，我们也提供生成人脸数据库的方法，具体方法如下：
python3 scripts/resnet_opencv_faiss_write.py --input data/images/face_data_train --bmodel data/models/BM1684X/resnet_arcface_fp32_1b.bmodel --db_data faiss_db_data.txt --index_label faiss_index_label.name --dev_id 0 参数说明如下：
usage:resnet_opencv_faiss_write.py [--input IMG_PATH] [--bmodel BMODEL] [--db_data DB_DATA] [--index_label INDEX_LABEL] [--dev_id DEV_ID]
--input: 推理图片路径，可输入整个图片文件夹的路径；
--bmodel: 用于推理的bmodel路径，默认使用stage 0的网络进行推理；
--db_data: 输出的人脸数据库；
--index_label: 输出数据库中索引对应的人脸标签文件；
--dev_id: 用于推理的tpu设备id。