.. SPDX-FileCopyrightText: 2019-2020 Intel Corporation
..
.. SPDX-License-Identifier: CC-BY-4.0

.. _struct_cross_component:

==========================
Cross-component Structures
==========================

.. _struct_cross_comp_begin:

Structures used across library components.

.. _struct_cross_comp_end:

---
API
---

.. contents::
   :local:
   :depth: 1

mfxComponentInfo
----------------

.. doxygenstruct:: mfxComponentInfo
   :project: oneVPL
   :members:
   :protected-members:

mfxExtHEVCParam
---------------

.. doxygenstruct:: mfxExtHEVCParam
   :project: oneVPL
   :members:
   :protected-members:

mfxExtJPEGHuffmanTables
-----------------------

.. doxygenstruct:: mfxExtJPEGHuffmanTables
   :project: oneVPL
   :members:
   :protected-members:

+------------------+---------+------+
| Table ID         | 0       | 1    |
+------------------+---------+------+
| Number of tables |         |      |
+==================+=========+======+
| 0                | Y, U, V |      |
+------------------+---------+------+
| 1                | Y       | U, V |
+------------------+---------+------+


mfxExtJPEGQuantTables
---------------------

.. doxygenstruct:: mfxExtJPEGQuantTables
   :project: oneVPL
   :members:
   :protected-members:

+------------------+---------+------+---+
| Table ID         | 0       | 1    | 2 |
+------------------+---------+------+---+
| Number of tables |         |      |   |
+==================+=========+======+===+
| 0                | Y, U, V |      |   |
+------------------+---------+------+---+
| 1                | Y       | U, V |   |
+------------------+---------+------+---+
| 2                | Y       | U    | V |
+------------------+---------+------+---+



mfxExtMVCSeqDesc
----------------

.. doxygenstruct:: mfxExtMVCSeqDesc
   :project: oneVPL
   :members:
   :protected-members:

mfxExtMVCTargetViews
--------------------

.. doxygenstruct:: mfxExtMVCTargetViews
   :project: oneVPL
   :members:
   :protected-members:

mfxExtVideoSignalInfo
---------------------

.. doxygenstruct:: mfxExtVideoSignalInfo
   :project: oneVPL
   :members:
   :protected-members:
   :undoc-members:

mfxExtVP9Param
--------------

.. doxygenstruct:: mfxExtVP9Param
   :project: oneVPL
   :members:
   :protected-members:

mfxFrameId
----------

.. doxygenstruct:: mfxFrameId
   :project: oneVPL
   :members:
   :protected-members:

mfxInfoMFX
----------

.. doxygenstruct:: mfxInfoMFX
   :project: oneVPL
   :members:
   :protected-members:

.. note::

   The :cpp:member:`mfxInfoMFX::InitialDelayInKB`, :cpp:member:`mfxInfoMFX::TargetKbps`,
   :cpp:member:`mfxInfoMFX::MaxKbps` parameters are used by the constant bitrate
   (CBR), variable bitrate control (VBR), and CQP HRD algorithms.

   Encoders follow the Hypothetical Reference Decoding (HRD) model. The
   HRD model assumes that data flows into a buffer of the fixed size
   BufferSizeInKB with a constant bitrate of TargetKbps. (Estimate the targeted
   frame size by dividing frame rate by bitrate.)

   The decoder starts decoding after the buffer reaches the initial size
   InitialDelayInKB, which is equivalent to reaching an initial delay of
   InitialDelayInKB*8000/TargetKbpsms.
   *In this context, KB is 1000 bytes and Kbps is 1000 bps.*

   If InitialDelayInKB or BufferSizeInKB is equal to zero, the value is
   calculated using bitrate, frame rate, profile, level, and so on.

   TargetKbps must be specified for encoding initialization.

   For variable bitrate control, the MaxKbps parameter specifies the maximum
   bitrate at which the encoded data enters the Video Buffering Verifier (VBV)
   buffer. If MaxKbps is equal to zero, the value is calculated from bitrate,
   frame rate, profile, and level.

.. note::

   The :cpp:member:`mfxInfoMFX::TargetKbps`, :cpp:member:`mfxInfoMFX::Accuracy`,
   :cpp:member:`mfxInfoMFX::Convergence` parameters are used by the average variable
   bitrate control (AVBR) algorithm. The algorithm focuses on overall encoding
   quality while meeting the specified bitrate, TargetKbps, within the accuracy
   range, Accuracy, after a Convergence period. This method does not follow HRD
   and the instant bitrate is not capped or padded.


mfxMVCOperationPoint
--------------------

.. doxygenstruct:: mfxMVCOperationPoint
   :project: oneVPL
   :members:
   :protected-members:

mfxMVCViewDependency
--------------------

.. doxygenstruct:: mfxMVCViewDependency
   :project: oneVPL
   :members:
   :protected-members:

mfxPayload
----------

.. doxygenstruct:: mfxPayload
   :project: oneVPL
   :members:
   :protected-members:

+-----------+-------------------------------------------+
| **Codec** | **Supported Types**                       |
+===========+===========================================+
| MPEG2     | 0x01B2 //User Data                        |
+-----------+-------------------------------------------+
| AVC       | 02 //pan_scan_rect                        |
|           |                                           |
|           | 03 //filler_payload                       |
|           |                                           |
|           | 04 //user_data_registered_itu_t_t35       |
|           |                                           |
|           | 05 //user_data_unregistered               |
|           |                                           |
|           | 06 //recovery_point                       |
|           |                                           |
|           | 09 //scene_info                           |
|           |                                           |
|           | 13 //full_frame_freeze                    |
|           |                                           |
|           | 14 //full_frame_freeze_release            |
|           |                                           |
|           | 15 //full_frame_snapshot                  |
|           |                                           |
|           | 16 //progressive_refinement_segment_start |
|           |                                           |
|           | 17 //progressive_refinement_segment_end   |
|           |                                           |
|           | 19 //film_grain_characteristics           |
|           |                                           |
|           | 20 //deblocking_filter_display_preference |
|           |                                           |
|           | 21 //stereo_video_info                    |
|           |                                           |
|           | 45 //frame_packing_arrangement            |
+-----------+-------------------------------------------+
| HEVC      | All                                       |
+-----------+-------------------------------------------+



mfxVideoParam
-------------

.. doxygenstruct:: mfxVideoParam
   :project: oneVPL
   :members:
   :protected-members:

mfxVP9SegmentParam
------------------

.. doxygenstruct:: mfxVP9SegmentParam
   :project: oneVPL
   :members:
   :protected-members:

mfxExtAV1FilmGrainParam
-----------------------

.. doxygenstruct:: mfxExtAV1FilmGrainParam
   :project: oneVPL
   :members:
   :protected-members:

mfxAV1FilmGrainPoint
--------------------

.. doxygenstruct:: mfxAV1FilmGrainPoint
   :project: oneVPL
   :members:
   :protected-members:

mfxRect
-------

.. doxygenstruct:: mfxRect
   :project: oneVPL
   :members:
   :protected-members:
   
mfxExtHyperModeParam
--------------------

.. doxygenstruct:: mfxExtHyperModeParam
   :project: oneVPL
   :members:
   :protected-members:

mfxGUID
-------

.. doxygenstruct:: mfxGUID
   :project: oneVPL
   :members:
   :protected-members:

mfxExtAllocationHints
---------------------
.. doxygenstruct:: mfxExtAllocationHints
   :project: oneVPL
   :members:
   :protected-members:

mfxRefInterface
---------------
.. doxygenstruct:: mfxRefInterface
   :project: oneVPL
   :members:
   :protected-members:

mfxExtMasteringDisplayColourVolume
----------------------------------

.. doxygenstruct:: mfxExtMasteringDisplayColourVolume
   :project: oneVPL
   :members:
   :protected-members:


mfxExtContentLightLevelInfo
---------------------------

.. doxygenstruct:: mfxExtContentLightLevelInfo
   :project: oneVPL
   :members:
   :protected-members: