| 1 |
.. SPDX-FileCopyrightText: 2021 Intel Corporation |
| 2 |
.. |
| 3 |
.. SPDX-License-Identifier: CC-BY-4.0 |
| 4 |
|
| 5 |
================================= |
| 6 |
|vpl_short_name| Experimental API |
| 7 |
================================= |
| 8 |
|
| 9 |
All API entries defined under the ONEVPL_EXPERIMENTAL macro are considered as |
| 10 |
experimental. Backward compatibility is not guaranteed for these features. |
| 11 |
Future presence is not guaranteed as well. |
| 12 |
|
| 13 |
By default, experimental API is turned off in the header files. To enable |
| 14 |
it, need to define ONEVPL_EXPERIMENTAL macro during the application |
| 15 |
compilation stage. |
| 16 |
|
| 17 |
The following is a list of experimental interfaces, starting from API version |
| 18 |
2.6. |
| 19 |
|
| 20 |
.. _experimental-api-table: |
| 21 |
|
| 22 |
.. list-table:: Experimental API |
| 23 |
:header-rows: 1 |
| 24 |
:widths: auto |
| 25 |
|
| 26 |
* - **Experimental API** |
| 27 |
- **Added in API Version** |
| 28 |
- **Removed in API Version** |
| 29 |
- **Removal Reason** |
| 30 |
* - :cpp:struct:`mfxExtendedDeviceId` |
| 31 |
- 2.6 |
| 32 |
- 2.10 |
| 33 |
- Moved to production |
| 34 |
* - ``mfxExtCodingOption3::CPUEncToolsProcessing`` |
| 35 |
- 2.6 |
| 36 |
- 2.10 |
| 37 |
- Redundant parameter |
| 38 |
* - :cpp:type:`mfxExtRefListCtrl` |
| 39 |
- 2.6 |
| 40 |
- 2.8 |
| 41 |
- Moved to production |
| 42 |
* - :cpp:enumerator:`MFX_EXTBUFF_UNIVERSAL_REFLIST_CTRL` |
| 43 |
- 2.6 |
| 44 |
- 2.8 |
| 45 |
- Moved to production |
| 46 |
* - Extended enum for :cpp:member:`mfxExtDecodeErrorReport::ErrorTypes` |
| 47 |
- 2.6 |
| 48 |
- 2.7 |
| 49 |
- Moved to production |
| 50 |
* - :cpp:enumerator:`mfxHandleType::MFX_HANDLE_PXP_CONTEXT` |
| 51 |
- 2.6 |
| 52 |
- 2.7 |
| 53 |
- Moved to production |
| 54 |
* - :cpp:struct:`mfxRefInterface` |
| 55 |
- 2.7 |
| 56 |
- 2.10 |
| 57 |
- Moved to production |
| 58 |
* - All definitions in mfxencodestats.h |
| 59 |
- 2.7 |
| 60 |
- |
| 61 |
- |
| 62 |
* - :cpp:enumerator:`MFX_FOURCC_ABGR16F` FourCC definition |
| 63 |
- 2.8 |
| 64 |
- 2.10 |
| 65 |
- Moved to production |
| 66 |
* - :cpp:enumerator:`MFX_CONTENT_NOISY_VIDEO` ContentInfo definition |
| 67 |
- 2.8 |
| 68 |
- 2.10 |
| 69 |
- Moved to production |
| 70 |
* - Camera Processing API for RAW acceleration |
| 71 |
- 2.8 |
| 72 |
- 2.10 |
| 73 |
- Moved to production |
| 74 |
* - Hint to disable external video frames caching for GPU copy |
| 75 |
- 2.8 |
| 76 |
- 2.10 |
| 77 |
- Moved to production |
| 78 |
* - :cpp:member:`mfxExtMBQP::Pitch` |
| 79 |
- 2.8 |
| 80 |
- 2.10 |
| 81 |
- Moved to production |
| 82 |
* - ``mfxExtSyncSubmission`` |
| 83 |
- 2.9 |
| 84 |
- 2.11 |
| 85 |
- Removed from API |
| 86 |
* - :cpp:struct:`mfxExtVPPPercEncPrefilter` |
| 87 |
- 2.9 |
| 88 |
- |
| 89 |
- |
| 90 |
* - :cpp:member:`mfxExtendedDeviceId::RevisionID` |
| 91 |
- 2.9 |
| 92 |
- 2.10 |
| 93 |
- Moved to production |
| 94 |
* - :cpp:struct:`extDeviceUUID` |
| 95 |
- 2.9 |
| 96 |
- 2.10 |
| 97 |
- Moved to production |
| 98 |
* - :cpp:struct:`mfxExtTuneEncodeQuality` |
| 99 |
- 2.9 |
| 100 |
- |
| 101 |
- |
| 102 |
* - ``MFX_ENCODE_TUNE_DEFAULT`` |
| 103 |
- 2.9 |
| 104 |
- 2.10 |
| 105 |
- Changed to :cpp:enumerator:`MFX_ENCODE_TUNE_OFF` |
| 106 |
* - :cpp:enumerator:`MFX_ENCODE_TUNE_PSNR` |
| 107 |
- 2.9 |
| 108 |
- |
| 109 |
- |
| 110 |
* - :cpp:enumerator:`MFX_ENCODE_TUNE_SSIM` |
| 111 |
- 2.9 |
| 112 |
- |
| 113 |
- |
| 114 |
* - :cpp:enumerator:`MFX_ENCODE_TUNE_MS_SSIM` |
| 115 |
- 2.9 |
| 116 |
- |
| 117 |
- |
| 118 |
* - :cpp:enumerator:`MFX_ENCODE_TUNE_VMAF` |
| 119 |
- 2.9 |
| 120 |
- |
| 121 |
- |
| 122 |
* - :cpp:enumerator:`MFX_ENCODE_TUNE_PERCEPTUAL` |
| 123 |
- 2.9 |
| 124 |
- |
| 125 |
- |
| 126 |
* - :cpp:enumerator:`MFX_EXTBUFF_TUNE_ENCODE_QUALITY` |
| 127 |
- 2.9 |
| 128 |
- |
| 129 |
- |
| 130 |
* - ``mfxAutoSelectImplDeviceHandle`` |
| 131 |
- 2.9 |
| 132 |
- 2.11 |
| 133 |
- Removed from API |
| 134 |
* - ``mfxAutoSelectImplType`` |
| 135 |
- 2.9 |
| 136 |
- 2.11 |
| 137 |
- Removed from API |
| 138 |
* - ``mfxAutoSelectImplType::MFX_AUTO_SELECT_IMPL_TYPE_UNKNOWN`` |
| 139 |
- 2.9 |
| 140 |
- 2.11 |
| 141 |
- Removed from API |
| 142 |
* - ``mfxAutoSelectImplType::MFX_AUTO_SELECT_IMPL_TYPE_DEVICE_HANDLE`` |
| 143 |
- 2.9 |
| 144 |
- 2.11 |
| 145 |
- Removed from API |
| 146 |
* - :cpp:enumerator:`MFX_CORRUPTION_HW_RESET` |
| 147 |
- 2.10 |
| 148 |
- |
| 149 |
- |
| 150 |
* - :cpp:enumerator:`MFX_ENCODE_TUNE_OFF` |
| 151 |
- 2.10 |
| 152 |
- |
| 153 |
- |
| 154 |
* - :cpp:struct:`mfxMemoryInterface` |
| 155 |
- 2.10 |
| 156 |
- |
| 157 |
- |
| 158 |
* - :cpp:enumerator:`mfxHandleType::MFX_HANDLE_MEMORY_INTERFACE` |
| 159 |
- 2.10 |
| 160 |
- |
| 161 |
- |
| 162 |
* - :cpp:enum:`mfxSurfaceComponent` |
| 163 |
- 2.10 |
| 164 |
- |
| 165 |
- |
| 166 |
* - :cpp:enum:`mfxSurfaceType` |
| 167 |
- 2.10 |
| 168 |
- |
| 169 |
- |
| 170 |
* - :cpp:struct:`mfxSurfaceHeader` |
| 171 |
- 2.10 |
| 172 |
- |
| 173 |
- |
| 174 |
* - :cpp:struct:`mfxSurfaceInterface` |
| 175 |
- 2.10 |
| 176 |
- |
| 177 |
- |
| 178 |
* - :cpp:struct:`mfxSurfaceD3D11Tex2D` |
| 179 |
- 2.10 |
| 180 |
- |
| 181 |
- |
| 182 |
* - :cpp:struct:`mfxSurfaceVAAPI` |
| 183 |
- 2.10 |
| 184 |
- |
| 185 |
- |
| 186 |
* - :cpp:struct:`mfxSurfaceOpenCLImg2D` |
| 187 |
- 2.10 |
| 188 |
- |
| 189 |
- |
| 190 |
* - :cpp:struct:`mfxExtSurfaceOpenCLImg2DExportDescription` |
| 191 |
- 2.10 |
| 192 |
- |
| 193 |
- |
| 194 |
* - :cpp:enumerator:`mfxImplCapsDeliveryFormat::MFX_IMPLCAPS_SURFACE_TYPES` |
| 195 |
- 2.10 |
| 196 |
- |
| 197 |
- |
| 198 |
* - :cpp:struct:`mfxSurfaceTypesSupported` |
| 199 |
- 2.10 |
| 200 |
- |
| 201 |
- |
| 202 |
* - :cpp:struct:`mfxConfigInterface` |
| 203 |
- 2.10 |
| 204 |
- 2.11 |
| 205 |
- Moved to production |
| 206 |
* - :cpp:enumerator:`mfxHandleType::MFX_HANDLE_CONFIG_INTERFACE` |
| 207 |
- 2.10 |
| 208 |
- 2.11 |
| 209 |
- Moved to production |
| 210 |
* - :cpp:enum:`mfxStructureType` |
| 211 |
- 2.10 |
| 212 |
- 2.11 |
| 213 |
- Moved to production |
| 214 |
* - :cpp:enumerator:`mfxStatus::MFX_ERR_MORE_EXTBUFFER` |
| 215 |
- 2.10 |
| 216 |
- 2.11 |
| 217 |
- Moved to production |
| 218 |
* - :cpp:enum:`mfx3DLutInterpolationMethod` |
| 219 |
- 2.11 |
| 220 |
- |
| 221 |
- |
| 222 |
* - :cpp:struct:`mfxSurfaceD3D12Tex2D` |
| 223 |
- 2.11 |
| 224 |
- |
| 225 |
- |
| 226 |
* - :cpp:struct:`mfxExtSurfaceD3D12Tex2DExportDescription` |
| 227 |
- 2.11 |
| 228 |
- |
| 229 |
- |
| 230 |
* - :cpp:struct:`mfxExtVPPAISuperResolution` |
| 231 |
- 2.11 |
| 232 |
- 2.13 |
| 233 |
- Moved to production |
| 234 |
* - :cpp:enum:`mfxAISuperResolutionMode` |
| 235 |
- 2.11 |
| 236 |
- 2.13 |
| 237 |
- Moved to production |
| 238 |
* - :cpp:struct:`mfxExtQualityInfoMode` |
| 239 |
- 2.11 |
| 240 |
- 2.13 |
| 241 |
- Moved to production |
| 242 |
* - :cpp:struct:`mfxExtQualityInfoOutput` |
| 243 |
- 2.11 |
| 244 |
- 2.13 |
| 245 |
- Moved to production |
| 246 |
* - :cpp:enum:`mfxQualityInfoMode` |
| 247 |
- 2.11 |
| 248 |
- 2.13 |
| 249 |
- Moved to production |
| 250 |
* - :cpp:enumerator:`MFX_GPUCOPY_FAST` |
| 251 |
- 2.11 |
| 252 |
- |
| 253 |
- |
| 254 |
* - :cpp:struct:`mfxExtAV1ScreenContentTools` |
| 255 |
- 2.11 |
| 256 |
- 2.13 |
| 257 |
- Moved to production |
| 258 |
* - :cpp:struct:`mfxExtAlphaChannelEncCtrl` |
| 259 |
- 2.11 |
| 260 |
- 2.13 |
| 261 |
- Moved to production |
| 262 |
* - :cpp:struct:`mfxExtAlphaChannelSurface` |
| 263 |
- 2.11 |
| 264 |
- 2.13 |
| 265 |
- Moved to production |
| 266 |
* - :cpp:struct:`mfxSurfaceVulkanImg2D` |
| 267 |
- 2.12 |
| 268 |
- |
| 269 |
- |
| 270 |
* - :cpp:struct:`mfxExtSurfaceVulkanImg2DExportDescription` |
| 271 |
- 2.12 |
| 272 |
- |
| 273 |
- |
| 274 |
* - :cpp:struct:`mfxExtVPPAIFrameInterpolation` |
| 275 |
- 2.12 |
| 276 |
- 2.13 |
| 277 |
- Moved to production |
| 278 |
* - :cpp:enum:`mfxAIFrameInterpolationMode` |
| 279 |
- 2.12 |
| 280 |
- 2.13 |
| 281 |
- Moved to production |
| 282 |
* - :cpp:enumerator:`MFX_AI_FRAME_INTERPOLATION_MODE_BEST_SPEED` |
| 283 |
- 2.14 |
| 284 |
- |
| 285 |
- |
| 286 |
* - :cpp:enumerator:`MFX_AI_FRAME_INTERPOLATION_MODE_BEST_QUALITY` |
| 287 |
- 2.14 |
| 288 |
- |
| 289 |
- |
| 290 |
* - :cpp:enumerator:`MFX_AI_SUPER_RESOLUTION_MODE_SHARPEN` |
| 291 |
- 2.14 |
| 292 |
- |
| 293 |
- |
| 294 |
* - :cpp:enumerator:`MFX_AI_SUPER_RESOLUTION_MODE_ARTIFACTREMOVAL` |
| 295 |
- 2.14 |
| 296 |
- |
| 297 |
- |
| 298 |
* - :cpp:enum:`mfxAISuperResolutionAlgorithm` |
| 299 |
- 2.14 |
| 300 |
- |
| 301 |
- |
| 302 |
* - :cpp:func:`MFXQueryImplsProperties` |
| 303 |
- 2.15 |
| 304 |
- |
| 305 |
- |
| 306 |
* - :cpp:struct:`mfxQueryProperty` |
| 307 |
- 2.15 |
| 308 |
- |
| 309 |
- |
| 310 |
* - :cpp:enumerator:`mfxVariantType::MFX_VARIANT_TYPE_QUERY` |
| 311 |
- 2.15 |
| 312 |
- |
| 313 |
- |
| 314 |
* - ``mfxEncoderDescription::encoder::ReportedStats`` |
| 315 |
- 2.7 |
| 316 |
- 2.15 |
| 317 |
- Removed from API |
| 318 |
* - :cpp:struct:`mfxDecExtDescription` |
| 319 |
- 2.15 |
| 320 |
- |
| 321 |
- |
| 322 |
* - :cpp:struct:`mfxDecMemExtDescription` |
| 323 |
- 2.15 |
| 324 |
- |
| 325 |
- |
| 326 |
* - :cpp:struct:`mfxEncExtDescription` |
| 327 |
- 2.15 |
| 328 |
- |
| 329 |
- |
| 330 |
* - :cpp:struct:`mfxEncMemExtDescription` |
| 331 |
- 2.15 |
| 332 |
- |
| 333 |
- |
| 334 |
* - :cpp:struct:`mfxExtAIEncCtrl` |
| 335 |
- 2.16 |
| 336 |
- |
| 337 |
- |