# LynxFlow

**Repository Path**: Lynxi/lynxflow

## Basic Information

- **Project Name**: LynxFlow
- **Description**: Lynxi开源LynxFlow代码库
- **Primary Language**: Python
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-09
- **Last Updated**: 2026-03-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Lynxflow

基于 GStreamer 与 Lynxi SDK 的视频流与视觉分析流水线框架，提供自定义 GStreamer 插件、流水线管理与多种视觉分析示例应用。

本项目采用 [BSD 3-Clause License](LICENSE) 开源，版权归 Lynxi Technologies Co., Ltd. 所有。部分功能使用第三方代码，详见 [第三方代码与许可说明](THIRD_PARTY_LICENSES.md)。

---

## 功能概览

- **GStreamer 插件**（`gstplugin/`）：视频源/解码/编码、多路复用、模型推理、检测/分类/属性/OCR/跟踪等后处理、OSD、图像处理等
- **流水线管理**（`streammanager/`）：基于 JSON 配置的 Pipeline 解析与运行时管理，支持多路输入与插件链式编排
- **示例应用**（`applications/`）：目标检测、人脸属性、车辆属性/跟踪/车牌、图像 OCR、动态源与算法等视觉分析 demo

---

## 环境依赖

| 依赖 | 说明 |
|------|------|
| **OS** | Ubuntu18.04/Ubuntu20.04 |
| **GStreamer** | 1.20.6 |
| **Meson** | >= 0.54.1，用于配置项目并生成构建文件 |
| **Ninja** | >= 1.8，用于执行 Meson 生成的编译与链接任务 |
| **Lynxi SDK & Driver** | >= 1.17.0，Lynxi 官方 SDK 与驱动（需预先安装至系统，如 `/usr/local/lynxi/sdk`） |
| **OpenCV** | >= 3.3 |

请先安装 GStreamer、Meson、Ninja 及 Lynxi SDK/Driver，再编译本工程。

---

## 编译与安装

```bash
# 1. 进入工程根目录，配置构建（安装前缀可选，默认 /usr）
meson build --prefix=/usr

# 2. 编译并安装
sudo ninja -C build install
```

- 编译成功后，GStreamer 插件将安装到：`<prefix>/lib/x86_64-linux-gnu/gstreamer-1.0/`（x86_64系统）或者`<prefix>/lib/aarch64-linux-gnu/gstreamer-1.0/`(arm64系统)，具体路径随 `--prefix` 与系统而定。
- 测试与示例程序将安装到：`<prefix>/bin`（如 `/usr/bin`）。

---

## 测试与运行

1. **准备测试数据**：从Lynxi技术支持获取测试媒体/模型文件。
2. **运行测试**：    
   - 参考 `applications/visual_analysis`，`streammanager/test` 及 `gstplugin/tests` 下各子目录中的 README 与 pipeline 配置（如 `streammanager/test/pipeline/config/detection_video.pipeline`）执行相应命令。

Pipeline 配置为 JSON 格式，可指定视频源、解码、多路复用、推理与后处理等插件及连接关系。

---

## 目录结构

```
Lynxflow/
├── gstplugin/          # GStreamer 插件实现与公共库
├── streammanager/      # 流水线解析、插件管理、Pipeline 运行时
├── applications/       # 视觉分析示例应用（检测、OCR、车辆、人脸等）
├── thirdparty/         # 第三方依赖（如 lynsdk、json、eigen 等）
├── docs/               # 项目文档
├── meson.build         # 顶层 Meson 配置
├── LICENSE                  # BSD 3-Clause
├── THIRD_PARTY_LICENSES.md  # 第三方代码与许可说明
└── README.md
```