Haivision/SRT开发者指南：从环境搭建到代码贡献全解析

前言

SRT（Secure Reliable Transport）是一种开源视频传输协议技术，由Haivision开发并维护。作为开发者，深入了解SRT的开发流程和规范对于参与项目贡献至关重要。本文将全面介绍SRT项目的开发环境搭建、项目结构、版本管理以及代码贡献规范。

开发环境搭建

依赖安装

在开始SRT开发前，需要确保系统已安装以下基础工具：

1. Git：版本控制系统，用于代码管理和协作开发
2. CMake：跨平台构建工具，建议使用v2.8.12或更高版本
3. OpenSSL：加密库，v1.1.0或更高版本，也可使用Nettle和mbedTLS替代

对于macOS用户，还需要额外配置OpenSSL路径：

export OPENSSL_ROOT_DIR=$(brew --prefix openssl)
export OPENSSL_LIB_DIR=$(brew --prefix openssl)"/lib"
export OPENSSL_INCLUDE_DIR=$(brew --prefix openssl)"/include"

获取源代码

通过以下步骤获取SRT源代码：

git clone https://<your-repository>/srt.git srt
cd srt
git remote add upstream "https://<main-repository>/srt.git"

构建SRT

SRT使用CMake作为构建系统，构建步骤如下：

mkdir _build && cd _build
cmake .. -DENABLE_UNITTESTS=ON
cmake --build ./

构建完成后，在_build目录下会生成以下关键应用程序：

• srt-live-transmit：实时流传输示例应用
• srt-file-transmit：文件传输示例应用
• srt-tunnel：SRT隧道应用
• tests-srt：单元测试程序

Windows用户注意：Windows平台有特定的构建要求，请参考专门的Windows构建文档。

语言标准要求

SRT项目对编程语言标准有严格要求：

1. SRT核心库：要求C++03标准（兼容C++98）
2. 示例代码：支持C++03或C89标准
3. 以下组件需要C++11标准：
   • 演示应用程序
   • 测试应用程序
   • 单元测试

如果使用不支持C++11的旧编译器，可以通过以下CMake选项进行配置：

-DENABLE_APPS=0 -DUSE_CXX_STD=03 -DENABLE_EXAMPLES=1

项目结构解析

SRT项目采用模块化设计，主要目录结构如下：

srt/
├── apps/                # 示例应用程序
├── common/              # 平台相关代码
├── docs/                # 项目文档
├── examples/            # 示例代码
├── haicrypt/            # 加密相关代码
├── scripts/             # 构建脚本
├── srtcore/             # SRT核心库代码
├── test/                # 单元测试
└── testing/             # 开发测试工具

版本管理策略

SRT采用主版本.次版本.补丁版本的版本号格式（如v1.4.3）。版本管理有以下特点：

1. 补丁版本更新：通常包含不影响API/ABI兼容性的改进和错误修复，可安全升级
2. 次版本更新：可能包含不兼容变更，升级需谨慎并进行充分测试

从SRT v1.4.3开始，动态库命名采用主版本.次版本后缀（如libsrt.so.1.4），这种设计使得：

• 补丁版本升级更安全
• 次版本升级需要显式决策

代码贡献流程

提交问题

发现问题时，可通过以下方式提交：

1. 创建问题报告
2. 在社区Slack频道的#general或#development中讨论

提交Pull Request

贡献代码需遵循以下规范：

1. 提交信息格式：[<标签>] <描述>
   • 常用标签：[core]、[tests]、[build]、[apps]、[docs]
2. 合并策略：推荐使用rebase方式合并
3. 多提交处理：若PR包含多个提交，应保持结构清晰

生成文件说明

项目中部分文件是自动生成的，修改时需特别注意：

日志功能区域

SRT日志系统包含功能区域(FA)概念，允许开发者选择性启用特定类型的日志。添加新的FA需要：

1. 修改generate-logging-defs.tcl脚本
2. 在loggers列表中添加新条目（包含长名称、短名称和ID）
3. 重新生成相关文件

生成的日志相关文件包括：

• srtcore/logger_default.cpp
• srtcore/logger_defs.h/cpp
• apps/logsupport_appdefs.cpp

构建选项

修改CMake构建选项后，需要更新configure-data.tcl文件中的选项列表。通过以下命令生成新选项列表：

./configure-data.tcl CMakeCache.txt

最佳实践建议

1. 代码审查：提交PR前进行充分的代码检查
2. 测试覆盖：新增功能应包含相应测试用例
3. 文档更新：代码变更伴随文档更新
4. 兼容性考虑：修改核心功能时注意向后兼容

通过遵循本指南，开发者可以更高效地参与SRT项目开发，为这一优秀的开源视频传输技术贡献力量。