objc2_video_toolbox/generated/VTCompressionProperties.rs
1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ffi::*;
4use core::ptr::NonNull;
5use objc2_core_foundation::*;
6
7use crate::*;
8
9extern "C" {
10 /// The number of pending frames in the compression session.
11 ///
12 /// This number may decrease asynchronously.
13 ///
14 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_numberofpendingframes?language=objc)
15 pub static kVTCompressionPropertyKey_NumberOfPendingFrames: &'static CFString;
16}
17
18extern "C" {
19 /// Indicates whether the a common pixel buffer pool is shared between
20 /// the video encoder and the session client.
21 ///
22 /// This is false if separate pools are used because the video encoder's
23 /// and the client's pixel buffer attributes were incompatible.
24 ///
25 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_pixelbufferpoolisshared?language=objc)
26 pub static kVTCompressionPropertyKey_PixelBufferPoolIsShared: &'static CFString;
27}
28
29extern "C" {
30 /// The video encoder's pixel buffer attributes for the compression session.
31 ///
32 /// You can use these to create a pixel buffer pool for source pixel buffers.
33 ///
34 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_videoencoderpixelbufferattributes?language=objc)
35 pub static kVTCompressionPropertyKey_VideoEncoderPixelBufferAttributes: &'static CFString;
36}
37
38extern "C" {
39 /// The maximum interval between key frames, also known as the key frame rate.
40 ///
41 /// Key frames, also known as sync frames, reset inter-frame
42 /// dependencies; decoding a key frame is sufficient to prepare a
43 /// decoder for correctly decoding the difference frames that
44 /// follow.
45 /// Video encoders are allowed to generate key frames more frequently if
46 /// this would result in more efficient compression.
47 /// The default key frame interval is 0, which indicates that the
48 /// video encoder should choose where to place all key frames. A key
49 /// frame interval of 1 indicates that every frame must be a key
50 /// frame, 2 indicates that at least every other frame must be a key
51 /// frame, etc.
52 /// See also kVTCompressionPropertyKey_AllowTemporalCompression.
53 ///
54 /// This key can be set in conjunction with
55 /// kVTCompressionPropertyKey_MaxKeyFrameIntervalDuration,
56 /// and both limits will be enforced - requiring a keyframe every X
57 /// frames or every Y seconds, whichever comes first.
58 ///
59 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maxkeyframeinterval?language=objc)
60 pub static kVTCompressionPropertyKey_MaxKeyFrameInterval: &'static CFString;
61}
62
63extern "C" {
64 /// The maximum duration from one key frame to the next in seconds.
65 ///
66 /// Zero by default, which means no limit.
67 /// This property is particularly useful when the frame rate is variable.
68 /// See kVTCompressionPropertyKey_MaxKeyFrameInterval for more discussion
69 /// of key frames.
70 ///
71 /// This key can be set in conjunction with
72 /// kVTCompressionPropertyKey_MaxKeyFrameInterval,
73 /// and both limits will be enforced - requiring a keyframe every X
74 /// frames or every Y seconds, whichever comes first.
75 ///
76 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maxkeyframeintervalduration?language=objc)
77 pub static kVTCompressionPropertyKey_MaxKeyFrameIntervalDuration: &'static CFString;
78}
79
80extern "C" {
81 /// Enables temporal compression.
82 ///
83 /// True by default. Set this to false to require key-frame-only compression.
84 ///
85 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_allowtemporalcompression?language=objc)
86 pub static kVTCompressionPropertyKey_AllowTemporalCompression: &'static CFString;
87}
88
89extern "C" {
90 /// Enables frame reordering.
91 ///
92 /// In order to encode B frames, a video encoder must reorder frames,
93 /// which means that the order in which they will be emitted and
94 /// stored (the decode order) is different from the order in which
95 /// they were presented to the video encoder (the display order).
96 /// True by default. Set this to false to prevent frame reordering.
97 ///
98 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_allowframereordering?language=objc)
99 pub static kVTCompressionPropertyKey_AllowFrameReordering: &'static CFString;
100}
101
102extern "C" {
103 /// Enables Open GOP (Group Of Pictures) encoding.
104 ///
105 /// Only applicable to certain video encoders. For HEVC encoding the property value is kCFBooleanTrue by default - which means
106 /// that the encoder may use Open GOP structures, but it is not guaranteed to.
107 /// Set this to kCFBooleanFalse to prevent the encoder from using any form of Open GOP during encoding.
108 /// If set to kCFBooleanFalse, this will mean that the encoder will generate groups of pictures that are independently decodable; there
109 /// will be no frame dependencies across sync samples (frames where kCMSampleAttachmentKey_NotSync is absent or kCFBooleanFalse)
110 /// When the value is kCFBooleanTrue, the encoder may use Open GOP frame dependency structures to increase compression efficiency or quality.
111 ///
112 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_allowopengop?language=objc)
113 pub static kVTCompressionPropertyKey_AllowOpenGOP: &'static CFString;
114}
115
116extern "C" {
117 /// The long-term desired average bit rate in bits per second.
118 ///
119 /// This is not a hard limit; the bit rate may peak above this.
120 /// The default bit rate is zero, which indicates that the video encoder
121 /// should determine the size of compressed data.
122 /// Note that bit rate settings only have an effect when timing
123 /// information is provided for source frames, and that some codecs do
124 /// not support limiting to specified bit rates.
125 ///
126 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_averagebitrate?language=objc)
127 pub static kVTCompressionPropertyKey_AverageBitRate: &'static CFString;
128}
129
130extern "C" {
131 /// Zero, one or two hard limits on data rate.
132 ///
133 /// Each hard limit is described by a data size in bytes and a
134 /// duration in seconds, and requires that the total size of
135 /// compressed data for any contiguous segment of that duration (in
136 /// decode time) must not exceed the data size.
137 /// By default, no data rate limits are set.
138 /// The property is a CFArray of an even number of CFNumbers,
139 /// alternating between bytes and seconds.
140 /// Note that data rate settings only have an effect when timing
141 /// information is provided for source frames, and that some codecs do
142 /// not support limiting to specified data rates.
143 ///
144 /// When both kVTCompressionPropertyKey_DataRateLimits and
145 /// kVTCompressionPropertyKey_AverageBitRate are supported,
146 /// it is recommended that kVTCompressionPropertyKey_AverageBitRate
147 /// be set when kVTCompressionPropertyKey_DataRateLimits is set.
148 /// If kVTCompressionPropertyKey_AverageBitRate is not specified,
149 /// an overall average bit rate target will be selected at a safe margin below
150 /// the kVTCompressionPropertyKey_DataRateLimits target, so that regional
151 /// overshoot in the encoding will not exceed the
152 /// kVTCompressionPropertyKey_DataRateLimits.
153 /// The overall average bitrate target generated from
154 /// kVTCompressionPropertyKey_DataRateLimits in the absence of
155 /// kVTCompressionPropertyKey_AverageBitRate may not be ideal for all
156 /// scenarios.
157 /// Encoding is more likely to undershoot a requested
158 /// kVTCompressionPropertyKey_AverageBitRate if the specified target is too
159 /// close to a hard limit specified by kVTCompressionPropertyKey_DataRateLimits.
160 ///
161 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_dataratelimits?language=objc)
162 pub static kVTCompressionPropertyKey_DataRateLimits: &'static CFString;
163}
164
165extern "C" {
166 /// The desired compression quality.
167 ///
168 /// Some encoders, such as JPEG, describe the compression level of each
169 /// image with a quality value. This value should be specified as a
170 /// number in the range of 0.0 to 1.0, where low = 0.25, normal = 0.50,
171 /// high = 0.75, and 1.0 implies lossless compression for encoders that
172 /// support it.
173 ///
174 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_quality?language=objc)
175 pub static kVTCompressionPropertyKey_Quality: &'static CFString;
176}
177
178extern "C" {
179 /// The target quality to use for encoding the alpha channel.
180 ///
181 /// The desired compression level to use for encoding the alpha channel.
182 /// This value should be specified as a number in the range of 0.0 to 1.0.
183 /// 0.0 is lowest quality and 1.0 implies nearly lossless. Alpha plane
184 /// bit rates will tend to increase with increasing values. When encoding
185 /// the alpha channel, quality is given priority over bitrate. Note this
186 /// parameter is currently only applicable to HEVC with Alpha encoders.
187 ///
188 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_targetqualityforalpha?language=objc)
189 pub static kVTCompressionPropertyKey_TargetQualityForAlpha: &'static CFString;
190}
191
192extern "C" {
193 /// Indicates whether and how a compression session's frames will be
194 /// concatenated with other compressed frames to form a longer series.
195 ///
196 /// True if frames compressed in a separate session will be
197 /// concatenated before the beginning of this one. False if this is a
198 /// stand-alone session, or if this session will encode the first
199 /// segment of a multi-segment compression. By default, false.
200 ///
201 /// This information enables video encoders to ensure that compressed
202 /// segments can be concatenated smoothly -- for example, avoiding
203 /// data rate spikes where segments are joined.
204 ///
205 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_moreframesbeforestart?language=objc)
206 pub static kVTCompressionPropertyKey_MoreFramesBeforeStart: &'static CFString;
207}
208
209extern "C" {
210 /// Indicates whether and how a compression session's frames will be
211 /// concatenated with other compressed frames to form a longer series.
212 ///
213 /// True if frames compressed in a separate session will be
214 /// concatenated following the end of this one. False if this is a
215 /// stand-alone session, or if this session will encode the last
216 /// segment of a multi-segment compression. By default, false.
217 ///
218 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_moreframesafterend?language=objc)
219 pub static kVTCompressionPropertyKey_MoreFramesAfterEnd: &'static CFString;
220}
221
222extern "C" {
223 /// Hint for the video encoder that it should maximize its speed during encode, sacrificing quality if needed
224 ///
225 /// Video encoders sometimes have a tradeoff available between encoding speed and quality at a given bitrate.
226 /// For example, by spending more time refining encoding decisions, it may be possible to make marginal improvements on quality.
227 /// This property lets a client indicate its preference for any such tradeoff.
228 /// Clients may set this property to kCFBooleanTrue to indicate that
229 /// the encoder can take steps to maximize its speed by reducing quality,
230 /// or to kCFBooleanFalse to indicate that the priority should be maximizing quality (at a given bitrate).
231 /// When the property value is NULL, the video encoder will choose its default behavior.
232 /// H.264 and HEVC hardware video encoders prioritize quality over speed by default.
233 /// ProRes hardware encoders currently prioritize speed over quality by default.
234 /// Not all video encoders support this property.
235 /// By default, this property is NULL.
236 ///
237 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_prioritizeencodingspeedoverquality?language=objc)
238 pub static kVTCompressionPropertyKey_PrioritizeEncodingSpeedOverQuality: &'static CFString;
239}
240
241extern "C" {
242 /// Requires that the encoder use a Constant Bit Rate algorithm.
243 ///
244 /// The property kVTCompressionPropertyKey_ExpectedFrameRate should be set along with kVTCompressionPropertyKey_ConstantBitRate
245 /// to ensure effective CBR rate control.
246 ///
247 /// This property is not compatible with kVTCompressionPropertyKey_DataRateLimits and
248 /// kVTCompressionPropertyKey_AverageBitRate.
249 ///
250 /// The encoder will pad the frame if they are smaller than they need to be based on the Constant BitRate. This
251 /// property is not recommended for general streaming or export scenarios. It is intended for interoperability with
252 /// certain streaming CDNs which specifically require that data rates not drop even during low motion and activity scenes.
253 ///
254 /// This is not supported in all encoders or in all encoder operating modes. kVTPropertyNotSupportedErr will be
255 /// returned when this option is not supported.
256 ///
257 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_constantbitrate?language=objc)
258 pub static kVTCompressionPropertyKey_ConstantBitRate: &'static CFString;
259}
260
261extern "C" {
262 /// Returns the encoder's estimate of the expected size of a single encoded frame in bytes, based on current configuration.
263 ///
264 /// When supported, this option is intended to allow clients to estimate the output file size for an encoded video stream.
265 /// This property is not implemented by all video encoders.
266 ///
267 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_estimatedaveragebytesperframe?language=objc)
268 pub static kVTCompressionPropertyKey_EstimatedAverageBytesPerFrame: &'static CFString;
269}
270
271extern "C" {
272 /// Specifies the profile and level for the encoded bitstream.
273 ///
274 /// Available profiles and levels vary across formats and between video encoders.
275 /// Video encoders should use standard keys where available, and follow standard patterns where not.
276 ///
277 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_profilelevel?language=objc)
278 pub static kVTCompressionPropertyKey_ProfileLevel: &'static CFString;
279}
280
281extern "C" {
282 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_hevc_main_autolevel?language=objc)
283 pub static kVTProfileLevel_HEVC_Main_AutoLevel: &'static CFString;
284}
285
286extern "C" {
287 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_hevc_main10_autolevel?language=objc)
288 pub static kVTProfileLevel_HEVC_Main10_AutoLevel: &'static CFString;
289}
290
291extern "C" {
292 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_hevc_main42210_autolevel?language=objc)
293 pub static kVTProfileLevel_HEVC_Main42210_AutoLevel: &'static CFString;
294}
295
296extern "C" {
297 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_hevc_monochrome_autolevel?language=objc)
298 pub static kVTProfileLevel_HEVC_Monochrome_AutoLevel: &'static CFString;
299}
300
301extern "C" {
302 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_hevc_monochrome10_autolevel?language=objc)
303 pub static kVTProfileLevel_HEVC_Monochrome10_AutoLevel: &'static CFString;
304}
305
306extern "C" {
307 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_1_3?language=objc)
308 pub static kVTProfileLevel_H264_Baseline_1_3: &'static CFString;
309}
310
311extern "C" {
312 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_3_0?language=objc)
313 pub static kVTProfileLevel_H264_Baseline_3_0: &'static CFString;
314}
315
316extern "C" {
317 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_3_1?language=objc)
318 pub static kVTProfileLevel_H264_Baseline_3_1: &'static CFString;
319}
320
321extern "C" {
322 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_3_2?language=objc)
323 pub static kVTProfileLevel_H264_Baseline_3_2: &'static CFString;
324}
325
326extern "C" {
327 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_4_0?language=objc)
328 pub static kVTProfileLevel_H264_Baseline_4_0: &'static CFString;
329}
330
331extern "C" {
332 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_4_1?language=objc)
333 pub static kVTProfileLevel_H264_Baseline_4_1: &'static CFString;
334}
335
336extern "C" {
337 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_4_2?language=objc)
338 pub static kVTProfileLevel_H264_Baseline_4_2: &'static CFString;
339}
340
341extern "C" {
342 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_5_0?language=objc)
343 pub static kVTProfileLevel_H264_Baseline_5_0: &'static CFString;
344}
345
346extern "C" {
347 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_5_1?language=objc)
348 pub static kVTProfileLevel_H264_Baseline_5_1: &'static CFString;
349}
350
351extern "C" {
352 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_5_2?language=objc)
353 pub static kVTProfileLevel_H264_Baseline_5_2: &'static CFString;
354}
355
356extern "C" {
357 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_autolevel?language=objc)
358 pub static kVTProfileLevel_H264_Baseline_AutoLevel: &'static CFString;
359}
360
361extern "C" {
362 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_constrainedbaseline_autolevel?language=objc)
363 pub static kVTProfileLevel_H264_ConstrainedBaseline_AutoLevel: &'static CFString;
364}
365
366extern "C" {
367 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_3_0?language=objc)
368 pub static kVTProfileLevel_H264_Main_3_0: &'static CFString;
369}
370
371extern "C" {
372 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_3_1?language=objc)
373 pub static kVTProfileLevel_H264_Main_3_1: &'static CFString;
374}
375
376extern "C" {
377 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_3_2?language=objc)
378 pub static kVTProfileLevel_H264_Main_3_2: &'static CFString;
379}
380
381extern "C" {
382 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_4_0?language=objc)
383 pub static kVTProfileLevel_H264_Main_4_0: &'static CFString;
384}
385
386extern "C" {
387 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_4_1?language=objc)
388 pub static kVTProfileLevel_H264_Main_4_1: &'static CFString;
389}
390
391extern "C" {
392 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_4_2?language=objc)
393 pub static kVTProfileLevel_H264_Main_4_2: &'static CFString;
394}
395
396extern "C" {
397 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_5_0?language=objc)
398 pub static kVTProfileLevel_H264_Main_5_0: &'static CFString;
399}
400
401extern "C" {
402 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_5_1?language=objc)
403 pub static kVTProfileLevel_H264_Main_5_1: &'static CFString;
404}
405
406extern "C" {
407 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_5_2?language=objc)
408 pub static kVTProfileLevel_H264_Main_5_2: &'static CFString;
409}
410
411extern "C" {
412 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_autolevel?language=objc)
413 pub static kVTProfileLevel_H264_Main_AutoLevel: &'static CFString;
414}
415
416extern "C" {
417 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_extended_5_0?language=objc)
418 pub static kVTProfileLevel_H264_Extended_5_0: &'static CFString;
419}
420
421extern "C" {
422 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_extended_autolevel?language=objc)
423 pub static kVTProfileLevel_H264_Extended_AutoLevel: &'static CFString;
424}
425
426extern "C" {
427 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_3_0?language=objc)
428 pub static kVTProfileLevel_H264_High_3_0: &'static CFString;
429}
430
431extern "C" {
432 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_3_1?language=objc)
433 pub static kVTProfileLevel_H264_High_3_1: &'static CFString;
434}
435
436extern "C" {
437 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_3_2?language=objc)
438 pub static kVTProfileLevel_H264_High_3_2: &'static CFString;
439}
440
441extern "C" {
442 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_4_0?language=objc)
443 pub static kVTProfileLevel_H264_High_4_0: &'static CFString;
444}
445
446extern "C" {
447 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_4_1?language=objc)
448 pub static kVTProfileLevel_H264_High_4_1: &'static CFString;
449}
450
451extern "C" {
452 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_4_2?language=objc)
453 pub static kVTProfileLevel_H264_High_4_2: &'static CFString;
454}
455
456extern "C" {
457 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_5_0?language=objc)
458 pub static kVTProfileLevel_H264_High_5_0: &'static CFString;
459}
460
461extern "C" {
462 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_5_1?language=objc)
463 pub static kVTProfileLevel_H264_High_5_1: &'static CFString;
464}
465
466extern "C" {
467 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_5_2?language=objc)
468 pub static kVTProfileLevel_H264_High_5_2: &'static CFString;
469}
470
471extern "C" {
472 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_autolevel?language=objc)
473 pub static kVTProfileLevel_H264_High_AutoLevel: &'static CFString;
474}
475
476extern "C" {
477 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_constrainedhigh_autolevel?language=objc)
478 pub static kVTProfileLevel_H264_ConstrainedHigh_AutoLevel: &'static CFString;
479}
480
481extern "C" {
482 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_simple_l0?language=objc)
483 pub static kVTProfileLevel_MP4V_Simple_L0: &'static CFString;
484}
485
486extern "C" {
487 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_simple_l1?language=objc)
488 pub static kVTProfileLevel_MP4V_Simple_L1: &'static CFString;
489}
490
491extern "C" {
492 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_simple_l2?language=objc)
493 pub static kVTProfileLevel_MP4V_Simple_L2: &'static CFString;
494}
495
496extern "C" {
497 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_simple_l3?language=objc)
498 pub static kVTProfileLevel_MP4V_Simple_L3: &'static CFString;
499}
500
501extern "C" {
502 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_main_l2?language=objc)
503 pub static kVTProfileLevel_MP4V_Main_L2: &'static CFString;
504}
505
506extern "C" {
507 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_main_l3?language=objc)
508 pub static kVTProfileLevel_MP4V_Main_L3: &'static CFString;
509}
510
511extern "C" {
512 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_main_l4?language=objc)
513 pub static kVTProfileLevel_MP4V_Main_L4: &'static CFString;
514}
515
516extern "C" {
517 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_advancedsimple_l0?language=objc)
518 pub static kVTProfileLevel_MP4V_AdvancedSimple_L0: &'static CFString;
519}
520
521extern "C" {
522 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_advancedsimple_l1?language=objc)
523 pub static kVTProfileLevel_MP4V_AdvancedSimple_L1: &'static CFString;
524}
525
526extern "C" {
527 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_advancedsimple_l2?language=objc)
528 pub static kVTProfileLevel_MP4V_AdvancedSimple_L2: &'static CFString;
529}
530
531extern "C" {
532 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_advancedsimple_l3?language=objc)
533 pub static kVTProfileLevel_MP4V_AdvancedSimple_L3: &'static CFString;
534}
535
536extern "C" {
537 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_advancedsimple_l4?language=objc)
538 pub static kVTProfileLevel_MP4V_AdvancedSimple_L4: &'static CFString;
539}
540
541extern "C" {
542 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h263_profile0_level10?language=objc)
543 pub static kVTProfileLevel_H263_Profile0_Level10: &'static CFString;
544}
545
546extern "C" {
547 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h263_profile0_level45?language=objc)
548 pub static kVTProfileLevel_H263_Profile0_Level45: &'static CFString;
549}
550
551extern "C" {
552 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h263_profile3_level45?language=objc)
553 pub static kVTProfileLevel_H263_Profile3_Level45: &'static CFString;
554}
555
556extern "C" {
557 /// When set, requires the encoder to output bitstream with the requested bit depth, if supported by the configured profile level setting.
558 /// In the absence of this property, the video encoder will assume the highest bit depth allowable by the configured profile level setting.
559 ///
560 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_outputbitdepth?language=objc)
561 pub static kVTCompressionPropertyKey_OutputBitDepth: &'static CFString;
562}
563
564extern "C" {
565 /// The mode for HDR metadata in the output bitstream.
566 ///
567 /// If set to kVTHDRMetadataInsertionMode_None, no HDR metadata will
568 /// be present in the output bitstream. For other modes,
569 /// VTCompressionSession will determine what type of HDR metadata
570 /// to insert based on the output color space. e.g. DolbyVision, HDR10, etc.
571 /// This property has no effect if the output color space is not HDR, or if
572 /// there is currently no underlying support for the HDR format.
573 ///
574 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_hdrmetadatainsertionmode?language=objc)
575 pub static kVTCompressionPropertyKey_HDRMetadataInsertionMode: &'static CFString;
576}
577
578extern "C" {
579 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvthdrmetadatainsertionmode_none?language=objc)
580 pub static kVTHDRMetadataInsertionMode_None: &'static CFString;
581}
582
583extern "C" {
584 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvthdrmetadatainsertionmode_auto?language=objc)
585 pub static kVTHDRMetadataInsertionMode_Auto: &'static CFString;
586}
587
588extern "C" {
589 /// The entropy encoding mode for H.264 compression.
590 ///
591 /// If supported by an H.264 encoder, this property controls whether the encoder should use
592 /// Context-based Adaptive Variable Length Coding (CAVLC) or Context-based Adaptive Binary Arithmetic Coding (CABAC).
593 /// CABAC generally gives better compression at the expense of higher computational overhead.
594 /// The default value is encoder-specific and may change depending on other encoder settings.
595 /// Care should be taken when using this property -- changes may result in a configuration
596 /// which is not compatible with a requested Profile and Level. Results in this case are undefined,
597 /// and could include encode errors or a non-compliant output stream.
598 ///
599 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_h264entropymode?language=objc)
600 pub static kVTCompressionPropertyKey_H264EntropyMode: &'static CFString;
601}
602
603extern "C" {
604 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvth264entropymode_cavlc?language=objc)
605 pub static kVTH264EntropyMode_CAVLC: &'static CFString;
606}
607
608extern "C" {
609 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvth264entropymode_cabac?language=objc)
610 pub static kVTH264EntropyMode_CABAC: &'static CFString;
611}
612
613extern "C" {
614 /// The pixel depth of the encoded video.
615 ///
616 /// This property is only supported by video encoders for formats that are
617 /// tied to particular pixel formats (eg, 16-bit RGB, 24-bit RGB).
618 ///
619 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_depth?language=objc)
620 pub static kVTCompressionPropertyKey_Depth: &'static CFString;
621}
622
623extern "C" {
624 /// Instructs the encoder to encode or discard the alpha channel of input video frames
625 ///
626 /// This property allows a client to specify whether or not the alpha channel in the source pixelBuffers should be encoded.
627 /// The client may set this to kCFBooleanFalse in cases where they are not interested in preserving alpha, or if the alpha channel is known to be fully opaque.
628 /// This property is not supported by all encoders.
629 ///
630 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_preservealphachannel?language=objc)
631 pub static kVTCompressionPropertyKey_PreserveAlphaChannel: &'static CFString;
632}
633
634extern "C" {
635 /// The maximum frame delay count is the maximum number of frames that
636 /// a compressor is allowed to hold before it must output a compressed
637 /// frame.
638 ///
639 /// It limits the number of frames that may be held in the
640 /// "compression window". If the maximum frame delay count is M, then
641 /// before the call to encode frame N returns, frame N-M must have
642 /// been emitted.
643 /// The default is kVTUnlimitedFrameDelayCount, which sets no limit
644 /// on the compression window.
645 ///
646 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maxframedelaycount?language=objc)
647 pub static kVTCompressionPropertyKey_MaxFrameDelayCount: &'static CFString;
648}
649
650/// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtunlimitedframedelaycount?language=objc)
651pub const kVTUnlimitedFrameDelayCount: c_int = -1;
652
653extern "C" {
654 /// Specifies the maximum slice size for H.264 encoding
655 ///
656 /// If supported by an H.264 encoder, the value limits the size in bytes of
657 /// slices produced by the encoder, where possible.
658 /// By default, no limit is specified. A value of zero implies default behavior.
659 ///
660 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maxh264slicebytes?language=objc)
661 pub static kVTCompressionPropertyKey_MaxH264SliceBytes: &'static CFString;
662}
663
664extern "C" {
665 /// Hints the video encoder that compression is, or is not, being performed in real time.
666 ///
667 /// For offline compression, clients are advised to set this property to kCFBooleanFalse.
668 /// This indicates that the timeline of the frames is not connected to wall-clock time at all.
669 /// This allows the video encoder to run either slower than real-time or faster than real-time,
670 /// depending upon the situation and device capabilities.
671 /// For real-time compression, clients are advised to set this property to kCFBooleanTrue.
672 /// This indicates that the timeline of frames is connected to real time (so, for example,
673 /// the client expects to encode one second of frames each second, on average).
674 /// In such a case, it is important that encoding keep up, but it is also not valuable to encode
675 /// substantially faster than real time.
676 /// When this property is set to kCFBooleanTrue, the video encoder may use the value of the
677 /// kVTCompressionPropertyKey_ExpectedFrameRate property to optimize energy usage,
678 /// by anticipating that encoding requests will happen at this rate.
679 /// By default, this property is NULL, indicating unknown.
680 ///
681 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_realtime?language=objc)
682 pub static kVTCompressionPropertyKey_RealTime: &'static CFString;
683}
684
685extern "C" {
686 /// Hints to the video encoder that it should maximize power efficiency during encode.
687 ///
688 /// For compression where the client is operating in the background, clients may set this property to kCFBooleanTrue, which indicates that
689 /// the encoder can take steps to minimize impact on power usage and other system activity.
690 /// Setting the property to NULL is equivalent to setting it to kCFBooleanFalse.
691 /// Not all video encoders support this property.
692 /// By default, this property is NULL.
693 /// If the kVTCompressionPropertyKey_RealTime property is set to kCFBooleanTrue,
694 /// the video encoder may act as though this property were set to kCFBooleanFalse.
695 ///
696 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maximizepowerefficiency?language=objc)
697 pub static kVTCompressionPropertyKey_MaximizePowerEfficiency: &'static CFString;
698}
699
700extern "C" {
701 /// Indicates the number of source frames, if known.
702 ///
703 /// This property allows a client to give the video encoder advance guidance as to how
704 /// many frames will be encoded.
705 /// If nonzero, this should be the exact number of times that the client calls
706 /// VTCompressionSessionEncodeFrame in each pass.
707 /// The default is 0, which indicates that the number of source frames
708 /// is not known.
709 ///
710 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_sourceframecount?language=objc)
711 pub static kVTCompressionPropertyKey_SourceFrameCount: &'static CFString;
712}
713
714extern "C" {
715 /// Indicates the expected frame rate of the video to be encoded.
716 ///
717 /// The frame rate is measured in frames per second.
718 /// This property is used to inform the encoder of the expected cadence of the presentation time stamp values of frames that will be submitted to the encoder.
719 /// The actual frame rate may vary, and will depend on the frame durations calculated by the difference between subsequent presentation time stamps.
720 /// If kVTCompressionPropertyKey_RealTime has been set to true, the ExpectedFrameRate may be used to optimize energy usage as well as perform internal encoder configuration before compression begins.
721 /// If kVTCompressionPropertyKey_RealTime is not set, or has been set to false, the ExpectedFrameRate is still helpful and allows the encoder to optimize internal encoder configuration before compression begins.
722 /// By default, the property has a value of zero indicating "unknown".
723 ///
724 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_expectedframerate?language=objc)
725 pub static kVTCompressionPropertyKey_ExpectedFrameRate: &'static CFString;
726}
727
728extern "C" {
729 /// Indicates the maximum real time rate at which frames could be submitted to the VTCompressionSession
730 ///
731 /// The frame rate is measured in frames per second.
732 /// This property can be used to inform the encoder of the maximum rate that frames could be submitted to the encoder during realtime encoding. This allows the encoder to configure itself to ensure this capability.
733 /// This property can only be used when kVTCompressionPropertyKey_RealTime has been set to true.
734 /// Unlike kVTCompressionPropertyKey_ExpectedFrameRate, this property informs the maximum possible rate that the VTCompressionSession could see, not the average frame rate that is expected in normal operation.
735 /// By default, the property has a value of zero indicating "unknown".
736 ///
737 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maximumrealtimeframerate?language=objc)
738 pub static kVTCompressionPropertyKey_MaximumRealTimeFrameRate: &'static CFString;
739}
740
741extern "C" {
742 /// This property indicates the desired frame rate fraction of the base layer.
743 ///
744 /// This property indicates the fraction of total frames submitted that should be encoded in the base layer.
745 /// For example, a value of 0.5 means that half of the frames are in the base layer, and half are in the enhancement layer.
746 ///
747 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_baselayerframeratefraction?language=objc)
748 pub static kVTCompressionPropertyKey_BaseLayerFrameRateFraction: &'static CFString;
749}
750
751extern "C" {
752 /// This property indicates the desired bit rate fraction of the base layer
753 ///
754 /// This is not a hard limit; the encoder will attempt to satisfy this ratio when possible. If not set, the encoder will manage the ratio.
755 /// For example: If the target bitrate is set to 500kbps and kVTCompressionPropertyKey_BaseLayerBitRateFraction is set to 0.6, the base layer will be given a
756 /// budget of 300kbps and the enhancement layer 200kbps.
757 ///
758 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_baselayerbitratefraction?language=objc)
759 pub static kVTCompressionPropertyKey_BaseLayerBitRateFraction: &'static CFString;
760}
761
762extern "C" {
763 /// Indicates the expected total duration for the compression session, if known.
764 ///
765 /// By default, this is zero, indicating "unknown".
766 ///
767 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_expectedduration?language=objc)
768 pub static kVTCompressionPropertyKey_ExpectedDuration: &'static CFString;
769}
770
771extern "C" {
772 /// This property indicates the desired frame rate for the base temporal layer used in hierarchical video encoding.
773 ///
774 /// The frame rate is measured in frames per second.
775 /// This property is only implemented by encoders which support hierarchical frame encoding, and requests that this encoding feature be enabled.
776 ///
777 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_baselayerframerate?language=objc)
778 pub static kVTCompressionPropertyKey_BaseLayerFrameRate: &'static CFString;
779}
780
781extern "C" {
782 /// The client will be able to control the the maximum allowed ReferenceBufferCount using this optional key.
783 ///
784 /// This is typically used to force the encoder to use lower count than allowed by the stantard for a level/profile.
785 /// The encoder will fail and report an error if the requested value exceeds the limit set by the standard for such a level/profile.
786 ///
787 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_referencebuffercount?language=objc)
788 pub static kVTCompressionPropertyKey_ReferenceBufferCount: &'static CFString;
789}
790
791extern "C" {
792 /// This property requests that the encoder measure and output the Mean Squared Error(MSE) quality metric.
793 ///
794 /// The MSE value returned may be measured using an internal representation of the decoded frame which may lack filtering or processing present in the actual decoded frame. Because of this, there may be a small delta between the reported MSE and the true MSE.
795 /// If supported, the MSE values will be returned as sample buffer attachments on the encoded frame using the kVTSampleAttachmentKey_QualityMetrics key.
796 ///
797 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_calculatemeansquarederror?language=objc)
798 pub static kVTCompressionPropertyKey_CalculateMeanSquaredError: &'static CFString;
799}
800
801extern "C" {
802 /// The value for this key contain quality-related metadata from the video encoder for a video frame.
803 ///
804 /// The video encoder will attach this via the CMSampleBufferGetSampleAttachmentsArray interface before emitting the sample buffer.
805 ///
806 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtsampleattachmentkey_qualitymetrics?language=objc)
807 pub static kVTSampleAttachmentKey_QualityMetrics: &'static CFString;
808}
809
810extern "C" {
811 /// Key for mean squared error (MSE) of the encoded Luma channel from the video encoder.
812 ///
813 /// For single-view video, a CFNumber value is returned.
814 /// For multi-view video, a CFArray value is returned, and each element (CFNumber) in the CFArray includes MSE for the corresponding view.
815 /// The video encoder will attach this in kVTSampleAttachmentKey_QualityMetrics via the CMSampleBufferGetSampleAttachmentsArray interface before emitting the sample buffer.
816 ///
817 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtsampleattachmentqualitymetricskey_lumameansquarederror?language=objc)
818 pub static kVTSampleAttachmentQualityMetricsKey_LumaMeanSquaredError: &'static CFString;
819}
820
821extern "C" {
822 /// Key for mean squared error (MSE) of the encoded Chroma Blue channel from the video encoder.
823 ///
824 /// For single-view video, a CFNumber value is returned.
825 /// For multi-view video, a CFArray value is returned, and each element (CFNumber) in the CFArray includes MSE for the corresponding view.
826 /// The video encoder will attach this in kVTSampleAttachmentKey_QualityMetrics via the CMSampleBufferGetSampleAttachmentsArray interface before emitting the sample buffer.
827 ///
828 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtsampleattachmentqualitymetricskey_chromabluemeansquarederror?language=objc)
829 pub static kVTSampleAttachmentQualityMetricsKey_ChromaBlueMeanSquaredError: &'static CFString;
830}
831
832extern "C" {
833 /// Key for mean squared error (MSE) of the encoded Chroma Red channel from the video encoder.
834 ///
835 /// For single-view video, a CFNumber value is returned.
836 /// For multi-view video, a CFArray value is returned, and each element (CFNumber) in the CFArray includes MSE for the corresponding view.
837 /// The video encoder will attach this in kVTSampleAttachmentKey_QualityMetrics via the CMSampleBufferGetSampleAttachmentsArray interface before emitting the sample buffer.
838 ///
839 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtsampleattachmentqualitymetricskey_chromaredmeansquarederror?language=objc)
840 pub static kVTSampleAttachmentQualityMetricsKey_ChromaRedMeanSquaredError: &'static CFString;
841}
842
843extern "C" {
844 /// If set to kCFBooleanTrue, use a hardware accelerated video encoder if available. If set to
845 /// kCFBooleanFalse, hardware encode will never be used.
846 ///
847 /// This key is set in the encoderSpecification passed in to VTCompressionSessionCreate. Set it
848 /// to kCFBooleanTrue to allow hardware accelerated encode. To prevent hardware encode,
849 /// this property can be set to kCFBooleanFalse.
850 /// In MacOS 10.15 and later, hardware encode is enabled in VTCompressionSessions by default.
851 ///
852 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtvideoencoderspecification_enablehardwareacceleratedvideoencoder?language=objc)
853 pub static kVTVideoEncoderSpecification_EnableHardwareAcceleratedVideoEncoder:
854 &'static CFString;
855}
856
857extern "C" {
858 /// If set to kCFBooleanTrue, only use hardware encode and return an error if this isn't possible.
859 /// Setting this key automatically implies kVTVideoEncoderSpecification_EnableHardwareAcceleratedVideoEncoder --
860 /// there is no need to set both and the Enable key does nothing if the Require key is set.
861 ///
862 /// This key is set in the encoderSpecification passed in to VTCompressionSessionCreate. Set it
863 /// to kCFBooleanTrue to require hardware accelerated encode. If hardware acceleration is not
864 /// possible, the VTCompressionSessionCreate call will fail.
865 /// This key is useful for clients that have their own software encode implementation or
866 /// those that may want to configure software and hardware encode sessions differently.
867 /// Hardware acceleration may be unavailable for a number of reasons. A few common cases are:
868 /// - the machine does not have hardware acceleration capabilities
869 /// - the requested encoding format or encoding configuration is not supported
870 /// - the hardware encoding resources on the machine are busy
871 ///
872 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtvideoencoderspecification_requirehardwareacceleratedvideoencoder?language=objc)
873 pub static kVTVideoEncoderSpecification_RequireHardwareAcceleratedVideoEncoder:
874 &'static CFString;
875}
876
877extern "C" {
878 /// If set to kCFBooleanTrue, a hardware accelerated video encoder is being used.
879 ///
880 /// You can query this property using VTSessionCopyProperty after you have enabled hardware
881 /// accelerated encode using kVTVideoEncoderSpecification_EnableHardwareAcceleratedVideoEncoder
882 /// to see if a hardware accelerated encoder was selected.
883 ///
884 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_usinghardwareacceleratedvideoencoder?language=objc)
885 pub static kVTCompressionPropertyKey_UsingHardwareAcceleratedVideoEncoder: &'static CFString;
886}
887
888extern "C" {
889 /// If set, the VideoToolbox will only use a hardware encoder running on the GPU specified by the provided GPU registryID.
890 ///
891 /// This specification implies kVTVideoEncoderSpecification_EnableHardwareAcceleratedVideoEncoder. A separate hardware encode opt-in is not required.
892 /// The GPU registryID can be obtained from a MTLDevice using [MTLDevice registryID] or can be obtained from OpenGL or OpenCL.
893 ///
894 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtvideoencoderspecification_requiredencodergpuregistryid?language=objc)
895 pub static kVTVideoEncoderSpecification_RequiredEncoderGPURegistryID: &'static CFString;
896}
897
898extern "C" {
899 /// If set, the VideoToolbox will try to use a hardware encoder running on the GPU specified by the provided GPU registryID. If the
900 /// GPU does not support encode of the specified format, the VideoToolbox will fall back to alternate encoders.
901 ///
902 /// This specification implies kVTVideoEncoderSpecification_EnableHardwareAcceleratedVideoEncoder. A separate hardware encode opt-in is not required.
903 /// If both kVTVideoEncoderSpecification_PreferredEncoderGPURegistryID and kVTVideoEncoderSpecification_RequiredEncoderGPURegistryID are set, kVTVideoEncoderSpecification_PreferredEncoderGPURegistryID will be ignored.
904 /// This specification can be used in conjunction with kVTVideoEncoderSpecification_RequireHardwareAcceleratedVideoEncoder to prevent a fallback to software encode.
905 /// The GPU registryID can be obtained from a MTLDevice using [MTLDevice registryID] or can be obtained from OpenGL or OpenCL.
906 ///
907 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtvideoencoderspecification_preferredencodergpuregistryid?language=objc)
908 pub static kVTVideoEncoderSpecification_PreferredEncoderGPURegistryID: &'static CFString;
909}
910
911extern "C" {
912 /// returns CFNumber indicating the gpu registryID of the encoder that was selected. NULL indicates a built-in encoder or software encode was used.
913 ///
914 /// You can query this property using VTSessionCopyProperty after building a VTCompressionSession to find out which GPU the encoder is using.
915 /// If a encoder based on a built-in GPU was used it will return NULL. If a software encoder is used, it will return NULL
916 ///
917 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_usinggpuregistryid?language=objc)
918 pub static kVTCompressionPropertyKey_UsingGPURegistryID: &'static CFString;
919}
920
921extern "C" {
922 /// This property can be queried to determine if the encoder supports base frame QP requests.
923 ///
924 /// If this property returns kCFBooleanTrue, it indicates that the encoder supports base frame QP requests through kVTEncodeFrameOptionKey_BaseFrameQP. If it returns false or kVTPropertyNotSupportedErr, base frame QP requests will cause errors on VTCompressionSessionEncodeFrame calls, or will be ignored.
925 ///
926 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_supportsbaseframeqp?language=objc)
927 pub static kVTCompressionPropertyKey_SupportsBaseFrameQP: &'static CFString;
928}
929
930extern "C" {
931 /// CFBoolean forcing the current frame to be a key frame
932 ///
933 /// This value is set in the frameProperties CFDictionary passed to
934 /// VTCompressionSessionEncodeFrame to force the current frame to be a
935 /// keyframe or not.
936 /// Note that it may not be possible for the encoder to accomodate all
937 /// requests.
938 ///
939 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtencodeframeoptionkey_forcekeyframe?language=objc)
940 pub static kVTEncodeFrameOptionKey_ForceKeyFrame: &'static CFString;
941}
942
943extern "C" {
944 /// CFNumberRef requesting the current frame to use the provided base frame QP.
945 ///
946 /// This value is set in the frameProperties CFDictionary passed to VTCompressionSessionEncodeFrame to force
947 /// the QP value for the current frame. This is an optional parameter. Use it only when you have a specific requirement
948 /// for the video quality and you are familiar with frame QP and are prepared to assume full responsibility for rate control.
949 /// Otherwise it is strongly encouraged to rely on the encoder’s rate control for adjusting frame QP.
950 ///
951 /// Setting BaseFrameQP turns off standard rate control and will cause the following properties to be ignored::
952 /// kVTCompressionPropertyKey_DataRateLimits
953 /// kVTCompressionPropertyKey_AverageBitRate
954 /// kVTCompressionPropertyKey_BaseLayerBitRateFraction
955 /// kVTCompressionPropertyKey_Quality
956 /// kVTCompressionPropertyKey_MaxAllowedFrameQP
957 /// kVTCompressionPropertyKey_MinAllowedFrameQP
958 ///
959 /// If kVTEncodeFrameOptionKey_BaseFrameQP is used, it must be set for all frames in a session. The QP value specified is
960 /// frame-level but macro-block level QP may be modulated inside a frame. There will be no rate-control related frame dropping
961 /// if kVTEncodeFrameOptionKey_BaseFrameQP is used.
962 ///
963 /// kVTEncodeFrameOptionKey_BaseFrameQP is only supported if the encoder returns kCFBooleanTrue when the
964 /// kVTCompressionPropertyKey_SupportsBaseFrameQP is queried. If this FrameOptionKey is set for encoder which
965 /// does not support it, it will be ignored.
966 ///
967 /// Note that it may not be possible for the encoder to accommodate all requests.
968 ///
969 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtencodeframeoptionkey_baseframeqp?language=objc)
970 pub static kVTEncodeFrameOptionKey_BaseFrameQP: &'static CFString;
971}
972
973extern "C" {
974 /// Describes the clean aperture for encoded frames.
975 ///
976 /// Some video encoders may enforce specific clean apertures;
977 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
978 /// The clean aperture will be set on the format description for output samples,
979 /// and may affect source frame scaling.
980 /// NULL is a valid value for this property, meaning that the clean aperture is the full width and height.
981 ///
982 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_cleanaperture?language=objc)
983 pub static kVTCompressionPropertyKey_CleanAperture: &'static CFString;
984}
985
986extern "C" {
987 /// Describes the pixel aspect ratio for encoded frames.
988 ///
989 /// Some video encoders may enforce specific pixel aspect ratios;
990 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
991 /// The pixel aspect ratio will be set on the format description for output samples,
992 /// and may affect source frame scaling.
993 /// NULL is a valid value for this property, meaning square pixels (1:1).
994 ///
995 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_pixelaspectratio?language=objc)
996 pub static kVTCompressionPropertyKey_PixelAspectRatio: &'static CFString;
997}
998
999extern "C" {
1000 /// Indicates whether the frames should be encoded progressive (1) or interlaced (2).
1001 ///
1002 /// The field count will be set on the format description for output samples,
1003 /// and may affect source frame scaling.
1004 /// NULL is a valid value for this property.
1005 ///
1006 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_fieldcount?language=objc)
1007 pub static kVTCompressionPropertyKey_FieldCount: &'static CFString;
1008}
1009
1010extern "C" {
1011 /// Indicates field ordering for encoded interlaced frames.
1012 ///
1013 /// Some video encoders may enforce specific field ordering;
1014 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1015 /// The field detail will be set on the format description for output samples,
1016 /// and may affect source frame scaling.
1017 /// NULL is a valid value for this property.
1018 ///
1019 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_fielddetail?language=objc)
1020 pub static kVTCompressionPropertyKey_FieldDetail: &'static CFString;
1021}
1022
1023extern "C" {
1024 /// Indicates that the DV video stream should have the 16x9 flag set.
1025 ///
1026 /// This property is supported by the DV25/50 family of encoders.
1027 /// When false, the picture aspect ratio is 4:3.
1028 /// When true, the picture aspect ratio is 16:9.
1029 /// Either way, a fixed PixelAspectRatio is used (the specific value depends on whether the format is NTSC or PAL).
1030 ///
1031 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_aspectratio16x9?language=objc)
1032 pub static kVTCompressionPropertyKey_AspectRatio16x9: &'static CFString;
1033}
1034
1035extern "C" {
1036 /// Indicates that the DV video stream should have the progressive flag set.
1037 ///
1038 /// This property is supported by the DV25/50 family of encoders.
1039 /// If false, content is encoded as interlaced.
1040 /// If true, content is encoded as progressive.
1041 /// The value of this property fixes the FieldCount and FieldDetail properties.
1042 ///
1043 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_progressivescan?language=objc)
1044 pub static kVTCompressionPropertyKey_ProgressiveScan: &'static CFString;
1045}
1046
1047extern "C" {
1048 /// Indicates color primaries for compressed content.
1049 ///
1050 /// Some video encoders may enforce specific colorimetry;
1051 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1052 /// The value will be set on the format description for output sample buffers.
1053 ///
1054 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_colorprimaries?language=objc)
1055 pub static kVTCompressionPropertyKey_ColorPrimaries: &'static CFString;
1056}
1057
1058extern "C" {
1059 /// Indicates transfer function for compressed content.
1060 ///
1061 /// Some video encoders may enforce specific colorimetry;
1062 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1063 /// The value will be set on the format description for output sample buffers.
1064 ///
1065 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_transferfunction?language=objc)
1066 pub static kVTCompressionPropertyKey_TransferFunction: &'static CFString;
1067}
1068
1069extern "C" {
1070 /// Indicates YCbCr matrix for compressed content.
1071 ///
1072 /// Some video encoders may enforce specific colorimetry;
1073 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1074 /// The value will be set on the format description for output sample buffers.
1075 ///
1076 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_ycbcrmatrix?language=objc)
1077 pub static kVTCompressionPropertyKey_YCbCrMatrix: &'static CFString;
1078}
1079
1080extern "C" {
1081 /// Indicates ICC profile for compressed content.
1082 ///
1083 /// Some video encoders may enforce specific colorimetry;
1084 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1085 /// If this property and any of the previous three are all set, they should be set to consistent values,
1086 /// or undefined behavior may occur.
1087 /// The value will be set on the format description for output sample buffers.
1088 /// NULL can be a valid value for this property.
1089 ///
1090 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_iccprofile?language=objc)
1091 pub static kVTCompressionPropertyKey_ICCProfile: &'static CFString;
1092}
1093
1094extern "C" {
1095 /// The value is 24 bytes containing a big-endian structure as defined in ISO/IEC 23008-2:2015(E), D.2.28 Mastering display colour volume SEI message.
1096 ///
1097 /// The value will be set on the format description for output sample buffers,
1098 /// and incorporated into the appropriate SEI NAL unit where supported by the encoder.
1099 ///
1100 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_masteringdisplaycolorvolume?language=objc)
1101 pub static kVTCompressionPropertyKey_MasteringDisplayColorVolume: &'static CFString;
1102}
1103
1104extern "C" {
1105 /// The value is 4 bytes containing a big-endian structure as defined in the Content Light Level Info SEI message.
1106 ///
1107 /// The value will be set on the format description for output sample buffers,
1108 /// and incorporated into the appropriate SEI NAL unit where supported by the encoder.
1109 ///
1110 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_contentlightlevelinfo?language=objc)
1111 pub static kVTCompressionPropertyKey_ContentLightLevelInfo: &'static CFString;
1112}
1113
1114extern "C" {
1115 /// Indicates gamma level for compressed content.
1116 ///
1117 /// This property allows the caller to specify a gamma value to include in the CMVideoFormatDescription attached to output CMSampleBuffers. It does not change pixel data being encoded.
1118 ///
1119 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_gammalevel?language=objc)
1120 pub static kVTCompressionPropertyKey_GammaLevel: &'static CFString;
1121}
1122
1123extern "C" {
1124 /// Specifies whether the source images' RGB values have been premultiplied by the alpha channel values.
1125 ///
1126 /// Video compression will fail if source image buffers have a mismatched value in their kCVImageBufferAlphaChannelMode attachment.
1127 /// If this property is not set, the encoder may read the first source image buffer's kCVImageBufferAlphaChannelMode attachment.
1128 /// If neither the property nor the first buffer's attachment is set, defaults to kVTAlphaChannelMode_PremultipliedAlpha.
1129 ///
1130 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_alphachannelmode?language=objc)
1131 pub static kVTCompressionPropertyKey_AlphaChannelMode: &'static CFString;
1132}
1133
1134extern "C" {
1135 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtalphachannelmode_straightalpha?language=objc)
1136 pub static kVTAlphaChannelMode_StraightAlpha: &'static CFString;
1137}
1138
1139extern "C" {
1140 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtalphachannelmode_premultipliedalpha?language=objc)
1141 pub static kVTAlphaChannelMode_PremultipliedAlpha: &'static CFString;
1142}
1143
1144extern "C" {
1145 /// Specifies properties to configure a VTPixelTransferSession used to transfer source frames
1146 /// from the client's image buffers to the video encoder's image buffers, if necessary.
1147 ///
1148 /// Setting this property alone does not necessarily guarantee that a VTPixelTransferSession will be created.
1149 /// See VTPixelTransferProperties.h.
1150 ///
1151 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_pixeltransferproperties?language=objc)
1152 pub static kVTCompressionPropertyKey_PixelTransferProperties: &'static CFString;
1153}
1154
1155extern "C" {
1156 /// Enables multi-pass compression and provides storage for encoder-private data.
1157 ///
1158 /// Some video encoders support multi-pass encoding. To determine whether a VTCompressionSession supports multi-pass encoding, you can inspect the dictionary returned by VTSessionCopySupportedPropertyDictionary to see if it contains kVTCompressionPropertyKey_MultiPassStorage.
1159 ///
1160 /// To enable multi-pass encoding, set the kVTCompressionPropertyKey_MultiPassStorage property to a VTMultiPassStorage object, which you can create by calling VTMultiPassStorageCreate. Then make one or more passes over the source frames. Bracket each pass with a call to VTCompressionSessionBeginPass at the beginning and VTCompressionSessionEndPass at the end.
1161 ///
1162 /// In the first pass of multi-pass encoding, call VTCompressionSessionEncodeFrame for every source frame (just as in single-pass encoding). At the end of every pass, call VTCompressionSessionEndPass. This may take some time as the video encoder determines whether it can improve the encoding by performing another pass. If the user cancels encoding during this time, call VTCompressionSessionInvalidate to interrupt the processing. VTCompressionSessionEndPass will indicate via the furtherPassesRequestedOut argument whether the video encoder would like to perform another pass. There is no particular bound on the number of passes the video encoder may request, but the client is free to disregard this request and use the last-emitted set of frames.
1163 ///
1164 /// If *furtherPassesRequestedOut is set to true and you want to perform another pass, call VTCompressionSessionGetTimeRangesForNextPass to determine the time ranges for the next pass. Only the source frames within these time ranges need to be passed to VTCompressionSessionEncodeFrame; the video encoder is satisfied with the already-emitted compressed frames outside these ranges and they can be kept for the final output.
1165 ///
1166 /// In second and successive passes, you must pass identical source frames, frame properties and timestamps to VTCompressionSessionEncodeFrame as in the first pass, with the exception that frames not in the requested time ranges should be skipped.
1167 ///
1168 /// You can create and use a VTFrameSilo object to merge sequences of compressed frames across passes during multi-pass encoding.
1169 ///
1170 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_multipassstorage?language=objc)
1171 pub static kVTCompressionPropertyKey_MultiPassStorage: &'static CFString;
1172}
1173
1174extern "C" {
1175 /// Specifies a particular video encoder by its ID string.
1176 ///
1177 /// Matches the value specified in kVTVideoEncoderSpecification_EncoderID, and the kVTVideoEncoderList_EncoderID value returned from VTCopyVideoEncoderList.
1178 ///
1179 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_encoderid?language=objc)
1180 pub static kVTCompressionPropertyKey_EncoderID: &'static CFString;
1181}
1182
1183extern "C" {
1184 /// If supported by the underlying video encoder, returns the recommended number of VTCompressionSessions to instantiate in a parallel encoding configuration.
1185 ///
1186 /// Parallel encoding VTCompressionSessions require the use of the properties kVTCompressionPropertyKey_MoreFramesBeforeStart, kVTCompressionPropertyKey_MoreFramesAfterEnd, and kVTCompressionPropertyKey_SourceFrameCount.
1187 /// e.g. If the property returns 4, a setup for 4 VTCompressionSessions on a 400 frame movie might look like:
1188 /// compressionSession1
1189 /// kVTCompressionPropertyKey_MoreFramesBeforeStart = false
1190 /// kVTCompressionPropertyKey_MoreFramesAfterEnd = true
1191 /// kVTCompressionPropertyKey_SourceFrameCount = 100
1192 /// compressionSession2
1193 /// kVTCompressionPropertyKey_MoreFramesBeforeStart = true
1194 /// kVTCompressionPropertyKey_MoreFramesAfterEnd = true
1195 /// kVTCompressionPropertyKey_SourceFrameCount = 100
1196 /// compressionSession3
1197 /// kVTCompressionPropertyKey_MoreFramesBeforeStart = true
1198 /// kVTCompressionPropertyKey_MoreFramesAfterEnd = true
1199 /// kVTCompressionPropertyKey_SourceFrameCount = 100
1200 /// compressionSession4
1201 /// kVTCompressionPropertyKey_MoreFramesBeforeStart = true
1202 /// kVTCompressionPropertyKey_MoreFramesAfterEnd = false
1203 /// kVTCompressionPropertyKey_SourceFrameCount = 100
1204 ///
1205 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_recommendedparallelizationlimit?language=objc)
1206 pub static kVTCompressionPropertyKey_RecommendedParallelizationLimit: &'static CFString;
1207}
1208
1209extern "C" {
1210 /// If supported by the underlying video encoder, returns the recommended minimum number of video frames for a given subdivision in a parallel encoding configuration.
1211 ///
1212 /// For best results, ensure that the total number of frames of a parallelized subdivision is greater than or equal to this returned value.
1213 /// See also kVTCompressionPropertyKey_RecommendedParallelizationLimit
1214 /// See also kVTCompressionPropertyKey_RecommendedParallelizedSubdivisionMinimumDuration
1215 ///
1216 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_recommendedparallelizedsubdivisionminimumframecount?language=objc)
1217 pub static kVTCompressionPropertyKey_RecommendedParallelizedSubdivisionMinimumFrameCount:
1218 &'static CFString;
1219}
1220
1221extern "C" {
1222 /// If supported by the underlying video encoder, returns the recommended minimum duration for a given subdivision in a parallel encoding configuration.
1223 ///
1224 /// For best results, ensure that the total duration of a parallelized subdivision is greater than or equal to this returned value.
1225 /// See also kVTCompressionPropertyKey_RecommendedParallelizationLimit
1226 /// See also kVTCompressionPropertyKey_RecommendedParallelizedSubdivisionMinimumFrameCount
1227 ///
1228 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_recommendedparallelizedsubdivisionminimumduration?language=objc)
1229 pub static kVTCompressionPropertyKey_RecommendedParallelizedSubdivisionMinimumDuration:
1230 &'static CFString;
1231}
1232
1233extern "C" {
1234 /// Controls whether or not to preserve any dynamic HDR metadata on the input pixel buffer
1235 ///
1236 /// If set to false, and kVTCompressionPropertyKey_HDRMetadataInsertionMode is not
1237 /// kVTHDRMetadataInsertionMode_None, then VTCompressionSession will generate the
1238 /// dynamic HDR metadata for the pixel buffer, if the HDR format is supported.
1239 ///
1240 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_preservedynamichdrmetadata?language=objc)
1241 pub static kVTCompressionPropertyKey_PreserveDynamicHDRMetadata: &'static CFString;
1242}
1243
1244extern "C" {
1245 /// Requires that an encoder which supports low-latency operation be selected, and enables low-latency mode.
1246 ///
1247 /// Low latency RateControl enforces the following behaviors:
1248 /// - Infinite GOP (all P frames following the beginning IDR).
1249 /// - No frame reordering (B frame) or looking ahead.
1250 /// - Only High profiles. Levels are left for the encoder to automatically set.
1251 /// - Temporal Layer structure.
1252 ///
1253 /// Also see:
1254 /// kVTCompressionPropertyKey_AverageBitRate
1255 /// kVTCompressionPropertyKey_BaseLayerFrameRateFraction
1256 /// kVTEncodeFrameOptionKey_ForceKeyFrame
1257 ///
1258 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtvideoencoderspecification_enablelowlatencyratecontrol?language=objc)
1259 pub static kVTVideoEncoderSpecification_EnableLowLatencyRateControl: &'static CFString;
1260}
1261
1262extern "C" {
1263 /// Specifies the maximum allowed encoded frame QP (Quantization Parameter).
1264 ///
1265 /// This is an optional parameter. Use it only when you have a specific requirement for the video quality and you are
1266 /// familiar with frame QP. To satisfy this requirement, the encoder may drop frames to maintain bitrate and QP goals.
1267 /// This is not supported in all encoders or in all encoder operating modes. kVTPropertyNotSupportedErr will be
1268 /// returned when this option is not supported.
1269 ///
1270 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maxallowedframeqp?language=objc)
1271 pub static kVTCompressionPropertyKey_MaxAllowedFrameQP: &'static CFString;
1272}
1273
1274extern "C" {
1275 /// Specifies the minimum allowed encoded frame QP (Quantization Parameter).
1276 ///
1277 /// This is an optional parameter. Use it only when you have a specific requirement for the video quality and you are
1278 /// familiar with frame QP.
1279 /// This is not supported in all encoders or in all encoder operating modes. kVTPropertyNotSupportedErr will be
1280 /// returned when this option is not supported.
1281 ///
1282 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_minallowedframeqp?language=objc)
1283 pub static kVTCompressionPropertyKey_MinAllowedFrameQP: &'static CFString;
1284}
1285
1286extern "C" {
1287 /// Enable Long Term Reference (LTR) frames during encoding
1288 ///
1289 /// When an LTR frame is encoded, encoder will signal a unique token of the LTR frame in the encoder callback through:
1290 /// kVTSampleAttachmentKey_RequireLTRAcknowledgementToken
1291 /// Clients are responsible for reporting acknowledged LTR frames to the encoder through:
1292 /// kVTEncodeFrameOptionKey_AcknowledgedLTRTokens
1293 /// Client can request a refresh frame at any time through:
1294 /// kVTEncodeFrameOptionKey_ForceLTRRefresh
1295 /// Encoder will encode a P frame by using one of acknowledged LTR frames
1296 /// as the reference. Encoder will encode a new reference frame using an acknowledged LTR, or an IDR if no LTR frames have been acknowledged.
1297 ///
1298 /// Also see:
1299 /// kVTEncodeFrameOptionKey_AcknowledgedLTRTokens
1300 /// kVTEncodeFrameOptionKey_ForceLTRRefresh
1301 /// kVTSampleAttachmentKey_RequireLTRAcknowledgementToken
1302 ///
1303 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_enableltr?language=objc)
1304 pub static kVTCompressionPropertyKey_EnableLTR: &'static CFString;
1305}
1306
1307extern "C" {
1308 /// A CFArray of CFNumbers containing the kVTSampleAttachmentKey_RequireLTRAcknowledgementToken values which have been successfully sent to the receiver and can be used as references
1309 ///
1310 /// When an LTR frame is encoded, the encoder will return a unique token for the LTR frame on the output CMSampleBuffer through kVTSampleAttachmentKey_RequireLTRAcknowledgementToken.
1311 /// This token is then returned to the encoder via kVTEncodeFrameOptionKey_AcknowledgedLTRTokens when the LTR frame is received by the remote consumer(s).
1312 ///
1313 /// Also see:
1314 /// kVTCompressionPropertyKey_EnableLTR
1315 /// kVTEncodeFrameOptionKey_ForceLTRRefresh
1316 /// kVTSampleAttachmentKey_RequireLTRAcknowledgementToken
1317 ///
1318 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtencodeframeoptionkey_acknowledgedltrtokens?language=objc)
1319 pub static kVTEncodeFrameOptionKey_AcknowledgedLTRTokens: &'static CFString;
1320}
1321
1322extern "C" {
1323 /// Set this option to kCFBooleanTrue to force an LTR refresh
1324 ///
1325 /// When the encoder receives this request on an incoming frame, the encoder will encode a new reference frame using a previously
1326 /// acknowledged LTR, or it will encode a new IDR if no LTR frames have been acknowledged.
1327 ///
1328 /// Also see:
1329 /// kVTCompressionPropertyKey_EnableLTR
1330 /// kVTEncodeFrameOptionKey_AcknowledgedLTRTokens
1331 /// kVTSampleAttachmentKey_RequireLTRAcknowledgementToken
1332 ///
1333 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtencodeframeoptionkey_forceltrrefresh?language=objc)
1334 pub static kVTEncodeFrameOptionKey_ForceLTRRefresh: &'static CFString;
1335}
1336
1337extern "C" {
1338 /// CFNumber containing a unique token for this LTR
1339 ///
1340 /// This CMSampleBuffer attachment contains a unique token which can be returned to the encoder through
1341 /// kVTEncodeFrameOptionKey_AcknowledgedLTRTokens to indicate that the LTR has been received and may be used as a reference.
1342 ///
1343 /// Also see:
1344 /// kVTCompressionPropertyKey_EnableLTR
1345 /// kVTEncodeFrameOptionKey_AcknowledgedLTRTokens
1346 /// kVTEncodeFrameOptionKey_ForceLTRRefresh
1347 ///
1348 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtsampleattachmentkey_requireltracknowledgementtoken?language=objc)
1349 pub static kVTSampleAttachmentKey_RequireLTRAcknowledgementToken: &'static CFString;
1350}
1351
1352extern "C" {
1353 /// Requests multi-image encoding; advises encoder to expect CMTaggedBufferGroups with specific CMTags referencing these MV-HEVC VideoLayerIDs.
1354 ///
1355 /// MV-HEVC specific.
1356 /// The property value is a CFArray containing VideoLayerIDs as CFNumbers.
1357 /// The property is NULL by default.
1358 ///
1359 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_mvhevcvideolayerids?language=objc)
1360 pub static kVTCompressionPropertyKey_MVHEVCVideoLayerIDs: &'static CFString;
1361}
1362
1363extern "C" {
1364 /// Specifies the ViewIDs corresponding to the VideoLayerIDs provided via kVTCompressionPropertyKey_MVHEVCVideoLayerIDs.
1365 ///
1366 /// MV-HEVC specific.
1367 /// The property value is a CFArray containing ViewIDs as CFNumbers.
1368 /// The entries in this array should be in the same order and have the same count as the value set via kVTCompressionPropertyKey_MVHEVCVideoLayerIDs.
1369 /// The property is NULL by default.
1370 ///
1371 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_mvhevcviewids?language=objc)
1372 pub static kVTCompressionPropertyKey_MVHEVCViewIDs: &'static CFString;
1373}
1374
1375extern "C" {
1376 /// Specifies which of the ViewIDs provided via kVTCompressionPropertyKey_MVHEVCViewIDs is the "left view id" and which is the "right view id".
1377 ///
1378 /// MV-HEVC specific.
1379 /// These ViewIDs will be incorporated into the 3D Reference Displays Info SEI message.
1380 /// The property value is a CFArray containing two ViewIDs as CFNumbers with the first correspponding to the left eye and the second corresponding to the right eye.
1381 /// The property is NULL by default.
1382 ///
1383 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_mvhevcleftandrightviewids?language=objc)
1384 pub static kVTCompressionPropertyKey_MVHEVCLeftAndRightViewIDs: &'static CFString;
1385}
1386
1387extern "C" {
1388 /// Specifies the value of kCMFormatDescriptionExtension_HeroEye.
1389 ///
1390 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1391 ///
1392 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_heroeye?language=objc)
1393 pub static kVTCompressionPropertyKey_HeroEye: &'static CFString;
1394}
1395
1396extern "C" {
1397 /// Specifies the value of kCMFormatDescriptionExtension_StereoCameraBaseline.
1398 ///
1399 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1400 ///
1401 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_stereocamerabaseline?language=objc)
1402 pub static kVTCompressionPropertyKey_StereoCameraBaseline: &'static CFString;
1403}
1404
1405extern "C" {
1406 /// Specifies the value of kCMFormatDescriptionExtension_HorizontalDisparityAdjustment.
1407 ///
1408 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1409 ///
1410 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_horizontaldisparityadjustment?language=objc)
1411 pub static kVTCompressionPropertyKey_HorizontalDisparityAdjustment: &'static CFString;
1412}
1413
1414extern "C" {
1415 /// Specifies the value of kCMFormatDescriptionExtension_HasLeftStereoEyeView.
1416 ///
1417 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1418 ///
1419 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_hasleftstereoeyeview?language=objc)
1420 pub static kVTCompressionPropertyKey_HasLeftStereoEyeView: &'static CFString;
1421}
1422
1423extern "C" {
1424 /// Specifies the value of kCMFormatDescriptionExtension_HasRightStereoEyeView.
1425 ///
1426 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1427 ///
1428 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_hasrightstereoeyeview?language=objc)
1429 pub static kVTCompressionPropertyKey_HasRightStereoEyeView: &'static CFString;
1430}
1431
1432extern "C" {
1433 /// Specifies the value of kCMFormatDescriptionExtension_HorizontalFieldOfView.
1434 ///
1435 /// The value is a CFNumber holding an unsigned 32-bit integer that is interpreted in millidegree or thousandths of a degree (e.g., 123456 is 123.456 degree).
1436 /// This property is optional and should only be specified if the field of view is known.
1437 ///
1438 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_horizontalfieldofview?language=objc)
1439 pub static kVTCompressionPropertyKey_HorizontalFieldOfView: &'static CFString;
1440}
1441
1442extern "C" {
1443 /// Specifies the value of kCMFormatDescriptionExtension_ProjectionKind.
1444 ///
1445 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1446 ///
1447 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_projectionkind?language=objc)
1448 pub static kVTCompressionPropertyKey_ProjectionKind: &'static CFString;
1449}
1450
1451extern "C" {
1452 /// Specifies the value of kCMFormatDescriptionExtension_ViewPackingKind.
1453 ///
1454 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1455 ///
1456 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_viewpackingkind?language=objc)
1457 pub static kVTCompressionPropertyKey_ViewPackingKind: &'static CFString;
1458}
1459
1460extern "C" {
1461 /// Requests that the encoder retain the specified number of frames during encoding. These frames will be used for additional analysis and statistics
1462 /// gathering before the frame is finally encoded at the end of the window. When this property is not set, video encoder will automatically determine
1463 /// the number of lookahead frames.
1464 ///
1465 /// Encoder will choose number of lookahead frames closer to the suggested value based on internal configuration. This property directly affects latency
1466 /// of the video encoder. The following properties also affect look ahead frames:
1467 /// 1. Value of this property must be less than or equal to `kVTCompressionPropertyKey_MaxFrameDelayCount`.
1468 /// 2. This property is ignored when `VTVideoEncoderSpecification_EnableLowLatencyRateControl` is set to true
1469 /// 3. This property is ignored when `kVTCompressionPropertyKey_Quality` is set to 1.0
1470 /// 4. This property can not be used in conjunction with multi-pass feature (`kVTCompressionPropertyKey_MultiPassStorage`)
1471 ///
1472 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_suggestedlookaheadframecount?language=objc)
1473 pub static kVTCompressionPropertyKey_SuggestedLookAheadFrameCount: &'static CFString;
1474}
1475
1476extern "C" {
1477 /// Control spatial adaptation of the quantization parameter (QP) based on per-frame statistics.
1478 /// If set to kVTQPModulationLevel_Disable, spatial QP adaptation is not applied based on per-frame statistics.
1479 /// If set to kVTQPModulationLevel_Default, video encoder is allowed to apply spatial QP adaptation for each macro block (or coding unit) within a video frame.
1480 /// QP adaptation is based on spatial characteristics of a frame and the level of spatial QP adaptation is decided internally by the rate controller.
1481 ///
1482 /// This property must be disabled when low latency rate control is enabled. Support for this property is codec dependent.
1483 ///
1484 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_spatialadaptiveqplevel?language=objc)
1485 pub static kVTCompressionPropertyKey_SpatialAdaptiveQPLevel: &'static CFString;
1486}
1487
1488/// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtqpmodulationlevel_default?language=objc)
1489pub const kVTQPModulationLevel_Default: c_int = -1;
1490/// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtqpmodulationlevel_disable?language=objc)
1491pub const kVTQPModulationLevel_Disable: c_int = 0;