Using vImage pixel buffers to generate video effects
At a glance
| Item | Summary |
|---|---|
| Purpose | Render real-time video effects with the vImage Pixel Buffer. |
| App architecture | A Swift sample with the source-visible chain vImagePixelBuffer_VideoEffectsApp → ContentView → VideoEffectsEngine → Accelerate APIs. |
| Main patterns | Delegate or data-source callbacks, SwiftUI environment injection, Publisher-backed observable state |
| Project style | 4 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: DispatchQueue.main.async, DispatchQueue(label:); none alone proves a background thread. |
| State/event model | Source-visible mechanisms: SwiftUI state property wrapper, ObservableObject, @Published. |
| Key frameworks/packages | SwiftUI, Combine, Accelerate, AVFoundation, Cocoa; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── vImagePixelBuffer-VideoEffects/
│ ├── vImagePixelBuffer_VideoEffectsApp.swift
│ ├── VideoEffectsEngine.swift
│ ├── ImageView.swift
│ ├── ContentView.swift
│ └── vImagePixelBuffer_VideoEffects.entitlements
├── Configuration/
│ └── SampleCode.xcconfig
└── vImagePixelBuffer-VideoEffects.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 4 project/configuration file(s) and 6 source declaration(s).
Overall architecture
flowchart LR
N1["vImagePixelBuffer_VideoEffectsApp"]
N2["ContentView"]
N3["VideoEffectsEngine"]
N4["Accelerate APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
vImagePixelBuffer-VideoEffects/vImagePixelBuffer_VideoEffectsApp.swift:11 — architecture anchor
@main
struct vImagePixelBufferVideoEffectsApp: App {
@StateObject private var videoEffectsEngine = VideoEffectsEngine()
var body: some Scene {
WindowGroup {
ContentView()
.environmentObject(videoEffectsEngine)
}
}
}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 Accelerate.
Ownership and state
classDiagram
vImagePixelBufferVideoEffectsApp *-- VideoEffectsEngine : videoEffectsEngine
VideoEffectsEngine o-- Pixelbuffersize : pixelBufferSize
VideoEffectsEngine o-- CGImage : outputImage
VideoEffectsEngine o-- vImageConverter : converter
Ownership evidence
vImagePixelBuffer-VideoEffects/vImagePixelBuffer_VideoEffectsApp.swift:14 — stored dependency or nearest verified ownership anchor
@main
struct vImagePixelBufferVideoEffectsApp: App {
// ...
@StateObject private var videoEffectsEngine = VideoEffectsEngine()
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
vImagePixelBufferVideoEffectsApp |
VideoEffectsEngine (videoEffectsEngine) |
owns wrapper-managed state | Owning lexical scope |
VideoEffectsEngine |
Pixelbuffersize (pixelBufferSize) |
stores or receives | Initialized by the owner; the binding is immutable |
VideoEffectsEngine |
CGImage (outputImage) |
stores or receives | App/module collaborators |
VideoEffectsEngine |
vImageConverter (converter) |
stores or receives | 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.main.async |
The source addresses the main dispatch queue. | vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift:119 |
| Queue scheduling | DispatchQueue(label:) |
The source constructs a dispatch queue; its label alone does not prove a thread. | vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift:267 |
@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
vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift:119 — representative execution boundary
DispatchQueue.main.async {
self.outputImage = self.destinationBuffer.makeCGImage(
cgImageFormat: self.cgImageFormat)!
}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 | SwiftUI state property wrapper |
A SwiftUI property wrapper supplies or observes UI state. | vImagePixelBuffer-VideoEffects/ContentView.swift:12 |
| State propagation | ObservableObject |
ObservableObject supplies an observation contract. | vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift:16 |
| State propagation | @Published |
A published property can emit owner-controlled changes. | vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift:18 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | vImagePixelBuffer-VideoEffects/ContentView.swift:8 |
| Source import | Combine |
The cited file imports this module; runtime use and architectural role are not inferred. | vImagePixelBuffer-VideoEffects/ImageView.swift:9 |
| Source import | Accelerate |
The cited file imports this module; runtime use and architectural role are not inferred. | vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift:8 |
| Source import | AVFoundation |
The cited file imports this module; runtime use and architectural role are not inferred. | vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift:9 |
| Source import | Cocoa |
The cited file imports this module; runtime use and architectural role are not inferred. | vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift:10 |
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
vImagePixelBuffer-VideoEffects/vImagePixelBuffer_VideoEffectsApp.swift:12 — representative type boundary
@main
struct vImagePixelBufferVideoEffectsApp: App {
// ...
@StateObject private var videoEffectsEngine = VideoEffectsEngine()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
vImagePixelBufferVideoEffectsApp |
Application entry and top-level composition | App |
VideoEffectsEngine |
Owns processing or simulation work | NSObject, ObservableObject |
ImageView |
User-interface presentation and input forwarding | NSViewRepresentable |
CoreGraphicsImageView |
User-interface presentation and input forwarding | NSView |
ContentView |
User-interface presentation and input forwarding | View |
VideoEffects |
Defines a closed set of feature states or choices | String, Identifiable, CaseIterable |
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 |
|---|---|---|---|
videoEffectsEngine (vImagePixelBuffer-VideoEffects/vImagePixelBuffer_VideoEffectsApp.swift:14) |
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. |
VideoEffectsEngine (vImagePixelBuffer-VideoEffects/VideoEffectsEngine.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
vImagePixelBuffer-VideoEffects/vImagePixelBuffer_VideoEffectsApp.swift:14 — representative boundary
@main
struct vImagePixelBufferVideoEffectsApp: App {
// ...
@StateObject private var videoEffectsEngine = VideoEffectsEngine()
// ...
}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 |
|---|---|---|
| Application entry and top-level composition | vImagePixelBufferVideoEffectsApp |
The source’s App suffix makes this role explicit. |
| Owns processing or simulation work | VideoEffectsEngine |
The source’s Engine suffix makes this role explicit. |
| User-interface presentation and input forwarding | ContentView, CoreGraphicsImageView, ImageView |
The source’s View suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| Delegate or data-source callbacks | vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift:222 |
Callback protocols invert event delivery back into the sample’s owner. |
| SwiftUI environment injection | vImagePixelBuffer-VideoEffects/ContentView.swift:12 |
The environment supplies state or a capability without threading it through every initializer. |
| Publisher-backed observable state | vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift:18 |
Published properties notify observers while mutation remains with the state object. |
Naming conventions
- Types: App: vImagePixelBufferVideoEffectsApp; Engine: VideoEffectsEngine; View: ContentView, CoreGraphicsImageView, ImageView.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
populateDestinationBuffer,renderDestinationBuffer,applyTemporalBlur,applyNoise,applyPosterization,applyColorThreshold,configureCaptureSession,captureOutput. - Files:
vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift,vImagePixelBuffer-VideoEffects/ImageView.swift,vImagePixelBuffer-VideoEffects/ContentView.swift.
Architecture takeaways
vImagePixelBuffer_VideoEffectsAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches SwiftUI, AVFoundation, Accelerate, Cocoa 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 |
|---|---|
vImagePixelBuffer-VideoEffects/vImagePixelBuffer_VideoEffectsApp.swift |
Cited implementation, vImagePixelBufferVideoEffectsApp |
vImagePixelBuffer-VideoEffects/VideoEffectsEngine.swift |
VideoEffectsEngine, Cited implementation, DispatchQueue.main.async, DispatchQueue(label:), ObservableObject, @Published, Accelerate, AVFoundation, Cocoa, VideoEffects |
vImagePixelBuffer-VideoEffects/ContentView.swift |
Cited implementation, SwiftUI state property wrapper, SwiftUI, ContentView |
vImagePixelBuffer-VideoEffects/ImageView.swift |
Combine, ImageView, CoreGraphicsImageView |