C ABI 参考
第 1 版。每个 sournd 引擎都有一个小巧、带版本的 C 接口。JUCE 模块只是它的一层薄封装;任何支持 C FFI 的语言都能调用它。
引擎的生命周期
控制线程,音频已停止
abi_version先检查createprepareload_state如果有的话save_statedestroy
音频线程,实时安全
set_paramprocess帧数不超过已准备的数量latency、tail_seconds和各项读数
规则
- 创建引擎之前,先检查
sournd_engine_abi_version()是否等于SOURND_ENGINE_ABI_VERSION。 - 对同一个实例的所有调用必须串行。每个处理线程使用一个实例。
- 控制线程,音频已停止:
create、destroy、prepare、prepare_layout、save_state、load_state、value_to_text以及各个元数据调用。 - 音频线程,实时安全:
process、process_sidechain、reset、set_param、get_param、latency、tail_seconds以及各项读数。 - 参数 id 就是该参数在引擎清单中的位置。
- 字符串使用 UTF-8 编码,以 NUL 结尾。目录字符串在库的整个生命周期内有效;参数字符串在
destroy之前有效。 process接受一个或两个声道,frames不得超过已准备的最大值。允许原地处理;输出声道不得重叠。帧数为零时不执行任何操作。- 先用
save_state(e, NULL, 0, &size)查询状态大小,分配内存,再保存。 load_state可跨引擎版本迁移:保存的值按参数 id 匹配,状态中没有的参数使用默认值,引擎已不再有的 id 会被忽略。state_report会给出上次加载中这两类的数量。只有其他引擎的状态或已损坏的数据会被拒绝,此时不会有任何改动。SOURND_PARAM_LOG表示对数曲线:宿主比例p(范围 0 到 1)对应min * (max / min)^p。没有它时,范围为线性。- 出现
SOURND_PANIC后,该实例即失效:只允许调用destroy。
状态码
| 代码 | 名称 | 含义 |
|---|---|---|
| 0 | SOURND_OK | 成功 |
| -1 | SOURND_INVALID | 空指针、超出范围的值或错误的参数 |
| -2 | SOURND_NOT_FOUND | 未知的引擎 id、参数 id 或索引 |
| -3 | SOURND_BUFFER_TOO_SMALL | 输出缓冲区太小;请先查询所需大小 |
| -4 | SOURND_NOT_PREPARED | 处理之前请先调用 prepare |
| -5 | SOURND_PANIC | 引擎出错;请销毁该实例 |
| -6 | SOURND_UNSUPPORTED | 此引擎不支持该声道布局或功能 |
头文件
// SPDX-License-Identifier: Apache-2.0
#ifndef SOURND_ENGINE_H
#define SOURND_ENGINE_H
#include <stdint.h>
#include <stddef.h>
#define SOURND_ENGINE_ABI_VERSION 1u
#ifdef __cplusplus
extern "C" {
#endif
typedef struct sournd_engine sournd_engine;
enum { SOURND_OK=0, SOURND_INVALID=-1, SOURND_NOT_FOUND=-2, SOURND_BUFFER_TOO_SMALL=-3,
SOURND_NOT_PREPARED=-4, SOURND_PANIC=-5, SOURND_UNSUPPORTED=-6,
SOURND_QUEUE_FULL=-7 };
/* Descriptor flags. INSTRUMENT: an engine the musician plays with notes (catalogue kind
"instrument"); see the note input section below. */
enum { SOURND_ENGINE_SIDECHAIN=1, SOURND_ENGINE_INSTRUMENT=2 };
/* Note events one instance holds for its next process call. */
#define SOURND_NOTE_QUEUE_CAPACITY 256u
/* LOG (added to ABI version 1 append-only): the parameter has a logarithmic taper, so equal
travel is an equal ratio: value = min * pow(max / min, p) for a proportion p in 0..1. Only
set when 0 < min < max. Without it the taper is linear. Hosts and UIs that ignore the flag
still work; they show a linear range. */
enum { SOURND_PARAM_STEPPED=1, SOURND_PARAM_BOOL=2, SOURND_PARAM_HIDDEN=4, SOURND_PARAM_LOG=8 };
/* UTF-8, NUL terminated. Metadata remains valid until destroy (catalogue info: forever). */
typedef struct { const char *id, *name, *version; uint32_t flags; } sournd_engine_descriptor;
typedef struct { uint32_t id; const char *name; double min, max, default_value;
const char *unit; uint32_t flags; } sournd_param_descriptor;
uint32_t sournd_engine_abi_version(void);
uint32_t sournd_engine_count(void);
int32_t sournd_engine_info(uint32_t index, sournd_engine_descriptor *out);
int32_t sournd_engine_create(const char *id, sournd_engine **out);
int32_t sournd_engine_destroy(sournd_engine *engine);
int32_t sournd_engine_param_count(sournd_engine *engine, uint32_t *out);
int32_t sournd_engine_param_info(sournd_engine *engine, uint32_t index, sournd_param_descriptor *out);
int32_t sournd_engine_value_to_text(sournd_engine *engine, uint32_t id, double value, char *out, size_t capacity);
int32_t sournd_engine_prepare(sournd_engine *engine, double sample_rate, uint32_t max_block);
/* Explicit layout for Processor implementations whose prepare depends on bus width.
prepare() selects stereo and, when declared, stereo sidechain. */
int32_t sournd_engine_prepare_layout(sournd_engine *engine, double sample_rate, uint32_t max_block, uint32_t channels, uint32_t side_channels);
int32_t sournd_engine_reset(sournd_engine *engine);
int32_t sournd_engine_set_param(sournd_engine *engine, uint32_t id, double value);
int32_t sournd_engine_get_param(sournd_engine *engine, uint32_t id, double *out);
/* One or two channels, frames <= prepared max_block. In-place is allowed. Output channels
must not overlap each other. Sidechain can be absent (0 channels), mono or stereo.
Buffers and pointer arrays must be valid for the call. Zero frames is a no-op.
An instrument may be given in=NULL (it hears silence); effects require input. */
int32_t sournd_engine_process(sournd_engine *engine, const float *const *in, float *const *out, uint32_t channels, uint32_t frames);
int32_t sournd_engine_process_sidechain(sournd_engine *engine, const float *const *in, float *const *out, uint32_t channels, const float *const *side, uint32_t side_channels, uint32_t frames);
int32_t sournd_engine_latency(sournd_engine *engine, uint32_t *out);
int32_t sournd_engine_tail_seconds(sournd_engine *engine, double *out);
int32_t sournd_engine_readout_count(sournd_engine *engine, uint32_t *out);
int32_t sournd_engine_readout_value(sournd_engine *engine, uint32_t index, double *out);
/* Note input (instruments). Added to ABI version 1 append-only: effects and existing calls
are unchanged, and a v1 host that never calls these sees no difference.
is_instrument returns 1 for an instrument, 0 for an effect, or a negative status.
note_on/note_off/all_notes_off follow the threading rules of set_param: audio thread (or
any thread that owns the instance), serialised with process, called before the process
call they belong to. They never allocate, lock or block.
Timing: sample_offset is a frame position inside the NEXT process call; 0 is its first
frame. Each event takes effect before the frame at its offset (the engine splits the
block there). Events at the same offset apply in call order; events need not be sent in
offset order. An offset at or past the frame count of the next process call is carried,
not dropped: it takes effect at frame 0 of the call after that. A zero-frame process call
applies and carries nothing.
Arguments: note is a MIDI note number 0..127; velocity is 0..1 (a note_on at velocity 0 is a
note_off, as in MIDI); sample_offset must be below the prepared max_block. Status codes:
SOURND_INVALID for a NULL engine or a bad note, velocity (NaN, infinite, outside 0..1) or
offset; SOURND_UNSUPPORTED on an effect; SOURND_NOT_PREPARED before prepare;
SOURND_QUEUE_FULL when SOURND_NOTE_QUEUE_CAPACITY events already wait for the next process
call: that event is refused and nothing else changes (send all_notes_off to recover).
all_notes_off ends every note at once and drops every queued event; it works prepared or
not (SOURND_UNSUPPORTED on an effect). prepare, prepare_layout and reset also drop queued
events. */
int32_t sournd_engine_is_instrument(sournd_engine *engine);
int32_t sournd_engine_note_on(sournd_engine *engine, uint32_t note, float velocity, uint32_t sample_offset);
int32_t sournd_engine_note_off(sournd_engine *engine, uint32_t note, uint32_t sample_offset);
int32_t sournd_engine_all_notes_off(sournd_engine *engine);
/* Control thread, audio stopped. Query required length using out=NULL, capacity=0.
State is engine-specific and versioned; it preserves settings, not delay history.
Loading migrates across engine versions: saved parameters are matched by id (never by
position or count), a current parameter the state lacks takes its default, and a saved id
this version does not have is ignored. Loading refuses the whole state (SOURND_INVALID,
nothing changes) only on a genuine clash: another engine's id, a value that is not finite,
outside the parameter's range or fractional for a stepped or switch parameter, an id saved
twice, or a truncated or malformed envelope.
state_report (added to ABI version 1 append-only) gives what the last successful load
migrated: ignored = saved ids this version does not have, defaulted = parameters set to
their default. Both are 0 before any load. */
int32_t sournd_engine_save_state(sournd_engine *engine, uint8_t *out, size_t capacity, size_t *written);
int32_t sournd_engine_load_state(sournd_engine *engine, const uint8_t *data, size_t length);
int32_t sournd_engine_state_report(sournd_engine *engine, uint32_t *ignored, uint32_t *defaulted);
/* Ownership: serialise ALL calls for an instance. create/destroy/prepare/state/text/metadata
are control-thread operations; process/reset/set/get/latency/tail/readouts and the note
calls are RT safe for conforming engines. Null is rejected (destroy(NULL) succeeds). Dangling, fabricated,
misaligned pointers and concurrent access violate the contract and cannot be checked.
On PANIC the instance is poisoned: only destroy is permitted. Build with panic=unwind. */
#ifdef __cplusplus
}
#endif
#endif