跳转至
XiStudio · User Manual

XiStudio 用户手册 v1.0

从零上手到精通 · 面向算法工程师与调音师
文档编号：D2-P1-MAN-001 · 版本：v1.0 · 发布：2026-05-05
让工具服从你 · 而不是你服从工具
4
版本适配
2
操作系统
15min
首个项目上手

XiStudio 用户手册 v1.0

摘要

本手册面向 XiStudio IDE 的终端用户（算法工程师、调音师、Tier1 方案工程师），覆盖从安装激活到项目交付的完整工作流。 与 api.md 互补：api 是给"集成开发者"看的接口参考，本文是给"日常使用者"看的操作指南。

1. 安装与激活

1.1 系统需求（摘要）

  • Windows 10 1809+ / Windows 11 · 或 · macOS 13+（Apple Silicon / Intel）
  • CPU 4 核 2.0 GHz 起 · 推荐 8 核 3.0 GHz
  • 内存 8 GB 起 · 推荐 16 GB
  • 存储 10 GB 起 · 推荐 50 GB SSD

完整需求见 spec.md §2。

1.2 下载与安装

  1. 访问官网 https://xisound.com/downloads
  2. 选择版本：
    • Community：免费，直接下载
    • Pro / Enterprise：购买后从客户后台下载专用安装包
    • IDM：由 Xisound 专属客户经理提供
  3. Windows：双击 .exe → 下一步 → 默认选项即可
  4. macOS：打开 .dmg → 拖拽 XiStudio.app 到 Applications → 首次打开可能需"系统偏好设置 → 安全性与隐私"放行

1.3 激活

版本 激活方式
Community 首次启动在线注册邮箱
Pro 输入 XS-PRO-XXXX-XXXX 激活码
Enterprise 配置 License Server 地址 + 用户账号登录
IDM 按交付文档部署源码 + 证书

离线激活

Pro 版支持离线激活：在"帮助 → 激活"里选择"离线模式"，导出激活请求文件，通过邮件/U盘发给 Xisound 支持，收到激活码后导入即可。

2. 界面总览

2.1 主窗口布局

┌─────────────────────────────────────────────────────────┐
│ 菜单栏（文件/编辑/视图/构建/设备/窗口/帮助）             │
├────────┬───────────────────────────────┬────────────────┤
│        │                               │                │
│ 项目树 │       流图画布                 │ 参数面板       │
│ 算法库 │    （节点 · 连线 · 组）         │ 示波器         │
│        │                               │                │
├────────┴───────────────────────────────┴────────────────┤
│ 输出控制台（编译日志 · 调试信息 · 仿真波形）             │
└─────────────────────────────────────────────────────────┘

2.2 常用快捷键（Windows / macOS）

功能 Win macOS
新建项目 Ctrl+N ⌘N
打开项目 Ctrl+O ⌘O
保存 Ctrl+S ⌘S
复制节点 Ctrl+C ⌘C
粘贴 Ctrl+V ⌘V
撤销 Ctrl+Z ⌘Z
重做 Ctrl+Shift+Z ⌘⇧Z
编译 F7 ⌘B
烧录 F5 ⌘R
开始仿真 F9 ⌘⇧R
切换示波器 F12 ⌘⇧O
放大/缩小画布 Ctrl+滚轮 ⌘滚轮

3. 第一个项目：15 分钟快速上手

3.1 新建项目

  1. 菜单 文件 → 新建项目
  2. 选模板：空白项目 / 立体声 EQ 示例 / 车载音响三分频示例
  3. 填基本信息：
    • 项目名：my-first-project
    • 目标芯片：XiDSP-D1
    • 保存位置
  4. 点"创建"

3.2 拖拽第一个流图

目标：输入 → 参数 EQ → 输出

  1. 从左侧算法库展开 基础信号处理 → 滤波器
  2. 拖 ParametricEQ 到画布
  3. 从右侧"I/O"分类拖 AudioInput 到画布左侧，拖 AudioOutput 到画布右侧
  4. 连线：AudioInput → ParametricEQ → AudioOutput

3.3 调参数

  1. 单击 ParametricEQ 节点
  2. 右侧参数面板出现 freq / gain / q 三个参数
  3. 设 freq=1000、gain=+3dB、q=1.4

3.4 仿真

  1. 按 F9 开始仿真
  2. 输入提示选择 pink-noise.wav（自带示例）
  3. 底部示波器显示仿真后的频谱，1kHz 附近能看到 +3 dB 凸起 → ✅

3.5 编译 + 烧录

  1. 把 XiFlash 烧录器插到电脑 USB，目标板 XiDSP 连到 XiFlash
  2. 按 F7 编译（输出 build/main.xifw）
  3. 按 F5 烧录 → 等待进度条
  4. 完成后即可在目标板上听到 EQ 效果

4. 流图编辑进阶

4.1 节点分组（Group）

  • 选中多个节点 → 右键 → 打组
  • 组可折叠 / 展开 / 重命名 / 导出为子流图
  • 典型用法：把 "AEC + NS + AGC" 打成一个 "语音前处理" 组，多个项目复用

4.2 子流图（Sub-Flow）

  • 大项目建议拆成多个子流图
  • 主流图中用 SubFlowRef 节点引用子流图
  • 子流图可单独调参、单独仿真

4.3 参数绑定（Bindings）

  • 把多个节点的同名参数绑定到一个 UI 控件
  • 典型场景：让客户只暴露"低音 / 中音 / 高音"三个滑块，其实背后是 6 个 EQ 频点

4.4 常见错误与快速修复

错误 现象 修复
未连接输出 编译 E: dangling output 确保 AudioOutput 有上游连线
采样率不匹配 编译 E: sr mismatch 对齐到 48 kHz 或加 Resample
MIPS 超限 编译 E: MIPS over budget 删算法 / 降复杂度 / 换芯片
参数越界 红框提示 参考参数面板里的 min/max 提示

5. 编译、仿真、调试

5.1 编译配置

  • Debug：带符号信息、便于 JTAG 单步
  • Release：全优化 + RSA 签名

5.2 仿真

  • 位精确仿真：对同一固件给同一输入，每次仿真结果完全一致
  • 实时率：v1.0 ≥ 10×（48 kHz 单通道）
  • 支持输出节点级波形（右键节点 → 在示波器中显示）

5.3 JTAG 调试

  • 在节点上右键 → 设置断点
  • 触发时编辑器跳转到对应生成代码行
  • 变量观察窗可实时观察算法内部缓冲

6. 设备烧录与现场调音

6.1 XiFlash 使用

  1. 插入 XiFlash（Win 自动装驱动；macOS 无需驱动）
  2. 菜单 设备 → 连接 XiFlash
  3. 选接口：USB（速度快） / UART（兼容老板） / JTAG（调试同时用）
  4. 选目标芯片（自动识别）
  5. 烧录

6.2 现场调参（XiTune 联动）

  • XiStudio 可以与 XiTune 便携套件联动（见 XiTune 三件套）
  • 通过蓝牙/USB 把当前 preset推送到 XiDSP，现场耳听 + 实时微调
  • 微调结果可一键同步回 XiStudio 项目

7. 团队协作（Enterprise 版）

7.1 XiForge 协作

  • Enterprise 版内置 视图 → XiForge 面板
  • 可与同事实时共同编辑同一流图（类似 Figma / VS Code Live Share）
  • 每次保存会自动记录版本历史

7.2 评审与评论

  • 右键任意节点 → 添加评论
  • 评论带 @mention，被 @ 的人会收到通知
  • 评论状态：Open / Resolved

7.3 版本历史

  • 视图 → 历史
  • 可看每一次保存的时间、作者、变更摘要
  • 支持回滚到任意历史版本

8. 与 XiAlgo / XiDSP / XiMind 联动

8.1 调用 XiAlgo 新版本算法

  • 菜单 帮助 → 检查 XiAlgo 更新
  • 更新会拉取最新的 XiAlgo 套件（Pro+ 版）
  • 老项目可选择性升级算法版本（不强制）

8.2 换芯片（XiDSP 系列）

  • 项目属性 → 目标芯片 → 从 D1 改为 D2 / D3 / A1（车规）
  • 编译器会自动切换后端，大多数算法无需改动
  • 如 MIPS 超限，会提示并给出优化建议

8.3 XiMind AI 辅助

  • 右键画布 → XiMind 智能建议
  • 用自然语言描述："给这个立体声加一个爵士乐曲线"
  • XiMind 会生成一组参数建议（仅供参考，需人工确认）

9. 导出与交付

9.1 导出产品固件

  • 构建 → 选 Release
  • 生成 build/main.xifw（原始固件）和 build/main.xiflash（签名烧录包）
  • 出厂仅需分发 .xiflash

9.2 导出为其他格式（通过插件）

  • Enterprise 版可安装 导出到 SigmaStudio 插件
  • 或通过 Plugin SDK 自定义导出格式（见 api.md §5）

9.3 项目打包归档

  • 文件 → 导出项目归档（.zip）
  • 包含：项目元数据 + 流图 + 参数 + 仿真素材 + 构建产物
  • 排除本地缓存（.xi/ 目录不包含在内）

10. 故障排查

10.1 启动相关

现象 排查
启动即崩溃 更新显卡驱动 · 或启动时加 --disable-gpu
启动慢 清理 %APPDATA%/XiStudio/Cache · 关闭不必要的插件
激活提示无网络 走离线激活流程

10.2 编辑相关

现象 排查
画布卡顿（>300 节点） 使用子流图拆分；v2.0+ 升 WebGL 后改善
Undo 失效 检查是否插件抢管了快捷键
粘贴丢参数 升级到 v1.0.3+（已修复）

10.3 硬件相关

现象 排查
找不到 XiFlash 换 USB 线 · 换 USB 口 · Win 更新驱动
烧录速度慢 走 USB 而非 UART · 关闭其他占用 USB 的软件
JTAG 断不住 确认 Debug 构建 · 目标板上电顺序

10.4 获取支持

11. 附录

11.1 相关文档

11.2 版本历史

版本 日期 要点
v1.0 2026-05-05 首版 · 覆盖安装 / 编辑 / 编译 / 烧录 / 协作全流程

user-manual.md · D2-P1-MAN-001 · v1.0 · 2026-05-05 · Xisound 交付中心 · 技术文档组