target/linux/bcm27xx/patches-5.4/950-0500-media-pixfmt-Document-the-HEVC-slice-pixel-format.patch

   1 From 662256810630f6ac6d06ee0cdc5f4660b25f7e98 Mon Sep 17 00:00:00 2001
   2 From: Paul Kocialkowski <paul.kocialkowski@bootlin.com>
   3 Date: Tue, 22 Oct 2019 12:26:53 -0300
   4 Subject: [PATCH] media: pixfmt: Document the HEVC slice pixel format
   5
   6 Commit de06f289283298e2938445019999cec46435375c upstream.
   7
   8 Document the current state of the HEVC slice pixel format.
   9 The format will need to evolve in the future, which is why it is
  10 not part of the public API.
  11
  12 Signed-off-by: Paul Kocialkowski <paul.kocialkowski@bootlin.com>
  13 Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
  14 Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
  15 ---
  16  .../media/uapi/v4l/pixfmt-compressed.rst      | 23 +++++++++++++++++++
  17  1 file changed, 23 insertions(+)
  18
  19 --- a/Documentation/media/uapi/v4l/pixfmt-compressed.rst
  20 +++ b/Documentation/media/uapi/v4l/pixfmt-compressed.rst
  21 @@ -188,6 +188,29 @@ Compressed Formats
  22         If :ref:`VIDIOC_ENUM_FMT` reports ``V4L2_FMT_FLAG_CONTINUOUS_BYTESTREAM``
  23         then the decoder has no requirements since it can parse all the
  24         information from the raw bytestream.
  25 +    * .. _V4L2-PIX-FMT-HEVC-SLICE:
  26 +
  27 +      - ``V4L2_PIX_FMT_HEVC_SLICE``
  28 +      - 'S265'
  29 +      - HEVC parsed slice data, as extracted from the HEVC bitstream.
  30 +       This format is adapted for stateless video decoders that implement a
  31 +       HEVC pipeline (using the :ref:`mem2mem` and :ref:`media-request-api`).
  32 +       This pixelformat has two modifiers that must be set at least once
  33 +       through the ``V4L2_CID_MPEG_VIDEO_HEVC_DECODE_MODE``
  34 +        and ``V4L2_CID_MPEG_VIDEO_HEVC_START_CODE`` controls.
  35 +       Metadata associated with the frame to decode is required to be passed
  36 +       through the following controls :
  37 +        * ``V4L2_CID_MPEG_VIDEO_HEVC_SPS``
  38 +        * ``V4L2_CID_MPEG_VIDEO_HEVC_PPS``
  39 +        * ``V4L2_CID_MPEG_VIDEO_HEVC_SLICE_PARAMS``
  40 +       See the :ref:`associated Codec Control IDs <v4l2-mpeg-hevc>`.
  41 +       Buffers associated with this pixel format must contain the appropriate
  42 +       number of macroblocks to decode a full corresponding frame.
  43 +
  44 +       .. note::
  45 +
  46 +          This format is not yet part of the public kernel API and it
  47 +          is expected to change.
  48      * .. _V4L2-PIX-FMT-FWHT:
  49
  50        - ``V4L2_PIX_FMT_FWHT``