Debian Codegraph @

doc/spec/source/VPL_change_log.rst

raw
1 .. SPDX-FileCopyrightText: 2021 Intel Corporation
2 ..
3 .. SPDX-License-Identifier: CC-BY-4.0
4
5 ==========
6 Change Log
7 ==========
8
9 This section describes the API evolution from version to version.
10
11 .. contents::
12 :local:
13 :depth: 1
14
15 ------------
16 Version 2.16
17 ------------
18
19 New in this release:
20
21 * Updated the description of FourCC RGB format to clarify the format layout and mapping information:
22
23 * :cpp:enumerator:`MFX_FOURCC_RGB4`
24 * :cpp:enumerator:`MFX_FOURCC_BGR4`
25 * :cpp:enumerator:`MFX_FOURCC_ARGB16`
26 * :cpp:enumerator:`MFX_FOURCC_ABGR16`
27
28 * Experimental API: introduced :cpp:struct:`mfxExtAIEncCtrl` to support control of AI assisted encoder solutions.
29
30 * Updated description of :cpp:struct:`mfxFrameAllocator` to add some critical details for implementation.
31
32 * Updated description of :cpp:func:`MFXQueryImplsDescription`, :cpp:func:`MFXQueryImplsProperties`, and :cpp:func:`MFXReleaseImplDescription` with information on recommended usage.
33
34 ------------
35 Version 2.15
36 ------------
37
38 New in this release:
39
40 * Experimental API: Introduced property-based capabilities query for the implementation description:
41
42 * :cpp:func:`MFXQueryImplsProperties`
43 * :cpp:struct:`mfxQueryProperty`
44 * :cpp:enumerator:`mfxVariantType::MFX_VARIANT_TYPE_QUERY`
45
46 * Updated description of :cpp:func:`MFXReleaseImplDescription` to clarify that it is also used to destroy the handle allocated by :cpp:func:`MFXQueryImplsProperties`.
47
48 * Experimental API: Removed ``mfxEncoderDescription::encoder::ReportedStats``
49
50 * Introduced the description of AsyncDepth for decoder usage.
51
52 * Updated description of :cpp:member:`mfxFrameInfo::Shift` to clarify its valid values and supported settings for codecs.
53
54 * Experimental API: Extended :cpp:struct:`mfxDecoderDescription` to report more capabilities of decoders for the implementation description:
55
56 * :cpp:struct:`mfxDecExtDescription`
57 * :cpp:struct:`mfxDecMemExtDescription`
58
59 * Experimental API: Extended :cpp:struct:`mfxEncoderDescription` to report more capabilities of encoders for the implementation description:
60
61 * :cpp:struct:`mfxEncExtDescription`
62 * :cpp:struct:`mfxEncMemExtDescription`
63
64 * Added VVC profile :cpp:enumerator:`MFX_PROFILE_VVC_MAIN10_STILL_PICTURE` and :cpp:enumerator:`MFX_LEVEL_VVC_63` enums.
65
66 ------------
67 Version 2.14
68 ------------
69
70 New in this release:
71
72 * Added decode HEVC level8.5 (general_level_idc=255) support:
73
74 * :cpp:enumerator:`MFX_LEVEL_HEVC_85`
75
76 * Experimental API: Introduced best quality and best speed mode for AI based video frame interpolation:
77
78 * :cpp:enumerator:`MFX_AI_FRAME_INTERPOLATION_MODE_BEST_SPEED`
79 * :cpp:enumerator:`MFX_AI_FRAME_INTERPOLATION_MODE_BEST_QUALITY`
80
81 * Updated description for decode FrameRate in :cpp:struct:`mfxFrameInfo`
82
83 * Experimental API: Introduced sharpen, artifact removal mode and algorithm setting for AI based super resolution:
84
85 * :cpp:enumerator:`MFX_AI_SUPER_RESOLUTION_MODE_SHARPEN`
86 * :cpp:enumerator:`MFX_AI_SUPER_RESOLUTION_MODE_ARTIFACTREMOVAL`
87 * :cpp:enum:`mfxAISuperResolutionAlgorithm`
88
89 * Made mfxvideo++.h session wrappers explicitly non-copyable:
90
91 * MFXVideoENCODE
92 * MFXVideoDECODE
93 * MFXVideoVPP
94 * MFXVideoDECODE_VPP
95
96 ------------
97 Version 2.13
98 ------------
99
100 New in this release:
101
102 * Moved to production API:
103
104 * :cpp:struct:`mfxExtQualityInfoMode`
105 * :cpp:struct:`mfxExtQualityInfoOutput`
106 * :cpp:enum:`mfxQualityInfoMode`
107 * :cpp:struct:`mfxExtAV1ScreenContentTools`
108 * :cpp:struct:`mfxExtAlphaChannelEncCtrl`
109 * :cpp:struct:`mfxExtAlphaChannelSurface`
110 * :cpp:struct:`mfxExtVPPAISuperResolution`
111 * :cpp:enum:`mfxAISuperResolutionMode`
112 * :cpp:struct:`mfxExtVPPAIFrameInterpolation`
113 * :cpp:enum:`mfxAIFrameInterpolationMode`
114
115 * Added code name for the platform: Battlemage:
116
117 * :cpp:enum:`MFX_DEPRECATED_ENUM_FIELD_INSIDE(MFX_PLATFORM_BATTLEMAGE)`
118
119 ------------
120 Version 2.12
121 ------------
122
123 New in this release:
124
125 * Experimental API: Added new structures and enumerated types for importing and exporting surfaces:
126
127 * :cpp:struct:`mfxSurfaceVulkanImg2D`
128 * :cpp:struct:`mfxExtSurfaceVulkanImg2DExportDescription`
129
130 * Experimental API: introduced :cpp:struct:`mfxExtVPPAIFrameInterpolation` and :cpp:enum:`mfxAIFrameInterpolationMode` for AI powered frame interpolation.
131
132 * Added code names for the platforms: Meteor Lake, Arrow Lake and Lunar Lake:
133
134 * :cpp:enum:`MFX_DEPRECATED_ENUM_FIELD_INSIDE(MFX_PLATFORM_METEORLAKE)`
135 * :cpp:enum:`MFX_DEPRECATED_ENUM_FIELD_INSIDE(MFX_PLATFORM_LUNARLAKE)`
136 * :cpp:enum:`MFX_DEPRECATED_ENUM_FIELD_INSIDE(MFX_PLATFORM_ARROWLAKE)`
137
138 * Added code name for future platforms:
139
140 * :cpp:enum:`MFX_DEPRECATED_ENUM_FIELD_INSIDE(MFX_PLATFORM_MAXIMUM)`
141
142 * Updated description for the function :cpp:func:`MFXVideoCORE_QueryPlatform`.
143
144 ------------
145 Version 2.11
146 ------------
147
148 New in this release:
149
150 * Experimental API: introduced :cpp:struct:`mfxExtAV1ScreenContentTools` to support screen content tools setting for encoder.
151 * Experimental API: introduced :cpp:struct:`mfxExtAlphaChannelEncCtrl` and :cpp:struct:`mfxExtAlphaChannelSurface` for alpha channel encoding.
152 * Experimental API: introduced :cpp:struct:`mfxExtQualityInfoMode`, :cpp:struct:`mfxExtQualityInfoOutput` and :cpp:enum:`mfxQualityInfoMode` to report quality information about encoded picture.
153 * Experimental API: introduced :cpp:struct:`mfxExtVPPAISuperResolution` and :cpp:enum:`mfxAISuperResolutionMode` for AI enhanced video processing filter super resolution.
154 * Experimental API: introduced :cpp:enum:`mfx3DLutInterpolationMethod` to support 3DLUT interpolation method.
155 * Experimental API: Added :cpp:enumerator:`MFX_GPUCOPY_FAST`.
156 * Experimental API: Added new structures and enumerated types for importing and exporting surfaces:
157
158 * :cpp:struct:`mfxSurfaceD3D12Tex2D`
159 * :cpp:struct:`mfxExtSurfaceD3D12Tex2DExportDescription`
160
161 * Supported the extraction of AV1 HDR metadata in the decoder.
162 * Updated description of :cpp:struct:`mfxExtAVCRefListCtrl` to clarify process for querying encoder support.
163 * Clarified the :cpp:member:`mfxExtCodingOption2::MaxQPI`, :cpp:member:`mfxExtCodingOption2::MaxQPP`, :cpp:member:`mfxExtCodingOption2::MaxQPB`, :cpp:member:`mfxExtCodingOption2::MinQPI`, :cpp:member:`mfxExtCodingOption2::MinQPP`, :cpp:member:`mfxExtCodingOption2::MinQPB` for the video encoding usage.
164 * Added VVC decode API.
165 * Update notes on :cpp:member:`mfxInfoMFX::QPI`, :cpp:member:`mfxInfoMFX::QPP`, :cpp:member:`mfxInfoMFX::QPB` to clarify to valid range.
166 * Moved to production API:
167
168 * :cpp:struct:`mfxConfigInterface`
169 * :cpp:enumerator:`mfxHandleType::MFX_HANDLE_CONFIG_INTERFACE`
170 * :cpp:enum:`mfxStructureType`
171 * :cpp:enumerator:`mfxStatus::MFX_ERR_MORE_EXTBUFFER`
172
173 * Experimental API: Removed ``mfxAutoSelectImplDeviceHandle`` and ``mfxAutoSelectImplType``
174 * Experimental API: Removed ``mfxExtSyncSubmission``
175
176 ------------
177 Version 2.10
178 ------------
179
180 New in this release:
181
182 * Experimental API: introduced :cpp:enumerator:`MFX_CORRUPTION_HW_RESET` to support media reset info report.
183 * Changed :cpp:enumerator:`MFX_ENCODE_TUNE_DEFAULT` to :cpp:enumerator:`MFX_ENCODE_TUNE_OFF`.
184 * Experimental API: Removed CPUEncToolsProcessing hint. No need to have explicit parameter. The decision to enable encoding tools will be made according to encoding parameters.
185 * Extended behavior of fused decode plus VPP operation to disable implicit scaling.
186 * Added alias :cpp:type:`mfxExtEncodedFrameInfo` as codec-independent version of :cpp:struct:`mfxExtAVCEncodedFrameInfo`.
187 * Updated description of :cpp:func:`MFXSetConfigFilterProperty` to permit multiple properties per config object.
188 * Fixed 3DLUT buffer size(system memory) in programming guide.
189 * Clarified Region of Interest Parameters Setting for dynamic change.
190 * Removed current working directory from the implementation search path.
191 * Updated argument names and description of MFX_UUID_COMPUTE_DEVICE_ID macro.
192 * Added new header file mfxmemory.h, which is automatically included by mfxvideo.h. Moved the following function declarations from mfxvideo.h to mfxmemory.h
193
194 * :cpp:func:`MFXMemory_GetSurfaceForEncode`
195 * :cpp:func:`MFXMemory_GetSurfaceForDecode`
196 * :cpp:func:`MFXMemory_GetSurfaceForVPP`
197 * :cpp:func:`MFXMemory_GetSurfaceForVPPOut`
198
199 * Experimental API: Introduced new interface for importing and exporting surfaces. Added new function :cpp:member:`mfxFrameSurfaceInterface::Export`. Added new structures and enumerated types:
200
201 * :cpp:struct:`mfxMemoryInterface`
202 * :cpp:enumerator:`mfxHandleType::MFX_HANDLE_MEMORY_INTERFACE`
203 * :cpp:enum:`mfxSurfaceComponent`
204 * :cpp:enum:`mfxSurfaceType`
205 * :cpp:struct:`mfxSurfaceHeader`
206 * :cpp:struct:`mfxSurfaceInterface`
207 * :cpp:struct:`mfxSurfaceD3D11Tex2D`
208 * :cpp:struct:`mfxSurfaceVAAPI`
209 * :cpp:struct:`mfxSurfaceOpenCLImg2D`
210 * :cpp:struct:`mfxExtSurfaceOpenCLImg2DExportDescription`
211
212 * Experimental API: Introduced capabilities query for supported surface import and export operations. Added new structures and enumerated types:
213
214 * :cpp:enumerator:`mfxImplCapsDeliveryFormat::MFX_IMPLCAPS_SURFACE_TYPES`
215 * :cpp:struct:`mfxSurfaceTypesSupported`
216
217 * Experimental API: Introduced new interface for configuring initialization parameters. Added new structures and enumerated types:
218
219 * :cpp:struct:`mfxConfigInterface`
220 * :cpp:enumerator:`mfxHandleType::MFX_HANDLE_CONFIG_INTERFACE`
221 * :cpp:enum:`mfxStructureType`
222 * :cpp:enumerator:`mfxStatus::MFX_ERR_MORE_EXTBUFFER`
223
224 * Experimental API: previously released experimental features were moved to production . See
225 :ref:`experimental-api-table` for more details.
226
227 * Not supported in the encoding of VDEnc or LowPower ON:
228
229 * :cpp:enumerator:`CodecProfile::MFX_PROFILE_AVC_MULTIVIEW_HIGH`
230 * :cpp:enumerator:`CodecProfile::MFX_PROFILE_AVC_STEREO_HIGH`
231
232 -----------
233 Version 2.9
234 -----------
235
236 New in this release:
237
238 * Deprecated :cpp:member:`mfxExtCodingOption2::BitrateLimit`.
239 * Added note that applications must call MFXVideoENCODE_Query() to check for support of :cpp:struct:`mfxExtChromaLocInfo` and :cpp:struct:`mfxExtHEVCRegion` extension buffers.
240 * Added AV1 HDR metadata description and further clarified :cpp:struct:`mfxExtMasteringDisplayColourVolume` and :cpp:struct:`mfxExtContentLightLevelInfo`.
241 * Added deprecation messages to the functions :cpp:func:`MFXQueryAdapters`, :cpp:func:`MFXQueryAdaptersDecode`, and :cpp:func:`MFXQueryAdaptersNumber`.
242 Applications should use the process described in :ref:`vpl-dispatcher` to enumerate and select adapters.
243 * Fixed multiple spelling errors.
244 * Added extension buffer ``mfxExtSyncSubmission`` to return submission synchronization sync point.
245 * Added extension buffer :cpp:struct:`mfxExtVPPPercEncPrefilter` to control perceptual encoding prefilter.
246 * Deprecated :cpp:member:`mfxPlatform::CodeName` and corresponding enum values.
247 * Added :cpp:member:`mfxExtendedDeviceId::RevisionID` and :cpp:struct:`extDeviceUUID` to be aligned across multiple domains including compute and specify device UUID accordingly.
248 * Added extension buffer :cpp:struct:`mfxExtTuneEncodeQuality` and correspondent enumeration to specify encoding tuning option.
249 * Updated description of :cpp:func:`MFXEnumImplementations` to clarify that the input :cpp:type:`mfxImplCapsDeliveryFormat` determines the type of structure returned.
250 * Updated mfxvideo++.h to use MFXLoad API.
251 * Added ``mfxAutoSelectImplDeviceHandle`` and ``mfxAutoSelectImplType`` for automatically selecting a suitable implementation based on application-provided device handle.
252
253
254 -----------
255 Version 2.8
256 -----------
257
258 New in this release:
259
260 * Introduced :cpp:enumerator:`MFX_FOURCC_ABGR16F` FourCC for 16-bit float point (per channel) 4:4:4 ABGR format.
261 * Clarified the :cpp:member:`mfxExtMasteringDisplayColourVolume::DisplayPrimariesX`, :cpp:member:`mfxExtMasteringDisplayColourVolume::DisplayPrimariesY` for the video processing usage.
262 * Added :cpp:enumerator:`MFX_CONTENT_NOISY_VIDEO` in ContentInfo definition.
263 * Added Camera Processing API for Camera RAW data.
264 * Introduced hint to disable external video frames caching for GPU copy.
265 * Clarified usage of :cpp:member:`mfxExtMasteringDisplayColourVolume::InsertPayloadToggle` and
266 :cpp:member:`mfxExtContentLightLevelInfo::InsertPayloadToggle` during decode operations.
267 * Fixed multiple spelling errors.
268 * Experimental API: introduced :cpp:member:`mfxExtMBQP::Pitch` value for QP map defined in :cpp:struct:`mfxExtMBQP`.
269 * Clarified when :cpp:func:`MFXEnumImplementations` may be called for implementation capabilities query.
270 * Added table with filenames included in the dispatcher's search process.
271
272 Bug Fixes:
273
274 * Fixed :ref:`Experimental API table <experimental-api-table>` to note that :cpp:type:`mfxExtRefListCtrl` and :cpp:enumerator:`MFX_EXTBUFF_UNIVERSAL_REFLIST_CTRL` were moved to production in version 2.8.
275
276 -----------
277 Version 2.7
278 -----------
279
280 New in this release:
281
282 * :cpp:member:`mfxExtVppAuxData::RepeatedFrame` flag is actual again and returned back from deprecation state.
283 * Clarified GPUCopy control behavior.
284 * Introduced MFX_FOURCC_XYUV FourCC for non-alpha packed 4:4:4 format.
285 * Notice added to the :cpp:member:`mfxFrameSurfaceInterface::OnComplete` to clarify when
286 library can call this callback.
287 * New product names for platforms:
288
289 * Code name Alder Lake N.
290
291 * Annotated missed aliases :cpp:type:`mfxExtHEVCRefListCtrl`, :cpp:type:`mfxExtHEVCRefLists`, :cpp:type:`mfxExtHEVCTemporalLayers`.
292 * New dispatcher's config properties:
293
294 * Pass through extension buffer to :cpp:struct:`mfxInitializationParam`.
295 * Select host or device responsible for the memory copy between host and device.
296
297 * Refined description of struct `mfxExtMasteringDisplayColourVolume` and `mfxExtContentLightLevelInfo` for HDR SEI decoder usage.
298 * Experimental API: introduced interface to get statistics after encode.
299
300 Bug Fixes:
301
302 * Fixed missprint in the :cpp:struct:`mfxExtDeviceAffinityMask` description.
303 * MFXVideoENCODE_Query description fixed for query mode 1.
304
305 -----------
306 Version 2.6
307 -----------
308
309 New in this release:
310
311 * New development practice to treat some new API features as experimental was introduced.
312 All new experimental API is wrapped with ONE_EXPERIMENTAL macro.
313 * Experimental API: introduced MFX_HANDLE_PXP_CONTEXT to support protected content.
314 * Experimental API: introduced CPUEncToolsProcessing hint to run adaptive encoding tools on CPU.
315 * Experimental API: extended device ID reporting to cover multi-adapter cases.
316 * Experimental API: introduced common alias for mfxExtAVCRefListCtrl
317 * Experimental API: mfxExtDecodeErrorReport ErrorTypes enum extended with new JPEG/MJPEG decode error report.
318 * Clarified LowPower flag meaning.
319 * Described that mfxExtThreadsParam can be attached to mfxInitializationParam during session initialization.
320 * Refined description of the MFXVideoDECODE_VPP_DecodeFrameAsync function.
321 * New dispatcher's config filter property: MediaAdapterType.
322 * Marked all deprecated fields as MFX_DEPRECATED.
323 * Introduced priority loading option for custom libraries.
324 * Clarified AV1 encoder behavior about writing of IVF headers.
325 * Removed outdated note about loading priority of |msdk_full_name|. For loading details see
326 :ref:`vpl_coexistense`.
327 * Spelled out mfxVariant type usage for strings.
328 * New product names for platforms:
329
330 * Code name DG2,
331 * Code name ATS-M.
332
333 -----------
334 Version 2.5
335 -----------
336
337 New in this release:
338
339 * Added mfxMediaAdapterType to capability reporting.
340 * Added surface pool interface.
341 * Helper macro definition to simplify filter properties set up process
342 for dispatcher.
343 * Added mfxExtAV1BitstreamParam, mfxExtAV1ResolutionParam and mfxExtAV1TileParam for AV1e.
344 * Added MFX_RESOURCE_VA_SURFACE_PTR and MFX_RESOURCE_VA_BUFFER_PTR enumerators.
345 * Clarified HEVC Main 10 Still Picture Profile configuration.
346 * External Buffer ID of mfxExtVideoSignalInfo and mfxExtMasteringDisplayColourVolume for video processing.
347 * New MFX_WRN_ALLOC_TIMEOUT_EXPIRED return status. Indicates that all surfaces are currently
348 in use and timeout set by mfxExtAllocationHints for allocation of new surfaces through
349 functions GetSurfaceForXXX expired.
350 * Introduced universal temporal layering structure.
351 * Added MFX_RESOURCE_VA_SURFACE_PTR and MFX_RESOURCE_VA_BUFFER_PTR enumerators.
352 * Introduced segmentation interface for AV1e, including ext-buffers and enums.
353 * Introduced planar I422 and I210 FourCC codes.
354
355 Bug Fixes:
356
357 * Dispatcher: Removed /etc/ld.so.cache from |vpl_short_name| search order.
358 * mfxSurfaceArray: CDECL attribute added to the member-functions.
359
360 Deprecated:
361
362 * mfxExtVPPDenoise extension buffer.
363
364
365 -----------
366 Version 2.4
367 -----------
368
369 * Added ability to retrieve path to the shared library with the implementation.
370 * Added 3DLUT (Three-Dimensional Look Up Table) filter in VPP.
371 * Added mfxGUID structure to specify Globally Unique Identifiers (GUIDs).
372 * Added QueryInterface function to mfxFrameSurfaceInterface.
373 * Added AdaptiveRef and alias for ExtBrcAdaptiveLTR.
374 * Added MFX_FOURCC_BGRP FourCC for Planar BGR format.
375 * Environmental variables to control dispatcher's logger.
376
377 -----------
378 Version 2.3
379 -----------
380
381 * Encoding in Hyper mode.
382 * New product names for platforms:
383
384 * Code name Rocket Lake,
385 * Code name Alder Lake S,
386 * Code name Alder Lake P,
387 * Code name for Arctic Sound P.
388 * For spec version 2.3.1 MFX_PLATFORM_XEHP_SDV alias was added
389
390 * mfx.h header file is added which includes all header files.
391 * Added deprecation messages (deprecation macro) to the functions MFXInit and
392 MFXInitEx functions definition.