screencapturekit 9.0.1

Safe Rust bindings for Apple's ScreenCaptureKit framework - screen and audio capture on macOS
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
//! Raw FFI bindings for Core Media types.
//!
//! These are low-level bindings and are not intended for direct use.
#![allow(missing_docs)]

extern "C" {
    pub fn cm_sample_buffer_get_image_buffer(
        sample_buffer: *mut std::ffi::c_void,
    ) -> *mut std::ffi::c_void;
    pub fn cm_sample_buffer_get_frame_status(sample_buffer: *mut std::ffi::c_void) -> i32;

    /// Build a retained `CGImage` from the sample buffer's image buffer via
    /// `VTCreateCGImageFromCVPixelBuffer`. Returns null on failure with
    /// `out_status` set to the underlying `OSStatus` (0 = `noErr` on success).
    pub fn cm_sample_buffer_create_cg_image(
        sample_buffer: *mut std::ffi::c_void,
        out_status: *mut i32,
    ) -> *const std::ffi::c_void;

    // Frame info accessors
    pub fn cm_sample_buffer_get_display_time(
        sample_buffer: *mut std::ffi::c_void,
        out_value: *mut u64,
    ) -> bool;
    pub fn cm_sample_buffer_get_scale_factor(
        sample_buffer: *mut std::ffi::c_void,
        out_value: *mut f64,
    ) -> bool;
    pub fn cm_sample_buffer_get_content_scale(
        sample_buffer: *mut std::ffi::c_void,
        out_value: *mut f64,
    ) -> bool;
    pub fn cm_sample_buffer_get_content_rect(
        sample_buffer: *mut std::ffi::c_void,
        out_x: *mut f64,
        out_y: *mut f64,
        out_width: *mut f64,
        out_height: *mut f64,
    ) -> bool;
    pub fn cm_sample_buffer_get_bounding_rect(
        sample_buffer: *mut std::ffi::c_void,
        out_x: *mut f64,
        out_y: *mut f64,
        out_width: *mut f64,
        out_height: *mut f64,
    ) -> bool;
    pub fn cm_sample_buffer_get_screen_rect(
        sample_buffer: *mut std::ffi::c_void,
        out_x: *mut f64,
        out_y: *mut f64,
        out_width: *mut f64,
        out_height: *mut f64,
    ) -> bool;
    #[cfg(feature = "macos_14_2")]
    pub fn cm_sample_buffer_get_presenter_overlay_content_rect(
        sample_buffer: *mut std::ffi::c_void,
        out_x: *mut f64,
        out_y: *mut f64,
        out_width: *mut f64,
        out_height: *mut f64,
    ) -> bool;
    pub fn cm_sample_buffer_get_dirty_rects(
        sample_buffer: *mut std::ffi::c_void,
        out_rects: *mut *mut std::ffi::c_void,
        out_count: *mut usize,
    ) -> bool;
    pub fn cm_sample_buffer_free_dirty_rects(rects_ptr: *mut std::ffi::c_void);

    /// Single-call frame attachment fetch — populates `out_fields` with bits
    /// for each successfully-read field. See `FrameInfoFields` for the bit
    /// layout. Replaces the per-attribute accessors above for the hot path
    /// (one attachment-array fetch + one CF→Swift bridge cast vs. one per
    /// field), measured at ~4× faster when reading multiple fields per frame.
    ///
    /// When the `DIRTY_RECTS` bit is set, `out_dirty_rects` receives a
    /// bridge-allocated `[x, y, w, h] * out_dirty_rects_count` array that the
    /// caller must hand back via `cm_sample_buffer_free_dirty_rects`.
    pub fn cm_sample_buffer_get_frame_info(
        sample_buffer: *mut std::ffi::c_void,
        out_fields: *mut u32,
        out_status: *mut i32,
        out_display_time: *mut u64,
        out_scale_factor: *mut f64,
        out_content_scale: *mut f64,
        out_content_rect: *mut f64,           // [4]: x, y, w, h
        out_bounding_rect: *mut f64,          // [4]
        out_screen_rect: *mut f64,            // [4]
        out_presenter_overlay_rect: *mut f64, // [4]
        out_dirty_rects: *mut *mut std::ffi::c_void,
        out_dirty_rects_count: *mut usize,
    ) -> bool;

    pub fn cm_sample_buffer_get_presentation_timestamp(
        sample_buffer: *mut std::ffi::c_void,
        out_value: *mut i64,
        out_timescale: *mut i32,
        out_flags: *mut u32,
        out_epoch: *mut i64,
    );
    pub fn cm_sample_buffer_get_duration(
        sample_buffer: *mut std::ffi::c_void,
        out_value: *mut i64,
        out_timescale: *mut i32,
        out_flags: *mut u32,
        out_epoch: *mut i64,
    );
    pub fn cm_sample_buffer_release(sample_buffer: *mut std::ffi::c_void);
    pub fn cm_sample_buffer_retain(sample_buffer: *mut std::ffi::c_void);
    pub fn cm_sample_buffer_is_valid(sample_buffer: *mut std::ffi::c_void) -> bool;
    pub fn cm_sample_buffer_get_num_samples(sample_buffer: *mut std::ffi::c_void) -> usize;
    pub fn cm_sample_buffer_get_audio_buffer_list(
        sample_buffer: *mut std::ffi::c_void,
        out_num_buffers: *mut u32,
        out_buffers_ptr: *mut *mut std::ffi::c_void,
        out_buffers_len: *mut usize,
        out_block_buffer: *mut *mut std::ffi::c_void,
    );
    pub fn cm_audio_buffer_bridge_array_free(buffers: *mut std::ffi::c_void);
    pub fn cm_block_buffer_release(block_buffer: *mut std::ffi::c_void);
    pub fn cm_block_buffer_retain(block_buffer: *mut std::ffi::c_void) -> *mut std::ffi::c_void;
    pub fn cm_block_buffer_get_data_length(block_buffer: *mut std::ffi::c_void) -> usize;
    pub fn cm_block_buffer_is_empty(block_buffer: *mut std::ffi::c_void) -> bool;
    pub fn cm_block_buffer_is_range_contiguous(
        block_buffer: *mut std::ffi::c_void,
        offset: usize,
        length: usize,
    ) -> bool;
    pub fn cm_block_buffer_get_data_pointer(
        block_buffer: *mut std::ffi::c_void,
        offset: usize,
        out_length_at_offset: *mut usize,
        out_total_length: *mut usize,
        out_data_pointer: *mut *mut std::ffi::c_void,
    ) -> i32;
    pub fn cm_block_buffer_copy_data_bytes(
        block_buffer: *mut std::ffi::c_void,
        offset_to_data: usize,
        data_length: usize,
        destination: *mut std::ffi::c_void,
    ) -> i32;
    pub fn cm_sample_buffer_get_data_buffer(
        sample_buffer: *mut std::ffi::c_void,
    ) -> *mut std::ffi::c_void;

    pub fn cm_sample_buffer_get_decode_timestamp(
        sample_buffer: *mut std::ffi::c_void,
        out_value: *mut i64,
        out_timescale: *mut i32,
        out_flags: *mut u32,
        out_epoch: *mut i64,
    );
    pub fn cm_sample_buffer_get_output_presentation_timestamp(
        sample_buffer: *mut std::ffi::c_void,
        out_value: *mut i64,
        out_timescale: *mut i32,
        out_flags: *mut u32,
        out_epoch: *mut i64,
    );
    pub fn cm_sample_buffer_set_output_presentation_timestamp(
        sample_buffer: *mut std::ffi::c_void,
        value: i64,
        timescale: i32,
        flags: u32,
        epoch: i64,
    ) -> i32;
    pub fn cm_sample_buffer_get_sample_size(
        sample_buffer: *mut std::ffi::c_void,
        sample_index: usize,
    ) -> usize;
    pub fn cm_sample_buffer_get_total_sample_size(sample_buffer: *mut std::ffi::c_void) -> usize;
    pub fn cm_sample_buffer_is_ready_for_data_access(sample_buffer: *mut std::ffi::c_void) -> bool;
    pub fn cm_sample_buffer_make_data_ready(sample_buffer: *mut std::ffi::c_void) -> i32;

    // New CMSampleBuffer APIs
    pub fn cm_sample_buffer_get_format_description(
        sample_buffer: *mut std::ffi::c_void,
    ) -> *mut std::ffi::c_void;
    pub fn cm_sample_buffer_get_sample_timing_info(
        sample_buffer: *mut std::ffi::c_void,
        sample_index: usize,
        out_duration_value: *mut i64,
        out_duration_timescale: *mut i32,
        out_duration_flags: *mut u32,
        out_duration_epoch: *mut i64,
        out_pts_value: *mut i64,
        out_pts_timescale: *mut i32,
        out_pts_flags: *mut u32,
        out_pts_epoch: *mut i64,
        out_dts_value: *mut i64,
        out_dts_timescale: *mut i32,
        out_dts_flags: *mut u32,
        out_dts_epoch: *mut i64,
    ) -> i32;
    pub fn cm_sample_buffer_invalidate(sample_buffer: *mut std::ffi::c_void) -> i32;
    pub fn cm_sample_buffer_create_copy_with_new_timing(
        sample_buffer: *mut std::ffi::c_void,
        num_timing_infos: usize,
        timing_info_array: *const std::ffi::c_void,
        sample_buffer_out: *mut *mut std::ffi::c_void,
    ) -> i32;
    pub fn cm_sample_buffer_copy_pcm_data_into_audio_buffer_list(
        sample_buffer: *mut std::ffi::c_void,
        frame_offset: i32,
        num_frames: i32,
        buffer_list: *mut std::ffi::c_void,
    ) -> i32;

    // CMFormatDescription APIs
    pub fn cm_format_description_get_media_type(format_description: *mut std::ffi::c_void) -> u32;
    pub fn cm_format_description_get_media_subtype(
        format_description: *mut std::ffi::c_void,
    ) -> u32;
    pub fn cm_format_description_get_extensions(
        format_description: *mut std::ffi::c_void,
    ) -> *const std::ffi::c_void;
    pub fn cm_format_description_retain(
        format_description: *mut std::ffi::c_void,
    ) -> *mut std::ffi::c_void;
    pub fn cm_format_description_release(format_description: *mut std::ffi::c_void);

    // CMFormatDescription Audio APIs
    pub fn cm_format_description_get_audio_sample_rate(
        format_description: *mut std::ffi::c_void,
    ) -> f64;
    pub fn cm_format_description_get_audio_channel_count(
        format_description: *mut std::ffi::c_void,
    ) -> u32;
    pub fn cm_format_description_get_audio_bits_per_channel(
        format_description: *mut std::ffi::c_void,
    ) -> u32;
    pub fn cm_format_description_get_audio_bytes_per_frame(
        format_description: *mut std::ffi::c_void,
    ) -> u32;
    pub fn cm_format_description_get_audio_format_flags(
        format_description: *mut std::ffi::c_void,
    ) -> u32;

    // Hash functions
    pub fn cm_sample_buffer_hash(sample_buffer: *mut std::ffi::c_void) -> usize;
    pub fn cv_pixel_buffer_hash(pixel_buffer: *mut std::ffi::c_void) -> usize;
    pub fn cv_pixel_buffer_pool_hash(pool: *mut std::ffi::c_void) -> usize;
    pub fn cm_block_buffer_hash(block_buffer: *mut std::ffi::c_void) -> usize;
    pub fn cm_format_description_hash(format_description: *mut std::ffi::c_void) -> usize;
    pub fn io_surface_hash(surface: *mut std::ffi::c_void) -> usize;

    pub fn cv_pixel_buffer_get_width(pixel_buffer: *mut std::ffi::c_void) -> usize;
    pub fn cv_pixel_buffer_get_height(pixel_buffer: *mut std::ffi::c_void) -> usize;
    pub fn cv_pixel_buffer_get_pixel_format_type(pixel_buffer: *mut std::ffi::c_void) -> u32;
    pub fn cv_pixel_buffer_get_bytes_per_row(pixel_buffer: *mut std::ffi::c_void) -> usize;
    pub fn cv_pixel_buffer_lock_base_address(
        pixel_buffer: *mut std::ffi::c_void,
        flags: u32,
    ) -> i32;
    pub fn cv_pixel_buffer_unlock_base_address(
        pixel_buffer: *mut std::ffi::c_void,
        flags: u32,
    ) -> i32;
    pub fn cv_pixel_buffer_get_base_address(
        pixel_buffer: *mut std::ffi::c_void,
    ) -> *mut std::ffi::c_void;
    pub fn cv_pixel_buffer_get_io_surface(
        pixel_buffer: *mut std::ffi::c_void,
    ) -> *mut std::ffi::c_void;
    pub fn cv_pixel_buffer_release(pixel_buffer: *mut std::ffi::c_void);
    pub fn cv_pixel_buffer_retain(pixel_buffer: *mut std::ffi::c_void) -> *mut std::ffi::c_void;
    pub fn cv_pixel_buffer_create(
        width: usize,
        height: usize,
        pixel_format_type: u32,
        pixel_buffer_out: *mut *mut std::ffi::c_void,
    ) -> i32;
    pub fn cv_pixel_buffer_create_with_bytes(
        width: usize,
        height: usize,
        pixel_format_type: u32,
        base_address: *mut std::ffi::c_void,
        bytes_per_row: usize,
        pixel_buffer_out: *mut *mut std::ffi::c_void,
    ) -> i32;
    pub fn cv_pixel_buffer_fill_extended_pixels(pixel_buffer: *mut std::ffi::c_void) -> i32;

    // New CVPixelBuffer APIs
    pub fn cv_pixel_buffer_create_with_planar_bytes(
        width: usize,
        height: usize,
        pixel_format_type: u32,
        num_planes: usize,
        plane_base_addresses: *const *mut std::ffi::c_void,
        plane_widths: *const usize,
        plane_heights: *const usize,
        plane_bytes_per_row: *const usize,
        pixel_buffer_out: *mut *mut std::ffi::c_void,
    ) -> i32;
    pub fn cv_pixel_buffer_create_with_io_surface(
        io_surface: *mut std::ffi::c_void,
        pixel_buffer_out: *mut *mut std::ffi::c_void,
    ) -> i32;
    pub fn cv_pixel_buffer_get_type_id() -> usize;

    // CVPixelBufferPool APIs
    pub fn cv_pixel_buffer_pool_create(
        width: usize,
        height: usize,
        pixel_format_type: u32,
        max_buffers: usize,
        pool_out: *mut *mut std::ffi::c_void,
    ) -> i32;
    pub fn cv_pixel_buffer_pool_create_pixel_buffer(
        pool: *mut std::ffi::c_void,
        pixel_buffer_out: *mut *mut std::ffi::c_void,
    ) -> i32;
    pub fn cv_pixel_buffer_pool_flush(pool: *mut std::ffi::c_void);
    pub fn cv_pixel_buffer_pool_get_type_id() -> usize;
    pub fn cv_pixel_buffer_pool_retain(pool: *mut std::ffi::c_void) -> *mut std::ffi::c_void;
    pub fn cv_pixel_buffer_pool_release(pool: *mut std::ffi::c_void);

    // Additional pool APIs
    pub fn cv_pixel_buffer_pool_get_attributes(
        pool: *mut std::ffi::c_void,
    ) -> *const std::ffi::c_void;
    pub fn cv_pixel_buffer_pool_get_pixel_buffer_attributes(
        pool: *mut std::ffi::c_void,
    ) -> *const std::ffi::c_void;

    pub fn cv_pixel_buffer_get_data_size(pixel_buffer: *mut std::ffi::c_void) -> usize;
    pub fn cv_pixel_buffer_is_planar(pixel_buffer: *mut std::ffi::c_void) -> bool;
    pub fn cv_pixel_buffer_get_plane_count(pixel_buffer: *mut std::ffi::c_void) -> usize;
    pub fn cv_pixel_buffer_get_width_of_plane(
        pixel_buffer: *mut std::ffi::c_void,
        plane_index: usize,
    ) -> usize;
    pub fn cv_pixel_buffer_get_height_of_plane(
        pixel_buffer: *mut std::ffi::c_void,
        plane_index: usize,
    ) -> usize;
    pub fn cv_pixel_buffer_get_base_address_of_plane(
        pixel_buffer: *mut std::ffi::c_void,
        plane_index: usize,
    ) -> *mut std::ffi::c_void;
    pub fn cv_pixel_buffer_get_bytes_per_row_of_plane(
        pixel_buffer: *mut std::ffi::c_void,
        plane_index: usize,
    ) -> usize;
    pub fn cv_pixel_buffer_get_extended_pixels(
        pixel_buffer: *mut std::ffi::c_void,
        extra_columns_on_left: *mut usize,
        extra_columns_on_right: *mut usize,
        extra_rows_on_top: *mut usize,
        extra_rows_on_bottom: *mut usize,
    );

    pub fn cm_sample_buffer_create_for_image_buffer(
        image_buffer: *mut std::ffi::c_void,
        presentation_time_value: i64,
        presentation_time_scale: i32,
        duration_value: i64,
        duration_scale: i32,
        sample_buffer_out: *mut *mut std::ffi::c_void,
    ) -> i32;

    // IOSurface functions
    pub fn io_surface_get_width(surface: *mut std::ffi::c_void) -> usize;
    pub fn io_surface_get_height(surface: *mut std::ffi::c_void) -> usize;
    pub fn io_surface_get_bytes_per_row(surface: *mut std::ffi::c_void) -> usize;
    pub fn io_surface_get_alloc_size(surface: *mut std::ffi::c_void) -> usize;
    pub fn io_surface_get_pixel_format(surface: *mut std::ffi::c_void) -> u32;
    pub fn io_surface_get_id(surface: *mut std::ffi::c_void) -> u32;
    pub fn io_surface_get_seed(surface: *mut std::ffi::c_void) -> u32;
    pub fn io_surface_get_plane_count(surface: *mut std::ffi::c_void) -> usize;
    pub fn io_surface_get_width_of_plane(
        surface: *mut std::ffi::c_void,
        plane_index: usize,
    ) -> usize;
    pub fn io_surface_get_height_of_plane(
        surface: *mut std::ffi::c_void,
        plane_index: usize,
    ) -> usize;
    pub fn io_surface_get_bytes_per_row_of_plane(
        surface: *mut std::ffi::c_void,
        plane_index: usize,
    ) -> usize;
    pub fn io_surface_get_base_address_of_plane(
        surface: *mut std::ffi::c_void,
        plane_index: usize,
    ) -> *mut std::ffi::c_void;
    pub fn io_surface_get_base_address(surface: *mut std::ffi::c_void) -> *mut std::ffi::c_void;
    pub fn io_surface_get_bytes_per_element(surface: *mut std::ffi::c_void) -> usize;
    pub fn io_surface_get_element_width(surface: *mut std::ffi::c_void) -> usize;
    pub fn io_surface_get_element_height(surface: *mut std::ffi::c_void) -> usize;
    pub fn io_surface_is_in_use(surface: *mut std::ffi::c_void) -> bool;
    pub fn io_surface_increment_use_count(surface: *mut std::ffi::c_void);
    pub fn io_surface_decrement_use_count(surface: *mut std::ffi::c_void);
    pub fn io_surface_lock(surface: *mut std::ffi::c_void, options: u32, seed: *mut u32) -> i32;
    pub fn io_surface_unlock(surface: *mut std::ffi::c_void, options: u32, seed: *mut u32) -> i32;
    pub fn io_surface_release(surface: *mut std::ffi::c_void);
    pub fn io_surface_retain(surface: *mut std::ffi::c_void) -> *mut std::ffi::c_void;

    // CMBlockBuffer creation (for testing)
    pub fn cm_block_buffer_create_with_data(
        data: *const std::ffi::c_void,
        data_length: usize,
        block_buffer_out: *mut *mut std::ffi::c_void,
    ) -> i32;
    pub fn cm_block_buffer_create_empty(block_buffer_out: *mut *mut std::ffi::c_void) -> i32;
}