Debian Codegraph @

doc/spec/source/appendix/VPL_apnds_a.rst

raw
1 .. SPDX-FileCopyrightText: 2019-2020 Intel Corporation
2 ..
3 .. SPDX-License-Identifier: CC-BY-4.0
4
5 ===================================
6 Configuration Parameter Constraints
7 ===================================
8
9 The :cpp:struct:`mfxFrameInfo` structure is used by both the :cpp:struct:`mfxVideoParam`
10 structure during |vpl_short_name| class initialization and the :cpp:struct:`mfxFrameSurface1`
11 structure during the actual |vpl_short_name| class operation. The parameter constraints
12 described in the following tables apply.
13
14 -----------------------------------
15 DECODE, ENCODE, and VPP Constraints
16 -----------------------------------
17
18 The :ref:`DECODE, ENCODE, and VPP Constraints table <common-constraint-table>`
19 lists parameter constraints common to :term:`DECODE`, :term:`ENCODE`, and
20 :term:`VPP`.
21
22 .. _common-constraint-table:
23
24 .. list-table:: DECODE, ENCODE, and VPP Constraints
25 :header-rows: 1
26 :widths: 20 30 50
27
28 * - **Parameters**
29 - **Use During Initialization**
30 - **Use During Operation**
31 * - FourCC
32 - Any valid value.
33 - The value must be the same as the initialization value. The only exception is :term:`VPP` in composition mode, where in some cases it is allowed to mix RGB and NV12 surfaces. See :cpp:struct:`mfxExtVPPComposite` for more details.
34 * - ChromaFormat
35 - Any valid value.
36 - The value must be the same as the initialization value.
37
38 ------------------
39 DECODE Constraints
40 ------------------
41
42 The :ref:`DECODE Constraints table <decode-constraint-table>` lists :term:`DECODE`
43 parameter constraints.
44
45 .. _decode-constraint-table:
46
47 .. list-table:: DECODE Constraints
48 :header-rows: 1
49 :widths: 20 30 50
50
51 * - **Parameters**
52 - **Use During Initialization**
53 - **Use During Operation**
54 * - Width, Height
55 - Aligned frame size.
56 - The values must be the equal to or larger than the initialization values.
57 * - | CropX, CropY
58 | CropW, CropH
59 - Ignored.
60 - :term:`DECODE` output. The cropping values are per-frame based.
61 * - | AspectRatioW,
62 | AspectRatioH
63 - Any valid values or unspecified (zero); if unspecified, values from the input bitstream will be used. See note below the table.
64 - DECODE output.
65 * - | FrameRateExtN,
66 | FrameRateExtD
67 - If unspecified, values from the input bitstream will be used. See note below the table.
68 - DECODE output.
69 * - PicStruct
70 - Ignored.
71 - DECODE output.
72
73
74 .. note:: If the application explicitly sets FrameRateExtN/FrameRateExtD or
75 AspectRatioW/AspectRatioH during initialization, then the decoder will
76 use these values during decoding regardless of the values from bitstream
77 and does not update them on new SPS. If the application sets them to 0,
78 then the decoder uses values from the stream and updates them on each SPS.
79
80 ------------------
81 ENCODE Constraints
82 ------------------
83
84 The :ref:`ENCODE Constraints table <encode-constraint-table>` lists :term:`ENCODE`
85 parameter constraints.
86
87 .. _encode-constraint-table:
88
89 .. list-table:: ENCODE Constraints
90 :header-rows: 1
91 :widths: 20 40 40
92
93 * - **Parameters**
94 - **Use During Initialization**
95 - **Use During Operation**
96 * - Width, Height
97 - Encoded frame size.
98 - The values must be the equal to or larger than the initialization values.
99 * - | CropX, CropY
100 | CropW, CropH
101 - | H.264: Cropped frame size
102 | MPEG-2: CropW and CropH
103 |
104 | Specify the real width and height (may be unaligned) of the coded frames. CropX and CropY must be zero.
105 - Ignored.
106 * - | AspectRatioW,
107 | AspectRatioH
108 - Any valid values.
109 - Ignored.
110 * - | FrameRateExtN,
111 | FrameRateExtD
112 - Any valid values.
113 - Ignored.
114 * - PicStruct
115 - | :cpp:enumerator:`MFX_PICSTRUCT_UNKNOWN`
116 | :cpp:enumerator:`MFX_PICSTRUCT_PROGRESSIVE`
117 | :cpp:enumerator:`MFX_PICSTRUCT_FIELD_TFF`
118 | :cpp:enumerator:`MFX_PICSTRUCT_FIELD_BFF`
119 - The base value must be the same as the initialization value unless :cpp:enumerator:`MFX_PICSTRUCT_UNKNOWN` is specified during initialization. Add other decorative picture structure flags to indicate additional display attributes. Use :cpp:enumerator:`MFX_PICSTRUCT_UNKNOWN` during initialization for field attributes and :cpp:enumerator:`MFX_PICSTRUCT_PROGRESSIVE` for frame attributes. See the :ref:`PicStruct` enumerator for details.
120
121
122 ---------------
123 VPP Constraints
124 ---------------
125
126 The :ref:`VPP Constraints table <vpp-constraint-table>` lists :term:`VPP`
127 parameter constraints.
128
129 .. _vpp-constraint-table:
130
131 .. list-table:: VPP Constraints
132 :header-rows: 1
133 :widths: 20 40 40
134
135 * - **Parameters**
136 - **During Initialization**
137 - **During Operation**
138 * - Width, Height
139 - Any valid values
140 - The values must be the equal to or larger than the initialization values.
141 * - | CropX, CropY,
142 | CropW, CropH
143 - Ignored
144 - These parameters specify the region of interest from input to output.
145 * - | AspectRatioW,
146 | AspectRatioH
147 - Ignored
148 - Aspect ratio values will be passed through from input to output.
149 * - | FrameRateExtN,
150 | FrameRateExtD
151 - Any valid values
152 - Frame rate values will be updated with the initialization value at output.
153 * - PicStruct
154 - | :cpp:enumerator:`MFX_PICSTRUCT_UNKNOWN`
155 | :cpp:enumerator:`MFX_PICSTRUCT_PROGRESSIVE`
156 | :cpp:enumerator:`MFX_PICSTRUCT_FIELD_TFF`
157 | :cpp:enumerator:`MFX_PICSTRUCT_FIELD_BFF`
158 | :cpp:enumerator:`MFX_PICSTRUCT_FIELD_SINGLE`
159 | :cpp:enumerator:`MFX_PICSTRUCT_FIELD_TOP`
160 | :cpp:enumerator:`MFX_PICSTRUCT_FIELD_BOTTOM`
161 - The base value must be the same as the initialization value unless
162 :cpp:enumerator:`MFX_PICSTRUCT_UNKNOWN` is specified during initialization.
163 Other decorative picture structure flags are passed through or added as
164 needed. See the :ref:`PicStruct` enumerator for details.
165
166 -----------------------------------
167 Specifying Configuration Parameters
168 -----------------------------------
169
170 The following :ref:`Configuration Parameters tables <config-param-table>`
171 summarize how to specify the configuration parameters during initialization,
172 encoding, decoding, and video processing.
173
174 .. _config-param-table:
175
176 .. list-table:: mfxVideoParam Configuration Parameters
177 :header-rows: 1
178 :widths: 15 14 14 14 14 14 15
179
180 * - | **Structure**
181 | **(param)**
182 - | **ENCODE**
183 | **Init**
184 - | **ENCODE**
185 | **Encoding**
186 - | **DECODE**
187 | **Init**
188 - | **DECODE**
189 | **Decoding**
190 - | **VPP**
191 | **Init**
192 - | **VPP**
193 | **Processing**
194 * - Protected
195 - R
196 - -
197 - R
198 - -
199 - R
200 - -
201 * - IOPattern
202 - M
203 - -
204 - M
205 - -
206 - M
207 - -
208 * - ExtParam
209 - O
210 - -
211 - O
212 - -
213 - O
214 - -
215 * - NumExtParam
216 - O
217 - -
218 - O
219 - -
220 - O
221 - -
222
223 .. list-table:: mfxInfoMFX Configuration Parameters
224 :header-rows: 1
225 :widths: 19 14 14 14 14 10 15
226
227 * - | **Structure**
228 | **(param)**
229 - | **ENCODE**
230 | **Init**
231 - | **ENCODE**
232 | **Encoding**
233 - | **DECODE**
234 | **Init**
235 - | **DECODE**
236 | **Decoding**
237 - | **VPP**
238 | **Init**
239 - | **VPP**
240 | **Processing**
241 * - CodecId
242 - M
243 - -
244 - M
245 - -
246 - -
247 - -
248 * - CodecProfile
249 - O
250 - -
251 - O/M\*
252 - -
253 - -
254 - -
255 * - CodecLevel
256 - O
257 - -
258 - O
259 - -
260 - -
261 - -
262 * - NumThread
263 - O
264 - -
265 - O
266 - -
267 - -
268 - -
269 * - TargetUsage
270 - O
271 - -
272 - -
273 - -
274 - -
275 - -
276 * - GopPicSize
277 - O
278 - -
279 - -
280 - -
281 - -
282 - -
283 * - GopRefDist
284 - O
285 - -
286 - -
287 - -
288 - -
289 - -
290 * - GopOptFlag
291 - O
292 - -
293 - -
294 - -
295 - -
296 - -
297 * - IdrInterval
298 - O
299 - -
300 - -
301 - -
302 - -
303 - -
304 * - RateControlMethod
305 - O
306 - -
307 - -
308 - -
309 - -
310 - -
311 * - InitialDelayInKB
312 - O
313 - -
314 - -
315 - -
316 - -
317 - -
318 * - BufferSizeInKB
319 - O
320 - -
321 - -
322 - -
323 - -
324 - -
325 * - TargetKbps
326 - M
327 - -
328 - -
329 - -
330 - -
331 - -
332 * - MaxKbps
333 - O
334 - -
335 - -
336 - -
337 - -
338 - -
339 * - NumSlice
340 - O
341 - -
342 - -
343 - -
344 - -
345 - -
346 * - NumRefFrame
347 - O
348 - -
349 - -
350 - -
351 - -
352 - -
353 * - EncodedOrder
354 - M
355 - -
356 - -
357 - -
358 - -
359 - -
360
361 .. list-table:: mfxFrameInfo Configuration Parameters
362 :header-rows: 1
363 :widths: 19 14 14 14 14 10 15
364
365 * - | **Structure**
366 | **(param)**
367 - | **ENCODE**
368 | **Init**
369 - | **ENCODE**
370 | **Encoding**
371 - | **DECODE**
372 | **Init**
373 - | **DECODE**
374 | **Decoding**
375 - | **VPP**
376 | **Init**
377 - | **VPP**
378 | **Processing**
379 * - FourCC
380 - M
381 - M
382 - M
383 - M
384 - M
385 - M
386 * - Width
387 - M
388 - M
389 - M
390 - M
391 - M
392 - M
393 * - Height
394 - M
395 - M
396 - M
397 - M
398 - M
399 - M
400 * - CropX
401 - M
402 - Ign
403 - Ign
404 - U
405 - Ign
406 - M
407 * - CropY
408 - M
409 - Ign
410 - Ign
411 - U
412 - Ign
413 - M
414 * - CropW
415 - M
416 - Ign
417 - Ign
418 - U
419 - Ign
420 - M
421 * - CropH
422 - M
423 - Ign
424 - Ign
425 - U
426 - Ign
427 - M
428 * - FrameRateExtN
429 - M
430 - Ign
431 - O
432 - U
433 - M
434 - U
435 * - FrameRateExtD
436 - M
437 - Ign
438 - O
439 - U
440 - M
441 - U
442 * - AspectRatioW
443 - O
444 - Ign
445 - O
446 - U
447 - Ign
448 - PT
449 * - AspectRatioH
450 - O
451 - Ign
452 - O
453 - U
454 - Ign
455 - PT
456 * - PicStruct
457 - O
458 - M
459 - Ign
460 - U
461 - M
462 - M/U
463 * - ChromaFormat
464 - M
465 - M
466 - M
467 - M
468 - Ign
469 - Ign
470
471 .. table:: Abbreviations used in configuration parameter tables
472 :widths: auto
473
474 ============ =================
475 Abbreviation Meaning
476 ============ =================
477 Ign Ignored
478 PT Pass Through
479 - Does Not Apply
480 M Mandated
481 R Reserved
482 O Optional
483 U Updated at output
484 ============ =================
485
486
487 .. note:: :ref:`CodecProfile <codec_profile>` is mandated for HEVC REXT and SCC
488 profiles and optional for other cases. If the application does not
489 explicitly set CodecProfile during initialization, the HEVC decoder
490 will use a profile up to Main10.