Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 4855307b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] doc-rst: use the right markup for footnotes



According with ReST spec, footnotes should be like:
[#name], and not [name]. So, change them.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 53ae9251
Loading
Loading
Loading
Loading
+2 −2
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ capture devices have inputs, output devices have outputs, zero or more
each. Radio devices have no audio inputs or outputs. They have exactly
one tuner which in fact *is* an audio source, but this API associates
tuners with video inputs or outputs only, and radio devices have none of
these. [1]_ A connector on a TV card to loop back the received audio
these. [#f1]_ A connector on a TV card to loop back the received audio
signal to a sound card is not considered an audio output.

Audio and video inputs and outputs are associated. Selecting a video
@@ -88,7 +88,7 @@ Example: Switching to the first audio input
	exit(EXIT_FAILURE);
    }

.. [1]
.. [#f1]
   Actually struct :ref:`v4l2_audio <v4l2-audio>` ought to have a
   ``tuner`` field like struct :ref:`v4l2_input <v4l2-input>`, not
   only making the API more consistent but also permitting radio devices
+2 −2
Original line number Diff line number Diff line
@@ -17,7 +17,7 @@ device.

All controls are accessed using an ID value. V4L2 defines several IDs
for specific purposes. Drivers can also implement their own custom
controls using ``V4L2_CID_PRIVATE_BASE``  [1]_ and higher values. The
controls using ``V4L2_CID_PRIVATE_BASE``  [#f1]_ and higher values. The
pre-defined control IDs have the prefix ``V4L2_CID_``, and are listed in
:ref:`control-id`. The ID is used when querying the attributes of a
control, and when getting or setting the current value.
@@ -522,7 +522,7 @@ Example: Changing controls
    /* Errors ignored */
    ioctl(fd, VIDIOC_S_CTRL, &control);

.. [1]
.. [#f1]
   The use of ``V4L2_CID_PRIVATE_BASE`` is problematic because different
   drivers may use the same ``V4L2_CID_PRIVATE_BASE`` ID for different
   controls. This makes it hard to programatically set such controls
+8 −8
Original line number Diff line number Diff line
@@ -33,7 +33,7 @@ Applications should use different file descriptors for capturing and
overlay. This must be supported by all drivers capable of simultaneous
capturing and overlay. Optionally these drivers may also permit
capturing and overlay with a single file descriptor for compatibility
with V4L and earlier versions of V4L2. [1]_
with V4L and earlier versions of V4L2. [#f1]_


Querying Capabilities
@@ -216,7 +216,7 @@ bits like:

    ((__u8 *) bitmap)[w.width * y + x / 8] & (1 << (x & 7))

where ``0`` ≤ x < ``w.width`` and ``0`` ≤ y <``w.height``. [2]_
where ``0`` ≤ x < ``w.width`` and ``0`` ≤ y <``w.height``. [#f2]_

When a clipping bit mask is not supported the driver ignores this field,
its contents after calling :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` are
@@ -227,7 +227,7 @@ Applications need not create a clip list or bit mask. When they pass
both, or despite negotiating chroma-keying, the results are undefined.
Regardless of the chosen method, the clipping abilities of the hardware
may be limited in quantity or quality. The results when these limits are
exceeded are undefined. [3]_
exceeded are undefined. [#f3]_

``__u8 global_alpha``
    The global alpha value used to blend the framebuffer with video
@@ -244,7 +244,7 @@ exceeded are undefined. [3]_

.. _v4l2-clip:

struct v4l2_clip [4]_
struct v4l2_clip [#f4]_
---------------------

``struct v4l2_rect c``
@@ -284,7 +284,7 @@ Enabling Overlay
To start or stop the frame buffer overlay applications call the
:ref:`VIDIOC_OVERLAY` ioctl.

.. [1]
.. [#f1]
   A common application of two file descriptors is the XFree86
   :ref:`Xv/V4L <xvideo>` interface driver and a V4L2 application.
   While the X server controls video overlay, the application can take
@@ -301,17 +301,17 @@ To start or stop the frame buffer overlay applications call the
   Hence as a complexity trade-off drivers *must* support two file
   descriptors and *may* support single fd operation.

.. [2]
.. [#f2]
   Should we require ``w.width`` to be a multiple of eight?

.. [3]
.. [#f3]
   When the image is written into frame buffer memory it will be
   undesirable if the driver clips out less pixels than expected,
   because the application and graphics system are not aware these
   regions need to be refreshed. The driver should clip out more pixels
   or not write the image at all.

.. [4]
.. [#f4]
   The X Window system defines "regions" which are vectors of ``struct
   BoxRec { short x1, y1, x2, y2; }`` with ``width = x2 - x1`` and
   ``height = y2 - y1``, so one cannot pass X11 clip lists directly.
+9 −9
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ sequence of lines of an analog video signal. During VBI no picture
information is transmitted, allowing some time while the electron beam
of a cathode ray tube TV returns to the top of the screen. Using an
oscilloscope you will find here the vertical synchronization pulses and
short data packages ASK modulated [1]_ onto the video signal. These are
short data packages ASK modulated [#f1]_ onto the video signal. These are
transmissions of services such as Teletext or Closed Caption.

Subject of this interface type is raw VBI data, as sampled off a video
@@ -143,7 +143,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does
       -  ``sample_format``

       -  Defines the sample format as in :ref:`pixfmt`, a
	  four-character-code. [2]_ Usually this is ``V4L2_PIX_FMT_GREY``,
	  four-character-code. [#f2]_ Usually this is ``V4L2_PIX_FMT_GREY``,
	  i. e. each sample consists of 8 bits with lower values oriented
	  towards the black level. Do not assume any other correlation of
	  values with the signal level. For example, the MSB does not
@@ -155,7 +155,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does

       -  __u32

       -  ``start``\ [2]_
       -  ``start``\ [#f2]_

       -  This is the scanning system line number associated with the first
	  line of the VBI image, of the first and the second field
@@ -173,7 +173,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does

       -  __u32

       -  ``count``\ [2]_
       -  ``count``\ [#f2]_

       -  The number of lines in the first and second field image,
	  respectively.
@@ -218,7 +218,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does

       -  __u32

       -  ``reserved``\ [2]_
       -  ``reserved``\ [#f2]_

       -  This array is reserved for future extensions. Drivers and
	  applications must set it to zero.
@@ -245,7 +245,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does
	  or bottom field depending on the video standard. When this flag is
	  set the first or second field may be stored first, however the
	  fields are still in correct temporal order with the older field
	  first in memory. [3]_
	  first in memory. [#f3]_

    -  .. row 2

@@ -336,15 +336,15 @@ points returning an ``EBUSY`` error code if the required hardware resources
are temporarily unavailable, for example the device is already in use by
another process.

.. [1]
.. [#f1]
   ASK: Amplitude-Shift Keying. A high signal level represents a '1'
   bit, a low level a '0' bit.

.. [2]
.. [#f2]
   A few devices may be unable to sample VBI data at all but can extend
   the video capture window to the VBI region.

.. [3]
.. [#f3]
   Most VBI services transmit on both fields, but some have different
   semantics depending on the field number. These cannot be reliable
   decoded or encoded when ``V4L2_VBI_UNSYNC`` is set.
+2 −2
Original line number Diff line number Diff line
@@ -126,7 +126,7 @@ struct v4l2_sliced_vbi_format
	  specified in this field. For example, if ``service_set`` is
	  initialized with ``V4L2_SLICED_TELETEXT_B | V4L2_SLICED_WSS_625``,
	  a driver for the cx25840 video decoder sets lines 7-22 of both
	  fields [1]_ to ``V4L2_SLICED_TELETEXT_B`` and line 23 of the first
	  fields [#f1]_ to ``V4L2_SLICED_TELETEXT_B`` and line 23 of the first
	  field to ``V4L2_SLICED_WSS_625``. If ``service_set`` is set to
	  zero, then the values of ``service_lines`` will be used instead.

@@ -817,6 +817,6 @@ Line Identifiers for struct v4l2_mpeg_vbi_itv0_line id field



.. [1]
.. [#f1]
   According to :ref:`ETS 300 706 <ets300706>` lines 6-22 of the first
   field and lines 5-22 of the second field may carry Teletext data.
Loading