Zig Audio Play 示例

功能说明

该示例演示如何在 Zig 中通过 arcs.Audio 打开音频设备、配置播放参数，并在运行时输出一段由 Zig 代码生成的 PCM 音频。示例依次播放 1kHz 正弦波、静音、500Hz 正弦波和静音，用于验证 Zig 侧音频 HAL 封装、缓冲写入与播放控制流程。

硬件连接

该示例依赖板级音频播放通路，请先确认：

已启用 audio0 设备
板子具备可用的音频输出路径
外接耳机、喇叭或评估板默认音频输出通道可正常工作

示例内容

打开 audio0 设备
配置 16kHz / 16bit / Mono 播放参数
在 Zig 中生成 1kHz 和 500Hz 正弦波采样数据
按段写入播放缓冲
刷新播放队列并停止播放
输出播放结果日志

编译

重要提示：编译前需要先确认当前示例支持的目标板型，然后将板型标识传给 -DBOARD。请按以下方式选择：

确认示例限制：查看当前示例 README 中的硬件连接和注意事项，确认是否限定板型。
参考示例配置：查看相关示例目录下的 sample.yaml，确认支持的板型。
填写板型标识：SDK 内置板型的标识为 boards/ 下的目录名。例如实际使用的板型目录为 boards/<板型名称>/，则编译参数填写为 -DBOARD=<板型名称>。

在 SDK 根目录执行编译，并将命令中的 <示例路径> 和 <板型名称> 替换为实际值。

Linux 使用 build.sh：

# 通用命令
./build.sh -C -S samples/<示例路径> -DBOARD=<板型名称>

# 示例：使用 arcs_evb 开发板
./build.sh -C -S samples/<示例路径> -DBOARD=arcs_evb

Windows PowerShell 使用 build.ps1：

# 通用命令
.\build.ps1 -C -S samples/<示例路径> -DBOARD=<板型名称>

# 示例：使用 arcs_evb 开发板
.\build.ps1 -C -S samples/<示例路径> -DBOARD=arcs_evb

Note

确保已安装对应平台的工具链和 ListenAI 开发工具包。Windows 环境请先执行 .\env.ps1 或直接使用 .\build.ps1 自动加载环境。

注意事项：-DBOARD 填写的是板型标识，不是芯片系列名称。如果示例有板型专用配置或额外编译参数，以示例 README 中的说明为准。

建议将示例路径替换为：

./build.sh -C -S samples/libraries/zig/audio_play -DBOARD=arcs_evb

烧录

编译完成后，使用 SDK tools/burn 目录下的 cskburn 工具烧录固件。请先根据目标板型和当前示例确定芯片系列、串口设备、烧录地址和固件路径。

Linux：

# 通用命令
./tools/burn/cskburn -C <芯片系列> -s <串口设备> -b 3000000 <烧录地址> <固件路径>

# 示例：使用 arcs_evb 开发板
./tools/burn/cskburn -s /dev/ttyUSB0 -b 3000000 0x0 build/arcs.bin -C arcs

Windows PowerShell：

# 通用命令
.\tools\burn\cskburn.exe -C <芯片系列> -s <串口号> -b 3000000 <烧录地址> <固件路径>

# 示例：使用 arcs_evb 开发板
.\tools\burn\cskburn.exe -C arcs -s COM7 -b 3000000 0x0 .\build\arcs.bin

Note

烧录参数说明：

-s /dev/ttyUSB0 / -s COM7：串口设备路径，需要根据实际情况修改 - Linux 系统：通常是 /dev/ttyUSB0 或 /dev/ttyACM0 - 可通过 ls /dev/tty* 命令查看可用串口设备 - Windows 系统：通常是 COM7、COM8 等，可在“设备管理器”的“端口”中查看 - 不同开发板或 USB 转串口芯片可能使用不同的设备名
-b 3000000：烧录波特率（3Mbps）
0x0：烧录起始地址
build/arcs.bin / .\build\arcs.bin：编译生成的固件路径
-C arcs：芯片类型

注意事项：

确保开发板已正确连接到电脑
如果无法识别串口设备，请检查 USB 连接线是否正常，或尝试其他 USB 端口

预期输出

串口中可看到类似日志：

=== Zig Audio Play Demo ===
Calling zig_audio_play_main()...
Audio play demo starting...
audio0 device opened
Play configured: 16kHz/16bit/Mono
Play started — generating tones...
Segment 1: 1kHz tone (0.8s, 12800 samples)
Segment 2: silence (0.2s)
Segment 3: 500Hz tone (0.8s, 12800 samples)
Segment 4: silence (0.2s)
Flushing audio...
Stopping play...
Audio play demo completed! Total duration: 2s
=== Zig Audio Play PASSED ===

听感上应为一声较高的“嘟”、短暂静音，再接一声较低的“嘟”。

核心 API

API	说明
`arcs.Audio.open()`	打开音频设备
`audio.configPlay()`	配置播放格式、增益和缓冲参数
`audio.startPlay()`	启动播放
`audio.writePlayData()`	写入 PCM 数据
`audio.flushPlay()`	刷新剩余播放数据
`audio.stopPlay()`	停止播放

关键代码

const play_cfg = arcs.Audio.PlayConfig{
    .format = .{
        .sample_rate = 16000,
        .channels = .left,
        .sample_bits = .bit_16,
    },
    .gain = .{
        .analog_gain = 0,
        .digital_gain = -12,
    },
    .buffer_count = 12,
    .buffer_samples = 256,
};

audio.configPlay(play_cfg) catch return -3;
audio.startPlay() catch return -4;

注意事项

音频链路: 该示例对板级音频链路有依赖，若没有可用输出路径，可能只能看到日志而听不到声音，因此当前 sample 继续保持 build-only
调试强化: 各播放分段、flushPlay() 与 stopPlay() 失败现在建议显式报错并返回失败码，便于真机调试时定位播放链路问题
内存预算: prj.conf 已调整内存配置以适应音频缓冲需求，移植到其他工程时要注意 heap/PSRAM 预算
实现方式: 当前示例使用运行时分段写入方式，避免一次性分配大块音频数组
CI 方向: 后续若要接入真机 CI，建议优先引入可自动判定的回采/loopback 方案，而不是仅依赖串口 PASS 日志