screencapturekit/stream/

sc_stream.rs

//! Swift FFI based `SCStream` implementation
//!
//! This is the primary (and only) implementation in v1.0+.
//! All `ScreenCaptureKit` operations use direct Swift FFI bindings.
//!
//! Each stream owns a heap-allocated `StreamContext` that holds its output
//! handlers and delegate. The context pointer is passed through FFI so that
//! callbacks route directly to the owning stream — no global registries.

use std::ffi::{c_void, CStr};
use std::fmt;
use std::num::NonZeroUsize;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use std::sync::{Arc, Mutex, RwLock};

use crate::error::{SCError, SCResult};
use crate::stream::delegate_trait::SCStreamDelegateTrait;
use crate::utils::completion::{is_timeout_error, UnitCompletion};
use crate::utils::panic_safe::catch_user_panic;
use crate::{
    dispatch_queue::DispatchQueue,
    ffi,
    stream::{
        configuration::SCStreamConfiguration, content_filter::SCContentFilter,
        output_trait::SCStreamOutputTrait, output_type::SCStreamOutputType,
    },
};

/// Per-stream handler entry.
///
/// The handler is behind an `Arc` so a callback can clone it out of the
/// registry, release the lock, and only then run user code — see
/// [`sample_handler`].
struct HandlerEntry {
    id: usize,
    of_type: SCStreamOutputType,
    handler: Arc<dyn SCStreamOutputTrait>,
}

/// The native dispatch queue established for one output type.
///
/// `ScreenCaptureKit` is given a single bridge-side `SCStreamOutput` object per
/// stream, so there is exactly one native registration — and therefore one
/// queue — per output type, no matter how many Rust handlers are attached.
#[derive(Clone, Copy, PartialEq, Eq)]
enum OutputQueue {
    /// The dedicated user-interactive queue the bridge creates.
    BridgeDefault,
    /// A caller-supplied [`DispatchQueue`], identified by its raw pointer.
    Custom(usize),
}

/// Per-stream context holding output handlers and an optional delegate.
///
/// Allocated on the heap via `Box::into_raw` and passed through FFI as an
/// opaque context pointer. Callbacks cast it back to `&StreamContext` for
/// direct, O(1) access to the owning stream's state.
///
/// `handlers` and `delegate` are stored behind `RwLock`s rather than
/// `Mutex`es so concurrent callbacks from `ScreenCaptureKit`'s independent
/// dispatch queues (e.g. screen + audio) can dispatch in parallel. The locks
/// are held only long enough to clone out the `Arc`s that a callback needs;
/// user code always runs unlocked.
struct StreamContext {
    handlers: RwLock<Vec<HandlerEntry>>,
    delegate: RwLock<Option<Arc<dyn SCStreamDelegateTrait>>>,
    /// Queue established by the first successful registration for each output
    /// type, cleared when the last handler of that type is removed.
    output_queues: RwLock<Vec<(SCStreamOutputType, OutputQueue)>>,
    output_mutation: Mutex<()>,
    capturing: Arc<AtomicBool>,
    /// Set when a `start_capture` completion timed out, leaving `capturing`
    /// latched without a confirmed outcome. The next start reissues instead of
    /// short-circuiting to `Ok(())` on the strength of a start that may never
    /// have landed.
    start_unconfirmed: Arc<AtomicBool>,
    #[cfg(feature = "macos_15_0")]
    recording_outputs: AtomicUsize,
    ref_count: AtomicUsize,
}

impl StreamContext {
    fn new(delegate: Option<Arc<dyn SCStreamDelegateTrait>>) -> *mut Self {
        let ctx = Box::new(Self {
            handlers: RwLock::new(Vec::new()),
            delegate: RwLock::new(delegate),
            output_queues: RwLock::new(Vec::new()),
            output_mutation: Mutex::new(()),
            capturing: Arc::new(AtomicBool::new(false)),
            start_unconfirmed: Arc::new(AtomicBool::new(false)),
            #[cfg(feature = "macos_15_0")]
            recording_outputs: AtomicUsize::new(0),
            ref_count: AtomicUsize::new(1),
        });
        Box::into_raw(ctx)
    }

    /// Increment the reference count.
    ///
    /// # Safety
    ///
    /// `ptr` must point to a valid, live `StreamContext`.
    unsafe fn retain(ptr: *mut Self) {
        unsafe { &*ptr }.ref_count.fetch_add(1, Ordering::Relaxed);
    }

    /// Decrement the reference count, freeing the context if it reaches zero.
    ///
    /// # Safety
    ///
    /// `ptr` must point to a valid, live `StreamContext`. After this call,
    /// `ptr` must not be used if the context was freed.
    unsafe fn release(ptr: *mut Self) {
        if ptr.is_null() {
            return;
        }
        let prev = unsafe { &*ptr }.ref_count.fetch_sub(1, Ordering::Release);
        if prev == 1 {
            // The Acquire fence is required (NOT redundant — it pairs with
            // the Release stores from other threads' `fetch_sub` calls
            // and any other writes to `*ptr` they performed). It guarantees
            // that the freeing thread sees all happened-before writes from
            // every other thread that previously held a reference. This is
            // the canonical Arc-style refcount drop pattern (see
            // `std::sync::Arc::drop`); removing the fence is unsound on
            // weakly-ordered architectures (e.g. AArch64).
            std::sync::atomic::fence(Ordering::Acquire);
            drop(unsafe { Box::from_raw(ptr) });
        }
    }

    /// Clone the delegate out from under the lock so user code runs unlocked.
    ///
    /// Holding the lock across a delegate call would deadlock any delegate that
    /// touches the stream, and would serialise otherwise-independent callbacks.
    fn delegate_snapshot(&self) -> Option<Arc<dyn SCStreamDelegateTrait>> {
        self.delegate
            .read()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .clone()
    }

    /// Clone the handlers matching `of_type` out from under the lock.
    ///
    /// A handler removed concurrently with a callback already in flight may
    /// still receive that one sample — the `Arc` keeps it alive for the
    /// duration — but never receives one afterwards.
    fn handler_snapshot(&self, of_type: SCStreamOutputType) -> Vec<Arc<dyn SCStreamOutputTrait>> {
        self.handlers
            .read()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .iter()
            .filter(|e| e.of_type == of_type)
            .map(|e| Arc::clone(&e.handler))
            .collect()
    }

    #[cfg(feature = "macos_15_0")]
    fn has_handlers(&self) -> bool {
        !self
            .handlers
            .read()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .is_empty()
    }
}

/// Compile-time assertion: `StreamContext` is `Send + Sync`.
///
/// `SCStream` carries `unsafe impl Send + Sync` (lines below); that impl is
/// only sound if the underlying `StreamContext` is itself `Send + Sync`.
/// Without this static check, a future refactor that adds a `!Send` or
/// `!Sync` field (or removes the `Send`/`Sync` bound from a trait it holds
/// in `Box<dyn …>`) would silently invalidate the unsafe impl with no
/// compiler error. This `const _` forces a compile error in that case.
const _: fn() = || {
    fn assert_send_sync<T: Send + Sync>() {}
    assert_send_sync::<StreamContext>();
};

/// Monotonically increasing handler ID generator (process-wide).
static NEXT_HANDLER_ID: AtomicUsize = AtomicUsize::new(1);

/// Discriminant the Swift bridge uses for each output type.
const fn native_output_type(of_type: SCStreamOutputType) -> i32 {
    match of_type {
        SCStreamOutputType::Screen => 0,
        SCStreamOutputType::Audio => 1,
        SCStreamOutputType::Microphone => 2,
    }
}

// C trampoline handed to Swift so the bridge objects (delegate wrapper and
// output handler) can each take a +1 reference on the `StreamContext` for the
// duration of their own lifetime. This keeps the context alive while any
// callback can still be dispatched on it.
extern "C" fn context_retain_cb(context: *mut c_void) {
    if !context.is_null() {
        unsafe { StreamContext::retain(context.cast::<StreamContext>()) };
    }
}

// C trampoline handed to Swift, invoked from each bridge object's `deinit` to
// drop the +1 reference taken in `context_retain_cb`. `StreamContext::release`
// null-checks internally.
extern "C" fn context_release_cb(context: *mut c_void) {
    catch_user_panic("StreamContext::release", || unsafe {
        StreamContext::release(context.cast::<StreamContext>());
    });
}

// C callback for stream errors — dispatches to per-stream delegate via context pointer.
//
// Safety: this function is called from Swift. A Rust panic unwinding across
// the C ABI is undefined behavior, so all user-visible code (delegate trait
// methods) is wrapped in `catch_unwind`. The `delegate` lock is taken with
// `unwrap_or_else` poisoning recovery so a panic in one callback cannot
// permanently break the stream by poisoning the lock.
extern "C" fn delegate_error_callback(context: *mut c_void, error_code: i32, msg: *const i8) {
    if context.is_null() {
        return;
    }
    // SAFETY: `context` is the +1-retained StreamContext pointer the Swift
    // bridge stored via context_retain_cb; it outlives this callback.
    let ctx = unsafe { &*(context.cast::<StreamContext>()) };
    ctx.capturing.store(false, Ordering::Release);

    let message = if msg.is_null() {
        "Unknown error".to_string()
    } else {
        // Best-effort: if Swift sent a non-UTF-8 buffer, fall back to a
        // placeholder rather than panicking.
        unsafe { CStr::from_ptr(msg) }
            .to_str()
            .unwrap_or("Unknown error")
            .to_string()
    };

    let error = if error_code != 0 {
        crate::error::SCStreamErrorCode::from_raw(error_code).map_or_else(
            || SCError::StreamError(format!("{message} (code: {error_code})")),
            |code| SCError::SCStreamError {
                code,
                message: Some(message.clone()),
            },
        )
    } else {
        SCError::StreamError(message)
    };

    let Some(delegate) = ctx.delegate_snapshot() else {
        eprintln!("SCStream error: {error}");
        return;
    };

    // ScreenCaptureKit reports stops only through `stream(_:didStopWithError:)`,
    // so we dispatch the single canonical `did_stop_with_error` callback.
    // Wrap user code in catch_unwind so a panic never propagates into Swift.
    catch_user_panic("delegate.did_stop_with_error", || {
        delegate.did_stop_with_error(error);
    });
}

// C callback for the remaining `SCStreamDelegate` lifecycle events. The event
// codes are defined alongside the trampoline in Stream.swift; the two lists
// must stay in sync.
extern "C" fn delegate_event_callback(context: *mut c_void, event: i32) {
    if context.is_null() {
        return;
    }
    // SAFETY: `context` is the +1-retained StreamContext pointer the Swift
    // bridge stored via context_retain_cb; it outlives this callback.
    let ctx = unsafe { &*(context.cast::<StreamContext>()) };

    let Some(delegate) = ctx.delegate_snapshot() else {
        return;
    };

    catch_user_panic("delegate lifecycle event", || match event {
        0 => delegate.stream_did_become_active(),
        1 => delegate.stream_did_become_inactive(),
        2 => delegate.output_video_effect_did_start_for_stream(),
        3 => delegate.output_video_effect_did_stop_for_stream(),
        other => eprintln!("SCStream: unknown delegate event code {other}"),
    });
}

// C callback for sample buffers — dispatches to per-stream handlers via context pointer.
//
// Safety: this function is called from Swift on a dispatch queue. A Rust
// panic across the C ABI is UB; every user handler invocation is wrapped in
// `catch_unwind`. The handler `Arc`s are cloned out under a short read lock
// and dispatched with the lock released, so a handler is free to call back
// into `add_output_handler` / `remove_output_handler` (which need the write
// lock) without deadlocking, and a slow handler never blocks registration.
// The `passRetained` `CMSampleBuffer` reference Swift hands us is consumed
// exactly once: each non-final matching handler receives a freshly retained
// clone, and the final matching handler consumes the original.
extern "C" fn sample_handler(context: *mut c_void, sample_buffer: *const c_void, output_type: i32) {
    if sample_buffer.is_null() {
        return;
    }
    if context.is_null() {
        unsafe { crate::cm::ffi::cm_sample_buffer_release(sample_buffer.cast_mut()) };
        return;
    }
    // SAFETY: `context` is the +1-retained StreamContext pointer the Swift
    // bridge stored via context_retain_cb; it outlives this callback.
    let ctx = unsafe { &*(context.cast::<StreamContext>()) };

    let output_type_enum = match output_type {
        0 => SCStreamOutputType::Screen,
        1 => SCStreamOutputType::Audio,
        2 => SCStreamOutputType::Microphone,
        _ => {
            eprintln!("Unknown output type: {output_type}");
            unsafe { crate::cm::ffi::cm_sample_buffer_release(sample_buffer.cast_mut()) };
            return;
        }
    };

    let matching = ctx.handler_snapshot(output_type_enum);

    if matching.is_empty() {
        unsafe { crate::cm::ffi::cm_sample_buffer_release(sample_buffer.cast_mut()) };
        return;
    }

    let last = matching.len() - 1;
    for (index, handler) in matching.iter().enumerate() {
        // Retain for every handler except the last; the last handler consumes
        // the original `passRetained` reference Swift gave us.
        if index != last {
            unsafe { crate::cm::ffi::cm_sample_buffer_retain(sample_buffer.cast_mut()) };
        }

        let buffer = unsafe { crate::cm::CMSampleBuffer::from_ptr(sample_buffer.cast_mut()) };

        // Wrap user code in catch_unwind so panics never propagate into Swift.
        // If the handler panics, `buffer` is dropped on unwind, which calls
        // `cm_sample_buffer_release` and balances the retain we just did
        // (or, for the last handler, balances the original `passRetained`).
        // The retain/release accounting is preserved either way.
        catch_user_panic("output handler", || {
            handler.did_output_sample_buffer(buffer, output_type_enum);
        });
    }
}

/// Stable, non-owning identity for an [`SCStream`].
///
/// This is the address of the underlying native stream, stored as an opaque
/// value. It does not keep the stream alive and must never be dereferenced.
/// Compare it with [`SCStream::identity`] while the stream is still live.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct StreamIdentity(NonZeroUsize);

impl StreamIdentity {
    pub(crate) fn from_ptr(ptr: *const c_void) -> Option<Self> {
        NonZeroUsize::new(ptr as usize).map(Self)
    }

    /// Whether this identity belongs to `stream`.
    #[must_use]
    pub fn matches(self, stream: &SCStream) -> bool {
        self == stream.identity()
    }
}

/// `SCStream` is a lightweight wrapper around the Swift `SCStream` instance.
/// It provides direct FFI access to `ScreenCaptureKit` functionality.
///
/// This is the primary and only implementation of `SCStream` in v1.0+.
/// All `ScreenCaptureKit` operations go through Swift FFI bindings.
///
/// # Examples
///
/// ```no_run
/// use screencapturekit::prelude::*;
///
/// # fn example() -> Result<(), Box<dyn std::error::Error>> {
/// // Get shareable content
/// let content = SCShareableContent::get()?;
/// let display = &content.displays()[0];
///
/// // Create filter and configuration
/// let filter = SCContentFilter::create()
///     .with_display(display)
///     .with_excluding_windows(&[])
///     .build()?;
/// let config = SCStreamConfiguration::new()
///     .with_width(1920)
///     .with_height(1080);
///
/// // Create and start stream
/// let mut stream = SCStream::new(&filter, &config)?;
/// stream.start_capture()?;
///
/// // ... capture frames ...
///
/// stream.stop_capture()?;
/// # Ok(())
/// # }
/// ```
pub struct SCStream {
    ptr: *const c_void,
    identity: StreamIdentity,
    /// Per-stream context holding handlers and delegate (ref-counted).
    context: *mut StreamContext,
}

unsafe impl Send for SCStream {}
unsafe impl Sync for SCStream {}

impl SCStream {
    /// Create a new stream with a content filter and configuration
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use screencapturekit::prelude::*;
    ///
    /// # fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// let content = SCShareableContent::get()?;
    /// let display = &content.displays()[0];
    /// let filter = SCContentFilter::create()
    ///     .with_display(display)
    ///     .with_excluding_windows(&[])
    ///     .build()?;
    /// let config = SCStreamConfiguration::new()
    ///     .with_width(1920)
    ///     .with_height(1080);
    ///
    /// let stream = SCStream::new(&filter, &config)?;
    /// # Ok(())
    /// # }
    /// ```
    #[allow(clippy::missing_errors_doc)]
    pub fn new(filter: &SCContentFilter, configuration: &SCStreamConfiguration) -> SCResult<Self> {
        Self::create(filter, configuration, None)
    }

    /// Create a new stream with a content filter, configuration, and delegate
    ///
    /// The delegate receives callbacks for stream lifecycle events. The key
    /// one is [`did_stop_with_error`](crate::stream::delegate_trait::SCStreamDelegateTrait::did_stop_with_error),
    /// invoked when `ScreenCaptureKit` stops the stream with an error (e.g. the
    /// captured window closes or permission is revoked). A *clean* stop you
    /// requested via [`stop_capture`](Self::stop_capture) is observed through
    /// that call's return value, not the delegate.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use screencapturekit::prelude::*;
    /// use screencapturekit::stream::delegate_trait::StreamCallbacks;
    ///
    /// # fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// let content = SCShareableContent::get()?;
    /// let display = &content.displays()[0];
    /// let filter = SCContentFilter::create()
    ///     .with_display(display)
    ///     .with_excluding_windows(&[])
    ///     .build()?;
    /// let config = SCStreamConfiguration::new()
    ///     .with_width(1920)
    ///     .with_height(1080);
    ///
    /// let delegate = StreamCallbacks::new()
    ///     .on_error(|e| eprintln!("Stream stopped with error: {}", e));
    ///
    /// let stream = SCStream::new_with_delegate(&filter, &config, delegate)?;
    /// stream.start_capture()?;
    /// # Ok(())
    /// # }
    /// ```
    #[allow(clippy::missing_errors_doc)]
    pub fn new_with_delegate(
        filter: &SCContentFilter,
        configuration: &SCStreamConfiguration,
        delegate: impl SCStreamDelegateTrait + 'static,
    ) -> SCResult<Self> {
        Self::create(filter, configuration, Some(Arc::new(delegate)))
    }

    fn create(
        filter: &SCContentFilter,
        configuration: &SCStreamConfiguration,
        delegate: Option<Arc<dyn SCStreamDelegateTrait>>,
    ) -> SCResult<Self> {
        let context = StreamContext::new(delegate);
        let context_ptr = context.cast::<c_void>();
        let configuration = configuration.clone();

        let ptr = unsafe {
            ffi::sc_stream_create(
                filter.as_ptr(),
                configuration.as_ptr(),
                context_ptr,
                delegate_error_callback,
                sample_handler,
                context_retain_cb,
                context_release_cb,
            )
        };

        unsafe { Self::adopt(ptr, context) }
    }

    unsafe fn adopt(ptr: *const c_void, context: *mut StreamContext) -> SCResult<Self> {
        let Some(identity) = StreamIdentity::from_ptr(ptr) else {
            unsafe { StreamContext::release(context) };
            return Err(SCError::null_pointer(
                "ScreenCaptureKit returned no SCStream",
            ));
        };

        // Wire up the remaining delegate callbacks (active / inactive / video
        // effect start / stop). Registration is unconditional: a delegate can
        // be present from the start, and the Rust trampoline is a no-op when
        // there isn't one.
        unsafe { ffi::sc_stream_set_delegate_event_callback(ptr, delegate_event_callback) };

        Ok(Self {
            ptr,
            identity,
            context,
        })
    }

    /// Add an output handler to receive captured frames
    ///
    /// # Arguments
    ///
    /// * `handler` - The handler to receive callbacks. Can be:
    ///   - A struct implementing [`SCStreamOutputTrait`]
    ///   - A closure `|CMSampleBuffer, SCStreamOutputType| { ... }`
    /// * `of_type` - The type of output to receive (Screen, Audio, or Microphone)
    ///
    /// # Returns
    ///
    /// Returns the handler ID, which can be used with
    /// [`remove_output_handler`](Self::remove_output_handler).
    ///
    /// # Errors
    ///
    /// Returns [`SCError::StreamError`] if `ScreenCaptureKit` rejected the
    /// registration (e.g. the output type is not enabled by the stream
    /// configuration), and [`SCError::InvalidConfiguration`] for the requests
    /// [`add_output_handler_with_queue`](Self::add_output_handler_with_queue)
    /// refuses.
    ///
    /// # Dispatch queue
    ///
    /// The handler is invoked on the queue already established for `of_type`,
    /// or — for the first handler of that type — on a dedicated
    /// user-interactive serial dispatch queue created by the bridge. This
    /// intentionally **deviates from
    /// Apple's `SCStream.addStreamOutput`** API, whose `nil` queue parameter
    /// means "deliver on the main queue". Main-queue dispatch only works
    /// when the host process runs a Cocoa runloop, which Rust apps
    /// generally don't, so the default would otherwise silently drop
    /// every frame. Use [`add_output_handler_with_queue`](Self::add_output_handler_with_queue)
    /// and pass an explicit [`DispatchQueue`] (e.g. one wrapping main) if
    /// you need a different queue — including AppKit/UIKit affinity.
    ///
    /// # Examples
    ///
    /// Using a struct:
    /// ```rust,no_run
    /// use screencapturekit::prelude::*;
    ///
    /// struct MyHandler;
    /// impl SCStreamOutputTrait for MyHandler {
    ///     fn did_output_sample_buffer(&self, _sample: CMSampleBuffer, _of_type: SCStreamOutputType) {
    ///         println!("Got frame!");
    ///     }
    /// }
    ///
    /// # fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// # let content = SCShareableContent::get()?;
    /// # let display = &content.displays()[0];
    /// # let filter = SCContentFilter::create().with_display(display).with_excluding_windows(&[]).build()?;
    /// # let config = SCStreamConfiguration::default();
    /// let mut stream = SCStream::new(&filter, &config)?;
    /// stream.add_output_handler(MyHandler, SCStreamOutputType::Screen)?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// Using a closure:
    /// ```rust,no_run
    /// use screencapturekit::prelude::*;
    ///
    /// # fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// # let content = SCShareableContent::get()?;
    /// # let display = &content.displays()[0];
    /// # let filter = SCContentFilter::create().with_display(display).with_excluding_windows(&[]).build()?;
    /// # let config = SCStreamConfiguration::default();
    /// let mut stream = SCStream::new(&filter, &config)?;
    /// stream.add_output_handler(
    ///     |_sample, _type| println!("Got frame!"),
    ///     SCStreamOutputType::Screen
    /// )?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Sharing state with handlers
    ///
    /// The handler bound is `impl SCStreamOutputTrait + 'static`. The
    /// `'static` is required because the handler is stored inside
    /// `SCStream` which can outlive any borrowed reference. Combined
    /// with the trait's `Send + Sync` bound (callbacks run on
    /// independent dispatch queues, see [`SCStreamOutputTrait`]),
    /// the canonical pattern for sharing state with a handler is to
    /// wrap it in `Arc<Mutex<T>>` (or `Arc<AtomicXxx>` for primitives):
    ///
    /// ```rust,no_run
    /// use screencapturekit::prelude::*;
    /// use std::sync::{Arc, Mutex, atomic::{AtomicUsize, Ordering}};
    /// # fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// # let content = SCShareableContent::get()?;
    /// # let display = &content.displays()[0];
    /// # let filter = SCContentFilter::create().with_display(display).with_excluding_windows(&[]).build()?;
    /// # let config = SCStreamConfiguration::default();
    /// let frame_count = Arc::new(AtomicUsize::new(0));
    /// let count_handler = frame_count.clone();
    /// let mut stream = SCStream::new(&filter, &config)?;
    /// stream.add_output_handler(
    ///     move |_sample, _type| {
    ///         count_handler.fetch_add(1, Ordering::Relaxed);
    ///     },
    ///     SCStreamOutputType::Screen,
    /// )?;
    /// // outer scope can still read frame_count any time:
    /// println!("frames so far: {}", frame_count.load(Ordering::Relaxed));
    /// # Ok(())
    /// # }
    /// ```
    pub fn add_output_handler(
        &mut self,
        handler: impl SCStreamOutputTrait + 'static,
        of_type: SCStreamOutputType,
    ) -> Result<usize, SCError> {
        self.add_output_handler_with_queue(handler, of_type, None)
    }

    /// Add an output handler with a custom dispatch queue
    ///
    /// This allows controlling which thread/queue the handler is called on.
    ///
    /// # Arguments
    ///
    /// * `handler` - The handler to receive callbacks
    /// * `of_type` - The type of output to receive
    /// * `queue` - Optional custom dispatch queue for callbacks
    ///
    /// # One queue per output type
    ///
    /// The bridge registers a single native `SCStreamOutput` object per output
    /// type, so `ScreenCaptureKit` delivers **all** handlers of a given type on
    /// **one** queue — the one established by the first successful registration
    /// for that type. Consequences:
    ///
    /// - Adding a further handler for the same type with `queue: None` is fine:
    ///   it joins the established queue.
    /// - Adding a further handler for the same type with a *different* explicit
    ///   queue is rejected with [`SCError::InvalidConfiguration`], rather than
    ///   silently delivering on a queue you did not ask for — that would break
    ///   handlers written around thread affinity.
    /// - Removing the last handler of a type also tears down the native output,
    ///   so the next registration for that type is free to pick a new queue.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use screencapturekit::prelude::*;
    /// use screencapturekit::dispatch_queue::{DispatchQueue, DispatchQoS};
    ///
    /// # fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// # let content = SCShareableContent::get()?;
    /// # let display = &content.displays()[0];
    /// # let filter = SCContentFilter::create().with_display(display).with_excluding_windows(&[]).build()?;
    /// # let config = SCStreamConfiguration::default();
    /// let mut stream = SCStream::new(&filter, &config)?;
    /// let queue = DispatchQueue::new("com.myapp.capture", DispatchQoS::UserInteractive);
    ///
    /// stream.add_output_handler_with_queue(
    ///     |_sample, _type| println!("Got frame on custom queue!"),
    ///     SCStreamOutputType::Screen,
    ///     Some(&queue)
    /// )?;
    /// # Ok(())
    /// # }
    /// ```
    #[allow(clippy::missing_errors_doc)]
    pub fn add_output_handler_with_queue(
        &mut self,
        handler: impl SCStreamOutputTrait + 'static,
        of_type: SCStreamOutputType,
        queue: Option<&DispatchQueue>,
    ) -> Result<usize, SCError> {
        #[cfg(not(feature = "macos_15_0"))]
        if of_type == SCStreamOutputType::Microphone {
            return Err(SCError::invalid_config(
                "microphone output requires the macos_15_0 feature",
            ));
        }

        let requested = queue.map_or(OutputQueue::BridgeDefault, |q| {
            OutputQueue::Custom(q.as_ptr() as usize)
        });

        // SAFETY: self.context is the Box::into_raw StreamContext created in
        // SCStream::create; it stays valid for the lifetime of self (released
        // only in Drop, after this method returns).
        let ctx = unsafe { &*self.context };
        let _mutation_guard = ctx
            .output_mutation
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner);

        let mut established = ctx
            .output_queues
            .write()
            .unwrap_or_else(std::sync::PoisonError::into_inner);

        if let Some(&(_, existing)) = established.iter().find(|(ty, _)| *ty == of_type) {
            if queue.is_some() && existing != requested {
                drop(established);
                return Err(SCError::invalid_config(format!(
                    "refusing to add a {of_type:?} handler on a different dispatch queue — \
                     ScreenCaptureKit delivers every handler of one output type on the queue \
                     chosen by the first registration. Reuse that queue (pass None) or remove \
                     the existing {of_type:?} handlers first."
                )));
            }
        }

        let output_type_int = native_output_type(of_type);

        let ok = if let Some(q) = queue {
            unsafe {
                ffi::sc_stream_add_stream_output_with_queue(self.ptr, output_type_int, q.as_ptr())
            }
        } else {
            unsafe { ffi::sc_stream_add_stream_output(self.ptr, output_type_int) }
        };

        if !ok {
            drop(established);
            return Err(SCError::StreamError(format!(
                "failed to register output handler for {of_type:?} \
                 (ScreenCaptureKit rejected addStreamOutput)"
            )));
        }

        if !established.iter().any(|(ty, _)| *ty == of_type) {
            established.push((of_type, requested));
        }
        drop(established);

        let handler_id = NEXT_HANDLER_ID.fetch_add(1, Ordering::Relaxed);
        ctx.handlers
            .write()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .push(HandlerEntry {
                id: handler_id,
                of_type,
                handler: Arc::new(handler),
            });
        Ok(handler_id)
    }

    /// Remove an output handler
    ///
    /// # Arguments
    ///
    /// * `id` - The handler ID returned from [`add_output_handler`](Self::add_output_handler)
    /// * `of_type` - The type of output the handler was registered for
    ///
    /// # Returns
    ///
    /// Returns `Ok(true)` if a handler with this `id` **and** output type was
    /// found and removed, and `Ok(false)` if there was no such handler.
    ///
    /// # Errors
    ///
    /// Returns [`SCError::StreamError`] when the handler was removed from this
    /// stream but `removeStreamOutput` failed on the `ScreenCaptureKit` side.
    /// The handler stops receiving samples either way; a native teardown
    /// failure only means `ScreenCaptureKit` keeps delivering samples that the
    /// bridge then discards.
    pub fn remove_output_handler(
        &mut self,
        id: usize,
        of_type: SCStreamOutputType,
    ) -> Result<bool, SCError> {
        // SAFETY: self.context is the Box::into_raw StreamContext created in
        // SCStream::create; it stays valid for the lifetime of self.
        let ctx = unsafe { &*self.context };
        let mutation_guard = ctx
            .output_mutation
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner);

        let mut handlers = ctx
            .handlers
            .write()
            .unwrap_or_else(std::sync::PoisonError::into_inner);
        // Match on the output type too: the same id registered for a different
        // type must not be silently removed by a mismatched call, which would
        // also detach the wrong native output.
        let Some(pos) = handlers
            .iter()
            .position(|e| e.id == id && e.of_type == of_type)
        else {
            return Ok(false);
        };
        let removed_handler = handlers.remove(pos);

        // If no more handlers for this output type, tell Swift to remove the output
        let has_type = handlers.iter().any(|e| e.of_type == of_type);
        drop(handlers);

        let result = if has_type {
            Ok(true)
        } else {
            let removed = unsafe {
                ffi::sc_stream_remove_stream_output(self.ptr, native_output_type(of_type))
            };

            if removed {
                // The next registration for this type may choose a fresh queue.
                ctx.output_queues
                    .write()
                    .unwrap_or_else(std::sync::PoisonError::into_inner)
                    .retain(|(ty, _)| *ty != of_type);
                Ok(true)
            } else {
                Err(SCError::StreamError(format!(
                    "ScreenCaptureKit rejected removeStreamOutput for {of_type:?}; the handler was \
                     detached but the native output is still registered"
                )))
            }
        };

        drop(mutation_guard);
        drop(removed_handler);
        result
    }

    /// Start capturing screen content
    ///
    /// This method blocks until the capture operation completes or fails.
    ///
    /// # Errors
    ///
    /// Returns `SCError::CaptureStartFailed` if the capture fails to start.
    pub fn start_capture(&self) -> Result<(), SCError> {
        let context = unsafe { &*self.context };
        if !claim_start(&context.capturing, &context.start_unconfirmed) {
            return Ok(());
        }
        let (completion, context) = UnitCompletion::new();
        unsafe { ffi::sc_stream_start_capture(self.ptr, context, UnitCompletion::callback) };
        match completion.wait() {
            Ok(()) => Ok(()),
            Err(error) => {
                let context = unsafe { &*self.context };
                if is_timeout_error(&error) {
                    // The native start is still outstanding, so clearing
                    // `capturing` would let a retry double-start. Record that
                    // the outcome is unconfirmed instead, so the next start
                    // reissues rather than reporting a success nobody observed.
                    context.start_unconfirmed.store(true, Ordering::Release);
                } else {
                    context.capturing.store(false, Ordering::Release);
                }
                Err(SCError::CaptureStartFailed(error))
            }
        }
    }

    /// Stop capturing screen content
    ///
    /// This method blocks until the capture operation completes or fails.
    ///
    /// # Errors
    ///
    /// Returns `SCError::CaptureStopFailed` if the capture fails to stop.
    pub fn stop_capture(&self) -> Result<(), SCError> {
        let context = unsafe { &*self.context };
        if !context.capturing.swap(false, Ordering::AcqRel) {
            return Ok(());
        }
        let (completion, context) = UnitCompletion::new();
        unsafe { ffi::sc_stream_stop_capture(self.ptr, context, UnitCompletion::callback) };
        if let Err(error) = completion.wait() {
            unsafe { &*self.context }
                .capturing
                .store(true, Ordering::Release);
            return Err(SCError::CaptureStopFailed(error));
        }
        Ok(())
    }

    /// Update the stream configuration
    ///
    /// This method blocks until the configuration update completes or fails.
    ///
    /// # Errors
    ///
    /// Returns `SCError::StreamError` if the configuration update fails.
    #[cfg(feature = "macos_14_0")]
    pub fn update_configuration(
        &self,
        configuration: &SCStreamConfiguration,
    ) -> Result<(), SCError> {
        let configuration = configuration.clone();
        let (completion, context) = UnitCompletion::new();
        unsafe {
            ffi::sc_stream_update_configuration(
                self.ptr,
                configuration.as_ptr(),
                context,
                UnitCompletion::callback,
            );
        }
        completion.wait().map_err(SCError::StreamError)
    }

    /// Update the content filter
    ///
    /// This method blocks until the filter update completes or fails.
    ///
    /// # Errors
    ///
    /// Returns `SCError::StreamError` if the filter update fails.
    pub fn update_content_filter(&self, filter: &SCContentFilter) -> Result<(), SCError> {
        let (completion, context) = UnitCompletion::new();
        unsafe {
            ffi::sc_stream_update_content_filter(
                self.ptr,
                filter.as_ptr(),
                context,
                UnitCompletion::callback,
            );
        }
        completion.wait().map_err(SCError::StreamError)
    }

    /// Get the synchronization clock for this stream (macOS 13.0+)
    ///
    /// Returns the `CMClock` used to synchronize the stream's output.
    /// This is useful for coordinating multiple streams or synchronizing
    /// with other media.
    ///
    /// Returns `None` if the clock is not available (e.g., stream not started
    /// or macOS version too old).
    #[cfg(feature = "macos_13_0")]
    pub fn synchronization_clock(&self) -> Option<crate::cm::CMClock> {
        let ptr = unsafe { ffi::sc_stream_get_synchronization_clock(self.ptr) };
        // SAFETY: the Swift thunk transfers a +1 retained clock reference.
        #[allow(unused_unsafe)]
        unsafe {
            crate::cm::CMClock::from_raw(ptr)
        }
    }

    /// Add a recording output to the stream (macOS 15.0+)
    ///
    /// Starts recording if the stream is already capturing, otherwise recording
    /// will start when capture begins. The recording is written to the file URL
    /// specified in the `SCRecordingOutputConfiguration`.
    ///
    /// # Errors
    ///
    /// Returns `SCError::StreamError` if adding the recording output fails.
    #[cfg(feature = "macos_15_0")]
    pub fn add_recording_output(
        &self,
        recording_output: &crate::recording_output::SCRecordingOutput,
    ) -> Result<(), SCError> {
        let stream_context = unsafe { &*self.context };
        let (completion, context) = UnitCompletion::new();
        unsafe {
            ffi::sc_stream_add_recording_output(
                self.ptr,
                recording_output.as_ptr(),
                UnitCompletion::callback,
                context,
            );
        }
        completion.wait().map_err(SCError::StreamError)?;
        stream_context
            .recording_outputs
            .fetch_add(1, Ordering::AcqRel);
        Ok(())
    }

    /// Remove a recording output from the stream (macOS 15.0+)
    ///
    /// Stops recording if the stream is currently recording.
    ///
    /// # Errors
    ///
    /// Returns `SCError::StreamError` if removing the recording output fails.
    #[cfg(feature = "macos_15_0")]
    pub fn remove_recording_output(
        &self,
        recording_output: &crate::recording_output::SCRecordingOutput,
    ) -> Result<(), SCError> {
        let context = unsafe { &*self.context };
        if context.capturing.load(Ordering::Acquire)
            && !context.has_handlers()
            && context.recording_outputs.load(Ordering::Acquire) == 1
        {
            self.stop_capture()?;
            let (completion, completion_context) = UnitCompletion::new();
            unsafe {
                ffi::sc_recording_output_wait_until_terminal(
                    recording_output.as_ptr(),
                    completion_context,
                    UnitCompletion::callback,
                );
            }
            completion.wait().map_err(SCError::StreamError)?;
        }
        let (completion, completion_context) = UnitCompletion::new();
        unsafe {
            ffi::sc_stream_remove_recording_output(
                self.ptr,
                recording_output.as_ptr(),
                UnitCompletion::callback,
                completion_context,
            );
        }
        let outcome = completion.wait();
        // Swift reports failure only when the native removal itself threw; a
        // timeout can therefore only expire while waiting for the movie to
        // finalize, by which point the output is already gone. Leaving the
        // count inflated there would permanently disable the stop-and-flush
        // branch above for whichever outputs remain.
        let removed = match &outcome {
            Ok(()) => true,
            Err(error) => is_timeout_error(error),
        };
        if removed {
            context
                .recording_outputs
                .fetch_update(Ordering::AcqRel, Ordering::Acquire, |count| {
                    Some(count.saturating_sub(1))
                })
                .ok();
        }
        outcome.map_err(SCError::StreamError)?;
        Ok(())
    }

    /// Returns the raw pointer to the underlying Swift `SCStream` instance.
    #[allow(dead_code)]
    pub(crate) fn as_ptr(&self) -> *const c_void {
        self.ptr
    }

    /// Return a stable, non-owning identity for this stream.
    #[must_use]
    pub fn identity(&self) -> StreamIdentity {
        self.identity
    }

    #[cfg(feature = "async")]
    pub(crate) fn capture_state(&self) -> Arc<AtomicBool> {
        Arc::clone(&unsafe { &*self.context }.capturing)
    }

    #[cfg(feature = "async")]
    pub(crate) fn start_unconfirmed_state(&self) -> Arc<AtomicBool> {
        Arc::clone(&unsafe { &*self.context }.start_unconfirmed)
    }
}

/// Claims the right to issue a native `startCapture`.
///
/// Returns `false` when the stream is already capturing and the previous start
/// was confirmed, so the caller can report success without a redundant FFI
/// call. `start_unconfirmed` is always cleared, since a flag left set past a
/// successful start would later reissue a start on a live stream.
pub(crate) fn claim_start(capturing: &AtomicBool, start_unconfirmed: &AtomicBool) -> bool {
    let was_capturing = capturing.swap(true, Ordering::AcqRel);
    let unconfirmed = start_unconfirmed.swap(false, Ordering::AcqRel);
    !was_capturing || unconfirmed
}

impl Drop for SCStream {
    // Safety / teardown ordering:
    //
    // `sc_stream_release` drops this handle's claim on the Swift-side
    // `StreamState` and releases the `SCStream`. The `StreamState` — and with
    // it the stream-output delegate — is discarded only when the *last* handle
    // (this stream plus every clone) is gone, so dropping one clone never
    // detaches the callbacks of the survivors. We release the `StreamContext`
    // afterwards, so the ordering here is release-stream-then-release-context.
    //
    // In-flight callbacks are safe even though Apple's stop is asynchronous: the
    // Swift `StreamDelegateWrapper` and `StreamOutputHandler` objects each hold
    // their own +1 reference on the `StreamContext` (taken in `init` via
    // `context_retain_cb`, dropped in `deinit` via `context_release_cb`). Each
    // callback runs as a method on one of those objects, and ARC keeps that
    // object (`self`) alive for the duration of the call, so its context
    // reference is also held for the duration of the call. Therefore a callback
    // already in flight can never observe a freed context: the final
    // `Box::from_raw` only happens once every holder — this Rust `SCStream` and
    // both Swift bridge objects — has released its reference.
    //
    // Refcount accounting: `StreamContext::new` starts at 1; the Swift
    // `createStream` adds +1 per bridge object (delegate + output handler) = 3;
    // each Rust clone adds +1; each `drop` removes -1; each bridge object's
    // `deinit` removes -1, and the context is freed when the total reaches 0.
    fn drop(&mut self) {
        unsafe { ffi::sc_stream_release(self.ptr) };
        unsafe { StreamContext::release(self.context) };
    }
}

impl Clone for SCStream {
    /// Clone the stream reference.
    ///
    /// Cloning an `SCStream` creates a new reference to the same underlying
    /// Swift `SCStream` object. The cloned stream shares the same handlers
    /// as the original — they receive frames from the same capture session.
    ///
    /// Both the original and cloned stream share the same capture state, so:
    /// - Starting capture on one affects both
    /// - Stopping capture on one affects both
    /// - Configuration updates affect both
    /// - Handlers receive the same frames
    /// - Dropping one clone leaves the others fully functional; capture and
    ///   delegate callbacks stop only once the last clone is dropped
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use screencapturekit::prelude::*;
    ///
    /// # fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// # let content = SCShareableContent::get()?;
    /// # let display = &content.displays()[0];
    /// # let filter = SCContentFilter::create().with_display(display).with_excluding_windows(&[]).build()?;
    /// # let config = SCStreamConfiguration::default();
    /// let mut stream = SCStream::new(&filter, &config)?;
    /// stream.add_output_handler(|_, _| println!("Handler 1"), SCStreamOutputType::Screen)?;
    ///
    /// // Clone shares the same handlers
    /// let stream2 = stream.clone();
    /// // Both stream and stream2 will receive frames via Handler 1
    /// # Ok(())
    /// # }
    /// ```
    fn clone(&self) -> Self {
        unsafe { StreamContext::retain(self.context) };

        Self {
            ptr: unsafe { crate::ffi::sc_stream_retain(self.ptr) },
            identity: self.identity,
            context: self.context,
        }
    }
}

impl fmt::Debug for SCStream {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("SCStream")
            .field("ptr", &self.ptr)
            .finish_non_exhaustive()
    }
}

impl fmt::Display for SCStream {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "SCStream")
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::atomic::AtomicUsize;
    use std::sync::Arc;

    /// Regression test for #135: multiple concurrent streams must not leak
    /// samples across each other.
    ///
    /// Creates two independent `StreamContexts` with separate handlers and
    /// directly invokes each context's handlers. Verifies that each handler
    /// only receives calls routed through its own context — not from the
    /// other context. With the old global `HANDLER_REGISTRY`, both handlers
    /// would have been called for every callback regardless of context.
    #[test]
    fn test_per_stream_callback_isolation() {
        let count_a = Arc::new(AtomicUsize::new(0));
        let count_b = Arc::new(AtomicUsize::new(0));

        // Create two independent contexts (simulates two SCStream instances)
        let ctx_a = StreamContext::new(None);
        let ctx_b = StreamContext::new(None);

        // Register an audio handler on context A
        {
            let counter = count_a.clone();
            let mut handlers = unsafe { &*ctx_a }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            handlers.push(HandlerEntry {
                id: 1,
                of_type: SCStreamOutputType::Audio,
                handler: Arc::new(
                    move |buf: crate::cm::CMSampleBuffer, _ty: SCStreamOutputType| {
                        counter.fetch_add(1, Ordering::Relaxed);
                        // Prevent Drop from calling cm_sample_buffer_release on our fake pointer
                        std::mem::forget(buf);
                    },
                ),
            });
        }

        // Register an audio handler on context B
        {
            let counter = count_b.clone();
            let mut handlers = unsafe { &*ctx_b }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            handlers.push(HandlerEntry {
                id: 2,
                of_type: SCStreamOutputType::Audio,
                handler: Arc::new(
                    move |buf: crate::cm::CMSampleBuffer, _ty: SCStreamOutputType| {
                        counter.fetch_add(1, Ordering::Relaxed);
                        std::mem::forget(buf);
                    },
                ),
            });
        }

        // Simulate 5 audio callbacks on context A by directly calling matching handlers
        for _ in 0..5 {
            let handlers = unsafe { &*ctx_a }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            for entry in handlers
                .iter()
                .filter(|e| e.of_type == SCStreamOutputType::Audio)
            {
                let buf = unsafe { crate::cm::CMSampleBuffer::from_ptr(std::ptr::null_mut()) };
                entry
                    .handler
                    .did_output_sample_buffer(buf, SCStreamOutputType::Audio);
            }
        }

        // Simulate 3 audio callbacks on context B
        for _ in 0..3 {
            let handlers = unsafe { &*ctx_b }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            for entry in handlers
                .iter()
                .filter(|e| e.of_type == SCStreamOutputType::Audio)
            {
                let buf = unsafe { crate::cm::CMSampleBuffer::from_ptr(std::ptr::null_mut()) };
                entry
                    .handler
                    .did_output_sample_buffer(buf, SCStreamOutputType::Audio);
            }
        }

        // Handler A must have received exactly 5 — not 8
        assert_eq!(
            count_a.load(Ordering::Relaxed),
            5,
            "handler A received callbacks meant for B (cross-stream leak)"
        );
        // Handler B must have received exactly 3 — not 8
        assert_eq!(
            count_b.load(Ordering::Relaxed),
            3,
            "handler B received callbacks meant for A (cross-stream leak)"
        );

        unsafe {
            StreamContext::release(ctx_a);
            StreamContext::release(ctx_b);
        }
    }

    /// Verify that handlers are filtered by output type within a single context.
    #[test]
    fn test_handler_output_type_filtering() {
        let screen_count = Arc::new(AtomicUsize::new(0));
        let audio_count = Arc::new(AtomicUsize::new(0));

        let ctx = StreamContext::new(None);

        {
            let counter = screen_count.clone();
            let mut handlers = unsafe { &*ctx }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            handlers.push(HandlerEntry {
                id: 1,
                of_type: SCStreamOutputType::Screen,
                handler: Arc::new(
                    move |buf: crate::cm::CMSampleBuffer, _ty: SCStreamOutputType| {
                        counter.fetch_add(1, Ordering::Relaxed);
                        std::mem::forget(buf);
                    },
                ),
            });
        }
        {
            let counter = audio_count.clone();
            let mut handlers = unsafe { &*ctx }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            handlers.push(HandlerEntry {
                id: 2,
                of_type: SCStreamOutputType::Audio,
                handler: Arc::new(
                    move |buf: crate::cm::CMSampleBuffer, _ty: SCStreamOutputType| {
                        counter.fetch_add(1, Ordering::Relaxed);
                        std::mem::forget(buf);
                    },
                ),
            });
        }

        // Send 4 screen callbacks
        for _ in 0..4 {
            let handlers = unsafe { &*ctx }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            for entry in handlers
                .iter()
                .filter(|e| e.of_type == SCStreamOutputType::Screen)
            {
                let buf = unsafe { crate::cm::CMSampleBuffer::from_ptr(std::ptr::null_mut()) };
                entry
                    .handler
                    .did_output_sample_buffer(buf, SCStreamOutputType::Screen);
            }
        }

        // Send 2 audio callbacks
        for _ in 0..2 {
            let handlers = unsafe { &*ctx }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            for entry in handlers
                .iter()
                .filter(|e| e.of_type == SCStreamOutputType::Audio)
            {
                let buf = unsafe { crate::cm::CMSampleBuffer::from_ptr(std::ptr::null_mut()) };
                entry
                    .handler
                    .did_output_sample_buffer(buf, SCStreamOutputType::Audio);
            }
        }

        assert_eq!(screen_count.load(Ordering::Relaxed), 4);
        assert_eq!(audio_count.load(Ordering::Relaxed), 2);

        unsafe { StreamContext::release(ctx) };
    }

    /// Verify that `StreamContext` ref counting works correctly.
    #[test]
    fn test_stream_context_ref_counting() {
        let ctx = StreamContext::new(None);

        // Initial ref count is 1
        assert_eq!(unsafe { &*ctx }.ref_count.load(Ordering::Relaxed), 1);

        // Retain bumps to 2
        unsafe { StreamContext::retain(ctx) };
        assert_eq!(unsafe { &*ctx }.ref_count.load(Ordering::Relaxed), 2);

        // First release drops to 1 — context still alive
        unsafe { StreamContext::release(ctx) };
        assert_eq!(unsafe { &*ctx }.ref_count.load(Ordering::Relaxed), 1);

        // Second release drops to 0 — context freed (no crash = success)
        unsafe { StreamContext::release(ctx) };
    }

    /// Regression test: a panic in a user-supplied output handler must NOT
    /// poison the handlers `RwLock`, must NOT propagate across the C ABI,
    /// and must NOT prevent subsequent callbacks from being dispatched.
    ///
    /// This validates the C1+C2 fix from the deep review: `catch_unwind`
    /// around user dispatch and `RwLock` poisoning recovery via
    /// `unwrap_or_else(PoisonError::into_inner)` together prevent one
    /// panicking handler from permanently breaking the stream.
    #[test]
    fn test_panic_in_handler_is_isolated() {
        // Set a no-op panic hook so our intentional panic doesn't spam the
        // test output. We restore it at the end of the test.
        let original_hook = std::panic::take_hook();
        std::panic::set_hook(Box::new(|_| {}));

        let panicked_count = Arc::new(AtomicUsize::new(0));
        let normal_count = Arc::new(AtomicUsize::new(0));

        let ctx = StreamContext::new(None);

        // Handler 1: always panics
        {
            let counter = panicked_count.clone();
            let mut handlers = unsafe { &*ctx }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            handlers.push(HandlerEntry {
                id: 1,
                of_type: SCStreamOutputType::Audio,
                handler: Arc::new(
                    move |buf: crate::cm::CMSampleBuffer, _ty: SCStreamOutputType| {
                        counter.fetch_add(1, Ordering::Relaxed);
                        std::mem::forget(buf);
                        panic!("intentional test panic");
                    },
                ),
            });
        }

        // Handler 2: well-behaved, registered AFTER the panicker
        {
            let counter = normal_count.clone();
            let mut handlers = unsafe { &*ctx }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            handlers.push(HandlerEntry {
                id: 2,
                of_type: SCStreamOutputType::Audio,
                handler: Arc::new(
                    move |buf: crate::cm::CMSampleBuffer, _ty: SCStreamOutputType| {
                        counter.fetch_add(1, Ordering::Relaxed);
                        std::mem::forget(buf);
                    },
                ),
            });
        }

        // Simulate 5 callbacks. Each iteration, the panicker fires (and
        // panics), then the well-behaved handler must still fire on the
        // SAME callback because both handlers match the output type. We
        // simulate the dispatch path without going through the C callback
        // (which would require a real CMSampleBuffer); the key behaviour
        // we're verifying is that the lock isn't poisoned and that the
        // catch_unwind boundary contains the panic.
        for _ in 0..5 {
            let handlers = unsafe { &*ctx }
                .handlers
                .read()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            for entry in handlers
                .iter()
                .filter(|e| e.of_type == SCStreamOutputType::Audio)
            {
                let buf = unsafe { crate::cm::CMSampleBuffer::from_ptr(std::ptr::null_mut()) };
                catch_user_panic("test handler", || {
                    entry
                        .handler
                        .did_output_sample_buffer(buf, SCStreamOutputType::Audio);
                });
            }
        }

        // Both handlers fired 5 times each — the panicker did not stop the
        // dispatch loop or poison the lock for subsequent reads.
        assert_eq!(
            panicked_count.load(Ordering::Relaxed),
            5,
            "panicking handler stopped firing after first panic"
        );
        assert_eq!(
            normal_count.load(Ordering::Relaxed),
            5,
            "well-behaved handler stopped firing after panicker poisoned state"
        );

        // Lock is still acquirable (would otherwise be poisoned).
        drop(
            unsafe { &*ctx }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner),
        );

        unsafe { StreamContext::release(ctx) };

        // Restore the original panic hook so other tests behave normally.
        std::panic::set_hook(original_hook);
    }

    /// Regression test: dispatching a sample must not hold the handlers lock,
    /// so a handler is free to mutate the handler set from inside the
    /// callback. Under the previous read-lock-across-dispatch design this
    /// deadlocked on the `RwLock` upgrade.
    #[test]
    fn test_handler_may_take_the_write_lock_from_inside_a_callback() {
        struct Reentrant(*mut StreamContext);
        // SAFETY: the pointer is only used to take the same locks the real
        // callback path takes; the context outlives the handler in this test.
        unsafe impl Send for Reentrant {}
        unsafe impl Sync for Reentrant {}

        impl SCStreamOutputTrait for Reentrant {
            fn did_output_sample_buffer(
                &self,
                buffer: crate::cm::CMSampleBuffer,
                _of_type: SCStreamOutputType,
            ) {
                std::mem::forget(buffer);
                // Would deadlock if the dispatch path still held a read lock.
                let mut handlers = unsafe { &*self.0 }
                    .handlers
                    .write()
                    .unwrap_or_else(std::sync::PoisonError::into_inner);
                handlers.retain(|e| e.id != 1);
            }
        }

        let ctx = StreamContext::new(None);
        unsafe { &*ctx }
            .handlers
            .write()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .push(HandlerEntry {
                id: 1,
                of_type: SCStreamOutputType::Screen,
                handler: Arc::new(Reentrant(ctx)),
            });

        for handler in unsafe { &*ctx }.handler_snapshot(SCStreamOutputType::Screen) {
            let buffer = unsafe { crate::cm::CMSampleBuffer::from_ptr(std::ptr::null_mut()) };
            handler.did_output_sample_buffer(buffer, SCStreamOutputType::Screen);
        }

        assert!(
            unsafe { &*ctx }
                .handler_snapshot(SCStreamOutputType::Screen)
                .is_empty(),
            "handler failed to remove itself from inside its own callback"
        );

        unsafe { StreamContext::release(ctx) };
    }

    /// A handler removed while a sample is already being dispatched must stay
    /// alive for that call — the snapshot holds an `Arc`, so the removal can
    /// never free a handler out from under a running callback.
    #[test]
    fn test_snapshot_keeps_a_concurrently_removed_handler_alive() {
        let ctx = StreamContext::new(None);
        let calls = Arc::new(AtomicUsize::new(0));

        {
            let counter = calls.clone();
            unsafe { &*ctx }
                .handlers
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner)
                .push(HandlerEntry {
                    id: 1,
                    of_type: SCStreamOutputType::Audio,
                    handler: Arc::new(
                        move |buf: crate::cm::CMSampleBuffer, _ty: SCStreamOutputType| {
                            counter.fetch_add(1, Ordering::Relaxed);
                            std::mem::forget(buf);
                        },
                    ),
                });
        }

        let snapshot = unsafe { &*ctx }.handler_snapshot(SCStreamOutputType::Audio);

        // Remove the handler *after* the snapshot was taken, mirroring a
        // `remove_output_handler` racing an in-flight callback.
        unsafe { &*ctx }
            .handlers
            .write()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .clear();

        for handler in &snapshot {
            let buffer = unsafe { crate::cm::CMSampleBuffer::from_ptr(std::ptr::null_mut()) };
            handler.did_output_sample_buffer(buffer, SCStreamOutputType::Audio);
        }

        assert_eq!(calls.load(Ordering::Relaxed), 1);
        // The next dispatch sees the removal.
        assert!(unsafe { &*ctx }
            .handler_snapshot(SCStreamOutputType::Audio)
            .is_empty());

        unsafe { StreamContext::release(ctx) };
    }

    /// The delegate snapshot must clone the `Arc` out rather than dispatch
    /// under the lock, so a delegate can register handlers (or otherwise
    /// re-enter the stream) from its own callback.
    #[test]
    fn test_delegate_snapshot_runs_user_code_unlocked() {
        struct Counting(Arc<AtomicUsize>);
        impl SCStreamDelegateTrait for Counting {
            fn stream_did_become_active(&self) {
                self.0.fetch_add(1, Ordering::Relaxed);
            }
        }

        let calls = Arc::new(AtomicUsize::new(0));
        let ctx = StreamContext::new(Some(Arc::new(Counting(calls.clone()))));

        let delegate = unsafe { &*ctx }
            .delegate_snapshot()
            .expect("delegate should be present");
        // The lock is free while user code runs.
        assert!(unsafe { &*ctx }.delegate.try_write().is_ok());
        delegate.stream_did_become_active();

        assert_eq!(calls.load(Ordering::Relaxed), 1);

        unsafe { StreamContext::release(ctx) };
    }

    /// Regression test: the four non-error `SCStreamDelegate` callbacks used
    /// to be dead code — the bridge never had a trampoline to reach them.
    /// This pins the event-code mapping shared with `Stream.swift`.
    #[test]
    fn test_delegate_event_callback_routes_each_event_code() {
        #[derive(Default)]
        struct Recorder {
            events: std::sync::Mutex<Vec<&'static str>>,
        }
        impl Recorder {
            fn record(&self, what: &'static str) {
                self.events
                    .lock()
                    .unwrap_or_else(std::sync::PoisonError::into_inner)
                    .push(what);
            }
        }
        impl SCStreamDelegateTrait for Arc<Recorder> {
            fn stream_did_become_active(&self) {
                self.record("active");
            }
            fn stream_did_become_inactive(&self) {
                self.record("inactive");
            }
            fn output_video_effect_did_start_for_stream(&self) {
                self.record("effect_start");
            }
            fn output_video_effect_did_stop_for_stream(&self) {
                self.record("effect_stop");
            }
        }

        let recorder = Arc::new(Recorder::default());
        let ctx = StreamContext::new(Some(Arc::new(Arc::clone(&recorder))));

        for event in 0..4 {
            delegate_event_callback(ctx.cast::<c_void>(), event);
        }
        // Unknown codes are logged, not dispatched, and must not panic.
        delegate_event_callback(ctx.cast::<c_void>(), 99);
        // A null context is ignored rather than dereferenced.
        delegate_event_callback(std::ptr::null_mut(), 0);

        assert_eq!(
            *recorder
                .events
                .lock()
                .unwrap_or_else(std::sync::PoisonError::into_inner),
            vec!["active", "inactive", "effect_start", "effect_stop"]
        );

        unsafe { StreamContext::release(ctx) };
    }

    /// A stream with no delegate must swallow lifecycle events instead of
    /// dereferencing a missing one.
    #[test]
    fn test_delegate_event_callback_without_a_delegate_is_a_noop() {
        let ctx = StreamContext::new(None);
        for event in 0..4 {
            delegate_event_callback(ctx.cast::<c_void>(), event);
        }
        unsafe { StreamContext::release(ctx) };
    }

    #[test]
    fn test_null_native_stream_is_rejected_and_releases_its_context() {
        let ctx = StreamContext::new(None);
        unsafe { StreamContext::retain(ctx) };

        let result = unsafe { SCStream::adopt(std::ptr::null(), ctx) };

        assert!(matches!(result, Err(SCError::NullPointer(_))));
        assert_eq!(unsafe { &*ctx }.ref_count.load(Ordering::Relaxed), 1);
        unsafe { StreamContext::release(ctx) };
    }

    #[test]
    fn test_stream_identity_rejects_null() {
        assert!(StreamIdentity::from_ptr(std::ptr::null()).is_none());
        let value = 0x1000_usize as *const c_void;
        assert_eq!(
            StreamIdentity::from_ptr(value),
            NonZeroUsize::new(0x1000).map(StreamIdentity)
        );
    }

    #[test]
    fn test_claim_start_skips_the_native_call_while_capturing() {
        let capturing = AtomicBool::new(false);
        let unconfirmed = AtomicBool::new(false);

        assert!(claim_start(&capturing, &unconfirmed));
        assert!(!claim_start(&capturing, &unconfirmed));
    }

    /// A start whose completion timed out left `capturing` latched without a
    /// confirmed outcome, so the retry must reissue rather than report the
    /// success nobody observed.
    #[test]
    fn test_claim_start_reissues_after_an_unconfirmed_start() {
        let capturing = AtomicBool::new(true);
        let unconfirmed = AtomicBool::new(true);

        assert!(claim_start(&capturing, &unconfirmed));
        assert!(!claim_start(&capturing, &unconfirmed));
    }

    /// The flag must not outlive the retry that consumed it, or a later start
    /// on a live stream would reissue against `ScreenCaptureKit`.
    #[test]
    fn test_claim_start_clears_the_flag_even_when_idle() {
        let capturing = AtomicBool::new(false);
        let unconfirmed = AtomicBool::new(true);

        assert!(claim_start(&capturing, &unconfirmed));
        assert!(!unconfirmed.load(Ordering::Acquire));
        assert!(!claim_start(&capturing, &unconfirmed));
    }
}