Publish API v2.13

latest/API_ref/VPL_enums.html

@@ -2323,7 +2323,7 @@ <h2>ErrorTypes<a class="headerlink" href="#errortypes" title="Permalink to this
 <dl class="cpp enumerator">
 <dt class="sig sig-object cpp" id="_CPPv432MFX_EXTBUFF_HEVC_TEMPORAL_LAYERS">
 <span id="_CPPv332MFX_EXTBUFF_HEVC_TEMPORAL_LAYERS"></span><span id="_CPPv232MFX_EXTBUFF_HEVC_TEMPORAL_LAYERS"></span><span class="target" id="mfxstructures_8h_1a9a3be2d66956bd67c0b66c32d8b30f17a1cdcd2195286335516bf412ec3292f33"></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_EXTBUFF_HEVC_TEMPORAL_LAYERS</span></span></span><a class="headerlink" href="#_CPPv432MFX_EXTBUFF_HEVC_TEMPORAL_LAYERS" title="Permalink to this definition">#</a><br /></dt>
-<dd><p>This extended buffer configures the structure of temporal layers inside the encoded H.264 bitstream. See the <a class="reference internal" href="VPL_structs_encode.html#structmfx_ext_avc_temporal_layers"><span class="std std-ref">mfxExtAvcTemporalLayers</span></a> structure for details. The application can attach this buffer to the <a class="reference internal" href="VPL_structs_cross_component.html#structmfx_video_param"><span class="std std-ref">mfxVideoParam</span></a> structure for encoding initialization. </p>
+<dd><p>This extended buffer configures the structure of temporal layers inside the encoded H.265 bitstream. See the mfxExtHEVCTemporalLayers structure for details. The application can attach this buffer to the <a class="reference internal" href="VPL_structs_cross_component.html#structmfx_video_param"><span class="std std-ref">mfxVideoParam</span></a> structure for encoding initialization. </p>
 </dd></dl>
 
 <dl class="cpp enumerator">

latest/API_ref/VPL_func_vidcore.html

@@ -431,7 +431,7 @@ <h3><a class="toc-backref" href="#id2" role="doc-backlink">MFXVideoCORE_SetHandl
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv422MFXVideoCORE_SetHandle10mfxSession13mfxHandleType6mfxHDL">
 <span id="_CPPv322MFXVideoCORE_SetHandle10mfxSession13mfxHandleType6mfxHDL"></span><span id="_CPPv222MFXVideoCORE_SetHandle10mfxSession13mfxHandleType6mfxHDL"></span><span id="MFXVideoCORE_SetHandle__mfxSession.mfxHandleType.mfxHDL"></span><span class="target" id="mfxvideo_8h_1a2073c019a92d591df6f088351ce62b47"></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_SetHandle</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_enums.html#_CPPv413mfxHandleType" title="mfxHandleType"><span class="n"><span class="pre">mfxHandleType</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">type</span></span>, <a class="reference internal" href="VPL_ref_types.html#_CPPv46mfxHDL" title="mfxHDL"><span class="n"><span class="pre">mfxHDL</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">hdl</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422MFXVideoCORE_SetHandle10mfxSession13mfxHandleType6mfxHDL" title="Permalink to this definition">#</a><br /></dt>
-<dd><p>Sets any essential system handle that the library might use. </p>
+<dd><p>Sets any essential system handle that the library might use. The handle must remain valid until after the application calls the MFXClose function. </p>
 <p>If the specified system handle is a COM interface, the reference counter of the COM interface will increase. The counter will decrease when the session closes.</p>
 <p><dl class="simple">
 <dt><strong>Since</strong></dt><dd><p>This function is available since API version 1.0. </p>

latest/API_ref/VPL_structs_cross_component.html

@@ -954,7 +954,7 @@ <h3><a class="toc-backref" href="#id10" role="doc-backlink">mfxInfoMFX</a><a cla
 <dl class="cpp var">
 <dt class="sig sig-object cpp" id="_CPPv4N10mfxInfoMFX18BRCParamMultiplierE">
 <span id="_CPPv3N10mfxInfoMFX18BRCParamMultiplierE"></span><span id="_CPPv2N10mfxInfoMFX18BRCParamMultiplierE"></span><span id="mfxInfoMFX::BRCParamMultiplier__mfxU16"></span><span class="target" id="structmfx_info_m_f_x_1a73d89b8daa51e39150491a2d65d0ac13"></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">BRCParamMultiplier</span></span></span><a class="headerlink" href="#_CPPv4N10mfxInfoMFX18BRCParamMultiplierE" title="Permalink to this definition">#</a><br /></dt>
-<dd><p>Specifies a multiplier for bitrate control parameters. Affects the following variables: InitialDelayInKB, BufferSizeInKB, TargetKbps, MaxKbps. If this value is not equal to zero, the encoder calculates BRC parameters as <code class="docutils literal notranslate"><span class="pre">value</span> <span class="pre">*</span> <span class="pre">BRCParamMultiplier</span></code>. </p>
+<dd><p>Specifies a multiplier for bitrate control parameters. Affects the following variables: InitialDelayInKB, BufferSizeInKB, TargetKbps, MaxKbps, WinBRCMaxAvgKbps. If this value is not equal to zero, the encoder calculates BRC parameters as <code class="docutils literal notranslate"><span class="pre">value</span> <span class="pre">*</span> <span class="pre">BRCParamMultiplier</span></code>. </p>
 </dd></dl>
 
 <dl class="cpp var">

latest/API_ref/VPL_structs_encode.html

@@ -1781,13 +1781,13 @@ <h3><a class="toc-backref" href="#id16" role="doc-backlink">mfxExtCodingOption3<
 <dl class="cpp var">
 <dt class="sig sig-object cpp" id="_CPPv4N19mfxExtCodingOption316WinBRCMaxAvgKbpsE">
 <span id="_CPPv3N19mfxExtCodingOption316WinBRCMaxAvgKbpsE"></span><span id="_CPPv2N19mfxExtCodingOption316WinBRCMaxAvgKbpsE"></span><span id="mfxExtCodingOption3::WinBRCMaxAvgKbps__mfxU16"></span><span class="target" id="structmfx_ext_coding_option3_1a6ce194a1743834462aca03362e1b1f17"></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">WinBRCMaxAvgKbps</span></span></span><a class="headerlink" href="#_CPPv4N19mfxExtCodingOption316WinBRCMaxAvgKbpsE" title="Permalink to this definition">#</a><br /></dt>
-<dd><p>When rate control method is MFX_RATECONTROL_VBR, MFX_RATECONTROL_LA, MFX_RATECONTROL_LA_HRD, or MFX_RATECONTROL_QVBR this parameter specifies the maximum bitrate averaged over a sliding window specified by WinBRCSize. For MFX_RATECONTROL_CBR this parameter is ignored and equals TargetKbps. </p>
+<dd><p>When rate control method is MFX_RATECONTROL_CBR, MFX_RATECONTROL_VBR, MFX_RATECONTROL_LA, MFX_RATECONTROL_LA_HRD, or MFX_RATECONTROL_QVBR this parameter specifies the maximum bitrate averaged over a sliding window specified by WinBRCSize. </p>
 </dd></dl>
 
 <dl class="cpp var">
 <dt class="sig sig-object cpp" id="_CPPv4N19mfxExtCodingOption310WinBRCSizeE">
 <span id="_CPPv3N19mfxExtCodingOption310WinBRCSizeE"></span><span id="_CPPv2N19mfxExtCodingOption310WinBRCSizeE"></span><span id="mfxExtCodingOption3::WinBRCSize__mfxU16"></span><span class="target" id="structmfx_ext_coding_option3_1a96a7efa32a8535e3d5efa65fc07c5bbc"></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">WinBRCSize</span></span></span><a class="headerlink" href="#_CPPv4N19mfxExtCodingOption310WinBRCSizeE" title="Permalink to this definition">#</a><br /></dt>
-<dd><p>When rate control method is MFX_RATECONTROL_CBR, MFX_RATECONTROL_VBR, MFX_RATECONTROL_LA, MFX_RATECONTROL_LA_HRD, or MFX_RATECONTROL_QVBR this parameter specifies sliding window size in frames. Set this parameter to zero to disable sliding window. </p>
+<dd><p>When rate control method is MFX_RATECONTROL_CBR, MFX_RATECONTROL_VBR, MFX_RATECONTROL_LA, MFX_RATECONTROL_LA_HRD, or MFX_RATECONTROL_QVBR this parameter specifies sliding window size in frames. Set WinBRCMaxAvgKbps and WinBRCSize to zero to disable sliding window. </p>
 </dd></dl>
 
 <dl class="cpp var">
@@ -4226,6 +4226,10 @@ <h3><a class="toc-backref" href="#id62" role="doc-backlink">mfxExtQualityInfoOut
 <dt class="sig sig-object cpp" id="_CPPv4N23mfxExtQualityInfoOutput3MSEE">
 <span id="_CPPv3N23mfxExtQualityInfoOutput3MSEE"></span><span id="_CPPv2N23mfxExtQualityInfoOutput3MSEE"></span><span id="mfxExtQualityInfoOutput::MSE__mfxU32A"></span><span class="target" id="structmfx_ext_quality_info_output_1a6a74dc6846962cc3c130d138a71f63b1"></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="sig-name descname"><span class="n"><span class="pre">MSE</span></span></span><span class="p"><span class="pre">[</span></span><span class="m"><span class="pre">3</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#_CPPv4N23mfxExtQualityInfoOutput3MSEE" title="Permalink to this definition">#</a><br /></dt>
 <dd><p>Frame level mean squared errors (MSE) for Y/U/V channel. </p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>MSE is stored in U24.8 format. The calculation formula is: PSNR = 10 * log10(256.0 * (2^bitDepth - 1)^2 / (double)MSE)). </p>
+</div>
 </dd></dl>
 
 <dl class="cpp var">

latest/Experimental.html

@@ -594,7 +594,7 @@ <h1>Intel<sup>®</sup> VPL Experimental API<a class="headerlink" href="#vpl-shor
 <td></td>
 <td></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="API_ref/VPL_enums.html#_CPPv425mfxImplCapsDeliveryFormat" title="mfxImplCapsDeliveryFormat"><code class="xref cpp cpp-enum docutils literal notranslate"><span class="pre">mfxImplCapsDeliveryFormat</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="API_ref/VPL_enums.html#_CPPv4N25mfxImplCapsDeliveryFormat26MFX_IMPLCAPS_SURFACE_TYPESE" title="mfxImplCapsDeliveryFormat::MFX_IMPLCAPS_SURFACE_TYPES"><code class="xref cpp cpp-enumerator docutils literal notranslate"><span class="pre">mfxImplCapsDeliveryFormat::MFX_IMPLCAPS_SURFACE_TYPES</span></code></a></p></td>
 <td><p>2.10</p></td>
 <td></td>
 <td></td>
@@ -641,28 +641,28 @@ <h1>Intel<sup>®</sup> VPL Experimental API<a class="headerlink" href="#vpl-shor
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="API_ref/VPL_structs_vpp.html#_CPPv426mfxExtVPPAISuperResolution" title="mfxExtVPPAISuperResolution"><code class="xref cpp cpp-struct docutils literal notranslate"><span class="pre">mfxExtVPPAISuperResolution</span></code></a></p></td>
 <td><p>2.11</p></td>
-<td></td>
-<td></td>
+<td><p>2.13</p></td>
+<td><p>Moved to production</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="API_ref/VPL_enums.html#_CPPv424mfxAISuperResolutionMode" title="mfxAISuperResolutionMode"><code class="xref cpp cpp-enum docutils literal notranslate"><span class="pre">mfxAISuperResolutionMode</span></code></a></p></td>
 <td><p>2.11</p></td>
-<td></td>
-<td></td>
+<td><p>2.13</p></td>
+<td><p>Moved to production</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="API_ref/VPL_structs_encode.html#_CPPv421mfxExtQualityInfoMode" title="mfxExtQualityInfoMode"><code class="xref cpp cpp-struct docutils literal notranslate"><span class="pre">mfxExtQualityInfoMode</span></code></a></p></td>
 <td><p>2.11</p></td>
-<td></td>
-<td></td>
+<td><p>2.13</p></td>
+<td><p>Moved to production</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="API_ref/VPL_structs_encode.html#_CPPv423mfxExtQualityInfoOutput" title="mfxExtQualityInfoOutput"><code class="xref cpp cpp-struct docutils literal notranslate"><span class="pre">mfxExtQualityInfoOutput</span></code></a></p></td>
 <td><p>2.11</p></td>
-<td></td>
-<td></td>
+<td><p>2.13</p></td>
+<td><p>Moved to production</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="API_ref/VPL_enums.html#_CPPv418mfxQualityInfoMode" title="mfxQualityInfoMode"><code class="xref cpp cpp-enum docutils literal notranslate"><span class="pre">mfxQualityInfoMode</span></code></a></p></td>
 <td><p>2.11</p></td>
-<td></td>
-<td></td>
+<td><p>2.13</p></td>
+<td><p>Moved to production</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="API_ref/VPL_enums.html#_CPPv416MFX_GPUCOPY_FAST" title="MFX_GPUCOPY_FAST"><code class="xref cpp cpp-enumerator docutils literal notranslate"><span class="pre">MFX_GPUCOPY_FAST</span></code></a></p></td>
 <td><p>2.11</p></td>
@@ -671,18 +671,18 @@ <h1>Intel<sup>®</sup> VPL Experimental API<a class="headerlink" href="#vpl-shor
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="API_ref/VPL_structs_encode.html#_CPPv427mfxExtAV1ScreenContentTools" title="mfxExtAV1ScreenContentTools"><code class="xref cpp cpp-struct docutils literal notranslate"><span class="pre">mfxExtAV1ScreenContentTools</span></code></a></p></td>
 <td><p>2.11</p></td>
-<td></td>
-<td></td>
+<td><p>2.13</p></td>
+<td><p>Moved to production</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="API_ref/VPL_structs_encode.html#_CPPv425mfxExtAlphaChannelEncCtrl" title="mfxExtAlphaChannelEncCtrl"><code class="xref cpp cpp-struct docutils literal notranslate"><span class="pre">mfxExtAlphaChannelEncCtrl</span></code></a></p></td>
 <td><p>2.11</p></td>
-<td></td>
-<td></td>
+<td><p>2.13</p></td>
+<td><p>Moved to production</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="API_ref/VPL_structs_encode.html#_CPPv425mfxExtAlphaChannelSurface" title="mfxExtAlphaChannelSurface"><code class="xref cpp cpp-struct docutils literal notranslate"><span class="pre">mfxExtAlphaChannelSurface</span></code></a></p></td>
 <td><p>2.11</p></td>
-<td></td>
-<td></td>
+<td><p>2.13</p></td>
+<td><p>Moved to production</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="API_ref/VPL_structs_memory.html#_CPPv421mfxSurfaceVulkanImg2D" title="mfxSurfaceVulkanImg2D"><code class="xref cpp cpp-struct docutils literal notranslate"><span class="pre">mfxSurfaceVulkanImg2D</span></code></a></p></td>
 <td><p>2.12</p></td>
@@ -696,13 +696,13 @@ <h1>Intel<sup>®</sup> VPL Experimental API<a class="headerlink" href="#vpl-shor
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="API_ref/VPL_structs_vpp.html#_CPPv429mfxExtVPPAIFrameInterpolation" title="mfxExtVPPAIFrameInterpolation"><code class="xref cpp cpp-struct docutils literal notranslate"><span class="pre">mfxExtVPPAIFrameInterpolation</span></code></a></p></td>
 <td><p>2.12</p></td>
-<td></td>
-<td></td>
+<td><p>2.13</p></td>
+<td><p>Moved to production</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="API_ref/VPL_enums.html#_CPPv427mfxAIFrameInterpolationMode" title="mfxAIFrameInterpolationMode"><code class="xref cpp cpp-enum docutils literal notranslate"><span class="pre">mfxAIFrameInterpolationMode</span></code></a></p></td>
 <td><p>2.12</p></td>
-<td></td>
-<td></td>
+<td><p>2.13</p></td>
+<td><p>Moved to production</p></td>
 </tr>
 </tbody>
 </table>