avplayer 0.6.0

Safe Rust bindings for Apple's AVPlayer + AVAssetReader — playback and frame-by-frame asset reading 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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
#![allow(
    clippy::missing_errors_doc,
    clippy::must_use_candidate,
    clippy::struct_excessive_bools
)]

use core::ffi::{c_char, c_void};
use core::ptr;
use std::collections::BTreeMap;
use std::ffi::{CStr, CString};

use serde::Deserialize;

use crate::asset::UrlAsset;
use crate::error::{from_swift, AVPlayerError};
use crate::ffi;
use crate::util::{catch_cb_panic, parse_json_and_free, to_cstring};

#[derive(Debug, Clone, PartialEq, Deserialize)]
#[serde(rename_all = "camelCase")]
struct AssetResourceLoaderInfoPayload {
    has_delegate: bool,
    preloads_eligible_content_keys: bool,
    sends_common_media_client_data_as_http_headers: Option<bool>,
}

#[derive(Debug, Clone, PartialEq, Deserialize)]
#[serde(rename_all = "camelCase")]
struct AssetResourceLoadingRequestPayload {
    request_url: Option<String>,
    request_method: Option<String>,
    request_headers: Option<BTreeMap<String, String>>,
    finished: bool,
    cancelled: bool,
    has_content_information_request: bool,
    has_data_request: bool,
    has_requestor: bool,
}

#[derive(Debug, Clone, PartialEq, Deserialize)]
#[serde(rename_all = "camelCase")]
struct AssetResourceLoadingContentInformationRequestPayload {
    content_type: Option<String>,
    allowed_content_types: Option<Vec<String>>,
    content_length: i64,
    byte_range_access_supported: bool,
    renewal_date_iso8601: Option<String>,
    entire_length_available_on_demand: Option<bool>,
}

#[derive(Debug, Clone, PartialEq, Deserialize)]
#[serde(rename_all = "camelCase")]
struct AssetResourceLoadingDataRequestPayload {
    requested_offset: i64,
    requested_length: i64,
    requests_all_data_to_end_of_resource: Option<bool>,
    current_offset: i64,
}

#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "camelCase")]
struct AssetResourceLoadingRequestorPayload {
    provides_expired_session_reports: bool,
}

#[derive(Debug)]
pub struct AssetResourceLoader {
    ptr: *mut c_void,
}

impl Drop for AssetResourceLoader {
    fn drop(&mut self) {
        if !self.ptr.is_null() {
            unsafe { ffi::av_ns_object_release(self.ptr) };
            self.ptr = ptr::null_mut();
        }
    }
}

#[derive(Debug)]
pub struct AssetResourceLoadingRequest {
    ptr: *mut c_void,
}

impl Drop for AssetResourceLoadingRequest {
    fn drop(&mut self) {
        if !self.ptr.is_null() {
            unsafe { ffi::av_ns_object_release(self.ptr) };
            self.ptr = ptr::null_mut();
        }
    }
}

#[derive(Debug)]
pub struct AssetResourceRenewalRequest {
    ptr: *mut c_void,
}

impl Drop for AssetResourceRenewalRequest {
    fn drop(&mut self) {
        if !self.ptr.is_null() {
            unsafe { ffi::av_ns_object_release(self.ptr) };
            self.ptr = ptr::null_mut();
        }
    }
}

#[derive(Debug)]
pub struct AssetResourceLoadingContentInformationRequest {
    ptr: *mut c_void,
}

impl Drop for AssetResourceLoadingContentInformationRequest {
    fn drop(&mut self) {
        if !self.ptr.is_null() {
            unsafe { ffi::av_ns_object_release(self.ptr) };
            self.ptr = ptr::null_mut();
        }
    }
}

#[derive(Debug)]
pub struct AssetResourceLoadingDataRequest {
    ptr: *mut c_void,
}

impl Drop for AssetResourceLoadingDataRequest {
    fn drop(&mut self) {
        if !self.ptr.is_null() {
            unsafe { ffi::av_ns_object_release(self.ptr) };
            self.ptr = ptr::null_mut();
        }
    }
}

#[derive(Debug)]
pub struct AssetResourceLoadingRequestor {
    ptr: *mut c_void,
}

impl Drop for AssetResourceLoadingRequestor {
    fn drop(&mut self) {
        if !self.ptr.is_null() {
            unsafe { ffi::av_ns_object_release(self.ptr) };
            self.ptr = ptr::null_mut();
        }
    }
}

#[derive(Debug)]
pub enum AssetResourceLoaderEvent {
    LoadingRequested(AssetResourceLoadingRequest),
    RenewalRequested(AssetResourceRenewalRequest),
    LoadingCancelled(AssetResourceLoadingRequest),
}

struct AssetResourceLoaderObserverState {
    callback: Box<dyn Fn(AssetResourceLoaderEvent) -> bool + Send + 'static>,
}

#[derive(Debug)]
pub struct AssetResourceLoaderObserver {
    token: *mut c_void,
}

impl Drop for AssetResourceLoaderObserver {
    fn drop(&mut self) {
        if !self.token.is_null() {
            unsafe { ffi::av_asset_resource_loader_delegate_release(self.token) };
            self.token = ptr::null_mut();
        }
    }
}

impl UrlAsset {
    pub fn resource_loader(&self) -> AssetResourceLoader {
        let ptr = unsafe { ffi::av_url_asset_copy_resource_loader(self.asset.ptr) };
        AssetResourceLoader { ptr }
    }
}

impl AssetResourceLoader {
    fn info(&self) -> Result<AssetResourceLoaderInfoPayload, AVPlayerError> {
        let mut err: *mut c_char = ptr::null_mut();
        let json_ptr = unsafe { ffi::av_asset_resource_loader_info_json(self.ptr, &mut err) };
        if json_ptr.is_null() {
            return Err(unsafe { from_swift(ffi::status::OPERATION_FAILED, err) });
        }
        parse_json_and_free(json_ptr)
    }

    pub fn has_delegate(&self) -> Result<bool, AVPlayerError> {
        Ok(self.info()?.has_delegate)
    }

    pub fn preloads_eligible_content_keys(&self) -> Result<bool, AVPlayerError> {
        Ok(self.info()?.preloads_eligible_content_keys)
    }

    pub fn set_preloads_eligible_content_keys(&self, enabled: bool) {
        unsafe {
            ffi::av_asset_resource_loader_set_preloads_eligible_content_keys(self.ptr, enabled);
        }
    }

    pub fn sends_common_media_client_data_as_http_headers(
        &self,
    ) -> Result<Option<bool>, AVPlayerError> {
        Ok(self.info()?.sends_common_media_client_data_as_http_headers)
    }

    pub fn set_sends_common_media_client_data_as_http_headers(
        &self,
        enabled: bool,
    ) -> Result<(), AVPlayerError> {
        let mut err: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::av_asset_resource_loader_set_sends_common_media_client_data_as_http_headers(
                self.ptr, enabled, &mut err,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { from_swift(status, err) });
        }
        Ok(())
    }

    pub fn observe_loading_requests<F>(
        &self,
        queue_label: Option<&str>,
        callback: F,
    ) -> Result<AssetResourceLoaderObserver, AVPlayerError>
    where
        F: Fn(AssetResourceLoaderEvent) -> bool + Send + 'static,
    {
        let queue_label = queue_label
            .map(|label| to_cstring(label, "resource-loader queue label"))
            .transpose()?;
        let state = Box::new(AssetResourceLoaderObserverState {
            callback: Box::new(callback),
        });
        let userdata = Box::into_raw(state).cast::<c_void>();
        let mut err: *mut c_char = ptr::null_mut();
        let token = unsafe {
            ffi::av_asset_resource_loader_add_delegate(
                self.ptr,
                queue_label
                    .as_ref()
                    .map_or(ptr::null(), |label| label.as_ptr()),
                Some(asset_resource_loader_event_trampoline),
                userdata,
                Some(asset_resource_loader_observer_drop),
                &mut err,
            )
        };
        if token.is_null() {
            unsafe { asset_resource_loader_observer_drop(userdata) };
            return Err(unsafe { from_swift(ffi::status::OBSERVER_FAILED, err) });
        }
        Ok(AssetResourceLoaderObserver { token })
    }
}

impl AssetResourceLoadingRequest {
    fn info(&self) -> Result<AssetResourceLoadingRequestPayload, AVPlayerError> {
        resource_loading_request_info(self.ptr)
    }

    pub fn request_url(&self) -> Result<Option<String>, AVPlayerError> {
        Ok(self.info()?.request_url)
    }

    pub fn request_method(&self) -> Result<Option<String>, AVPlayerError> {
        Ok(self.info()?.request_method)
    }

    pub fn request_headers(&self) -> Result<Option<BTreeMap<String, String>>, AVPlayerError> {
        Ok(self.info()?.request_headers)
    }

    pub fn is_finished(&self) -> Result<bool, AVPlayerError> {
        Ok(self.info()?.finished)
    }

    pub fn is_cancelled(&self) -> Result<bool, AVPlayerError> {
        Ok(self.info()?.cancelled)
    }

    pub fn has_content_information_request(&self) -> Result<bool, AVPlayerError> {
        Ok(self.info()?.has_content_information_request)
    }

    pub fn has_data_request(&self) -> Result<bool, AVPlayerError> {
        Ok(self.info()?.has_data_request)
    }

    pub fn has_requestor(&self) -> Result<bool, AVPlayerError> {
        Ok(self.info()?.has_requestor)
    }

    pub fn content_information_request(
        &self,
    ) -> Option<AssetResourceLoadingContentInformationRequest> {
        copy_content_information_request(self.ptr)
    }

    pub fn data_request(&self) -> Option<AssetResourceLoadingDataRequest> {
        copy_data_request(self.ptr)
    }

    pub fn requestor(&self) -> Option<AssetResourceLoadingRequestor> {
        copy_requestor(self.ptr)
    }

    pub fn finish_loading(&self) {
        unsafe { ffi::av_asset_resource_loading_request_finish_loading(self.ptr) };
    }

    pub fn finish_loading_with_error(&self, message: impl AsRef<str>) -> Result<(), AVPlayerError> {
        let message = CString::new(message.as_ref()).map_err(|error| {
            AVPlayerError::InvalidArgument(format!(
                "resource-loading error message contains NUL byte: {error}"
            ))
        })?;
        unsafe {
            ffi::av_asset_resource_loading_request_finish_loading_with_error(
                self.ptr,
                message.as_ptr(),
            );
        }
        Ok(())
    }
}

impl AssetResourceRenewalRequest {
    fn info(&self) -> Result<AssetResourceLoadingRequestPayload, AVPlayerError> {
        resource_loading_request_info(self.ptr)
    }

    pub fn request_url(&self) -> Result<Option<String>, AVPlayerError> {
        Ok(self.info()?.request_url)
    }

    pub fn request_method(&self) -> Result<Option<String>, AVPlayerError> {
        Ok(self.info()?.request_method)
    }

    pub fn request_headers(&self) -> Result<Option<BTreeMap<String, String>>, AVPlayerError> {
        Ok(self.info()?.request_headers)
    }

    pub fn is_finished(&self) -> Result<bool, AVPlayerError> {
        Ok(self.info()?.finished)
    }

    pub fn is_cancelled(&self) -> Result<bool, AVPlayerError> {
        Ok(self.info()?.cancelled)
    }

    pub fn content_information_request(
        &self,
    ) -> Option<AssetResourceLoadingContentInformationRequest> {
        copy_content_information_request(self.ptr)
    }

    pub fn data_request(&self) -> Option<AssetResourceLoadingDataRequest> {
        copy_data_request(self.ptr)
    }

    pub fn requestor(&self) -> Option<AssetResourceLoadingRequestor> {
        copy_requestor(self.ptr)
    }

    pub fn finish_loading(&self) {
        unsafe { ffi::av_asset_resource_loading_request_finish_loading(self.ptr) };
    }

    pub fn finish_loading_with_error(&self, message: impl AsRef<str>) -> Result<(), AVPlayerError> {
        let message = CString::new(message.as_ref()).map_err(|error| {
            AVPlayerError::InvalidArgument(format!(
                "resource-renewal error message contains NUL byte: {error}"
            ))
        })?;
        unsafe {
            ffi::av_asset_resource_loading_request_finish_loading_with_error(
                self.ptr,
                message.as_ptr(),
            );
        }
        Ok(())
    }
}

impl AssetResourceLoadingContentInformationRequest {
    fn info(&self) -> Result<AssetResourceLoadingContentInformationRequestPayload, AVPlayerError> {
        let mut err: *mut c_char = ptr::null_mut();
        let json_ptr = unsafe {
            ffi::av_asset_resource_loading_content_information_request_info_json(self.ptr, &mut err)
        };
        if json_ptr.is_null() {
            return Err(unsafe { from_swift(ffi::status::OPERATION_FAILED, err) });
        }
        parse_json_and_free(json_ptr)
    }

    pub fn content_type(&self) -> Result<Option<String>, AVPlayerError> {
        Ok(self.info()?.content_type)
    }

    pub fn allowed_content_types(&self) -> Result<Option<Vec<String>>, AVPlayerError> {
        Ok(self.info()?.allowed_content_types)
    }

    pub fn content_length(&self) -> Result<i64, AVPlayerError> {
        Ok(self.info()?.content_length)
    }

    pub fn is_byte_range_access_supported(&self) -> Result<bool, AVPlayerError> {
        Ok(self.info()?.byte_range_access_supported)
    }

    pub fn renewal_date_iso8601(&self) -> Result<Option<String>, AVPlayerError> {
        Ok(self.info()?.renewal_date_iso8601)
    }

    pub fn is_entire_length_available_on_demand(&self) -> Result<Option<bool>, AVPlayerError> {
        Ok(self.info()?.entire_length_available_on_demand)
    }

    pub fn set_content_type(&self, content_type: Option<&str>) -> Result<(), AVPlayerError> {
        let content_type = content_type
            .map(|value| to_cstring(value, "resource content type"))
            .transpose()?;
        unsafe {
            ffi::av_asset_resource_loading_content_information_request_set_content_type(
                self.ptr,
                content_type
                    .as_ref()
                    .map_or(ptr::null(), |value| value.as_ptr()),
            );
        }
        Ok(())
    }

    pub fn set_content_length(&self, content_length: i64) {
        unsafe {
            ffi::av_asset_resource_loading_content_information_request_set_content_length(
                self.ptr,
                content_length,
            );
        }
    }

    pub fn set_byte_range_access_supported(&self, supported: bool) {
        unsafe {
            ffi::av_asset_resource_loading_content_information_request_set_byte_range_access_supported(
                self.ptr, supported,
            );
        }
    }

    pub fn set_renewal_date_iso8601(&self, value: Option<&str>) -> Result<(), AVPlayerError> {
        let value = value
            .map(|value| to_cstring(value, "resource renewal date"))
            .transpose()?;
        unsafe {
            ffi::av_asset_resource_loading_content_information_request_set_renewal_date_iso8601(
                self.ptr,
                value.as_ref().map_or(ptr::null(), |value| value.as_ptr()),
            );
        }
        Ok(())
    }

    pub fn set_entire_length_available_on_demand(
        &self,
        available: bool,
    ) -> Result<(), AVPlayerError> {
        let mut err: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::av_asset_resource_loading_content_information_request_set_entire_length_available_on_demand(
                self.ptr,
                available,
                &mut err,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { from_swift(status, err) });
        }
        Ok(())
    }
}

impl AssetResourceLoadingDataRequest {
    fn info(&self) -> Result<AssetResourceLoadingDataRequestPayload, AVPlayerError> {
        let mut err: *mut c_char = ptr::null_mut();
        let json_ptr =
            unsafe { ffi::av_asset_resource_loading_data_request_info_json(self.ptr, &mut err) };
        if json_ptr.is_null() {
            return Err(unsafe { from_swift(ffi::status::OPERATION_FAILED, err) });
        }
        parse_json_and_free(json_ptr)
    }

    pub fn requested_offset(&self) -> Result<i64, AVPlayerError> {
        Ok(self.info()?.requested_offset)
    }

    pub fn requested_length(&self) -> Result<i64, AVPlayerError> {
        Ok(self.info()?.requested_length)
    }

    pub fn requests_all_data_to_end_of_resource(&self) -> Result<Option<bool>, AVPlayerError> {
        Ok(self.info()?.requests_all_data_to_end_of_resource)
    }

    pub fn current_offset(&self) -> Result<i64, AVPlayerError> {
        Ok(self.info()?.current_offset)
    }

    pub fn respond_with_data(&self, data: &[u8]) {
        unsafe {
            ffi::av_asset_resource_loading_data_request_respond_with_data(
                self.ptr,
                data.as_ptr(),
                data.len(),
            );
        }
    }
}

impl AssetResourceLoadingRequestor {
    fn info(&self) -> Result<AssetResourceLoadingRequestorPayload, AVPlayerError> {
        let mut err: *mut c_char = ptr::null_mut();
        let json_ptr =
            unsafe { ffi::av_asset_resource_loading_requestor_info_json(self.ptr, &mut err) };
        if json_ptr.is_null() {
            return Err(unsafe { from_swift(ffi::status::OPERATION_FAILED, err) });
        }
        parse_json_and_free(json_ptr)
    }

    pub fn provides_expired_session_reports(&self) -> Result<bool, AVPlayerError> {
        Ok(self.info()?.provides_expired_session_reports)
    }
}

fn resource_loading_request_info(
    ptr: *mut c_void,
) -> Result<AssetResourceLoadingRequestPayload, AVPlayerError> {
    let mut err: *mut c_char = ptr::null_mut();
    let json_ptr = unsafe { ffi::av_asset_resource_loading_request_info_json(ptr, &mut err) };
    if json_ptr.is_null() {
        return Err(unsafe { from_swift(ffi::status::OPERATION_FAILED, err) });
    }
    parse_json_and_free(json_ptr)
}

fn copy_content_information_request(
    ptr: *mut c_void,
) -> Option<AssetResourceLoadingContentInformationRequest> {
    let ptr =
        unsafe { ffi::av_asset_resource_loading_request_copy_content_information_request(ptr) };
    if ptr.is_null() {
        None
    } else {
        Some(AssetResourceLoadingContentInformationRequest { ptr })
    }
}

fn copy_data_request(ptr: *mut c_void) -> Option<AssetResourceLoadingDataRequest> {
    let ptr = unsafe { ffi::av_asset_resource_loading_request_copy_data_request(ptr) };
    if ptr.is_null() {
        None
    } else {
        Some(AssetResourceLoadingDataRequest { ptr })
    }
}

fn copy_requestor(ptr: *mut c_void) -> Option<AssetResourceLoadingRequestor> {
    let ptr = unsafe { ffi::av_asset_resource_loading_request_copy_requestor(ptr) };
    if ptr.is_null() {
        None
    } else {
        Some(AssetResourceLoadingRequestor { ptr })
    }
}

unsafe extern "C" fn asset_resource_loader_event_trampoline(
    userdata: *mut c_void,
    event_name: *const c_char,
    object_ptr: *mut c_void,
) -> bool {
    if userdata.is_null() || event_name.is_null() || object_ptr.is_null() {
        if !object_ptr.is_null() {
            ffi::av_ns_object_release(object_ptr);
        }
        return false;
    }

    let state = &*userdata.cast::<AssetResourceLoaderObserverState>();
    let Ok(event_name) = CStr::from_ptr(event_name).to_str() else {
        ffi::av_ns_object_release(object_ptr);
        return false;
    };

    let event = match event_name {
        "loading_requested" => {
            AssetResourceLoaderEvent::LoadingRequested(AssetResourceLoadingRequest {
                ptr: object_ptr,
            })
        }
        "renewal_requested" => {
            AssetResourceLoaderEvent::RenewalRequested(AssetResourceRenewalRequest {
                ptr: object_ptr,
            })
        }
        "loading_cancelled" => {
            AssetResourceLoaderEvent::LoadingCancelled(AssetResourceLoadingRequest {
                ptr: object_ptr,
            })
        }
        _ => {
            ffi::av_ns_object_release(object_ptr);
            return false;
        }
    };

    let mut result = false;
    catch_cb_panic("asset_resource_loader_event_trampoline", || {
        result = (state.callback)(event);
    });
    result
}

unsafe extern "C" fn asset_resource_loader_observer_drop(userdata: *mut c_void) {
    if !userdata.is_null() {
        drop(Box::from_raw(
            userdata.cast::<AssetResourceLoaderObserverState>(),
        ));
    }
}