Sophon-Stream 项目使用教程

Sophon-Stream 项目使用教程

sophon-stream 项目地址: https://gitcode.com/gh_mirrors/so/sophon-stream

1. 项目目录结构及介绍

sophon-stream 项目是一个面向算丰开发平台的数据流处理工具，其目录结构如下：

• 3rdparty: 第三方库和依赖文件
• docs: 项目文档
• element: 包含各种算法插件，如 yolov5、yolov7、yolov8、yolox、bytetrack 等
• framework: 项目框架核心代码
• samples: 示例程序和脚本
• scripts: 项目构建和部署脚本
• tools: 工具类文件
• .gitignore: Git 忽略文件列表
• CMakeLists.txt: CMake 构建脚本
• Doxyfile: Doxygen 文档生成配置文件
• LICENSE: 项目许可证文件
• README.md: 项目介绍和说明文件
• README_EN.md: 项目介绍和说明文件的英文版
• VERSION: 项目版本文件

2. 项目的启动文件介绍

项目的启动文件通常位于 samples 目录下，例如 yolov5_demo、yolov7_demo 等。这些示例程序是用于展示如何使用 sophon-stream 的基础功能。以下是启动 yolov5 示例的一个基本步骤：

1. 确保已经安装了所有必要的依赖和第三方库。
2. 使用 CMake 构建项目。
3. 运行构建出的示例程序。

cd samples/yolov5
mkdir build && cd build
cmake ..
make
./yolov5_demo

3. 项目的配置文件介绍

sophon-stream 的配置文件通常为 JSON 格式，位于 samples 目录下的对应示例文件夹中。配置文件定义了算法插件的参数、数据流的处理流程等。以下是一个基本的配置文件示例：

{
  "plugins": [
    {
      "type": "decode",
      "enable": true,
      "params": {
        "input_type": "rtsp",
        "input_url": "rtsp://example.com/stream"
      }
    },
    {
      "type": "yolov5",
      "enable": true,
      "params": {
        "model_path": "./models/yolov5.onnx",
        "conf_threshold": 0.5,
        "nms_threshold": 0.4
      }
    },
    {
      "type": "osd",
      "enable": true
    },
    {
      "type": "encode",
      "enable": true,
      "params": {
        "output_type": "mp4",
        "output_url": "./output.mp4"
      }
    }
  ]
}

在这个配置文件中，定义了一个解码插件、一个 yolov5 算法插件、一个算法结果可视化插件和一个编码插件。每个插件的配置包括类型、是否启用以及相关的参数。用户可以根据自己的需求修改这些配置。

sophon-stream 项目地址: https://gitcode.com/gh_mirrors/so/sophon-stream