Documentation/userspace-api/media/videodev2.h.rst.exceptions

   1 # SPDX-License-Identifier: GPL-2.0
   2
   3 # Ignore header name
   4 ignore define _UAPI__LINUX_VIDEODEV2_H
   5
   6 #
   7 # The cross reference valitator for videodev2.h DocBook never cared
   8 # about enum symbols or defines. Yet, they're all (or almost all?)
   9 # handled inside V4L API sections. So, for now, it is safe to just
  10 # ignore. This should be revisited, as validating it helps to avoid
  11 # having something not documented at the uAPI.
  12 #
  13
  14 # Those symbols should not be used by uAPI - don't document them
  15 ignore symbol V4L2_BUF_TYPE_PRIVATE
  16 ignore symbol V4L2_TUNER_DIGITAL_TV
  17 ignore symbol V4L2_COLORSPACE_BT878
  18
  19 # Documented enum v4l2_field
  20 replace symbol V4L2_FIELD_ALTERNATE :c:type:`v4l2_field`
  21 replace symbol V4L2_FIELD_ANY :c:type:`v4l2_field`
  22 replace symbol V4L2_FIELD_BOTTOM :c:type:`v4l2_field`
  23 replace symbol V4L2_FIELD_INTERLACED :c:type:`v4l2_field`
  24 replace symbol V4L2_FIELD_INTERLACED_BT :c:type:`v4l2_field`
  25 replace symbol V4L2_FIELD_INTERLACED_TB :c:type:`v4l2_field`
  26 replace symbol V4L2_FIELD_NONE :c:type:`v4l2_field`
  27 replace symbol V4L2_FIELD_SEQ_BT :c:type:`v4l2_field`
  28 replace symbol V4L2_FIELD_SEQ_TB :c:type:`v4l2_field`
  29 replace symbol V4L2_FIELD_TOP :c:type:`v4l2_field`
  30
  31 # Documented enum v4l2_buf_type
  32 replace symbol V4L2_BUF_TYPE_META_CAPTURE :c:type:`v4l2_buf_type`
  33 replace symbol V4L2_BUF_TYPE_META_OUTPUT :c:type:`v4l2_buf_type`
  34 replace symbol V4L2_BUF_TYPE_SDR_CAPTURE :c:type:`v4l2_buf_type`
  35 replace symbol V4L2_BUF_TYPE_SDR_OUTPUT :c:type:`v4l2_buf_type`
  36 replace symbol V4L2_BUF_TYPE_SLICED_VBI_CAPTURE :c:type:`v4l2_buf_type`
  37 replace symbol V4L2_BUF_TYPE_SLICED_VBI_OUTPUT :c:type:`v4l2_buf_type`
  38 replace symbol V4L2_BUF_TYPE_VBI_CAPTURE :c:type:`v4l2_buf_type`
  39 replace symbol V4L2_BUF_TYPE_VBI_OUTPUT :c:type:`v4l2_buf_type`
  40 replace symbol V4L2_BUF_TYPE_VIDEO_CAPTURE :c:type:`v4l2_buf_type`
  41 replace symbol V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE :c:type:`v4l2_buf_type`
  42 replace symbol V4L2_BUF_TYPE_VIDEO_OUTPUT :c:type:`v4l2_buf_type`
  43 replace symbol V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE :c:type:`v4l2_buf_type`
  44 replace symbol V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY :c:type:`v4l2_buf_type`
  45 replace symbol V4L2_BUF_TYPE_VIDEO_OVERLAY :c:type:`v4l2_buf_type`
  46
  47 # Documented enum v4l2_tuner_type
  48 replace symbol V4L2_TUNER_ANALOG_TV :c:type:`v4l2_tuner_type`
  49 replace symbol V4L2_TUNER_RADIO :c:type:`v4l2_tuner_type`
  50 replace symbol V4L2_TUNER_RF :c:type:`v4l2_tuner_type`
  51 replace symbol V4L2_TUNER_SDR :c:type:`v4l2_tuner_type`
  52
  53 # Documented enum v4l2_memory
  54 replace symbol V4L2_MEMORY_DMABUF :c:type:`v4l2_memory`
  55 replace symbol V4L2_MEMORY_MMAP :c:type:`v4l2_memory`
  56 replace symbol V4L2_MEMORY_OVERLAY :c:type:`v4l2_memory`
  57 replace symbol V4L2_MEMORY_USERPTR :c:type:`v4l2_memory`
  58
  59 # Documented enum v4l2_colorspace
  60 replace symbol V4L2_COLORSPACE_470_SYSTEM_BG :c:type:`v4l2_colorspace`
  61 replace symbol V4L2_COLORSPACE_470_SYSTEM_M :c:type:`v4l2_colorspace`
  62 replace symbol V4L2_COLORSPACE_OPRGB :c:type:`v4l2_colorspace`
  63 replace define V4L2_COLORSPACE_ADOBERGB :c:type:`v4l2_colorspace`
  64 replace symbol V4L2_COLORSPACE_BT2020 :c:type:`v4l2_colorspace`
  65 replace symbol V4L2_COLORSPACE_DCI_P3 :c:type:`v4l2_colorspace`
  66 replace symbol V4L2_COLORSPACE_DEFAULT :c:type:`v4l2_colorspace`
  67 replace symbol V4L2_COLORSPACE_JPEG :c:type:`v4l2_colorspace`
  68 replace symbol V4L2_COLORSPACE_RAW :c:type:`v4l2_colorspace`
  69 replace symbol V4L2_COLORSPACE_REC709 :c:type:`v4l2_colorspace`
  70 replace symbol V4L2_COLORSPACE_SMPTE170M :c:type:`v4l2_colorspace`
  71 replace symbol V4L2_COLORSPACE_SMPTE240M :c:type:`v4l2_colorspace`
  72 replace symbol V4L2_COLORSPACE_SRGB :c:type:`v4l2_colorspace`
  73 replace symbol V4L2_COLORSPACE_LAST :c:type:`v4l2_colorspace`
  74
  75 # Documented enum v4l2_xfer_func
  76 replace symbol V4L2_XFER_FUNC_709 :c:type:`v4l2_xfer_func`
  77 replace symbol V4L2_XFER_FUNC_OPRGB :c:type:`v4l2_xfer_func`
  78 replace define V4L2_XFER_FUNC_ADOBERGB :c:type:`v4l2_xfer_func`
  79 replace symbol V4L2_XFER_FUNC_DCI_P3 :c:type:`v4l2_xfer_func`
  80 replace symbol V4L2_XFER_FUNC_DEFAULT :c:type:`v4l2_xfer_func`
  81 replace symbol V4L2_XFER_FUNC_NONE :c:type:`v4l2_xfer_func`
  82 replace symbol V4L2_XFER_FUNC_SMPTE2084 :c:type:`v4l2_xfer_func`
  83 replace symbol V4L2_XFER_FUNC_SMPTE240M :c:type:`v4l2_xfer_func`
  84 replace symbol V4L2_XFER_FUNC_SRGB :c:type:`v4l2_xfer_func`
  85 replace symbol V4L2_XFER_FUNC_LAST :c:type:`v4l2_xfer_func`
  86
  87 # Documented enum v4l2_ycbcr_encoding
  88 replace symbol V4L2_YCBCR_ENC_601 :c:type:`v4l2_ycbcr_encoding`
  89 replace symbol V4L2_YCBCR_ENC_709 :c:type:`v4l2_ycbcr_encoding`
  90 replace symbol V4L2_YCBCR_ENC_BT2020 :c:type:`v4l2_ycbcr_encoding`
  91 replace symbol V4L2_YCBCR_ENC_BT2020_CONST_LUM :c:type:`v4l2_ycbcr_encoding`
  92 replace symbol V4L2_YCBCR_ENC_DEFAULT :c:type:`v4l2_ycbcr_encoding`
  93 replace symbol V4L2_YCBCR_ENC_SYCC :c:type:`v4l2_ycbcr_encoding`
  94 replace symbol V4L2_YCBCR_ENC_XV601 :c:type:`v4l2_ycbcr_encoding`
  95 replace symbol V4L2_YCBCR_ENC_XV709 :c:type:`v4l2_ycbcr_encoding`
  96 replace symbol V4L2_YCBCR_ENC_SMPTE240M :c:type:`v4l2_ycbcr_encoding`
  97 replace symbol V4L2_YCBCR_ENC_LAST :c:type:`v4l2_ycbcr_encoding`
  98
  99 # Documented enum v4l2_hsv_encoding
 100 replace symbol V4L2_HSV_ENC_180 :c:type:`v4l2_hsv_encoding`
 101 replace symbol V4L2_HSV_ENC_256 :c:type:`v4l2_hsv_encoding`
 102
 103 # Documented enum v4l2_quantization
 104 replace symbol V4L2_QUANTIZATION_DEFAULT :c:type:`v4l2_quantization`
 105 replace symbol V4L2_QUANTIZATION_FULL_RANGE :c:type:`v4l2_quantization`
 106 replace symbol V4L2_QUANTIZATION_LIM_RANGE :c:type:`v4l2_quantization`
 107
 108 # Documented enum v4l2_priority
 109 replace symbol V4L2_PRIORITY_BACKGROUND :c:type:`v4l2_priority`
 110 replace symbol V4L2_PRIORITY_DEFAULT :c:type:`v4l2_priority`
 111 replace symbol V4L2_PRIORITY_INTERACTIVE :c:type:`v4l2_priority`
 112 replace symbol V4L2_PRIORITY_RECORD :c:type:`v4l2_priority`
 113 replace symbol V4L2_PRIORITY_UNSET :c:type:`v4l2_priority`
 114
 115 # Documented enum v4l2_frmsizetypes
 116 replace symbol V4L2_FRMSIZE_TYPE_CONTINUOUS :c:type:`v4l2_frmsizetypes`
 117 replace symbol V4L2_FRMSIZE_TYPE_DISCRETE :c:type:`v4l2_frmsizetypes`
 118 replace symbol V4L2_FRMSIZE_TYPE_STEPWISE :c:type:`v4l2_frmsizetypes`
 119
 120 # Documented enum frmivaltypes
 121 replace symbol V4L2_FRMIVAL_TYPE_CONTINUOUS :c:type:`v4l2_frmivaltypes`
 122 replace symbol V4L2_FRMIVAL_TYPE_DISCRETE :c:type:`v4l2_frmivaltypes`
 123 replace symbol V4L2_FRMIVAL_TYPE_STEPWISE :c:type:`v4l2_frmivaltypes`
 124
 125 # Documented enum :c:type:`v4l2_ctrl_type`
 126 replace symbol V4L2_CTRL_COMPOUND_TYPES vidioc_queryctrl
 127
 128 replace symbol V4L2_CTRL_TYPE_BITMASK :c:type:`v4l2_ctrl_type`
 129 replace symbol V4L2_CTRL_TYPE_BOOLEAN :c:type:`v4l2_ctrl_type`
 130 replace symbol V4L2_CTRL_TYPE_BUTTON :c:type:`v4l2_ctrl_type`
 131 replace symbol V4L2_CTRL_TYPE_CTRL_CLASS :c:type:`v4l2_ctrl_type`
 132 replace symbol V4L2_CTRL_TYPE_INTEGER :c:type:`v4l2_ctrl_type`
 133 replace symbol V4L2_CTRL_TYPE_INTEGER64 :c:type:`v4l2_ctrl_type`
 134 replace symbol V4L2_CTRL_TYPE_INTEGER_MENU :c:type:`v4l2_ctrl_type`
 135 replace symbol V4L2_CTRL_TYPE_MENU :c:type:`v4l2_ctrl_type`
 136 replace symbol V4L2_CTRL_TYPE_STRING :c:type:`v4l2_ctrl_type`
 137 replace symbol V4L2_CTRL_TYPE_U16 :c:type:`v4l2_ctrl_type`
 138 replace symbol V4L2_CTRL_TYPE_U32 :c:type:`v4l2_ctrl_type`
 139 replace symbol V4L2_CTRL_TYPE_U8 :c:type:`v4l2_ctrl_type`
 140 replace symbol V4L2_CTRL_TYPE_MPEG2_SEQUENCE :c:type:`v4l2_ctrl_type`
 141 replace symbol V4L2_CTRL_TYPE_MPEG2_PICTURE :c:type:`v4l2_ctrl_type`
 142 replace symbol V4L2_CTRL_TYPE_MPEG2_QUANTISATION :c:type:`v4l2_ctrl_type`
 143 replace symbol V4L2_CTRL_TYPE_H264_SPS :c:type:`v4l2_ctrl_type`
 144 replace symbol V4L2_CTRL_TYPE_H264_PPS :c:type:`v4l2_ctrl_type`
 145 replace symbol V4L2_CTRL_TYPE_H264_SCALING_MATRIX :c:type:`v4l2_ctrl_type`
 146 replace symbol V4L2_CTRL_TYPE_H264_PRED_WEIGHTS :c:type:`v4l2_ctrl_type`
 147 replace symbol V4L2_CTRL_TYPE_H264_SLICE_PARAMS :c:type:`v4l2_ctrl_type`
 148 replace symbol V4L2_CTRL_TYPE_H264_DECODE_PARAMS :c:type:`v4l2_ctrl_type`
 149 replace symbol V4L2_CTRL_TYPE_HEVC_SPS :c:type:`v4l2_ctrl_type`
 150 replace symbol V4L2_CTRL_TYPE_HEVC_PPS :c:type:`v4l2_ctrl_type`
 151 replace symbol V4L2_CTRL_TYPE_HEVC_SLICE_PARAMS :c:type:`v4l2_ctrl_type`
 152 replace symbol V4L2_CTRL_TYPE_AREA :c:type:`v4l2_ctrl_type`
 153 replace symbol V4L2_CTRL_TYPE_FWHT_PARAMS :c:type:`v4l2_ctrl_type`
 154 replace symbol V4L2_CTRL_TYPE_VP8_FRAME :c:type:`v4l2_ctrl_type`
 155 replace symbol V4L2_CTRL_TYPE_VP9_COMPRESSED_HDR :c:type:`v4l2_ctrl_type`
 156 replace symbol V4L2_CTRL_TYPE_VP9_FRAME :c:type:`v4l2_ctrl_type`
 157 replace symbol V4L2_CTRL_TYPE_HDR10_CLL_INFO :c:type:`v4l2_ctrl_type`
 158 replace symbol V4L2_CTRL_TYPE_HDR10_MASTERING_DISPLAY :c:type:`v4l2_ctrl_type`
 159 replace symbol V4L2_CTRL_TYPE_HEVC_SPS :c:type:`v4l2_ctrl_type`
 160 replace symbol V4L2_CTRL_TYPE_HEVC_PPS :c:type:`v4l2_ctrl_type`
 161 replace symbol V4L2_CTRL_TYPE_HEVC_SLICE_PARAMS :c:type:`v4l2_ctrl_type`
 162 replace symbol V4L2_CTRL_TYPE_HEVC_SCALING_MATRIX :c:type:`v4l2_ctrl_type`
 163 replace symbol V4L2_CTRL_TYPE_HEVC_DECODE_PARAMS :c:type:`v4l2_ctrl_type`
 164
 165 # V4L2 capability defines
 166 replace define V4L2_CAP_VIDEO_CAPTURE device-capabilities
 167 replace define V4L2_CAP_VIDEO_CAPTURE_MPLANE device-capabilities
 168 replace define V4L2_CAP_VIDEO_OUTPUT device-capabilities
 169 replace define V4L2_CAP_VIDEO_OUTPUT_MPLANE device-capabilities
 170 replace define V4L2_CAP_VIDEO_M2M device-capabilities
 171 replace define V4L2_CAP_VIDEO_M2M_MPLANE device-capabilities
 172 replace define V4L2_CAP_VIDEO_OVERLAY device-capabilities
 173 replace define V4L2_CAP_VBI_CAPTURE device-capabilities
 174 replace define V4L2_CAP_VBI_OUTPUT device-capabilities
 175 replace define V4L2_CAP_SLICED_VBI_CAPTURE device-capabilities
 176 replace define V4L2_CAP_SLICED_VBI_OUTPUT device-capabilities
 177 replace define V4L2_CAP_RDS_CAPTURE device-capabilities
 178 replace define V4L2_CAP_VIDEO_OUTPUT_OVERLAY device-capabilities
 179 replace define V4L2_CAP_HW_FREQ_SEEK device-capabilities
 180 replace define V4L2_CAP_RDS_OUTPUT device-capabilities
 181 replace define V4L2_CAP_TUNER device-capabilities
 182 replace define V4L2_CAP_AUDIO device-capabilities
 183 replace define V4L2_CAP_RADIO device-capabilities
 184 replace define V4L2_CAP_MODULATOR device-capabilities
 185 replace define V4L2_CAP_SDR_CAPTURE device-capabilities
 186 replace define V4L2_CAP_EXT_PIX_FORMAT device-capabilities
 187 replace define V4L2_CAP_SDR_OUTPUT device-capabilities
 188 replace define V4L2_CAP_META_CAPTURE device-capabilities
 189 replace define V4L2_CAP_READWRITE device-capabilities
 190 replace define V4L2_CAP_ASYNCIO device-capabilities
 191 replace define V4L2_CAP_STREAMING device-capabilities
 192 replace define V4L2_CAP_META_OUTPUT device-capabilities
 193 replace define V4L2_CAP_DEVICE_CAPS device-capabilities
 194 replace define V4L2_CAP_TOUCH device-capabilities
 195 replace define V4L2_CAP_IO_MC device-capabilities
 196
 197 # V4L2 pix flags
 198 replace define V4L2_PIX_FMT_PRIV_MAGIC :c:type:`v4l2_pix_format`
 199 replace define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA format-flags
 200 replace define V4L2_PIX_FMT_HM12 :c:type:`v4l2_pix_format`
 201 replace define V4L2_PIX_FMT_SUNXI_TILED_NV12 :c:type:`v4l2_pix_format`
 202
 203 # V4L2 format flags
 204 replace define V4L2_FMT_FLAG_COMPRESSED fmtdesc-flags
 205 replace define V4L2_FMT_FLAG_EMULATED fmtdesc-flags
 206 replace define V4L2_FMT_FLAG_CONTINUOUS_BYTESTREAM fmtdesc-flags
 207 replace define V4L2_FMT_FLAG_DYN_RESOLUTION fmtdesc-flags
 208 replace define V4L2_FMT_FLAG_ENC_CAP_FRAME_INTERVAL fmtdesc-flags
 209 replace define V4L2_FMT_FLAG_CSC_COLORSPACE fmtdesc-flags
 210 replace define V4L2_FMT_FLAG_CSC_XFER_FUNC fmtdesc-flags
 211 replace define V4L2_FMT_FLAG_CSC_YCBCR_ENC fmtdesc-flags
 212 replace define V4L2_FMT_FLAG_CSC_HSV_ENC fmtdesc-flags
 213 replace define V4L2_FMT_FLAG_CSC_QUANTIZATION fmtdesc-flags
 214
 215 # V4L2 timecode types
 216 replace define V4L2_TC_TYPE_24FPS timecode-type
 217 replace define V4L2_TC_TYPE_25FPS timecode-type
 218 replace define V4L2_TC_TYPE_30FPS timecode-type
 219 replace define V4L2_TC_TYPE_50FPS timecode-type
 220 replace define V4L2_TC_TYPE_60FPS timecode-type
 221
 222 # V4L2 timecode flags
 223 replace define V4L2_TC_FLAG_DROPFRAME timecode-flags
 224 replace define V4L2_TC_FLAG_COLORFRAME timecode-flags
 225 replace define V4L2_TC_USERBITS_field timecode-flags
 226 replace define V4L2_TC_USERBITS_USERDEFINED timecode-flags
 227 replace define V4L2_TC_USERBITS_8BITCHARS timecode-flags
 228
 229 # V4L2 JPEG markers
 230 replace define V4L2_JPEG_MARKER_DHT jpeg-markers
 231 replace define V4L2_JPEG_MARKER_DQT jpeg-markers
 232 replace define V4L2_JPEG_MARKER_DRI jpeg-markers
 233 replace define V4L2_JPEG_MARKER_COM jpeg-markers
 234 replace define V4L2_JPEG_MARKER_APP jpeg-markers
 235
 236 # V4L2 framebuffer caps and flags
 237
 238 replace define V4L2_FBUF_CAP_EXTERNOVERLAY framebuffer-cap
 239 replace define V4L2_FBUF_CAP_CHROMAKEY framebuffer-cap
 240 replace define V4L2_FBUF_CAP_LIST_CLIPPING framebuffer-cap
 241 replace define V4L2_FBUF_CAP_BITMAP_CLIPPING framebuffer-cap
 242 replace define V4L2_FBUF_CAP_LOCAL_ALPHA framebuffer-cap
 243 replace define V4L2_FBUF_CAP_GLOBAL_ALPHA framebuffer-cap
 244 replace define V4L2_FBUF_CAP_LOCAL_INV_ALPHA framebuffer-cap
 245 replace define V4L2_FBUF_CAP_SRC_CHROMAKEY framebuffer-cap
 246
 247 replace define V4L2_FBUF_FLAG_PRIMARY framebuffer-flags
 248 replace define V4L2_FBUF_FLAG_OVERLAY framebuffer-flags
 249 replace define V4L2_FBUF_FLAG_CHROMAKEY framebuffer-flags
 250 replace define V4L2_FBUF_FLAG_LOCAL_ALPHA framebuffer-flags
 251 replace define V4L2_FBUF_FLAG_GLOBAL_ALPHA framebuffer-flags
 252 replace define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA framebuffer-flags
 253 replace define V4L2_FBUF_FLAG_SRC_CHROMAKEY framebuffer-flags
 254
 255 # Used on VIDIOC_G_PARM
 256
 257 replace define V4L2_MODE_HIGHQUALITY parm-flags
 258 replace define V4L2_CAP_TIMEPERFRAME :c:type:`v4l2_captureparm`
 259
 260 # The V4L2_STD_foo are all defined at v4l2_std_id table
 261
 262 replace define V4L2_STD_PAL_B v4l2-std-id
 263 replace define V4L2_STD_PAL_B1 v4l2-std-id
 264 replace define V4L2_STD_PAL_G v4l2-std-id
 265 replace define V4L2_STD_PAL_H v4l2-std-id
 266 replace define V4L2_STD_PAL_I v4l2-std-id
 267 replace define V4L2_STD_PAL_D v4l2-std-id
 268 replace define V4L2_STD_PAL_D1 v4l2-std-id
 269 replace define V4L2_STD_PAL_K v4l2-std-id
 270 replace define V4L2_STD_PAL_M v4l2-std-id
 271 replace define V4L2_STD_PAL_N v4l2-std-id
 272 replace define V4L2_STD_PAL_Nc v4l2-std-id
 273 replace define V4L2_STD_PAL_60 v4l2-std-id
 274 replace define V4L2_STD_NTSC_M v4l2-std-id
 275 replace define V4L2_STD_NTSC_M_JP v4l2-std-id
 276 replace define V4L2_STD_NTSC_443 v4l2-std-id
 277 replace define V4L2_STD_NTSC_M_KR v4l2-std-id
 278 replace define V4L2_STD_SECAM_B v4l2-std-id
 279 replace define V4L2_STD_SECAM_D v4l2-std-id
 280 replace define V4L2_STD_SECAM_G v4l2-std-id
 281 replace define V4L2_STD_SECAM_H v4l2-std-id
 282 replace define V4L2_STD_SECAM_K v4l2-std-id
 283 replace define V4L2_STD_SECAM_K1 v4l2-std-id
 284 replace define V4L2_STD_SECAM_L v4l2-std-id
 285 replace define V4L2_STD_SECAM_LC v4l2-std-id
 286 replace define V4L2_STD_ATSC_8_VSB v4l2-std-id
 287 replace define V4L2_STD_ATSC_16_VSB v4l2-std-id
 288 replace define V4L2_STD_NTSC v4l2-std-id
 289 replace define V4L2_STD_SECAM_DK v4l2-std-id
 290 replace define V4L2_STD_SECAM v4l2-std-id
 291 replace define V4L2_STD_PAL_BG v4l2-std-id
 292 replace define V4L2_STD_PAL_DK v4l2-std-id
 293 replace define V4L2_STD_PAL v4l2-std-id
 294 replace define V4L2_STD_B v4l2-std-id
 295 replace define V4L2_STD_G v4l2-std-id
 296 replace define V4L2_STD_H v4l2-std-id
 297 replace define V4L2_STD_L v4l2-std-id
 298 replace define V4L2_STD_GH v4l2-std-id
 299 replace define V4L2_STD_DK v4l2-std-id
 300 replace define V4L2_STD_BG v4l2-std-id
 301 replace define V4L2_STD_MN v4l2-std-id
 302 replace define V4L2_STD_MTS v4l2-std-id
 303 replace define V4L2_STD_525_60 v4l2-std-id
 304 replace define V4L2_STD_625_50 v4l2-std-id
 305 replace define V4L2_STD_ATSC v4l2-std-id
 306 replace define V4L2_STD_UNKNOWN v4l2-std-id
 307 replace define V4L2_STD_ALL v4l2-std-id
 308
 309 # V4L2 DT BT timings definitions
 310
 311 replace define V4L2_DV_PROGRESSIVE :c:type:`v4l2_bt_timings`
 312 replace define V4L2_DV_INTERLACED :c:type:`v4l2_bt_timings`
 313
 314 replace define V4L2_DV_VSYNC_POS_POL :c:type:`v4l2_bt_timings`
 315 replace define V4L2_DV_HSYNC_POS_POL :c:type:`v4l2_bt_timings`
 316
 317 replace define V4L2_DV_BT_STD_CEA861 dv-bt-standards
 318 replace define V4L2_DV_BT_STD_DMT dv-bt-standards
 319 replace define V4L2_DV_BT_STD_CVT dv-bt-standards
 320 replace define V4L2_DV_BT_STD_GTF dv-bt-standards
 321 replace define V4L2_DV_BT_STD_SDI dv-bt-standards
 322
 323 replace define V4L2_DV_FL_REDUCED_BLANKING dv-bt-standards
 324 replace define V4L2_DV_FL_CAN_REDUCE_FPS dv-bt-standards
 325 replace define V4L2_DV_FL_CAN_DETECT_REDUCED_FPS dv-bt-standards
 326 replace define V4L2_DV_FL_REDUCED_FPS dv-bt-standards
 327 replace define V4L2_DV_FL_HALF_LINE dv-bt-standards
 328 replace define V4L2_DV_FL_IS_CE_VIDEO dv-bt-standards
 329 replace define V4L2_DV_FL_FIRST_FIELD_EXTRA_LINE dv-bt-standards
 330 replace define V4L2_DV_FL_HAS_PICTURE_ASPECT dv-bt-standards
 331 replace define V4L2_DV_FL_HAS_CEA861_VIC dv-bt-standards
 332 replace define V4L2_DV_FL_HAS_HDMI_VIC dv-bt-standards
 333
 334 replace define V4L2_DV_BT_656_1120 dv-timing-types
 335
 336 replace define V4L2_DV_BT_CAP_INTERLACED framebuffer-cap
 337 replace define V4L2_DV_BT_CAP_PROGRESSIVE framebuffer-cap
 338 replace define V4L2_DV_BT_CAP_REDUCED_BLANKING framebuffer-cap
 339 replace define V4L2_DV_BT_CAP_CUSTOM framebuffer-cap
 340
 341 # V4L2 input
 342
 343 replace define V4L2_INPUT_TYPE_TUNER input-type
 344 replace define V4L2_INPUT_TYPE_CAMERA input-type
 345 replace define V4L2_INPUT_TYPE_TOUCH input-type
 346
 347 replace define V4L2_IN_ST_NO_POWER input-status
 348 replace define V4L2_IN_ST_NO_SIGNAL input-status
 349 replace define V4L2_IN_ST_NO_COLOR input-status
 350 replace define V4L2_IN_ST_HFLIP input-status
 351 replace define V4L2_IN_ST_VFLIP input-status
 352 replace define V4L2_IN_ST_NO_H_LOCK input-status
 353 replace define V4L2_IN_ST_COLOR_KILL input-status
 354 replace define V4L2_IN_ST_NO_SYNC input-status
 355 replace define V4L2_IN_ST_NO_EQU input-status
 356 replace define V4L2_IN_ST_NO_CARRIER input-status
 357 replace define V4L2_IN_ST_MACROVISION input-status
 358 replace define V4L2_IN_ST_NO_ACCESS input-status
 359 replace define V4L2_IN_ST_VTR input-status
 360 replace define V4L2_IN_ST_NO_V_LOCK input-status
 361 replace define V4L2_IN_ST_NO_STD_LOCK input-status
 362
 363 replace define V4L2_IN_CAP_DV_TIMINGS input-capabilities
 364 replace define V4L2_IN_CAP_STD input-capabilities
 365 replace define V4L2_IN_CAP_NATIVE_SIZE input-capabilities
 366
 367 # V4L2 output
 368
 369 replace define V4L2_OUTPUT_TYPE_MODULATOR output-type
 370 replace define V4L2_OUTPUT_TYPE_ANALOG output-type
 371 replace define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY output-type
 372
 373 replace define V4L2_OUT_CAP_DV_TIMINGS output-capabilities
 374 replace define V4L2_OUT_CAP_STD output-capabilities
 375 replace define V4L2_OUT_CAP_NATIVE_SIZE output-capabilities
 376
 377 # V4L2 control flags
 378
 379 replace define V4L2_CTRL_FLAG_DISABLED control-flags
 380 replace define V4L2_CTRL_FLAG_GRABBED control-flags
 381 replace define V4L2_CTRL_FLAG_READ_ONLY control-flags
 382 replace define V4L2_CTRL_FLAG_UPDATE control-flags
 383 replace define V4L2_CTRL_FLAG_INACTIVE control-flags
 384 replace define V4L2_CTRL_FLAG_SLIDER control-flags
 385 replace define V4L2_CTRL_FLAG_WRITE_ONLY control-flags
 386 replace define V4L2_CTRL_FLAG_VOLATILE control-flags
 387 replace define V4L2_CTRL_FLAG_HAS_PAYLOAD control-flags
 388 replace define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE control-flags
 389 replace define V4L2_CTRL_FLAG_MODIFY_LAYOUT control-flags
 390 replace define V4L2_CTRL_FLAG_DYNAMIC_ARRAY control-flags
 391
 392 replace define V4L2_CTRL_FLAG_NEXT_CTRL control
 393 replace define V4L2_CTRL_FLAG_NEXT_COMPOUND control
 394 replace define V4L2_CID_PRIVATE_BASE control
 395
 396 # V4L2 tuner
 397
 398 replace define V4L2_TUNER_CAP_LOW tuner-capability
 399 replace define V4L2_TUNER_CAP_NORM tuner-capability
 400 replace define V4L2_TUNER_CAP_HWSEEK_BOUNDED tuner-capability
 401 replace define V4L2_TUNER_CAP_HWSEEK_WRAP tuner-capability
 402 replace define V4L2_TUNER_CAP_STEREO tuner-capability
 403 replace define V4L2_TUNER_CAP_LANG2 tuner-capability
 404 replace define V4L2_TUNER_CAP_SAP tuner-capability
 405 replace define V4L2_TUNER_CAP_LANG1 tuner-capability
 406 replace define V4L2_TUNER_CAP_RDS tuner-capability
 407 replace define V4L2_TUNER_CAP_RDS_BLOCK_IO tuner-capability
 408 replace define V4L2_TUNER_CAP_RDS_CONTROLS tuner-capability
 409 replace define V4L2_TUNER_CAP_FREQ_BANDS tuner-capability
 410 replace define V4L2_TUNER_CAP_HWSEEK_PROG_LIM tuner-capability
 411 replace define V4L2_TUNER_CAP_1HZ tuner-capability
 412
 413 replace define V4L2_TUNER_SUB_MONO tuner-rxsubchans
 414 replace define V4L2_TUNER_SUB_STEREO tuner-rxsubchans
 415 replace define V4L2_TUNER_SUB_LANG2 tuner-rxsubchans
 416 replace define V4L2_TUNER_SUB_SAP tuner-rxsubchans
 417 replace define V4L2_TUNER_SUB_LANG1 tuner-rxsubchans
 418 replace define V4L2_TUNER_SUB_RDS tuner-rxsubchans
 419
 420 replace define V4L2_TUNER_MODE_MONO tuner-audmode
 421 replace define V4L2_TUNER_MODE_STEREO tuner-audmode
 422 replace define V4L2_TUNER_MODE_LANG2 tuner-audmode
 423 replace define V4L2_TUNER_MODE_SAP tuner-audmode
 424 replace define V4L2_TUNER_MODE_LANG1 tuner-audmode
 425 replace define V4L2_TUNER_MODE_LANG1_LANG2 tuner-audmode
 426
 427 replace define V4L2_BAND_MODULATION_VSB band-modulation
 428 replace define V4L2_BAND_MODULATION_FM band-modulation
 429 replace define V4L2_BAND_MODULATION_AM band-modulation
 430
 431 replace define V4L2_RDS_BLOCK_MSK v4l2-rds-block
 432 replace define V4L2_RDS_BLOCK_A v4l2-rds-block
 433 replace define V4L2_RDS_BLOCK_B v4l2-rds-block
 434 replace define V4L2_RDS_BLOCK_C v4l2-rds-block
 435 replace define V4L2_RDS_BLOCK_D v4l2-rds-block
 436 replace define V4L2_RDS_BLOCK_C_ALT v4l2-rds-block
 437 replace define V4L2_RDS_BLOCK_INVALID v4l2-rds-block
 438 replace define V4L2_RDS_BLOCK_CORRECTED v4l2-rds-block
 439 replace define V4L2_RDS_BLOCK_ERROR v4l2-rds-block
 440
 441 # V4L2 audio
 442
 443 replace define V4L2_AUDCAP_STEREO audio-capability
 444 replace define V4L2_AUDCAP_AVL audio-capability
 445
 446 replace define V4L2_AUDMODE_AVL audio-mode
 447
 448 # MPEG
 449
 450 replace define V4L2_ENC_IDX_FRAME_I :c:type:`v4l2_enc_idx`
 451 replace define V4L2_ENC_IDX_FRAME_P :c:type:`v4l2_enc_idx`
 452 replace define V4L2_ENC_IDX_FRAME_B :c:type:`v4l2_enc_idx`
 453 replace define V4L2_ENC_IDX_FRAME_MASK :c:type:`v4l2_enc_idx`
 454 replace define V4L2_ENC_IDX_ENTRIES :c:type:`v4l2_enc_idx`
 455
 456 replace define V4L2_ENC_CMD_START encoder-cmds
 457 replace define V4L2_ENC_CMD_STOP encoder-cmds
 458 replace define V4L2_ENC_CMD_PAUSE encoder-cmds
 459 replace define V4L2_ENC_CMD_RESUME encoder-cmds
 460
 461 replace define V4L2_ENC_CMD_STOP_AT_GOP_END encoder-flags
 462
 463 replace define V4L2_DEC_CMD_START decoder-cmds
 464 replace define V4L2_DEC_CMD_STOP decoder-cmds
 465 replace define V4L2_DEC_CMD_PAUSE decoder-cmds
 466 replace define V4L2_DEC_CMD_RESUME decoder-cmds
 467 replace define V4L2_DEC_CMD_FLUSH decoder-cmds
 468
 469 replace define V4L2_DEC_CMD_START_MUTE_AUDIO decoder-cmds
 470 replace define V4L2_DEC_CMD_PAUSE_TO_BLACK decoder-cmds
 471 replace define V4L2_DEC_CMD_STOP_TO_BLACK decoder-cmds
 472 replace define V4L2_DEC_CMD_STOP_IMMEDIATELY decoder-cmds
 473
 474 replace define V4L2_DEC_START_FMT_NONE decoder-cmds
 475 replace define V4L2_DEC_START_FMT_GOP decoder-cmds
 476
 477 # V4L2 VBI
 478
 479 replace define V4L2_VBI_UNSYNC vbifmt-flags
 480 replace define V4L2_VBI_INTERLACED vbifmt-flags
 481
 482 replace define V4L2_VBI_ITU_525_F1_START :c:type:`v4l2_vbi_format`
 483 replace define V4L2_VBI_ITU_525_F2_START :c:type:`v4l2_vbi_format`
 484 replace define V4L2_VBI_ITU_625_F1_START :c:type:`v4l2_vbi_format`
 485 replace define V4L2_VBI_ITU_625_F2_START :c:type:`v4l2_vbi_format`
 486
 487
 488 replace define V4L2_SLICED_TELETEXT_B vbi-services
 489 replace define V4L2_SLICED_VPS vbi-services
 490 replace define V4L2_SLICED_CAPTION_525 vbi-services
 491 replace define V4L2_SLICED_WSS_625 vbi-services
 492 replace define V4L2_SLICED_VBI_525 vbi-services
 493 replace define V4L2_SLICED_VBI_625 vbi-services
 494
 495 replace define V4L2_MPEG_VBI_IVTV_TELETEXT_B ITV0-Line-Identifier-Constants
 496 replace define V4L2_MPEG_VBI_IVTV_CAPTION_525 ITV0-Line-Identifier-Constants
 497 replace define V4L2_MPEG_VBI_IVTV_WSS_625 ITV0-Line-Identifier-Constants
 498 replace define V4L2_MPEG_VBI_IVTV_VPS ITV0-Line-Identifier-Constants
 499
 500 replace define V4L2_MPEG_VBI_IVTV_MAGIC0 v4l2-mpeg-vbi-fmt-ivtv-magic
 501 replace define V4L2_MPEG_VBI_IVTV_MAGIC1 v4l2-mpeg-vbi-fmt-ivtv-magic
 502
 503 # V4L2 events
 504
 505 replace define V4L2_EVENT_ALL event-type
 506 replace define V4L2_EVENT_VSYNC event-type
 507 replace define V4L2_EVENT_EOS event-type
 508 replace define V4L2_EVENT_CTRL event-type
 509 replace define V4L2_EVENT_FRAME_SYNC event-type
 510 replace define V4L2_EVENT_SOURCE_CHANGE event-type
 511 replace define V4L2_EVENT_MOTION_DET event-type
 512 replace define V4L2_EVENT_PRIVATE_START event-type
 513
 514 replace define V4L2_EVENT_CTRL_CH_VALUE ctrl-changes-flags
 515 replace define V4L2_EVENT_CTRL_CH_FLAGS ctrl-changes-flags
 516 replace define V4L2_EVENT_CTRL_CH_RANGE ctrl-changes-flags
 517 replace define V4L2_EVENT_CTRL_CH_DIMENSIONS ctrl-changes-flags
 518
 519 replace define V4L2_EVENT_SRC_CH_RESOLUTION src-changes-flags
 520
 521 replace define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ :c:type:`v4l2_event_motion_det`
 522
 523 replace define V4L2_EVENT_SUB_FL_SEND_INITIAL event-flags
 524 replace define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK event-flags
 525
 526 # V4L2 debugging
 527 replace define V4L2_CHIP_MATCH_BRIDGE vidioc_dbg_g_register
 528 replace define V4L2_CHIP_MATCH_SUBDEV vidioc_dbg_g_register
 529 replace define V4L2_CHIP_MATCH_HOST vidioc_dbg_g_register
 530 replace define V4L2_CHIP_MATCH_I2C_DRIVER vidioc_dbg_g_register
 531 replace define V4L2_CHIP_MATCH_I2C_ADDR vidioc_dbg_g_register
 532 replace define V4L2_CHIP_MATCH_AC97 vidioc_dbg_g_register
 533
 534 replace define V4L2_CHIP_FL_READABLE vidioc_dbg_g_register
 535 replace define V4L2_CHIP_FL_WRITABLE vidioc_dbg_g_register
 536
 537 # Ignore reserved ioctl and ancillary macros
 538
 539 ignore define VIDEO_MAX_FRAME
 540 ignore define VIDEO_MAX_PLANES
 541 ignore define v4l2_fourcc
 542 ignore define v4l2_fourcc_be
 543 ignore define V4L2_FIELD_HAS_TOP
 544 ignore define V4L2_FIELD_HAS_BOTTOM
 545 ignore define V4L2_FIELD_HAS_BOTH
 546 ignore define V4L2_FIELD_HAS_T_OR_B
 547 ignore define V4L2_TYPE_IS_MULTIPLANAR
 548 ignore define V4L2_TYPE_IS_OUTPUT
 549 ignore define V4L2_TUNER_ADC
 550 ignore define V4L2_MAP_COLORSPACE_DEFAULT
 551 ignore define V4L2_MAP_XFER_FUNC_DEFAULT
 552 ignore define V4L2_MAP_YCBCR_ENC_DEFAULT
 553 ignore define V4L2_DV_BT_BLANKING_WIDTH
 554 ignore define V4L2_DV_BT_FRAME_WIDTH
 555 ignore define V4L2_DV_BT_BLANKING_HEIGHT
 556 ignore define V4L2_DV_BT_FRAME_HEIGHT
 557 ignore define V4L2_IN_CAP_CUSTOM_TIMINGS
 558 ignore define V4L2_CTRL_ID_MASK
 559 ignore define V4L2_CTRL_ID2CLASS
 560 ignore define V4L2_CTRL_ID2WHICH
 561 ignore define V4L2_CTRL_DRIVER_PRIV
 562 ignore define V4L2_CTRL_MAX_DIMS
 563 ignore define V4L2_CTRL_WHICH_CUR_VAL
 564 ignore define V4L2_CTRL_WHICH_DEF_VAL
 565 ignore define V4L2_CTRL_WHICH_REQUEST_VAL
 566 ignore define V4L2_OUT_CAP_CUSTOM_TIMINGS
 567 ignore define V4L2_CID_MAX_CTRLS
 568
 569 ignore define BASE_VIDIOC_PRIVATE
 570
 571 # Associate ioctls with their counterparts
 572 replace ioctl VIDIOC_DBG_S_REGISTER vidioc_dbg_g_register
 573 replace ioctl VIDIOC_DQBUF vidioc_qbuf
 574 replace ioctl VIDIOC_S_AUDOUT vidioc_g_audout
 575 replace ioctl VIDIOC_S_CROP vidioc_g_crop
 576 replace ioctl VIDIOC_S_CTRL vidioc_g_ctrl
 577 replace ioctl VIDIOC_S_DV_TIMINGS vidioc_g_dv_timings
 578 replace ioctl VIDIOC_S_EDID vidioc_g_edid
 579 replace ioctl VIDIOC_S_EXT_CTRLS vidioc_g_ext_ctrls
 580 replace ioctl VIDIOC_S_FBUF vidioc_g_fbuf
 581 replace ioctl VIDIOC_S_FMT vidioc_g_fmt
 582 replace ioctl VIDIOC_S_FREQUENCY vidioc_g_frequency
 583 replace ioctl VIDIOC_S_INPUT vidioc_g_input
 584 replace ioctl VIDIOC_S_JPEGCOMP vidioc_g_jpegcomp
 585 replace ioctl VIDIOC_S_MODULATOR vidioc_g_modulator
 586 replace ioctl VIDIOC_S_OUTPUT vidioc_g_output
 587 replace ioctl VIDIOC_S_PARM vidioc_g_parm
 588 replace ioctl VIDIOC_S_PRIORITY vidioc_g_priority
 589 replace ioctl VIDIOC_S_SELECTION vidioc_g_selection
 590 replace ioctl VIDIOC_S_STD vidioc_g_std
 591 replace ioctl VIDIOC_S_AUDIO vidioc_g_audio
 592 replace ioctl VIDIOC_S_TUNER vidioc_g_tuner
 593 replace ioctl VIDIOC_TRY_DECODER_CMD vidioc_decoder_cmd
 594 replace ioctl VIDIOC_TRY_ENCODER_CMD vidioc_encoder_cmd
 595 replace ioctl VIDIOC_TRY_EXT_CTRLS vidioc_g_ext_ctrls
 596 replace ioctl VIDIOC_TRY_FMT vidioc_g_fmt
 597 replace ioctl VIDIOC_STREAMOFF vidioc_streamon
 598 replace ioctl VIDIOC_QUERY_EXT_CTRL vidioc_queryctrl
 599 replace ioctl VIDIOC_QUERYMENU vidioc_queryctrl