Commit 35aaa6e6 authored by Ezequiel Garcia's avatar Ezequiel Garcia Committed by Mauro Carvalho Chehab
Browse files

media: Rename stateful codec control macros 



For historical reasons, stateful codec controls are named
as {}_MPEG_{}. While we can't at this point sanely
change all control IDs (such as V4L2_CID_MPEG_VIDEO_VP8_FRAME_HEADER),
we can least change the more meaningful macros such as classes
macros.

Signed-off-by: default avatarEzequiel Garcia <ezequiel@collabora.com>
Tested-by: default avatarJernej Skrabec <jernej.skrabec@siol.net>
Signed-off-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent c8363ff2

Documentation/userspace-api/media/v4l/dev-mem2mem.rst

+1 −1
Original line number Original line Diff line number Diff line
@@ -32,7 +32,7 @@ file handle is visible through another file handle). 
One of the most common memory-to-memory device is the codec. Codecs

One of the most common memory-to-memory device is the codec. Codecs

are more complicated than most and require additional setup for

are more complicated than most and require additional setup for

their codec parameters. This is done through codec controls.

their codec parameters. This is done through codec controls.

See :ref:`mpeg-controls`. More details on how to use codec memory-to-memory

See :ref:`codec-controls`. More details on how to use codec memory-to-memory

devices are given in the following sections.

devices are given in the following sections.





.. toctree::

.. toctree::

Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst

+2 −2
Original line number Original line Diff line number Diff line 
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later

.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later





.. _mpeg-controls:

.. _codec-controls:





***********************

***********************

Codec Control Reference

Codec Control Reference
@@ -26,7 +26,7 @@ Generic Codec Controls 
Codec Control IDs

Codec Control IDs

-----------------

-----------------





``V4L2_CID_MPEG_CLASS (class)``

``V4L2_CID_CODEC_CLASS (class)``

    The Codec class descriptor. Calling

    The Codec class descriptor. Calling

    :ref:`VIDIOC_QUERYCTRL` for this control will

    :ref:`VIDIOC_QUERYCTRL` for this control will

    return a description of this control class. This description can be

    return a description of this control class. This description can be

Documentation/userspace-api/media/v4l/extended-controls.rst

+4 −4
Original line number Original line Diff line number Diff line
@@ -55,8 +55,8 @@ controls in that array and a control class. Control classes are used to 
group similar controls into a single class. For example, control class

group similar controls into a single class. For example, control class

``V4L2_CTRL_CLASS_USER`` contains all user controls (i. e. all controls

``V4L2_CTRL_CLASS_USER`` contains all user controls (i. e. all controls

that can also be set using the old :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>`

that can also be set using the old :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>`

ioctl). Control class ``V4L2_CTRL_CLASS_MPEG`` contains all controls

ioctl). Control class ``V4L2_CTRL_CLASS_CODEC`` contains controls

relating to MPEG encoding, etc.

relating to codecs.





All controls in the control array must belong to the specified control

All controls in the control array must belong to the specified control

class. An error is returned if this is not the case.

class. An error is returned if this is not the case.
@@ -130,9 +130,9 @@ control class is found: 




.. code-block:: c

.. code-block:: c





    qctrl.id = V4L2_CTRL_CLASS_MPEG | V4L2_CTRL_FLAG_NEXT_CTRL;

    qctrl.id = V4L2_CTRL_CLASS_CODEC | V4L2_CTRL_FLAG_NEXT_CTRL;

    while (0 == ioctl(fd, VIDIOC_QUERYCTRL, &qctrl)) {

    while (0 == ioctl(fd, VIDIOC_QUERYCTRL, &qctrl)) {

	if (V4L2_CTRL_ID2CLASS(qctrl.id) != V4L2_CTRL_CLASS_MPEG)

	if (V4L2_CTRL_ID2CLASS(qctrl.id) != V4L2_CTRL_CLASS_CODEC)

	    break;

	    break;

	/* ... */

	/* ... */

	qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;

	qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;

Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst

+3 −3
Original line number Original line Diff line number Diff line
@@ -322,10 +322,10 @@ still cause this situation. 
	:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` and

	:ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` and

	:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` ioctl belong to this

	:ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` ioctl belong to this

	class.

	class.

    * - ``V4L2_CTRL_CLASS_MPEG``

    * - ``V4L2_CTRL_CLASS_CODEC``

      - 0x990000

      - 0x990000

      - The class containing MPEG compression controls. These controls are

      - The class containing stateful codec controls. These controls are

	described in :ref:`mpeg-controls`.

	described in :ref:`codec-controls`.

    * - ``V4L2_CTRL_CLASS_CAMERA``

    * - ``V4L2_CTRL_CLASS_CAMERA``

      - 0x9a0000

      - 0x9a0000

      - The class containing camera controls. These controls are described

      - The class containing camera controls. These controls are described

drivers/media/common/cx2341x.c

+2 −2
Original line number Original line Diff line number Diff line
@@ -166,7 +166,7 @@ static void cx2341x_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *ty 




/* Must be sorted from low to high control ID! */

/* Must be sorted from low to high control ID! */

const u32 cx2341x_mpeg_ctrls[] = {

const u32 cx2341x_mpeg_ctrls[] = {

	V4L2_CID_MPEG_CLASS,

	V4L2_CID_CODEC_CLASS,

	V4L2_CID_MPEG_STREAM_TYPE,

	V4L2_CID_MPEG_STREAM_TYPE,

	V4L2_CID_MPEG_STREAM_VBI_FMT,

	V4L2_CID_MPEG_STREAM_VBI_FMT,

	V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ,

	V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ,
@@ -574,7 +574,7 @@ int cx2341x_ctrl_query(const struct cx2341x_mpeg_params *params, 
	int err;

	int err;





	switch (qctrl->id) {

	switch (qctrl->id) {

	case V4L2_CID_MPEG_CLASS:

	case V4L2_CID_CODEC_CLASS:

		return v4l2_ctrl_query_fill(qctrl, 0, 0, 0, 0);

		return v4l2_ctrl_query_fill(qctrl, 0, 0, 0, 0);

	case V4L2_CID_MPEG_STREAM_TYPE:

	case V4L2_CID_MPEG_STREAM_TYPE:

		return v4l2_ctrl_query_fill(qctrl,

		return v4l2_ctrl_query_fill(qctrl,