Lines Matching +full:control +full:- +full:field
1 .. SPDX-License-Identifier: GPL-2.0
13 Each input can be a webcam, TV capture device, S-Video capture device or an HDMI
14 capture device. Each output can be an S-Video output device or an HDMI output
23 - Support for read()/write(), MMAP, USERPTR and DMABUF streaming I/O.
24 - A large list of test patterns and variations thereof
25 - Working brightness, contrast, saturation and hue controls
26 - Support for the alpha color component
27 - Full colorspace support, including limited/full RGB range
28 - All possible control types are present
29 - Support for various pixel aspect ratios and video aspect ratios
30 - Error injection to test what happens if errors occur
31 - Supports crop/compose/scale in any combination for both input and output
32 - Can emulate up to 4K resolutions
33 - All Field settings are supported for testing interlaced capturing
34 - Supports all standard YUV and RGB formats, including two multiplanar YUV formats
35 - Raw and Sliced VBI capture and output support
36 - Radio receiver and transmitter support, including RDS support
37 - Software defined radio (SDR) support
38 - Capture and output overlay support
39 - Metadata capture and output support
40 - Touch capture support
45 ----------------------
48 device with webcam, TV, S-Video and HDMI inputs, a video output device with
49 S-Video and HDMI outputs, one vbi capture device, one vbi output device, one
55 - n_devs:
60 - node_types:
66 - bit 0: Video Capture node
67 - bit 2-3: VBI Capture node: 0 = none, 1 = raw vbi, 2 = sliced vbi, 3 = both
68 - bit 4: Radio Receiver node
69 - bit 5: Software Defined Radio Receiver node
70 - bit 8: Video Output node
71 - bit 10-11: VBI Output node: 0 = none, 1 = raw vbi, 2 = sliced vbi, 3 = both
72 - bit 12: Radio Transmitter node
73 - bit 16: Framebuffer for testing overlays
74 - bit 17: Metadata Capture node
75 - bit 18: Metadata Output node
76 - bit 19: Touch Capture node
82 .. code-block:: none
86 - num_inputs:
92 - input_types:
97 pair gives the type and bits 0-1 map to input 0, bits 2-3 map to input 1,
98 30-31 map to input 15. Each pair of bits has the following meaning:
100 - 00: this is a webcam input
101 - 01: this is a TV tuner input
102 - 10: this is an S-Video input
103 - 11: this is an HDMI input
106 tuner, inputs 1-3 are S-Video inputs and inputs 4-7 are HDMI inputs you
109 .. code-block:: none
113 - num_outputs:
119 - output_types:
127 - 0: this is an S-Video output
128 - 1: this is an HDMI output
130 So to create a video output device with 8 outputs where outputs 0-3 are
131 S-Video outputs and outputs 4-7 are HDMI outputs you would use the
134 .. code-block:: none
138 - vid_cap_nr:
141 The default is -1 which will just take the first free number. This allows
144 .. code-block:: none
153 - vid_out_nr:
156 The default is -1 which will just take the first free number.
158 - vbi_cap_nr:
161 The default is -1 which will just take the first free number.
163 - vbi_out_nr:
166 The default is -1 which will just take the first free number.
168 - radio_rx_nr:
171 The default is -1 which will just take the first free number.
173 - radio_tx_nr:
176 device. The default is -1 which will just take the first free number.
178 - sdr_cap_nr:
181 The default is -1 which will just take the first free number.
183 - meta_cap_nr:
186 The default is -1 which will just take the first free number.
188 - meta_out_nr:
191 The default is -1 which will just take the first free number.
193 - touch_cap_nr:
195 give the desired v4l-touchX start number for each touch capture device.
196 The default is -1 which will just take the first free number.
198 - ccs_cap_mode:
206 The value is either -1 (controlled by the user) or a set of three bits,
209 - bit 0:
213 - bit 1:
218 - bit 2:
223 very simple and low-quality. Simplicity and speed were
230 - ccs_out_mode:
238 The value is either -1 (controlled by the user) or a set of three bits,
241 - bit 0:
246 - bit 1:
251 - bit 2:
256 very simple and low-quality. Simplicity and speed were
259 - multiplanar:
261 select whether each device instance supports multi-planar formats,
262 and thus the V4L2 multi-planar API. By default device instances are
263 single-planar.
267 - 1: this is a single-planar instance.
268 - 2: this is a multi-planar instance.
270 - vivid_debug:
274 - no_error_inj:
277 needed in order to run a tool like v4l2-compliance. Tools like that
278 exercise all controls including a control like 'Disconnect' which
280 all tests that v4l2-compliance is doing will fail afterwards.
288 - allocators:
293 - 0: vmalloc
294 - 1: dma-contig
296 - cache_hints:
298 specifies if the device should set queues' user-space cache and memory
302 - 0: forbid hints
303 - 1: allow hints
312 -------------
317 four inputs are configured: a webcam, a TV tuner, an S-Video and an HDMI
324 but the long-term behavior is exactly following the framerate. So a
327 frame/field sequence counting will keep track of that so the sequence
343 TV and S-Video Inputs
346 The only difference between the TV and S-Video input is that the TV has a
349 These inputs support audio inputs as well: one TV and one Line-In. They
354 These inputs support all combinations of the field setting. Special care has
358 visible. For 50 Hz standards the top field is the oldest and the bottom field
359 is the newest in time. For 60 Hz standards that is reversed: the bottom field
360 is the oldest and the top field is the newest in time.
363 contain the top field for 50 Hz standards and the bottom field for 60 Hz
369 The initially selected colorspace when you switch to the TV or S-Video input
370 will be SMPTE-170M.
373 can be selected through the 'Standard Aspect Ratio' Vivid control.
378 The TV 'tuner' supports a frequency range of 44-958 MHz. Channels are available
380 will be in color for the +/- 0.25 MHz around it, and in grayscale for
381 +/- 1 MHz around the channel. Beyond that it is just noise. The VIDIOC_G_TUNER
382 ioctl will return 100% signal strength for +/- 0.25 MHz and 50% for +/- 1 MHz.
386 The audio subchannels that are returned are MONO for the +/- 1 MHz range around
387 a valid channel frequency. When the frequency is within +/- 0.25 MHz of the
402 The HDMI inputs supports all CEA-861 and DMT timings, both progressive and
403 interlaced, for pixelclock frequencies between 25 and 600 MHz. The field
405 field order is always top field first, and when you start capturing an
406 interlaced format you will receive the top field first.
410 less than or equal to 720x576 the colorspace is set to SMPTE-170M, for
411 others it is set to REC-709 (CEA-861 timings) or sRGB (VESA DMT timings).
418 Vivid control. Choices are 'Source Width x Height' (just use the
434 ------------
438 information), but by default two outputs are configured: an S-Video and an
445 S-Video Output
448 This output supports audio outputs as well: "Line-Out 1" and "Line-Out 2".
449 The S-Video output supports all TV standards.
451 This output supports all combinations of the field setting.
453 The initially selected colorspace when you switch to the TV or S-Video input
454 will be SMPTE-170M.
460 The HDMI output supports all CEA-861 and DMT timings, both progressive and
461 interlaced, for pixelclock frequencies between 25 and 600 MHz. The field
466 less than or equal to 720x576 the colorspace is set to SMPTE-170M, for
467 others it is set to REC-709 (CEA-861 timings) or sRGB (VESA DMT timings).
480 -----------
490 Aspect Ratio control setting and teletext pages 100-159, one page per frame.
492 The VBI device will only work for the S-Video and TV inputs, it will give
497 ----------
506 The VBI device will only work for the S-Video output, it will give
511 --------------
516 - FM: 64 MHz - 108 MHz
517 - AM: 520 kHz - 1710 kHz
518 - SW: 2300 kHz - 26.1 MHz
522 frequency until it becomes 0% at +/- 50 kHz (FM) or 5 kHz (AM/SW) from the
527 modes. In the 'Controls' mode the RDS information is stored in read-only
532 The RDS signal is 'detected' for +/- 12.5 kHz around the channel frequency,
535 blocks if you are +/- 12.5 kHz from the channel frequency. All four errors
543 mode or both, which is configurable with the "Radio HW Seek Mode" control.
547 -----------------
552 - FM: 64 MHz - 108 MHz
553 - AM: 520 kHz - 1710 kHz
554 - SW: 2300 kHz - 26.1 MHz
565 -------------------------------
569 - 300 kHz
570 - 900 kHz - 2800 kHz
571 - 3200 kHz
573 The RF tuner supports 50 MHz - 2000 MHz.
575 The generated data contains the In-phase and Quadrature components of a
580 ----------------
590 ---------------
599 -------------
607 --------
610 each control and which devices support them.
613 User Controls - Test Controls
617 Integer Menu are controls that represent all possible control types. The Menu
618 control and the Integer Menu control both have 'holes' in their menu list,
620 Both menu controls also have a non-zero minimum control value. These features
625 User Controls - Video Capture
631 standard. There is one special feature with the Brightness control: each
634 brightness range (minimum and maximum control values). Switching inputs will
635 cause a control event to be sent with the V4L2_EVENT_CTRL_CH_RANGE flag set.
639 if 'Gain, Automatic' is set, then the Gain control is volatile and changes
640 constantly. If 'Gain, Automatic' is cleared, then the Gain control is a normal
641 control.
647 The 'Alpha Component' control can be used to set the alpha component for
651 User Controls - Audio
658 control the volume and mute the audio. They don't actually do anything in
665 These vivid custom controls control the image generation, error injection, etc.
673 - Test Pattern:
680 - OSD Text Mode:
686 - Horizontal Movement:
691 - Vertical Movement:
695 - Show Border:
697 show a two-pixel wide border at the edge of the actual image,
700 - Show Square:
707 - Insert SAV Code in Image:
713 - Insert EAV Code in Image:
717 - Insert Video Guard Band
725 control and then move the image to the left hand side of the screen.
737 - Sensor Flipped Horizontally:
743 - Sensor Flipped Vertically:
749 - Standard Aspect Ratio:
752 S-Video input should be 4x3, 16x9 or anamorphic widescreen. This may
755 - DV Timings Aspect Ratio:
761 - Timestamp Source:
765 - Colorspace:
777 - Transfer Function:
789 - Y'CbCr Encoding:
798 - Quantization:
806 - Limited RGB Range (16-235):
810 Quantization Range' control and can be used to test what happens if
812 See the description of that control for more details.
814 - Apply Alpha To Red Only:
817 user control to the red color of the test pattern only.
819 - Enable Capture Cropping:
821 enables crop support. This control is only present if
822 the ccs_cap_mode module option is set to the default value of -1 and if
825 - Enable Capture Composing:
827 enables composing support. This control is only
829 -1 and if the no_error_inj module option is set to 0 (the default).
831 - Enable Capture Scaler:
834 and downscaling). This control is only present if the ccs_cap_mode
835 module option is set to the default value of -1 and if the no_error_inj
838 - Maximum EDID Blocks:
845 - Fill Percentage of Frame:
859 - Enable Output Cropping:
861 enables crop support. This control is only present if
862 the ccs_out_mode module option is set to the default value of -1 and if
865 - Enable Output Composing:
867 enables composing support. This control is only
869 -1 and if the no_error_inj module option is set to 0 (the default).
871 - Enable Output Scaler:
874 and downscaling). This control is only present if the ccs_out_mode
875 module option is set to the default value of -1 and if the no_error_inj
884 - Standard Signal Mode:
888 Changing this control will result in the V4L2_EVENT_SOURCE_CHANGE
892 - Standard:
895 previous control is set to "Selected Standard".
897 Changing this control will result in the V4L2_EVENT_SOURCE_CHANGE
903 - DV Timings Signal Mode:
908 Changing this control will result in the V4L2_EVENT_SOURCE_CHANGE
912 - DV Timings:
915 if the previous control is set to "Selected DV Timings".
917 Changing this control will result in the V4L2_EVENT_SOURCE_CHANGE
924 Disconnect control which is valid for all devices.
926 - Wrap Sequence Number:
931 - Wrap Timestamp:
936 - Percentage of Dropped Buffers:
941 - Disconnect:
947 - Inject V4L2_BUF_FLAG_ERROR:
953 - Inject VIDIOC_REQBUFS Error:
957 queue_setup() op will return -EINVAL.
959 - Inject VIDIOC_QBUF Error:
963 precise: the videobuf2 buf_prepare() op will return -EINVAL.
965 - Inject VIDIOC_STREAMON Error:
969 start_streaming() op will return -EINVAL.
971 - Inject Fatal Streaming Error:
982 - Interlaced VBI Format:
985 of providing it grouped by field.
991 - Rx RGB Quantization Range:
994 input. This combines with the Vivid 'Limited RGB Range (16-235)'
995 control and can be used to test what happens if a source provides
997 by selecting an HDMI input, setting this control to Full or Limited
998 range and selecting the opposite in the 'Limited RGB Range (16-235)'
999 control. The effect is easy to see if the 'Gray Ramp' test pattern
1002 - Tx RGB Quantization Range:
1006 transmitters would typically have this control.
1008 - Transmit Mode:
1010 sets the transmit mode of the HDMI output to HDMI or DVI-D. This
1014 - Display Present:
1023 - RDS Reception:
1027 - RDS Program Type:
1030 - RDS PS Name:
1033 - RDS Radio Text:
1036 - RDS Traffic Announcement:
1039 - RDS Traffic Program:
1042 - RDS Music:
1044 these are all read-only controls. If RDS Rx I/O Mode is set to
1053 - Radio HW Seek Mode:
1057 range or wrap-around or if it is selectable by the user.
1059 - Radio Programmable HW Seek:
1065 - Generate RBDS Instead of RDS:
1068 RDS) data instead of RDS (European-style RDS). This affects only the
1071 - RDS Rx I/O Mode:
1081 - RDS Program ID:
1084 - RDS Program Type:
1087 - RDS PS Name:
1090 - RDS Radio Text:
1093 - RDS Stereo:
1096 - RDS Artificial Head:
1099 - RDS Compressed:
1102 - RDS Dynamic PTY:
1105 - RDS Traffic Announcement:
1108 - RDS Traffic Program:
1111 - RDS Music:
1116 - RDS Tx I/O Mode:
1125 - Generate PTS
1129 - Generate SCR
1134 --------------------------
1139 and VBI looping is only supported between S-Video and HDMI inputs and outputs.
1140 VBI is only valid for S-Video as it makes no sense for HDMI.
1154 control is available in the "Vivid" control class of the video
1156 Once enabled any video S-Video or HDMI input will show a static test pattern
1160 - the input type matches the output type. So the HDMI input cannot receive
1161 video from the S-Video output.
1163 - the video resolution of the video input must match that of the video output.
1164 So it is not possible to loop a 50 Hz (720x576) S-Video output to a 60 Hz
1165 (720x480) S-Video input, or a 720p60 HDMI output to a 1080p30 input.
1167 - the pixel formats must be identical on both sides. Otherwise the driver would
1170 - the field settings must be identical on both sides. Same reason as above:
1171 requiring the driver to convert from one field format to another complicated
1172 matters too much. This also prohibits capturing with 'Field Top' or 'Field
1173 Bottom' when the output video is set to 'Field Alternate'. This combination,
1174 while legal, became too complicated to support. Both sides have to be 'Field
1176 sequence and field counting in struct v4l2_buffer on the capture side may not
1179 - field settings V4L2_FIELD_SEQ_TB/BT are not supported. While it is possible to
1181 field values are rarely used the decision was made not to implement this for
1184 - on the input side the "Standard Signal Mode" for the S-Video input or the
1191 This can be turned off by changing the "OSD Text Mode" control of the video
1216 ----------------------------
1227 only applies to the TV/S-Video/HDMI inputs and outputs. The reason is that
1250 -------
1256 The alpha component can be set through the 'Alpha Component' User control
1257 for those formats that support it. If the 'Apply Alpha To Red Only' control
1262 the driver instances are single-planar. This can be changed by setting the
1267 will have a plane that has a non-zero data_offset of 128 bytes. It is rare for
1268 data_offset to be non-zero, so this is a useful feature for testing applications.
1274 ---------------
1286 supported for multiplanar formats. It also honors the struct v4l2_window field
1307 .. code-block:: none
1310 $ v4l2-ctl -d1 --find-fb
1312 $ sudo v4l2-ctl -d2 --set-fbuf fb=1
1313 $ v4l2-ctl -d1 --set-fbuf fb=1
1314 $ v4l2-ctl -d0 --set-fmt-video=pixelformat='AR15'
1315 $ v4l2-ctl -d1 --set-fmt-video-out=pixelformat='AR15'
1316 $ v4l2-ctl -d2 --set-fmt-video=pixelformat='AR15'
1317 $ v4l2-ctl -d0 -i2
1318 $ v4l2-ctl -d2 -i2
1319 $ v4l2-ctl -d2 -c horizontal_movement=4
1320 $ v4l2-ctl -d1 --overlay=1
1321 $ v4l2-ctl -d0 -c loop_video=1
1322 $ v4l2-ctl -d2 --stream-mmap --overlay=1
1326 .. code-block:: none
1328 $ v4l2-ctl -d1 --stream-out-mmap
1332 .. code-block:: none
1342 --------------
1350 - bitmap clipping,
1351 - list clipping (up to 16 rectangles)
1352 - chromakey
1353 - source chromakey
1354 - global alpha
1355 - local alpha
1356 - local inverse alpha
1374 CEC (Consumer Electronics Control)
1375 ----------------------------------
1394 ------------------------
1398 - Add a virtual alsa driver to test audio
1399 - Add virtual sub-devices and media controller support
1400 - Some support for testing compressed video
1401 - Add support to loop raw VBI output to raw VBI input
1402 - Add support to loop teletext sliced VBI output to VBI input
1403 - Fix sequence/field numbering when looping of video with alternate fields
1404 - Add support for V4L2_CID_BG_COLOR for video outputs
1405 - Add ARGB888 overlay support: better testing of the alpha channel
1406 - Improve pixel aspect support in the tpg code by passing a real v4l2_fract
1407 - Use per-queue locks and/or per-device locks to improve throughput
1408 - Add support to loop from a specific output to a specific input across
1410 - The SDR radio should use the same 'frequencies' for stations as the normal
1413 - Make a thread for the RDS generation, that would help in particular for the
1414 "Controls" RDS Rx I/O Mode as the read-only RDS controls could be updated
1415 in real-time.
1416 - Changing the EDID should cause hotplug detect emulation to happen.