kernel/linux.git/Documentation/userspace-api/media/v4l/dev-encoder.rst, branch linux-7.0.y

docs: media: add missing c namespace to V4L headers

2025-10-17T19:56:59+00:00

Media references belong to V4L namespace. Fix a lot of broken links when including videodev2.h and probably fixing several other broken cross-references between different files inside media docs. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID:

media: doc: dev-encoder: Fixup type for ENUM_FRAMEINTERVALS

2023-08-10T05:58:36+00:00

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 Signed-off-by: Hans Verkuil

media: doc: codec: Rename "Return fields" to "Returned fields" for consistency

2023-08-10T05:58:36+00:00

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 Signed-off-by: Hans Verkuil

media: doc: dev-encoder: Fixup whitespace before bold asterisks

2023-08-10T05:58:35+00:00

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 Signed-off-by: Hans Verkuil

media: docs: use SPDX GPL-2.0 OR GFDL-1.1 instead of text on *.rst files

2020-09-01T12:13:30+00:00

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

media: dev-encoder.rst: add GFDL-1-1+ to SPDX header

2020-06-23T13:05:10+00:00

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 Signed-off-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab

media: dev-encoder.rst: add reference to V4L2_FMT_FLAG_ENC_CAP_FRAME_INTERVAL

2020-06-23T12:02:46+00:00

Setting the stateful encoder capture frame interval is only supported if this flag is set. Document this. Signed-off-by: Hans Verkuil Reviewed-by: Michael Tretter Acked-by: Tomasz Figa Signed-off-by: Mauro Carvalho Chehab

media: docs-rst: Document memory-to-memory video encoder interface

2020-06-23T12:02:45+00:00

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 Signed-off-by: Hans Verkuil Reviewed-by: Michael Tretter Signed-off-by: Mauro Carvalho Chehab