media: docs-rst: Document memory-to-memory video decoder interface
authorTomasz Figa <tfiga@chromium.org>
Thu, 15 Aug 2019 14:44:51 +0000 (11:44 -0300)
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Mon, 19 Aug 2019 17:59:49 +0000 (14:59 -0300)
commit051f8d2d86f848cd29632908f56d277ac5800a50
tree3ce04ba427e3247feb1ade0189f808441c532fd9
parentb867d9ce0915a1edf580add42db64e6c764928eb
media: docs-rst: Document memory-to-memory video decoder interface

Due to complexity of the video decoding process, the V4L2 drivers of
stateful decoder hardware require specific sequences of V4L2 API calls
to be followed. These include capability enumeration, initialization,
decoding, seek, pause, dynamic resolution change, drain and end of
stream.

Specifics of the above have been discussed during Media Workshops at
LinuxCon Europe 2012 in Barcelona and then later Embedded Linux
Conference Europe 2014 in Düsseldorf. The de facto Codec API that
originated at those events was later implemented by the drivers we already
have merged in mainline, such as s5p-mfc or coda.

The only thing missing was the real specification included as a part of
Linux Media documentation. Fix it now and document the decoder part of
the Codec API.

Signed-off-by: Tomasz Figa <tfiga@chromium.org>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Documentation/media/uapi/v4l/dev-decoder.rst [new file with mode: 0644]
Documentation/media/uapi/v4l/dev-mem2mem.rst
Documentation/media/uapi/v4l/pixfmt-v4l2.rst
Documentation/media/uapi/v4l/v4l2.rst
Documentation/media/uapi/v4l/vidioc-decoder-cmd.rst
Documentation/media/uapi/v4l/vidioc-dqevent.rst