Lines Matching +full:video +full:- +full:mode
1 .. SPDX-License-Identifier: GPL-2.0
3 The Virtual Video Test Driver (vivid)
6 This driver emulates video4linux hardware of various types: video capture, video
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 ----------------------
47 By default the driver will create a single instance that has a video capture
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
52 The number of instances, devices, video inputs and outputs and their types are
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
78 So to create four instances, the first two with just one video capture
79 device, the second two with just one video output device you would pass
82 .. code-block:: none
86 - num_inputs:
89 are created for each video capture device. At most 16 inputs can be created,
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
105 So to create a video capture device with 8 inputs where input 0 is a TV
106 tuner, inputs 1-3 are S-Video inputs and inputs 4-7 are HDMI inputs you
109 .. code-block:: none
113 - num_outputs:
116 are created for each video output device. At most 16 outputs can be
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:
140 give the desired videoX start number for each video capture device.
141 The default is -1 which will just take the first free number. This allows
142 you to map capture video nodes to specific videoX device nodes. Example:
144 .. code-block:: none
148 This will attempt to assign /dev/video2 for the video capture device of
153 - vid_out_nr:
155 give the desired videoX start number for each video output device.
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:
200 specify the allowed video capture crop/compose/scaling combination
201 for each driver instance. Video capture devices can have any combination
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:
232 specify the allowed video output crop/compose/scaling combination
233 for each driver instance. Video output devices can have any combination
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
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
311 Video Capture
312 -------------
314 This is probably the most frequently used feature. The video capture device
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
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
351 controls 'Standard Signal Mode' and 'Standard' determine what
362 When you start capturing in V4L2_FIELD_ALTERNATE mode the first buffer will
369 The initially selected colorspace when you switch to the TV or S-Video input
370 will be SMPTE-170M.
372 The pixel aspect ratio will depend on the TV standard. The video aspect ratio
374 Choices are '4x3', '16x9' which will give letterboxed widescreen video and
376 video that will need to be scaled accordingly.
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
404 mode for interlaced formats is always V4L2_FIELD_ALTERNATE. For HDMI the
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).
417 The video aspect ratio can be selected through the 'DV Timings Aspect Ratio'
420 result in pillarboxed or letterboxed video.
433 Video Output
434 ------------
436 The video output device can be configured by using the module options
438 information), but by default two outputs are configured: an S-Video and an
442 Like with video capture the framerate is also exact in the long term.
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.
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
462 mode for interlaced formats is always V4L2_FIELD_ALTERNATE.
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 -----------
489 it will generate the Wide Screen Signal which is based on the actual Video
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
542 The receiver supports HW frequency seek, either in Bounded mode, Wrap Around
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
559 modes. In the 'Controls' mode the transmitted RDS information is configured
560 using controls, and in 'Block I/O' mode the blocks are passed to the driver
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 --------
613 User Controls - Test Controls
620 Both menu controls also have a non-zero minimum control value. These features
625 User Controls - Video Capture
628 The following controls are specific to video capture.
632 video input has its own brightness value, so changing input will restore
633 the brightness for that input. In addition, each video input uses a different
651 User Controls - Audio
654 The following controls are specific to video capture and output and radio
671 The Test Pattern Controls are all specific to video capture.
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:
709 adds a SAV (Start of Active Video) code to the image.
713 - Insert EAV Code in Image:
715 does the same for the EAV (End of Active Video) code.
717 - Insert Video Guard Band
719 adds 4 columns of pixels with the HDMI Video Guard Band code at the
722 to the HDMI Video Guard Band code that precedes each active video line
723 (see section 5.2.2.1 in the HDMI 1.3 Specification). To test if a video
724 receiver has correct HDMI Video Guard Band processing, enable this
726 That will result in video lines that start with multiple pixels that
727 have the same value as the Video Guard Band that precedes them.
728 Receivers that will just keep skipping Video Guard Band values will
729 now fail and either loose sync or these video lines will shift.
735 These controls are all specific to video capture.
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):
809 be limited or full range. This combines with the Digital Video 'Rx RGB
814 - Apply Alpha To Red Only:
819 - Enable Capture Cropping:
822 the ccs_cap_mode module option is set to the default value of -1 and if
825 - Enable Capture Composing:
829 -1 and if the no_error_inj module option is set to 0 (the default).
831 - Enable Capture Scaler:
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:
857 These controls are all specific to video output.
859 - Enable Output Cropping:
862 the ccs_out_mode module option is set to the default value of -1 and if
865 - Enable Output Composing:
869 -1 and if the no_error_inj module option is set to 0 (the default).
871 - Enable Output Scaler:
875 module option is set to the default value of -1 and if the no_error_inj
882 The following two controls are only valid for video and vbi capture.
884 - Standard Signal Mode:
892 - Standard:
901 The following two controls are only valid for video capture.
903 - DV Timings Signal Mode:
912 - DV Timings:
922 is set to 0 (the default). These controls are valid for video and vbi
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:
988 Digital Video Controls
991 - Rx RGB Quantization Range:
994 input. This combines with the Vivid 'Limited RGB Range (16-235)'
998 range and selecting the opposite in the 'Limited RGB Range (16-235)'
1002 - Tx RGB Quantization Range:
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
1045 "Block I/O", then they are inactive as well. If RDS Rx I/O Mode is set
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
1133 Video, VBI and RDS Looping
1134 --------------------------
1136 The vivid driver supports looping of video output to video input, VBI output
1137 to VBI input and RDS output to RDS input. For video/VBI looping this emulates
1138 as if a cable was hooked up between the output and input connector. So video
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.
1150 Video and Sliced VBI looping
1153 The way to enable video/VBI looping is currently fairly crude. A 'Loop Video'
1154 control is available in the "Vivid" control class of the video
1155 capture and VBI capture devices. When checked the video looping will be enabled.
1156 Once enabled any video S-Video or HDMI input will show a static test pattern
1157 until the video output has started. At that time the video output will be
1158 looped to the video input provided that:
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:
1173 Bottom' when the output video is set to 'Field Alternate'. This combination,
1179 - field settings V4L2_FIELD_SEQ_TB/BT are not supported. While it is possible to
1184 - on the input side the "Standard Signal Mode" for the S-Video input or the
1185 "DV Timings Signal Mode" for the HDMI input should be configured so that a
1186 valid signal is passed to the video input.
1190 By default you will see the OSD text superimposed on top of the looped video.
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 -------
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.
1270 Video output will also honor any data_offset that the application set.
1274 ---------------
1303 the output overlay for the video output, turn on video looping and capture
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
1368 processing capabilities you need to turn on video looping and see the results
1370 capabilities will slow down the video loop considerably as a lot of checks have
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.