uapi/linux/v4l2-controls.h

1 /* SPDX-License-Identifier: ((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) */
5  *  Copyright (C) 1999-2012 the contributors
19 #define V4L2_CTRL_CLASS_USER		0x00980000	/* Old-style 'user' controls */
23 #define V4L2_CTRL_CLASS_FLASH		0x009c0000	/* Camera flash controls */
24 #define V4L2_CTRL_CLASS_JPEG		0x009d0000	/* JPEG-compression controls */
34 /* User-class control IDs */
116 /* USER-class private control IDs */
136  * The base for the si476x driver controls. See include/media/drv-intf/si476x.h
225 /* MPEG-class control IDs */
235 	V4L2_MPEG_STREAM_TYPE_MPEG2_PS   = 0, /* MPEG-2 program stream */
236 	V4L2_MPEG_STREAM_TYPE_MPEG2_TS   = 1, /* MPEG-2 transport stream */
237 	V4L2_MPEG_STREAM_TYPE_MPEG1_SS   = 2, /* MPEG-1 system stream */
238 	V4L2_MPEG_STREAM_TYPE_MPEG2_DVD  = 3, /* MPEG-2 DVD-compatible stream */
239 	V4L2_MPEG_STREAM_TYPE_MPEG1_VCD  = 4, /* MPEG-1 VCD-compatible stream */
240 	V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD = 5, /* MPEG-2 SVCD-compatible stream */
455 /* CIDs for the MPEG-2 Part 2 (H.262) codec */
828  * enum v4l2_mpeg_video_av1_profile - AV1 profiles
847  * enum v4l2_mpeg_video_av1_level - AV1 levels
910 /*  MPEG-class control IDs specific to the CX2341x driver as defined by V4L2 */
951 /*  MPEG-class control IDs specific to the Samsung MFC 5.1 driver as defined by V4L2 */
1143 /* Flash and privacy (indicator) light controls */
1185 /* JPEG-class control IDs */
1236 /*  DV-class control IDs defined by V4L2 */
1301 /*  Detection-class control IDs defined by V4L2 */
1323  * enum v4l2_stateless_h264_decode_mode - Decoding mode
1345  * enum v4l2_stateless_h264_start_code - Start code
1351  * (legal start codes can be 3-bytes 0x000001 or 4-bytes 0x00000001).
1376 	((sps)->profile_idc == 100 || (sps)->profile_idc == 110 || \
1377 	 (sps)->profile_idc == 122 || (sps)->profile_idc == 244 || \
1378 	 (sps)->profile_idc == 44  || (sps)->profile_idc == 83  || \
1379 	 (sps)->profile_idc == 86  || (sps)->profile_idc == 118 || \
1380 	 (sps)->profile_idc == 128 || (sps)->profile_idc == 138 || \
1381 	 (sps)->profile_idc == 139 || (sps)->profile_idc == 134 || \
1382 	 (sps)->profile_idc == 135)
1386  * struct v4l2_ctrl_h264_sps - H264 sequence parameter set
1442  * struct v4l2_ctrl_h264_pps - H264 picture parameter set
1449  * has a specific meaning. This flag should be set if a non-flat
1452  * to pass the values of the non-flat matrices.
1482  * struct v4l2_ctrl_h264_scaling_matrix - H264 scaling matrices
1494  * matrices as per the H264 specification, see table 7-2 "Assignment
1496  * fall-back rule".
1511 	((((pps)->flags & V4L2_H264_PPS_FLAG_WEIGHTED_PRED) && \
1512 	 ((slice)->slice_type == V4L2_H264_SLICE_TYPE_P || \
1513 	  (slice)->slice_type == V4L2_H264_SLICE_TYPE_SP)) || \
1514 	 ((pps)->weighted_bipred_idc == 1 && \
1515 	  (slice)->slice_type == V4L2_H264_SLICE_TYPE_B))
1519  * struct v4l2_ctrl_h264_pred_weights - Prediction weight table
1548  * struct v4l2_h264_reference - H264 picture reference
1568  * struct v4l2_ctrl_h264_slice_params - H264 slice parameters
1571  * as non-invariant for the slices in a given frame.
1575  * on frame-based decoders, where slice header parsing is done by the
1597  * @ref_pic_list0: reference picture list 0 after applying the per-slice modifications.
1598  * @ref_pic_list1: reference picture list 1 after applying the per-slice modifications.
1630  * struct v4l2_h264_dpb_entry - H264 decoded picture buffer entry
1665  * struct v4l2_ctrl_h264_decode_params - H264 decoding parameters
1712 /* Set if this is a bottom-first (NTSC) interlaced format */
1736 /* A 4-values flag - the number of components - 1 */
1740 /* A 4-values flag - the pixel encoding type */
1749  * struct v4l2_ctrl_fwht_params - FWHT parameters
1783  * struct v4l2_vp8_segment - VP8 segment-based adjustments parameters
1791  * This structure contains segment-based adjustments related parameters.
1793  * and section '9.3. Segment-Based Adjustments' of the VP8 specification
1809  * struct v4l2_vp8_loop_filter - VP8 loop filter parameters
1833  * struct v4l2_vp8_quantization - VP8 quantizattion indices
1862  * struct v4l2_vp8_entropy - VP8 update probabilities
1865  * @y_mode_probs: luma intra-prediction probabilities.
1866  * @uv_mode_probs: chroma intra-prediction probabilities.
1884  * struct v4l2_vp8_entropy_coder_state - VP8 boolean coder state
1909 	(!!((hdr)->flags & V4L2_VP8_FRAME_FLAG_KEY_FRAME))
1913  * struct v4l2_ctrl_vp8_frame - VP8 frame parameters
1924  * @version: bitstream version.
1971 /* Stateless MPEG-2 controls */
1977  * struct v4l2_ctrl_mpeg2_sequence - MPEG-2 sequence header
1980  * extension syntaxes as specified by the MPEG-2 specification.
1992  * @profile_and_level_indication: see MPEG-2 specification.
1993  * @chroma_format: see MPEG-2 specification.
2025  * struct v4l2_ctrl_mpeg2_picture - MPEG-2 picture header
2028  * coding extension syntaxes as specified by the MPEG-2 specification.
2037  * @f_code: see MPEG-2 specification.
2038  * @picture_coding_type: see MPEG-2 specification.
2040  * @intra_dc_precision: see MPEG-2 specification.
2056  * struct v4l2_ctrl_mpeg2_quantisation - MPEG-2 quantisation
2062  * for intra-coded frames, in zigzag scanning order. It is relevant
2064  * by the chroma-specific matrix for non-4:2:0 YUV formats.
2066  * for non-intra-coded frames, in zigzag scanning order. It is relevant
2068  * by the chroma-specific matrix for non-4:2:0 YUV formats.
2070  * for the chominance component of intra-coded frames, in zigzag scanning
2073  * for the chrominance component of non-intra-coded frames, in zigzag scanning
2117  * struct v4l2_ctrl_hevc_sps - ITU-T Rec. H.265: Sequence parameter set
2170  * @num_long_term_ref_pics_sps: specifies the number of candidate long-term
2174  *                             of temporal sub-layers
2231  * struct v4l2_ctrl_hevc_pps - ITU-T Rec. H.265: Picture parameter set
2306  * struct v4l2_hevc_dpb_entry - HEVC decoded picture buffer entry
2323  * struct v4l2_hevc_pred_weight_table - HEVC weighted prediction parameters
2374  * struct v4l2_ctrl_hevc_slice_params - HEVC slice parameters
2376  * This control is a dynamically sized 1-dimensional array,
2415  * @short_term_ref_pic_set_size: specifies the size of short-term reference
2417  * @long_term_ref_pic_set_size: specifies the size of long-term reference
2419  * @pred_weight_table: the prediction weight coefficients for inter-picture
2429 	/* ISO/IEC 23008-2, ITU-T Rec. H.265: NAL unit header */
2433 	/* ISO/IEC 23008-2, ITU-T Rec. H.265: General slice segment header */
2450 	/* ISO/IEC 23008-2, ITU-T Rec. H.265: Picture timing SEI message */
2454 	/* ISO/IEC 23008-2, ITU-T Rec. H.265: General slice segment header */
2461 	/* ISO/IEC 23008-2, ITU-T Rec. H.265: Weighted prediction parameter */
2473  * struct v4l2_ctrl_hevc_decode_params - HEVC decode parameters
2476  * @short_term_ref_pic_set_size: specifies the size of short-term reference
2478  * @long_term_ref_pic_set_size: specifies the size of long-term reference
2481  * @num_poc_st_curr_before: the number of reference pictures in the short-term
2483  * @num_poc_st_curr_after: the number of reference pictures in the short-term
2485  * @num_poc_lt_curr: the number of reference pictures in the long-term set
2495  * @dpb: the decoded picture buffer, for meta-data about reference frames
2516  * struct v4l2_ctrl_hevc_scaling_matrix - HEVC scaling lists parameters
2586  * struct v4l2_vp9_loop_filter - VP9 loop filter parameters
2589  * chosen reference frame. If this syntax element is not present in the bitstream,
2592  * chosen mode.	If this syntax element is not present in the bitstream, users should
2612  * struct v4l2_vp9_quantization - VP9 quantization parameters
2647  * struct v4l2_vp9_segmentation - VP9 segmentation parameters
2656  * Segment-ID. See '5.15. Segmentation map' section of the VP9 specification
2659  * Predicted-Segment-ID. See '6.4.14. Get segment id syntax' section of :ref:`vp9`
2709  * struct v4l2_ctrl_vp9_frame - VP9 frame decoding control
2781  * struct v4l2_vp9_mv_probs - VP9 Motion vector probability updates
2817  * struct v4l2_ctrl_vp9_compressed_hdr - VP9 probability updates control
2826  * @is_inter: is inter-block probability updates.
2904  * struct v4l2_ctrl_av1_sequence - AV1 Sequence
2934  * struct v4l2_ctrl_av1_tile_group_entry - AV1 Tile Group entry
2959  * enum v4l2_av1_warp_model - AV1 Warp Model as described in section 3
2976  * enum v4l2_av1_reference_frame - AV1 reference frames
3004  * struct v4l2_av1_global_motion - AV1 Global Motion parameters as described in
3028  * enum v4l2_av1_frame_restoration_type - AV1 Frame Restoration Type
3045  * struct v4l2_av1_loop_restoration - AV1 Loop Restauration as described in
3067  * struct v4l2_av1_cdef - AV1 CDEF params semantics as described in section
3094  * enum v4l2_av1_segment_feature - AV1 segment features as described in section
3117  * struct v4l2_av1_segmentation - AV1 Segmentation params as defined in section
3142  * struct v4l2_av1_loop_filter - AV1 Loop filter params as defined in section
3178  * struct v4l2_av1_quantization - AV1 Quantization params as defined in section
3215  * struct v4l2_av1_tile_info - AV1 Tile info as defined in section 6.8.14 "Tile
3248  * enum v4l2_av1_frame_type - AV1 Frame Type
3252  * @V4L2_AV1_INTRA_ONLY_FRAME: Intra-only frame
3263  * enum v4l2_av1_interpolation_filter - AV1 interpolation filter types
3284  * enum v4l2_av1_tx_mode - AV1 Tx mode as described in section 6.8.21 "TX mode
3322  * struct v4l2_ctrl_av1_frame - Represents an AV1 Frame Header OBU.
3361  * only used for non-intra frames and ignored otherwise. order_hints[0] is
3365  * inter-frames. The meaning of this array is the same as in the specification.
3410  * struct v4l2_ctrl_av1_film_grain - AV1 Film Grain parameters.
3417  * @grain_seed: specifies the starting value for the pseudo-random numbers used
3421  * @num_y_points: specifies the number of points for the piece-wise linear
3423  * @point_y_value: represents the x (luma value) coordinate for the i-th point
3428  * @point_y_scaling:  represents the scaling (output) value for the i-th point
3430  * @num_cb_points: specifies the number of points for the piece-wise linear
3432  * @point_cb_value: represents the x coordinate for the i-th point of the
3433  * piece-wise linear scaling function for cb component. The values are signaled
3435  * @point_cb_scaling: represents the scaling (output) value for the i-th point
3437  * @num_cr_points: specifies represents the number of points for the piece-wise
3439  * @point_cr_value:  represents the x coordinate for the i-th point of the
3440  * piece-wise linear scaling function for cr component. The values are signaled
3442  * @point_cr_scaling:  represents the scaling (output) value for the i-th point
3448  * @ar_coeff_lag: specifies the number of auto-regressive coefficients for luma
3450  * @ar_coeffs_y_plus_128: specifies auto-regressive coefficients used for the Y
3452  * @ar_coeffs_cb_plus_128: specifies auto-regressive coefficients used for the U
3454  * @ar_coeffs_cr_plus_128: specifies auto-regressive coefficients used for the V
3456  * @ar_coeff_shift_minus_6: specifies the range of the auto-regressive
3458  * auto-regressive coefficients of [-2, 2), [-1, 1), [-0.5, 0.5) and [-0.25,
3503 /* MPEG-compression definitions kept for backwards compatibility */