avplayer 0.7.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
import AVFoundation
import Foundation

private struct AssetResourceLoaderInfoPayload: Codable {
    let hasDelegate: Bool
    let preloadsEligibleContentKeys: Bool
    let sendsCommonMediaClientDataAsHTTPHeaders: Bool?
}

private struct AssetResourceLoadingRequestPayload: Codable {
    let requestURL: String?
    let requestMethod: String?
    let requestHeaders: [String: String]?
    let finished: Bool
    let cancelled: Bool
    let hasContentInformationRequest: Bool
    let hasDataRequest: Bool
    let hasRequestor: Bool
}

private struct AssetResourceLoadingContentInformationRequestPayload: Codable {
    let contentType: String?
    let allowedContentTypes: [String]?
    let contentLength: Int64
    let byteRangeAccessSupported: Bool
    let renewalDateISO8601: String?
    let entireLengthAvailableOnDemand: Bool?
}

private struct AssetResourceLoadingDataRequestPayload: Codable {
    let requestedOffset: Int64
    let requestedLength: Int64
    let requestsAllDataToEndOfResource: Bool?
    let currentOffset: Int64
}

private struct AssetResourceLoadingRequestorPayload: Codable {
    let providesExpiredSessionReports: Bool
}

private final class AssetResourceLoaderDelegateBox: NSObject, AVAssetResourceLoaderDelegate {
    private weak var loader: AVAssetResourceLoader?
    private let callback: AVPBoolObjectCallback
    private let userData: UnsafeMutableRawPointer?
    private let dropUserData: AVPDropCallback?
    private var disposed = false

    init(
        loader: AVAssetResourceLoader,
        queue: DispatchQueue?,
        callback: @escaping AVPBoolObjectCallback,
        userData: UnsafeMutableRawPointer?,
        dropUserData: AVPDropCallback?
    ) {
        self.loader = loader
        self.callback = callback
        self.userData = userData
        self.dropUserData = dropUserData
        super.init()
        loader.setDelegate(self, queue: queue)
    }

    deinit {
        dispose()
    }

    func dispose() {
        guard !disposed else { return }
        disposed = true
        loader?.setDelegate(nil, queue: nil)
        if let userData, let dropUserData {
            dropUserData(userData)
        }
    }

    private func send(event: String, object: AnyObject) -> Bool {
        guard !disposed else { return false }
        let objectPtr = Unmanaged.passRetained(object).toOpaque()
        return event.withCString { callback(userData, $0, objectPtr) }
    }

    func resourceLoader(
        _ resourceLoader: AVAssetResourceLoader,
        shouldWaitForLoadingOfRequestedResource loadingRequest: AVAssetResourceLoadingRequest
    ) -> Bool {
        send(event: "loading_requested", object: loadingRequest)
    }

    func resourceLoader(
        _ resourceLoader: AVAssetResourceLoader,
        shouldWaitForRenewalOfRequestedResource renewalRequest: AVAssetResourceRenewalRequest
    ) -> Bool {
        send(event: "renewal_requested", object: renewalRequest)
    }

    func resourceLoader(
        _ resourceLoader: AVAssetResourceLoader,
        didCancel loadingRequest: AVAssetResourceLoadingRequest
    ) {
        _ = send(event: "loading_cancelled", object: loadingRequest)
    }
}

@_cdecl("av_url_asset_copy_resource_loader")
public func av_url_asset_copy_resource_loader(
    _ assetPtr: UnsafeMutableRawPointer
) -> UnsafeMutableRawPointer? {
    let asset = Unmanaged<AVAsset>.fromOpaque(assetPtr).takeUnretainedValue()
    guard let urlAsset = asset as? AVURLAsset else { return nil }
    return Unmanaged.passRetained(urlAsset.resourceLoader).toOpaque()
}

@_cdecl("av_asset_resource_loader_info_json")
public func av_asset_resource_loader_info_json(
    _ loaderPtr: UnsafeMutableRawPointer,
    _ outErrorMessage: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> UnsafeMutablePointer<CChar>? {
    let loader = Unmanaged<AVAssetResourceLoader>.fromOpaque(loaderPtr).takeUnretainedValue()
    let payload = AssetResourceLoaderInfoPayload(
        hasDelegate: loader.delegate != nil,
        preloadsEligibleContentKeys: loader.preloadsEligibleContentKeys,
        sendsCommonMediaClientDataAsHTTPHeaders: {
            if #available(macOS 15.0, *) {
                return loader.sendsCommonMediaClientDataAsHTTPHeaders
            }
            return nil
        }()
    )
    do {
        return ffiString(try avpEncodeJSON(payload))
    } catch {
        outErrorMessage?.pointee = ffiString(error.localizedDescription)
        return nil
    }
}

@_cdecl("av_asset_resource_loader_set_preloads_eligible_content_keys")
public func av_asset_resource_loader_set_preloads_eligible_content_keys(
    _ loaderPtr: UnsafeMutableRawPointer,
    _ enabled: Bool
) {
    let loader = Unmanaged<AVAssetResourceLoader>.fromOpaque(loaderPtr).takeUnretainedValue()
    loader.preloadsEligibleContentKeys = enabled
}

@_cdecl("av_asset_resource_loader_set_sends_common_media_client_data_as_http_headers")
public func av_asset_resource_loader_set_sends_common_media_client_data_as_http_headers(
    _ loaderPtr: UnsafeMutableRawPointer,
    _ enabled: Bool,
    _ outErrorMessage: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> Int32 {
    guard #available(macOS 15.0, *) else {
        outErrorMessage?.pointee = ffiString("sendsCommonMediaClientDataAsHTTPHeaders requires macOS 15.0")
        return AVP_INVALID_ARGUMENT
    }
    let loader = Unmanaged<AVAssetResourceLoader>.fromOpaque(loaderPtr).takeUnretainedValue()
    loader.sendsCommonMediaClientDataAsHTTPHeaders = enabled
    return AVP_OK
}

@_cdecl("av_asset_resource_loader_add_delegate")
public func av_asset_resource_loader_add_delegate(
    _ loaderPtr: UnsafeMutableRawPointer,
    _ queueLabel: UnsafePointer<CChar>?,
    _ callback: AVPBoolObjectCallback?,
    _ userData: UnsafeMutableRawPointer?,
    _ dropUserData: AVPDropCallback?,
    _ outErrorMessage: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> UnsafeMutableRawPointer? {
    guard let callback else {
        outErrorMessage?.pointee = ffiString("missing resource-loader callback")
        return nil
    }
    let loader = Unmanaged<AVAssetResourceLoader>.fromOpaque(loaderPtr).takeUnretainedValue()
    let observer = AssetResourceLoaderDelegateBox(
        loader: loader,
        queue: avpDispatchQueue(from: queueLabel),
        callback: callback,
        userData: userData,
        dropUserData: dropUserData
    )
    return Unmanaged.passRetained(observer).toOpaque()
}

@_cdecl("av_asset_resource_loader_delegate_release")
public func av_asset_resource_loader_delegate_release(_ observerPtr: UnsafeMutableRawPointer?) {
    guard let observerPtr else { return }
    Unmanaged<AssetResourceLoaderDelegateBox>.fromOpaque(observerPtr).release()
}

@_cdecl("av_asset_resource_loading_request_info_json")
public func av_asset_resource_loading_request_info_json(
    _ requestPtr: UnsafeMutableRawPointer,
    _ outErrorMessage: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> UnsafeMutablePointer<CChar>? {
    let request = Unmanaged<AVAssetResourceLoadingRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    let payload = AssetResourceLoadingRequestPayload(
        requestURL: request.request.url?.absoluteString,
        requestMethod: request.request.httpMethod,
        requestHeaders: request.request.allHTTPHeaderFields,
        finished: request.isFinished,
        cancelled: request.isCancelled,
        hasContentInformationRequest: request.contentInformationRequest != nil,
        hasDataRequest: request.dataRequest != nil,
        hasRequestor: {
            if #available(macOS 10.14, *) {
                return true
            }
            return false
        }()
    )
    do {
        return ffiString(try avpEncodeJSON(payload))
    } catch {
        outErrorMessage?.pointee = ffiString(error.localizedDescription)
        return nil
    }
}

@_cdecl("av_asset_resource_loading_request_finish_loading")
public func av_asset_resource_loading_request_finish_loading(
    _ requestPtr: UnsafeMutableRawPointer
) {
    let request = Unmanaged<AVAssetResourceLoadingRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    request.finishLoading()
}

@_cdecl("av_asset_resource_loading_request_finish_loading_with_error")
public func av_asset_resource_loading_request_finish_loading_with_error(
    _ requestPtr: UnsafeMutableRawPointer,
    _ messagePtr: UnsafePointer<CChar>?
) {
    let request = Unmanaged<AVAssetResourceLoadingRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    if let messagePtr {
        let message = String(cString: messagePtr)
        let error = NSError(
            domain: "avplayer.resource-loader",
            code: -1,
            userInfo: [NSLocalizedDescriptionKey: message]
        )
        request.finishLoading(with: error)
    } else {
        request.finishLoading(with: nil)
    }
}

@_cdecl("av_asset_resource_loading_request_copy_content_information_request")
public func av_asset_resource_loading_request_copy_content_information_request(
    _ requestPtr: UnsafeMutableRawPointer
) -> UnsafeMutableRawPointer? {
    let request = Unmanaged<AVAssetResourceLoadingRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    guard let contentInformationRequest = request.contentInformationRequest else { return nil }
    return Unmanaged.passRetained(contentInformationRequest).toOpaque()
}

@_cdecl("av_asset_resource_loading_request_copy_data_request")
public func av_asset_resource_loading_request_copy_data_request(
    _ requestPtr: UnsafeMutableRawPointer
) -> UnsafeMutableRawPointer? {
    let request = Unmanaged<AVAssetResourceLoadingRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    guard let dataRequest = request.dataRequest else { return nil }
    return Unmanaged.passRetained(dataRequest).toOpaque()
}

@_cdecl("av_asset_resource_loading_request_copy_requestor")
public func av_asset_resource_loading_request_copy_requestor(
    _ requestPtr: UnsafeMutableRawPointer
) -> UnsafeMutableRawPointer? {
    guard #available(macOS 10.14, *) else { return nil }
    let request = Unmanaged<AVAssetResourceLoadingRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    return Unmanaged.passRetained(request.requestor).toOpaque()
}

@_cdecl("av_asset_resource_loading_content_information_request_info_json")
public func av_asset_resource_loading_content_information_request_info_json(
    _ requestPtr: UnsafeMutableRawPointer,
    _ outErrorMessage: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> UnsafeMutablePointer<CChar>? {
    let request = Unmanaged<AVAssetResourceLoadingContentInformationRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    let payload = AssetResourceLoadingContentInformationRequestPayload(
        contentType: request.contentType,
        allowedContentTypes: {
            if #available(macOS 10.13.2, *) {
                return request.allowedContentTypes
            }
            return nil
        }(),
        contentLength: request.contentLength,
        byteRangeAccessSupported: request.isByteRangeAccessSupported,
        renewalDateISO8601: avpISO8601String(request.renewalDate),
        entireLengthAvailableOnDemand: {
            if #available(macOS 13.0, *) {
                return request.isEntireLengthAvailableOnDemand
            }
            return nil
        }()
    )
    do {
        return ffiString(try avpEncodeJSON(payload))
    } catch {
        outErrorMessage?.pointee = ffiString(error.localizedDescription)
        return nil
    }
}

@_cdecl("av_asset_resource_loading_content_information_request_set_content_type")
public func av_asset_resource_loading_content_information_request_set_content_type(
    _ requestPtr: UnsafeMutableRawPointer,
    _ contentTypePtr: UnsafePointer<CChar>?
) {
    let request = Unmanaged<AVAssetResourceLoadingContentInformationRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    request.contentType = contentTypePtr.map { String(cString: $0) }
}

@_cdecl("av_asset_resource_loading_content_information_request_set_content_length")
public func av_asset_resource_loading_content_information_request_set_content_length(
    _ requestPtr: UnsafeMutableRawPointer,
    _ contentLength: Int64
) {
    let request = Unmanaged<AVAssetResourceLoadingContentInformationRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    request.contentLength = contentLength
}

@_cdecl("av_asset_resource_loading_content_information_request_set_byte_range_access_supported")
public func av_asset_resource_loading_content_information_request_set_byte_range_access_supported(
    _ requestPtr: UnsafeMutableRawPointer,
    _ supported: Bool
) {
    let request = Unmanaged<AVAssetResourceLoadingContentInformationRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    request.isByteRangeAccessSupported = supported
}

@_cdecl("av_asset_resource_loading_content_information_request_set_renewal_date_iso8601")
public func av_asset_resource_loading_content_information_request_set_renewal_date_iso8601(
    _ requestPtr: UnsafeMutableRawPointer,
    _ renewalDatePtr: UnsafePointer<CChar>?
) {
    let request = Unmanaged<AVAssetResourceLoadingContentInformationRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    request.renewalDate = avpDate(fromISO8601: renewalDatePtr.map { String(cString: $0) })
}

@_cdecl("av_asset_resource_loading_content_information_request_set_entire_length_available_on_demand")
public func av_asset_resource_loading_content_information_request_set_entire_length_available_on_demand(
    _ requestPtr: UnsafeMutableRawPointer,
    _ available: Bool,
    _ outErrorMessage: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> Int32 {
    guard #available(macOS 13.0, *) else {
        outErrorMessage?.pointee = ffiString("entireLengthAvailableOnDemand requires macOS 13.0")
        return AVP_INVALID_ARGUMENT
    }
    let request = Unmanaged<AVAssetResourceLoadingContentInformationRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    request.isEntireLengthAvailableOnDemand = available
    return AVP_OK
}

@_cdecl("av_asset_resource_loading_data_request_info_json")
public func av_asset_resource_loading_data_request_info_json(
    _ requestPtr: UnsafeMutableRawPointer,
    _ outErrorMessage: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> UnsafeMutablePointer<CChar>? {
    let request = Unmanaged<AVAssetResourceLoadingDataRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    let payload = AssetResourceLoadingDataRequestPayload(
        requestedOffset: request.requestedOffset,
        requestedLength: Int64(request.requestedLength),
        requestsAllDataToEndOfResource: {
            if #available(macOS 10.11, *) {
                return request.requestsAllDataToEndOfResource
            }
            return nil
        }(),
        currentOffset: request.currentOffset
    )
    do {
        return ffiString(try avpEncodeJSON(payload))
    } catch {
        outErrorMessage?.pointee = ffiString(error.localizedDescription)
        return nil
    }
}

@_cdecl("av_asset_resource_loading_data_request_respond_with_data")
public func av_asset_resource_loading_data_request_respond_with_data(
    _ requestPtr: UnsafeMutableRawPointer,
    _ bytes: UnsafePointer<UInt8>?,
    _ count: Int
) {
    let request = Unmanaged<AVAssetResourceLoadingDataRequest>.fromOpaque(requestPtr).takeUnretainedValue()
    let data = bytes.map { Data(bytes: $0, count: count) } ?? Data()
    request.respond(with: data)
}

@_cdecl("av_asset_resource_loading_requestor_info_json")
public func av_asset_resource_loading_requestor_info_json(
    _ requestorPtr: UnsafeMutableRawPointer,
    _ outErrorMessage: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> UnsafeMutablePointer<CChar>? {
    let requestor = Unmanaged<AVAssetResourceLoadingRequestor>.fromOpaque(requestorPtr).takeUnretainedValue()
    do {
        return ffiString(
            try avpEncodeJSON(
                AssetResourceLoadingRequestorPayload(
                    providesExpiredSessionReports: requestor.providesExpiredSessionReports
                )
            )
        )
    } catch {
        outErrorMessage?.pointee = ffiString(error.localizedDescription)
        return nil
    }
}