Editing Spatial Audio with an audio mix
At a glance
| Item | Summary |
|---|---|
| Purpose | Add Spatial Audio editing capabilities with the Audio Mix API in the Cinematic framework. |
| App architecture | A Swift sample centered on SpatialAudioCLI, with direct use of Cinematic, AVFoundation, ArgumentParser. |
| Main patterns | No named application pattern supported by the extracted structure |
| Project style | 4 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: @MainActor, async declaration or closure, DispatchQueue(label:), Sendable or @Sendable; none alone proves a background thread. |
| State/event model | No structured observation or publisher-scheduling marker indexed. |
| Key frameworks/packages | Cinematic, ArgumentParser, AVFoundation, Foundation; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── SpatialAudioCLI/
│ ├── SpatialAudioCLI.swift
│ ├── SpatialUtility.swift
│ ├── Actions.swift
│ └── AudioUnitHost.swift
├── Configuration/
│ └── SampleCode.xcconfig
└── SpatialAudioCLI.xcodeproj/
├── .xcodesamplecode.plist
└── project.pbxproj
Structure observations
- Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
- Primary languages: Swift.
- The verified tree contains 3 project/configuration file(s) and 9 source declaration(s).
Overall architecture
flowchart LR
N1["SpatialAudioCLI"]
N2["Cinematic APIs"]
N1 --> N2
Reference code
SpatialAudioCLI/SpatialAudioCLI.swift:12 — architecture anchor
@main
struct SpatialAudioCLI: AsyncParsableCommand {
// ...
static let configuration = CommandConfiguration(
abstract: """
Use Audio Mix with spatial audio assets.
""",
usage: """
preview <input-file> [--duration <duration>] [--intensity <intensity>] [--style <style>]
bake <input-file> [--intensity <intensity>] [--style <style>] [--output <file>] [--delete] [--include-video]
process <input-file> "" + [--audio-output-format <audio-output-format>]
"""
)
// ...
}Interpretation
The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into Cinematic.
Ownership and state
classDiagram
SpatialAudioCLI *-- CommandConfiguration : configuration
SpatialAudioCLI *-- String : action
SpatialAudioCLI *-- URL : inputFile
SpatialAudioCLI *-- Float : duration
Ownership evidence
SpatialAudioCLI/SpatialAudioCLI.swift:15 — stored dependency or nearest verified ownership anchor
@main
struct SpatialAudioCLI: AsyncParsableCommand {
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
SpatialAudioCLI |
CommandConfiguration (configuration) |
creates and retains | Initialized by the owner; the binding is immutable |
SpatialAudioCLI |
String (action) |
owns value state | App/module collaborators |
SpatialAudioCLI |
URL (inputFile) |
owns value state | App/module collaborators |
SpatialAudioCLI |
Float (duration) |
owns value state | App/module collaborators |
Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.
Concurrency, scheduling, and thread safety
Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.
| Concern | Source mechanism | Verified placement or handoff | Evidence |
|---|---|---|---|
| Main isolation | @MainActor |
The cited annotation marks its attached declaration or closure as main-actor isolated. | SpatialAudioCLI/Actions.swift:11 |
| Suspension boundary | async declaration or closure |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | SpatialAudioCLI/Actions.swift:16 |
| Queue scheduling | DispatchQueue(label:) |
The source constructs a dispatch queue; its label alone does not prove a thread. | SpatialAudioCLI/Actions.swift:126 |
| Transfer contract | Sendable or @Sendable |
The source declares a sendability boundary; this alone does not synchronize mutable state. | SpatialAudioCLI/SpatialUtility.swift:64 |
@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.
Reference code
SpatialAudioCLI/Actions.swift:11 — representative execution boundary
@MainActor
/*
Use `AVPlayer` with an `AVAudioMix` to preview the audio mix parameters for
a number of seconds that the 'duration' option specifies.
*/
static func preview(_ previewInput: SpatialUtility.PreviewInput) async throws {
// ...
print("Preview: effectIntensity=\(previewInput.intensity), renderingStyle=\(previewInput.style)")
// ...
}State propagation, frameworks, and dependencies
Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.
| Category | Mechanism or module | Verified role | Evidence |
|---|---|---|---|
| Source import | Cinematic |
The cited file imports this module; runtime use and architectural role are not inferred. | SpatialAudioCLI/Actions.swift:8 |
| Source import | ArgumentParser |
The cited file imports this module; runtime use and architectural role are not inferred. | SpatialAudioCLI/SpatialAudioCLI.swift:9 |
| Source import | AVFoundation |
The cited file imports this module; runtime use and architectural role are not inferred. | SpatialAudioCLI/AudioUnitHost.swift:8 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | SpatialAudioCLI/SpatialAudioCLI.swift:8 |
receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.
Class and protocol design
SpatialAudioCLI/SpatialAudioCLI.swift:13 — representative type boundary
@main
struct SpatialAudioCLI: AsyncParsableCommand {
// ...
var action: String
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
SpatialAudioCLI |
Represents a feature value or composable behavior | AsyncParsableCommand |
SpatialUtility |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
PreviewInput |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
BakeInput |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
ProcessInput |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
SetupAudioMixInput |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
RuntimeError |
Represents feature failure conditions | LocalizedError |
Actions |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
AudioUnitHost |
Owns feature behavior and collaborator lifecycle | Concrete collaborators/imported frameworks |
No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
auAudioMix (SpatialAudioCLI/AudioUnitHost.swift:13) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
SpatialUtility (SpatialAudioCLI/SpatialUtility.swift:8) |
implicit internal |
No explicit modifier means the Swift declaration is internal to the module. | Inference: app-target collaboration needs no exported library surface. |
Reference code
SpatialAudioCLI/AudioUnitHost.swift:13 — representative boundary
class AudioUnitHost {
// ...
public var auAudioMix = AVAudioUnitEffect()
// ...
}Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.
Logic ownership and placement
| Logic | Owning type or file | Placement rationale |
|---|---|---|
| Feature and framework orchestration | SpatialAudioCLI |
The sample keeps the demonstrated path in its primary concrete type. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| No named application pattern | SpatialAudioCLI/SpatialAudioCLI.swift:12 |
The verified source directly composes concrete framework types; this document avoids forcing a pattern name. |
Main application flow
sequenceDiagram
participant Actions
participant processedAudioAsset
participant asset
participant exportSession
Actions->>processedAudioAsset: loadTracks()
Actions->>Actions: processedAudioTrack()
Actions->>asset: loadTracks()
Actions->>Actions: videoTrack()
Actions->>Actions: videoTrack()
Actions->>exportSession: export()
Actions->>exportSession: export()
Reference code
SpatialAudioCLI/Actions.swift:277 — saveProcessedFile()
struct Actions {
// ...
let videoTimeRange = try await videoTrack!.load(.timeRange)
// ...
}Naming conventions
- Types: feature-specific names rather than reusable layer suffixes.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
validate,run,verifyCNSpatialAudioRenderingStyle,verifyAudioOutput,deleteFiles,preview,bake,bakeReadWrite. - Files:
SpatialAudioCLI/SpatialAudioCLI.swift,SpatialAudioCLI/SpatialUtility.swift,SpatialAudioCLI/Actions.swift,SpatialAudioCLI/AudioUnitHost.swift.
Architecture takeaways
SpatialAudioCLIis the main source-visible entry or composition anchor for this sample.- Framework work reaches Cinematic, AVFoundation, ArgumentParser through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
- Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
- Access-control conclusions separate verified language visibility from the likely design rationale.
- The source does not justify labeling the design protocol-oriented.
Source map
| Source file | Relevant symbols |
|---|---|
SpatialAudioCLI/SpatialAudioCLI.swift |
Cited implementation, SpatialAudioCLI, ArgumentParser, Foundation |
SpatialAudioCLI/AudioUnitHost.swift |
Cited implementation, AVFoundation, AudioUnitHost |
SpatialAudioCLI/SpatialUtility.swift |
SpatialUtility, Sendable or @Sendable, PreviewInput, BakeInput, ProcessInput, SetupAudioMixInput, RuntimeError |
SpatialAudioCLI/Actions.swift |
@MainActor, async declaration or closure, DispatchQueue(label:), Cinematic, Actions |