summaryrefslogtreecommitdiff
path: root/Documentation/userspace-api/media/v4l/dev-encoder.rst
AgeCommit message (Collapse)AuthorFilesLines
2023-08-10media: doc: dev-encoder: Fixup type for ENUM_FRAMEINTERVALSPaul Kocialkowski1-2/+2
The doc mistakently mentions v4l2_frmsizeenum as the struct type passed to VIDIOC_ENUM_FRAMEINTERVALS, while it's actually v4l2_frmivalenum that should be used. Signed-off-by: Paul Kocialkowski <paul.kocialkowski@bootlin.com> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
2023-08-10media: doc: codec: Rename "Return fields" to "Returned fields" for consistencyPaul Kocialkowski1-8/+8
The parts about fields that are returned typically comes after "Required fields" so it feels more consistent to name them "Returned fields". Signed-off-by: Paul Kocialkowski <paul.kocialkowski@bootlin.com> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
2023-08-10media: doc: dev-encoder: Fixup whitespace before bold asterisksPaul Kocialkowski1-2/+2
An extra whitespace after the asterisks prevents bold syntax parsing and results in the asterisks shown in the (non-bold) title. Signed-off-by: Paul Kocialkowski <paul.kocialkowski@bootlin.com> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
2020-09-01media: docs: use SPDX GPL-2.0 OR GFDL-1.1 instead of text on *.rst filesMauro Carvalho Chehab1-25/+1
There are some files that are dual licensed GPL and GFDL. As SPDX v3.10 gained support for GFDL-1.1 with no invariant sections: https://spdx.org/licenses/GFDL-1.1-no-invariants-or-later.html Let's remove the dual license text, replacing them by: SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-06-23media: dev-encoder.rst: add GFDL-1-1+ to SPDX headerMauro Carvalho Chehab1-1/+25
The media documents under the uAPI should be GFDL compatible. So, make this one dual-licensed GPL-2.0 or GFDL-1.1+ with no-invariant sections. Signed-off-by: Tomasz Figa <tfiga@chromium.org> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-06-23media: dev-encoder.rst: add reference to V4L2_FMT_FLAG_ENC_CAP_FRAME_INTERVALHans Verkuil1-1/+2
Setting the stateful encoder capture frame interval is only supported if this flag is set. Document this. Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Reviewed-by: Michael Tretter <m.tretter@pengutronix.de> Acked-by: Tomasz Figa <tfiga@chromium.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-06-23media: docs-rst: Document memory-to-memory video encoder interfaceTomasz Figa1-0/+728
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>