Streaming depth data from the TrueDepth camera
At a glance
| Item | Summary |
|---|---|
| Purpose | Visualize depth data in 2D and 3D from the TrueDepth camera. |
| App architecture | A C/Objective-C header, Metal, Objective-C, Objective-C++, Swift sample with the source-visible chain AppDelegate → CameraViewController → FilterRenderer → CoreVideo / CoreMedia APIs. |
| Main patterns | View-controller organization, Protocol-oriented abstraction, Delegate or data-source callbacks |
| Project style | 17 scanned source file(s) across C/Objective-C header, Metal, Objective-C, Objective-C++, Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: DispatchQueue(label:), DispatchQueue.main.async; none alone proves a background thread. |
| State/event model | Source-visible mechanisms: NotificationCenter. |
| Key frameworks/packages | CoreVideo, CoreMedia, Metal, metal_stdlib, MetalKit; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
└── TrueDepthStreamer/
├── DepthToJETConverter.swift
├── AppDelegate.swift
├── CameraViewController.swift
├── PreviewMetalView.swift
├── FilterRenderer.swift
├── PointCloud/
│ ├── PointCloudMetalView.h
│ └── PointCloudMetalView.mm
├── Shaders/
│ ├── DepthToJET.metal
│ └── Mixer.metal
├── VideoMixer.swift
├── HistogramCalculator.h
└── HistogramCalculator.m
Structure observations
- Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
- Primary languages: C/Objective-C header, Metal, Objective-C, Objective-C++, Swift.
- The verified tree contains 6 project/configuration file(s) and 19 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["CameraViewController"]
N3["FilterRenderer"]
N4["CoreVideo / CoreMedia APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
TrueDepthStreamer/AppDelegate.swift:10 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
}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 AVFoundation.
Ownership and state
classDiagram
BGRAPixel *-- UInt8 : blue
BGRAPixel *-- UInt8 : green
BGRAPixel *-- UInt8 : red
BGRAPixel *-- UInt8 : alpha
Ownership evidence
TrueDepthStreamer/DepthToJETConverter.swift:13 — stored dependency or nearest verified ownership anchor
struct BGRAPixel {
var blue: UInt8 = 0
var green: UInt8 = 0
var red: UInt8 = 0
var alpha: UInt8 = 0
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
BGRAPixel |
UInt8 (blue) |
owns value state | App/module collaborators |
BGRAPixel |
UInt8 (green) |
owns value state | App/module collaborators |
BGRAPixel |
UInt8 (red) |
owns value state | App/module collaborators |
BGRAPixel |
UInt8 (alpha) |
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 |
|---|---|---|---|
| Queue scheduling | DispatchQueue(label:) |
The source constructs a dispatch queue; its label alone does not prove a thread. | TrueDepthStreamer/CameraViewController.swift:46 |
| Queue scheduling | DispatchQueue.main.async |
The source addresses the main dispatch queue. | TrueDepthStreamer/CameraViewController.swift:196 |
@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
TrueDepthStreamer/CameraViewController.swift:46 — representative execution boundary
@available(iOS 11.1, *)
class CameraViewController: UIViewController, AVCaptureDataOutputSynchronizerDelegate {
// ...
private let sessionQueue = DispatchQueue(label: "session queue", attributes: [], autoreleaseFrequency: .workItem)
// ...
}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 |
|---|---|---|---|
| State propagation | NotificationCenter |
NotificationCenter distributes named process-local events. | TrueDepthStreamer/CameraViewController.swift:318 |
| Source import | CoreVideo |
The cited file imports this module; runtime use and architectural role are not inferred. | TrueDepthStreamer/CameraViewController.swift:10 |
| Source import | CoreMedia |
The cited file imports this module; runtime use and architectural role are not inferred. | TrueDepthStreamer/DepthToJETConverter.swift:8 |
| Source import | Metal |
The cited file imports this module; runtime use and architectural role are not inferred. | TrueDepthStreamer/DepthToJETConverter.swift:10 |
| Source import | metal_stdlib |
The cited file imports this module; runtime use and architectural role are not inferred. | TrueDepthStreamer/Shaders/DepthToJET.metal:8 |
| Source import | MetalKit |
The cited file imports this module; runtime use and architectural role are not inferred. | TrueDepthStreamer/PointCloud/PointCloudMetalView.h:12 |
| Source import | AVFoundation |
The cited file imports this module; runtime use and architectural role are not inferred. | TrueDepthStreamer/CameraViewController.swift:9 |
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
TrueDepthStreamer/FilterRenderer.swift:10 — representative type boundary
protocol FilterRenderer: AnyObject {
// ...
var description: String { get }
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
FilterRenderer |
Defines a capability or collaboration contract | AnyObject |
DepthToJETConverter |
Transforms between feature representations | FilterRenderer |
CameraViewController |
View lifecycle, callbacks, and feature coordination | UIViewController, AVCaptureDataOutputSynchronizerDelegate |
PreviewMetalView |
User-interface presentation and input forwarding | MTKView |
PointCloudMetalView |
User-interface presentation and input forwarding | MTKView |
BGRAPixel |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
JETParams |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
ColorTable |
Owns feature behavior and collaborator lifecycle | NSObject |
SessionSetupResult |
Represents the result of an operation | Concrete collaborators/imported frameworks |
The source explicitly defines local protocol relationships: DepthToJETConverter → FilterRenderer.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
setupResult (TrueDepthStreamer/CameraViewController.swift:39) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
session (TrueDepthStreamer/CameraViewController.swift:41) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
isSessionRunning (TrueDepthStreamer/CameraViewController.swift:43) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
sessionQueue (TrueDepthStreamer/CameraViewController.swift:46) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
Reference code
TrueDepthStreamer/CameraViewController.swift:39 — representative boundary
@available(iOS 11.1, *)
class CameraViewController: UIViewController, AVCaptureDataOutputSynchronizerDelegate {
// ...
private var setupResult: SessionSetupResult = .success
// ...
}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 |
|---|---|---|
| View lifecycle, callbacks, and feature coordination | CameraViewController |
The source’s Controller suffix makes this role explicit. |
| Transforms between feature representations | DepthToJETConverter |
The source’s Converter suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate |
The source’s Delegate suffix makes this role explicit. |
| Owns drawing, GPU, or presentation processing | FilterRenderer |
The source’s Renderer suffix makes this role explicit. |
| User-interface presentation and input forwarding | PointCloudMetalView, PreviewMetalView |
The source’s View suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | TrueDepthStreamer/CameraViewController.swift:15 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Protocol-oriented abstraction | TrueDepthStreamer/DepthToJETConverter.swift:97 |
A local protocol and concrete conformance create an explicit capability boundary. |
| Delegate or data-source callbacks | TrueDepthStreamer/AppDelegate.swift:11 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: CameraViewController; Converter: DepthToJETConverter; Delegate: AppDelegate; Renderer: FilterRenderer; View: PointCloudMetalView, PreviewMetalView.
- Protocols:
FilterRenderer. - Methods:
wave,fillJetTable,getColorTable,allocateOutputBufferPool,prepare,reset,render,makeTextureFromCVPixelBuffer. - Files:
TrueDepthStreamer/DepthToJETConverter.swift,TrueDepthStreamer/AppDelegate.swift,TrueDepthStreamer/CameraViewController.swift,TrueDepthStreamer/PreviewMetalView.swift,TrueDepthStreamer/FilterRenderer.swift,TrueDepthStreamer/PointCloud/PointCloudMetalView.h.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches CoreVideo, CoreMedia, Metal, MetalKit 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.
- Local protocol relationships provide an explicit substitution boundary.
Source map
| Source file | Relevant symbols |
|---|---|
TrueDepthStreamer/AppDelegate.swift |
Cited implementation, AppDelegate |
TrueDepthStreamer/DepthToJETConverter.swift |
Cited implementation, CoreMedia, Metal, BGRAPixel, JETParams, ColorTable, DepthToJETConverter |
TrueDepthStreamer/FilterRenderer.swift |
FilterRenderer |
TrueDepthStreamer/CameraViewController.swift |
Cited implementation, CameraViewController, DispatchQueue(label:), DispatchQueue.main.async, NotificationCenter, CoreVideo, AVFoundation, SessionSetupResult |
TrueDepthStreamer/Shaders/DepthToJET.metal |
metal_stdlib, BGRAPixel, JETParams |
TrueDepthStreamer/PointCloud/PointCloudMetalView.h |
MetalKit, PointCloudMetalView |
TrueDepthStreamer/PreviewMetalView.swift |
PreviewMetalView, Rotation |
TrueDepthStreamer/PointCloud/PointCloudMetalView.mm |
PointCloudMetalView |
TrueDepthStreamer/Shaders/Mixer.metal |
VertexIO, mixerParameters |
TrueDepthStreamer/VideoMixer.swift |
VideoMixer, MixerParameters |
TrueDepthStreamer/HistogramCalculator.h |
HistogramCalculator |
TrueDepthStreamer/HistogramCalculator.m |
HistogramCalculator |
TrueDepthStreamer/Shaders/PassThrough.metal |
VertexIO |
TrueDepthStreamer/PointCloud/AAPLTransforms.h |
Feature implementation |
TrueDepthStreamer/PointCloud/AAPLTransforms.mm |
Feature implementation |
TrueDepthStreamer/Shaders/PointCloud.metal |
Feature implementation |