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

Commit 2212ff25 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

doc-rst: linux_tv: convert lots of consts to references 



There were lots of consts at the media docbook that should
be, instead, references. Convert the ones that can easily
be done by an automatic script.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 7347081e

Documentation/linux_tv/media/v4l/dev-capture.rst

+8 −8
Original line number Diff line number Diff line
@@ -75,23 +75,23 @@ To request different parameters applications set the ``type`` field of a 
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all

fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>`

``vbi`` member of the ``fmt`` union, or better just modify the results

of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`

of :ref:`VIDIOC_G_FMT`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`

ioctl with a pointer to this structure. Drivers may adjust the

parameters and finally return the actual parameters as ``VIDIOC_G_FMT``

parameters and finally return the actual parameters as :ref:`VIDIOC_G_FMT`

does.



Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl

Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl

can be used to learn about hardware limitations without disabling I/O or

possibly time consuming hardware preparations.



The contents of struct :ref:`v4l2_pix_format <v4l2-pix-format>` and

struct :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` are

discussed in :ref:`pixfmt`. See also the specification of the

``VIDIOC_G_FMT``, ``VIDIOC_S_FMT`` and ``VIDIOC_TRY_FMT`` ioctls for

details. Video capture devices must implement both the ``VIDIOC_G_FMT``

and ``VIDIOC_S_FMT`` ioctl, even if ``VIDIOC_S_FMT`` ignores all

requests and always returns default parameters as ``VIDIOC_G_FMT`` does.

``VIDIOC_TRY_FMT`` is optional.

:ref:`VIDIOC_G_FMT`, :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctls for

details. Video capture devices must implement both the :ref:`VIDIOC_G_FMT`

and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, even if :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ignores all

requests and always returns default parameters as :ref:`VIDIOC_G_FMT` does.

:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is optional.





Reading Images

Documentation/linux_tv/media/v4l/dev-osd.rst

+2 −2
Original line number Diff line number Diff line
@@ -124,10 +124,10 @@ struct :ref:`v4l2_format <v4l2-format>` to 
``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY``, initialize the ``win``

substructure and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.

The driver adjusts the parameters against hardware limits and returns

the actual parameters as ``VIDIOC_G_FMT`` does. Like ``VIDIOC_S_FMT``,

the actual parameters as :ref:`VIDIOC_G_FMT` does. Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`,

the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to learn

about driver capabilities without actually changing driver state. Unlike

``VIDIOC_S_FMT`` this also works after the overlay has been enabled.

:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` this also works after the overlay has been enabled.



A struct :ref:`v4l2_crop <v4l2-crop>` defines the size and position

of the target rectangle. The scaling factor of the overlay is implied by

Documentation/linux_tv/media/v4l/dev-output.rst

+8 −8
Original line number Diff line number Diff line
@@ -72,23 +72,23 @@ To request different parameters applications set the ``type`` field of a 
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all

fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>`

``vbi`` member of the ``fmt`` union, or better just modify the results

of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`

of :ref:`VIDIOC_G_FMT`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`

ioctl with a pointer to this structure. Drivers may adjust the

parameters and finally return the actual parameters as ``VIDIOC_G_FMT``

parameters and finally return the actual parameters as :ref:`VIDIOC_G_FMT`

does.



Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl

Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl

can be used to learn about hardware limitations without disabling I/O or

possibly time consuming hardware preparations.



The contents of struct :ref:`v4l2_pix_format <v4l2-pix-format>` and

struct :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` are

discussed in :ref:`pixfmt`. See also the specification of the

``VIDIOC_G_FMT``, ``VIDIOC_S_FMT`` and ``VIDIOC_TRY_FMT`` ioctls for

details. Video output devices must implement both the ``VIDIOC_G_FMT``

and ``VIDIOC_S_FMT`` ioctl, even if ``VIDIOC_S_FMT`` ignores all

requests and always returns default parameters as ``VIDIOC_G_FMT`` does.

``VIDIOC_TRY_FMT`` is optional.

:ref:`VIDIOC_G_FMT`, :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctls for

details. Video output devices must implement both the :ref:`VIDIOC_G_FMT`

and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, even if :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ignores all

requests and always returns default parameters as :ref:`VIDIOC_G_FMT` does.

:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is optional.





Writing Images

Documentation/linux_tv/media/v4l/dev-overlay.rst

+6 −6
Original line number Diff line number Diff line
@@ -65,7 +65,7 @@ frame buffer parameters, namely the address and size of the frame buffer 
and the image format, for example RGB 5:6:5. The

:ref:`VIDIOC_G_FBUF` and

:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctls are available to get and

set these parameters, respectively. The ``VIDIOC_S_FBUF`` ioctl is

set these parameters, respectively. The :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl is

privileged because it allows to set up DMA into physical memory,

bypassing the memory protection mechanisms of the kernel. Only the

superuser can change the frame buffer address and size. Users are not
@@ -76,8 +76,8 @@ system and program the V4L2 driver at the appropriate time. 
Some devices add the video overlay to the output signal of the graphics

card. In this case the frame buffer is not modified by the video device,

and the frame buffer address and pixel format are not needed by the

driver. The ``VIDIOC_S_FBUF`` ioctl is not privileged. An application

can check for this type of device by calling the ``VIDIOC_G_FBUF``

driver. The :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl is not privileged. An application

can check for this type of device by calling the :ref:`VIDIOC_G_FBUF`

ioctl.



A driver may support any (or none) of five clipping/blending methods:
@@ -130,10 +130,10 @@ struct :ref:`v4l2_format <v4l2-format>` to 
``V4L2_BUF_TYPE_VIDEO_OVERLAY``, initialize the ``win`` substructure and

call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. The driver

adjusts the parameters against hardware limits and returns the actual

parameters as ``VIDIOC_G_FMT`` does. Like ``VIDIOC_S_FMT``, the

parameters as :ref:`VIDIOC_G_FMT` does. Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`, the

:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to learn

about driver capabilities without actually changing driver state. Unlike

``VIDIOC_S_FMT`` this also works after the overlay has been enabled.

:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` this also works after the overlay has been enabled.



The scaling factor of the overlaid image is implied by the width and

height given in struct :ref:`v4l2_window <v4l2-window>` and the size
@@ -199,7 +199,7 @@ are undefined. 
    When the application set the ``clips`` field, this field must

    contain the number of clipping rectangles in the list. When clip

    lists are not supported the driver ignores this field, its contents

    after calling ``VIDIOC_S_FMT`` are undefined. When clip lists are

    after calling :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` are undefined. When clip lists are

    supported but no clipping is desired this field must be set to zero.



``void * bitmap``

Documentation/linux_tv/media/v4l/dev-raw-vbi.rst

+5 −5
Original line number Diff line number Diff line
@@ -80,7 +80,7 @@ To request different parameters applications set the ``type`` field of a 
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all

fields of the struct :ref:`v4l2_vbi_format <v4l2-vbi-format>`

``vbi`` member of the ``fmt`` union, or better just modify the results

of ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`

of :ref:`VIDIOC_G_FMT`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`

ioctl with a pointer to this structure. Drivers return an EINVAL error

code only when the given parameters are ambiguous, otherwise they modify

the parameters according to the hardware capabilities and return the
@@ -94,10 +94,10 @@ expect other resource allocation points which may return EBUSY, at the 
:ref:`VIDIOC_STREAMON` ioctl and the first read(),

write() and select() call.



VBI devices must implement both the ``VIDIOC_G_FMT`` and

``VIDIOC_S_FMT`` ioctl, even if ``VIDIOC_S_FMT`` ignores all requests

and always returns default parameters as ``VIDIOC_G_FMT`` does.

``VIDIOC_TRY_FMT`` is optional.

VBI devices must implement both the :ref:`VIDIOC_G_FMT` and

:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, even if :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ignores all requests

and always returns default parameters as :ref:`VIDIOC_G_FMT` does.

:ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is optional.





.. _v4l2-vbi-format: