Nanako/Alicho

Fork 0

Go to file

nanako 2003c5992f at

2025-10-28 10:27:49 +08:00

build

2025-10-28 10:27:49 +08:00

cmake

init

2025-10-24 18:17:58 +08:00

docs

2025-10-28 10:27:49 +08:00

examples

2025-10-28 10:27:49 +08:00

include/audio_backend

2025-10-28 10:27:49 +08:00

src

2025-10-28 10:27:49 +08:00

tests

2025-10-28 10:27:49 +08:00

build.bat

init

2025-10-24 18:17:58 +08:00

build.sh

init

2025-10-24 18:17:58 +08:00

CMakeLists.txt

2025-10-28 10:27:49 +08:00

conanfile.txt

2025-10-28 10:27:49 +08:00

setup_conan.bat

init

2025-10-24 18:17:58 +08:00

docs/README.md

C++23 跨平台音频后端系统

项目概述

这是一个企业级的跨平台（Windows、Linux、macOS）C++23音频后端系统，采用多进程架构设计，提供高性能、高可靠性和高安全性的音频处理能力。系统通过进程隔离技术将音频引擎核心与第三方插件完全分离，使用双通道通信机制（ZeroMQ和Boost共享内存）实现高效数据传输，并支持SIMD运行时优化和跨平台网络音频通信。

本系统适用于专业音频处理应用、实时音频通信系统和需要高性能音频处理的游戏引擎等场景，提供完善的开发接口和扩展框架，使开发者能够快速构建稳定、高效的音频应用。

核心特性

多进程架构与沙盒隔离

进程级隔离：音频引擎核心、插件沙盒和前端UI在独立进程中运行，确保系统稳定性
插件沙盒：针对不同平台的沙盒实现（Windows Job Objects、Linux Namespaces/cgroups、macOS Sandbox）
资源配额管理：对CPU、内存、文件、网络等资源的精确限制
故障隔离：插件崩溃不会影响音频引擎和其他插件
自动恢复机制：插件故障自动检测和重启

高效通信系统

双通道通信架构：
- ZeroMQ（控制通道）：处理小型消息、状态通知、控制命令
- Boost共享内存（数据通道）：处理大型数据传输，如音频缓冲区
零拷贝数据传输：使用共享内存实现大数据零拷贝传输
灵活的消息路由：基于消息类型和优先级的自动路由
高性能序列化：使用Protobuf进行高效消息序列化
网络透明性：本地和远程通信使用统一接口

SIMD运行时优化

多级SIMD优化：
- SSE/SSE2/SSE3/SSSE3/SSE4
- AVX/AVX2
- AVX-512
- ARM NEON
运行时指令集检测：自动检测可用指令集
动态分发机制：无开销的函数指针分发
优化内存布局：SIMD友好的数据结构和对齐
自适应算法选择：根据可用指令集自动选择最优实现

网络音频传输

多协议支持：TCP/UDP/QUIC传输层
丢包恢复：前向纠错和选择性重传
码率自适应：根据网络条件调整传输质量
设备发现机制：自动发现和连接远程音频设备
安全通信：TLS 1.3加密和认证

错误处理与容错机制

完整的错误分类体系：致命错误、严重错误、警告错误、信息错误
插件故障处理：崩溃检测、心跳监控、响应超时检测
音频缓冲区管理：预警机制、动态调整、紧急处理
网络通信容错：断线自动重连、消息重传、会话恢复
内存管理容错：预分配内存池、OOM处理、泄漏检测

高扩展性设计

模块化架构：核心层、抽象层、实现层清晰分离
插件系统：标准插件API和扩展机制
处理图扩展：动态节点添加/删除、动态连接重路由
存储和配置扩展：可扩展的项目文件格式和序列化
平台抽象层：统一API跨平台实现

系统架构

系统分为三个主要进程组：

音频引擎核心进程：中央处理单元，负责音频处理调度、资源管理和通信协调
插件沙盒进程：隔离执行环境，运行第三方插件，实施资源限制
前端进程：用户交互界面，处理UI显示、硬件控制和用户输入

各进程通过双通道通信机制（ZeroMQ + Boost共享内存）进行高效数据交换。

graph TB
    subgraph "前端进程"
        UI[用户界面层]
        HAL[硬件抽象层]
        FrontAPI[前端API]
    end
    
    subgraph "音频引擎核心进程"
        AudioCore[音频核心引擎]
        ProcessingGraph[处理图管理器]
        BufferManager[音频缓冲区管理]
        SIMDEngine[SIMD优化引擎]
        MixerEngine[混音引擎]
        PluginManager[插件管理器]
        CommManager[通信管理器]
    end
    
    subgraph "插件沙盒进程"
        Sandbox1[沙盒运行时]
        Plugin1[插件实例]
    end
    
    subgraph "远程前端"
        RemoteUI[远程UI]
        RemoteAPI[远程API]
    end
    
    FrontAPI -- ZeroMQ --> CommManager
    HAL -- 硬件控制 --> FrontAPI
    UI -- 用户操作 --> FrontAPI
    
    AudioCore -- 调度 --> ProcessingGraph
    ProcessingGraph -- 使用 --> BufferManager
    ProcessingGraph -- 调用 --> SIMDEngine
    SIMDEngine -- 输出 --> MixerEngine
    PluginManager -- 管理 --> CommManager
    
    CommManager -- 共享内存/ZeroMQ --> Sandbox1
    Sandbox1 -- 加载 --> Plugin1
    
    RemoteAPI -- 网络协议 --> CommManager
    RemoteUI -- 用户操作 --> RemoteAPI

注：完整的系统架构图请参阅系统架构图文档，详细的架构信息请参阅架构详解文档

环境要求

系统要求

Windows: Windows 10+（64位）
Linux: Ubuntu 20.04+, Debian 11+, CentOS 8+（64位）
macOS: macOS 11.0+（Intel和Apple Silicon）

编译器要求

Windows: MSVC 2022 (19.30+)
Linux: GCC 13+ 或 Clang 17+
macOS: AppleClang 15+ 或 Clang 17+

依赖项

必要依赖:
- Boost 1.88.0+
- ZeroMQ 4.3.5+
- Protobuf 3.21.12+
- spdlog 1.14.1+
- fmt 10.2.1+
可选依赖:
- TBB 2022.2.0+ (并行处理)
- Eigen 3.4.0+ (矩阵运算)

快速入门

构建系统

安装Conan包管理器（2.x版本）:
```
pip install conan>=2.0.0
```

初始化Conan:

# Windows
.\setup_conan.bat

# Linux/macOS
./setup_conan.sh

构建项目:

# Windows
.\build.bat

# Linux/macOS
./build.sh

基本用法示例

前端连接示例

#include "audio_backend/frontend.h"

int main() {
    // 初始化前端系统
    audio_backend::frontend::initialize_frontend();
    
    // 创建前端管理器
    auto frontend = audio_backend::frontend::create_frontend_manager();
    frontend->initialize();
    
    // 连接到音频引擎
    frontend->connect_to_engine("tcp://localhost:5555");
    
    // 枚举音频设备
    auto devices = frontend->get_audio_devices();
    for (const auto& device : devices) {
        std::cout << "设备: " << device.name << std::endl;
    }
    
    // 启动音频流
    frontend->start_audio_stream();
    
    // 关闭并清理
    frontend->shutdown();
    audio_backend::frontend::shutdown_frontend();
    
    return 0;
}

插件宿主示例

#include "audio_backend/plugin_host.h"

int main() {
    // 创建插件宿主管理器
    auto host_manager = audio_backend::plugin::create_plugin_host_manager();
    
    // 配置沙盒
    auto effect_config = audio_backend::plugin::create_audio_effect_sandbox_config();
    
    // 加载插件
    host_manager->load_plugin(
        "/path/to/plugin.dll",
        "plugin_instance_1",
        effect_config,
        true  // auto_activate
    );
    
    // 音频处理
    engine::AudioBuffer input_buffer(audio_config);
    engine::AudioBuffer output_buffer(audio_config);
    
    host_manager->process_plugin_audio(
        "plugin_instance_1",
        input_buffer,
        output_buffer,
        midi_in,
        midi_out,
        context
    );
    
    // 卸载插件
    host_manager->unload_plugin("plugin_instance_1", true);
    
    return 0;
}

更多详细示例请参见教程和指南部分

文档结构

本文档系统组织为以下几个主要部分：

完整文档索引请参见 SUMMARY.md。

版本信息

当前版本: 1.0.0

发布日期: 2025-10-25
状态: 稳定版
官方仓库: GitHub - Audio Backend
问题追踪: GitHub Issues

版本历史

版本	日期	主要变更
1.0.0	2025-10-25	首个稳定版发布，包含所有核心功能
0.9.0	2025-09-15	Beta版本，完成所有功能但API可能有变更
0.5.0	2025-07-10	Alpha版本，实现基础功能和原型设计

完整变更日志请查看CHANGELOG.md文件。

版本兼容性

API兼容性承诺:

补丁版本(1.0.x)：完全向后兼容，仅包含bug修复
次要版本(1.x.0)：保持API兼容，可能添加新功能，不会移除或更改现有功能
主版本(x.0.0)：可能包含破坏性变更，升级时需参考迁移指南

文件格式兼容性:

主版本内保持项目文件和配置文件兼容
插件接口保持向后兼容，新版本可加载旧插件
序列化格式在次要版本内保持兼容

迁移和升级:

主版本升级指南将在迁移文档中提供
自动迁移工具可用于项目文件和配置格式升级

系统支持矩阵

功能	Windows	Linux	macOS
音频设备	ASIO, WASAPI, DirectSound	ALSA, JACK, PulseAudio	CoreAudio
进程隔离	Job Objects, AppContainer	Namespaces, Cgroups	Sandbox, XPC
共享内存	Named Shared Memory	POSIX SHM, System V SHM	POSIX SHM
网络通信	Winsock	BSD Sockets	BSD Sockets
实时优先级	SetThreadPriority	SCHED_FIFO	Thread Policy
SIMD	SSE/AVX/AVX-512	SSE/AVX/AVX-512	SSE/AVX/NEON (M系列)

测试状态

平台	状态	最后验证版本	测试覆盖率
Windows 11	✅ 稳定	1.0.0	95%
Windows 10	✅ 稳定	1.0.0	95%
Ubuntu 22.04 LTS	✅ 稳定	1.0.0	92%
Debian 11	✅ 稳定	1.0.0	90%
CentOS 8	✅ 稳定	1.0.0	88%
macOS 14 (Intel)	✅ 稳定	1.0.0	93%
macOS 14 (Apple Silicon)	✅ 稳定	1.0.0	93%

完整的测试报告和性能基准请参阅测试文档。

许可证

本项目采用 MIT 许可证。

MIT License

Copyright (c) 2025 Your Organization

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

开源依赖

本项目使用多个开源库和工具，完整的依赖列表和许可证信息请参见依赖项文档。主要依赖包括：

Boost (BSL-1.0)
ZeroMQ (MPL 2.0)
Protobuf (BSD-3-Clause)
spdlog (MIT)
nlohmann_json (MIT)
Eigen (MPL 2.0)

贡献

欢迎提交贡献！请阅读贡献指南了解如何参与项目开发。所有贡献者都需要签署贡献者许可协议(CLA)。

docs/README.md Unescape Escape

C++23 跨平台音频后端系统

项目概述

核心特性

多进程架构与沙盒隔离

高效通信系统

SIMD运行时优化

网络音频传输

错误处理与容错机制

高扩展性设计

系统架构

环境要求

系统要求

编译器要求

依赖项

快速入门

构建系统

基本用法示例

前端连接示例

插件宿主示例

文档结构

版本信息

版本历史

版本兼容性

系统支持矩阵

测试状态

许可证

开源依赖

贡献

docs/README.md