korg/linux
0
0
Fork 0
mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2024-11-15 00:04:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

media: Documentation: vivid.rst: fix confusing section refs

Browse Source 
The documentation contained several instances of "section X"
references, which no longer map to whatever X was.

Replace these by the section titles.

Also fix a single confusing typo in the "Radio & RDS Looping" section:
"are regular frequency intervals" -> "at regular frequency intervals"

Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
This commit is contained in:
Hans Verkuil 2024-06-24 12:52:53 +03:00
parent 57dd8f2f77
commit 2513996024
1 changed files with 21 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
Documentation/admin-guide/media/vivid.rst
View File

@ -313,10 +313,10 @@ Video Capture
This is probably the most frequently used feature. The video capture device This is probably the most frequently used feature. The video capture device
can be configured by using the module options num_inputs, input_types and can be configured by using the module options num_inputs, input_types and
ccs_cap_mode (see section 1 for more detailed information), but by default ccs_cap_mode (see "Configuring the driver" for more detailed information),
four inputs are configured: a webcam, a TV tuner, an S-Video and an HDMI but by default four inputs are configured: a webcam, a TV tuner, an S-Video
input, one input for each input type. Those are described in more detail and an HDMI input, one input for each input type. Those are described in more
below. detail below.
Special attention has been given to the rate at which new frames become Special attention has been given to the rate at which new frames become
available. The jitter will be around 1 jiffie (that depends on the HZ available. The jitter will be around 1 jiffie (that depends on the HZ
@ -434,10 +434,10 @@ Video Output
------------ ------------
The video output device can be configured by using the module options The video output device can be configured by using the module options
num_outputs, output_types and ccs_out_mode (see section 1 for more detailed num_outputs, output_types and ccs_out_mode (see "Configuring the driver"
information), but by default two outputs are configured: an S-Video and an for more detailed information), but by default two outputs are configured:
HDMI input, one output for each output type. Those are described in more detail an S-Video and an HDMI input, one output for each output type. Those are
below. described in more detail below.
Like with video capture the framerate is also exact in the long term. Like with video capture the framerate is also exact in the long term.
@ -1200,15 +1200,15 @@ and WSS (50 Hz formats) VBI data is looped. Teletext VBI data is not looped.
Radio & RDS Looping Radio & RDS Looping
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
As mentioned in section 6 the radio receiver emulates stations are regular As mentioned in the "Radio Receiver" section, the radio receiver emulates
frequency intervals. Depending on the frequency of the radio receiver a stations at regular frequency intervals. Depending on the frequency of the
signal strength value is calculated (this is returned by VIDIOC_G_TUNER). radio receiver a signal strength value is calculated (this is returned by
However, it will also look at the frequency set by the radio transmitter and VIDIOC_G_TUNER). However, it will also look at the frequency set by the radio
if that results in a higher signal strength than the settings of the radio transmitter and if that results in a higher signal strength than the settings
transmitter will be used as if it was a valid station. This also includes of the radio transmitter will be used as if it was a valid station. This also
the RDS data (if any) that the transmitter 'transmits'. This is received includes the RDS data (if any) that the transmitter 'transmits'. This is
faithfully on the receiver side. Note that when the driver is loaded the received faithfully on the receiver side. Note that when the driver is loaded
frequencies of the radio receiver and transmitter are not identical, so the frequencies of the radio receiver and transmitter are not identical, so
initially no looping takes place. initially no looping takes place.
@ -1218,8 +1218,8 @@ Cropping, Composing, Scaling
This driver supports cropping, composing and scaling in any combination. Normally This driver supports cropping, composing and scaling in any combination. Normally
which features are supported can be selected through the Vivid controls, which features are supported can be selected through the Vivid controls,
but it is also possible to hardcode it when the module is loaded through the but it is also possible to hardcode it when the module is loaded through the
ccs_cap_mode and ccs_out_mode module options. See section 1 on the details of ccs_cap_mode and ccs_out_mode module options. See "Configuring the driver" on
these module options. the details of these module options.
This allows you to test your application for all these variations. This allows you to test your application for all these variations.
@ -1260,7 +1260,8 @@ is set, then the alpha component is only used for the color red and set to
The driver has to be configured to support the multiplanar formats. By default The driver has to be configured to support the multiplanar formats. By default
the driver instances are single-planar. This can be changed by setting the the driver instances are single-planar. This can be changed by setting the
multiplanar module option, see section 1 for more details on that option. multiplanar module option, see "Configuring the driver" for more details on that
option.
If the driver instance is using the multiplanar formats/API, then the first If the driver instance is using the multiplanar formats/API, then the first
single planar format (YUYV) and the multiplanar NV16M and NV61M formats the single planar format (YUYV) and the multiplanar NV16M and NV61M formats the