Skip to content

Commit

Permalink
Publish API v2.12
Browse files Browse the repository at this point in the history
  • Loading branch information
mav-intel committed Jun 28, 2024
1 parent 1e760b5 commit 20a2d92
Show file tree
Hide file tree
Showing 231 changed files with 78,617 additions and 44 deletions.
5 changes: 3 additions & 2 deletions latest/API_ref/VPL_disp_api_enum.html
Original file line number Diff line number Diff line change
Expand Up @@ -439,12 +439,13 @@ <h3><a class="toc-backref" href="#id1" role="doc-backlink">mfxAccelerationMode</
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N19mfxAccelerationMode28MFX_ACCEL_MODE_VIA_VAAPI_GLXE">
<span id="_CPPv3N19mfxAccelerationMode28MFX_ACCEL_MODE_VIA_VAAPI_GLXE"></span><span id="_CPPv2N19mfxAccelerationMode28MFX_ACCEL_MODE_VIA_VAAPI_GLXE"></span><span class="target" id="mfxcommon_8h_1aae47fab6a9bb988df3b4f8865a128460a60fbe1e1e926d8a7e5bce29695605f87"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MFX_ACCEL_MODE_VIA_VAAPI_GLX</span></span></span><a class="headerlink" href="#_CPPv4N19mfxAccelerationMode28MFX_ACCEL_MODE_VIA_VAAPI_GLXE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>
<dd><p>Hardware acceleration goes through the Linux* VA-API infrastructure with OpenGL Extension to the X Window System as default acceleration access point. </p>
</dd></dl>

<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N19mfxAccelerationMode28MFX_ACCEL_MODE_VIA_VAAPI_X11E">
<span id="_CPPv3N19mfxAccelerationMode28MFX_ACCEL_MODE_VIA_VAAPI_X11E"></span><span id="_CPPv2N19mfxAccelerationMode28MFX_ACCEL_MODE_VIA_VAAPI_X11E"></span><span class="target" id="mfxcommon_8h_1aae47fab6a9bb988df3b4f8865a128460a2ba68c507fd1c82d8fbb72714ee8619d"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MFX_ACCEL_MODE_VIA_VAAPI_X11</span></span></span><a class="headerlink" href="#_CPPv4N19mfxAccelerationMode28MFX_ACCEL_MODE_VIA_VAAPI_X11E" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Hardware acceleration goes through the Linux* VA-API infrastructure with OpenGL Extension to the X Window System as default acceleration access point. Hardware acceleration goes through the Linux* VA-API infrastructure with X11 as default acceleration access point. </p>
<dd><p>Hardware acceleration goes through the Linux* VA-API infrastructure with X11 as default acceleration access point. </p>
</dd></dl>

<dl class="cpp enumerator">
Expand Down
29 changes: 29 additions & 0 deletions latest/API_ref/VPL_enums.html
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,7 @@ <h2> Contents </h2>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mfxsurfacetype">mfxSurfaceType</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mfxstructuretype">mfxStructureType</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mfxaisuperresolutionmode">mfxAISuperResolutionMode</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mfxaiframeinterpolationmode">mfxAIFrameInterpolationMode</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mfxqualityinfomode">mfxQualityInfoMode</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#alphachannelmode">AlphaChannelMode</a></li>
</ul>
Expand Down Expand Up @@ -5468,6 +5469,12 @@ <h2>mfxSurfaceType<a class="headerlink" href="#mfxsurfacetype" title="Permalink
<dd><p>D3D12 surface of type ID3D12Resource with 2D texture type. </p>
</dd></dl>

<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N14mfxSurfaceType29MFX_SURFACE_TYPE_VULKAN_IMG2DE">
<span id="_CPPv3N14mfxSurfaceType29MFX_SURFACE_TYPE_VULKAN_IMG2DE"></span><span id="_CPPv2N14mfxSurfaceType29MFX_SURFACE_TYPE_VULKAN_IMG2DE"></span><span class="target" id="mfxstructures_8h_1abef1692594df881f5950ffcea918ac10ab23f1350d8d631d24ab1109300b99597"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MFX_SURFACE_TYPE_VULKAN_IMG2D</span></span></span><a class="headerlink" href="#_CPPv4N14mfxSurfaceType29MFX_SURFACE_TYPE_VULKAN_IMG2DE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Vulkan 2D image (VkImage). </p>
</dd></dl>

</dd></dl>

</section>
Expand Down Expand Up @@ -5514,6 +5521,27 @@ <h2>mfxAISuperResolutionMode<a class="headerlink" href="#mfxaisuperresolutionmod

</dd></dl>

</section>
<section id="mfxaiframeinterpolationmode">
<h2>mfxAIFrameInterpolationMode<a class="headerlink" href="#mfxaiframeinterpolationmode" title="Permalink to this heading">#</a></h2>
<dl class="cpp enum">
<dt class="sig sig-object cpp" id="_CPPv427mfxAIFrameInterpolationMode">
<span id="_CPPv327mfxAIFrameInterpolationMode"></span><span id="_CPPv227mfxAIFrameInterpolationMode"></span><span class="target" id="mfxstructures_8h_1a99465f74c5fec6b5d38a8787556045c9"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">mfxAIFrameInterpolationMode</span></span></span><a class="headerlink" href="#_CPPv427mfxAIFrameInterpolationMode" title="Permalink to this definition">#</a><br /></dt>
<dd><p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N27mfxAIFrameInterpolationMode39MFX_AI_FRAME_INTERPOLATION_MODE_DISABLEE">
<span id="_CPPv3N27mfxAIFrameInterpolationMode39MFX_AI_FRAME_INTERPOLATION_MODE_DISABLEE"></span><span id="_CPPv2N27mfxAIFrameInterpolationMode39MFX_AI_FRAME_INTERPOLATION_MODE_DISABLEE"></span><span class="target" id="mfxstructures_8h_1a99465f74c5fec6b5d38a8787556045c9adf02e3a61c9600068dc6eac94cbaef2a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MFX_AI_FRAME_INTERPOLATION_MODE_DISABLE</span></span></span><a class="headerlink" href="#_CPPv4N27mfxAIFrameInterpolationMode39MFX_AI_FRAME_INTERPOLATION_MODE_DISABLEE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>AI based frame interpolation is disabled. The library duplicates the frame if AI frame interpolation is disabled. </p>
</dd></dl>

<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N27mfxAIFrameInterpolationMode39MFX_AI_FRAME_INTERPOLATION_MODE_DEFAULTE">
<span id="_CPPv3N27mfxAIFrameInterpolationMode39MFX_AI_FRAME_INTERPOLATION_MODE_DEFAULTE"></span><span id="_CPPv2N27mfxAIFrameInterpolationMode39MFX_AI_FRAME_INTERPOLATION_MODE_DEFAULTE"></span><span class="target" id="mfxstructures_8h_1a99465f74c5fec6b5d38a8787556045c9a2ea481661c48c9b7f8df992481d4fe90"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MFX_AI_FRAME_INTERPOLATION_MODE_DEFAULT</span></span></span><a class="headerlink" href="#_CPPv4N27mfxAIFrameInterpolationMode39MFX_AI_FRAME_INTERPOLATION_MODE_DEFAULTE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Default AI based frame interpolation mode. The library selects the most appropriate AI based frame interpolation mode. </p>
</dd></dl>

</dd></dl>

</section>
<section id="mfxqualityinfomode">
<h2>mfxQualityInfoMode<a class="headerlink" href="#mfxqualityinfomode" title="Permalink to this heading">#</a></h2>
Expand Down Expand Up @@ -5722,6 +5750,7 @@ <h2>AlphaChannelMode<a class="headerlink" href="#alphachannelmode" title="Permal
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mfxsurfacetype">mfxSurfaceType</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mfxstructuretype">mfxStructureType</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mfxaisuperresolutionmode">mfxAISuperResolutionMode</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mfxaiframeinterpolationmode">mfxAIFrameInterpolationMode</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mfxqualityinfomode">mfxQualityInfoMode</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#alphachannelmode">AlphaChannelMode</a></li>
</ul>
Expand Down
10 changes: 2 additions & 8 deletions latest/API_ref/VPL_func_vid_decode_vpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -406,11 +406,7 @@ <h3><a class="toc-backref" href="#id1" role="doc-backlink">MFXVideoDECODE_VPP_In
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv423MFXVideoDECODE_VPP_Init10mfxSessionP13mfxVideoParamPP20mfxVideoChannelParam6mfxU32">
<span id="_CPPv323MFXVideoDECODE_VPP_Init10mfxSessionP13mfxVideoParamPP20mfxVideoChannelParam6mfxU32"></span><span id="_CPPv223MFXVideoDECODE_VPP_Init10mfxSessionP13mfxVideoParamPP20mfxVideoChannelParam6mfxU32"></span><span id="MFXVideoDECODE_VPP_Init__mfxSession.mfxVideoParamP.mfxVideoChannelParamPP.mfxU32"></span><span class="target" id="mfxvideo_8h_1af0880a14dea025021875050231f96caf"></span><a class="reference internal" href="VPL_enums.html#_CPPv49mfxStatus" title="mfxStatus"><span class="n"><span class="pre">mfxStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MFXVideoDECODE_VPP_Init</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="VPL_ref_types.html#_CPPv410mfxSession" title="mfxSession"><span class="n"><span class="pre">mfxSession</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">session</span></span>, <a class="reference internal" href="VPL_structs_cross_component.html#_CPPv413mfxVideoParam" title="mfxVideoParam"><span class="n"><span class="pre">mfxVideoParam</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">decode_par</span></span>, <a class="reference internal" href="VPL_structs_decode_vpp.html#_CPPv420mfxVideoChannelParam" title="mfxVideoChannelParam"><span class="n"><span class="pre">mfxVideoChannelParam</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">vpp_par_array</span></span>, <a class="reference internal" href="VPL_ref_types.html#_CPPv46mfxU32" title="mfxU32"><span class="n"><span class="pre">mfxU32</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">num_vpp_par</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423MFXVideoDECODE_VPP_Init10mfxSessionP13mfxVideoParamPP20mfxVideoChannelParam6mfxU32" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Initialize the SDK in (decode + vpp) mode. The logic of this function is similar to MFXVideoDECODE_Init, but application has to provide array of pointers to <a class="reference internal" href="VPL_structs_decode_vpp.html#structmfx_video_channel_param"><span class="std std-ref">mfxVideoChannelParam</span></a><p>and num_channel_param - number of channels. Application is responsible for</p>
<p>memory allocation for</p>
<a class="reference internal" href="VPL_structs_decode_vpp.html#structmfx_video_channel_param"><span class="std std-ref">mfxVideoChannelParam</span></a><p>parameters and for each channel it should specify channel IDs:</p>
<p>mfxVideoChannelParam::mfxFrameInfo::ChannelId. ChannelId should be unique value within one session. ChannelID equals to the 0 is reserved for the original decoded frame. The application can attach</p>
<a class="reference internal" href="VPL_structs_decode_vpp.html#structmfx_ext_in_crops"><span class="std std-ref">mfxExtInCrops</span></a> to <a class="reference internal" href="VPL_structs_decode_vpp.html#structmfx_video_channel_param_1a6c6d4e90cfb42d72948ec1daab0d21d2"><span class="std std-ref">mfxVideoChannelParam::ExtParam</span></a> to annotate input video frame if it wants to enable letterboxing operation. </p>
<dd><p>Initialize the SDK in (decode + vpp) mode. The logic of this function is similar to MFXVideoDECODE_Init, but application has to provide array of pointers to <a class="reference internal" href="VPL_structs_decode_vpp.html#structmfx_video_channel_param"><span class="std std-ref">mfxVideoChannelParam</span></a> and num_channel_param - number of channels. Application is responsible for memory allocation for <a class="reference internal" href="VPL_structs_decode_vpp.html#structmfx_video_channel_param"><span class="std std-ref">mfxVideoChannelParam</span></a> parameters and for each channel it should specify channel IDs: mfxVideoChannelParam::mfxFrameInfo::ChannelId. ChannelId should be unique value within one session. ChannelID equals to the 0 is reserved for the original decoded frame. The application can attach <a class="reference internal" href="VPL_structs_decode_vpp.html#structmfx_ext_in_crops"><span class="std std-ref">mfxExtInCrops</span></a> to <a class="reference internal" href="VPL_structs_decode_vpp.html#structmfx_video_channel_param_1a6c6d4e90cfb42d72948ec1daab0d21d2"><span class="std std-ref">mfxVideoChannelParam::ExtParam</span></a> to annotate input video frame if it wants to enable letterboxing operation. </p>
<p><dl class="simple">
<dt><strong>Since</strong></dt><dd><p>This function is available since API version 2.1. </p>
</dd>
Expand Down Expand Up @@ -477,9 +473,7 @@ <h3><a class="toc-backref" href="#id3" role="doc-backlink">MFXVideoDECODE_VPP_Ge
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv434MFXVideoDECODE_VPP_GetChannelParam10mfxSessionP20mfxVideoChannelParam6mfxU32">
<span id="_CPPv334MFXVideoDECODE_VPP_GetChannelParam10mfxSessionP20mfxVideoChannelParam6mfxU32"></span><span id="_CPPv234MFXVideoDECODE_VPP_GetChannelParam10mfxSessionP20mfxVideoChannelParam6mfxU32"></span><span id="MFXVideoDECODE_VPP_GetChannelParam__mfxSession.mfxVideoChannelParamP.mfxU32"></span><span class="target" id="mfxvideo_8h_1a6cc897ca2201a664b74ea70caa4e5d4a"></span><a class="reference internal" href="VPL_enums.html#_CPPv49mfxStatus" title="mfxStatus"><span class="n"><span class="pre">mfxStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MFXVideoDECODE_VPP_GetChannelParam</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="VPL_ref_types.html#_CPPv410mfxSession" title="mfxSession"><span class="n"><span class="pre">mfxSession</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">session</span></span>, <a class="reference internal" href="VPL_structs_decode_vpp.html#_CPPv420mfxVideoChannelParam" title="mfxVideoChannelParam"><span class="n"><span class="pre">mfxVideoChannelParam</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">par</span></span>, <a class="reference internal" href="VPL_ref_types.html#_CPPv46mfxU32" title="mfxU32"><span class="n"><span class="pre">mfxU32</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">channel_id</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv434MFXVideoDECODE_VPP_GetChannelParam10mfxSessionP20mfxVideoChannelParam6mfxU32" title="Permalink to this definition">#</a><br /></dt>
<dd><p><p>Returns actual VPP parameters for selected channel which should be specified by application through</p>
<p>mfxVideoChannelParam::mfxFrameInfo::ChannelId.</p>
</p>
<dd><p>Returns actual VPP parameters for selected channel which should be specified by application through mfxVideoChannelParam::mfxFrameInfo::ChannelId. </p>
<p><dl class="simple">
<dt><strong>Since</strong></dt><dd><p>This function is available since API version 2.1. </p>
</dd>
Expand Down
5 changes: 3 additions & 2 deletions latest/API_ref/VPL_func_vidcore.html
Original file line number Diff line number Diff line change
Expand Up @@ -490,8 +490,9 @@ <h3><a class="toc-backref" href="#id4" role="doc-backlink">MFXVideoCORE_QueryPla
<dt class="sig sig-object cpp" id="_CPPv426MFXVideoCORE_QueryPlatform10mfxSessionP11mfxPlatform">
<span id="_CPPv326MFXVideoCORE_QueryPlatform10mfxSessionP11mfxPlatform"></span><span id="_CPPv226MFXVideoCORE_QueryPlatform10mfxSessionP11mfxPlatform"></span><span id="MFXVideoCORE_QueryPlatform__mfxSession.mfxPlatformP"></span><span class="target" id="mfxvideo_8h_1a80f35fe5d1e86a4c8c7d1f9c389cedd8"></span><a class="reference internal" href="VPL_enums.html#_CPPv49mfxStatus" title="mfxStatus"><span class="n"><span class="pre">mfxStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MFXVideoCORE_QueryPlatform</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="VPL_ref_types.html#_CPPv410mfxSession" title="mfxSession"><span class="n"><span class="pre">mfxSession</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">session</span></span>, <a class="reference internal" href="VPL_structs_impl_manage.html#_CPPv411mfxPlatform" title="mfxPlatform"><span class="n"><span class="pre">mfxPlatform</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">platform</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426MFXVideoCORE_QueryPlatform10mfxSessionP11mfxPlatform" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Returns information about current hardware platform in the Legacy mode. </p>
<p><dl class="simple">
<dt><strong>Since</strong></dt><dd><p>This function is available since API version 1.19. </p>
<p>
Notes: Deprecated <a class="reference internal" href="VPL_structs_impl_manage.html#structmfx_platform_1afda02de73584735d513c8d87c05b064d"><span class="std std-ref">mfxPlatform::CodeName</span></a> will be filled with MFX_PLATFORM_MAXIMUM for future new platforms. <dl class="simple">
<dt><strong>Since</strong></dt><dd><p>This function is available since API version 1.19.</p>
</dd>
</dl>
</p>
Expand Down
6 changes: 6 additions & 0 deletions latest/API_ref/VPL_structs_cross_component.html
Original file line number Diff line number Diff line change
Expand Up @@ -1419,6 +1419,12 @@ <h3><a class="toc-backref" href="#id12" role="doc-backlink">mfxMVCViewDependency
<dd><p>View identifiers of the view components for inter-view prediction in the initial reference picture list RefPicList0 for non-anchor view components. </p>
</dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N20mfxMVCViewDependency14NonAnchorRefL1E">
<span id="_CPPv3N20mfxMVCViewDependency14NonAnchorRefL1E"></span><span id="_CPPv2N20mfxMVCViewDependency14NonAnchorRefL1E"></span><span id="mfxMVCViewDependency::NonAnchorRefL1__mfxU16A"></span><span class="target" id="structmfx_m_v_c_view_dependency_1ad71ddd6fe2f43c9dea3e2e101b624687"></span><a class="reference internal" href="VPL_ref_types.html#_CPPv46mfxU16" title="mfxU16"><span class="n"><span class="pre">mfxU16</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NonAnchorRefL1</span></span></span><span class="p"><span class="pre">[</span></span><span class="m"><span class="pre">16</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#_CPPv4N20mfxMVCViewDependency14NonAnchorRefL1E" title="Permalink to this definition">#</a><br /></dt>
<dd><p>View identifiers of the view components for inter-view prediction in the initial reference picture list RefPicList0 for non-anchor view components. </p>
</dd></dl>

</div>
</dd></dl>

Expand Down
Loading

0 comments on commit 20a2d92

Please sign in to comment.