media: docs-rst: Document memory-to-memory video encoder interface
authorTomasz Figa <tfiga@chromium.org>
Tue, 19 Nov 2019 11:34:57 +0000 (12:34 +0100)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 23 Jun 2020 12:02:45 +0000 (14:02 +0200)
commit9ec656cf571edb85de72c21b3ca852289c4788ae
treed8b363eadca34646ef9ad4475d7d1f8cc204a1ab
parent62a4cd0130f3936e431d5c8495af07edc9e1363d
media: docs-rst: Document memory-to-memory video encoder interface

Due to complexity of the video encoding process, the V4L2 drivers of
stateful encoder hardware require specific sequences of V4L2 API calls
to be followed. These include capability enumeration, initialization,
encoding, encode parameters change, drain and reset.

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 encoder part of
the Codec API.

Signed-off-by: Tomasz Figa <tfiga@chromium.org>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Reviewed-by: Michael Tretter <m.tretter@pengutronix.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Documentation/userspace-api/media/v4l/dev-encoder.rst [new file with mode: 0644]
Documentation/userspace-api/media/v4l/dev-mem2mem.rst
Documentation/userspace-api/media/v4l/pixfmt-v4l2.rst
Documentation/userspace-api/media/v4l/v4l2.rst
Documentation/userspace-api/media/v4l/vidioc-encoder-cmd.rst