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,
248 /// kVTCompressionPropertyKey_AverageBitRate, and kVTCompressionPropertyKey_VariableBitRate.
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 /// Requires that the encoder use a variable bitrate (VBR) rate control algorithm and specifies the desired variable bitrate in bits per second.
273 ///
274 /// The actual peak bitrate present in the bitstream may be above or below this value based on other parameters such as kVTCompressionPropertyKey_VBVMaxBitRate.
275 /// This property key needs to be set to achieve Variable Bitrate (VBR) rate control.
276 /// This property key is not compatible with:
277 /// 1. kVTCompressionPropertyKey_AverageBitRate,
278 /// 2. kVTCompressionPropertyKey_ConstantBitRate,
279 /// 3. kVTCompressionPropertyKey_DataRateLimits,
280 /// 4. VTVideoEncoderSpecification_EnableLowLatencyRateControl = True.
281 ///
282 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_variablebitrate?language=objc)
283 pub static kVTCompressionPropertyKey_VariableBitRate: &'static CFString;
284}
285
286extern "C" {
287 /// Defines the maximum bitrate that can enter the video buffering verifier (VBV) model at any time in variable bitrate (VBR) mode.
288 ///
289 /// The value of this property must be greater than zero.
290 /// This property key is not compatible with:
291 /// 1. kVTCompressionPropertyKey_AverageBitRate,
292 /// 2. kVTCompressionPropertyKey_ConstantBitRate,
293 /// 3. kVTCompressionPropertyKey_DataRateLimits,
294 /// 4. VTVideoEncoderSpecification_EnableLowLatencyRateControl=True.
295 ///
296 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_vbvmaxbitrate?language=objc)
297 pub static kVTCompressionPropertyKey_VBVMaxBitRate: &'static CFString;
298}
299
300extern "C" {
301 /// Capacity of the video buffering verifier (VBV) model in seconds.
302 ///
303 /// VBV model allows for larger variations in bitrates while avoiding decoder-side overflows or underflows.
304 /// A larger VBV model size may improve compression quality, but it requires more memory and may introduce delay.
305 /// The value of this property must be greater than 0.0.
306 /// The default value is set as 2.5 seconds.
307 /// This property key is compatible with constant bitrate (CBR) or variable bitrate (VBR) rate control.
308 /// This property key is incompatible with:
309 /// 1. kVTCompressionPropertyKey_AverageBitRate,
310 /// 2. kVTCompressionPropertyKey_DataRateLimits,
311 /// 3. VTVideoEncoderSpecification_EnableLowLatencyRateControl=True.
312 ///
313 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_vbvbufferduration?language=objc)
314 pub static kVTCompressionPropertyKey_VBVBufferDuration: &'static CFString;
315}
316
317extern "C" {
318 /// Initial delay of the VBV model between storing the picture in the VBV buffer model and decoding of that picture, as a percentage of VBV buffer duration.
319 ///
320 /// This value should be specified as a number in the range of 0 to 100.
321 /// Larger value increases the delay but results in smoother playback.
322 /// Default value is 90, meaning 90% of the VBV buffer duration.
323 /// This property key is incompatible with:
324 /// 1. kVTCompressionPropertyKey_AverageBitRate,
325 /// 2. kVTCompressionPropertyKey_DataRateLimits,
326 /// 3. VTVideoEncoderSpecification_EnableLowLatencyRateControl=True.
327 ///
328 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_vbvinitialdelaypercentage?language=objc)
329 pub static kVTCompressionPropertyKey_VBVInitialDelayPercentage: &'static CFString;
330}
331
332extern "C" {
333 /// Specifies the profile and level for the encoded bitstream.
334 ///
335 /// Available profiles and levels vary across formats and between video encoders.
336 /// Video encoders should use standard keys where available, and follow standard patterns where not.
337 ///
338 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_profilelevel?language=objc)
339 pub static kVTCompressionPropertyKey_ProfileLevel: &'static CFString;
340}
341
342extern "C" {
343 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_hevc_main_autolevel?language=objc)
344 pub static kVTProfileLevel_HEVC_Main_AutoLevel: &'static CFString;
345}
346
347extern "C" {
348 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_hevc_main10_autolevel?language=objc)
349 pub static kVTProfileLevel_HEVC_Main10_AutoLevel: &'static CFString;
350}
351
352extern "C" {
353 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_hevc_main42210_autolevel?language=objc)
354 pub static kVTProfileLevel_HEVC_Main42210_AutoLevel: &'static CFString;
355}
356
357extern "C" {
358 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_hevc_monochrome_autolevel?language=objc)
359 pub static kVTProfileLevel_HEVC_Monochrome_AutoLevel: &'static CFString;
360}
361
362extern "C" {
363 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_hevc_monochrome10_autolevel?language=objc)
364 pub static kVTProfileLevel_HEVC_Monochrome10_AutoLevel: &'static CFString;
365}
366
367extern "C" {
368 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_1_3?language=objc)
369 pub static kVTProfileLevel_H264_Baseline_1_3: &'static CFString;
370}
371
372extern "C" {
373 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_3_0?language=objc)
374 pub static kVTProfileLevel_H264_Baseline_3_0: &'static CFString;
375}
376
377extern "C" {
378 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_3_1?language=objc)
379 pub static kVTProfileLevel_H264_Baseline_3_1: &'static CFString;
380}
381
382extern "C" {
383 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_3_2?language=objc)
384 pub static kVTProfileLevel_H264_Baseline_3_2: &'static CFString;
385}
386
387extern "C" {
388 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_4_0?language=objc)
389 pub static kVTProfileLevel_H264_Baseline_4_0: &'static CFString;
390}
391
392extern "C" {
393 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_4_1?language=objc)
394 pub static kVTProfileLevel_H264_Baseline_4_1: &'static CFString;
395}
396
397extern "C" {
398 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_4_2?language=objc)
399 pub static kVTProfileLevel_H264_Baseline_4_2: &'static CFString;
400}
401
402extern "C" {
403 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_5_0?language=objc)
404 pub static kVTProfileLevel_H264_Baseline_5_0: &'static CFString;
405}
406
407extern "C" {
408 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_5_1?language=objc)
409 pub static kVTProfileLevel_H264_Baseline_5_1: &'static CFString;
410}
411
412extern "C" {
413 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_5_2?language=objc)
414 pub static kVTProfileLevel_H264_Baseline_5_2: &'static CFString;
415}
416
417extern "C" {
418 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_baseline_autolevel?language=objc)
419 pub static kVTProfileLevel_H264_Baseline_AutoLevel: &'static CFString;
420}
421
422extern "C" {
423 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_constrainedbaseline_autolevel?language=objc)
424 pub static kVTProfileLevel_H264_ConstrainedBaseline_AutoLevel: &'static CFString;
425}
426
427extern "C" {
428 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_3_0?language=objc)
429 pub static kVTProfileLevel_H264_Main_3_0: &'static CFString;
430}
431
432extern "C" {
433 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_3_1?language=objc)
434 pub static kVTProfileLevel_H264_Main_3_1: &'static CFString;
435}
436
437extern "C" {
438 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_3_2?language=objc)
439 pub static kVTProfileLevel_H264_Main_3_2: &'static CFString;
440}
441
442extern "C" {
443 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_4_0?language=objc)
444 pub static kVTProfileLevel_H264_Main_4_0: &'static CFString;
445}
446
447extern "C" {
448 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_4_1?language=objc)
449 pub static kVTProfileLevel_H264_Main_4_1: &'static CFString;
450}
451
452extern "C" {
453 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_4_2?language=objc)
454 pub static kVTProfileLevel_H264_Main_4_2: &'static CFString;
455}
456
457extern "C" {
458 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_5_0?language=objc)
459 pub static kVTProfileLevel_H264_Main_5_0: &'static CFString;
460}
461
462extern "C" {
463 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_5_1?language=objc)
464 pub static kVTProfileLevel_H264_Main_5_1: &'static CFString;
465}
466
467extern "C" {
468 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_5_2?language=objc)
469 pub static kVTProfileLevel_H264_Main_5_2: &'static CFString;
470}
471
472extern "C" {
473 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_main_autolevel?language=objc)
474 pub static kVTProfileLevel_H264_Main_AutoLevel: &'static CFString;
475}
476
477extern "C" {
478 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_extended_5_0?language=objc)
479 pub static kVTProfileLevel_H264_Extended_5_0: &'static CFString;
480}
481
482extern "C" {
483 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_extended_autolevel?language=objc)
484 pub static kVTProfileLevel_H264_Extended_AutoLevel: &'static CFString;
485}
486
487extern "C" {
488 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_3_0?language=objc)
489 pub static kVTProfileLevel_H264_High_3_0: &'static CFString;
490}
491
492extern "C" {
493 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_3_1?language=objc)
494 pub static kVTProfileLevel_H264_High_3_1: &'static CFString;
495}
496
497extern "C" {
498 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_3_2?language=objc)
499 pub static kVTProfileLevel_H264_High_3_2: &'static CFString;
500}
501
502extern "C" {
503 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_4_0?language=objc)
504 pub static kVTProfileLevel_H264_High_4_0: &'static CFString;
505}
506
507extern "C" {
508 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_4_1?language=objc)
509 pub static kVTProfileLevel_H264_High_4_1: &'static CFString;
510}
511
512extern "C" {
513 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_4_2?language=objc)
514 pub static kVTProfileLevel_H264_High_4_2: &'static CFString;
515}
516
517extern "C" {
518 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_5_0?language=objc)
519 pub static kVTProfileLevel_H264_High_5_0: &'static CFString;
520}
521
522extern "C" {
523 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_5_1?language=objc)
524 pub static kVTProfileLevel_H264_High_5_1: &'static CFString;
525}
526
527extern "C" {
528 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_5_2?language=objc)
529 pub static kVTProfileLevel_H264_High_5_2: &'static CFString;
530}
531
532extern "C" {
533 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_high_autolevel?language=objc)
534 pub static kVTProfileLevel_H264_High_AutoLevel: &'static CFString;
535}
536
537extern "C" {
538 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h264_constrainedhigh_autolevel?language=objc)
539 pub static kVTProfileLevel_H264_ConstrainedHigh_AutoLevel: &'static CFString;
540}
541
542extern "C" {
543 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_simple_l0?language=objc)
544 pub static kVTProfileLevel_MP4V_Simple_L0: &'static CFString;
545}
546
547extern "C" {
548 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_simple_l1?language=objc)
549 pub static kVTProfileLevel_MP4V_Simple_L1: &'static CFString;
550}
551
552extern "C" {
553 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_simple_l2?language=objc)
554 pub static kVTProfileLevel_MP4V_Simple_L2: &'static CFString;
555}
556
557extern "C" {
558 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_simple_l3?language=objc)
559 pub static kVTProfileLevel_MP4V_Simple_L3: &'static CFString;
560}
561
562extern "C" {
563 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_main_l2?language=objc)
564 pub static kVTProfileLevel_MP4V_Main_L2: &'static CFString;
565}
566
567extern "C" {
568 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_main_l3?language=objc)
569 pub static kVTProfileLevel_MP4V_Main_L3: &'static CFString;
570}
571
572extern "C" {
573 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_main_l4?language=objc)
574 pub static kVTProfileLevel_MP4V_Main_L4: &'static CFString;
575}
576
577extern "C" {
578 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_advancedsimple_l0?language=objc)
579 pub static kVTProfileLevel_MP4V_AdvancedSimple_L0: &'static CFString;
580}
581
582extern "C" {
583 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_advancedsimple_l1?language=objc)
584 pub static kVTProfileLevel_MP4V_AdvancedSimple_L1: &'static CFString;
585}
586
587extern "C" {
588 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_advancedsimple_l2?language=objc)
589 pub static kVTProfileLevel_MP4V_AdvancedSimple_L2: &'static CFString;
590}
591
592extern "C" {
593 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_advancedsimple_l3?language=objc)
594 pub static kVTProfileLevel_MP4V_AdvancedSimple_L3: &'static CFString;
595}
596
597extern "C" {
598 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_mp4v_advancedsimple_l4?language=objc)
599 pub static kVTProfileLevel_MP4V_AdvancedSimple_L4: &'static CFString;
600}
601
602extern "C" {
603 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h263_profile0_level10?language=objc)
604 pub static kVTProfileLevel_H263_Profile0_Level10: &'static CFString;
605}
606
607extern "C" {
608 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h263_profile0_level45?language=objc)
609 pub static kVTProfileLevel_H263_Profile0_Level45: &'static CFString;
610}
611
612extern "C" {
613 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprofilelevel_h263_profile3_level45?language=objc)
614 pub static kVTProfileLevel_H263_Profile3_Level45: &'static CFString;
615}
616
617extern "C" {
618 /// When set, requires the encoder to output bitstream with the requested bit depth, if supported by the configured profile level setting.
619 /// In the absence of this property, the video encoder will assume the highest bit depth allowable by the configured profile level setting.
620 ///
621 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_outputbitdepth?language=objc)
622 pub static kVTCompressionPropertyKey_OutputBitDepth: &'static CFString;
623}
624
625extern "C" {
626 /// The mode for HDR metadata in the output bitstream.
627 ///
628 /// If set to kVTHDRMetadataInsertionMode_None, no HDR metadata will
629 /// be present in the output bitstream. For other modes,
630 /// VTCompressionSession will determine what type of HDR metadata
631 /// to insert based on the output color space. e.g. DolbyVision, HDR10, etc.
632 /// This property has no effect if the output color space is not HDR, or if
633 /// there is currently no underlying support for the HDR format.
634 /// kVTHDRMetadataInsertionMode_RequestSDRRangePreservation will
635 /// only insert metadata when the following is true:
636 /// transfer function is kCVImageBufferTransferFunction_SMPTE_ST_2084_PQ
637 /// color primaries is kCVImageBufferColorPrimaries_ITU_R_2020
638 /// color matrix is kCVImageBufferYCbCrMatrix_ITU_R_2020
639 ///
640 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_hdrmetadatainsertionmode?language=objc)
641 pub static kVTCompressionPropertyKey_HDRMetadataInsertionMode: &'static CFString;
642}
643
644extern "C" {
645 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvthdrmetadatainsertionmode_none?language=objc)
646 pub static kVTHDRMetadataInsertionMode_None: &'static CFString;
647}
648
649extern "C" {
650 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvthdrmetadatainsertionmode_auto?language=objc)
651 pub static kVTHDRMetadataInsertionMode_Auto: &'static CFString;
652}
653
654extern "C" {
655 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvthdrmetadatainsertionmode_requestsdrrangepreservation?language=objc)
656 pub static kVTHDRMetadataInsertionMode_RequestSDRRangePreservation: &'static CFString;
657}
658
659extern "C" {
660 /// The entropy encoding mode for H.264 compression.
661 ///
662 /// If supported by an H.264 encoder, this property controls whether the encoder should use
663 /// Context-based Adaptive Variable Length Coding (CAVLC) or Context-based Adaptive Binary Arithmetic Coding (CABAC).
664 /// CABAC generally gives better compression at the expense of higher computational overhead.
665 /// The default value is encoder-specific and may change depending on other encoder settings.
666 /// Care should be taken when using this property -- changes may result in a configuration
667 /// which is not compatible with a requested Profile and Level. Results in this case are undefined,
668 /// and could include encode errors or a non-compliant output stream.
669 ///
670 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_h264entropymode?language=objc)
671 pub static kVTCompressionPropertyKey_H264EntropyMode: &'static CFString;
672}
673
674extern "C" {
675 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvth264entropymode_cavlc?language=objc)
676 pub static kVTH264EntropyMode_CAVLC: &'static CFString;
677}
678
679extern "C" {
680 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvth264entropymode_cabac?language=objc)
681 pub static kVTH264EntropyMode_CABAC: &'static CFString;
682}
683
684extern "C" {
685 /// The pixel depth of the encoded video.
686 ///
687 /// This property is only supported by video encoders for formats that are
688 /// tied to particular pixel formats (eg, 16-bit RGB, 24-bit RGB).
689 ///
690 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_depth?language=objc)
691 pub static kVTCompressionPropertyKey_Depth: &'static CFString;
692}
693
694extern "C" {
695 /// Instructs the encoder to encode or discard the alpha channel of input video frames
696 ///
697 /// This property allows a client to specify whether or not the alpha channel in the source pixelBuffers should be encoded.
698 /// 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.
699 /// This property is not supported by all encoders.
700 ///
701 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_preservealphachannel?language=objc)
702 pub static kVTCompressionPropertyKey_PreserveAlphaChannel: &'static CFString;
703}
704
705extern "C" {
706 /// The maximum frame delay count is the maximum number of frames that
707 /// a compressor is allowed to hold before it must output a compressed
708 /// frame.
709 ///
710 /// It limits the number of frames that may be held in the
711 /// "compression window". If the maximum frame delay count is M, then
712 /// before the call to encode frame N returns, frame N-M must have
713 /// been emitted.
714 /// The default is kVTUnlimitedFrameDelayCount, which sets no limit
715 /// on the compression window.
716 ///
717 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maxframedelaycount?language=objc)
718 pub static kVTCompressionPropertyKey_MaxFrameDelayCount: &'static CFString;
719}
720
721/// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtunlimitedframedelaycount?language=objc)
722pub const kVTUnlimitedFrameDelayCount: c_int = -1;
723
724extern "C" {
725 /// Specifies the maximum slice size for H.264 encoding
726 ///
727 /// If supported by an H.264 encoder, the value limits the size in bytes of
728 /// slices produced by the encoder, where possible.
729 /// By default, no limit is specified. A value of zero implies default behavior.
730 ///
731 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maxh264slicebytes?language=objc)
732 pub static kVTCompressionPropertyKey_MaxH264SliceBytes: &'static CFString;
733}
734
735extern "C" {
736 /// Hints the video encoder that compression is, or is not, being performed in real time.
737 ///
738 /// For offline compression, clients are advised to set this property to kCFBooleanFalse.
739 /// This indicates that the timeline of the frames is not connected to wall-clock time at all.
740 /// This allows the video encoder to run either slower than real-time or faster than real-time,
741 /// depending upon the situation and device capabilities.
742 /// For real-time compression, clients are advised to set this property to kCFBooleanTrue.
743 /// This indicates that the timeline of frames is connected to real time (so, for example,
744 /// the client expects to encode one second of frames each second, on average).
745 /// In such a case, it is important that encoding keep up, but it is also not valuable to encode
746 /// substantially faster than real time.
747 /// When this property is set to kCFBooleanTrue, the video encoder may use the value of the
748 /// kVTCompressionPropertyKey_ExpectedFrameRate property to optimize energy usage,
749 /// by anticipating that encoding requests will happen at this rate.
750 /// By default, this property is NULL, indicating unknown.
751 ///
752 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_realtime?language=objc)
753 pub static kVTCompressionPropertyKey_RealTime: &'static CFString;
754}
755
756extern "C" {
757 /// Hints to the video encoder that it should maximize power efficiency during encode.
758 ///
759 /// For compression where the client is operating in the background, clients may set this property to kCFBooleanTrue, which indicates that
760 /// the encoder can take steps to minimize impact on power usage and other system activity.
761 /// Setting the property to NULL is equivalent to setting it to kCFBooleanFalse.
762 /// Not all video encoders support this property.
763 /// By default, this property is NULL.
764 /// If the kVTCompressionPropertyKey_RealTime property is set to kCFBooleanTrue,
765 /// the video encoder may act as though this property were set to kCFBooleanFalse.
766 ///
767 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maximizepowerefficiency?language=objc)
768 pub static kVTCompressionPropertyKey_MaximizePowerEfficiency: &'static CFString;
769}
770
771extern "C" {
772 /// Indicates the number of source frames, if known.
773 ///
774 /// This property allows a client to give the video encoder advance guidance as to how
775 /// many frames will be encoded.
776 /// If nonzero, this should be the exact number of times that the client calls
777 /// VTCompressionSessionEncodeFrame in each pass.
778 /// The default is 0, which indicates that the number of source frames
779 /// is not known.
780 ///
781 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_sourceframecount?language=objc)
782 pub static kVTCompressionPropertyKey_SourceFrameCount: &'static CFString;
783}
784
785extern "C" {
786 /// Indicates the expected frame rate of the video to be encoded.
787 ///
788 /// The frame rate is measured in frames per second.
789 /// 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.
790 /// The actual frame rate may vary, and will depend on the frame durations calculated by the difference between subsequent presentation time stamps.
791 /// 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.
792 /// 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.
793 /// By default, the property has a value of zero indicating "unknown".
794 ///
795 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_expectedframerate?language=objc)
796 pub static kVTCompressionPropertyKey_ExpectedFrameRate: &'static CFString;
797}
798
799extern "C" {
800 /// Indicates the maximum real time rate at which frames could be submitted to the VTCompressionSession
801 ///
802 /// The frame rate is measured in frames per second.
803 /// 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.
804 /// This property can only be used when kVTCompressionPropertyKey_RealTime has been set to true.
805 /// 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.
806 /// By default, the property has a value of zero indicating "unknown".
807 ///
808 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maximumrealtimeframerate?language=objc)
809 pub static kVTCompressionPropertyKey_MaximumRealTimeFrameRate: &'static CFString;
810}
811
812extern "C" {
813 /// This property indicates the desired frame rate fraction of the base layer.
814 ///
815 /// This property indicates the fraction of total frames submitted that should be encoded in the base layer.
816 /// 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.
817 ///
818 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_baselayerframeratefraction?language=objc)
819 pub static kVTCompressionPropertyKey_BaseLayerFrameRateFraction: &'static CFString;
820}
821
822extern "C" {
823 /// This property indicates the desired bit rate fraction of the base layer
824 ///
825 /// 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.
826 /// 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
827 /// budget of 300kbps and the enhancement layer 200kbps.
828 ///
829 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_baselayerbitratefraction?language=objc)
830 pub static kVTCompressionPropertyKey_BaseLayerBitRateFraction: &'static CFString;
831}
832
833extern "C" {
834 /// Indicates the expected total duration for the compression session, if known.
835 ///
836 /// By default, this is zero, indicating "unknown".
837 ///
838 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_expectedduration?language=objc)
839 pub static kVTCompressionPropertyKey_ExpectedDuration: &'static CFString;
840}
841
842extern "C" {
843 /// This property indicates the desired frame rate for the base temporal layer used in hierarchical video encoding.
844 ///
845 /// The frame rate is measured in frames per second.
846 /// This property is only implemented by encoders which support hierarchical frame encoding, and requests that this encoding feature be enabled.
847 ///
848 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_baselayerframerate?language=objc)
849 pub static kVTCompressionPropertyKey_BaseLayerFrameRate: &'static CFString;
850}
851
852extern "C" {
853 /// The client will be able to control the the maximum allowed ReferenceBufferCount using this optional key.
854 ///
855 /// This is typically used to force the encoder to use lower count than allowed by the stantard for a level/profile.
856 /// The encoder will fail and report an error if the requested value exceeds the limit set by the standard for such a level/profile.
857 ///
858 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_referencebuffercount?language=objc)
859 pub static kVTCompressionPropertyKey_ReferenceBufferCount: &'static CFString;
860}
861
862extern "C" {
863 /// This property requests that the encoder measure and output the Mean Squared Error(MSE) quality metric.
864 ///
865 /// 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.
866 /// If supported, the MSE values will be returned as sample buffer attachments on the encoded frame using the kVTSampleAttachmentKey_QualityMetrics key.
867 ///
868 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_calculatemeansquarederror?language=objc)
869 pub static kVTCompressionPropertyKey_CalculateMeanSquaredError: &'static CFString;
870}
871
872extern "C" {
873 /// The value for this key contain quality-related metadata from the video encoder for a video frame.
874 ///
875 /// The video encoder will attach this via the CMSampleBufferGetSampleAttachmentsArray interface before emitting the sample buffer.
876 ///
877 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtsampleattachmentkey_qualitymetrics?language=objc)
878 pub static kVTSampleAttachmentKey_QualityMetrics: &'static CFString;
879}
880
881extern "C" {
882 /// Key for mean squared error (MSE) of the encoded Luma channel from the video encoder.
883 ///
884 /// For single-view video, a CFNumber value is returned.
885 /// For multi-view video, a CFArray value is returned, and each element (CFNumber) in the CFArray includes MSE for the corresponding view.
886 /// The video encoder will attach this in kVTSampleAttachmentKey_QualityMetrics via the CMSampleBufferGetSampleAttachmentsArray interface before emitting the sample buffer.
887 ///
888 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtsampleattachmentqualitymetricskey_lumameansquarederror?language=objc)
889 pub static kVTSampleAttachmentQualityMetricsKey_LumaMeanSquaredError: &'static CFString;
890}
891
892extern "C" {
893 /// Key for mean squared error (MSE) of the encoded Chroma Blue channel from the video encoder.
894 ///
895 /// For single-view video, a CFNumber value is returned.
896 /// For multi-view video, a CFArray value is returned, and each element (CFNumber) in the CFArray includes MSE for the corresponding view.
897 /// The video encoder will attach this in kVTSampleAttachmentKey_QualityMetrics via the CMSampleBufferGetSampleAttachmentsArray interface before emitting the sample buffer.
898 ///
899 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtsampleattachmentqualitymetricskey_chromabluemeansquarederror?language=objc)
900 pub static kVTSampleAttachmentQualityMetricsKey_ChromaBlueMeanSquaredError: &'static CFString;
901}
902
903extern "C" {
904 /// Key for mean squared error (MSE) of the encoded Chroma Red channel from the video encoder.
905 ///
906 /// For single-view video, a CFNumber value is returned.
907 /// For multi-view video, a CFArray value is returned, and each element (CFNumber) in the CFArray includes MSE for the corresponding view.
908 /// The video encoder will attach this in kVTSampleAttachmentKey_QualityMetrics via the CMSampleBufferGetSampleAttachmentsArray interface before emitting the sample buffer.
909 ///
910 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtsampleattachmentqualitymetricskey_chromaredmeansquarederror?language=objc)
911 pub static kVTSampleAttachmentQualityMetricsKey_ChromaRedMeanSquaredError: &'static CFString;
912}
913
914extern "C" {
915 /// If set to kCFBooleanTrue, use a hardware accelerated video encoder if available. If set to
916 /// kCFBooleanFalse, hardware encode will never be used.
917 ///
918 /// This key is set in the encoderSpecification passed in to VTCompressionSessionCreate. Set it
919 /// to kCFBooleanTrue to allow hardware accelerated encode. To prevent hardware encode,
920 /// this property can be set to kCFBooleanFalse.
921 /// In MacOS 10.15 and later, hardware encode is enabled in VTCompressionSessions by default.
922 ///
923 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtvideoencoderspecification_enablehardwareacceleratedvideoencoder?language=objc)
924 pub static kVTVideoEncoderSpecification_EnableHardwareAcceleratedVideoEncoder:
925 &'static CFString;
926}
927
928extern "C" {
929 /// If set to kCFBooleanTrue, only use hardware encode and return an error if this isn't possible.
930 /// Setting this key automatically implies kVTVideoEncoderSpecification_EnableHardwareAcceleratedVideoEncoder --
931 /// there is no need to set both and the Enable key does nothing if the Require key is set.
932 ///
933 /// This key is set in the encoderSpecification passed in to VTCompressionSessionCreate. Set it
934 /// to kCFBooleanTrue to require hardware accelerated encode. If hardware acceleration is not
935 /// possible, the VTCompressionSessionCreate call will fail.
936 /// This key is useful for clients that have their own software encode implementation or
937 /// those that may want to configure software and hardware encode sessions differently.
938 /// Hardware acceleration may be unavailable for a number of reasons. A few common cases are:
939 /// - the machine does not have hardware acceleration capabilities
940 /// - the requested encoding format or encoding configuration is not supported
941 /// - the hardware encoding resources on the machine are busy
942 ///
943 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtvideoencoderspecification_requirehardwareacceleratedvideoencoder?language=objc)
944 pub static kVTVideoEncoderSpecification_RequireHardwareAcceleratedVideoEncoder:
945 &'static CFString;
946}
947
948extern "C" {
949 /// If set to kCFBooleanTrue, a hardware accelerated video encoder is being used.
950 ///
951 /// You can query this property using VTSessionCopyProperty after you have enabled hardware
952 /// accelerated encode using kVTVideoEncoderSpecification_EnableHardwareAcceleratedVideoEncoder
953 /// to see if a hardware accelerated encoder was selected.
954 ///
955 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_usinghardwareacceleratedvideoencoder?language=objc)
956 pub static kVTCompressionPropertyKey_UsingHardwareAcceleratedVideoEncoder: &'static CFString;
957}
958
959extern "C" {
960 /// If set, the VideoToolbox will only use a hardware encoder running on the GPU specified by the provided GPU registryID.
961 ///
962 /// This specification implies kVTVideoEncoderSpecification_EnableHardwareAcceleratedVideoEncoder. A separate hardware encode opt-in is not required.
963 /// The GPU registryID can be obtained from a MTLDevice using [MTLDevice registryID] or can be obtained from OpenGL or OpenCL.
964 ///
965 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtvideoencoderspecification_requiredencodergpuregistryid?language=objc)
966 pub static kVTVideoEncoderSpecification_RequiredEncoderGPURegistryID: &'static CFString;
967}
968
969extern "C" {
970 /// If set, the VideoToolbox will try to use a hardware encoder running on the GPU specified by the provided GPU registryID. If the
971 /// GPU does not support encode of the specified format, the VideoToolbox will fall back to alternate encoders.
972 ///
973 /// This specification implies kVTVideoEncoderSpecification_EnableHardwareAcceleratedVideoEncoder. A separate hardware encode opt-in is not required.
974 /// If both kVTVideoEncoderSpecification_PreferredEncoderGPURegistryID and kVTVideoEncoderSpecification_RequiredEncoderGPURegistryID are set, kVTVideoEncoderSpecification_PreferredEncoderGPURegistryID will be ignored.
975 /// This specification can be used in conjunction with kVTVideoEncoderSpecification_RequireHardwareAcceleratedVideoEncoder to prevent a fallback to software encode.
976 /// The GPU registryID can be obtained from a MTLDevice using [MTLDevice registryID] or can be obtained from OpenGL or OpenCL.
977 ///
978 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtvideoencoderspecification_preferredencodergpuregistryid?language=objc)
979 pub static kVTVideoEncoderSpecification_PreferredEncoderGPURegistryID: &'static CFString;
980}
981
982extern "C" {
983 /// returns CFNumber indicating the gpu registryID of the encoder that was selected. NULL indicates a built-in encoder or software encode was used.
984 ///
985 /// You can query this property using VTSessionCopyProperty after building a VTCompressionSession to find out which GPU the encoder is using.
986 /// 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
987 ///
988 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_usinggpuregistryid?language=objc)
989 pub static kVTCompressionPropertyKey_UsingGPURegistryID: &'static CFString;
990}
991
992extern "C" {
993 /// This property can be queried to determine if the encoder supports base frame QP requests.
994 ///
995 /// 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.
996 ///
997 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_supportsbaseframeqp?language=objc)
998 pub static kVTCompressionPropertyKey_SupportsBaseFrameQP: &'static CFString;
999}
1000
1001extern "C" {
1002 /// CFBoolean forcing the current frame to be a key frame
1003 ///
1004 /// This value is set in the frameProperties CFDictionary passed to
1005 /// VTCompressionSessionEncodeFrame to force the current frame to be a
1006 /// keyframe or not.
1007 /// Note that it may not be possible for the encoder to accomodate all
1008 /// requests.
1009 ///
1010 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtencodeframeoptionkey_forcekeyframe?language=objc)
1011 pub static kVTEncodeFrameOptionKey_ForceKeyFrame: &'static CFString;
1012}
1013
1014extern "C" {
1015 /// CFNumberRef requesting the current frame to use the provided base frame QP.
1016 ///
1017 /// This value is set in the frameProperties CFDictionary passed to VTCompressionSessionEncodeFrame to force
1018 /// the QP value for the current frame. This is an optional parameter. Use it only when you have a specific requirement
1019 /// for the video quality and you are familiar with frame QP and are prepared to assume full responsibility for rate control.
1020 /// Otherwise it is strongly encouraged to rely on the encoder’s rate control for adjusting frame QP.
1021 ///
1022 /// Setting BaseFrameQP turns off standard rate control and will cause the following properties to be ignored::
1023 /// kVTCompressionPropertyKey_DataRateLimits
1024 /// kVTCompressionPropertyKey_AverageBitRate
1025 /// kVTCompressionPropertyKey_BaseLayerBitRateFraction
1026 /// kVTCompressionPropertyKey_Quality
1027 /// kVTCompressionPropertyKey_MaxAllowedFrameQP
1028 /// kVTCompressionPropertyKey_MinAllowedFrameQP
1029 ///
1030 /// If kVTEncodeFrameOptionKey_BaseFrameQP is used, it must be set for all frames in a session. The QP value specified is
1031 /// frame-level but macro-block level QP may be modulated inside a frame. There will be no rate-control related frame dropping
1032 /// if kVTEncodeFrameOptionKey_BaseFrameQP is used.
1033 ///
1034 /// kVTEncodeFrameOptionKey_BaseFrameQP is only supported if the encoder returns kCFBooleanTrue when the
1035 /// kVTCompressionPropertyKey_SupportsBaseFrameQP is queried. If this FrameOptionKey is set for encoder which
1036 /// does not support it, it will be ignored.
1037 ///
1038 /// Note that it may not be possible for the encoder to accommodate all requests.
1039 ///
1040 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtencodeframeoptionkey_baseframeqp?language=objc)
1041 pub static kVTEncodeFrameOptionKey_BaseFrameQP: &'static CFString;
1042}
1043
1044extern "C" {
1045 /// Describes the clean aperture for encoded frames.
1046 ///
1047 /// Some video encoders may enforce specific clean apertures;
1048 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1049 /// The clean aperture will be set on the format description for output samples,
1050 /// and may affect source frame scaling.
1051 /// NULL is a valid value for this property, meaning that the clean aperture is the full width and height.
1052 ///
1053 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_cleanaperture?language=objc)
1054 pub static kVTCompressionPropertyKey_CleanAperture: &'static CFString;
1055}
1056
1057extern "C" {
1058 /// Describes the pixel aspect ratio for encoded frames.
1059 ///
1060 /// Some video encoders may enforce specific pixel aspect ratios;
1061 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1062 /// The pixel aspect ratio will be set on the format description for output samples,
1063 /// and may affect source frame scaling.
1064 /// NULL is a valid value for this property, meaning square pixels (1:1).
1065 ///
1066 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_pixelaspectratio?language=objc)
1067 pub static kVTCompressionPropertyKey_PixelAspectRatio: &'static CFString;
1068}
1069
1070extern "C" {
1071 /// Indicates whether the frames should be encoded progressive (1) or interlaced (2).
1072 ///
1073 /// The field count will be set on the format description for output samples,
1074 /// and may affect source frame scaling.
1075 /// NULL is a valid value for this property.
1076 ///
1077 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_fieldcount?language=objc)
1078 pub static kVTCompressionPropertyKey_FieldCount: &'static CFString;
1079}
1080
1081extern "C" {
1082 /// Indicates field ordering for encoded interlaced frames.
1083 ///
1084 /// Some video encoders may enforce specific field ordering;
1085 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1086 /// The field detail will be set on the format description for output samples,
1087 /// and may affect source frame scaling.
1088 /// NULL is a valid value for this property.
1089 ///
1090 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_fielddetail?language=objc)
1091 pub static kVTCompressionPropertyKey_FieldDetail: &'static CFString;
1092}
1093
1094extern "C" {
1095 /// Indicates that the DV video stream should have the 16x9 flag set.
1096 ///
1097 /// This property is supported by the DV25/50 family of encoders.
1098 /// When false, the picture aspect ratio is 4:3.
1099 /// When true, the picture aspect ratio is 16:9.
1100 /// Either way, a fixed PixelAspectRatio is used (the specific value depends on whether the format is NTSC or PAL).
1101 ///
1102 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_aspectratio16x9?language=objc)
1103 pub static kVTCompressionPropertyKey_AspectRatio16x9: &'static CFString;
1104}
1105
1106extern "C" {
1107 /// Indicates that the DV video stream should have the progressive flag set.
1108 ///
1109 /// This property is supported by the DV25/50 family of encoders.
1110 /// If false, content is encoded as interlaced.
1111 /// If true, content is encoded as progressive.
1112 /// The value of this property fixes the FieldCount and FieldDetail properties.
1113 ///
1114 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_progressivescan?language=objc)
1115 pub static kVTCompressionPropertyKey_ProgressiveScan: &'static CFString;
1116}
1117
1118extern "C" {
1119 /// Indicates color primaries for compressed content.
1120 ///
1121 /// Some video encoders may enforce specific colorimetry;
1122 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1123 /// The value will be set on the format description for output sample buffers.
1124 ///
1125 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_colorprimaries?language=objc)
1126 pub static kVTCompressionPropertyKey_ColorPrimaries: &'static CFString;
1127}
1128
1129extern "C" {
1130 /// Indicates transfer function for compressed content.
1131 ///
1132 /// Some video encoders may enforce specific colorimetry;
1133 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1134 /// The value will be set on the format description for output sample buffers.
1135 ///
1136 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_transferfunction?language=objc)
1137 pub static kVTCompressionPropertyKey_TransferFunction: &'static CFString;
1138}
1139
1140extern "C" {
1141 /// Indicates YCbCr matrix for compressed content.
1142 ///
1143 /// Some video encoders may enforce specific colorimetry;
1144 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1145 /// The value will be set on the format description for output sample buffers.
1146 ///
1147 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_ycbcrmatrix?language=objc)
1148 pub static kVTCompressionPropertyKey_YCbCrMatrix: &'static CFString;
1149}
1150
1151extern "C" {
1152 /// Indicates ICC profile for compressed content.
1153 ///
1154 /// Some video encoders may enforce specific colorimetry;
1155 /// in those cases this property will be read-only (SetProperty will return kVTPropertyReadOnlyErr).
1156 /// If this property and any of the previous three are all set, they should be set to consistent values,
1157 /// or undefined behavior may occur.
1158 /// The value will be set on the format description for output sample buffers.
1159 /// NULL can be a valid value for this property.
1160 ///
1161 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_iccprofile?language=objc)
1162 pub static kVTCompressionPropertyKey_ICCProfile: &'static CFString;
1163}
1164
1165extern "C" {
1166 /// 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.
1167 ///
1168 /// The value will be set on the format description for output sample buffers,
1169 /// and incorporated into the appropriate SEI NAL unit where supported by the encoder.
1170 ///
1171 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_masteringdisplaycolorvolume?language=objc)
1172 pub static kVTCompressionPropertyKey_MasteringDisplayColorVolume: &'static CFString;
1173}
1174
1175extern "C" {
1176 /// The value is 4 bytes containing a big-endian structure as defined in the Content Light Level Info SEI message.
1177 ///
1178 /// The value will be set on the format description for output sample buffers,
1179 /// and incorporated into the appropriate SEI NAL unit where supported by the encoder.
1180 ///
1181 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_contentlightlevelinfo?language=objc)
1182 pub static kVTCompressionPropertyKey_ContentLightLevelInfo: &'static CFString;
1183}
1184
1185extern "C" {
1186 /// Indicates gamma level for compressed content.
1187 ///
1188 /// 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.
1189 ///
1190 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_gammalevel?language=objc)
1191 pub static kVTCompressionPropertyKey_GammaLevel: &'static CFString;
1192}
1193
1194extern "C" {
1195 /// Specifies whether the source images' RGB values have been premultiplied by the alpha channel values.
1196 ///
1197 /// Video compression will fail if source image buffers have a mismatched value in their kCVImageBufferAlphaChannelMode attachment.
1198 /// If this property is not set, the encoder may read the first source image buffer's kCVImageBufferAlphaChannelMode attachment.
1199 /// If neither the property nor the first buffer's attachment is set, defaults to kVTAlphaChannelMode_PremultipliedAlpha.
1200 ///
1201 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_alphachannelmode?language=objc)
1202 pub static kVTCompressionPropertyKey_AlphaChannelMode: &'static CFString;
1203}
1204
1205extern "C" {
1206 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtalphachannelmode_straightalpha?language=objc)
1207 pub static kVTAlphaChannelMode_StraightAlpha: &'static CFString;
1208}
1209
1210extern "C" {
1211 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtalphachannelmode_premultipliedalpha?language=objc)
1212 pub static kVTAlphaChannelMode_PremultipliedAlpha: &'static CFString;
1213}
1214
1215extern "C" {
1216 /// Specifies properties to configure a VTPixelTransferSession used to transfer source frames
1217 /// from the client's image buffers to the video encoder's image buffers, if necessary.
1218 ///
1219 /// Setting this property alone does not necessarily guarantee that a VTPixelTransferSession will be created.
1220 /// See VTPixelTransferProperties.h.
1221 ///
1222 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_pixeltransferproperties?language=objc)
1223 pub static kVTCompressionPropertyKey_PixelTransferProperties: &'static CFString;
1224}
1225
1226extern "C" {
1227 /// Enables multi-pass compression and provides storage for encoder-private data.
1228 ///
1229 /// 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.
1230 ///
1231 /// 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.
1232 ///
1233 /// 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.
1234 ///
1235 /// 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.
1236 ///
1237 /// 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.
1238 ///
1239 /// You can create and use a VTFrameSilo object to merge sequences of compressed frames across passes during multi-pass encoding.
1240 ///
1241 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_multipassstorage?language=objc)
1242 pub static kVTCompressionPropertyKey_MultiPassStorage: &'static CFString;
1243}
1244
1245extern "C" {
1246 /// Specifies a particular video encoder by its ID string.
1247 ///
1248 /// Matches the value specified in kVTVideoEncoderSpecification_EncoderID, and the kVTVideoEncoderList_EncoderID value returned from VTCopyVideoEncoderList.
1249 ///
1250 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_encoderid?language=objc)
1251 pub static kVTCompressionPropertyKey_EncoderID: &'static CFString;
1252}
1253
1254extern "C" {
1255 /// If supported by the underlying video encoder, returns the recommended number of VTCompressionSessions to instantiate in a parallel encoding configuration.
1256 ///
1257 /// Parallel encoding VTCompressionSessions require the use of the properties kVTCompressionPropertyKey_MoreFramesBeforeStart, kVTCompressionPropertyKey_MoreFramesAfterEnd, and kVTCompressionPropertyKey_SourceFrameCount.
1258 /// e.g. If the property returns 4, a setup for 4 VTCompressionSessions on a 400 frame movie might look like:
1259 /// compressionSession1
1260 /// kVTCompressionPropertyKey_MoreFramesBeforeStart = false
1261 /// kVTCompressionPropertyKey_MoreFramesAfterEnd = true
1262 /// kVTCompressionPropertyKey_SourceFrameCount = 100
1263 /// compressionSession2
1264 /// kVTCompressionPropertyKey_MoreFramesBeforeStart = true
1265 /// kVTCompressionPropertyKey_MoreFramesAfterEnd = true
1266 /// kVTCompressionPropertyKey_SourceFrameCount = 100
1267 /// compressionSession3
1268 /// kVTCompressionPropertyKey_MoreFramesBeforeStart = true
1269 /// kVTCompressionPropertyKey_MoreFramesAfterEnd = true
1270 /// kVTCompressionPropertyKey_SourceFrameCount = 100
1271 /// compressionSession4
1272 /// kVTCompressionPropertyKey_MoreFramesBeforeStart = true
1273 /// kVTCompressionPropertyKey_MoreFramesAfterEnd = false
1274 /// kVTCompressionPropertyKey_SourceFrameCount = 100
1275 ///
1276 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_recommendedparallelizationlimit?language=objc)
1277 pub static kVTCompressionPropertyKey_RecommendedParallelizationLimit: &'static CFString;
1278}
1279
1280extern "C" {
1281 /// If supported by the underlying video encoder, returns the recommended minimum number of video frames for a given subdivision in a parallel encoding configuration.
1282 ///
1283 /// For best results, ensure that the total number of frames of a parallelized subdivision is greater than or equal to this returned value.
1284 /// See also kVTCompressionPropertyKey_RecommendedParallelizationLimit
1285 /// See also kVTCompressionPropertyKey_RecommendedParallelizedSubdivisionMinimumDuration
1286 ///
1287 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_recommendedparallelizedsubdivisionminimumframecount?language=objc)
1288 pub static kVTCompressionPropertyKey_RecommendedParallelizedSubdivisionMinimumFrameCount:
1289 &'static CFString;
1290}
1291
1292extern "C" {
1293 /// If supported by the underlying video encoder, returns the recommended minimum duration for a given subdivision in a parallel encoding configuration.
1294 ///
1295 /// For best results, ensure that the total duration of a parallelized subdivision is greater than or equal to this returned value.
1296 /// See also kVTCompressionPropertyKey_RecommendedParallelizationLimit
1297 /// See also kVTCompressionPropertyKey_RecommendedParallelizedSubdivisionMinimumFrameCount
1298 ///
1299 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_recommendedparallelizedsubdivisionminimumduration?language=objc)
1300 pub static kVTCompressionPropertyKey_RecommendedParallelizedSubdivisionMinimumDuration:
1301 &'static CFString;
1302}
1303
1304extern "C" {
1305 /// Controls whether or not to preserve any dynamic HDR metadata on the input pixel buffer
1306 ///
1307 /// If set to false, and kVTCompressionPropertyKey_HDRMetadataInsertionMode is not
1308 /// kVTHDRMetadataInsertionMode_None, then VTCompressionSession will generate the
1309 /// dynamic HDR metadata for the pixel buffer, if the HDR format is supported.
1310 ///
1311 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_preservedynamichdrmetadata?language=objc)
1312 pub static kVTCompressionPropertyKey_PreserveDynamicHDRMetadata: &'static CFString;
1313}
1314
1315extern "C" {
1316 /// Requires that an encoder which supports low-latency operation be selected, and enables low-latency mode.
1317 ///
1318 /// Low latency RateControl enforces the following behaviors:
1319 /// - Infinite GOP (all P frames following the beginning IDR).
1320 /// - No frame reordering (B frame) or looking ahead.
1321 /// - Only High profiles. Levels are left for the encoder to automatically set.
1322 /// - Temporal Layer structure.
1323 ///
1324 /// Also see:
1325 /// kVTCompressionPropertyKey_AverageBitRate
1326 /// kVTCompressionPropertyKey_BaseLayerFrameRateFraction
1327 /// kVTEncodeFrameOptionKey_ForceKeyFrame
1328 ///
1329 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtvideoencoderspecification_enablelowlatencyratecontrol?language=objc)
1330 pub static kVTVideoEncoderSpecification_EnableLowLatencyRateControl: &'static CFString;
1331}
1332
1333extern "C" {
1334 /// Specifies the maximum allowed encoded frame QP (Quantization Parameter).
1335 ///
1336 /// This is an optional parameter. Use it only when you have a specific requirement for the video quality and you are
1337 /// familiar with frame QP. To satisfy this requirement, the encoder may drop frames to maintain bitrate and QP goals.
1338 /// This is not supported in all encoders or in all encoder operating modes. kVTPropertyNotSupportedErr will be
1339 /// returned when this option is not supported.
1340 ///
1341 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_maxallowedframeqp?language=objc)
1342 pub static kVTCompressionPropertyKey_MaxAllowedFrameQP: &'static CFString;
1343}
1344
1345extern "C" {
1346 /// Specifies the minimum allowed encoded frame QP (Quantization Parameter).
1347 ///
1348 /// This is an optional parameter. Use it only when you have a specific requirement for the video quality and you are
1349 /// familiar with frame QP.
1350 /// This is not supported in all encoders or in all encoder operating modes. kVTPropertyNotSupportedErr will be
1351 /// returned when this option is not supported.
1352 ///
1353 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_minallowedframeqp?language=objc)
1354 pub static kVTCompressionPropertyKey_MinAllowedFrameQP: &'static CFString;
1355}
1356
1357extern "C" {
1358 /// Enable Long Term Reference (LTR) frames during encoding
1359 ///
1360 /// When an LTR frame is encoded, encoder will signal a unique token of the LTR frame in the encoder callback through:
1361 /// kVTSampleAttachmentKey_RequireLTRAcknowledgementToken
1362 /// Clients are responsible for reporting acknowledged LTR frames to the encoder through:
1363 /// kVTEncodeFrameOptionKey_AcknowledgedLTRTokens
1364 /// Client can request a refresh frame at any time through:
1365 /// kVTEncodeFrameOptionKey_ForceLTRRefresh
1366 /// Encoder will encode a P frame by using one of acknowledged LTR frames
1367 /// as the reference. Encoder will encode a new reference frame using an acknowledged LTR, or an IDR if no LTR frames have been acknowledged.
1368 ///
1369 /// Also see:
1370 /// kVTEncodeFrameOptionKey_AcknowledgedLTRTokens
1371 /// kVTEncodeFrameOptionKey_ForceLTRRefresh
1372 /// kVTSampleAttachmentKey_RequireLTRAcknowledgementToken
1373 ///
1374 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_enableltr?language=objc)
1375 pub static kVTCompressionPropertyKey_EnableLTR: &'static CFString;
1376}
1377
1378extern "C" {
1379 /// A CFArray of CFNumbers containing the kVTSampleAttachmentKey_RequireLTRAcknowledgementToken values which have been successfully sent to the receiver and can be used as references
1380 ///
1381 /// When an LTR frame is encoded, the encoder will return a unique token for the LTR frame on the output CMSampleBuffer through kVTSampleAttachmentKey_RequireLTRAcknowledgementToken.
1382 /// This token is then returned to the encoder via kVTEncodeFrameOptionKey_AcknowledgedLTRTokens when the LTR frame is received by the remote consumer(s).
1383 ///
1384 /// Also see:
1385 /// kVTCompressionPropertyKey_EnableLTR
1386 /// kVTEncodeFrameOptionKey_ForceLTRRefresh
1387 /// kVTSampleAttachmentKey_RequireLTRAcknowledgementToken
1388 ///
1389 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtencodeframeoptionkey_acknowledgedltrtokens?language=objc)
1390 pub static kVTEncodeFrameOptionKey_AcknowledgedLTRTokens: &'static CFString;
1391}
1392
1393extern "C" {
1394 /// Set this option to kCFBooleanTrue to force an LTR refresh
1395 ///
1396 /// When the encoder receives this request on an incoming frame, the encoder will encode a new reference frame using a previously
1397 /// acknowledged LTR, or it will encode a new IDR if no LTR frames have been acknowledged.
1398 ///
1399 /// Also see:
1400 /// kVTCompressionPropertyKey_EnableLTR
1401 /// kVTEncodeFrameOptionKey_AcknowledgedLTRTokens
1402 /// kVTSampleAttachmentKey_RequireLTRAcknowledgementToken
1403 ///
1404 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtencodeframeoptionkey_forceltrrefresh?language=objc)
1405 pub static kVTEncodeFrameOptionKey_ForceLTRRefresh: &'static CFString;
1406}
1407
1408extern "C" {
1409 /// CFNumber containing a unique token for this LTR
1410 ///
1411 /// This CMSampleBuffer attachment contains a unique token which can be returned to the encoder through
1412 /// kVTEncodeFrameOptionKey_AcknowledgedLTRTokens to indicate that the LTR has been received and may be used as a reference.
1413 ///
1414 /// Also see:
1415 /// kVTCompressionPropertyKey_EnableLTR
1416 /// kVTEncodeFrameOptionKey_AcknowledgedLTRTokens
1417 /// kVTEncodeFrameOptionKey_ForceLTRRefresh
1418 ///
1419 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtsampleattachmentkey_requireltracknowledgementtoken?language=objc)
1420 pub static kVTSampleAttachmentKey_RequireLTRAcknowledgementToken: &'static CFString;
1421}
1422
1423extern "C" {
1424 /// Requests multi-image encoding; advises encoder to expect CMTaggedBufferGroups with specific CMTags referencing these MV-HEVC VideoLayerIDs.
1425 ///
1426 /// MV-HEVC specific.
1427 /// The property value is a CFArray containing VideoLayerIDs as CFNumbers.
1428 /// The property is NULL by default.
1429 ///
1430 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_mvhevcvideolayerids?language=objc)
1431 pub static kVTCompressionPropertyKey_MVHEVCVideoLayerIDs: &'static CFString;
1432}
1433
1434extern "C" {
1435 /// Specifies the ViewIDs corresponding to the VideoLayerIDs provided via kVTCompressionPropertyKey_MVHEVCVideoLayerIDs.
1436 ///
1437 /// MV-HEVC specific.
1438 /// The property value is a CFArray containing ViewIDs as CFNumbers.
1439 /// The entries in this array should be in the same order and have the same count as the value set via kVTCompressionPropertyKey_MVHEVCVideoLayerIDs.
1440 /// The property is NULL by default.
1441 ///
1442 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_mvhevcviewids?language=objc)
1443 pub static kVTCompressionPropertyKey_MVHEVCViewIDs: &'static CFString;
1444}
1445
1446extern "C" {
1447 /// Specifies which of the ViewIDs provided via kVTCompressionPropertyKey_MVHEVCViewIDs is the "left view id" and which is the "right view id".
1448 ///
1449 /// MV-HEVC specific.
1450 /// These ViewIDs will be incorporated into the 3D Reference Displays Info SEI message.
1451 /// 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.
1452 /// The property is NULL by default.
1453 ///
1454 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_mvhevcleftandrightviewids?language=objc)
1455 pub static kVTCompressionPropertyKey_MVHEVCLeftAndRightViewIDs: &'static CFString;
1456}
1457
1458extern "C" {
1459 /// Specifies the value of kCMFormatDescriptionExtension_HeroEye.
1460 ///
1461 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1462 ///
1463 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_heroeye?language=objc)
1464 pub static kVTCompressionPropertyKey_HeroEye: &'static CFString;
1465}
1466
1467extern "C" {
1468 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtheroeye_left?language=objc)
1469 pub static kVTHeroEye_Left: &'static CFString;
1470}
1471
1472extern "C" {
1473 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtheroeye_right?language=objc)
1474 pub static kVTHeroEye_Right: &'static CFString;
1475}
1476
1477extern "C" {
1478 /// Specifies the value of kCMFormatDescriptionExtension_StereoCameraBaseline.
1479 ///
1480 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1481 ///
1482 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_stereocamerabaseline?language=objc)
1483 pub static kVTCompressionPropertyKey_StereoCameraBaseline: &'static CFString;
1484}
1485
1486extern "C" {
1487 /// Specifies the value of kCMFormatDescriptionExtension_HorizontalDisparityAdjustment.
1488 ///
1489 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1490 ///
1491 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_horizontaldisparityadjustment?language=objc)
1492 pub static kVTCompressionPropertyKey_HorizontalDisparityAdjustment: &'static CFString;
1493}
1494
1495extern "C" {
1496 /// Specifies the value of kCMFormatDescriptionExtension_HasLeftStereoEyeView.
1497 ///
1498 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1499 ///
1500 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_hasleftstereoeyeview?language=objc)
1501 pub static kVTCompressionPropertyKey_HasLeftStereoEyeView: &'static CFString;
1502}
1503
1504extern "C" {
1505 /// Specifies the value of kCMFormatDescriptionExtension_HasRightStereoEyeView.
1506 ///
1507 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1508 ///
1509 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_hasrightstereoeyeview?language=objc)
1510 pub static kVTCompressionPropertyKey_HasRightStereoEyeView: &'static CFString;
1511}
1512
1513extern "C" {
1514 /// Specifies the value of kCMFormatDescriptionExtension_HorizontalFieldOfView.
1515 ///
1516 /// 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).
1517 /// This property is optional and should only be specified if the field of view is known.
1518 ///
1519 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_horizontalfieldofview?language=objc)
1520 pub static kVTCompressionPropertyKey_HorizontalFieldOfView: &'static CFString;
1521}
1522
1523extern "C" {
1524 /// Specifies the value of kCMFormatDescriptionExtension_ProjectionKind.
1525 ///
1526 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1527 ///
1528 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_projectionkind?language=objc)
1529 pub static kVTCompressionPropertyKey_ProjectionKind: &'static CFString;
1530}
1531
1532extern "C" {
1533 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprojectionkind_rectilinear?language=objc)
1534 pub static kVTProjectionKind_Rectilinear: &'static CFString;
1535}
1536
1537extern "C" {
1538 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprojectionkind_equirectangular?language=objc)
1539 pub static kVTProjectionKind_Equirectangular: &'static CFString;
1540}
1541
1542extern "C" {
1543 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprojectionkind_halfequirectangular?language=objc)
1544 pub static kVTProjectionKind_HalfEquirectangular: &'static CFString;
1545}
1546
1547extern "C" {
1548 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtprojectionkind_parametricimmersive?language=objc)
1549 pub static kVTProjectionKind_ParametricImmersive: &'static CFString;
1550}
1551
1552extern "C" {
1553 /// Specifies the value of kCMFormatDescriptionExtension_ViewPackingKind.
1554 ///
1555 /// The value will be set on the format description for output samples and may affect the decoded frame presentation.
1556 ///
1557 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_viewpackingkind?language=objc)
1558 pub static kVTCompressionPropertyKey_ViewPackingKind: &'static CFString;
1559}
1560
1561extern "C" {
1562 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtviewpackingkind_sidebyside?language=objc)
1563 pub static kVTViewPackingKind_SideBySide: &'static CFString;
1564}
1565
1566extern "C" {
1567 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtviewpackingkind_overunder?language=objc)
1568 pub static kVTViewPackingKind_OverUnder: &'static CFString;
1569}
1570
1571extern "C" {
1572 /// Specifies intrinsic and extrinsic parameters for single or multiple lenses.
1573 ///
1574 /// The property value is an array of dictionaries describing the camera calibration data for each lens. The camera calibration data includes intrinsics and extrinics with other parameters.
1575 /// For a stereoscopic camera system, the left and right lens signaling can be done with the kVTCompressionPropertyCameraCalibrationKey_LensRole key and its value.
1576 ///
1577 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_cameracalibrationdatalenscollection?language=objc)
1578 pub static kVTCompressionPropertyKey_CameraCalibrationDataLensCollection: &'static CFString;
1579}
1580
1581extern "C" {
1582 /// The following keys are required in each kVTCompressionPropertyKey_CameraCalibrationDataLensCollection dictionary.
1583 ///
1584 ///
1585 ///
1586 /// Specifies the camera calibration methodology.
1587 ///
1588 /// If the algorithm kind is ParametricLens, the camera lens collection requires camera intrinsic and extrinsic parameters.
1589 ///
1590 ///
1591 ///
1592 /// Specifies the kind of lens (e.g., color).
1593 ///
1594 ///
1595 ///
1596 /// Specifies a unique number associated with a lens.
1597 ///
1598 ///
1599 ///
1600 /// Specifies the particular use of the lens in the camera system (e.g., left or right for a stereo system).
1601 ///
1602 /// For a stereoscopic camera system, one lens should have the left role and another should have the right role.
1603 ///
1604 ///
1605 ///
1606 /// Specifies the first and second radial distortion coefficients(k1 and k2) used to correct the distortion that appeared as curved lines for straight lines and the first and second tangential distortion coefficients(p1 and p2) used to correct the distortion caused by a lens's improper alignment of physical elements.
1607 ///
1608 /// The values are in a CFArray of four CFNumbers in k1, k2, p1 and p2 order.
1609 ///
1610 ///
1611 ///
1612 /// Specifies a three element polynomial for mapping x axis UV parameters with an adjustment using the equation `x' = polynomialX[0] + polynomialX[1]*x + polynomialX[2]*x^3`.
1613 ///
1614 /// The values are in a CFArray of three CFNumbers(float) in the order polynomialX[0], polynomialX[1]
1615 /// &
1616 /// polynomialX[2].
1617 /// The polynomial transform origin is at the center of the frame. The default values of elements of polynomialX[] are [0.0, 1.0, 0.0].
1618 ///
1619 ///
1620 ///
1621 /// Specifies a three element polynomial for mapping y axis UV parameters with an adjustment using the equation `y' = polynomialY[0] + polynomialY[1]*y + polynomialY[2]*y^3`.
1622 ///
1623 /// The values are in a CFArray of three CFNumbers(float) in the order polynomialY[0], polynomialY[1]
1624 /// &
1625 /// polynomialY[2].
1626 /// The polynomial transform origin is at the center of the frame. The default values of elements of polynomialY[] are [0.0, 1.0, 0.0].
1627 ///
1628 ///
1629 ///
1630 /// Specifies the outer limit of the calibration validity in degrees of angle eccentric from the optical axis.
1631 ///
1632 /// The value is linked to radial distortion corrections with k1 and k2.
1633 ///
1634 ///
1635 ///
1636 /// Specifies the 3x3 camera intrinsic matrix for camera calibration.
1637 ///
1638 /// Camera intrinsic matrix is a CFData containing a matrix_float3x3, which is column-major. Each element is in IEEE754 native-endian 32-bit floating point. It has the following contents:
1639 /// fx s cx
1640 /// 0 fy cy
1641 /// 0 0 1
1642 /// fx and fy are the focal length in pixels. For square pixels, they will have the same value.
1643 /// cx and cy are the coordinates of the principal point. The origin is the upper left of the frame.
1644 /// s is an optional skew factor.
1645 ///
1646 ///
1647 ///
1648 /// Specifies the offset of the point of perspective relative to the rectilinear projection.
1649 ///
1650 ///
1651 ///
1652 /// Specifies the image dimensions to which the camera’s intrinsic matrix values are relative.
1653 ///
1654 /// Values are width and height in a CFDictionary. Dictionary keys are compatible with CGSize dictionary, namely "Width" and "Height".
1655 ///
1656 ///
1657 ///
1658 /// Identifies how the origin of the camera system's extrinsics are determined.
1659 ///
1660 /// The 'blin' value indicates the center of transform is determined by the point mid way along the dimensions indicated by the StereoCameraSystemBaselineBox held in the StereoCameraSystemBox.
1661 /// Each left and right lens within a stereoscopic camera system is equidistant from this point, so the 'blin' value is halved when associated with the respective left and right lenses.
1662 ///
1663 ///
1664 ///
1665 /// Specifies a camera’s orientation to a world or scene coordinate system. The orientation value is a unit quaternion(ix, iy, and iz) instead of the classical 3x3 matrix.
1666 ///
1667 /// The values are in a CFArray of three CFNumbers in ix, iy, and iz order.
1668 ///
1669 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_lensalgorithmkind?language=objc)
1670 pub static kVTCompressionPropertyCameraCalibrationKey_LensAlgorithmKind: &'static CFString;
1671}
1672
1673extern "C" {
1674 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcameracalibrationlensalgorithmkind_parametriclens?language=objc)
1675 pub static kVTCameraCalibrationLensAlgorithmKind_ParametricLens: &'static CFString;
1676}
1677
1678extern "C" {
1679 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_lensdomain?language=objc)
1680 pub static kVTCompressionPropertyCameraCalibrationKey_LensDomain: &'static CFString;
1681}
1682
1683extern "C" {
1684 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcameracalibrationlensdomain_color?language=objc)
1685 pub static kVTCameraCalibrationLensDomain_Color: &'static CFString;
1686}
1687
1688extern "C" {
1689 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_lensidentifier?language=objc)
1690 pub static kVTCompressionPropertyCameraCalibrationKey_LensIdentifier: &'static CFString;
1691}
1692
1693extern "C" {
1694 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_lensrole?language=objc)
1695 pub static kVTCompressionPropertyCameraCalibrationKey_LensRole: &'static CFString;
1696}
1697
1698extern "C" {
1699 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcameracalibrationlensrole_mono?language=objc)
1700 pub static kVTCameraCalibrationLensRole_Mono: &'static CFString;
1701}
1702
1703extern "C" {
1704 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcameracalibrationlensrole_left?language=objc)
1705 pub static kVTCameraCalibrationLensRole_Left: &'static CFString;
1706}
1707
1708extern "C" {
1709 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcameracalibrationlensrole_right?language=objc)
1710 pub static kVTCameraCalibrationLensRole_Right: &'static CFString;
1711}
1712
1713extern "C" {
1714 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_lensdistortions?language=objc)
1715 pub static kVTCompressionPropertyCameraCalibrationKey_LensDistortions: &'static CFString;
1716}
1717
1718extern "C" {
1719 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_radialanglelimit?language=objc)
1720 pub static kVTCompressionPropertyCameraCalibrationKey_RadialAngleLimit: &'static CFString;
1721}
1722
1723extern "C" {
1724 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_lensframeadjustmentspolynomialx?language=objc)
1725 pub static kVTCompressionPropertyCameraCalibrationKey_LensFrameAdjustmentsPolynomialX:
1726 &'static CFString;
1727}
1728
1729extern "C" {
1730 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_lensframeadjustmentspolynomialy?language=objc)
1731 pub static kVTCompressionPropertyCameraCalibrationKey_LensFrameAdjustmentsPolynomialY:
1732 &'static CFString;
1733}
1734
1735extern "C" {
1736 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_intrinsicmatrix?language=objc)
1737 pub static kVTCompressionPropertyCameraCalibrationKey_IntrinsicMatrix: &'static CFString;
1738}
1739
1740extern "C" {
1741 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_intrinsicmatrixprojectionoffset?language=objc)
1742 pub static kVTCompressionPropertyCameraCalibrationKey_IntrinsicMatrixProjectionOffset:
1743 &'static CFString;
1744}
1745
1746extern "C" {
1747 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_intrinsicmatrixreferencedimensions?language=objc)
1748 pub static kVTCompressionPropertyCameraCalibrationKey_IntrinsicMatrixReferenceDimensions:
1749 &'static CFString;
1750}
1751
1752extern "C" {
1753 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_extrinsicoriginsource?language=objc)
1754 pub static kVTCompressionPropertyCameraCalibrationKey_ExtrinsicOriginSource: &'static CFString;
1755}
1756
1757extern "C" {
1758 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcameracalibrationextrinsicoriginsource_stereocamerasystembaseline?language=objc)
1759 pub static kVTCameraCalibrationExtrinsicOriginSource_StereoCameraSystemBaseline:
1760 &'static CFString;
1761}
1762
1763extern "C" {
1764 /// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertycameracalibrationkey_extrinsicorientationquaternion?language=objc)
1765 pub static kVTCompressionPropertyCameraCalibrationKey_ExtrinsicOrientationQuaternion:
1766 &'static CFString;
1767}
1768
1769extern "C" {
1770 /// Requests that the encoder retain the specified number of frames during encoding. These frames will be used for additional analysis and statistics
1771 /// gathering before the frame is finally encoded at the end of the window. When this property is not set, video encoder will automatically determine
1772 /// the number of lookahead frames.
1773 ///
1774 /// Encoder will choose number of lookahead frames closer to the suggested value based on internal configuration. This property directly affects latency
1775 /// of the video encoder. The following properties also affect look ahead frames:
1776 /// 1. Value of this property must be less than or equal to `kVTCompressionPropertyKey_MaxFrameDelayCount`.
1777 /// 2. This property is ignored when `VTVideoEncoderSpecification_EnableLowLatencyRateControl` is set to true
1778 /// 3. This property is ignored when `kVTCompressionPropertyKey_Quality` is set to 1.0
1779 /// 4. This property can not be used in conjunction with multi-pass feature (`kVTCompressionPropertyKey_MultiPassStorage`)
1780 ///
1781 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_suggestedlookaheadframecount?language=objc)
1782 pub static kVTCompressionPropertyKey_SuggestedLookAheadFrameCount: &'static CFString;
1783}
1784
1785extern "C" {
1786 /// Control spatial adaptation of the quantization parameter (QP) based on per-frame statistics.
1787 /// If set to kVTQPModulationLevel_Disable, spatial QP adaptation is not applied based on per-frame statistics.
1788 /// 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.
1789 /// QP adaptation is based on spatial characteristics of a frame and the level of spatial QP adaptation is decided internally by the rate controller.
1790 ///
1791 /// This property must be disabled when low latency rate control is enabled. Support for this property is codec dependent.
1792 ///
1793 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_spatialadaptiveqplevel?language=objc)
1794 pub static kVTCompressionPropertyKey_SpatialAdaptiveQPLevel: &'static CFString;
1795}
1796
1797/// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtqpmodulationlevel_default?language=objc)
1798pub const kVTQPModulationLevel_Default: c_int = -1;
1799/// [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtqpmodulationlevel_disable?language=objc)
1800pub const kVTQPModulationLevel_Disable: c_int = 0;
1801
1802extern "C" {
1803 /// Where supported by video encoders, returns a dictionary whose keys are the available compression presets (prefixed by `kVTCompressionPreset_`) and the values are dictionaries containing the corresponding settings property key/value pairs.
1804 ///
1805 /// Clients can select a compression preset for their encoding needs and use its encoder settings to configure the encoder.
1806 /// Clients may also use the encoder settings as a base configuration that they can customize as they require.
1807 ///
1808 /// See also kVTCompressionPreset_HighQuality, kVTCompressionPreset_Balanced, kVTCompressionPreset_HighSpeed, kVTCompressionPreset_VideoConferencing.
1809 ///
1810 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpropertykey_supportedpresetdictionaries?language=objc)
1811 pub static kVTCompressionPropertyKey_SupportedPresetDictionaries: &'static CFString;
1812}
1813
1814extern "C" {
1815 /// A preset to achieve a high compression quality.
1816 ///
1817 /// An encoder configured using this preset is expected to achieve a higher quality with a slower encoding than an encoder configured with the preset kVTCompressionPreset_Balanced or kVTCompressionPreset_HighSpeed.
1818 /// The presets kVTCompressionPreset_Balanced and kVTCompressionPreset_HighSpeed may be preferred for a faster encoding.
1819 ///
1820 /// See also kVTCompressionPreset_Balanced, kVTCompressionPreset_HighSpeed, kVTCompressionPreset_VideoConferencing.
1821 ///
1822 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpreset_highquality?language=objc)
1823 pub static kVTCompressionPreset_HighQuality: &'static CFString;
1824}
1825
1826extern "C" {
1827 /// A preset to provide a balanced compression quality and encoding speed.
1828 ///
1829 /// An encoder configured using this preset is expected to achieve a higher quality than an encoder configured with the preset kVTCompressionPreset_HighSpeed.
1830 /// The preset kVTCompressionPreset_HighSpeed may be preferred for a faster encoding.
1831 /// The preset kVTCompressionPreset_HighQuality may be preferred for a higher compression quality.
1832 ///
1833 /// See also kVTCompressionPreset_HighQuality, kVTCompressionPreset_HighSpeed, kVTCompressionPreset_VideoConferencing.
1834 ///
1835 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpreset_balanced?language=objc)
1836 pub static kVTCompressionPreset_Balanced: &'static CFString;
1837}
1838
1839extern "C" {
1840 /// A preset to provide a high-speed encoding.
1841 ///
1842 /// An encoder configured using this preset is expected to achieve a faster encoding at a lower compression quality than an encoder configured with the preset kVTCompressionPreset_HighQuality or kVTCompressionPreset_Balanced.
1843 /// The presets kVTCompressionPreset_HighQuality and kVTCompressionPreset_Balanced may be preferred for a higher compression quality.
1844 ///
1845 /// See also kVTCompressionPreset_HighQuality, kVTCompressionPreset_Balanced, kVTCompressionPreset_VideoConferencing.
1846 ///
1847 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpreset_highspeed?language=objc)
1848 pub static kVTCompressionPreset_HighSpeed: &'static CFString;
1849}
1850
1851extern "C" {
1852 /// A preset to achieve low-latency encoding for real-time communication applications.
1853 ///
1854 /// This preset requires setting kVTVideoEncoderSpecification_EnableLowLatencyRateControl to kCFBooleanTrue for encoding in the low-latency mode.
1855 ///
1856 /// See also kVTCompressionPreset_HighQuality, kVTCompressionPreset_Balanced, kVTCompressionPreset_HighSpeed.
1857 ///
1858 /// See also [Apple's documentation](https://developer.apple.com/documentation/videotoolbox/kvtcompressionpreset_videoconferencing?language=objc)
1859 pub static kVTCompressionPreset_VideoConferencing: &'static CFString;
1860}