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
218 /* MPEG-class control IDs */
228 	V4L2_MPEG_STREAM_TYPE_MPEG2_PS   = 0, /* MPEG-2 program stream */
229 	V4L2_MPEG_STREAM_TYPE_MPEG2_TS   = 1, /* MPEG-2 transport stream */
230 	V4L2_MPEG_STREAM_TYPE_MPEG1_SS   = 2, /* MPEG-1 system stream */
231 	V4L2_MPEG_STREAM_TYPE_MPEG2_DVD  = 3, /* MPEG-2 DVD-compatible stream */
232 	V4L2_MPEG_STREAM_TYPE_MPEG1_VCD  = 4, /* MPEG-1 VCD-compatible stream */
233 	V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD = 5, /* MPEG-2 SVCD-compatible stream */
448 /* CIDs for the MPEG-2 Part 2 (H.262) codec */
821  * enum v4l2_mpeg_video_av1_profile - AV1 profiles
840  * enum v4l2_mpeg_video_av1_level - AV1 levels
901 /*  MPEG-class control IDs specific to the CX2341x driver as defined by V4L2 */
942 /*  MPEG-class control IDs specific to the Samsung MFC 5.1 driver as defined by V4L2 */
1134 /* Flash and privacy (indicator) light controls */
1176 /* JPEG-class control IDs */
1227 /*  DV-class control IDs defined by V4L2 */
1292 /*  Detection-class control IDs defined by V4L2 */
1314  * enum v4l2_stateless_h264_decode_mode - Decoding mode
1336  * enum v4l2_stateless_h264_start_code - Start code
1342  * (legal start codes can be 3-bytes 0x000001 or 4-bytes 0x00000001).
1367 	((sps)->profile_idc == 100 || (sps)->profile_idc == 110 || \
1368 	 (sps)->profile_idc == 122 || (sps)->profile_idc == 244 || \
1369 	 (sps)->profile_idc == 44  || (sps)->profile_idc == 83  || \
1370 	 (sps)->profile_idc == 86  || (sps)->profile_idc == 118 || \
1371 	 (sps)->profile_idc == 128 || (sps)->profile_idc == 138 || \
1372 	 (sps)->profile_idc == 139 || (sps)->profile_idc == 134 || \
1373 	 (sps)->profile_idc == 135)
1377  * struct v4l2_ctrl_h264_sps - H264 sequence parameter set
1433  * struct v4l2_ctrl_h264_pps - H264 picture parameter set
1440  * has a specific meaning. This flag should be set if a non-flat
1443  * to pass the values of the non-flat matrices.
1473  * struct v4l2_ctrl_h264_scaling_matrix - H264 scaling matrices
1485  * matrices as per the H264 specification, see table 7-2 "Assignment
1487  * fall-back rule".
1502 	((((pps)->flags & V4L2_H264_PPS_FLAG_WEIGHTED_PRED) && \
1503 	 ((slice)->slice_type == V4L2_H264_SLICE_TYPE_P || \
1504 	  (slice)->slice_type == V4L2_H264_SLICE_TYPE_SP)) || \
1505 	 ((pps)->weighted_bipred_idc == 1 && \
1506 	  (slice)->slice_type == V4L2_H264_SLICE_TYPE_B))
1510  * struct v4l2_ctrl_h264_pred_weights - Prediction weight table
1539  * struct v4l2_h264_reference - H264 picture reference
1559  * struct v4l2_ctrl_h264_slice_params - H264 slice parameters
1562  * as non-invariant for the slices in a given frame.
1566  * on frame-based decoders, where slice header parsing is done by the
1588  * @ref_pic_list0: reference picture list 0 after applying the per-slice modifications.
1589  * @ref_pic_list1: reference picture list 1 after applying the per-slice modifications.
1621  * struct v4l2_h264_dpb_entry - H264 decoded picture buffer entry
1656  * struct v4l2_ctrl_h264_decode_params - H264 decoding parameters
1703 /* Set if this is a bottom-first (NTSC) interlaced format */
1727 /* A 4-values flag - the number of components - 1 */
1731 /* A 4-values flag - the pixel encoding type */
1740  * struct v4l2_ctrl_fwht_params - FWHT parameters
1774  * struct v4l2_vp8_segment - VP8 segment-based adjustments parameters
1782  * This structure contains segment-based adjustments related parameters.
1784  * and section '9.3. Segment-Based Adjustments' of the VP8 specification
1800  * struct v4l2_vp8_loop_filter - VP8 loop filter parameters
1824  * struct v4l2_vp8_quantization - VP8 quantizattion indices
1853  * struct v4l2_vp8_entropy - VP8 update probabilities
1856  * @y_mode_probs: luma intra-prediction probabilities.
1857  * @uv_mode_probs: chroma intra-prediction probabilities.
1875  * struct v4l2_vp8_entropy_coder_state - VP8 boolean coder state
1900 	(!!((hdr)->flags & V4L2_VP8_FRAME_FLAG_KEY_FRAME))
1904  * struct v4l2_ctrl_vp8_frame - VP8 frame parameters
1915  * @version: bitstream version.
1962 /* Stateless MPEG-2 controls */
1968  * struct v4l2_ctrl_mpeg2_sequence - MPEG-2 sequence header
1971  * extension syntaxes as specified by the MPEG-2 specification.
1983  * @profile_and_level_indication: see MPEG-2 specification.
1984  * @chroma_format: see MPEG-2 specification.
2016  * struct v4l2_ctrl_mpeg2_picture - MPEG-2 picture header
2019  * coding extension syntaxes as specified by the MPEG-2 specification.
2028  * @f_code: see MPEG-2 specification.
2029  * @picture_coding_type: see MPEG-2 specification.
2031  * @intra_dc_precision: see MPEG-2 specification.
2047  * struct v4l2_ctrl_mpeg2_quantisation - MPEG-2 quantisation
2053  * for intra-coded frames, in zigzag scanning order. It is relevant
2055  * by the chroma-specific matrix for non-4:2:0 YUV formats.
2057  * for non-intra-coded frames, in zigzag scanning order. It is relevant
2059  * by the chroma-specific matrix for non-4:2:0 YUV formats.
2061  * for the chominance component of intra-coded frames, in zigzag scanning
2064  * for the chrominance component of non-intra-coded frames, in zigzag scanning
2108  * struct v4l2_ctrl_hevc_sps - ITU-T Rec. H.265: Sequence parameter set
2161  * @num_long_term_ref_pics_sps: specifies the number of candidate long-term
2165  *                             of temporal sub-layers
2222  * struct v4l2_ctrl_hevc_pps - ITU-T Rec. H.265: Picture parameter set
2297  * struct v4l2_hevc_dpb_entry - HEVC decoded picture buffer entry
2314  * struct v4l2_hevc_pred_weight_table - HEVC weighted prediction parameters
2365  * struct v4l2_ctrl_hevc_slice_params - HEVC slice parameters
2367  * This control is a dynamically sized 1-dimensional array,
2406  * @short_term_ref_pic_set_size: specifies the size of short-term reference
2408  * @long_term_ref_pic_set_size: specifies the size of long-term reference
2410  * @pred_weight_table: the prediction weight coefficients for inter-picture
2420 	/* ISO/IEC 23008-2, ITU-T Rec. H.265: NAL unit header */
2424 	/* ISO/IEC 23008-2, ITU-T Rec. H.265: General slice segment header */
2441 	/* ISO/IEC 23008-2, ITU-T Rec. H.265: Picture timing SEI message */
2445 	/* ISO/IEC 23008-2, ITU-T Rec. H.265: General slice segment header */
2452 	/* ISO/IEC 23008-2, ITU-T Rec. H.265: Weighted prediction parameter */
2464  * struct v4l2_ctrl_hevc_decode_params - HEVC decode parameters
2467  * @short_term_ref_pic_set_size: specifies the size of short-term reference
2469  * @long_term_ref_pic_set_size: specifies the size of long-term reference
2472  * @num_poc_st_curr_before: the number of reference pictures in the short-term
2474  * @num_poc_st_curr_after: the number of reference pictures in the short-term
2476  * @num_poc_lt_curr: the number of reference pictures in the long-term set
2486  * @dpb: the decoded picture buffer, for meta-data about reference frames
2507  * struct v4l2_ctrl_hevc_scaling_matrix - HEVC scaling lists parameters
2577  * struct v4l2_vp9_loop_filter - VP9 loop filter parameters
2580  * chosen reference frame. If this syntax element is not present in the bitstream,
2583  * chosen mode.	If this syntax element is not present in the bitstream, users should
2603  * struct v4l2_vp9_quantization - VP9 quantization parameters
2638  * struct v4l2_vp9_segmentation - VP9 segmentation parameters
2647  * Segment-ID. See '5.15. Segmentation map' section of the VP9 specification
2650  * Predicted-Segment-ID. See '6.4.14. Get segment id syntax' section of :ref:`vp9`
2700  * struct v4l2_ctrl_vp9_frame - VP9 frame decoding control
2772  * struct v4l2_vp9_mv_probs - VP9 Motion vector probability updates
2808  * struct v4l2_ctrl_vp9_compressed_hdr - VP9 probability updates control
2817  * @is_inter: is inter-block probability updates.
2895  * struct v4l2_ctrl_av1_sequence - AV1 Sequence
2925  * struct v4l2_ctrl_av1_tile_group_entry - AV1 Tile Group entry
2950  * enum v4l2_av1_warp_model - AV1 Warp Model as described in section 3
2967  * enum v4l2_av1_reference_frame - AV1 reference frames
2995  * struct v4l2_av1_global_motion - AV1 Global Motion parameters as described in
3019  * enum v4l2_av1_frame_restoration_type - AV1 Frame Restoration Type
3036  * struct v4l2_av1_loop_restoration - AV1 Loop Restauration as described in
3058  * struct v4l2_av1_cdef - AV1 CDEF params semantics as described in section
3085  * enum v4l2_av1_segment_feature - AV1 segment features as described in section
3108  * struct v4l2_av1_segmentation - AV1 Segmentation params as defined in section
3133  * struct v4l2_av1_loop_filter - AV1 Loop filter params as defined in section
3169  * struct v4l2_av1_quantization - AV1 Quantization params as defined in section
3206  * struct v4l2_av1_tile_info - AV1 Tile info as defined in section 6.8.14 "Tile
3239  * enum v4l2_av1_frame_type - AV1 Frame Type
3243  * @V4L2_AV1_INTRA_ONLY_FRAME: Intra-only frame
3254  * enum v4l2_av1_interpolation_filter - AV1 interpolation filter types
3275  * enum v4l2_av1_tx_mode - AV1 Tx mode as described in section 6.8.21 "TX mode
3313  * struct v4l2_ctrl_av1_frame - Represents an AV1 Frame Header OBU.
3352  * only used for non-intra frames and ignored otherwise. order_hints[0] is
3356  * inter-frames. The meaning of this array is the same as in the specification.
3401  * struct v4l2_ctrl_av1_film_grain - AV1 Film Grain parameters.
3408  * @grain_seed: specifies the starting value for the pseudo-random numbers used
3412  * @num_y_points: specifies the number of points for the piece-wise linear
3414  * @point_y_value: represents the x (luma value) coordinate for the i-th point
3419  * @point_y_scaling:  represents the scaling (output) value for the i-th point
3421  * @num_cb_points: specifies the number of points for the piece-wise linear
3423  * @point_cb_value: represents the x coordinate for the i-th point of the
3424  * piece-wise linear scaling function for cb component. The values are signaled
3426  * @point_cb_scaling: represents the scaling (output) value for the i-th point
3428  * @num_cr_points: specifies represents the number of points for the piece-wise
3430  * @point_cr_value:  represents the x coordinate for the i-th point of the
3431  * piece-wise linear scaling function for cr component. The values are signaled
3433  * @point_cr_scaling:  represents the scaling (output) value for the i-th point
3439  * @ar_coeff_lag: specifies the number of auto-regressive coefficients for luma
3441  * @ar_coeffs_y_plus_128: specifies auto-regressive coefficients used for the Y
3443  * @ar_coeffs_cb_plus_128: specifies auto-regressive coefficients used for the U
3445  * @ar_coeffs_cr_plus_128: specifies auto-regressive coefficients used for the V
3447  * @ar_coeff_shift_minus_6: specifies the range of the auto-regressive
3449  * auto-regressive coefficients of [-2, 2), [-1, 1), [-0.5, 0.5) and [-0.25,
3494 /* MPEG-compression definitions kept for backwards compatibility */