Debian Codegraph @

doc/spec/source/VPL_intel_media_sdk.rst

raw
1 .. SPDX-FileCopyrightText: 2019-2020 Intel Corporation
2 ..
3 .. SPDX-License-Identifier: CC-BY-4.0
4
5 ===========================================
6 |vpl_short_name| for |msdk_full_name| Users
7 ===========================================
8
9 |vpl_short_name| is source compatible with |msdk_full_name|. Applications can use
10 |msdk_full_name| to target older hardware and |vpl_short_name| to target everything else.
11 Some obsolete features of |msdk_full_name| have been omitted from |vpl_short_name|.
12 Hereinafter the term "Legacy" will be used to describe a behavior when |vpl_short_name|
13 is called by |msdk_full_name| applications.
14
15 -----------------------------------------
16 |vpl_short_name| Ease of Use Enhancements
17 -----------------------------------------
18
19 |vpl_short_name| provides improved ease of use compared to |msdk_full_name|. Ease of use
20 enhancements include the following:
21
22 - Smart dispatcher with discovery of implementation capabilities. See
23 :ref:`sdk-session` for more details.
24 - Simplified decoder initialization. See :ref:`decoding-proc` for more
25 details.
26 - New memory management and components (session) interoperability. See
27 :ref:`internal-mem-manage` and :ref:`decoding-proc` for more details.
28
29 .. _new-api:
30
31 ----------------------------
32 New APIs in |vpl_short_name|
33 ----------------------------
34
35 |vpl_short_name| introduces new functions that are not available in |msdk_full_name|.
36
37 .. _dispatcher-api:
38
39 New |vpl_short_name| dispatcher functions:
40
41 - :cpp:func:`MFXLoad`
42 - :cpp:func:`MFXUnload`
43 - :cpp:func:`MFXCreateConfig`
44 - :cpp:func:`MFXSetConfigFilterProperty`
45 - :cpp:func:`MFXEnumImplementations`
46 - :cpp:func:`MFXCreateSession`
47 - :cpp:func:`MFXDispReleaseImplDescription`
48
49 New |vpl_short_name| memory management functions:
50
51 - :cpp:func:`MFXMemory_GetSurfaceForVPP`
52 - :cpp:func:`MFXMemory_GetSurfaceForVPPOut`
53 - :cpp:func:`MFXMemory_GetSurfaceForEncode`
54 - :cpp:func:`MFXMemory_GetSurfaceForDecode`
55
56 New |vpl_short_name| implementation capabilities retrieval functions:
57
58 - :cpp:func:`MFXQueryImplsDescription`
59 - :cpp:func:`MFXReleaseImplDescription`
60
61 New |vpl_short_name| session initialization:
62
63 - :cpp:func:`MFXInitialize`
64
65 ---------------------------------
66 |msdk_full_name| Feature Removals
67 ---------------------------------
68
69 The following |msdk_full_name| features are considered obsolete and are not
70 included in |vpl_short_name|:
71
72 - **Audio support.** |vpl_short_name| is intended for video processing. Audio APIs that
73 duplicate functionality from other audio libraries such as
74 `Sound Open Firmware <https://github.com/thesofproject>`__ have been removed.
75
76 - **ENC and PAK interfaces.** Part of the Flexible Encode Infrastructure (FEI)
77 and plugin interfaces which provide additional control over the encoding
78 process for AVC and HEVC encoders. This feature was removed because it is not
79 widely used by customers.
80
81 - **User plugins architecture.** |vpl_short_name| enables robust video acceleration through
82 API implementations of many different video processing frameworks. Support of
83 a |msdk_full_name| user plugin framework is obsolete. |msdk_full_name| RAW acceleration (Camera API)
84 which is implemented as plugin is also obsolete, |vpl_short_name| enables RAW acceleration (Camera
85 API) through |vpl_short_name| runtime such as |vpl_short_name| GPU runtime.
86
87 - **External buffer memory management.** A set of callback functions to replace
88 internal memory allocation is obsolete.
89
90 - **Video Processing extended runtime functionality.** Video processing function
91 MFXVideoVPP_RunFrameVPPAsyncEx is used for plugins only and is obsolete.
92
93 - **External threading.** The new threading model makes the MFXDoWork function
94 obsolete.
95
96 - **Multi-frame encode.** A set of external buffers to combine several frames
97 into one encoding call. This feature was removed because it is device specific
98 and not commonly used.
99
100 - **Surface Type Neutral Transcoding.** Opaque memory support is removed and
101 replaced with internal memory allocation concept.
102
103 - **Raw Acceleration.** |msdk_full_name| RAW acceleration (Camera API) which is
104 implemented as plugin is obsolete, replaced by |vpl_short_name| and |vpl_short_name| runtime implementation.
105 |vpl_short_name| reused most of |msdk_full_name| Camera API, but |vpl_short_name| camera API is not backward
106 compatible with |msdk_full_name| camera API due to obsolete plugin mechanism in |vpl_short_name|
107 and a few difference between |vpl_short_name| and |msdk_full_name|. The major difference between |vpl_short_name|
108 and |msdk_full_name| are listed:
109 1) mfxCamGammaParam and mfxExtCamGammaCorrection are removed in |vpl_short_name|; 2) Added
110 reserved bytes in mfxExtCamHotPixelRemoval, mfxCamVignetteCorrectionParam and
111 mfxCamVignetteCorrectionElement for future extension; 3) Changed CCM from mfxF64
112 to mfxF32 in mfxExtCamColorCorrection3x3 and added more reserved bytes.
113
114 .. _deprecated-api:
115
116 -----------------------------
117 |msdk_full_name| API Removals
118 -----------------------------
119
120 The following |msdk_full_name| functions are not included in |vpl_short_name|:
121
122 - **Audio related functions**
123
124 - MFXAudioCORE_SyncOperation()
125 - MFXAudioDECODE_Close()
126 - MFXAudioDECODE_DecodeFrameAsync()
127 - MFXAudioDECODE_DecodeHeader()
128 - MFXAudioDECODE_GetAudioParam()
129 - MFXAudioDECODE_Init()
130 - MFXAudioDECODE_Query()
131 - MFXAudioDECODE_QueryIOSize()
132 - MFXAudioDECODE_Reset()
133 - MFXAudioENCODE_Close()
134 - MFXAudioENCODE_EncodeFrameAsync()
135 - MFXAudioENCODE_GetAudioParam()
136 - MFXAudioENCODE_Init()
137 - MFXAudioENCODE_Query()
138 - MFXAudioENCODE_QueryIOSize()
139 - MFXAudioENCODE_Reset()
140
141 - **Flexible encode infrastructure functions**
142
143 - MFXVideoENC_Close()
144 - MFXVideoENC_GetVideoParam()
145 - MFXVideoENC_Init()
146 - MFXVideoENC_ProcessFrameAsync()
147 - MFXVideoENC_Query()
148 - MFXVideoENC_QueryIOSurf()
149 - MFXVideoENC_Reset()
150 - MFXVideoPAK_Close()
151 - MFXVideoPAK_GetVideoParam()
152 - MFXVideoPAK_Init()
153 - MFXVideoPAK_ProcessFrameAsync()
154 - MFXVideoPAK_Query()
155 - MFXVideoPAK_QueryIOSurf()
156 - MFXVideoPAK_Reset()
157
158 - **User plugin functions**
159
160 - MFXAudioUSER_ProcessFrameAsync()
161 - MFXAudioUSER_Register()
162 - MFXAudioUSER_Unregister()
163 - MFXVideoUSER_GetPlugin()
164 - MFXVideoUSER_ProcessFrameAsync()
165 - MFXVideoUSER_Register()
166 - MFXVideoUSER_Unregister()
167 - MFXVideoUSER_Load()
168 - MFXVideoUSER_LoadByPath()
169 - MFXVideoUSER_UnLoad()
170 - MFXDoWork()
171
172 - **Memory functions**
173
174 - MFXVideoCORE_SetBufferAllocator()
175
176 - **Video processing functions**
177
178 - MFXVideoVPP_RunFrameVPPAsyncEx()
179
180 - **Memory type and IOPattern enumerations**
181
182 - MFX_IOPATTERN_IN_OPAQUE_MEMORY
183 - MFX_IOPATTERN_OUT_OPAQUE_MEMORY
184 - MFX_MEMTYPE_OPAQUE_FRAME
185
186 .. important:: Corresponding extension buffers are also removed.
187
188 The following behaviors occur when attempting to use a |msdk_full_name| API that
189 is not supported by |vpl_short_name|:
190
191 - Code compiled with the |vpl_short_name| API headers will generate a compile and/or
192 link error when attempting to use a removed API.
193
194 - Code previously compiled with |msdk_full_name| and executed using a |vpl_short_name|
195 runtime will generate an :cpp:enumerator:`MFX_ERR_NOT_IMPLEMENTED` error when
196 calling a removed function.
197
198 ---------------------------
199 |msdk_full_name| Legacy API
200 ---------------------------
201
202 |vpl_short_name| contains following header files from |msdk_full_name| included for the
203 simplification of existing applications migration to |vpl_short_name|:
204
205 - mfxvideo++.h
206
207 .. important:: |msdk_full_name| obsolete API removed from those header files.
208 Code compiled with the |vpl_short_name| API headers will generate a compile and/or
209 link error when attempting to use a removed API.