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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
//! Comprehensive tests for Eq, `PartialEq`, and Hash implementations
//!
//! Tests all types that implement these traits to ensure correctness.

#![allow(clippy::similar_names)]

use screencapturekit::prelude::*;
use screencapturekit::{
    cg::{CGPoint, CGRect, CGSize},
    cm::{CMSampleTimingInfo, CMTime},
    codec_types, media_types, FourCharCode,
};
use std::collections::{HashMap, HashSet};

#[test]
fn test_cmtime_eq_and_hash() {
    let time1 = CMTime::new(1, 30);
    let time2 = CMTime::new(1, 30);
    let time3 = CMTime::new(2, 30);

    // Test equality
    assert_eq!(time1, time2);
    assert_ne!(time1, time3);

    // Test hash
    let mut set = HashSet::new();
    set.insert(time1);
    set.insert(time2); // Duplicate
    set.insert(time3);
    assert_eq!(set.len(), 2);

    // Test in HashMap
    let mut map = HashMap::new();
    map.insert(time1, "frame 1");
    map.insert(time2, "frame 1 again"); // Overwrites
    map.insert(time3, "frame 2");
    assert_eq!(map.len(), 2);
    assert_eq!(map.get(&time1), Some(&"frame 1 again"));
}

#[test]
fn test_cmtime_special_values() {
    let zero = CMTime::ZERO;
    let invalid = CMTime::INVALID;
    let pos_inf = CMTime::positive_infinity();
    let neg_inf = CMTime::negative_infinity();
    let indefinite = CMTime::indefinite();

    // All should be unequal
    assert_ne!(zero, invalid);
    assert_ne!(zero, pos_inf);
    assert_ne!(invalid, pos_inf);
    assert_ne!(pos_inf, neg_inf);
    assert_ne!(pos_inf, indefinite);

    // Each should equal itself
    assert_eq!(zero, zero);
    assert_eq!(invalid, invalid);
    assert_eq!(pos_inf, pos_inf);

    // Should work in collections
    let mut set = HashSet::new();
    set.insert(zero);
    set.insert(invalid);
    set.insert(pos_inf);
    set.insert(neg_inf);
    set.insert(indefinite);
    assert_eq!(set.len(), 5);
}

#[test]
fn test_cmsample_timing_info_eq_and_hash() {
    let timing1 =
        CMSampleTimingInfo::with_times(CMTime::new(1, 30), CMTime::new(0, 30), CMTime::INVALID);
    let timing2 =
        CMSampleTimingInfo::with_times(CMTime::new(1, 30), CMTime::new(0, 30), CMTime::INVALID);
    let timing3 =
        CMSampleTimingInfo::with_times(CMTime::new(1, 30), CMTime::new(1, 30), CMTime::INVALID);

    assert_eq!(timing1, timing2);
    assert_ne!(timing1, timing3);

    let mut set = HashSet::new();
    set.insert(timing1);
    set.insert(timing2);
    set.insert(timing3);
    assert_eq!(set.len(), 2);
}

#[test]
fn test_cgpoint_eq_and_hash() {
    let p1 = CGPoint::new(10.0, 20.0);
    let p2 = CGPoint::new(10.0, 20.0);
    let p3 = CGPoint::new(10.0, 20.1);

    assert_eq!(p1, p2);
    assert_ne!(p1, p3);

    let mut set = HashSet::new();
    set.insert(p1);
    set.insert(p2);
    set.insert(p3);
    assert_eq!(set.len(), 2);
}

#[test]
fn test_cgsize_eq_and_hash() {
    let s1 = CGSize::new(1920.0, 1080.0);
    let s2 = CGSize::new(1920.0, 1080.0);
    let s3 = CGSize::new(3840.0, 2160.0);

    assert_eq!(s1, s2);
    assert_ne!(s1, s3);

    let mut map: HashMap<CGSize, &str> = HashMap::new();
    map.insert(s1, "Full HD");
    map.insert(s2, "1080p"); // Overwrites
    map.insert(s3, "4K");
    assert_eq!(map.len(), 2);
    assert_eq!(map.get(&s1), Some(&"1080p"));
}

#[test]
fn test_cgrect_eq_and_hash() {
    let r1 = CGRect::new(0.0, 0.0, 100.0, 100.0);
    let r2 = CGRect::new(0.0, 0.0, 100.0, 100.0);
    let r3 = CGRect::new(0.0, 0.0, 100.0, 101.0);

    assert_eq!(r1, r2);
    assert_ne!(r1, r3);

    let mut set = HashSet::new();
    set.insert(r1);
    set.insert(r2);
    set.insert(r3);
    assert_eq!(set.len(), 2);
}

#[test]
fn test_fourcharcode_eq_and_hash() {
    let code1 = FourCharCode::from_bytes(*b"avc1");
    let code2 = FourCharCode::from_bytes(*b"avc1");
    let code3 = FourCharCode::from_bytes(*b"hvc1");

    assert_eq!(code1, code2);
    assert_ne!(code1, code3);

    // Test with constants
    assert_eq!(codec_types::H264, FourCharCode::from_bytes(*b"avc1"));
    assert_eq!(media_types::VIDEO, FourCharCode::from_bytes(*b"vide"));

    let mut map: HashMap<FourCharCode, &str> = HashMap::new();
    map.insert(codec_types::H264, "H.264");
    map.insert(codec_types::HEVC, "HEVC");
    map.insert(codec_types::AAC, "AAC");
    assert_eq!(map.len(), 3);
    assert_eq!(map.get(&codec_types::H264), Some(&"H.264"));
}

#[test]
fn test_media_type_constants_eq_and_hash() {
    let video1 = media_types::VIDEO;
    let video2 = media_types::VIDEO;
    let audio = media_types::AUDIO;

    assert_eq!(video1, video2);
    assert_ne!(video1, audio);

    let mut set = HashSet::new();
    set.insert(media_types::VIDEO);
    set.insert(media_types::AUDIO);
    set.insert(media_types::VIDEO); // Duplicate
    set.insert(media_types::MUXED);
    set.insert(media_types::TEXT);
    assert_eq!(set.len(), 4);
}

#[test]
fn test_codec_type_constants_eq_and_hash() {
    let mut codecs: HashSet<FourCharCode> = HashSet::new();

    // Video codecs
    codecs.insert(codec_types::H264);
    codecs.insert(codec_types::HEVC);
    codecs.insert(codec_types::HEVC_2);
    codecs.insert(codec_types::JPEG);

    // Audio codecs
    codecs.insert(codec_types::AAC);
    codecs.insert(codec_types::LPCM);
    codecs.insert(codec_types::ALAC);

    // Test duplicates
    codecs.insert(codec_types::H264); // Duplicate

    assert_eq!(codecs.len(), 7);
}

#[test]
fn test_audio_buffer_eq_and_hash() {
    // AudioBuffer has a private data_ptr field, so we skip detailed testing
    // The Eq and Hash implementations are tested via integration tests
    // that actually capture audio
    use std::collections::HashSet;
    let _set: HashSet<screencapturekit::cm::AudioBuffer> = HashSet::new();
}

#[test]
fn test_pixel_format_eq_and_hash() {
    use screencapturekit::stream::configuration::PixelFormat;

    let fmt1 = PixelFormat::BGRA;
    let fmt2 = PixelFormat::BGRA;
    let fmt3 = PixelFormat::YCbCr_420v;

    assert_eq!(fmt1, fmt2);
    assert_ne!(fmt1, fmt3);

    let mut formats: HashSet<PixelFormat> = HashSet::new();
    formats.insert(PixelFormat::BGRA);
    formats.insert(PixelFormat::BGRA); // Duplicate
    formats.insert(PixelFormat::l10r);
    formats.insert(PixelFormat::YCbCr_420v);
    formats.insert(PixelFormat::YCbCr_420f);
    assert_eq!(formats.len(), 4);

    // Test in HashMap
    let mut map: HashMap<PixelFormat, &str> = HashMap::new();
    map.insert(PixelFormat::BGRA, "BGRA");
    map.insert(PixelFormat::YCbCr_420v, "YUV 420v");
    assert_eq!(map.len(), 2);
}

#[test]
fn test_stream_output_type_eq_and_hash() {
    use screencapturekit::stream::output_type::SCStreamOutputType;

    let screen1 = SCStreamOutputType::Screen;
    let screen2 = SCStreamOutputType::Screen;
    let audio = SCStreamOutputType::Audio;

    assert_eq!(screen1, screen2);
    assert_ne!(screen1, audio);

    let mut set = HashSet::new();
    set.insert(SCStreamOutputType::Screen);
    set.insert(SCStreamOutputType::Audio);
    set.insert(SCStreamOutputType::Screen); // Duplicate
    assert_eq!(set.len(), 2);
}

#[test]
fn test_error_eq() {
    let err1 = SCError::invalid_dimension("width", 0);
    let err2 = SCError::invalid_dimension("width", 0);
    let err3 = SCError::invalid_dimension("height", 0);

    assert_eq!(err1, err2);
    assert_ne!(err1, err3);

    // Test other error types
    let perm_err1 = SCError::permission_denied("Screen Recording");
    let perm_err2 = SCError::permission_denied("Screen Recording");
    let perm_err3 = SCError::permission_denied("Microphone");

    assert_eq!(perm_err1, perm_err2);
    assert_ne!(perm_err1, perm_err3);
}

#[test]
fn test_lock_options_eq_and_hash() {
    use screencapturekit::cv::CVPixelBufferLockFlags;

    let read1 = CVPixelBufferLockFlags::READ_ONLY;
    let read2 = CVPixelBufferLockFlags::READ_ONLY;

    assert_eq!(read1, read2);

    let mut flags = HashSet::new();
    flags.insert(CVPixelBufferLockFlags::READ_ONLY);
    flags.insert(CVPixelBufferLockFlags::READ_ONLY); // Duplicate
    assert_eq!(flags.len(), 1);
}

#[test]
fn test_iosurface_lock_options_eq_and_hash() {
    use screencapturekit::cm::IOSurfaceLockOptions;

    let opt1 = IOSurfaceLockOptions::READ_ONLY;
    let opt2 = IOSurfaceLockOptions::READ_ONLY;
    let opt3 = IOSurfaceLockOptions::AVOID_SYNC;

    assert_eq!(opt1, opt2);
    assert_ne!(opt1, opt3);

    let mut options_set = HashSet::new();
    options_set.insert(IOSurfaceLockOptions::READ_ONLY);
    options_set.insert(IOSurfaceLockOptions::AVOID_SYNC);
    options_set.insert(IOSurfaceLockOptions::READ_ONLY); // Duplicate
    assert_eq!(options_set.len(), 2);
}

#[test]
#[cfg(feature = "macos_15_0")]
fn test_recording_codec_eq_and_hash() {
    use screencapturekit::recording_output::SCRecordingOutputCodec;

    let h264_1 = SCRecordingOutputCodec::H264;
    let h264_2 = SCRecordingOutputCodec::H264;
    let hevc = SCRecordingOutputCodec::HEVC;

    assert_eq!(h264_1, h264_2);
    assert_ne!(h264_1, hevc);

    let mut codecs = HashSet::new();
    codecs.insert(SCRecordingOutputCodec::H264);
    codecs.insert(SCRecordingOutputCodec::HEVC);
    codecs.insert(SCRecordingOutputCodec::H264); // Duplicate
    assert_eq!(codecs.len(), 2);

    // Test in HashMap
    let mut map: HashMap<SCRecordingOutputCodec, &str> = HashMap::new();
    map.insert(SCRecordingOutputCodec::H264, "H.264");
    map.insert(SCRecordingOutputCodec::HEVC, "HEVC");
    assert_eq!(map.len(), 2);
}

#[test]
fn test_presenter_overlay_setting_eq_and_hash() {
    use screencapturekit::stream::configuration::advanced::SCPresenterOverlayAlertSetting;

    let never1 = SCPresenterOverlayAlertSetting::Never;
    let never2 = SCPresenterOverlayAlertSetting::Never;
    let system = SCPresenterOverlayAlertSetting::System;
    let always = SCPresenterOverlayAlertSetting::Always;

    assert_eq!(never1, never2);
    assert_ne!(never1, system);
    assert_ne!(system, always);

    let mut settings = HashSet::new();
    settings.insert(SCPresenterOverlayAlertSetting::System);
    settings.insert(SCPresenterOverlayAlertSetting::Never);
    settings.insert(SCPresenterOverlayAlertSetting::Always);
    settings.insert(SCPresenterOverlayAlertSetting::Never); // Duplicate
    assert_eq!(settings.len(), 3);
}

#[test]
#[cfg(feature = "macos_14_0")]
fn test_content_sharing_picker_mode_eq_and_hash() {
    use screencapturekit::content_sharing_picker::SCContentSharingPickerMode;

    let mode1 = SCContentSharingPickerMode::SingleWindow;
    let mode2 = SCContentSharingPickerMode::SingleWindow;
    let mode3 = SCContentSharingPickerMode::MultipleWindows;

    assert_eq!(mode1, mode2);
    assert_ne!(mode1, mode3);

    let mut modes = HashSet::new();
    modes.insert(SCContentSharingPickerMode::SingleWindow);
    modes.insert(SCContentSharingPickerMode::MultipleWindows);
    modes.insert(SCContentSharingPickerMode::SingleWindow); // Duplicate
    assert_eq!(modes.len(), 2);
}

#[test]
fn test_complex_nested_collections() {
    // Test complex nested structures
    let mut codec_to_formats: HashMap<FourCharCode, HashSet<CGSize>> = HashMap::new();

    let mut h264_sizes = HashSet::new();
    h264_sizes.insert(CGSize::new(1920.0, 1080.0));
    h264_sizes.insert(CGSize::new(1280.0, 720.0));

    let mut hevc_sizes = HashSet::new();
    hevc_sizes.insert(CGSize::new(3840.0, 2160.0));
    hevc_sizes.insert(CGSize::new(1920.0, 1080.0));

    codec_to_formats.insert(codec_types::H264, h264_sizes);
    codec_to_formats.insert(codec_types::HEVC, hevc_sizes);

    assert_eq!(codec_to_formats.len(), 2);
    assert_eq!(codec_to_formats.get(&codec_types::H264).unwrap().len(), 2);
    assert_eq!(codec_to_formats.get(&codec_types::HEVC).unwrap().len(), 2);
}

#[test]
fn test_cmtime_const_equality() {
    // Test const equality method
    const TIME1: CMTime = CMTime::new(1, 30);
    const TIME2: CMTime = CMTime::new(1, 30);
    const TIME3: CMTime = CMTime::new(2, 30);

    assert!(TIME1.equals(&TIME2));
    assert!(!TIME1.equals(&TIME3));

    // Test with invalid times
    assert!(!CMTime::INVALID.equals(&CMTime::INVALID)); // Invalid times don't equal
    assert!(CMTime::ZERO.equals(&CMTime::ZERO));
}

#[test]
fn test_fourcharcode_const_equality() {
    const H264: FourCharCode = codec_types::H264;
    const HEVC: FourCharCode = codec_types::HEVC;

    assert!(H264.equals(H264));
    assert!(!H264.equals(HEVC));
}

#[test]
fn test_deduplication_in_vec() {
    use screencapturekit::stream::configuration::PixelFormat;

    let formats = vec![
        PixelFormat::BGRA,
        PixelFormat::YCbCr_420v,
        PixelFormat::BGRA,       // Duplicate
        PixelFormat::YCbCr_420v, // Duplicate
        PixelFormat::l10r,
    ];

    let unique: HashSet<_> = formats.into_iter().collect();
    assert_eq!(unique.len(), 3);
}

#[test]
fn test_hashmap_key_stability() {
    // Ensure hash values are stable across insertions
    let time = CMTime::new(1, 30);

    let mut map1 = HashMap::new();
    map1.insert(time, "value1");

    let mut map2 = HashMap::new();
    map2.insert(time, "value2");

    // Same key should hash to same value in different maps
    assert!(map1.contains_key(&time));
    assert!(map2.contains_key(&time));

    // Should be able to retrieve from both
    assert_eq!(map1.get(&time), Some(&"value1"));
    assert_eq!(map2.get(&time), Some(&"value2"));
}

#[test]
fn test_zero_values_eq() {
    // Test that zero/default values work correctly
    assert_eq!(CMTime::ZERO, CMTime::ZERO);
    assert_eq!(CGPoint::zero(), CGPoint::zero());
    assert_eq!(CGSize::zero(), CGSize::zero());
    assert_eq!(CGRect::zero(), CGRect::zero());

    let mut set = HashSet::new();
    set.insert(CMTime::ZERO);
    set.insert(CMTime::ZERO);
    assert_eq!(set.len(), 1);
}

#[test]
fn test_edge_case_float_values() {
    // Test edge cases with floating point
    let p1 = CGPoint::new(0.0, 0.0);
    let p2 = CGPoint::new(-0.0, -0.0);

    // 0.0 and -0.0 should be equal (same bit representation)
    assert_eq!(p1, p2);

    // Test very small differences
    let p3 = CGPoint::new(1.0, 1.0);
    let p4 = CGPoint::new(1.0 + f64::EPSILON, 1.0);
    assert_ne!(p3, p4); // Should be different
}