Files
oak-editor/docs/zh/plans/riir/M6-oakaudio.md
T
Mike-Solar 774eda75fe docs(riir): design inter-module C ABI interfaces and split out oakstorage
- riir.md: split project file read/write into standalone oakstorage
  module (pluggable backend, DB-replaceable); add Mermaid data flow
  diagram of all modules; adjust batch table and milestones
- riir/04-interfaces.md: new provides/consumes contract matrix for
  all modules
- riir/M10-oakstorage.md: new manual with frozen C API (typed opaque
  handles, manual vtable for storage backends, URI addressing)
- riir/01: codify pure-C OO interface rules (typed handles instead of
  void*, init/free pairs, manual vtables, no C++ objects or member
  calls across shared library boundaries); upper layers issue commands
  only, no module-to-module event subscriptions (async task callbacks
  excepted)
- sync 00/02/03 and M2-M9 manuals: remove subscribe APIs, replace
  void* with typed handles, update tests accordingly
2026-08-05 14:48:08 +08:00

2.5 KiB
Raw Blame History

M6 · oakaudio 拆分手册

内容:engine/audio/AudioManager、AudioProcessor、输出设备 抽象、audiovisualwaveform)。 依赖:common 5、core 5、config 2、render 2、codec 1。拆分顺序第 6 位 (小模块,穿插在 render 前做掉)。

1. 目标形态

oakaudio/
  include/oakaudio/{manager.h, processor.h, types.h, export.h}
  src/
  tests/  # oakaudio_gtest

2. 冻结 C API

2.1 oakaudio/processor.h(实时重采样/格式转换,R6 已建过

oakengine_audio_processor_*,本表即其 oakaudio 版,语义不变)

typedef struct OakAudioProcessor OakAudioProcessor;
OAKAU_API OakAudioProcessor *oakaudio_processor_init(void);
OAKAU_API void oakaudio_processor_free(OakAudioProcessor *p);
OAKAU_API int oakaudio_processor_open(OakAudioProcessor *p,
	int in_rate, uint64_t in_layout, int in_format,
	int out_rate, uint64_t out_layout, int out_format, double speed);
OAKAU_API void oakaudio_processor_close(OakAudioProcessor *p);
OAKAU_API int oakaudio_processor_convert(OakAudioProcessor *p,
	float **data, int frame_count);

2.2 oakaudio/manager.h

OAKAU_API int oakaudio_manager_init(int prefer_backend /* -1=auto */);
OAKAU_API void oakaudio_manager_shutdown(void);
OAKAU_API int oakaudio_manager_set_output_params(int rate,
	uint64_t layout, int format);
OAKAU_API int oakaudio_manager_get_output_params(int *rate,
	uint64_t *layout, int *format);
/* 推流:播放路径逐块喂 samplesfloat 交错) */
OAKAU_API int oakaudio_manager_push(const float *samples,
	int frame_count, double speed);
OAKAU_API int oakaudio_manager_is_playing(void);
OAKAU_API void oakaudio_manager_stop(void);
/* 无事件接口(2026-08 修订,04 §3):输出参数的修改是调用方发的
 * 命令(set_params),params_changed 通知由调用方所在层发出。 */

3. 切割点

现状 处理
audio → render/ 2 audiovisualwaveform 对 render 类型的引用:POD 化(波形 min/max 对数组),残留类型随 M3.5 下沉
audio → codec/ 1 经 oakcodec C ABIM5 已就位)

4. 测试(映射 03 §2/§3

  • processoropen/convert/close 全链(44.1k stereo → 48k stereo, 帧数换算正确、无爆音断言用能量差阈值)、速度 1.5x。
  • manager:无音频设备环境用 null backend 初始化(现有后端探测 模式),params set/get 往返(set 后 get 读数即生效——无事件)。
  • oakaudio_debug_alive_count() 泄漏断言。