Files
JustOneCacophony/README.en.md
T
TheM14 6f6b5db6c2
ci / ubuntu-latest (push) Failing after 15s
ci / macos-latest (push) Has been cancelled
ci / windows-latest (push) Has been cancelled
Add JOC downmix configurations 0..4, cross-layer notes, and the analysis-side clipgain
2026-10-16 19:52:04 +08:00

9.9 KiB

JustOneCacophony — C++ Core

中文 · Mathematics · Binaural rendering · SIMD dispatch

The C++ implementation of JustOneCacophony: an execution core for E-AC-3 JOC bitstream parsing, object reconstruction and rendering. It extracts EMDF, ID14 JOC parameters and ID11 OAMD metadata from E-AC-3 syncframes, combines them with the core 5.1 PCM decoded by FFmpeg to rebuild the LFE and 15 object signals, and writes ADM BWF, a WAV for a chosen speaker layout, or a binaural WAV using a compiled HRTF directional field.

This is research code, not a complete, standard-conformant or production JOC decoder. It covers the bitstream forms it implements and reports an explicit error on unknown variants instead of pretending everything is in harmony.

Building

cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
cmake --build build
ctest --test-dir build --output-on-failure

Only MSVC (VS 2022, static CRT) is validated locally; Linux and macOS are built and unit-tested by .github/workflows/ci.yml. Floating-point behaviour is part of the byte-exact acceptance, so fast-math is never enabled: /fp:precise on MSVC, -fno-fast-math elsewhere.

The heaviest binaural loops are runtime-dispatched: one binary carries several ISA variants and picks the widest one at startup from CPUID/XGETBV, with the output byte-identical either way (see SIMD dispatch). JOC_ENABLE_AVX2 / JOC_ENABLE_AVX512 (both ON by default) only decide whether those units are linked in: carrying the AVX2 unit buys 12.4% on the SOFA binaural kernel and 1.8% on Rosella, while a CPU without AVX2 still runs the baseline (SSE2) path. To produce a baseline-only binary:

cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release -DJOC_ENABLE_AVX2=OFF

gives a baseline-ISA (SSE2) build that runs on any x86-64. Non-MSVC builds never receive the flag.

Paths and encoding

Every path inside the library is UTF-8, converted only at the OS boundary (src/foundation/fs_utf8.*): on Windows through std::filesystem::path (UTF-16 inside) into _wfopen/CreateProcessW, and as plain bytes elsewhere. Command line arguments are re-parsed from GetCommandLineW + CommandLineToArgvW on Windows and the console code page is set to UTF-8, so non-ASCII paths (Japanese, Chinese, ...) work for the input, the ffmpeg child process and the output files alike; a non-ASCII path regression case runs in ctest.

Artifacts

Artifact Purpose
joc_core.dll The engine: bitstream parsing, JOC/OAMD, DSP, speaker and binaural rendering, ADM BWF/WAV writing, file task, streaming surface
joc_cli.exe Command line frontend for file tasks
include/joc_core.h Engine, telemetry and file-task interface (pure C)
include/joc_stream.h Embedder-facing streaming push/pull interface (pure C, self-contained)

Command line

The arguments match the reference Python CLI exactly: the input is positional, ADM BWF is the default output, --speaker-layout or --binaural selects the other two modes, and without -o the result lands in output/.

# Default: ADM BWF (inherently 24-bit, so there is no format option)
joc_cli input.m4a
#   -> output/input.adm.wav

joc_cli input.m4a -o out/adm.wav                 # explicit output

# Speaker layout
joc_cli input.m4a --speaker-layout 5.1           # -> output/<name>.5.1.wav
joc_cli input.m4a --speaker-layout 7.1.4 --speaker-output out/714.wav --speaker-format int24

# Binaural (HRTF defaults to <exe>/HRTF/binaural.sofa, then <exe>/HRTF/binaural.personalized_headphone)
joc_cli input.m4a --binaural
joc_cli input.m4a --binaural --sofa-hrtf HRTF/other.sofa   # another SOFA
joc_cli input.m4a --binaural --personalized-headphone      # Rosella personalisation
#   -> output/<name>.binaural.wav

# Other common switches
joc_cli input.m4a --duration 30 --gain-db -3 --trajectory-mode dense64
joc_cli input.eac3 --metadata-only --print-metadata summary   # parse and print metadata only

--speaker-format / --binaural-format default to float32; an int24 request that would clip follows --clip-action (default ask; a non-interactive terminal must pass continue, float32 or abort). --duration is in seconds, and --object-delay-samples, --speaker-metadata-offset, --binaural-tail-seconds and --binaural-tail-threshold (1e-8, the binaural tail trim) keep the reference defaults. A run always writes <output>.report.json (--report-json overrides it).

Differences from the reference: --sofa-hrtf, --personalized-headphone, --backend python and the metadata sidecars (--metadata-dir, --metadata-cache, --metadata-backend sidecar) are unavailable in this build and fail immediately with an explanation instead of being ignored. This build adds --bed (pre-decoded 6-channel float32 PCM, which skips ffmpeg decoding), --kernels, --work-dir, --report-json, --dry-run and --quiet.

Library integration

The engine and the file task are exposed by joc_core.h: joc_task_validate / joc_task_execute run a file task and report state events through a callback, and joc_task_result carries frame counts, peak, byte count and SHA-256.

Players and decoder components use joc_stream.h: the caller pushes E-AC-3 bytes and the matching core PCM (or already-rebuilt objects16) at its own pace and pulls rendered PCM. Any chunking is allowed, and the result is byte-identical to the file task.

joc_stream_config config = {0};
config.struct_size = sizeof(config);
config.input = JOC_STREAM_IN_EAC3;      /* or JOC_STREAM_IN_PCM_OBJECTS16 */
config.output = JOC_STREAM_OUT_SPEAKER; /* or BINAURAL / PCM_OBJECTS16 */
config.speaker_layout_name = "5.1";
joc_stream* stream = NULL;
joc_stream_create(&config, &stream);
/* loop: joc_stream_push(...) / joc_stream_pull(...) */
joc_stream_flush(stream);
joc_stream_destroy(stream);

Contract: state is instance-private, so streams coexist; push and pull on one instance must come from the same thread; rendering is stateful, so this version offers no seek - repositioning means decoding from the start of the stream. The kernel latency is 961 samples for speaker/binaural output and joc_stream_flush drains the binaural room tail.

Layout

include/     public C ABI: joc_core.h (engine/file task), joc_stream.h (streaming),
             eac3joc_core.h (upstream ABI)
src/         implementation: eac3_transport, emdf, joc_bitstream, joc_core, oamd,
             timeline, speaker, binaural, hrtf, adm, io, telemetry, task, stream,
             api, cli, simd
tests/       unit tests (CTest, self-contained, no external data)
docs/        mathematics, the binaural rendering flow and SIMD dispatch

Eight files under src/ are byte-identical copies of the upstream JustOneCacophony native library and are never edited (see THIRD_PARTY_NOTICES.md).

Compatibility note

How joc_clipgain is applied

joc_clipgain is folded into the analysis-side scalar: scalar = 1/16 x g (g = 1 + (y/32)·2^(x-4), from the 8-bit field x:3 | y:5). The x16 at the output cancels the 1/16, so the net effect is a multiply by g and the clamp therefore sits after the gain (clamp(16·IQMF·g_interp)). The scalar is kept in two per-frame slots: the first 256 samples of a frame ramp linearly from the previous value, the rest stays constant, and the first frame after a reset takes the new value directly. For g = 1 the interpolation is the identity and clamp(x)·1 == clamp(x·1).

object_delay_samples defaults to 1473, preserving the behaviour of the existing implementation; it is a configurable field and changing it changes the OAMD/ADM time alignment. Upstream investigation suggests the value should be 0; this project keeps the current default to stay byte-identical.

joc_dmx_config_idx 0..4

All five configurations are covered: N=5,7,7,5,7 with the phase switch \sigma(k)=(k\in\{3,4\}) gating the Ls/Rs -j rotation and the band-0 21-tap FIR together. A 7-channel configuration needs an 8-channel bed, mapped by channel code:

k extra pair decoder 8-channel order JOC input (bed index)
1 Lb/Rb FL FR FC LFE BL BR SL SR 0 1 2 6 7 4 5
2 / 4 Tfl/Tfr FL FR FC LFE SL SR TFL TFR 0 1 2 4 5 6 7

ffmpeg gets -ac 6 only for the N=5 configurations; N=7 keeps the decoder's own layout (-ac 6 downmixes 5.1.2/7.1 into 5.1 and -ac 8 remaps 5.1.2 into 7.1; both lose information).

Cross-layer consistency (section 11.2): the substreams' full-band channel count must equal N, a non-zero joc\_ext\_config\_idx is an unmapped variant, and a declared object count above 15 is clamped to 15 and recorded as a diagnostic - those change the DSP input, so a mismatch is refused. The extra pair's identity never reaches the DSP (section 10.1): when the dependent-substream chanmap disagrees with k, or an OAMD standard bed mask does, the mismatch is recorded as a diagnostic and the frame still renders, with the bed mapping following the channel codes the chanmap declares. When one audio frame holds several EMDF containers carrying ID11/ID14, they are scored by the association rule of section 8.2 and its Table 56: a container whose OAMD and JOC payloads share a group id and whose ID14 parses completely wins, then one whose ID14 merely parses; only a unique best score is used and the others are recorded as a diagnostic (emdf/extra_container_ignored). The extra pair's 10-slot ADM skeleton placement (k=1\to6/7, k\in\{2,4\}\to8/9) is recorded, but bed channels are not output channels under the current contract.

An audio frame with no JOC EMDF at all (for example when the encoder wrote none for the first frame) emits silent object channels while the QMF analysis and synthesis state keep advancing, and it is counted separately in the statistics.

License

MIT, see LICENSE. Third-party provenance and patent boundaries are in THIRD_PARTY_NOTICES.md.