From d04c114e806f93135e3584bb7016aefa414322fb Mon Sep 17 00:00:00 2001 From: Ezequiel Garcia Date: Thu, 4 Mar 2021 15:07:48 +0100 Subject: media: uapi: vp8: Remove "header" from symbol names and macros It doesn't seem to add any clarity to have a "header" suffix in controls, struct names and flags. Since this just makes names too long without any benefit, just drop it. Signed-off-by: Ezequiel Garcia Signed-off-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab --- .../userspace-api/media/v4l/ext-ctrls-codec.rst | 80 +++++++++++----------- .../userspace-api/media/v4l/pixfmt-compressed.rst | 2 +- 2 files changed, 41 insertions(+), 41 deletions(-) (limited to 'Documentation/userspace-api/media') diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst index 9963c1c9a4d5..7c778f42f80e 100644 --- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst @@ -1800,7 +1800,7 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - .. _v4l2-mpeg-vp8: -``V4L2_CID_MPEG_VIDEO_VP8_FRAME_HEADER (struct)`` +``V4L2_CID_MPEG_VIDEO_VP8_FRAME (struct)`` Specifies the frame parameters for the associated VP8 parsed frame data. This includes the necessary parameters for configuring a stateless hardware decoding pipeline for VP8. @@ -1811,7 +1811,7 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - This compound control is not yet part of the public kernel API and it is expected to change. -.. c:type:: v4l2_ctrl_vp8_frame_header +.. c:type:: v4l2_ctrl_vp8_frame .. raw:: latex @@ -1821,22 +1821,22 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - .. cssclass:: longtable -.. flat-table:: struct v4l2_ctrl_vp8_frame_header +.. flat-table:: struct v4l2_ctrl_vp8_frame :header-rows: 0 :stub-columns: 0 :widths: 1 1 2 - * - struct :c:type:`v4l2_vp8_segment_header` - - ``segment_header`` + * - struct :c:type:`v4l2_vp8_segment` + - ``segment`` - Structure with segment-based adjustments metadata. - * - struct :c:type:`v4l2_vp8_loopfilter_header` - - ``loopfilter_header`` + * - struct :c:type:`v4l2_vp8_loopfilter` + - ``lf`` - Structure with loop filter level adjustments metadata. - * - struct :c:type:`v4l2_vp8_quantization_header` - - ``quant_header`` + * - struct :c:type:`v4l2_vp8_quantization` + - ``quant`` - Structure with VP8 dequantization indices metadata. - * - struct :c:type:`v4l2_vp8_entropy_header` - - ``entropy_header`` + * - struct :c:type:`v4l2_vp8_entropy` + - ``entropy`` - Structure with VP8 entropy coder probabilities metadata. * - struct :c:type:`v4l2_vp8_entropy_coder_state` - ``coder_state`` @@ -1905,15 +1905,15 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - :c:type:`v4l2_buffer` to a __u64. * - __u64 - ``flags`` - - See :ref:`Frame Header Flags ` + - See :ref:`Frame Flags ` .. raw:: latex \normalsize -.. _vp8_frame_header_flags: +.. _vp8_frame_flags: -``Frame Header Flags`` +``Frame Flags`` .. tabularcolumns:: |p{9.8cm}|p{0.8cm}|p{6.7cm}| @@ -1924,22 +1924,22 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - :stub-columns: 0 :widths: 1 1 2 - * - ``V4L2_VP8_FRAME_HEADER_FLAG_KEY_FRAME`` + * - ``V4L2_VP8_FRAME_FLAG_KEY_FRAME`` - 0x01 - Indicates if the frame is a key frame. - * - ``V4L2_VP8_FRAME_HEADER_FLAG_EXPERIMENTAL`` + * - ``V4L2_VP8_FRAME_FLAG_EXPERIMENTAL`` - 0x02 - Experimental bitstream. - * - ``V4L2_VP8_FRAME_HEADER_FLAG_SHOW_FRAME`` + * - ``V4L2_VP8_FRAME_FLAG_SHOW_FRAME`` - 0x04 - Show frame flag, indicates if the frame is for display. - * - ``V4L2_VP8_FRAME_HEADER_FLAG_MB_NO_SKIP_COEFF`` + * - ``V4L2_VP8_FRAME_FLAG_MB_NO_SKIP_COEFF`` - 0x08 - Enable/disable skipping of macroblocks with no non-zero coefficients. - * - ``V4L2_VP8_FRAME_HEADER_FLAG_SIGN_BIAS_GOLDEN`` + * - ``V4L2_VP8_FRAME_FLAG_SIGN_BIAS_GOLDEN`` - 0x10 - Sign of motion vectors when the golden frame is referenced. - * - ``V4L2_VP8_FRAME_HEADER_FLAG_SIGN_BIAS_ALT`` + * - ``V4L2_VP8_FRAME_FLAG_SIGN_BIAS_ALT`` - 0x20 - Sign of motion vectors when the alt frame is referenced. @@ -1967,13 +1967,13 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - - ``padding`` - Applications and drivers must set this to zero. -.. c:type:: v4l2_vp8_segment_header +.. c:type:: v4l2_vp8_segment .. cssclass:: longtable .. tabularcolumns:: |p{1.2cm}|p{4.0cm}|p{12.1cm}| -.. flat-table:: struct v4l2_vp8_segment_header +.. flat-table:: struct v4l2_vp8_segment :header-rows: 0 :stub-columns: 0 :widths: 1 1 2 @@ -1992,11 +1992,11 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - - Applications and drivers must set this to zero. * - __u32 - ``flags`` - - See :ref:`Segment Header Flags ` + - See :ref:`Segment Flags ` -.. _vp8_segment_header_flags: +.. _vp8_segment_flags: -``Segment Header Flags`` +``Segment Flags`` .. raw:: latex @@ -2009,16 +2009,16 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - :stub-columns: 0 :widths: 1 1 2 - * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_ENABLED`` + * - ``V4L2_VP8_SEGMENT_FLAG_ENABLED`` - 0x01 - Enable/disable segment-based adjustments. - * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_UPDATE_MAP`` + * - ``V4L2_VP8_SEGMENT_FLAG_UPDATE_MAP`` - 0x02 - Indicates if the macroblock segmentation map is updated in this frame. - * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_UPDATE_FEATURE_DATA`` + * - ``V4L2_VP8_SEGMENT_FLAG_UPDATE_FEATURE_DATA`` - 0x04 - Indicates if the segment feature data is updated in this frame. - * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_DELTA_VALUE_MODE`` + * - ``V4L2_VP8_SEGMENT_FLAG_DELTA_VALUE_MODE`` - 0x08 - If is set, the segment feature data mode is delta-value. If cleared, it's absolute-value. @@ -2027,13 +2027,13 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - \normalsize -.. c:type:: v4l2_vp8_loopfilter_header +.. c:type:: v4l2_vp8_loopfilter .. cssclass:: longtable .. tabularcolumns:: |p{1.5cm}|p{3.9cm}|p{11.9cm}| -.. flat-table:: struct v4l2_vp8_loopfilter_header +.. flat-table:: struct v4l2_vp8_loopfilter :header-rows: 0 :stub-columns: 0 :widths: 1 1 2 @@ -2055,11 +2055,11 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - - Applications and drivers must set this to zero. * - __u32 - ``flags`` - - See :ref:`Loopfilter Header Flags ` + - See :ref:`Loopfilter Flags ` -.. _vp8_loopfilter_header_flags: +.. _vp8_loopfilter_flags: -``Loopfilter Header Flags`` +``Loopfilter Flags`` .. tabularcolumns:: |p{7.0cm}|p{1.2cm}|p{9.1cm}| @@ -2068,10 +2068,10 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - :stub-columns: 0 :widths: 1 1 2 - * - ``V4L2_VP8_LF_HEADER_ADJ_ENABLE`` + * - ``V4L2_VP8_LF_ADJ_ENABLE`` - 0x01 - Enable/disable macroblock-level loop filter adjustment. - * - ``V4L2_VP8_LF_HEADER_DELTA_UPDATE`` + * - ``V4L2_VP8_LF_DELTA_UPDATE`` - 0x02 - Indicates if the delta values used in an adjustment are updated. * - ``V4L2_VP8_LF_FILTER_TYPE_SIMPLE`` @@ -2079,11 +2079,11 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - - If set, indicates the filter type is simple. If cleared, the filter type is normal. -.. c:type:: v4l2_vp8_quantization_header +.. c:type:: v4l2_vp8_quantization .. tabularcolumns:: |p{1.5cm}|p{3.5cm}|p{12.3cm}| -.. flat-table:: struct v4l2_vp8_quantization_header +.. flat-table:: struct v4l2_vp8_quantization :header-rows: 0 :stub-columns: 0 :widths: 1 1 2 @@ -2110,13 +2110,13 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type - - ``padding`` - Applications and drivers must set this to zero. -.. c:type:: v4l2_vp8_entropy_header +.. c:type:: v4l2_vp8_entropy .. cssclass:: longtable .. tabularcolumns:: |p{1.5cm}|p{5.8cm}|p{10.0cm}| -.. flat-table:: struct v4l2_vp8_entropy_header +.. flat-table:: struct v4l2_vp8_entropy :header-rows: 0 :stub-columns: 0 :widths: 1 1 2 diff --git a/Documentation/userspace-api/media/v4l/pixfmt-compressed.rst b/Documentation/userspace-api/media/v4l/pixfmt-compressed.rst index ba6c0c961204..7341c9b4516b 100644 --- a/Documentation/userspace-api/media/v4l/pixfmt-compressed.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-compressed.rst @@ -157,7 +157,7 @@ Compressed Formats This format is adapted for stateless video decoders that implement a VP8 pipeline (using the :ref:`mem2mem` and :ref:`media-request-api`). Metadata associated with the frame to decode is required to be passed - through the ``V4L2_CID_MPEG_VIDEO_VP8_FRAME_HEADER`` control. + through the ``V4L2_CID_MPEG_VIDEO_VP8_FRAME`` control. See the :ref:`associated Codec Control IDs `. Exactly one output and one capture buffer must be provided for use with this pixel format. The output buffer must contain the appropriate number -- cgit v1.2.3