Skip to content

docs: correct the TrueHD Atmos CODECS levels, OS requirement and delivery state - #9

Merged
Quick104 merged 1 commit into
mainfrom
docs/truehd-atmos-codecs-levels
Sep 26, 2026
Merged

Quick104 merged 1 commit into
mainfrom
docs/truehd-atmos-codecs-levels

Conversation

@Quick104

@Quick104 Quick104 commented Sep 26, 2026 •

Copy link
Copy Markdown

Summary

Three statements about the TrueHD Atmos path did not match the code. CodeRabbit flagged the first two on #6. Stacked on #8, because both change the same formats.md paragraph; GitHub retargets this PR to main when #8 merges.

What changed

  • cli.md and formats.md said apac.31.03 covers up to 12 channels. 5.1.2 has 8 channels, and APACSampleEntry.codecsString gives it level 2, so its master reads apac.31.02. DocumentedConstantsTests now pins 8, 10 and 12 channels.
  • api.md listed "OS 25 and earlier" as a fallback case. There is no OS 25; the path needs iOS, tvOS, macOS or visionOS 26.
  • AudioDelivery.bridged said the bed channels stay lossless. That holds only for FLAC. E-AC-3 and APAC are lossy, and APAC renders the Atmos objects into the bed.

Test plan

  • Device / OS: macOS 27; documentation and doc-comment change only.
  • Source media: none.
  • Result: Scripts/check-doc-links.py resolves every link, and DocumentedConstantsTests (16) and PublicAPIDocumentationTests (4) pass.

Checklist

  • CHANGELOG.md updated (not needed: the changelog entry for the feature already states the OS 26 requirement and makes no claim about levels)
  • Commit messages follow Conventional Commits (feat(...), fix(...), chore(...))
  • The fix lives in the engine, not in a host-side workaround
  • Public API changes are intentional and documented (no public API change)

AI disclosure: written with Claude Opus 5.5 (claude-opus-5-5) in Claude Code, from a review of #6 by Claude Opus 5.5 subagents. No other AI tooling was used.

🤖 Generated with Claude Code

Note

Fix TrueHD Atmos APAC codec level, OS requirement, and delivery docs

  • Corrects the APAC channel-count to level mapping in formats.md and the --atmos-bed examples in cli.md: level 02 for 8 channels, 03 for 9–12, 04 for 13–24.
  • Documents objectAudioRendering as requiring OS 26+ on iOS, tvOS, macOS, and visionOS in api.md.
  • Clarifies the .bridged AudioDelivery case in api.md and PlayerState.swift: FLAC and E-AC-3 bridge output vs the optional APAC path that renders TrueHD Atmos objects into the speaker bed.
  • Risk: DocumentedConstantsTests.swift now fails if 8 channels do not map to apac.31.02 or 10 channels to apac.31.03; the 12-channel assertion message changed.

Macroscope summarized 78ae042.

…very state

- cli.md and formats.md said `apac.31.03` covers up to 12 channels. 5.1.2 has
  8 channels and `APACSampleEntry.codecsString` gives it level 2, so the master
  reads `apac.31.02`. DocumentedConstantsTests now pins 8, 10 and 12 channels.
- api.md named "OS 25 and earlier" as a fallback case. There is no OS 25; the
  path needs iOS, tvOS, macOS or visionOS 26.
- `.bridged` said the bed channels stay lossless. That holds for FLAC only;
  E-AC-3 and the APAC path are lossy.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@coderabbitai

coderabbitai Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 46 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 5506c3ba-e437-4dbd-bafa-713e1d414b97

📥 Commits

Reviewing files that changed from the base of the PR and between a02975e and 78ae042.

📒 Files selected for processing (5)
  • Sources/AetherEngine/PlayerState.swift
  • Tests/AetherEngineTests/DocumentedConstantsTests.swift
  • docs/api.md
  • docs/cli.md
  • docs/formats.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

macroscopeapp[bot]
macroscopeapp Bot previously approved these changes Sep 26, 2026
@macroscopeapp

macroscopeapp Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Approvability

Verdict: Approved at 78ae042

Macroscope's review found this PR approvable — The changes are limited to correcting APAC codec-level, OS-version, delivery-state, and rendering documentation, with guarded test assertions for the documented values. No production behavior or runtime paths are modified.

Notes:

  • Diff unchanged. Approvability was decided on eligibility alone.

You can add or adjust custom eligibility rules. Learn more.

@Quick104
Quick104 changed the base branch from fix/apac-priming-sync to main September 26, 2026 04:52
@macroscopeapp
macroscopeapp Bot dismissed their stale review September 26, 2026 04:53

Dismissing prior approval to re-evaluate 78ae042

@Quick104
Quick104 merged commit 67208ad into main Sep 26, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant