Commit af4a4d0d authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

doc-rst: linux_tv: Replace reference names to match ioctls

Due to a limitation at the DocBook language, the references
were using lowercase and slashes, instead of the name of the
ioctls. On ReST, make them identical. This will hopefully
help to cleanup the code a little bit.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 78981884
...@@ -456,7 +456,7 @@ AUDIO_SET_MUTE ...@@ -456,7 +456,7 @@ AUDIO_SET_MUTE
DESCRIPTION DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the This ioctl is for DVB devices only. To control a V4L2 decoder use the
V4L2 :ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` with the V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` with the
``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead. ``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
This ioctl call asks the audio device to mute the stream that is This ioctl call asks the audio device to mute the stream that is
......
...@@ -239,7 +239,7 @@ VIDEO_STOP ...@@ -239,7 +239,7 @@ VIDEO_STOP
DESCRIPTION DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the This ioctl is for DVB devices only. To control a V4L2 decoder use the
V4L2 :ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` instead. V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
This ioctl call asks the Video Device to stop playing the current This ioctl call asks the Video Device to stop playing the current
stream. Depending on the input parameter, the screen can be blanked out stream. Depending on the input parameter, the screen can be blanked out
...@@ -302,7 +302,7 @@ VIDEO_PLAY ...@@ -302,7 +302,7 @@ VIDEO_PLAY
DESCRIPTION DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the This ioctl is for DVB devices only. To control a V4L2 decoder use the
V4L2 :ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` instead. V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
This ioctl call asks the Video Device to start playing a video stream This ioctl call asks the Video Device to start playing a video stream
from the selected source. from the selected source.
...@@ -348,7 +348,7 @@ VIDEO_FREEZE ...@@ -348,7 +348,7 @@ VIDEO_FREEZE
DESCRIPTION DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the This ioctl is for DVB devices only. To control a V4L2 decoder use the
V4L2 :ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` instead. V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
This ioctl call suspends the live video stream being played. Decoding This ioctl call suspends the live video stream being played. Decoding
and playing are frozen. It is then possible to restart the decoding and and playing are frozen. It is then possible to restart the decoding and
...@@ -398,7 +398,7 @@ VIDEO_CONTINUE ...@@ -398,7 +398,7 @@ VIDEO_CONTINUE
DESCRIPTION DESCRIPTION
This ioctl is for DVB devices only. To control a V4L2 decoder use the This ioctl is for DVB devices only. To control a V4L2 decoder use the
V4L2 :ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` instead. V4L2 :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` instead.
This ioctl call restarts decoding and playing processes of the video This ioctl call restarts decoding and playing processes of the video
stream which was played before a call to VIDEO_FREEZE was made. stream which was played before a call to VIDEO_FREEZE was made.
...@@ -763,7 +763,7 @@ VIDEO_GET_EVENT ...@@ -763,7 +763,7 @@ VIDEO_GET_EVENT
DESCRIPTION DESCRIPTION
This ioctl is for DVB devices only. To get events from a V4L2 decoder This ioctl is for DVB devices only. To get events from a V4L2 decoder
use the V4L2 :ref:`VIDIOC_DQEVENT <vidioc-dqevent>` ioctl instead. use the V4L2 :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>` ioctl instead.
This ioctl call returns an event of type video_event if available. If This ioctl call returns an event of type video_event if available. If
an event is not available, the behavior depends on whether the device is an event is not available, the behavior depends on whether the device is
...@@ -844,11 +844,11 @@ DESCRIPTION ...@@ -844,11 +844,11 @@ DESCRIPTION
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
this ioctl has been replaced by the this ioctl has been replaced by the
:ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` ioctl. :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
This ioctl commands the decoder. The ``video_command`` struct is a This ioctl commands the decoder. The ``video_command`` struct is a
subset of the ``v4l2_decoder_cmd`` struct, so refer to the subset of the ``v4l2_decoder_cmd`` struct, so refer to the
:ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>` documentation for :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation for
more information. more information.
SYNOPSIS SYNOPSIS
...@@ -900,11 +900,11 @@ DESCRIPTION ...@@ -900,11 +900,11 @@ DESCRIPTION
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
this ioctl has been replaced by the this ioctl has been replaced by the
:ref:`VIDIOC_TRY_DECODER_CMD <vidioc-decoder-cmd>` ioctl. :ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
This ioctl tries a decoder command. The ``video_command`` struct is a This ioctl tries a decoder command. The ``video_command`` struct is a
subset of the ``v4l2_decoder_cmd`` struct, so refer to the subset of the ``v4l2_decoder_cmd`` struct, so refer to the
:ref:`VIDIOC_TRY_DECODER_CMD <vidioc-decoder-cmd>` documentation :ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
for more information. for more information.
SYNOPSIS SYNOPSIS
......
...@@ -16,17 +16,17 @@ applications and automatically regain control of the device at a later ...@@ -16,17 +16,17 @@ applications and automatically regain control of the device at a later
time. time.
Since these features cannot be implemented entirely in user space V4L2 Since these features cannot be implemented entirely in user space V4L2
defines the :ref:`VIDIOC_G_PRIORITY <vidioc-g-priority>` and defines the :ref:`VIDIOC_G_PRIORITY <VIDIOC_G_PRIORITY>` and
:ref:`VIDIOC_S_PRIORITY <vidioc-g-priority>` ioctls to request and :ref:`VIDIOC_S_PRIORITY <VIDIOC_G_PRIORITY>` ioctls to request and
query the access priority associate with a file descriptor. Opening a query the access priority associate with a file descriptor. Opening a
device assigns a medium priority, compatible with earlier versions of device assigns a medium priority, compatible with earlier versions of
V4L2 and drivers not supporting these ioctls. Applications requiring a V4L2 and drivers not supporting these ioctls. Applications requiring a
different priority will usually call :ref:`VIDIOC_S_PRIORITY different priority will usually call :ref:`VIDIOC_S_PRIORITY
<vidioc-g-priority>` after verifying the device with the <VIDIOC_G_PRIORITY>` after verifying the device with the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl.
Ioctls changing driver properties, such as Ioctls changing driver properties, such as
:ref:`VIDIOC_S_INPUT <vidioc-g-input>`, return an EBUSY error code :ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>`, return an EBUSY error code
after another application obtained higher priority. after another application obtained higher priority.
......
...@@ -27,31 +27,31 @@ number, starting at zero, of one audio input or output. ...@@ -27,31 +27,31 @@ number, starting at zero, of one audio input or output.
To learn about the number and attributes of the available inputs and To learn about the number and attributes of the available inputs and
outputs applications can enumerate them with the outputs applications can enumerate them with the
:ref:`VIDIOC_ENUMAUDIO <vidioc-enumaudio>` and :ref:`VIDIOC_ENUMAUDIO <VIDIOC_ENUMAUDIO>` and
:ref:`VIDIOC_ENUMAUDOUT <vidioc-enumaudioout>` ioctl, respectively. :ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>` ioctl, respectively.
The struct :ref:`v4l2_audio <v4l2-audio>` returned by the The struct :ref:`v4l2_audio <v4l2-audio>` returned by the
:ref:`VIDIOC_ENUMAUDIO <vidioc-enumaudio>` ioctl also contains signal :ref:`VIDIOC_ENUMAUDIO <VIDIOC_ENUMAUDIO>` ioctl also contains signal
:status information applicable when the current audio input is queried. :status information applicable when the current audio input is queried.
The :ref:`VIDIOC_G_AUDIO <vidioc-g-audio>` and The :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` and
:ref:`VIDIOC_G_AUDOUT <vidioc-g-audioout>` ioctls report the current :ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDIOout>` ioctls report the current
audio input and output, respectively. Note that, unlike audio input and output, respectively. Note that, unlike
:ref:`VIDIOC_G_INPUT <vidioc-g-input>` and :ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
:ref:`VIDIOC_G_OUTPUT <vidioc-g-output>` these ioctls return a :ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` these ioctls return a
structure as :ref:`VIDIOC_ENUMAUDIO <vidioc-enumaudio>` and structure as :ref:`VIDIOC_ENUMAUDIO <VIDIOC_ENUMAUDIO>` and
:ref:`VIDIOC_ENUMAUDOUT <vidioc-enumaudioout>` do, not just an index. :ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>` do, not just an index.
To select an audio input and change its properties applications call the To select an audio input and change its properties applications call the
:ref:`VIDIOC_S_AUDIO <vidioc-g-audio>` ioctl. To select an audio :ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` ioctl. To select an audio
output (which presently has no changeable properties) applications call output (which presently has no changeable properties) applications call
the :ref:`VIDIOC_S_AUDOUT <vidioc-g-audioout>` ioctl. the :ref:`VIDIOC_S_AUDOUT <VIDIOC_G_AUDIOout>` ioctl.
Drivers must implement all audio input ioctls when the device has Drivers must implement all audio input ioctls when the device has
multiple selectable audio inputs, all audio output ioctls when the multiple selectable audio inputs, all audio output ioctls when the
device has multiple selectable audio outputs. When the device has any device has multiple selectable audio outputs. When the device has any
audio inputs or outputs the driver must set the ``V4L2_CAP_AUDIO`` flag audio inputs or outputs the driver must set the ``V4L2_CAP_AUDIO`` flag
in the struct :ref:`v4l2_capability <v4l2-capability>` returned by in the struct :ref:`v4l2_capability <v4l2-capability>` returned by
the :ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. the :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl.
.. code-block:: c .. code-block:: c
......
...@@ -12,9 +12,9 @@ planes, while the buffer structure acts as a container for the planes. ...@@ -12,9 +12,9 @@ planes, while the buffer structure acts as a container for the planes.
Only pointers to buffers (planes) are exchanged, the data itself is not Only pointers to buffers (planes) are exchanged, the data itself is not
copied. These pointers, together with meta-information like timestamps copied. These pointers, together with meta-information like timestamps
or field parity, are stored in a struct :c:type:`struct v4l2_buffer`, or field parity, are stored in a struct :c:type:`struct v4l2_buffer`,
argument to the :ref:`VIDIOC_QUERYBUF <vidioc-querybuf>`, argument to the :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`,
:ref:`VIDIOC_QBUF <vidioc-qbuf>` and :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. In the multi-planar API, :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. In the multi-planar API,
some plane-specific members of struct :c:type:`struct v4l2_buffer`, some plane-specific members of struct :c:type:`struct v4l2_buffer`,
such as pointers and sizes for each plane, are stored in struct such as pointers and sizes for each plane, are stored in struct
:c:type:`struct v4l2_plane` instead. In that case, struct :c:type:`struct v4l2_plane` instead. In that case, struct
...@@ -26,8 +26,8 @@ see flags in the masks ``V4L2_BUF_FLAG_TIMESTAMP_MASK`` and ...@@ -26,8 +26,8 @@ see flags in the masks ``V4L2_BUF_FLAG_TIMESTAMP_MASK`` and
``V4L2_BUF_FLAG_TSTAMP_SRC_MASK`` in :ref:`buffer-flags`. These flags ``V4L2_BUF_FLAG_TSTAMP_SRC_MASK`` in :ref:`buffer-flags`. These flags
are always valid and constant across all buffers during the whole video are always valid and constant across all buffers during the whole video
stream. Changes in these flags may take place as a side effect of stream. Changes in these flags may take place as a side effect of
:ref:`VIDIOC_S_INPUT <vidioc-g-input>` or :ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` or
:ref:`VIDIOC_S_OUTPUT <vidioc-g-output>` however. The :ref:`VIDIOC_S_OUTPUT <VIDIOC_G_OUTPUT>` however. The
``V4L2_BUF_FLAG_TIMESTAMP_COPY`` timestamp type which is used by e.g. on ``V4L2_BUF_FLAG_TIMESTAMP_COPY`` timestamp type which is used by e.g. on
mem-to-mem devices is an exception to the rule: the timestamp source mem-to-mem devices is an exception to the rule: the timestamp source
flags are copied from the OUTPUT video buffer to the CAPTURE video flags are copied from the OUTPUT video buffer to the CAPTURE video
...@@ -50,12 +50,12 @@ buffer. ...@@ -50,12 +50,12 @@ buffer.
- -
- Number of the buffer, set by the application except when calling - Number of the buffer, set by the application except when calling
:ref:`VIDIOC_DQBUF <vidioc-qbuf>`, then it is set by the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`, then it is set by the
driver. This field can range from zero to the number of buffers driver. This field can range from zero to the number of buffers
allocated with the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl allocated with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl
(struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` (struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>`
``count``), plus any buffers allocated with ``count``), plus any buffers allocated with
:ref:`VIDIOC_CREATE_BUFS <vidioc-create-bufs>` minus one. :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>` minus one.
- .. row 2 - .. row 2
...@@ -243,8 +243,8 @@ buffer. ...@@ -243,8 +243,8 @@ buffer.
- -
- Size of the buffer (not the payload) in bytes for the - Size of the buffer (not the payload) in bytes for the
single-planar API. This is set by the driver based on the calls to single-planar API. This is set by the driver based on the calls to
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` and/or :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and/or
:ref:`VIDIOC_CREATE_BUFS <vidioc-create-bufs>`. For the :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>`. For the
multi-planar API the application sets this to the number of multi-planar API the application sets this to the number of
elements in the ``planes`` array. The driver will fill in the elements in the ``planes`` array. The driver will fill in the
actual number of valid elements in that array. actual number of valid elements in that array.
...@@ -303,8 +303,8 @@ buffer. ...@@ -303,8 +303,8 @@ buffer.
- -
- Size in bytes of the plane (not its payload). This is set by the - Size in bytes of the plane (not its payload). This is set by the
driver based on the calls to driver based on the calls to
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` and/or :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and/or
:ref:`VIDIOC_CREATE_BUFS <vidioc-create-bufs>`. :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>`.
- .. row 3 - .. row 3
...@@ -506,9 +506,9 @@ buffer. ...@@ -506,9 +506,9 @@ buffer.
- The buffer resides in device memory and has been mapped into the - The buffer resides in device memory and has been mapped into the
application's address space, see :ref:`mmap` for details. application's address space, see :ref:`mmap` for details.
Drivers set or clear this flag when the Drivers set or clear this flag when the
:ref:`VIDIOC_QUERYBUF <vidioc-querybuf>`, :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`,
:ref:`VIDIOC_QBUF <vidioc-qbuf>` or :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` or
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl is called. Set by the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl is called. Set by the
driver. driver.
- .. row 2 - .. row 2
...@@ -609,10 +609,10 @@ buffer. ...@@ -609,10 +609,10 @@ buffer.
- The buffer has been prepared for I/O and can be queued by the - The buffer has been prepared for I/O and can be queued by the
application. Drivers set or clear this flag when the application. Drivers set or clear this flag when the
:ref:`VIDIOC_QUERYBUF <vidioc-querybuf>`, :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`,
:ref:`VIDIOC_PREPARE_BUF <vidioc-qbuf>`, :ref:`VIDIOC_PREPARE_BUF <VIDIOC_QBUF>`,
:ref:`VIDIOC_QBUF <vidioc-qbuf>` or :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` or
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl is called. :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl is called.
- .. row 10 - .. row 10
...@@ -645,12 +645,12 @@ buffer. ...@@ -645,12 +645,12 @@ buffer.
- Last buffer produced by the hardware. mem2mem codec drivers set - Last buffer produced by the hardware. mem2mem codec drivers set
this flag on the capture queue for the last buffer when the this flag on the capture queue for the last buffer when the
:ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` or :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` or
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl is called. Due to :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl is called. Due to
hardware limitations, the last buffer may be empty. In this case hardware limitations, the last buffer may be empty. In this case
the driver will set the ``bytesused`` field to 0, regardless of the driver will set the ``bytesused`` field to 0, regardless of
the format. Any Any subsequent call to the the format. Any Any subsequent call to the
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl will not block anymore, :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
but return an EPIPE error code. but return an EPIPE error code.
- .. row 13 - .. row 13
......
...@@ -47,7 +47,7 @@ changed or generally never without application request. ...@@ -47,7 +47,7 @@ changed or generally never without application request.
V4L2 specifies an event mechanism to notify applications when controls V4L2 specifies an event mechanism to notify applications when controls
change value (see change value (see
:ref:`VIDIOC_SUBSCRIBE_EVENT <vidioc-subscribe-event>`, event :ref:`VIDIOC_SUBSCRIBE_EVENT <VIDIOC_SUBSCRIBE_EVENT>`, event
``V4L2_EVENT_CTRL``), panel applications might want to make use of that ``V4L2_EVENT_CTRL``), panel applications might want to make use of that
in order to always reflect the correct control value. in order to always reflect the correct control value.
...@@ -311,7 +311,7 @@ Control IDs ...@@ -311,7 +311,7 @@ Control IDs
180. Rotating the image to 90 and 270 will reverse the height and 180. Rotating the image to 90 and 270 will reverse the height and
width of the display window. It is necessary to set the new height width of the display window. It is necessary to set the new height
and width of the picture using the and width of the picture using the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl according to the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl according to the
rotation angle selected. rotation angle selected.
``V4L2_CID_BG_COLOR`` ``(integer)`` ``V4L2_CID_BG_COLOR`` ``(integer)``
...@@ -362,10 +362,10 @@ Control IDs ...@@ -362,10 +362,10 @@ Control IDs
and version, see :ref:`querycap`. and version, see :ref:`querycap`.
Applications can enumerate the available controls with the Applications can enumerate the available controls with the
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` and :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` and
:ref:`VIDIOC_QUERYMENU <vidioc-queryctrl>` ioctls, get and set a :ref:`VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>` ioctls, get and set a
control value with the :ref:`VIDIOC_G_CTRL <vidioc-g-ctrl>` and control value with the :ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
:ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` ioctls. Drivers must implement :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls. Drivers must implement
``VIDIOC_QUERYCTRL``, ``VIDIOC_G_CTRL`` and ``VIDIOC_S_CTRL`` when the ``VIDIOC_QUERYCTRL``, ``VIDIOC_G_CTRL`` and ``VIDIOC_S_CTRL`` when the
device has one or more controls, ``VIDIOC_QUERYMENU`` when it has one or device has one or more controls, ``VIDIOC_QUERYMENU`` when it has one or
more menu type controls. more menu type controls.
...@@ -522,7 +522,7 @@ more menu type controls. ...@@ -522,7 +522,7 @@ more menu type controls.
the real IDs. the real IDs.
Many applications today still use the ``V4L2_CID_PRIVATE_BASE`` IDs Many applications today still use the ``V4L2_CID_PRIVATE_BASE`` IDs
instead of using :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` with instead of using :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` with
the ``V4L2_CTRL_FLAG_NEXT_CTRL`` flag to enumerate all IDs, so the ``V4L2_CTRL_FLAG_NEXT_CTRL`` flag to enumerate all IDs, so
support for ``V4L2_CID_PRIVATE_BASE`` is still around. support for ``V4L2_CID_PRIVATE_BASE`` is still around.
......
...@@ -14,17 +14,17 @@ offset into a video signal. ...@@ -14,17 +14,17 @@ offset into a video signal.
Applications can use the following API to select an area in the video Applications can use the following API to select an area in the video
signal, query the default area and the hardware limits. *Despite their signal, query the default area and the hardware limits. *Despite their
name, the :ref:`VIDIOC_CROPCAP <vidioc-cropcap>`, name, the :ref:`VIDIOC_CROPCAP <VIDIOC_CROPCAP>`,
:ref:`VIDIOC_G_CROP <vidioc-g-crop>` and :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and
:ref:`VIDIOC_S_CROP <vidioc-g-crop>` ioctls apply to input as well :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` ioctls apply to input as well
as output devices.* as output devices.*
Scaling requires a source and a target. On a video capture or overlay Scaling requires a source and a target. On a video capture or overlay
device the source is the video signal, and the cropping ioctls determine device the source is the video signal, and the cropping ioctls determine
the area actually sampled. The target are images read by the application the area actually sampled. The target are images read by the application
or overlaid onto the graphics screen. Their size (and position for an or overlaid onto the graphics screen. Their size (and position for an
overlay) is negotiated with the :ref:`VIDIOC_G_FMT <vidioc-g-fmt>` overlay) is negotiated with the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
and :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctls. and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls.
On a video output device the source are the images passed in by the On a video output device the source are the images passed in by the
application, and their size is again negotiated with the application, and their size is again negotiated with the
...@@ -108,7 +108,7 @@ they may prefer a particular image size or a certain area in the video ...@@ -108,7 +108,7 @@ they may prefer a particular image size or a certain area in the video
signal. If the driver has to adjust both to satisfy hardware signal. If the driver has to adjust both to satisfy hardware
limitations, the last requested rectangle shall take priority, and the limitations, the last requested rectangle shall take priority, and the
driver should preferably adjust the opposite one. The driver should preferably adjust the opposite one. The
:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl however shall not change :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl however shall not change
the driver state and therefore only adjust the requested rectangle. the driver state and therefore only adjust the requested rectangle.
Suppose scaling on a video capture device is restricted to a factor 1:1 Suppose scaling on a video capture device is restricted to a factor 1:1
......
...@@ -25,7 +25,7 @@ Devices supporting the video capture interface set the ...@@ -25,7 +25,7 @@ Devices supporting the video capture interface set the
``V4L2_CAP_VIDEO_CAPTURE`` or ``V4L2_CAP_VIDEO_CAPTURE_MPLANE`` flag in ``V4L2_CAP_VIDEO_CAPTURE`` or ``V4L2_CAP_VIDEO_CAPTURE_MPLANE`` flag in
the ``capabilities`` field of struct the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. As secondary device :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. As secondary device
functions they may also support the :ref:`video overlay <overlay>` functions they may also support the :ref:`video overlay <overlay>`
(``V4L2_CAP_VIDEO_OVERLAY``) and the :ref:`raw VBI capture <raw-vbi>` (``V4L2_CAP_VIDEO_OVERLAY``) and the :ref:`raw VBI capture <raw-vbi>`
(``V4L2_CAP_VBI_CAPTURE``) interface. At least one of the read/write or (``V4L2_CAP_VBI_CAPTURE``) interface. At least one of the read/write or
...@@ -65,7 +65,7 @@ To query the current image format applications set the ``type`` field of ...@@ -65,7 +65,7 @@ To query the current image format applications set the ``type`` field of
a struct :ref:`v4l2_format <v4l2-format>` to a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_CAPTURE`` or ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` or
``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE`` and call the ``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE`` and call the
:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl with a pointer to this :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer to this
structure. Drivers fill the struct structure. Drivers fill the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct :ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp`` :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp``
...@@ -75,12 +75,12 @@ To request different parameters applications set the ``type`` field of a ...@@ -75,12 +75,12 @@ To request different parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>` fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results ``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 ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl with a pointer to this structure. Drivers may adjust the 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 ``VIDIOC_G_FMT``
does. does.
Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl
can be used to learn about hardware limitations without disabling I/O or can be used to learn about hardware limitations without disabling I/O or
possibly time consuming hardware preparations. possibly time consuming hardware preparations.
......
...@@ -15,7 +15,7 @@ A memory-to-memory video node acts just like a normal video node, but it ...@@ -15,7 +15,7 @@ A memory-to-memory video node acts just like a normal video node, but it
supports both output (sending frames from memory to the codec hardware) supports both output (sending frames from memory to the codec hardware)
and capture (receiving the processed frames from the codec hardware into and capture (receiving the processed frames from the codec hardware into
memory) stream I/O. An application will have to setup the stream I/O for memory) stream I/O. An application will have to setup the stream I/O for
both sides and finally call :ref:`VIDIOC_STREAMON <vidioc-streamon>` both sides and finally call :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
for both capture and output to start the codec. for both capture and output to start the codec.
Video compression codecs use the MPEG controls to setup their codec Video compression codecs use the MPEG controls to setup their codec
......
...@@ -14,9 +14,9 @@ events. ...@@ -14,9 +14,9 @@ events.
To receive events, the events the user is interested in first must be To receive events, the events the user is interested in first must be
subscribed using the subscribed using the
:ref:`VIDIOC_SUBSCRIBE_EVENT <vidioc-subscribe-event>` ioctl. Once :ref:`VIDIOC_SUBSCRIBE_EVENT <VIDIOC_SUBSCRIBE_EVENT>` ioctl. Once
an event is subscribed, the events of subscribed types are dequeueable an event is subscribed, the events of subscribed types are dequeueable
using the :ref:`VIDIOC_DQEVENT <vidioc-dqevent>` ioctl. Events may be using the :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>` ioctl. Events may be
unsubscribed using VIDIOC_UNSUBSCRIBE_EVENT ioctl. The special event unsubscribed using VIDIOC_UNSUBSCRIBE_EVENT ioctl. The special event
type V4L2_EVENT_ALL may be used to unsubscribe all the events the type V4L2_EVENT_ALL may be used to unsubscribe all the events the
driver supports. driver supports.
......
...@@ -17,7 +17,7 @@ The OSD function is accessible through the same character special file ...@@ -17,7 +17,7 @@ The OSD function is accessible through the same character special file
as the :ref:`Video Output <capture>` function. Note the default as the :ref:`Video Output <capture>` function. Note the default
function of such a ``/dev/video`` device is video capturing or output. function of such a ``/dev/video`` device is video capturing or output.
The OSD function is only available after calling the The OSD function is only available after calling the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
Querying Capabilities Querying Capabilities
...@@ -26,7 +26,7 @@ Querying Capabilities ...@@ -26,7 +26,7 @@ Querying Capabilities
Devices supporting the *Video Output Overlay* interface set the Devices supporting the *Video Output Overlay* interface set the
``V4L2_CAP_VIDEO_OUTPUT_OVERLAY`` flag in the ``capabilities`` field of ``V4L2_CAP_VIDEO_OUTPUT_OVERLAY`` flag in the ``capabilities`` field of
struct :ref:`v4l2_capability <v4l2-capability>` returned by the struct :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl.
Framebuffer Framebuffer
...@@ -36,7 +36,7 @@ Contrary to the *Video Overlay* interface the framebuffer is normally ...@@ -36,7 +36,7 @@ Contrary to the *Video Overlay* interface the framebuffer is normally
implemented on the TV card and not the graphics card. On Linux it is implemented on the TV card and not the graphics card. On Linux it is
accessible as a framebuffer device (``/dev/fbN``). Given a V4L2 device, accessible as a framebuffer device (``/dev/fbN``). Given a V4L2 device,
applications can find the corresponding framebuffer device by calling applications can find the corresponding framebuffer device by calling
the :ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>` ioctl. It returns, amongst the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` ioctl. It returns, amongst
other information, the physical address of the framebuffer in the other information, the physical address of the framebuffer in the
``base`` field of struct :ref:`v4l2_framebuffer <v4l2-framebuffer>`. ``base`` field of struct :ref:`v4l2_framebuffer <v4l2-framebuffer>`.
The framebuffer device ioctl ``FBIOGET_FSCREENINFO`` returns the same The framebuffer device ioctl ``FBIOGET_FSCREENINFO`` returns the same
...@@ -115,17 +115,17 @@ clipping/blending method to be used for the overlay. To get the current ...@@ -115,17 +115,17 @@ clipping/blending method to be used for the overlay. To get the current
parameters applications set the ``type`` field of a struct parameters applications set the ``type`` field of a struct
:ref:`v4l2_format <v4l2-format>` to :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY`` and call the ``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY`` and call the
:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl. The driver fills the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl. The driver fills the
:c:type:`struct v4l2_window` substructure named ``win``. It is not :c:type:`struct v4l2_window` substructure named ``win``. It is not
possible to retrieve a previously programmed clipping list or bitmap. possible to retrieve a previously programmed clipping list or bitmap.
To program the source rectangle applications set the ``type`` field of a To program the source rectangle applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` to struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY``, initialize the ``win`` ``V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY``, initialize the ``win``
substructure and call the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. substructure and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
The driver adjusts the parameters against hardware limits and returns 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 ``VIDIOC_G_FMT`` does. Like ``VIDIOC_S_FMT``,
the :ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl can be used to learn the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to learn
about driver capabilities without actually changing driver state. Unlike about driver capabilities without actually changing driver state. Unlike
``VIDIOC_S_FMT`` this also works after the overlay has been enabled. ``VIDIOC_S_FMT`` this also works after the overlay has been enabled.
......
...@@ -24,7 +24,7 @@ Devices supporting the video output interface set the ...@@ -24,7 +24,7 @@ Devices supporting the video output interface set the
``V4L2_CAP_VIDEO_OUTPUT`` or ``V4L2_CAP_VIDEO_OUTPUT_MPLANE`` flag in ``V4L2_CAP_VIDEO_OUTPUT`` or ``V4L2_CAP_VIDEO_OUTPUT_MPLANE`` flag in
the ``capabilities`` field of struct the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. As secondary device :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. As secondary device
functions they may also support the :ref:`raw VBI output <raw-vbi>` functions they may also support the :ref:`raw VBI output <raw-vbi>`
(``V4L2_CAP_VBI_OUTPUT``) interface. At least one of the read/write or (``V4L2_CAP_VBI_OUTPUT``) interface. At least one of the read/write or
streaming I/O methods must be supported. Modulators and audio outputs streaming I/O methods must be supported. Modulators and audio outputs
...@@ -62,7 +62,7 @@ defaults. An example is given in :ref:`crop`. ...@@ -62,7 +62,7 @@ defaults. An example is given in :ref:`crop`.
To query the current image format applications set the ``type`` field of To query the current image format applications set the ``type`` field of
a struct :ref:`v4l2_format <v4l2-format>` to a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OUTPUT`` or ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE`` ``V4L2_BUF_TYPE_VIDEO_OUTPUT`` or ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE``
and call the :ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl with a pointer and call the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer
to this structure. Drivers fill the struct to this structure. Drivers fill the struct
:ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct :ref:`v4l2_pix_format <v4l2-pix-format>` ``pix`` or the struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp`` :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` ``pix_mp``
...@@ -72,12 +72,12 @@ To request different parameters applications set the ``type`` field of a ...@@ -72,12 +72,12 @@ To request different parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` as above and initialize all struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>` fields of the struct :ref:`v4l2_pix_format <v4l2-pix-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results ``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 ``VIDIOC_G_FMT``, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl with a pointer to this structure. Drivers may adjust the 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 ``VIDIOC_G_FMT``
does. does.
Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl Like ``VIDIOC_S_FMT`` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl
can be used to learn about hardware limitations without disabling I/O or can be used to learn about hardware limitations without disabling I/O or
possibly time consuming hardware preparations. possibly time consuming hardware preparations.
......
...@@ -20,7 +20,7 @@ Video overlay devices are accessed through the same character special ...@@ -20,7 +20,7 @@ Video overlay devices are accessed through the same character special
files as :ref:`video capture <capture>` devices. Note the default files as :ref:`video capture <capture>` devices. Note the default
function of a ``/dev/video`` device is video capturing. The overlay function of a ``/dev/video`` device is video capturing. The overlay
function is only available after calling the function is only available after calling the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
The driver may support simultaneous overlay and capturing using the The driver may support simultaneous overlay and capturing using the
read/write and streaming I/O methods. If so, operation at the nominal read/write and streaming I/O methods. If so, operation at the nominal
...@@ -41,7 +41,7 @@ Querying Capabilities ...@@ -41,7 +41,7 @@ Querying Capabilities
Devices supporting the video overlay interface set the Devices supporting the video overlay interface set the
``V4L2_CAP_VIDEO_OVERLAY`` flag in the ``capabilities`` field of struct ``V4L2_CAP_VIDEO_OVERLAY`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. The overlay I/O :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. The overlay I/O
method specified below must be supported. Tuners and audio inputs are method specified below must be supported. Tuners and audio inputs are
optional. optional.
...@@ -63,8 +63,8 @@ Setup ...@@ -63,8 +63,8 @@ Setup
Before overlay can commence applications must program the driver with Before overlay can commence applications must program the driver with
frame buffer parameters, namely the address and size of the frame buffer frame buffer parameters, namely the address and size of the frame buffer
and the image format, for example RGB 5:6:5. The and the image format, for example RGB 5:6:5. The
:ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>` and :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and
:ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>` ioctls are available to get 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 ``VIDIOC_S_FBUF`` ioctl is
privileged because it allows to set up DMA into physical memory, privileged because it allows to set up DMA into physical memory,
bypassing the memory protection mechanisms of the kernel. Only the bypassing the memory protection mechanisms of the kernel. Only the
...@@ -101,8 +101,8 @@ A driver may support any (or none) of five clipping/blending methods: ...@@ -101,8 +101,8 @@ A driver may support any (or none) of five clipping/blending methods:
When simultaneous capturing and overlay is supported and the hardware When simultaneous capturing and overlay is supported and the hardware
prohibits different image and frame buffer formats, the format requested prohibits different image and frame buffer formats, the format requested
first takes precedence. The attempt to capture first takes precedence. The attempt to capture
(:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`) or overlay (:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`) or overlay
(:ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>`) may fail with an EBUSY error (:ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`) may fail with an EBUSY error
code or return accordingly modified parameters.. code or return accordingly modified parameters..
...@@ -121,17 +121,17 @@ its position over the graphics surface and the clipping to be applied. ...@@ -121,17 +121,17 @@ its position over the graphics surface and the clipping to be applied.
To get the current parameters applications set the ``type`` field of a To get the current parameters applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` to struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OVERLAY`` and call the ``V4L2_BUF_TYPE_VIDEO_OVERLAY`` and call the
:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl. The driver fills the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl. The driver fills the
:c:type:`struct v4l2_window` substructure named ``win``. It is not :c:type:`struct v4l2_window` substructure named ``win``. It is not
possible to retrieve a previously programmed clipping list or bitmap. possible to retrieve a previously programmed clipping list or bitmap.
To program the overlay window applications set the ``type`` field of a To program the overlay window applications set the ``type`` field of a
struct :ref:`v4l2_format <v4l2-format>` to struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VIDEO_OVERLAY``, initialize the ``win`` substructure and ``V4L2_BUF_TYPE_VIDEO_OVERLAY``, initialize the ``win`` substructure and
call the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. The driver call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. The driver
adjusts the parameters against hardware limits and returns the actual adjusts the parameters against hardware limits and returns the actual
parameters as ``VIDIOC_G_FMT`` does. Like ``VIDIOC_S_FMT``, the parameters as ``VIDIOC_G_FMT`` does. Like ``VIDIOC_S_FMT``, the
:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl can be used to learn :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to learn
about driver capabilities without actually changing driver state. Unlike about driver capabilities without actually changing driver state. Unlike
``VIDIOC_S_FMT`` this also works after the overlay has been enabled. ``VIDIOC_S_FMT`` this also works after the overlay has been enabled.
...@@ -142,7 +142,7 @@ of the cropping rectangle. For more information see :ref:`crop`. ...@@ -142,7 +142,7 @@ of the cropping rectangle. For more information see :ref:`crop`.
When simultaneous capturing and overlay is supported and the hardware When simultaneous capturing and overlay is supported and the hardware
prohibits different image and window sizes, the size requested first prohibits different image and window sizes, the size requested first
takes precedence. The attempt to capture or overlay as well takes precedence. The attempt to capture or overlay as well
(:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`) may fail with an EBUSY error (:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`) may fail with an EBUSY error
code or return accordingly modified parameters. code or return accordingly modified parameters.
...@@ -154,7 +154,7 @@ struct v4l2_window ...@@ -154,7 +154,7 @@ struct v4l2_window
``struct v4l2_rect w`` ``struct v4l2_rect w``
Size and position of the window relative to the top, left corner of Size and position of the window relative to the top, left corner of
the frame buffer defined with the frame buffer defined with
:ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>`. The window can extend the :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`. The window can extend the
frame buffer width and height, the ``x`` and ``y`` coordinates can frame buffer width and height, the ``x`` and ``y`` coordinates can
be negative, and it can lie completely outside the frame buffer. The be negative, and it can lie completely outside the frame buffer. The
driver clips the window accordingly, or if that is not possible, driver clips the window accordingly, or if that is not possible,
...@@ -169,7 +169,7 @@ struct v4l2_window ...@@ -169,7 +169,7 @@ struct v4l2_window
``__u32 chromakey`` ``__u32 chromakey``
When chroma-keying has been negotiated with When chroma-keying has been negotiated with
:ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>` applications set this field :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` applications set this field
to the desired pixel value for the chroma key. The format is the to the desired pixel value for the chroma key. The format is the
same as the pixel format of the framebuffer (struct same as the pixel format of the framebuffer (struct
:ref:`v4l2_framebuffer <v4l2-framebuffer>` ``fmt.pixelformat`` :ref:`v4l2_framebuffer <v4l2-framebuffer>` ``fmt.pixelformat``
...@@ -179,7 +179,7 @@ struct v4l2_window ...@@ -179,7 +179,7 @@ struct v4l2_window
``struct v4l2_clip * clips`` ``struct v4l2_clip * clips``
When chroma-keying has *not* been negotiated and When chroma-keying has *not* been negotiated and
:ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>` indicated this capability, :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` indicated this capability,
applications can set this field to point to an array of clipping applications can set this field to point to an array of clipping
rectangles. rectangles.
...@@ -192,7 +192,7 @@ applications should merge adjacent rectangles. Whether this must create ...@@ -192,7 +192,7 @@ applications should merge adjacent rectangles. Whether this must create
x-y or y-x bands, or the order of rectangles, is not defined. When clip x-y or y-x bands, or the order of rectangles, is not defined. When clip
lists are not supported the driver ignores this field. Its contents lists are not supported the driver ignores this field. Its contents
after calling after calling
!ri!:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` !ri!:ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
are undefined. are undefined.
``__u32 clipcount`` ``__u32 clipcount``
...@@ -204,7 +204,7 @@ are undefined. ...@@ -204,7 +204,7 @@ are undefined.
``void * bitmap`` ``void * bitmap``
When chroma-keying has *not* been negotiated and When chroma-keying has *not* been negotiated and
:ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>` indicated this capability, :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` indicated this capability,
applications can set this field to point to a clipping bit mask. applications can set this field to point to a clipping bit mask.
It must be of the same size as the window, ``w.width`` and ``w.height``. It must be of the same size as the window, ``w.width`` and ``w.height``.
...@@ -220,7 +220,7 @@ bits like: ...@@ -220,7 +220,7 @@ bits like:
where ``0`` ≤ x < ``w.width`` and ``0`` ≤ y <``w.height``. [2]_ where ``0`` ≤ x < ``w.width`` and ``0`` ≤ y <``w.height``. [2]_
When a clipping bit mask is not supported the driver ignores this field, 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 its contents after calling :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` are
undefined. When a bit mask is supported but no clipping is desired this undefined. When a bit mask is supported but no clipping is desired this
field must be set to ``NULL``. field must be set to ``NULL``.
...@@ -234,12 +234,12 @@ exceeded are undefined. [3]_ ...@@ -234,12 +234,12 @@ exceeded are undefined. [3]_
The global alpha value used to blend the framebuffer with video The global alpha value used to blend the framebuffer with video
images, if global alpha blending has been negotiated images, if global alpha blending has been negotiated
(``V4L2_FBUF_FLAG_GLOBAL_ALPHA``, see (``V4L2_FBUF_FLAG_GLOBAL_ALPHA``, see
:ref:`VIDIOC_S_FBUF <vidioc-g-fbuf>`, :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`,
:ref:`framebuffer-flags`). :ref:`framebuffer-flags`).
Note this field was added in Linux 2.6.23, extending the structure. Note this field was added in Linux 2.6.23, extending the structure.
However the However the
!ri!:ref:`VIDIOC_G/S/TRY_FMT <vidioc-g-fmt>` !ri!:ref:`VIDIOC_G/S/TRY_FMT <VIDIOC_G_FMT>`
ioctls, which take a pointer to a ioctls, which take a pointer to a
!ri!:ref:`v4l2_format <v4l2-format>` !ri!:ref:`v4l2_format <v4l2-format>`
parent structure with padding bytes at the end, are not affected. parent structure with padding bytes at the end, are not affected.
...@@ -289,7 +289,7 @@ Enabling Overlay ...@@ -289,7 +289,7 @@ Enabling Overlay
================ ================
To start or stop the frame buffer overlay applications call the To start or stop the frame buffer overlay applications call the
:ref:`VIDIOC_OVERLAY <vidioc-overlay>` ioctl. :ref:`VIDIOC_OVERLAY <VIDIOC_OVERLAY>` ioctl.
.. [1] .. [1]
A common application of two file descriptors is the XFree86 A common application of two file descriptors is the XFree86
......
...@@ -21,7 +21,7 @@ Devices supporting the radio interface set the ``V4L2_CAP_RADIO`` and ...@@ -21,7 +21,7 @@ Devices supporting the radio interface set the ``V4L2_CAP_RADIO`` and
``V4L2_CAP_TUNER`` or ``V4L2_CAP_MODULATOR`` flag in the ``V4L2_CAP_TUNER`` or ``V4L2_CAP_MODULATOR`` flag in the
``capabilities`` field of struct ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. Other combinations of :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. Other combinations of
capability flags are reserved for future extensions. capability flags are reserved for future extensions.
...@@ -47,8 +47,8 @@ discussed in :ref:`tuner`) with index number zero to select the radio ...@@ -47,8 +47,8 @@ discussed in :ref:`tuner`) with index number zero to select the radio
frequency and to determine if a monaural or FM stereo program is frequency and to determine if a monaural or FM stereo program is
received/emitted. Drivers switch automatically between AM and FM received/emitted. Drivers switch automatically between AM and FM
depending on the selected frequency. The depending on the selected frequency. The
:ref:`VIDIOC_G_TUNER <vidioc-g-tuner>` or :ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` or
:ref:`VIDIOC_G_MODULATOR <vidioc-g-modulator>` ioctl reports the :ref:`VIDIOC_G_MODULATOR <VIDIOC_G_MODULATOR>` ioctl reports the
supported frequency range. supported frequency range.
......
...@@ -28,7 +28,7 @@ applies to both input and output devices. ...@@ -28,7 +28,7 @@ applies to both input and output devices.
To address the problems of finding related video and VBI devices VBI To address the problems of finding related video and VBI devices VBI
capturing and output is also available as device function under capturing and output is also available as device function under
``/dev/video``. To capture or output raw VBI data with these devices ``/dev/video``. To capture or output raw VBI data with these devices
applications must call the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. applications must call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.
Accessed as ``/dev/vbi``, raw VBI capturing or output is the default Accessed as ``/dev/vbi``, raw VBI capturing or output is the default
device function. device function.
...@@ -40,7 +40,7 @@ Devices supporting the raw VBI capturing or output API set the ...@@ -40,7 +40,7 @@ Devices supporting the raw VBI capturing or output API set the
``V4L2_CAP_VBI_CAPTURE`` or ``V4L2_CAP_VBI_OUTPUT`` flags, respectively, ``V4L2_CAP_VBI_CAPTURE`` or ``V4L2_CAP_VBI_OUTPUT`` flags, respectively,
in the ``capabilities`` field of struct in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. At least one of the :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. At least one of the
read/write, streaming or asynchronous I/O methods must be supported. VBI read/write, streaming or asynchronous I/O methods must be supported. VBI
devices may or may not have a tuner or modulator. devices may or may not have a tuner or modulator.
...@@ -71,7 +71,7 @@ parameters and then checking if the actual parameters are suitable. ...@@ -71,7 +71,7 @@ parameters and then checking if the actual parameters are suitable.
To query the current raw VBI capture parameters applications set the To query the current raw VBI capture parameters applications set the
``type`` field of a struct :ref:`v4l2_format <v4l2-format>` to ``type`` field of a struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_VBI_CAPTURE`` or ``V4L2_BUF_TYPE_VBI_OUTPUT``, and call ``V4L2_BUF_TYPE_VBI_CAPTURE`` or ``V4L2_BUF_TYPE_VBI_OUTPUT``, and call
the :ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl with a pointer to this the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer to this
structure. Drivers fill the struct structure. Drivers fill the struct
:ref:`v4l2_vbi_format <v4l2-vbi-format>` ``vbi`` member of the :ref:`v4l2_vbi_format <v4l2-vbi-format>` ``vbi`` member of the
``fmt`` union. ``fmt`` union.
...@@ -80,7 +80,7 @@ To request different parameters applications set the ``type`` field of a ...@@ -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 struct :ref:`v4l2_format <v4l2-format>` as above and initialize all
fields of the struct :ref:`v4l2_vbi_format <v4l2-vbi-format>` fields of the struct :ref:`v4l2_vbi_format <v4l2-vbi-format>`
``vbi`` member of the ``fmt`` union, or better just modify the results ``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 ``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 ioctl with a pointer to this structure. Drivers return an EINVAL error
code only when the given parameters are ambiguous, otherwise they modify code only when the given parameters are ambiguous, otherwise they modify
the parameters according to the hardware capabilities and return the the parameters according to the hardware capabilities and return the
...@@ -91,7 +91,7 @@ happen for instance when the video and VBI areas to capture would ...@@ -91,7 +91,7 @@ happen for instance when the video and VBI areas to capture would
overlap, or when the driver supports multiple opens and another process overlap, or when the driver supports multiple opens and another process
already requested VBI capturing or output. Anyway, applications must already requested VBI capturing or output. Anyway, applications must
expect other resource allocation points which may return EBUSY, at the expect other resource allocation points which may return EBUSY, at the
:ref:`VIDIOC_STREAMON <vidioc-streamon>` ioctl and the first read(), :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` ioctl and the first read(),
write() and select() call. write() and select() call.
VBI devices must implement both the ``VIDIOC_G_FMT`` and VBI devices must implement both the ``VIDIOC_G_FMT`` and
...@@ -339,7 +339,7 @@ A VBI device may support :ref:`read/write <rw>` and/or streaming ...@@ -339,7 +339,7 @@ A VBI device may support :ref:`read/write <rw>` and/or streaming
The latter bears the possibility of synchronizing video and VBI data by The latter bears the possibility of synchronizing video and VBI data by
using buffer timestamps. using buffer timestamps.
Remember the :ref:`VIDIOC_STREAMON <vidioc-streamon>` ioctl and the Remember the :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` ioctl and the
first read(), write() and select() call can be resource allocation first read(), write() and select() call can be resource allocation
points returning an EBUSY error code if the required hardware resources points returning an EBUSY error code if the required hardware resources
are temporarily unavailable, for example the device is already in use by are temporarily unavailable, for example the device is already in use by
......
...@@ -33,7 +33,7 @@ Querying Capabilities ...@@ -33,7 +33,7 @@ Querying Capabilities
Devices supporting the RDS capturing API set the Devices supporting the RDS capturing API set the
``V4L2_CAP_RDS_CAPTURE`` flag in the ``capabilities`` field of struct ``V4L2_CAP_RDS_CAPTURE`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. Any tuner that :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. Any tuner that
supports RDS will set the ``V4L2_TUNER_CAP_RDS`` flag in the supports RDS will set the ``V4L2_TUNER_CAP_RDS`` flag in the
``capability`` field of struct :ref:`v4l2_tuner <v4l2-tuner>`. If the ``capability`` field of struct :ref:`v4l2_tuner <v4l2-tuner>`. If the
driver only passes RDS blocks without interpreting the data the driver only passes RDS blocks without interpreting the data the
...@@ -52,7 +52,7 @@ Whether an RDS signal is present can be detected by looking at the ...@@ -52,7 +52,7 @@ Whether an RDS signal is present can be detected by looking at the
Devices supporting the RDS output API set the ``V4L2_CAP_RDS_OUTPUT`` Devices supporting the RDS output API set the ``V4L2_CAP_RDS_OUTPUT``
flag in the ``capabilities`` field of struct flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. Any modulator that :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. Any modulator that
supports RDS will set the ``V4L2_TUNER_CAP_RDS`` flag in the supports RDS will set the ``V4L2_TUNER_CAP_RDS`` flag in the
``capability`` field of struct ``capability`` field of struct
:ref:`v4l2_modulator <v4l2-modulator>`. In order to enable the RDS :ref:`v4l2_modulator <v4l2-modulator>`. In order to enable the RDS
......
...@@ -22,7 +22,7 @@ Devices supporting the SDR receiver interface set the ...@@ -22,7 +22,7 @@ Devices supporting the SDR receiver interface set the
``V4L2_CAP_SDR_CAPTURE`` and ``V4L2_CAP_TUNER`` flag in the ``V4L2_CAP_SDR_CAPTURE`` and ``V4L2_CAP_TUNER`` flag in the
``capabilities`` field of struct ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. That flag means the :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. That flag means the
device has an Analog to Digital Converter (ADC), which is a mandatory device has an Analog to Digital Converter (ADC), which is a mandatory
element for the SDR receiver. element for the SDR receiver.
...@@ -30,7 +30,7 @@ Devices supporting the SDR transmitter interface set the ...@@ -30,7 +30,7 @@ Devices supporting the SDR transmitter interface set the
``V4L2_CAP_SDR_OUTPUT`` and ``V4L2_CAP_MODULATOR`` flag in the ``V4L2_CAP_SDR_OUTPUT`` and ``V4L2_CAP_MODULATOR`` flag in the
``capabilities`` field of struct ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. That flag means the :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. That flag means the
device has an Digital to Analog Converter (DAC), which is a mandatory device has an Digital to Analog Converter (DAC), which is a mandatory
element for the SDR transmitter. element for the SDR transmitter.
...@@ -52,7 +52,7 @@ radio frequency. The tuner index of the RF tuner (if any) must always ...@@ -52,7 +52,7 @@ radio frequency. The tuner index of the RF tuner (if any) must always
follow the SDR tuner index. Normally the SDR tuner is #0 and the RF follow the SDR tuner index. Normally the SDR tuner is #0 and the RF
tuner is #1. tuner is #1.
The :ref:`VIDIOC_S_HW_FREQ_SEEK <vidioc-s-hw-freq-seek>` ioctl is The :ref:`VIDIOC_S_HW_FREQ_SEEK <VIDIOC_S_HW_FREQ_SEEK>` ioctl is
not supported. not supported.
...@@ -63,7 +63,7 @@ The SDR device uses the :ref:`format <format>` ioctls to select the ...@@ -63,7 +63,7 @@ The SDR device uses the :ref:`format <format>` ioctls to select the
capture and output format. Both the sampling resolution and the data capture and output format. Both the sampling resolution and the data
streaming format are bound to that selectable format. In addition to the streaming format are bound to that selectable format. In addition to the
basic :ref:`format <format>` ioctls, the basic :ref:`format <format>` ioctls, the
:ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` ioctl must be supported as :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` ioctl must be supported as
well. well.
To use the :ref:`format <format>` ioctls applications set the ``type`` To use the :ref:`format <format>` ioctls applications set the ``type``
......
...@@ -21,7 +21,7 @@ Sliced VBI capture and output devices are accessed through the same ...@@ -21,7 +21,7 @@ Sliced VBI capture and output devices are accessed through the same
character special files as raw VBI devices. When a driver supports both character special files as raw VBI devices. When a driver supports both
interfaces, the default function of a ``/dev/vbi`` device is *raw* VBI interfaces, the default function of a ``/dev/vbi`` device is *raw* VBI
capturing or output, and the sliced VBI function is only available after capturing or output, and the sliced VBI function is only available after
calling the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl as defined calling the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl as defined
below. Likewise a ``/dev/video`` device may support the sliced VBI API, below. Likewise a ``/dev/video`` device may support the sliced VBI API,
however the default function here is video capturing or output. however the default function here is video capturing or output.
Different file descriptors must be used to pass raw and sliced VBI data Different file descriptors must be used to pass raw and sliced VBI data
...@@ -35,7 +35,7 @@ Devices supporting the sliced VBI capturing or output API set the ...@@ -35,7 +35,7 @@ Devices supporting the sliced VBI capturing or output API set the
``V4L2_CAP_SLICED_VBI_CAPTURE`` or ``V4L2_CAP_SLICED_VBI_OUTPUT`` flag ``V4L2_CAP_SLICED_VBI_CAPTURE`` or ``V4L2_CAP_SLICED_VBI_OUTPUT`` flag
respectively, in the ``capabilities`` field of struct respectively, in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. At least one of the :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. At least one of the
read/write, streaming or asynchronous :ref:`I/O methods <io>` must be read/write, streaming or asynchronous :ref:`I/O methods <io>` must be
supported. Sliced VBI devices may have a tuner or modulator. supported. Sliced VBI devices may have a tuner or modulator.
...@@ -57,10 +57,10 @@ Sliced VBI Format Negotiation ...@@ -57,10 +57,10 @@ Sliced VBI Format Negotiation
To find out which data services are supported by the hardware To find out which data services are supported by the hardware
applications can call the applications can call the
:ref:`VIDIOC_G_SLICED_VBI_CAP <vidioc-g-sliced-vbi-cap>` ioctl. :ref:`VIDIOC_G_SLICED_VBI_CAP <VIDIOC_G_SLICED_VBI_CAP>` ioctl.
All drivers implementing the sliced VBI interface must support this All drivers implementing the sliced VBI interface must support this
ioctl. The results may differ from those of the ioctl. The results may differ from those of the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl when the number of VBI :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl when the number of VBI
lines the hardware can capture or output per frame, or the number of lines the hardware can capture or output per frame, or the number of
services it can identify on a given line are limited. For example on PAL services it can identify on a given line are limited. For example on PAL
line 16 the hardware may be able to look for a VPS or Teletext signal, line 16 the hardware may be able to look for a VPS or Teletext signal,
...@@ -70,13 +70,13 @@ To determine the currently selected services applications set the ...@@ -70,13 +70,13 @@ To determine the currently selected services applications set the
``type`` field of struct :ref:`v4l2_format <v4l2-format>` to ``type`` field of struct :ref:`v4l2_format <v4l2-format>` to
``V4L2_BUF_TYPE_SLICED_VBI_CAPTURE`` or ``V4L2_BUF_TYPE_SLICED_VBI_CAPTURE`` or
``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT``, and the ``V4L2_BUF_TYPE_SLICED_VBI_OUTPUT``, and the
:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctl fills the ``fmt.sliced`` :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl fills the ``fmt.sliced``
member, a struct member, a struct
:ref:`v4l2_sliced_vbi_format <v4l2-sliced-vbi-format>`. :ref:`v4l2_sliced_vbi_format <v4l2-sliced-vbi-format>`.
Applications can request different parameters by initializing or Applications can request different parameters by initializing or
modifying the ``fmt.sliced`` member and calling the modifying the ``fmt.sliced`` member and calling the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl with a pointer to the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl with a pointer to the
:c:type:`struct v4l2_format` structure. :c:type:`struct v4l2_format` structure.
The sliced VBI API is more complicated than the raw VBI API because the The sliced VBI API is more complicated than the raw VBI API because the
...@@ -90,12 +90,12 @@ array according to hardware capabilities. Only if more precise control ...@@ -90,12 +90,12 @@ array according to hardware capabilities. Only if more precise control
is needed should the programmer set the ``service_lines`` array is needed should the programmer set the ``service_lines`` array
explicitly. explicitly.
The :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl modifies the parameters The :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl modifies the parameters
according to hardware capabilities. When the driver allocates resources according to hardware capabilities. When the driver allocates resources
at this point, it may return an EBUSY error code if the required at this point, it may return an EBUSY error code if the required
resources are temporarily unavailable. Other resource allocation points resources are temporarily unavailable. Other resource allocation points
which may return EBUSY can be the which may return EBUSY can be the
:ref:`VIDIOC_STREAMON <vidioc-streamon>` ioctl and the first :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` ioctl and the first
:ref:`read() <func-read>`, :ref:`write() <func-write>` and :ref:`read() <func-read>`, :ref:`write() <func-write>` and
:ref:`select() <func-select>` call. :ref:`select() <func-select>` call.
...@@ -117,8 +117,8 @@ which may return EBUSY can be the ...@@ -117,8 +117,8 @@ which may return EBUSY can be the
- :cspan:`2` - :cspan:`2`
If ``service_set`` is non-zero when passed with If ``service_set`` is non-zero when passed with
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` or :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` or
:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>`, the ``service_lines`` :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`, the ``service_lines``
array will be filled by the driver according to the services array will be filled by the driver according to the services
specified in this field. For example, if ``service_set`` is specified in this field. For example, if ``service_set`` is
initialized with ``V4L2_SLICED_TELETEXT_B | V4L2_SLICED_WSS_625``, initialized with ``V4L2_SLICED_TELETEXT_B | V4L2_SLICED_WSS_625``,
...@@ -224,8 +224,8 @@ which may return EBUSY can be the ...@@ -224,8 +224,8 @@ which may return EBUSY can be the
- :cspan:`2` Maximum number of bytes passed by one - :cspan:`2` Maximum number of bytes passed by one
:ref:`read() <func-read>` or :ref:`write() <func-write>` call, :ref:`read() <func-read>` or :ref:`write() <func-write>` call,
and the buffer size in bytes for the and the buffer size in bytes for the
:ref:`VIDIOC_QBUF <vidioc-qbuf>` and :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. Drivers set this field :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. Drivers set this field
to the size of struct to the size of struct
:ref:`v4l2_sliced_vbi_data <v4l2-sliced-vbi-data>` times the :ref:`v4l2_sliced_vbi_data <v4l2-sliced-vbi-data>` times the
number of non-zero elements in the returned ``service_lines`` number of non-zero elements in the returned ``service_lines``
...@@ -340,11 +340,11 @@ Drivers may return an EINVAL error code when applications attempt to ...@@ -340,11 +340,11 @@ Drivers may return an EINVAL error code when applications attempt to
read or write data without prior format negotiation, after switching the read or write data without prior format negotiation, after switching the
video standard (which may invalidate the negotiated VBI parameters) and video standard (which may invalidate the negotiated VBI parameters) and
after switching the video input (which may change the video standard as after switching the video input (which may change the video standard as
a side effect). The :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl may a side effect). The :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl may
return an EBUSY error code when applications attempt to change the return an EBUSY error code when applications attempt to change the
format while i/o is in progress (between a format while i/o is in progress (between a
:ref:`VIDIOC_STREAMON <vidioc-streamon>` and :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` call, and after the first :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` call, and after the first
:ref:`read() <func-read>` or :ref:`write() <func-write>` call). :ref:`read() <func-read>` or :ref:`write() <func-write>` call).
...@@ -428,12 +428,12 @@ of one video frame. The ``id`` of unused ...@@ -428,12 +428,12 @@ of one video frame. The ``id`` of unused
Packets are always passed in ascending line number order, without Packets are always passed in ascending line number order, without
duplicate line numbers. The :ref:`write() <func-write>` function and duplicate line numbers. The :ref:`write() <func-write>` function and
the :ref:`VIDIOC_QBUF <vidioc-qbuf>` ioctl must return an EINVAL the :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl must return an EINVAL
error code when applications violate this rule. They must also return an error code when applications violate this rule. They must also return an
EINVAL error code when applications pass an incorrect field or line EINVAL error code when applications pass an incorrect field or line
number, or a combination of ``field``, ``line`` and ``id`` which has not number, or a combination of ``field``, ``line`` and ``id`` which has not
been negotiated with the :ref:`VIDIOC_G_FMT <vidioc-g-fmt>` or been negotiated with the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` or
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. When the line numbers are :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. When the line numbers are
unknown the driver must pass the packets in transmitted order. The unknown the driver must pass the packets in transmitted order. The
driver can insert empty packets with ``id`` set to zero anywhere in the driver can insert empty packets with ``id`` set to zero anywhere in the
packet array. packet array.
......
...@@ -86,7 +86,7 @@ Pad-level Formats ...@@ -86,7 +86,7 @@ Pad-level Formats
Image formats are typically negotiated on video capture and output Image formats are typically negotiated on video capture and output
devices using the format and devices using the format and
:ref:`selection <vidioc-subdev-g-selection>` ioctls. The driver is :ref:`selection <VIDIOC_SUBDEV_G_SELECTION>` ioctls. The driver is
responsible for configuring every block in the video pipeline according responsible for configuring every block in the video pipeline according
to the requested format at the pipeline input and/or output. to the requested format at the pipeline input and/or output.
...@@ -118,18 +118,18 @@ every point in the pipeline explicitly. ...@@ -118,18 +118,18 @@ every point in the pipeline explicitly.
Drivers that implement the :ref:`media API <media-controller-intro>` Drivers that implement the :ref:`media API <media-controller-intro>`
can expose pad-level image format configuration to applications. When can expose pad-level image format configuration to applications. When
they do, applications can use the they do, applications can use the
:ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` and :ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` and
:ref:`VIDIOC_SUBDEV_S_FMT <vidioc-subdev-g-fmt>` ioctls. to :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctls. to
negotiate formats on a per-pad basis. negotiate formats on a per-pad basis.
Applications are responsible for configuring coherent parameters on the Applications are responsible for configuring coherent parameters on the
whole pipeline and making sure that connected pads have compatible whole pipeline and making sure that connected pads have compatible
formats. The pipeline is checked for formats mismatch at formats. The pipeline is checked for formats mismatch at
:ref:`VIDIOC_STREAMON <vidioc-streamon>` time, and an EPIPE error :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` time, and an EPIPE error
code is then returned if the configuration is invalid. code is then returned if the configuration is invalid.
Pad-level image format configuration support can be tested by calling Pad-level image format configuration support can be tested by calling
the :ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` ioctl on pad the :ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` ioctl on pad
0. If the driver returns an EINVAL error code pad-level format 0. If the driver returns an EINVAL error code pad-level format
configuration is not supported by the sub-device. configuration is not supported by the sub-device.
...@@ -146,8 +146,8 @@ formats enumeration only. A format negotiation mechanism is required. ...@@ -146,8 +146,8 @@ formats enumeration only. A format negotiation mechanism is required.
Central to the format negotiation mechanism are the get/set format Central to the format negotiation mechanism are the get/set format
operations. When called with the ``which`` argument set to operations. When called with the ``which`` argument set to
``V4L2_SUBDEV_FORMAT_TRY``, the ``V4L2_SUBDEV_FORMAT_TRY``, the
:ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` and :ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` and
:ref:`VIDIOC_SUBDEV_S_FMT <vidioc-subdev-g-fmt>` ioctls operate on :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctls operate on
a set of formats parameters that are not connected to the hardware a set of formats parameters that are not connected to the hardware
configuration. Modifying those 'try' formats leaves the device state configuration. Modifying those 'try' formats leaves the device state
untouched (this applies to both the software state stored in the driver untouched (this applies to both the software state stored in the driver
...@@ -155,14 +155,14 @@ and the hardware state stored in the device itself). ...@@ -155,14 +155,14 @@ and the hardware state stored in the device itself).
While not kept as part of the device state, try formats are stored in While not kept as part of the device state, try formats are stored in
the sub-device file handles. A the sub-device file handles. A
:ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` call will return :ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` call will return
the last try format set *on the same sub-device file handle*. Several the last try format set *on the same sub-device file handle*. Several
applications querying the same sub-device at the same time will thus not applications querying the same sub-device at the same time will thus not
interact with each other. interact with each other.
To find out whether a particular format is supported by the device, To find out whether a particular format is supported by the device,
applications use the applications use the
:ref:`VIDIOC_SUBDEV_S_FMT <vidioc-subdev-g-fmt>` ioctl. Drivers :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctl. Drivers
verify and, if needed, change the requested ``format`` based on device verify and, if needed, change the requested ``format`` based on device
requirements and return the possibly modified value. Applications can requirements and return the possibly modified value. Applications can
then choose to try a different format or accept the returned value and then choose to try a different format or accept the returned value and
...@@ -171,7 +171,7 @@ continue. ...@@ -171,7 +171,7 @@ continue.
Formats returned by the driver during a negotiation iteration are Formats returned by the driver during a negotiation iteration are
guaranteed to be supported by the device. In particular, drivers guaranteed to be supported by the device. In particular, drivers
guarantee that a returned format will not be further changed if passed guarantee that a returned format will not be further changed if passed
to an :ref:`VIDIOC_SUBDEV_S_FMT <vidioc-subdev-g-fmt>` call as-is to an :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` call as-is
(as long as external parameters, such as formats on other pads or links' (as long as external parameters, such as formats on other pads or links'
configuration are not changed). configuration are not changed).
...@@ -353,7 +353,7 @@ struct :ref:`v4l2_rect <v4l2-rect>`. ...@@ -353,7 +353,7 @@ struct :ref:`v4l2_rect <v4l2-rect>`.
Scaling support is optional. When supported by a subdev, the crop Scaling support is optional. When supported by a subdev, the crop
rectangle on the subdev's sink pad is scaled to the size configured rectangle on the subdev's sink pad is scaled to the size configured
using the using the
:ref:`VIDIOC_SUBDEV_S_SELECTION <vidioc-subdev-g-selection>` IOCTL :ref:`VIDIOC_SUBDEV_S_SELECTION <VIDIOC_SUBDEV_G_SELECTION>` IOCTL
using ``V4L2_SEL_TGT_COMPOSE`` selection target on the same pad. If the using ``V4L2_SEL_TGT_COMPOSE`` selection target on the same pad. If the
subdev supports scaling but not composing, the top and left values are subdev supports scaling but not composing, the top and left values are
not used and must always be set to zero. not used and must always be set to zero.
......
...@@ -14,15 +14,15 @@ previously exported for a different or the same device (known as the ...@@ -14,15 +14,15 @@ previously exported for a different or the same device (known as the
importer role), or both. This section describes the DMABUF importer role importer role), or both. This section describes the DMABUF importer role
API in V4L2. API in V4L2.
Refer to :ref:`DMABUF exporting <vidioc-expbuf>` for details about Refer to :ref:`DMABUF exporting <VIDIOC_EXPBUF>` for details about
exporting V4L2 buffers as DMABUF file descriptors. exporting V4L2 buffers as DMABUF file descriptors.
Input and output devices support the streaming I/O method when the Input and output devices support the streaming I/O method when the
``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct ``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl is set. Whether :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set. Whether
importing DMA buffers through DMABUF file descriptors is supported is importing DMA buffers through DMABUF file descriptors is supported is
determined by calling the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` determined by calling the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`
ioctl with the memory type set to ``V4L2_MEMORY_DMABUF``. ioctl with the memory type set to ``V4L2_MEMORY_DMABUF``.
This I/O method is dedicated to sharing DMA buffers between different This I/O method is dedicated to sharing DMA buffers between different
...@@ -34,7 +34,7 @@ such file descriptor are exchanged. The descriptors and meta-information ...@@ -34,7 +34,7 @@ such file descriptor are exchanged. The descriptors and meta-information
are passed in struct :ref:`v4l2_buffer <v4l2-buffer>` (or in struct are passed in struct :ref:`v4l2_buffer <v4l2-buffer>` (or in struct
:ref:`v4l2_plane <v4l2-plane>` in the multi-planar API case). The :ref:`v4l2_plane <v4l2-plane>` in the multi-planar API case). The
driver must be switched into DMABUF I/O mode by calling the driver must be switched into DMABUF I/O mode by calling the
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` with the desired buffer type. :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` with the desired buffer type.
.. code-block:: c .. code-block:: c
...@@ -56,7 +56,7 @@ driver must be switched into DMABUF I/O mode by calling the ...@@ -56,7 +56,7 @@ driver must be switched into DMABUF I/O mode by calling the
} }
The buffer (plane) file descriptor is passed on the fly with the The buffer (plane) file descriptor is passed on the fly with the
:ref:`VIDIOC_QBUF <vidioc-qbuf>` ioctl. In case of multiplanar :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl. In case of multiplanar
buffers, every plane can be associated with a different DMABUF buffers, every plane can be associated with a different DMABUF
descriptor. Although buffers are commonly cycled, applications can pass descriptor. Although buffers are commonly cycled, applications can pass
a different DMABUF descriptor at each ``VIDIOC_QBUF`` call. a different DMABUF descriptor at each ``VIDIOC_QBUF`` call.
...@@ -112,11 +112,11 @@ a different DMABUF descriptor at each ``VIDIOC_QBUF`` call. ...@@ -112,11 +112,11 @@ a different DMABUF descriptor at each ``VIDIOC_QBUF`` call.
} }
Captured or displayed buffers are dequeued with the Captured or displayed buffers are dequeued with the
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. The driver can unlock the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. The driver can unlock the
buffer at any time between the completion of the DMA and this ioctl. The buffer at any time between the completion of the DMA and this ioctl. The
memory is also unlocked when memory is also unlocked when
:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` is called, :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` is called,
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>`, or when the device is closed. :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`, or when the device is closed.
For capturing applications it is customary to enqueue a number of empty For capturing applications it is customary to enqueue a number of empty
buffers, to start capturing and enter the read loop. Here the buffers, to start capturing and enter the read loop. Here the
...@@ -134,8 +134,8 @@ immediately with an EAGAIN error code when no buffer is available. The ...@@ -134,8 +134,8 @@ immediately with an EAGAIN error code when no buffer is available. The
functions are always available. functions are always available.
To start and stop capturing or displaying applications call the To start and stop capturing or displaying applications call the
:ref:`VIDIOC_STREAMON <vidioc-streamon>` and :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` ioctls. Note that :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctls. Note that
``VIDIOC_STREAMOFF`` removes all buffers from both queues and unlocks ``VIDIOC_STREAMOFF`` removes all buffers from both queues and unlocks
all buffers as a side effect. Since there is no notion of doing anything all buffers as a side effect. Since there is no notion of doing anything
"now" on a multitasking system, if an application needs to synchronize "now" on a multitasking system, if an application needs to synchronize
......
...@@ -24,14 +24,14 @@ standards. ...@@ -24,14 +24,14 @@ standards.
To enumerate and query the attributes of the DV timings supported by a To enumerate and query the attributes of the DV timings supported by a
device applications use the device applications use the
:ref:`VIDIOC_ENUM_DV_TIMINGS <vidioc-enum-dv-timings>` and :ref:`VIDIOC_ENUM_DV_TIMINGS <VIDIOC_ENUM_DV_TIMINGS>` and
:ref:`VIDIOC_DV_TIMINGS_CAP <vidioc-dv-timings-cap>` ioctls. To set :ref:`VIDIOC_DV_TIMINGS_CAP <VIDIOC_DV_TIMINGS_CAP>` ioctls. To set
DV timings for the device applications use the DV timings for the device applications use the
:ref:`VIDIOC_S_DV_TIMINGS <vidioc-g-dv-timings>` ioctl and to get :ref:`VIDIOC_S_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>` ioctl and to get
current DV timings they use the current DV timings they use the
:ref:`VIDIOC_G_DV_TIMINGS <vidioc-g-dv-timings>` ioctl. To detect :ref:`VIDIOC_G_DV_TIMINGS <VIDIOC_G_DV_TIMINGS>` ioctl. To detect
the DV timings as seen by the video receiver applications use the the DV timings as seen by the video receiver applications use the
:ref:`VIDIOC_QUERY_DV_TIMINGS <vidioc-query-dv-timings>` ioctl. :ref:`VIDIOC_QUERY_DV_TIMINGS <VIDIOC_QUERY_DV_TIMINGS>` ioctl.
Applications can make use of the :ref:`input-capabilities` and Applications can make use of the :ref:`input-capabilities` and
:ref:`output-capabilities` flags to determine whether the digital :ref:`output-capabilities` flags to determine whether the digital
......
...@@ -39,12 +39,12 @@ The Extended Control API ...@@ -39,12 +39,12 @@ The Extended Control API
======================== ========================
Three new ioctls are available: Three new ioctls are available:
:ref:`VIDIOC_G_EXT_CTRLS <vidioc-g-ext-ctrls>`, :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
:ref:`VIDIOC_S_EXT_CTRLS <vidioc-g-ext-ctrls>` and :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` and
:ref:`VIDIOC_TRY_EXT_CTRLS <vidioc-g-ext-ctrls>`. These ioctls act :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`. These ioctls act
on arrays of controls (as opposed to the on arrays of controls (as opposed to the
:ref:`VIDIOC_G_CTRL <vidioc-g-ctrl>` and :ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` and
:ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` ioctls that act on a single :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` ioctls that act on a single
control). This is needed since it is often required to atomically change control). This is needed since it is often required to atomically change
several controls at once. several controls at once.
...@@ -79,17 +79,17 @@ with compound types should only be used programmatically. ...@@ -79,17 +79,17 @@ with compound types should only be used programmatically.
Since such compound controls need to expose more information about Since such compound controls need to expose more information about
themselves than is possible with themselves than is possible with
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` the :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` the
:ref:`VIDIOC_QUERY_EXT_CTRL <vidioc-queryctrl>` ioctl was added. In :ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>` ioctl was added. In
particular, this ioctl gives the dimensions of the N-dimensional array particular, this ioctl gives the dimensions of the N-dimensional array
if this control consists of more than one element. if this control consists of more than one element.
It is important to realize that due to the flexibility of controls it is It is important to realize that due to the flexibility of controls it is
necessary to check whether the control you want to set actually is necessary to check whether the control you want to set actually is
supported in the driver and what the valid range of values is. So use supported in the driver and what the valid range of values is. So use
the :ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` (or the :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` (or
:ref:`VIDIOC_QUERY_EXT_CTRL <vidioc-queryctrl>`) and :ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>`) and
:ref:`VIDIOC_QUERYMENU <vidioc-queryctrl>` ioctls to check this. Also :ref:`VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>` ioctls to check this. Also
note that it is possible that some of the menu indices in a control of note that it is possible that some of the menu indices in a control of
type ``V4L2_CTRL_TYPE_MENU`` may not be supported (``VIDIOC_QUERYMENU`` type ``V4L2_CTRL_TYPE_MENU`` may not be supported (``VIDIOC_QUERYMENU``
will return an error). A good example is the list of supported MPEG will return an error). A good example is the list of supported MPEG
...@@ -103,7 +103,7 @@ Enumerating Extended Controls ...@@ -103,7 +103,7 @@ Enumerating Extended Controls
============================= =============================
The recommended way to enumerate over the extended controls is by using The recommended way to enumerate over the extended controls is by using
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` in combination with the :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` in combination with the
``V4L2_CTRL_FLAG_NEXT_CTRL`` flag: ``V4L2_CTRL_FLAG_NEXT_CTRL`` flag:
...@@ -169,7 +169,7 @@ within a control panel. ...@@ -169,7 +169,7 @@ within a control panel.
The flags field of struct :ref:`v4l2_queryctrl <v4l2-queryctrl>` also The flags field of struct :ref:`v4l2_queryctrl <v4l2-queryctrl>` also
contains hints on the behavior of the control. See the contains hints on the behavior of the control. See the
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` documentation for more :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` documentation for more
details. details.
...@@ -198,7 +198,7 @@ Codec Control IDs ...@@ -198,7 +198,7 @@ Codec Control IDs
``V4L2_CID_MPEG_CLASS (class)`` ``V4L2_CID_MPEG_CLASS (class)``
The Codec class descriptor. Calling The Codec class descriptor. Calling
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class. This description can be return a description of this control class. This description can be
used as the caption of a Tab page in a GUI, for example. used as the caption of a Tab page in a GUI, for example.
...@@ -1168,7 +1168,7 @@ Codec Control IDs ...@@ -1168,7 +1168,7 @@ Codec Control IDs
This read-only control returns the 33-bit video Presentation Time This read-only control returns the 33-bit video Presentation Time
Stamp as defined in ITU T-REC-H.222.0 and ISO/IEC 13818-1 of the Stamp as defined in ITU T-REC-H.222.0 and ISO/IEC 13818-1 of the
currently displayed frame. This is the same PTS as is used in currently displayed frame. This is the same PTS as is used in
:ref:`VIDIOC_DECODER_CMD <vidioc-decoder-cmd>`. :ref:`VIDIOC_DECODER_CMD <VIDIOC_DECODER_CMD>`.
.. _`v4l2-mpeg-video-dec-frame`: .. _`v4l2-mpeg-video-dec-frame`:
...@@ -2781,7 +2781,7 @@ Camera Control IDs ...@@ -2781,7 +2781,7 @@ Camera Control IDs
``V4L2_CID_CAMERA_CLASS (class)`` ``V4L2_CID_CAMERA_CLASS (class)``
The Camera class descriptor. Calling The Camera class descriptor. Calling
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class. return a description of this control class.
.. _`v4l2-exposure-auto-type`: .. _`v4l2-exposure-auto-type`:
...@@ -3441,7 +3441,7 @@ FM_TX Control IDs ...@@ -3441,7 +3441,7 @@ FM_TX Control IDs
``V4L2_CID_FM_TX_CLASS (class)`` ``V4L2_CID_FM_TX_CLASS (class)``
The FM_TX class descriptor. Calling The FM_TX class descriptor. Calling
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class. return a description of this control class.
``V4L2_CID_RDS_TX_DEVIATION (integer)`` ``V4L2_CID_RDS_TX_DEVIATION (integer)``
...@@ -3870,7 +3870,7 @@ JPEG Control IDs ...@@ -3870,7 +3870,7 @@ JPEG Control IDs
``V4L2_CID_JPEG_CLASS (class)`` ``V4L2_CID_JPEG_CLASS (class)``
The JPEG class descriptor. Calling The JPEG class descriptor. Calling
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class. return a description of this control class.
``V4L2_CID_JPEG_CHROMA_SUBSAMPLING (menu)`` ``V4L2_CID_JPEG_CHROMA_SUBSAMPLING (menu)``
...@@ -4271,7 +4271,7 @@ FM_RX Control IDs ...@@ -4271,7 +4271,7 @@ FM_RX Control IDs
``V4L2_CID_FM_RX_CLASS (class)`` ``V4L2_CID_FM_RX_CLASS (class)``
The FM_RX class descriptor. Calling The FM_RX class descriptor. Calling
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class. return a description of this control class.
``V4L2_CID_RDS_RECEPTION (boolean)`` ``V4L2_CID_RDS_RECEPTION (boolean)``
...@@ -4369,7 +4369,7 @@ Detect Control IDs ...@@ -4369,7 +4369,7 @@ Detect Control IDs
``V4L2_CID_DETECT_CLASS (class)`` ``V4L2_CID_DETECT_CLASS (class)``
The Detect class descriptor. Calling The Detect class descriptor. Calling
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class. return a description of this control class.
``V4L2_CID_DETECT_MD_MODE (menu)`` ``V4L2_CID_DETECT_MD_MODE (menu)``
...@@ -4463,7 +4463,7 @@ RF_TUNER Control IDs ...@@ -4463,7 +4463,7 @@ RF_TUNER Control IDs
``V4L2_CID_RF_TUNER_CLASS (class)`` ``V4L2_CID_RF_TUNER_CLASS (class)``
The RF_TUNER class descriptor. Calling The RF_TUNER class descriptor. Calling
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` for this control will :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` for this control will
return a description of this control class. return a description of this control class.
``V4L2_CID_RF_TUNER_BANDWIDTH_AUTO (boolean)`` ``V4L2_CID_RF_TUNER_BANDWIDTH_AUTO (boolean)``
......
...@@ -48,7 +48,7 @@ All video capture and output devices must report the current field ...@@ -48,7 +48,7 @@ All video capture and output devices must report the current field
order. Some drivers may permit the selection of a different order, to order. Some drivers may permit the selection of a different order, to
this end applications initialize the ``field`` field of struct this end applications initialize the ``field`` field of struct
:ref:`v4l2_pix_format <v4l2-pix-format>` before calling the :ref:`v4l2_pix_format <v4l2-pix-format>` before calling the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. If this is not desired it :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. If this is not desired it
should have the value ``V4L2_FIELD_ANY`` (0). should have the value ``V4L2_FIELD_ANY`` (0).
...@@ -73,8 +73,8 @@ should have the value ``V4L2_FIELD_ANY`` (0). ...@@ -73,8 +73,8 @@ should have the value ``V4L2_FIELD_ANY`` (0).
size, and return the actual field order. Drivers must never return size, and return the actual field order. Drivers must never return
``V4L2_FIELD_ANY``. If multiple field orders are possible the ``V4L2_FIELD_ANY``. If multiple field orders are possible the
driver must choose one of the possible field orders during driver must choose one of the possible field orders during
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` or :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` or
:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>`. struct :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`. struct
:ref:`v4l2_buffer <v4l2-buffer>` ``field`` can never be :ref:`v4l2_buffer <v4l2-buffer>` ``field`` can never be
``V4L2_FIELD_ANY``. ``V4L2_FIELD_ANY``.
......
...@@ -23,9 +23,9 @@ current selection. ...@@ -23,9 +23,9 @@ current selection.
A single mechanism exists to negotiate all data formats using the A single mechanism exists to negotiate all data formats using the
aggregate struct :ref:`v4l2_format <v4l2-format>` and the aggregate struct :ref:`v4l2_format <v4l2-format>` and the
:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` and :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctls. Additionally the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls. Additionally the
:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` ioctl can be used to examine :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl can be used to examine
what the hardware *could* do, without actually selecting a new data what the hardware *could* do, without actually selecting a new data
format. The data formats supported by the V4L2 API are covered in the format. The data formats supported by the V4L2 API are covered in the
respective device section in :ref:`devices`. For a closer look at respective device section in :ref:`devices`. For a closer look at
...@@ -52,7 +52,7 @@ image size. ...@@ -52,7 +52,7 @@ image size.
When applications omit the ``VIDIOC_S_FMT`` ioctl its locking side When applications omit the ``VIDIOC_S_FMT`` ioctl its locking side
effects are implied by the next step, the selection of an I/O method effects are implied by the next step, the selection of an I/O method
with the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl or implicit with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl or implicit
with the first :ref:`read() <func-read>` or with the first :ref:`read() <func-read>` or
:ref:`write() <func-write>` call. :ref:`write() <func-write>` call.
...@@ -75,7 +75,7 @@ Apart of the generic format negotiation functions a special ioctl to ...@@ -75,7 +75,7 @@ Apart of the generic format negotiation functions a special ioctl to
enumerate all image formats supported by video capture, overlay or enumerate all image formats supported by video capture, overlay or
output devices is available. [1]_ output devices is available. [1]_
The :ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` ioctl must be supported The :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` ioctl must be supported
by all drivers exchanging image data with applications. by all drivers exchanging image data with applications.
**Important** **Important**
......
...@@ -98,8 +98,8 @@ application address space, preferably at address ``start``. This latter ...@@ -98,8 +98,8 @@ application address space, preferably at address ``start``. This latter
address is a hint only, and is usually specified as 0. address is a hint only, and is usually specified as 0.
Suitable length and offset parameters are queried with the Suitable length and offset parameters are queried with the
:ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` ioctl. Buffers must be :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl. Buffers must be
allocated with the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl allocated with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl
before they can be queried. before they can be queried.
To unmap buffers the :ref:`munmap() <func-munmap>` function is used. To unmap buffers the :ref:`munmap() <func-munmap>` function is used.
...@@ -125,7 +125,7 @@ EINVAL ...@@ -125,7 +125,7 @@ EINVAL
The ``flags`` or ``prot`` value is not supported. The ``flags`` or ``prot`` value is not supported.
No buffers have been allocated with the No buffers have been allocated with the
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl. :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
ENOMEM ENOMEM
Not enough physical or virtual memory was available to complete the Not enough physical or virtual memory was available to complete the
......
...@@ -33,7 +33,7 @@ Arguments ...@@ -33,7 +33,7 @@ Arguments
devices only writing. devices only writing.
When the ``O_NONBLOCK`` flag is given, the read() function and the When the ``O_NONBLOCK`` flag is given, the read() function and the
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl will return the EAGAIN :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will return the EAGAIN
error code when no data is available or no buffer is in the driver error code when no data is available or no buffer is in the driver
outgoing queue, otherwise these functions block until data becomes outgoing queue, otherwise these functions block until data becomes
available. All V4L2 drivers exchanging data with applications must available. All V4L2 drivers exchanging data with applications must
......
...@@ -30,9 +30,9 @@ output. ...@@ -30,9 +30,9 @@ output.
When streaming I/O has been negotiated this function waits until a When streaming I/O has been negotiated this function waits until a
buffer has been filled by the capture device and can be dequeued with buffer has been filled by the capture device and can be dequeued with
the :ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. For output devices this the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. For output devices this
function waits until the device is ready to accept a new buffer to be function waits until the device is ready to accept a new buffer to be
queued up with the :ref:`VIDIOC_QBUF <vidioc-qbuf>` ioctl for queued up with the :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl for
display. When buffers are already in the outgoing queue of the driver display. When buffers are already in the outgoing queue of the driver
(capture) or the incoming queue isn't full (display) the function (capture) or the incoming queue isn't full (display) the function
returns immediately. returns immediately.
...@@ -45,17 +45,17 @@ flags in the ``revents`` field, output devices the ``POLLOUT`` and ...@@ -45,17 +45,17 @@ flags in the ``revents`` field, output devices the ``POLLOUT`` and
``POLLWRNORM`` flags. When the function timed out it returns a value of ``POLLWRNORM`` flags. When the function timed out it returns a value of
zero, on failure it returns -1 and the ``errno`` variable is set zero, on failure it returns -1 and the ``errno`` variable is set
appropriately. When the application did not call appropriately. When the application did not call
:ref:`VIDIOC_STREAMON <vidioc-streamon>` the :c:func:`poll()` :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` the :c:func:`poll()`
function succeeds, but sets the ``POLLERR`` flag in the ``revents`` function succeeds, but sets the ``POLLERR`` flag in the ``revents``
field. When the application has called field. When the application has called
:ref:`VIDIOC_STREAMON <vidioc-streamon>` for a capture device but :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` for a capture device but
hasn't yet called :ref:`VIDIOC_QBUF <vidioc-qbuf>`, the hasn't yet called :ref:`VIDIOC_QBUF <VIDIOC_QBUF>`, the
:c:func:`poll()` function succeeds and sets the ``POLLERR`` flag in :c:func:`poll()` function succeeds and sets the ``POLLERR`` flag in
the ``revents`` field. For output devices this same situation will cause the ``revents`` field. For output devices this same situation will cause
:c:func:`poll()` to succeed as well, but it sets the ``POLLOUT`` and :c:func:`poll()` to succeed as well, but it sets the ``POLLOUT`` and
``POLLWRNORM`` flags in the ``revents`` field. ``POLLWRNORM`` flags in the ``revents`` field.
If an event occurred (see :ref:`VIDIOC_DQEVENT <vidioc-dqevent>`) If an event occurred (see :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>`)
then ``POLLPRI`` will be set in the ``revents`` field and then ``POLLPRI`` will be set in the ``revents`` field and
:c:func:`poll()` will return. :c:func:`poll()` will return.
......
...@@ -85,8 +85,8 @@ enough. Again, the behavior when the driver runs out of free buffers ...@@ -85,8 +85,8 @@ enough. Again, the behavior when the driver runs out of free buffers
depends on the discarding policy. depends on the discarding policy.
Applications can get and set the number of buffers used internally by Applications can get and set the number of buffers used internally by
the driver with the :ref:`VIDIOC_G_PARM <vidioc-g-parm>` and the driver with the :ref:`VIDIOC_G_PARM <VIDIOC_G_PARM>` and
:ref:`VIDIOC_S_PARM <vidioc-g-parm>` ioctls. They are optional, :ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctls. They are optional,
however. The discarding policy is not reported and cannot be changed. however. The discarding policy is not reported and cannot be changed.
For minimum requirements see :ref:`devices`. For minimum requirements see :ref:`devices`.
......
...@@ -32,17 +32,17 @@ for output. ...@@ -32,17 +32,17 @@ for output.
When streaming I/O has been negotiated this function waits until a When streaming I/O has been negotiated this function waits until a
buffer has been filled or displayed and can be dequeued with the buffer has been filled or displayed and can be dequeued with the
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. When buffers are already in :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. When buffers are already in
the outgoing queue of the driver the function returns immediately. the outgoing queue of the driver the function returns immediately.
On success :c:func:`select()` returns the total number of bits set in On success :c:func:`select()` returns the total number of bits set in
the :c:type:`struct fd_set`s. When the function timed out it returns the :c:type:`struct fd_set`s. When the function timed out it returns
a value of zero. On failure it returns -1 and the ``errno`` variable is a value of zero. On failure it returns -1 and the ``errno`` variable is
set appropriately. When the application did not call set appropriately. When the application did not call
:ref:`VIDIOC_QBUF <vidioc-qbuf>` or :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` or
:ref:`VIDIOC_STREAMON <vidioc-streamon>` yet the :c:func:`select()` :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` yet the :c:func:`select()`
function succeeds, setting the bit of the file descriptor in ``readfds`` function succeeds, setting the bit of the file descriptor in ``readfds``
or ``writefds``, but subsequent :ref:`VIDIOC_DQBUF <vidioc-qbuf>` or ``writefds``, but subsequent :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`
calls will fail. [1]_ calls will fail. [1]_
When use of the :c:func:`read()` function has been negotiated and the When use of the :c:func:`read()` function has been negotiated and the
......
...@@ -16,12 +16,12 @@ read or write will fail at any time. ...@@ -16,12 +16,12 @@ read or write will fail at any time.
Other methods must be negotiated. To select the streaming I/O method Other methods must be negotiated. To select the streaming I/O method
with memory mapped or user buffers applications call the with memory mapped or user buffers applications call the
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl. The asynchronous I/O :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl. The asynchronous I/O
method is not defined yet. method is not defined yet.
Video overlay can be considered another I/O method, although the Video overlay can be considered another I/O method, although the
application does not directly receive the image data. It is selected by application does not directly receive the image data. It is selected by
initiating video overlay with the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` initiating video overlay with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl. For more information see :ref:`overlay`. ioctl. For more information see :ref:`overlay`.
Generally exactly one I/O method, including overlay, is associated with Generally exactly one I/O method, including overlay, is associated with
......
...@@ -91,17 +91,17 @@ and to enhance the image quality. ...@@ -91,17 +91,17 @@ and to enhance the image quality.
In most cases, libv4l2 just passes the calls directly through to the In most cases, libv4l2 just passes the calls directly through to the
v4l2 driver, intercepting the calls to v4l2 driver, intercepting the calls to
:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>`, :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`,
:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
:ref:`VIDIOC_ENUM_FRAMESIZES <vidioc-enum-framesizes>` and :ref:`VIDIOC_ENUM_FRAMESIZES <VIDIOC_ENUM_FRAMESIZES>` and
:ref:`VIDIOC_ENUM_FRAMEINTERVALS <vidioc-enum-frameintervals>` in :ref:`VIDIOC_ENUM_FRAMEINTERVALS <VIDIOC_ENUM_FRAMEINTERVALS>` in
order to emulate the formats order to emulate the formats
:ref:`V4L2_PIX_FMT_BGR24 <V4L2-PIX-FMT-BGR24>`, :ref:`V4L2_PIX_FMT_BGR24 <V4L2-PIX-FMT-BGR24>`,
:ref:`V4L2_PIX_FMT_RGB24 <V4L2-PIX-FMT-RGB24>`, :ref:`V4L2_PIX_FMT_RGB24 <V4L2-PIX-FMT-RGB24>`,
:ref:`V4L2_PIX_FMT_YUV420 <V4L2-PIX-FMT-YUV420>`, and :ref:`V4L2_PIX_FMT_YUV420 <V4L2-PIX-FMT-YUV420>`, and
:ref:`V4L2_PIX_FMT_YVU420 <V4L2-PIX-FMT-YVU420>`, if they aren't :ref:`V4L2_PIX_FMT_YVU420 <V4L2-PIX-FMT-YVU420>`, if they aren't
available in the driver. :ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` available in the driver. :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>`
keeps enumerating the hardware supported formats, plus the emulated keeps enumerating the hardware supported formats, plus the emulated
formats offered by libv4l at the end. formats offered by libv4l at the end.
......
...@@ -9,10 +9,10 @@ Streaming I/O (Memory Mapping) ...@@ -9,10 +9,10 @@ Streaming I/O (Memory Mapping)
Input and output devices support this I/O method when the Input and output devices support this I/O method when the
``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct ``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl is set. There are two :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set. There are two
streaming methods, to determine if the memory mapping flavor is streaming methods, to determine if the memory mapping flavor is
supported applications must call the supported applications must call the
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl. :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
Streaming is an I/O method where only pointers to buffers are exchanged Streaming is an I/O method where only pointers to buffers are exchanged
between application and driver, the data itself is not copied. Memory between application and driver, the data itself is not copied. Memory
...@@ -29,7 +29,7 @@ a different type of data. To access different sets at the same time ...@@ -29,7 +29,7 @@ a different type of data. To access different sets at the same time
different file descriptors must be used. [1]_ different file descriptors must be used. [1]_
To allocate device buffers applications call the To allocate device buffers applications call the
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl with the desired number :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl with the desired number
of buffers and buffer type, for example ``V4L2_BUF_TYPE_VIDEO_CAPTURE``. of buffers and buffer type, for example ``V4L2_BUF_TYPE_VIDEO_CAPTURE``.
This ioctl can also be used to change the number of buffers or to free This ioctl can also be used to change the number of buffers or to free
the allocated memory, provided none of the buffers are still mapped. the allocated memory, provided none of the buffers are still mapped.
...@@ -37,7 +37,7 @@ the allocated memory, provided none of the buffers are still mapped. ...@@ -37,7 +37,7 @@ the allocated memory, provided none of the buffers are still mapped.
Before applications can access the buffers they must map them into their Before applications can access the buffers they must map them into their
address space with the :ref:`mmap() <func-mmap>` function. The address space with the :ref:`mmap() <func-mmap>` function. The
location of the buffers in device memory can be determined with the location of the buffers in device memory can be determined with the
:ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` ioctl. In the single-planar :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl. In the single-planar
API case, the ``m.offset`` and ``length`` returned in a struct API case, the ``m.offset`` and ``length`` returned in a struct
:ref:`v4l2_buffer <v4l2-buffer>` are passed as sixth and second :ref:`v4l2_buffer <v4l2-buffer>` are passed as sixth and second
parameter to the :c:func:`mmap()` function. When using the parameter to the :c:func:`mmap()` function. When using the
...@@ -227,10 +227,10 @@ when the application runs out of free buffers, it must wait until an ...@@ -227,10 +227,10 @@ when the application runs out of free buffers, it must wait until an
empty buffer can be dequeued and reused. empty buffer can be dequeued and reused.
To enqueue and dequeue a buffer applications use the To enqueue and dequeue a buffer applications use the
:ref:`VIDIOC_QBUF <vidioc-qbuf>` and :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. The status of a buffer being :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. The status of a buffer being
mapped, enqueued, full or empty can be determined at any time using the mapped, enqueued, full or empty can be determined at any time using the
:ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` ioctl. Two methods exist to :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl. Two methods exist to
suspend execution of the application until one or more buffers can be suspend execution of the application until one or more buffers can be
dequeued. By default ``VIDIOC_DQBUF`` blocks when no buffer is in the dequeued. By default ``VIDIOC_DQBUF`` blocks when no buffer is in the
outgoing queue. When the ``O_NONBLOCK`` flag was given to the outgoing queue. When the ``O_NONBLOCK`` flag was given to the
...@@ -240,8 +240,8 @@ immediately with an EAGAIN error code when no buffer is available. The ...@@ -240,8 +240,8 @@ immediately with an EAGAIN error code when no buffer is available. The
are always available. are always available.
To start and stop capturing or output applications call the To start and stop capturing or output applications call the
:ref:`VIDIOC_STREAMON <vidioc-streamon>` and :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` ioctl. Note :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctl. Note
``VIDIOC_STREAMOFF`` removes all buffers from both queues as a side ``VIDIOC_STREAMOFF`` removes all buffers from both queues as a side
effect. Since there is no notion of doing anything "now" on a effect. Since there is no notion of doing anything "now" on a
multitasking system, if an application needs to synchronize with another multitasking system, if an application needs to synchronize with another
...@@ -258,7 +258,7 @@ the :c:func:`mmap()`, :c:func:`munmap()`, :c:func:`select()` and ...@@ -258,7 +258,7 @@ the :c:func:`mmap()`, :c:func:`munmap()`, :c:func:`select()` and
.. [1] .. [1]
One could use one file descriptor and set the buffer type field One could use one file descriptor and set the buffer type field
accordingly when calling :ref:`VIDIOC_QBUF <vidioc-qbuf>` etc., accordingly when calling :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` etc.,
but it makes the :c:func:`select()` function ambiguous. We also but it makes the :c:func:`select()` function ambiguous. We also
like the clean approach of one file descriptor per logical stream. like the clean approach of one file descriptor per logical stream.
Video overlay for example is also a logical stream, although the CPU Video overlay for example is also a logical stream, although the CPU
......
...@@ -108,13 +108,13 @@ are comparable to an ALSA audio mixer application. Just opening a V4L2 ...@@ -108,13 +108,13 @@ are comparable to an ALSA audio mixer application. Just opening a V4L2
device should not change the state of the device. [2]_ device should not change the state of the device. [2]_
Once an application has allocated the memory buffers needed for Once an application has allocated the memory buffers needed for
streaming data (by calling the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` streaming data (by calling the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`
or :ref:`VIDIOC_CREATE_BUFS <vidioc-create-bufs>` ioctls, or or :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>` ioctls, or
implicitly by calling the :ref:`read() <func-read>` or implicitly by calling the :ref:`read() <func-read>` or
:ref:`write() <func-write>` functions) that application (filehandle) :ref:`write() <func-write>` functions) that application (filehandle)
becomes the owner of the device. It is no longer allowed to make changes becomes the owner of the device. It is no longer allowed to make changes
that would affect the buffer sizes (e.g. by calling the that would affect the buffer sizes (e.g. by calling the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl) and other applications are :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl) and other applications are
no longer allowed to allocate buffers or start or stop streaming. The no longer allowed to allocate buffers or start or stop streaming. The
EBUSY error code will be returned instead. EBUSY error code will be returned instead.
......
...@@ -27,8 +27,8 @@ Compressed Formats ...@@ -27,8 +27,8 @@ Compressed Formats
- 'JPEG' - 'JPEG'
- TBD. See also :ref:`VIDIOC_G_JPEGCOMP <vidioc-g-jpegcomp>`, - TBD. See also :ref:`VIDIOC_G_JPEGCOMP <VIDIOC_G_JPEGCOMP>`,
:ref:`VIDIOC_S_JPEGCOMP <vidioc-g-jpegcomp>`. :ref:`VIDIOC_S_JPEGCOMP <VIDIOC_G_JPEGCOMP>`.
- .. _`V4L2-PIX-FMT-MPEG`: - .. _`V4L2-PIX-FMT-MPEG`:
......
...@@ -11,9 +11,9 @@ with applications. The :c:type:`struct v4l2_pix_format` and ...@@ -11,9 +11,9 @@ with applications. The :c:type:`struct v4l2_pix_format` and
format and layout of an image in memory. The former is used with the format and layout of an image in memory. The former is used with the
single-planar API, while the latter is used with the multi-planar single-planar API, while the latter is used with the multi-planar
version (see :ref:`planar-apis`). Image formats are negotiated with version (see :ref:`planar-apis`). Image formats are negotiated with
the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl. (The explanations here the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. (The explanations here
focus on video capturing and output, for overlay frame buffer formats focus on video capturing and output, for overlay frame buffer formats
see also :ref:`VIDIOC_G_FBUF <vidioc-g-fbuf>`.) see also :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`.)
.. toctree:: .. toctree::
......
...@@ -39,29 +39,29 @@ handle multi-planar formats. ...@@ -39,29 +39,29 @@ handle multi-planar formats.
Calls that distinguish between single and multi-planar APIs Calls that distinguish between single and multi-planar APIs
=========================================================== ===========================================================
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`
Two additional multi-planar capabilities are added. They can be set Two additional multi-planar capabilities are added. They can be set
together with non-multi-planar ones for devices that handle both together with non-multi-planar ones for devices that handle both
single- and multi-planar formats. single- and multi-planar formats.
:ref:`VIDIOC_G_FMT <vidioc-g-fmt>`, :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`,
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`, :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`,
:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>`
New structures for describing multi-planar formats are added: struct New structures for describing multi-planar formats are added: struct
:ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` and :ref:`v4l2_pix_format_mplane <v4l2-pix-format-mplane>` and
struct :ref:`v4l2_plane_pix_format <v4l2-plane-pix-format>`. struct :ref:`v4l2_plane_pix_format <v4l2-plane-pix-format>`.
Drivers may define new multi-planar formats, which have distinct Drivers may define new multi-planar formats, which have distinct
FourCC codes from the existing single-planar ones. FourCC codes from the existing single-planar ones.
:ref:`VIDIOC_QBUF <vidioc-qbuf>`, :ref:`VIDIOC_QBUF <VIDIOC_QBUF>`,
:ref:`VIDIOC_DQBUF <vidioc-qbuf>`, :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`,
:ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>`
A new struct :ref:`v4l2_plane <v4l2-plane>` structure for A new struct :ref:`v4l2_plane <v4l2-plane>` structure for
describing planes is added. Arrays of this structure are passed in describing planes is added. Arrays of this structure are passed in
the new ``m.planes`` field of struct the new ``m.planes`` field of struct
:ref:`v4l2_buffer <v4l2-buffer>`. :ref:`v4l2_buffer <v4l2-buffer>`.
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`
Will allocate multi-planar buffers as requested. Will allocate multi-planar buffers as requested.
......
...@@ -11,26 +11,26 @@ are equally applicable to all types of devices. Furthermore devices of ...@@ -11,26 +11,26 @@ are equally applicable to all types of devices. Furthermore devices of
the same type have different capabilities and this specification permits the same type have different capabilities and this specification permits
the omission of a few complicated and less important parts of the API. the omission of a few complicated and less important parts of the API.
The :ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl is available to The :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is available to
check if the kernel device is compatible with this specification, and to check if the kernel device is compatible with this specification, and to
query the :ref:`functions <devices>` and :ref:`I/O methods <io>` query the :ref:`functions <devices>` and :ref:`I/O methods <io>`
supported by the device. supported by the device.
Starting with kernel version 3.1, :ref:`VIDIOC_QUERYCAP <vidioc-querycap>` Starting with kernel version 3.1, :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`
will return the V4L2 API version used by the driver, with generally will return the V4L2 API version used by the driver, with generally
matches the Kernel version. There's no need of using matches the Kernel version. There's no need of using
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` to check if a specific ioctl :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` to check if a specific ioctl
is supported, the V4L2 core now returns ENOTTY if a driver doesn't is supported, the V4L2 core now returns ENOTTY if a driver doesn't
provide support for an ioctl. provide support for an ioctl.
Other features can be queried by calling the respective ioctl, for Other features can be queried by calling the respective ioctl, for
example :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` to learn about the example :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` to learn about the
number, types and names of video connectors on the device. Although number, types and names of video connectors on the device. Although
abstraction is a major objective of this API, the abstraction is a major objective of this API, the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl also allows driver :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl also allows driver
specific applications to reliably identify the driver. specific applications to reliably identify the driver.
All V4L2 drivers must support :ref:`VIDIOC_QUERYCAP <vidioc-querycap>`. All V4L2 drivers must support :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>`.
Applications should always call this ioctl after opening the device. Applications should always call this ioctl after opening the device.
......
...@@ -10,7 +10,7 @@ Input and output devices support the :c:func:`read()` and ...@@ -10,7 +10,7 @@ Input and output devices support the :c:func:`read()` and
:c:func:`write()` function, respectively, when the :c:func:`write()` function, respectively, when the
``V4L2_CAP_READWRITE`` flag in the ``capabilities`` field of struct ``V4L2_CAP_READWRITE`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl is set. :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set.
Drivers may need the CPU to copy the data, but they may also support DMA Drivers may need the CPU to copy the data, but they may also support DMA
to or from user memory, so this I/O method is not necessarily less to or from user memory, so this I/O method is not necessarily less
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
Configuration Configuration
************* *************
Applications can use the :ref:`selection API <vidioc-g-selection>` to Applications can use the :ref:`selection API <VIDIOC_G_SELECTION>` to
select an area in a video signal or a buffer, and to query for default select an area in a video signal or a buffer, and to query for default
settings and hardware limits. settings and hardware limits.
......
...@@ -11,8 +11,8 @@ variations of standards. Each video input and output may support another ...@@ -11,8 +11,8 @@ variations of standards. Each video input and output may support another
set of standards. This set is reported by the ``std`` field of struct set of standards. This set is reported by the ``std`` field of struct
:ref:`v4l2_input <v4l2-input>` and struct :ref:`v4l2_input <v4l2-input>` and struct
:ref:`v4l2_output <v4l2-output>` returned by the :ref:`v4l2_output <v4l2-output>` returned by the
:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` and :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` ioctls, respectively. :ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctls, respectively.
V4L2 defines one bit for each analog video standard currently in use V4L2 defines one bit for each analog video standard currently in use
worldwide, and sets aside bits for driver defined standards, e. g. worldwide, and sets aside bits for driver defined standards, e. g.
...@@ -20,7 +20,7 @@ hybrid standards to watch NTSC video tapes on PAL TVs and vice versa. ...@@ -20,7 +20,7 @@ hybrid standards to watch NTSC video tapes on PAL TVs and vice versa.
Applications can use the predefined bits to select a particular Applications can use the predefined bits to select a particular
standard, although presenting the user a menu of supported standards is standard, although presenting the user a menu of supported standards is
preferred. To enumerate and query the attributes of the supported preferred. To enumerate and query the attributes of the supported
standards applications use the :ref:`VIDIOC_ENUMSTD <vidioc-enumstd>` standards applications use the :ref:`VIDIOC_ENUMSTD <VIDIOC_ENUMSTD>`
ioctl. ioctl.
Many of the defined standards are actually just variations of a few Many of the defined standards are actually just variations of a few
...@@ -36,10 +36,10 @@ Composite input may collapse standards, enumerating "PAL-B/G/H/I", ...@@ -36,10 +36,10 @@ Composite input may collapse standards, enumerating "PAL-B/G/H/I",
"NTSC-M" and "SECAM-D/K". [1]_ "NTSC-M" and "SECAM-D/K". [1]_
To query and select the standard used by the current video input or To query and select the standard used by the current video input or
output applications call the :ref:`VIDIOC_G_STD <vidioc-g-std>` and output applications call the :ref:`VIDIOC_G_STD <VIDIOC_G_STD>` and
:ref:`VIDIOC_S_STD <vidioc-g-std>` ioctl, respectively. The :ref:`VIDIOC_S_STD <VIDIOC_G_STD>` ioctl, respectively. The
*received* standard can be sensed with the *received* standard can be sensed with the
:ref:`VIDIOC_QUERYSTD <vidioc-querystd>` ioctl. Note that the :ref:`VIDIOC_QUERYSTD <VIDIOC_QUERYSTD>` ioctl. Note that the
parameter of all these ioctls is a pointer to a parameter of all these ioctls is a pointer to a
:ref:`v4l2_std_id <v4l2-std-id>` type (a standard set), *not* an :ref:`v4l2_std_id <v4l2-std-id>` type (a standard set), *not* an
index into the standard enumeration. Drivers must implement all video index into the standard enumeration. Drivers must implement all video
......
...@@ -8,7 +8,7 @@ Streaming Parameters ...@@ -8,7 +8,7 @@ Streaming Parameters
Streaming parameters are intended to optimize the video capture process Streaming parameters are intended to optimize the video capture process
as well as I/O. Presently applications can request a high quality as well as I/O. Presently applications can request a high quality
capture mode with the :ref:`VIDIOC_S_PARM <vidioc-g-parm>` ioctl. capture mode with the :ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctl.
The current video standard determines a nominal number of frames per The current video standard determines a nominal number of frames per
second. If less than this number of frames is to be captured or output, second. If less than this number of frames is to be captured or output,
...@@ -23,8 +23,8 @@ internally by a driver in read/write mode. For implications see the ...@@ -23,8 +23,8 @@ internally by a driver in read/write mode. For implications see the
section discussing the :ref:`read() <func-read>` function. section discussing the :ref:`read() <func-read>` function.
To get and set the streaming parameters applications call the To get and set the streaming parameters applications call the
:ref:`VIDIOC_G_PARM <vidioc-g-parm>` and :ref:`VIDIOC_G_PARM <VIDIOC_G_PARM>` and
:ref:`VIDIOC_S_PARM <vidioc-g-parm>` ioctl, respectively. They take :ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctl, respectively. They take
a pointer to a struct :ref:`v4l2_streamparm <v4l2-streamparm>`, which a pointer to a struct :ref:`v4l2_streamparm <v4l2-streamparm>`, which
contains a union holding separate parameters for input and output contains a union holding separate parameters for input and output
devices. devices.
......
...@@ -14,7 +14,7 @@ Video input devices can have one or more tuners demodulating a RF ...@@ -14,7 +14,7 @@ Video input devices can have one or more tuners demodulating a RF
signal. Each tuner is associated with one or more video inputs, signal. Each tuner is associated with one or more video inputs,
depending on the number of RF connectors on the tuner. The ``type`` depending on the number of RF connectors on the tuner. The ``type``
field of the respective struct :ref:`v4l2_input <v4l2-input>` field of the respective struct :ref:`v4l2_input <v4l2-input>`
returned by the :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` ioctl is returned by the :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` ioctl is
set to ``V4L2_INPUT_TYPE_TUNER`` and its ``tuner`` field contains the set to ``V4L2_INPUT_TYPE_TUNER`` and its ``tuner`` field contains the
index number of the tuner. index number of the tuner.
...@@ -22,8 +22,8 @@ Radio input devices have exactly one tuner with index zero, no video ...@@ -22,8 +22,8 @@ Radio input devices have exactly one tuner with index zero, no video
inputs. inputs.
To query and change tuner properties applications use the To query and change tuner properties applications use the
:ref:`VIDIOC_G_TUNER <vidioc-g-tuner>` and :ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` and
:ref:`VIDIOC_S_TUNER <vidioc-g-tuner>` ioctls, respectively. The :ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` ioctls, respectively. The
struct :ref:`v4l2_tuner <v4l2-tuner>` returned by ``VIDIOC_G_TUNER`` struct :ref:`v4l2_tuner <v4l2-tuner>` returned by ``VIDIOC_G_TUNER``
also contains signal status information applicable when the tuner of the also contains signal status information applicable when the tuner of the
current video or radio input is queried. Note that ``VIDIOC_S_TUNER`` current video or radio input is queried. Note that ``VIDIOC_S_TUNER``
...@@ -31,7 +31,7 @@ does not switch the current tuner, when there is more than one at all. ...@@ -31,7 +31,7 @@ does not switch the current tuner, when there is more than one at all.
The tuner is solely determined by the current video input. Drivers must The tuner is solely determined by the current video input. Drivers must
support both ioctls and set the ``V4L2_CAP_TUNER`` flag in the struct support both ioctls and set the ``V4L2_CAP_TUNER`` flag in the struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl when the device has :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl when the device has
one or more tuners. one or more tuners.
...@@ -44,7 +44,7 @@ set or video recorder. Each modulator is associated with one or more ...@@ -44,7 +44,7 @@ set or video recorder. Each modulator is associated with one or more
video outputs, depending on the number of RF connectors on the video outputs, depending on the number of RF connectors on the
modulator. The ``type`` field of the respective struct modulator. The ``type`` field of the respective struct
:ref:`v4l2_output <v4l2-output>` returned by the :ref:`v4l2_output <v4l2-output>` returned by the
:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` ioctl is set to :ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctl is set to
``V4L2_OUTPUT_TYPE_MODULATOR`` and its ``modulator`` field contains the ``V4L2_OUTPUT_TYPE_MODULATOR`` and its ``modulator`` field contains the
index number of the modulator. index number of the modulator.
...@@ -55,18 +55,18 @@ A video or radio device cannot support both a tuner and a modulator. Two ...@@ -55,18 +55,18 @@ A video or radio device cannot support both a tuner and a modulator. Two
separate device nodes will have to be used for such hardware, one that separate device nodes will have to be used for such hardware, one that
supports the tuner functionality and one that supports the modulator supports the tuner functionality and one that supports the modulator
functionality. The reason is a limitation with the functionality. The reason is a limitation with the
:ref:`VIDIOC_S_FREQUENCY <vidioc-g-frequency>` ioctl where you :ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl where you
cannot specify whether the frequency is for a tuner or a modulator. cannot specify whether the frequency is for a tuner or a modulator.
To query and change modulator properties applications use the To query and change modulator properties applications use the
:ref:`VIDIOC_G_MODULATOR <vidioc-g-modulator>` and :ref:`VIDIOC_G_MODULATOR <VIDIOC_G_MODULATOR>` and
:ref:`VIDIOC_S_MODULATOR <vidioc-g-modulator>` ioctl. Note that :ref:`VIDIOC_S_MODULATOR <VIDIOC_G_MODULATOR>` ioctl. Note that
``VIDIOC_S_MODULATOR`` does not switch the current modulator, when there ``VIDIOC_S_MODULATOR`` does not switch the current modulator, when there
is more than one at all. The modulator is solely determined by the is more than one at all. The modulator is solely determined by the
current video output. Drivers must support both ioctls and set the current video output. Drivers must support both ioctls and set the
``V4L2_CAP_MODULATOR`` flag in the struct ``V4L2_CAP_MODULATOR`` flag in the struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl when the device has :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl when the device has
one or more modulators. one or more modulators.
...@@ -74,8 +74,8 @@ Radio Frequency ...@@ -74,8 +74,8 @@ Radio Frequency
=============== ===============
To get and set the tuner or modulator radio frequency applications use To get and set the tuner or modulator radio frequency applications use
the :ref:`VIDIOC_G_FREQUENCY <vidioc-g-frequency>` and the :ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` and
:ref:`VIDIOC_S_FREQUENCY <vidioc-g-frequency>` ioctl which both take :ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl which both take
a pointer to a struct :ref:`v4l2_frequency <v4l2-frequency>`. These a pointer to a struct :ref:`v4l2_frequency <v4l2-frequency>`. These
ioctls are used for TV and radio devices alike. Drivers must support ioctls are used for TV and radio devices alike. Drivers must support
both ioctls when the tuner or modulator ioctls are supported, or when both ioctls when the tuner or modulator ioctls are supported, or when
......
...@@ -9,10 +9,10 @@ Streaming I/O (User Pointers) ...@@ -9,10 +9,10 @@ Streaming I/O (User Pointers)
Input and output devices support this I/O method when the Input and output devices support this I/O method when the
``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct ``V4L2_CAP_STREAMING`` flag in the ``capabilities`` field of struct
:ref:`v4l2_capability <v4l2-capability>` returned by the :ref:`v4l2_capability <v4l2-capability>` returned by the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl is set. If the :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl is set. If the
particular user pointer method (not only memory mapping) is supported particular user pointer method (not only memory mapping) is supported
must be determined by calling the must be determined by calling the
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl. :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
This I/O method combines advantages of the read/write and memory mapping This I/O method combines advantages of the read/write and memory mapping
methods. Buffers (planes) are allocated by the application itself, and methods. Buffers (planes) are allocated by the application itself, and
...@@ -21,7 +21,7 @@ data are exchanged, these pointers and meta-information are passed in ...@@ -21,7 +21,7 @@ data are exchanged, these pointers and meta-information are passed in
struct :ref:`v4l2_buffer <v4l2-buffer>` (or in struct struct :ref:`v4l2_buffer <v4l2-buffer>` (or in struct
:ref:`v4l2_plane <v4l2-plane>` in the multi-planar API case). The :ref:`v4l2_plane <v4l2-plane>` in the multi-planar API case). The
driver must be switched into user pointer I/O mode by calling the driver must be switched into user pointer I/O mode by calling the
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` with the desired buffer type. :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` with the desired buffer type.
No buffers (planes) are allocated beforehand, consequently they are not No buffers (planes) are allocated beforehand, consequently they are not
indexed and cannot be queried like mapped buffers with the indexed and cannot be queried like mapped buffers with the
``VIDIOC_QUERYBUF`` ioctl. ``VIDIOC_QUERYBUF`` ioctl.
...@@ -45,7 +45,7 @@ indexed and cannot be queried like mapped buffers with the ...@@ -45,7 +45,7 @@ indexed and cannot be queried like mapped buffers with the
} }
Buffer (plane) addresses and sizes are passed on the fly with the Buffer (plane) addresses and sizes are passed on the fly with the
:ref:`VIDIOC_QBUF <vidioc-qbuf>` ioctl. Although buffers are commonly :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` ioctl. Although buffers are commonly
cycled, applications can pass different addresses and sizes at each cycled, applications can pass different addresses and sizes at each
``VIDIOC_QBUF`` call. If required by the hardware the driver swaps ``VIDIOC_QBUF`` call. If required by the hardware the driver swaps
memory pages within physical memory to create a continuous area of memory pages within physical memory to create a continuous area of
...@@ -55,11 +55,11 @@ to disk they are brought back and finally locked in physical memory for ...@@ -55,11 +55,11 @@ to disk they are brought back and finally locked in physical memory for
DMA. [1]_ DMA. [1]_
Filled or displayed buffers are dequeued with the Filled or displayed buffers are dequeued with the
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl. The driver can unlock the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl. The driver can unlock the
memory pages at any time between the completion of the DMA and this memory pages at any time between the completion of the DMA and this
ioctl. The memory is also unlocked when ioctl. The memory is also unlocked when
:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` is called, :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` is called,
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>`, or when the device is closed. :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`, or when the device is closed.
Applications must take care not to free buffers without dequeuing. For Applications must take care not to free buffers without dequeuing. For
once, the buffers remain locked until further, wasting physical memory. once, the buffers remain locked until further, wasting physical memory.
Second the driver will not be notified when the memory is returned to Second the driver will not be notified when the memory is returned to
...@@ -82,8 +82,8 @@ immediately with an EAGAIN error code when no buffer is available. The ...@@ -82,8 +82,8 @@ immediately with an EAGAIN error code when no buffer is available. The
are always available. are always available.
To start and stop capturing or output applications call the To start and stop capturing or output applications call the
:ref:`VIDIOC_STREAMON <vidioc-streamon>` and :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` and
:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` ioctl. Note :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctl. Note
``VIDIOC_STREAMOFF`` removes all buffers from both queues and unlocks ``VIDIOC_STREAMOFF`` removes all buffers from both queues and unlocks
all buffers as a side effect. Since there is no notion of doing anything all buffers as a side effect. Since there is no notion of doing anything
"now" on a multitasking system, if an application needs to synchronize "now" on a multitasking system, if an application needs to synchronize
......
...@@ -86,7 +86,7 @@ Revision History ...@@ -86,7 +86,7 @@ Revision History
:revision: 4.5 / 2015-10-29 (*rr*) :revision: 4.5 / 2015-10-29 (*rr*)
Extend vidioc-g-ext-ctrls;. Replace ctrl_class with a new union with Extend VIDIOC_G_EXT_CTRLS;. Replace ctrl_class with a new union with
ctrl_class and which. Which is used to select the current value of the ctrl_class and which. Which is used to select the current value of the
control or the default value. control or the default value.
......
...@@ -14,17 +14,17 @@ Radio devices have no video inputs or outputs. ...@@ -14,17 +14,17 @@ Radio devices have no video inputs or outputs.
To learn about the number and attributes of the available inputs and To learn about the number and attributes of the available inputs and
outputs applications can enumerate them with the outputs applications can enumerate them with the
:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` and :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` ioctl, respectively. The :ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctl, respectively. The
struct :ref:`v4l2_input <v4l2-input>` returned by the struct :ref:`v4l2_input <v4l2-input>` returned by the
:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` ioctl also contains signal :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` ioctl also contains signal
:status information applicable when the current video input is queried. :status information applicable when the current video input is queried.
The :ref:`VIDIOC_G_INPUT <vidioc-g-input>` and The :ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
:ref:`VIDIOC_G_OUTPUT <vidioc-g-output>` ioctls return the index of :ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` ioctls return the index of
the current video input or output. To select a different input or output the current video input or output. To select a different input or output
applications call the :ref:`VIDIOC_S_INPUT <vidioc-g-input>` and applications call the :ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` and
:ref:`VIDIOC_S_OUTPUT <vidioc-g-output>` ioctls. Drivers must :ref:`VIDIOC_S_OUTPUT <VIDIOC_G_OUTPUT>` ioctls. Drivers must
implement all the input ioctls when the device has one or more inputs, implement all the input ioctls when the device has one or more inputs,
all the output ioctls when the device has one or more outputs. all the output ioctls when the device has one or more outputs.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-create-bufs: .. _VIDIOC_CREATE_BUFS:
************************ ************************
ioctl VIDIOC_CREATE_BUFS ioctl VIDIOC_CREATE_BUFS
...@@ -34,7 +34,7 @@ Description ...@@ -34,7 +34,7 @@ Description
This ioctl is used to create buffers for :ref:`memory mapped <mmap>` This ioctl is used to create buffers for :ref:`memory mapped <mmap>`
or :ref:`user pointer <userp>` or :ref:`DMA buffer <dmabuf>` I/O. It or :ref:`user pointer <userp>` or :ref:`DMA buffer <dmabuf>` I/O. It
can be used as an alternative or in addition to the can be used as an alternative or in addition to the
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl, when a tighter control :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl, when a tighter control
over buffers is required. This ioctl can be called multiple times to over buffers is required. This ioctl can be called multiple times to
create buffers of different sizes. create buffers of different sizes.
...@@ -47,8 +47,8 @@ array must be zeroed. ...@@ -47,8 +47,8 @@ array must be zeroed.
The ``format`` field specifies the image format that the buffers must be The ``format`` field specifies the image format that the buffers must be
able to handle. The application has to fill in this struct able to handle. The application has to fill in this struct
:ref:`v4l2_format <v4l2-format>`. Usually this will be done using the :ref:`v4l2_format <v4l2-format>`. Usually this will be done using the
:ref:`VIDIOC_TRY_FMT <vidioc-g-fmt>` or :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` or
:ref:`VIDIOC_G_FMT <vidioc-g-fmt>` ioctls to ensure that the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctls to ensure that the
requested format is supported by the driver. Based on the format's requested format is supported by the driver. Based on the format's
``type`` field the requested buffer size (for single-planar) or plane ``type`` field the requested buffer size (for single-planar) or plane
sizes (for multi-planar formats) will be used for the allocated buffers. sizes (for multi-planar formats) will be used for the allocated buffers.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-cropcap: .. _VIDIOC_CROPCAP:
******************** ********************
ioctl VIDIOC_CROPCAP ioctl VIDIOC_CROPCAP
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-dbg-g-chip-info: .. _VIDIOC_DBG_G_CHIP_INFO:
**************************** ****************************
ioctl VIDIOC_DBG_G_CHIP_INFO ioctl VIDIOC_DBG_G_CHIP_INFO
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-dbg-g-register: .. _VIDIOC_DBG_G_REGISTER:
************************************************** **************************************************
ioctl VIDIOC_DBG_G_REGISTER, VIDIOC_DBG_S_REGISTER ioctl VIDIOC_DBG_G_REGISTER, VIDIOC_DBG_S_REGISTER
...@@ -65,14 +65,14 @@ When ``match.type`` is ``V4L2_CHIP_MATCH_BRIDGE``, ``match.addr`` ...@@ -65,14 +65,14 @@ When ``match.type`` is ``V4L2_CHIP_MATCH_BRIDGE``, ``match.addr``
selects the nth non-sub-device chip on the TV card. The number zero selects the nth non-sub-device chip on the TV card. The number zero
always selects the host chip, e. g. the chip connected to the PCI or USB always selects the host chip, e. g. the chip connected to the PCI or USB
bus. You can find out which chips are present with the bus. You can find out which chips are present with the
:ref:`VIDIOC_DBG_G_CHIP_INFO <vidioc-dbg-g-chip-info>` ioctl. :ref:`VIDIOC_DBG_G_CHIP_INFO <VIDIOC_DBG_G_CHIP_INFO>` ioctl.
When ``match.type`` is ``V4L2_CHIP_MATCH_SUBDEV``, ``match.addr`` When ``match.type`` is ``V4L2_CHIP_MATCH_SUBDEV``, ``match.addr``
selects the nth sub-device. selects the nth sub-device.
These ioctls are optional, not all drivers may support them. However These ioctls are optional, not all drivers may support them. However
when a driver supports these ioctls it must also support when a driver supports these ioctls it must also support
:ref:`VIDIOC_DBG_G_CHIP_INFO <vidioc-dbg-g-chip-info>`. Conversely :ref:`VIDIOC_DBG_G_CHIP_INFO <VIDIOC_DBG_G_CHIP_INFO>`. Conversely
it may support ``VIDIOC_DBG_G_CHIP_INFO`` but not these ioctls. it may support ``VIDIOC_DBG_G_CHIP_INFO`` but not these ioctls.
``VIDIOC_DBG_G_REGISTER`` and ``VIDIOC_DBG_S_REGISTER`` were introduced ``VIDIOC_DBG_G_REGISTER`` and ``VIDIOC_DBG_S_REGISTER`` were introduced
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-decoder-cmd: .. _VIDIOC_DECODER_CMD:
************************************************ ************************************************
ioctl VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD ioctl VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD
...@@ -43,11 +43,11 @@ this structure. ...@@ -43,11 +43,11 @@ this structure.
The ``cmd`` field must contain the command code. Some commands use the The ``cmd`` field must contain the command code. Some commands use the
``flags`` field for additional information. ``flags`` field for additional information.
A :c:func:`write()`() or :ref:`VIDIOC_STREAMON <vidioc-streamon>` A :c:func:`write()`() or :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
call sends an implicit START command to the decoder if it has not been call sends an implicit START command to the decoder if it has not been
started yet. started yet.
A :c:func:`close()`() or :ref:`VIDIOC_STREAMOFF <vidioc-streamon>` A :c:func:`close()`() or :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>`
call of a streaming file descriptor sends an implicit immediate STOP call of a streaming file descriptor sends an implicit immediate STOP
command to the decoder, and all buffered data is discarded. command to the decoder, and all buffered data is discarded.
...@@ -224,7 +224,7 @@ introduced in Linux 3.3. ...@@ -224,7 +224,7 @@ introduced in Linux 3.3.
new buffers produced to dequeue. This buffer may be empty, new buffers produced to dequeue. This buffer may be empty,
indicated by the driver setting the ``bytesused`` field to 0. Once indicated by the driver setting the ``bytesused`` field to 0. Once
the ``V4L2_BUF_FLAG_LAST`` flag was set, the the ``V4L2_BUF_FLAG_LAST`` flag was set, the
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl will not block anymore, :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
but return an EPIPE error code. If but return an EPIPE error code. If
``V4L2_DEC_CMD_STOP_IMMEDIATELY`` is set, then the decoder stops ``V4L2_DEC_CMD_STOP_IMMEDIATELY`` is set, then the decoder stops
immediately (ignoring the ``pts`` value), otherwise it will keep immediately (ignoring the ``pts`` value), otherwise it will keep
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-dqevent: .. _VIDIOC_DQEVENT:
******************** ********************
ioctl VIDIOC_DQEVENT ioctl VIDIOC_DQEVENT
...@@ -226,8 +226,8 @@ call. ...@@ -226,8 +226,8 @@ call.
:ref:`v4l2_control <v4l2-control>`. :ref:`v4l2_control <v4l2-control>`.
If the event is generated due to a call to If the event is generated due to a call to
:ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` or :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` or
:ref:`VIDIOC_S_EXT_CTRLS <vidioc-g-ext-ctrls>`, then the :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`, then the
event will *not* be sent to the file handle that called the ioctl event will *not* be sent to the file handle that called the ioctl
function. This prevents nasty feedback loops. If you *do* want to function. This prevents nasty feedback loops. If you *do* want to
get the event, then set the ``V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK`` get the event, then set the ``V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK``
...@@ -363,7 +363,7 @@ call. ...@@ -363,7 +363,7 @@ call.
- The 32-bit value of the control for 32-bit control types. This is - The 32-bit value of the control for 32-bit control types. This is
0 for string controls since the value of a string cannot be passed 0 for string controls since the value of a string cannot be passed
using :ref:`VIDIOC_DQEVENT <vidioc-dqevent>`. using :ref:`VIDIOC_DQEVENT <VIDIOC_DQEVENT>`.
- .. row 5 - .. row 5
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-dv-timings-cap: .. _VIDIOC_DV_TIMINGS_CAP:
********************************************************* *********************************************************
ioctl VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP ioctl VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-encoder-cmd: .. _VIDIOC_ENCODER_CMD:
************************************************ ************************************************
ioctl VIDIOC_ENCODER_CMD, VIDIOC_TRY_ENCODER_CMD ioctl VIDIOC_ENCODER_CMD, VIDIOC_TRY_ENCODER_CMD
...@@ -48,14 +48,14 @@ currently only used by the STOP command and contains one bit: If the ...@@ -48,14 +48,14 @@ currently only used by the STOP command and contains one bit: If the
until the end of the current *Group Of Pictures*, otherwise it will stop until the end of the current *Group Of Pictures*, otherwise it will stop
immediately. immediately.
A :c:func:`read()`() or :ref:`VIDIOC_STREAMON <vidioc-streamon>` A :c:func:`read()`() or :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
call sends an implicit START command to the encoder if it has not been call sends an implicit START command to the encoder if it has not been
started yet. After a STOP command, :c:func:`read()`() calls will read started yet. After a STOP command, :c:func:`read()`() calls will read
the remaining data buffered by the driver. When the buffer is empty, the remaining data buffered by the driver. When the buffer is empty,
:c:func:`read()`() will return zero and the next :c:func:`read()`() :c:func:`read()`() will return zero and the next :c:func:`read()`()
call will restart the encoder. call will restart the encoder.
A :c:func:`close()`() or :ref:`VIDIOC_STREAMOFF <vidioc-streamon>` A :c:func:`close()`() or :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>`
call of a streaming file descriptor sends an implicit immediate STOP to call of a streaming file descriptor sends an implicit immediate STOP to
the encoder, and all buffered data is discarded. the encoder, and all buffered data is discarded.
...@@ -134,7 +134,7 @@ introduced in Linux 2.6.21. ...@@ -134,7 +134,7 @@ introduced in Linux 2.6.21.
produced to dequeue. This buffer may be empty, indicated by the produced to dequeue. This buffer may be empty, indicated by the
driver setting the ``bytesused`` field to 0. Once the driver setting the ``bytesused`` field to 0. Once the
``V4L2_BUF_FLAG_LAST`` flag was set, the ``V4L2_BUF_FLAG_LAST`` flag was set, the
:ref:`VIDIOC_DQBUF <vidioc-qbuf>` ioctl will not block anymore, :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will not block anymore,
but return an EPIPE error code. but return an EPIPE error code.
- .. row 3 - .. row 3
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-enum-dv-timings: .. _VIDIOC_ENUM_DV_TIMINGS:
*********************************************************** ***********************************************************
ioctl VIDIOC_ENUM_DV_TIMINGS, VIDIOC_SUBDEV_ENUM_DV_TIMINGS ioctl VIDIOC_ENUM_DV_TIMINGS, VIDIOC_SUBDEV_ENUM_DV_TIMINGS
...@@ -35,7 +35,7 @@ Description ...@@ -35,7 +35,7 @@ Description
While some DV receivers or transmitters support a wide range of timings, While some DV receivers or transmitters support a wide range of timings,
others support only a limited number of timings. With this ioctl others support only a limited number of timings. With this ioctl
applications can enumerate a list of known supported timings. Call applications can enumerate a list of known supported timings. Call
:ref:`VIDIOC_DV_TIMINGS_CAP <vidioc-dv-timings-cap>` to check if it :ref:`VIDIOC_DV_TIMINGS_CAP <VIDIOC_DV_TIMINGS_CAP>` to check if it
also supports other standards or even custom timings that are not in also supports other standards or even custom timings that are not in
this list. this list.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-enum-fmt: .. _VIDIOC_ENUM_FMT:
********************* *********************
ioctl VIDIOC_ENUM_FMT ioctl VIDIOC_ENUM_FMT
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-enum-frameintervals: .. _VIDIOC_ENUM_FRAMEINTERVALS:
******************************** ********************************
ioctl VIDIOC_ENUM_FRAMEINTERVALS ioctl VIDIOC_ENUM_FRAMEINTERVALS
...@@ -38,8 +38,8 @@ This ioctl allows applications to enumerate all frame intervals that the ...@@ -38,8 +38,8 @@ This ioctl allows applications to enumerate all frame intervals that the
device supports for the given pixel format and frame size. device supports for the given pixel format and frame size.
The supported pixel formats and frame sizes can be obtained by using the The supported pixel formats and frame sizes can be obtained by using the
:ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` and :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` and
:ref:`VIDIOC_ENUM_FRAMESIZES <vidioc-enum-framesizes>` functions. :ref:`VIDIOC_ENUM_FRAMESIZES <VIDIOC_ENUM_FRAMESIZES>` functions.
The return value and the content of the ``v4l2_frmivalenum.type`` field The return value and the content of the ``v4l2_frmivalenum.type`` field
depend on the type of frame intervals the device supports. Here are the depend on the type of frame intervals the device supports. Here are the
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-enum-framesizes: .. _VIDIOC_ENUM_FRAMESIZES:
**************************** ****************************
ioctl VIDIOC_ENUM_FRAMESIZES ioctl VIDIOC_ENUM_FRAMESIZES
...@@ -39,7 +39,7 @@ and height in pixels) that the device supports for the given pixel ...@@ -39,7 +39,7 @@ and height in pixels) that the device supports for the given pixel
format. format.
The supported pixel formats can be obtained by using the The supported pixel formats can be obtained by using the
:ref:`VIDIOC_ENUM_FMT <vidioc-enum-fmt>` function. :ref:`VIDIOC_ENUM_FMT <VIDIOC_ENUM_FMT>` function.
The return value and the content of the ``v4l2_frmsizeenum.type`` field The return value and the content of the ``v4l2_frmsizeenum.type`` field
depend on the type of frame sizes the device supports. Here are the depend on the type of frame sizes the device supports. Here are the
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-enum-freq-bands: .. _VIDIOC_ENUM_FREQ_BANDS:
**************************** ****************************
ioctl VIDIOC_ENUM_FREQ_BANDS ioctl VIDIOC_ENUM_FREQ_BANDS
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-enumaudio: .. _VIDIOC_ENUMAUDIO:
********************** **********************
ioctl VIDIOC_ENUMAUDIO ioctl VIDIOC_ENUMAUDIO
...@@ -39,7 +39,7 @@ structure or return an EINVAL error code when the index is out of ...@@ -39,7 +39,7 @@ structure or return an EINVAL error code when the index is out of
bounds. To enumerate all audio inputs applications shall begin at index bounds. To enumerate all audio inputs applications shall begin at index
zero, incrementing by one until the driver returns EINVAL. zero, incrementing by one until the driver returns EINVAL.
See :ref:`vidioc-g-audio` for a description of struct See :ref:`VIDIOC_G_AUDIO` for a description of struct
:ref:`v4l2_audio <v4l2-audio>`. :ref:`v4l2_audio <v4l2-audio>`.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-enumaudioout: .. _VIDIOC_ENUMAUDIOOUT:
*********************** ***********************
ioctl VIDIOC_ENUMAUDOUT ioctl VIDIOC_ENUMAUDOUT
...@@ -42,7 +42,7 @@ zero, incrementing by one until the driver returns EINVAL. ...@@ -42,7 +42,7 @@ zero, incrementing by one until the driver returns EINVAL.
Note connectors on a TV card to loop back the received audio signal to a Note connectors on a TV card to loop back the received audio signal to a
sound card are not audio outputs in this sense. sound card are not audio outputs in this sense.
See :ref:`vidioc-g-audioout` for a description of struct See :ref:`VIDIOC_G_AUDIOout` for a description of struct
:ref:`v4l2_audioout <v4l2-audioout>`. :ref:`v4l2_audioout <v4l2-audioout>`.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-enuminput: .. _VIDIOC_ENUMINPUT:
********************** **********************
ioctl VIDIOC_ENUMINPUT ioctl VIDIOC_ENUMINPUT
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-enumoutput: .. _VIDIOC_ENUMOUTPUT:
*********************** ***********************
ioctl VIDIOC_ENUMOUTPUT ioctl VIDIOC_ENUMOUTPUT
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-enumstd: .. _VIDIOC_ENUMSTD:
******************** ********************
ioctl VIDIOC_ENUMSTD ioctl VIDIOC_ENUMSTD
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-expbuf: .. _VIDIOC_EXPBUF:
******************* *******************
ioctl VIDIOC_EXPBUF ioctl VIDIOC_EXPBUF
...@@ -35,7 +35,7 @@ This ioctl is an extension to the :ref:`memory mapping <mmap>` I/O ...@@ -35,7 +35,7 @@ This ioctl is an extension to the :ref:`memory mapping <mmap>` I/O
method, therefore it is available only for ``V4L2_MEMORY_MMAP`` buffers. method, therefore it is available only for ``V4L2_MEMORY_MMAP`` buffers.
It can be used to export a buffer as a DMABUF file at any time after It can be used to export a buffer as a DMABUF file at any time after
buffers have been allocated with the buffers have been allocated with the
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl. :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
To export a buffer, applications fill struct To export a buffer, applications fill struct
:ref:`v4l2_exportbuffer <v4l2-exportbuffer>`. The ``type`` field is :ref:`v4l2_exportbuffer <v4l2-exportbuffer>`. The ``type`` field is
...@@ -43,7 +43,7 @@ set to the same buffer type as was previously used with struct ...@@ -43,7 +43,7 @@ set to the same buffer type as was previously used with struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``. :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``.
Applications must also set the ``index`` field. Valid index numbers Applications must also set the ``index`` field. Valid index numbers
range from zero to the number of buffers allocated with range from zero to the number of buffers allocated with
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` (struct :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` (struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus
one. For the multi-planar API, applications set the ``plane`` field to one. For the multi-planar API, applications set the ``plane`` field to
the index of the plane to be exported. Valid planes range from zero to the index of the plane to be exported. Valid planes range from zero to
...@@ -142,8 +142,8 @@ Examples ...@@ -142,8 +142,8 @@ Examples
- Number of the buffer, set by the application. This field is only - Number of the buffer, set by the application. This field is only
used for :ref:`memory mapping <mmap>` I/O and can range from used for :ref:`memory mapping <mmap>` I/O and can range from
zero to the number of buffers allocated with the zero to the number of buffers allocated with the
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` and/or :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and/or
:ref:`VIDIOC_CREATE_BUFS <vidioc-create-bufs>` ioctls. :ref:`VIDIOC_CREATE_BUFS <VIDIOC_CREATE_BUFS>` ioctls.
- .. row 3 - .. row 3
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-audio: .. _VIDIOC_G_AUDIO:
************************************ ************************************
ioctl VIDIOC_G_AUDIO, VIDIOC_S_AUDIO ioctl VIDIOC_G_AUDIO, VIDIOC_S_AUDIO
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-audioout: .. _VIDIOC_G_AUDIOOUT:
************************************** **************************************
ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-crop: .. _VIDIOC_G_CROP:
********************************** **********************************
ioctl VIDIOC_G_CROP, VIDIOC_S_CROP ioctl VIDIOC_G_CROP, VIDIOC_S_CROP
...@@ -66,7 +66,7 @@ vertical scaling factor. ...@@ -66,7 +66,7 @@ vertical scaling factor.
Finally the driver programs the hardware with the actual cropping and Finally the driver programs the hardware with the actual cropping and
image parameters. ``VIDIOC_S_CROP`` is a write-only ioctl, it does not image parameters. ``VIDIOC_S_CROP`` is a write-only ioctl, it does not
return the actual parameters. To query them applications must call return the actual parameters. To query them applications must call
``VIDIOC_G_CROP`` and :ref:`VIDIOC_G_FMT <vidioc-g-fmt>`. When the ``VIDIOC_G_CROP`` and :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`. When the
parameters are unsuitable the application may modify the cropping or parameters are unsuitable the application may modify the cropping or
image parameters and repeat the cycle until satisfactory parameters have image parameters and repeat the cycle until satisfactory parameters have
been negotiated. been negotiated.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-ctrl: .. _VIDIOC_G_CTRL:
********************************** **********************************
ioctl VIDIOC_G_CTRL, VIDIOC_S_CTRL ioctl VIDIOC_G_CTRL, VIDIOC_S_CTRL
...@@ -48,9 +48,9 @@ actual new value. If the ``value`` is inappropriate for the control ...@@ -48,9 +48,9 @@ actual new value. If the ``value`` is inappropriate for the control
EINVAL error code is returned as well. EINVAL error code is returned as well.
These ioctls work only with user controls. For other control classes the These ioctls work only with user controls. For other control classes the
:ref:`VIDIOC_G_EXT_CTRLS <vidioc-g-ext-ctrls>`, :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>`,
:ref:`VIDIOC_S_EXT_CTRLS <vidioc-g-ext-ctrls>` or :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` or
:ref:`VIDIOC_TRY_EXT_CTRLS <vidioc-g-ext-ctrls>` must be used. :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` must be used.
.. _v4l2-control: .. _v4l2-control:
...@@ -90,7 +90,7 @@ EINVAL ...@@ -90,7 +90,7 @@ EINVAL
The struct :ref:`v4l2_control <v4l2-control>` ``id`` is invalid The struct :ref:`v4l2_control <v4l2-control>` ``id`` is invalid
or the ``value`` is inappropriate for the given control (i.e. if a or the ``value`` is inappropriate for the given control (i.e. if a
menu item is selected that is not supported by the driver according menu item is selected that is not supported by the driver according
to :ref:`VIDIOC_QUERYMENU <vidioc-queryctrl>`). to :ref:`VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>`).
ERANGE ERANGE
The struct :ref:`v4l2_control <v4l2-control>` ``value`` is out of The struct :ref:`v4l2_control <v4l2-control>` ``value`` is out of
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-dv-timings: .. _VIDIOC_G_DV_TIMINGS:
********************************************** **********************************************
ioctl VIDIOC_G_DV_TIMINGS, VIDIOC_S_DV_TIMINGS ioctl VIDIOC_G_DV_TIMINGS, VIDIOC_S_DV_TIMINGS
...@@ -47,7 +47,7 @@ values are not correct, the driver returns EINVAL error code. ...@@ -47,7 +47,7 @@ values are not correct, the driver returns EINVAL error code.
The ``linux/v4l2-dv-timings.h`` header can be used to get the timings of The ``linux/v4l2-dv-timings.h`` header can be used to get the timings of
the formats in the :ref:`cea861` and :ref:`vesadmt` standards. If the formats in the :ref:`cea861` and :ref:`vesadmt` standards. If
the current input or output does not support DV timings (e.g. if the current input or output does not support DV timings (e.g. if
:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` does not set the :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` does not set the
``V4L2_IN_CAP_DV_TIMINGS`` flag), then ENODATA error code is returned. ``V4L2_IN_CAP_DV_TIMINGS`` flag), then ENODATA error code is returned.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-edid: .. _VIDIOC_G_EDID:
****************************************************************************** ******************************************************************************
ioctl VIDIOC_G_EDID, VIDIOC_S_EDID, VIDIOC_SUBDEV_G_EDID, VIDIOC_SUBDEV_S_EDID ioctl VIDIOC_G_EDID, VIDIOC_S_EDID, VIDIOC_SUBDEV_G_EDID, VIDIOC_SUBDEV_S_EDID
...@@ -44,8 +44,8 @@ with subdevice nodes (/dev/v4l-subdevX) or with video nodes ...@@ -44,8 +44,8 @@ with subdevice nodes (/dev/v4l-subdevX) or with video nodes
When used with video nodes the ``pad`` field represents the input (for When used with video nodes the ``pad`` field represents the input (for
video capture devices) or output (for video output devices) index as is video capture devices) or output (for video output devices) index as is
returned by :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` and returned by :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` respectively. When used :ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` respectively. When used
with subdevice nodes the ``pad`` field represents the input or output with subdevice nodes the ``pad`` field represents the input or output
pad of the subdevice. If there is no EDID support for the given ``pad`` pad of the subdevice. If there is no EDID support for the given ``pad``
value, then the EINVAL error code will be returned. value, then the EINVAL error code will be returned.
...@@ -105,8 +105,8 @@ EDID is no longer available. ...@@ -105,8 +105,8 @@ EDID is no longer available.
- Pad for which to get/set the EDID blocks. When used with a video - Pad for which to get/set the EDID blocks. When used with a video
device node the pad represents the input or output index as device node the pad represents the input or output index as
returned by :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` and returned by :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` and
:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` respectively. :ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` respectively.
- .. row 2 - .. row 2
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-enc-index: .. _VIDIOC_G_ENC_INDEX:
************************ ************************
ioctl VIDIOC_G_ENC_INDEX ioctl VIDIOC_G_ENC_INDEX
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-ext-ctrls: .. _VIDIOC_G_EXT_CTRLS:
****************************************************************** ******************************************************************
ioctl VIDIOC_G_EXT_CTRLS, VIDIOC_S_EXT_CTRLS, VIDIOC_TRY_EXT_CTRLS ioctl VIDIOC_G_EXT_CTRLS, VIDIOC_S_EXT_CTRLS, VIDIOC_TRY_EXT_CTRLS
...@@ -58,14 +58,14 @@ set ``size`` to a valid value and return an ENOSPC error code. You ...@@ -58,14 +58,14 @@ set ``size`` to a valid value and return an ENOSPC error code. You
should re-allocate the memory to this new size and try again. For the should re-allocate the memory to this new size and try again. For the
string type it is possible that the same issue occurs again if the string type it is possible that the same issue occurs again if the
string has grown in the meantime. It is recommended to call string has grown in the meantime. It is recommended to call
:ref:`VIDIOC_QUERYCTRL <vidioc-queryctrl>` first and use :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` first and use
``maximum``\ +1 as the new ``size`` value. It is guaranteed that that is ``maximum``\ +1 as the new ``size`` value. It is guaranteed that that is
sufficient memory. sufficient memory.
N-dimensional arrays are set and retrieved row-by-row. You cannot set a N-dimensional arrays are set and retrieved row-by-row. You cannot set a
partial array, all elements have to be set or retrieved. The total size partial array, all elements have to be set or retrieved. The total size
is calculated as ``elems`` * ``elem_size``. These values can be obtained is calculated as ``elems`` * ``elem_size``. These values can be obtained
by calling :ref:`VIDIOC_QUERY_EXT_CTRL <vidioc-queryctrl>`. by calling :ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>`.
To change the value of a set of controls applications initialize the To change the value of a set of controls applications initialize the
``id``, ``size``, ``reserved2`` and ``value/value64/string/ptr`` fields ``id``, ``size``, ``reserved2`` and ``value/value64/string/ptr`` fields
...@@ -366,8 +366,8 @@ still cause this situation. ...@@ -366,8 +366,8 @@ still cause this situation.
- The class containing user controls. These controls are described - The class containing user controls. These controls are described
in :ref:`control`. All controls that can be set using the in :ref:`control`. All controls that can be set using the
:ref:`VIDIOC_S_CTRL <vidioc-g-ctrl>` and :ref:`VIDIOC_S_CTRL <VIDIOC_G_CTRL>` and
:ref:`VIDIOC_G_CTRL <vidioc-g-ctrl>` ioctl belong to this :ref:`VIDIOC_G_CTRL <VIDIOC_G_CTRL>` ioctl belong to this
class. class.
- .. row 2 - .. row 2
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-fbuf: .. _VIDIOC_G_FBUF:
********************************** **********************************
ioctl VIDIOC_G_FBUF, VIDIOC_S_FBUF ioctl VIDIOC_G_FBUF, VIDIOC_S_FBUF
...@@ -39,7 +39,7 @@ to get and set the framebuffer parameters for a ...@@ -39,7 +39,7 @@ to get and set the framebuffer parameters for a
:ref:`Video Overlay <overlay>` or :ref:`Video Output Overlay <osd>` :ref:`Video Overlay <overlay>` or :ref:`Video Output Overlay <osd>`
(OSD). The type of overlay is implied by the device type (capture or (OSD). The type of overlay is implied by the device type (capture or
output device) and can be determined with the output device) and can be determined with the
:ref:`VIDIOC_QUERYCAP <vidioc-querycap>` ioctl. One ``/dev/videoN`` :ref:`VIDIOC_QUERYCAP <VIDIOC_QUERYCAP>` ioctl. One ``/dev/videoN``
device must not support both kinds of overlay. device must not support both kinds of overlay.
The V4L2 API distinguishes destructive and non-destructive overlays. A The V4L2 API distinguishes destructive and non-destructive overlays. A
...@@ -202,7 +202,7 @@ destructive video overlay. ...@@ -202,7 +202,7 @@ destructive video overlay.
- Drivers and applications shall ignore this field. If applicable, - Drivers and applications shall ignore this field. If applicable,
the field order is selected with the the field order is selected with the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl, using the ``field`` :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, using the ``field``
field of struct :ref:`v4l2_window <v4l2-window>`. field of struct :ref:`v4l2_window <v4l2-window>`.
- .. row 13 - .. row 13
...@@ -396,12 +396,12 @@ destructive video overlay. ...@@ -396,12 +396,12 @@ destructive video overlay.
- If this flag is set for a video capture device, then the driver - If this flag is set for a video capture device, then the driver
will set the initial overlay size to cover the full framebuffer will set the initial overlay size to cover the full framebuffer
size, otherwise the existing overlay size (as set by size, otherwise the existing overlay size (as set by
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`) will be used. Only one :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`) will be used. Only one
video capture driver (bttv) supports this flag. The use of this video capture driver (bttv) supports this flag. The use of this
flag for capture devices is deprecated. There is no way to detect flag for capture devices is deprecated. There is no way to detect
which drivers support this flag, so the only reliable method of which drivers support this flag, so the only reliable method of
setting the overlay size is through setting the overlay size is through
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>`. If this flag is set for a :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. If this flag is set for a
video output device, then the video output overlay window is video output device, then the video output overlay window is
relative to the top-left corner of the framebuffer and restricted relative to the top-left corner of the framebuffer and restricted
to the size of the framebuffer. If it is cleared, then the video to the size of the framebuffer. If it is cleared, then the video
...@@ -415,14 +415,14 @@ destructive video overlay. ...@@ -415,14 +415,14 @@ destructive video overlay.
- Use chroma-keying. The chroma-key color is determined by the - Use chroma-keying. The chroma-key color is determined by the
``chromakey`` field of struct :ref:`v4l2_window <v4l2-window>` ``chromakey`` field of struct :ref:`v4l2_window <v4l2-window>`
and negotiated with the :ref:`VIDIOC_S_FMT <vidioc-g-fmt>` and negotiated with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
ioctl, see :ref:`overlay` and :ref:`osd`. ioctl, see :ref:`overlay` and :ref:`osd`.
- .. row 4 - .. row 4
- :cspan:`2` There are no flags to enable clipping using a list of - :cspan:`2` There are no flags to enable clipping using a list of
clip rectangles or a bitmap. These methods are negotiated with the clip rectangles or a bitmap. These methods are negotiated with the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl, see :ref:`overlay` :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
and :ref:`osd`. and :ref:`osd`.
- .. row 5 - .. row 5
...@@ -447,7 +447,7 @@ destructive video overlay. ...@@ -447,7 +447,7 @@ destructive video overlay.
+ video pixel * (255 - alpha)) / 255. The alpha value is + video pixel * (255 - alpha)) / 255. The alpha value is
determined by the ``global_alpha`` field of struct determined by the ``global_alpha`` field of struct
:ref:`v4l2_window <v4l2-window>` and negotiated with the :ref:`v4l2_window <v4l2-window>` and negotiated with the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl, see :ref:`overlay` :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
and :ref:`osd`. and :ref:`osd`.
- .. row 7 - .. row 7
...@@ -471,7 +471,7 @@ destructive video overlay. ...@@ -471,7 +471,7 @@ destructive video overlay.
- Use source chroma-keying. The source chroma-key color is - Use source chroma-keying. The source chroma-key color is
determined by the ``chromakey`` field of struct determined by the ``chromakey`` field of struct
:ref:`v4l2_window <v4l2-window>` and negotiated with the :ref:`v4l2_window <v4l2-window>` and negotiated with the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl, see :ref:`overlay` :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, see :ref:`overlay`
and :ref:`osd`. Both chroma-keying are mutual exclusive to each and :ref:`osd`. Both chroma-keying are mutual exclusive to each
other, so same ``chromakey`` field of struct other, so same ``chromakey`` field of struct
:ref:`v4l2_window <v4l2-window>` is being used. :ref:`v4l2_window <v4l2-window>` is being used.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-fmt: .. _VIDIOC_G_FMT:
************************************************ ************************************************
ioctl VIDIOC_G_FMT, VIDIOC_S_FMT, VIDIOC_TRY_FMT ioctl VIDIOC_G_FMT, VIDIOC_S_FMT, VIDIOC_TRY_FMT
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-frequency: .. _VIDIOC_G_FREQUENCY:
******************************************** ********************************************
ioctl VIDIOC_G_FREQUENCY, VIDIOC_S_FREQUENCY ioctl VIDIOC_G_FREQUENCY, VIDIOC_S_FREQUENCY
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-input: .. _VIDIOC_G_INPUT:
************************************ ************************************
ioctl VIDIOC_G_INPUT, VIDIOC_S_INPUT ioctl VIDIOC_G_INPUT, VIDIOC_S_INPUT
...@@ -47,7 +47,7 @@ applications must select an input before querying or negotiating any ...@@ -47,7 +47,7 @@ applications must select an input before querying or negotiating any
other parameters. other parameters.
Information about video inputs is available using the Information about video inputs is available using the
:ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` ioctl. :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>` ioctl.
Return Value Return Value
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-jpegcomp: .. _VIDIOC_G_JPEGCOMP:
****************************************** ******************************************
ioctl VIDIOC_G_JPEGCOMP, VIDIOC_S_JPEGCOMP ioctl VIDIOC_G_JPEGCOMP, VIDIOC_S_JPEGCOMP
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-modulator: .. _VIDIOC_G_MODULATOR:
******************************************** ********************************************
ioctl VIDIOC_G_MODULATOR, VIDIOC_S_MODULATOR ioctl VIDIOC_G_MODULATOR, VIDIOC_S_MODULATOR
...@@ -57,7 +57,7 @@ initialized to zero. The term 'modulator' means SDR transmitter in this ...@@ -57,7 +57,7 @@ initialized to zero. The term 'modulator' means SDR transmitter in this
context. context.
To change the radio frequency the To change the radio frequency the
:ref:`VIDIOC_S_FREQUENCY <vidioc-g-frequency>` ioctl is available. :ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl is available.
.. _v4l2-modulator: .. _v4l2-modulator:
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-output: .. _VIDIOC_G_OUTPUT:
************************************** **************************************
ioctl VIDIOC_G_OUTPUT, VIDIOC_S_OUTPUT ioctl VIDIOC_G_OUTPUT, VIDIOC_S_OUTPUT
...@@ -48,7 +48,7 @@ effects applications must select an output before querying or ...@@ -48,7 +48,7 @@ effects applications must select an output before querying or
negotiating any other parameters. negotiating any other parameters.
Information about video outputs is available using the Information about video outputs is available using the
:ref:`VIDIOC_ENUMOUTPUT <vidioc-enumoutput>` ioctl. :ref:`VIDIOC_ENUMOUTPUT <VIDIOC_ENUMOUTPUT>` ioctl.
Return Value Return Value
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-parm: .. _VIDIOC_G_PARM:
********************************** **********************************
ioctl VIDIOC_G_PARM, VIDIOC_S_PARM ioctl VIDIOC_G_PARM, VIDIOC_S_PARM
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-priority: .. _VIDIOC_G_PRIORITY:
****************************************** ******************************************
ioctl VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY ioctl VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-selection: .. _VIDIOC_G_SELECTION:
******************************************** ********************************************
ioctl VIDIOC_G_SELECTION, VIDIOC_S_SELECTION ioctl VIDIOC_G_SELECTION, VIDIOC_S_SELECTION
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-sliced-vbi-cap: .. _VIDIOC_G_SLICED_VBI_CAP:
***************************** *****************************
ioctl VIDIOC_G_SLICED_VBI_CAP ioctl VIDIOC_G_SLICED_VBI_CAP
...@@ -134,7 +134,7 @@ to write-read, in Linux 2.6.19. ...@@ -134,7 +134,7 @@ to write-read, in Linux 2.6.19.
given line may be limited. For example on PAL line 16 the hardware given line may be limited. For example on PAL line 16 the hardware
may be able to look for a VPS or Teletext signal, but not both at may be able to look for a VPS or Teletext signal, but not both at
the same time. Applications can learn about these limits using the the same time. Applications can learn about these limits using the
:ref:`VIDIOC_S_FMT <vidioc-g-fmt>` ioctl as described in :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl as described in
:ref:`sliced`. :ref:`sliced`.
- .. row 10 - .. row 10
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-std: .. _VIDIOC_G_STD:
******************************** ********************************
ioctl VIDIOC_G_STD, VIDIOC_S_STD ioctl VIDIOC_G_STD, VIDIOC_S_STD
...@@ -48,7 +48,7 @@ no flags are given or the current input does not support the requested ...@@ -48,7 +48,7 @@ no flags are given or the current input does not support the requested
standard the driver returns an EINVAL error code. When the standard set standard the driver returns an EINVAL error code. When the standard set
is ambiguous drivers may return EINVAL or choose any of the requested is ambiguous drivers may return EINVAL or choose any of the requested
standards. If the current input or output does not support standard standards. If the current input or output does not support standard
video timings (e.g. if :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` video timings (e.g. if :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>`
does not set the ``V4L2_IN_CAP_STD`` flag), then ENODATA error code is does not set the ``V4L2_IN_CAP_STD`` flag), then ENODATA error code is
returned. returned.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-g-tuner: .. _VIDIOC_G_TUNER:
************************************ ************************************
ioctl VIDIOC_G_TUNER, VIDIOC_S_TUNER ioctl VIDIOC_G_TUNER, VIDIOC_S_TUNER
...@@ -56,7 +56,7 @@ selected audio mode. ...@@ -56,7 +56,7 @@ selected audio mode.
to zero. The term 'tuner' means SDR receiver in this context. to zero. The term 'tuner' means SDR receiver in this context.
To change the radio frequency the To change the radio frequency the
:ref:`VIDIOC_S_FREQUENCY <vidioc-g-frequency>` ioctl is available. :ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>` ioctl is available.
.. _v4l2-tuner: .. _v4l2-tuner:
...@@ -323,7 +323,7 @@ To change the radio frequency the ...@@ -323,7 +323,7 @@ To change the radio frequency the
determined from the frequency band.) The set of supported video determined from the frequency band.) The set of supported video
standards is available from the struct standards is available from the struct
:ref:`v4l2_input <v4l2-input>` pointing to this tuner, see the :ref:`v4l2_input <v4l2-input>` pointing to this tuner, see the
description of ioctl :ref:`VIDIOC_ENUMINPUT <vidioc-enuminput>` description of ioctl :ref:`VIDIOC_ENUMINPUT <VIDIOC_ENUMINPUT>`
for details. Only ``V4L2_TUNER_ANALOG_TV`` tuners can have this for details. Only ``V4L2_TUNER_ANALOG_TV`` tuners can have this
capability. capability.
...@@ -425,7 +425,7 @@ To change the radio frequency the ...@@ -425,7 +425,7 @@ To change the radio frequency the
- 0x0400 - 0x0400
- The :ref:`VIDIOC_ENUM_FREQ_BANDS <vidioc-enum-freq-bands>` - The :ref:`VIDIOC_ENUM_FREQ_BANDS <VIDIOC_ENUM_FREQ_BANDS>`
ioctl can be used to enumerate the available frequency bands. ioctl can be used to enumerate the available frequency bands.
- .. row 13 - .. row 13
...@@ -436,7 +436,7 @@ To change the radio frequency the ...@@ -436,7 +436,7 @@ To change the radio frequency the
- The range to search when using the hardware seek functionality is - The range to search when using the hardware seek functionality is
programmable, see programmable, see
:ref:`VIDIOC_S_HW_FREQ_SEEK <vidioc-s-hw-freq-seek>` for :ref:`VIDIOC_S_HW_FREQ_SEEK <VIDIOC_S_HW_FREQ_SEEK>` for
details. details.
- .. row 14 - .. row 14
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-log-status: .. _VIDIOC_LOG_STATUS:
*********************** ***********************
ioctl VIDIOC_LOG_STATUS ioctl VIDIOC_LOG_STATUS
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-overlay: .. _VIDIOC_OVERLAY:
******************** ********************
ioctl VIDIOC_OVERLAY ioctl VIDIOC_OVERLAY
...@@ -36,8 +36,8 @@ Applications call ``VIDIOC_OVERLAY`` to start or stop the overlay. It ...@@ -36,8 +36,8 @@ Applications call ``VIDIOC_OVERLAY`` to start or stop the overlay. It
takes a pointer to an integer which must be set to zero by the takes a pointer to an integer which must be set to zero by the
application to stop overlay, to one to start. application to stop overlay, to one to start.
Drivers do not support :ref:`VIDIOC_STREAMON <vidioc-streamon>` or Drivers do not support :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>` or
:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` with :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` with
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. ``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-prepare-buf: .. _VIDIOC_PREPARE_BUF:
************************ ************************
ioctl VIDIOC_PREPARE_BUF ioctl VIDIOC_PREPARE_BUF
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-qbuf: .. _VIDIOC_QBUF:
******************************* *******************************
ioctl VIDIOC_QBUF, VIDIOC_DQBUF ioctl VIDIOC_QBUF, VIDIOC_DQBUF
...@@ -42,10 +42,10 @@ previously used with struct :ref:`v4l2_format <v4l2-format>` ``type`` ...@@ -42,10 +42,10 @@ previously used with struct :ref:`v4l2_format <v4l2-format>` ``type``
and struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``. and struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``.
Applications must also set the ``index`` field. Valid index numbers Applications must also set the ``index`` field. Valid index numbers
range from zero to the number of buffers allocated with range from zero to the number of buffers allocated with
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` (struct :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` (struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus
one. The contents of the struct :c:type:`struct v4l2_buffer` returned one. The contents of the struct :c:type:`struct v4l2_buffer` returned
by a :ref:`VIDIOC_QUERYBUF <vidioc-querybuf>` ioctl will do as well. by a :ref:`VIDIOC_QUERYBUF <VIDIOC_QUERYBUF>` ioctl will do as well.
When the buffer is intended for output (``type`` is When the buffer is intended for output (``type`` is
``V4L2_BUF_TYPE_VIDEO_OUTPUT``, ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE``, ``V4L2_BUF_TYPE_VIDEO_OUTPUT``, ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE``,
or ``V4L2_BUF_TYPE_VBI_OUTPUT``) applications must also initialize the or ``V4L2_BUF_TYPE_VBI_OUTPUT``) applications must also initialize the
...@@ -75,8 +75,8 @@ the driver sets the ``V4L2_BUF_FLAG_QUEUED`` flag and clears the ...@@ -75,8 +75,8 @@ the driver sets the ``V4L2_BUF_FLAG_QUEUED`` flag and clears the
``flags`` field, or it returns an error code. This ioctl locks the ``flags`` field, or it returns an error code. This ioctl locks the
memory pages of the buffer in physical memory, they cannot be swapped memory pages of the buffer in physical memory, they cannot be swapped
out to disk. Buffers remain locked until dequeued, until the out to disk. Buffers remain locked until dequeued, until the
:ref:`VIDIOC_STREAMOFF <vidioc-streamon>` or :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` or
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl is called, or until the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl is called, or until the
device is closed. device is closed.
To enqueue a :ref:`DMABUF <dmabuf>` buffer applications set the To enqueue a :ref:`DMABUF <dmabuf>` buffer applications set the
...@@ -91,8 +91,8 @@ sets the ``V4L2_BUF_FLAG_QUEUED`` flag and clears the ...@@ -91,8 +91,8 @@ sets the ``V4L2_BUF_FLAG_QUEUED`` flag and clears the
buffer. Locking a buffer means passing it to a driver for a hardware buffer. Locking a buffer means passing it to a driver for a hardware
access (usually DMA). If an application accesses (reads/writes) a locked access (usually DMA). If an application accesses (reads/writes) a locked
buffer then the result is undefined. Buffers remain locked until buffer then the result is undefined. Buffers remain locked until
dequeued, until the :ref:`VIDIOC_STREAMOFF <vidioc-streamon>` or dequeued, until the :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` or
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl is called, or until the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl is called, or until the
device is closed. device is closed.
Applications call the ``VIDIOC_DQBUF`` ioctl to dequeue a filled Applications call the ``VIDIOC_DQBUF`` ioctl to dequeue a filled
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-query-dv-timings: .. _VIDIOC_QUERY_DV_TIMINGS:
***************************** *****************************
ioctl VIDIOC_QUERY_DV_TIMINGS ioctl VIDIOC_QUERY_DV_TIMINGS
...@@ -56,7 +56,7 @@ the receiver could lock to the signal, but the format is unsupported ...@@ -56,7 +56,7 @@ the receiver could lock to the signal, but the format is unsupported
(e.g. because the pixelclock is out of range of the hardware (e.g. because the pixelclock is out of range of the hardware
capabilities), then the driver fills in whatever timings it could find capabilities), then the driver fills in whatever timings it could find
and returns ERANGE. In that case the application can call and returns ERANGE. In that case the application can call
:ref:`VIDIOC_DV_TIMINGS_CAP <vidioc-dv-timings-cap>` to compare the :ref:`VIDIOC_DV_TIMINGS_CAP <VIDIOC_DV_TIMINGS_CAP>` to compare the
found timings with the hardware's capabilities in order to give more found timings with the hardware's capabilities in order to give more
precise feedback to the user. precise feedback to the user.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-querybuf: .. _VIDIOC_QUERYBUF:
********************* *********************
ioctl VIDIOC_QUERYBUF ioctl VIDIOC_QUERYBUF
...@@ -33,7 +33,7 @@ Description ...@@ -33,7 +33,7 @@ Description
This ioctl is part of the :ref:`streaming <mmap>` I/O method. It can This ioctl is part of the :ref:`streaming <mmap>` I/O method. It can
be used to query the status of a buffer at any time after buffers have be used to query the status of a buffer at any time after buffers have
been allocated with the :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` ioctl. been allocated with the :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` ioctl.
Applications set the ``type`` field of a struct Applications set the ``type`` field of a struct
:ref:`v4l2_buffer <v4l2-buffer>` to the same buffer type as was :ref:`v4l2_buffer <v4l2-buffer>` to the same buffer type as was
...@@ -41,7 +41,7 @@ previously used with struct :ref:`v4l2_format <v4l2-format>` ``type`` ...@@ -41,7 +41,7 @@ previously used with struct :ref:`v4l2_format <v4l2-format>` ``type``
and struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``, and struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``,
and the ``index`` field. Valid index numbers range from zero to the and the ``index`` field. Valid index numbers range from zero to the
number of buffers allocated with number of buffers allocated with
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` (struct :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` (struct
:ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus
one. The ``reserved`` and ``reserved2`` fields must be set to 0. When one. The ``reserved`` and ``reserved2`` fields must be set to 0. When
using the :ref:`multi-planar API <planar-apis>`, the ``m.planes`` using the :ref:`multi-planar API <planar-apis>`, the ``m.planes``
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-querycap: .. _VIDIOC_QUERYCAP:
********************* *********************
ioctl VIDIOC_QUERYCAP ioctl VIDIOC_QUERYCAP
...@@ -308,7 +308,7 @@ specification the ioctl returns an EINVAL error code. ...@@ -308,7 +308,7 @@ specification the ioctl returns an EINVAL error code.
- 0x00000400 - 0x00000400
- The device supports the - The device supports the
:ref:`VIDIOC_S_HW_FREQ_SEEK <vidioc-s-hw-freq-seek>` ioctl :ref:`VIDIOC_S_HW_FREQ_SEEK <VIDIOC_S_HW_FREQ_SEEK>` ioctl
for hardware frequency seeking. for hardware frequency seeking.
- .. row 15 - .. row 15
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-queryctrl: .. _VIDIOC_QUERYCTRL:
*************************************************************** ***************************************************************
ioctl VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL, VIDIOC_QUERYMENU ioctl VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL, VIDIOC_QUERYMENU
...@@ -566,10 +566,10 @@ See also the examples in :ref:`control`. ...@@ -566,10 +566,10 @@ See also the examples in :ref:`control`.
the string must be (minimum + N * step) characters long for N ≥ 0. the string must be (minimum + N * step) characters long for N ≥ 0.
These lengths do not include the terminating zero, so in order to These lengths do not include the terminating zero, so in order to
pass a string of length 8 to pass a string of length 8 to
:ref:`VIDIOC_S_EXT_CTRLS <vidioc-g-ext-ctrls>` you need to :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` you need to
set the ``size`` field of struct set the ``size`` field of struct
:ref:`v4l2_ext_control <v4l2-ext-control>` to 9. For :ref:`v4l2_ext_control <v4l2-ext-control>` to 9. For
:ref:`VIDIOC_G_EXT_CTRLS <vidioc-g-ext-ctrls>` you can set :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` you can set
the ``size`` field to ``maximum`` + 1. Which character encoding is the ``size`` field to ``maximum`` + 1. Which character encoding is
used will depend on the string control itself and should be part used will depend on the string control itself and should be part
of the control documentation. of the control documentation.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-querystd: .. _VIDIOC_QUERYSTD:
********************* *********************
ioctl VIDIOC_QUERYSTD ioctl VIDIOC_QUERYSTD
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-reqbufs: .. _VIDIOC_REQBUFS:
******************** ********************
ioctl VIDIOC_REQBUFS ioctl VIDIOC_REQBUFS
...@@ -62,7 +62,7 @@ Applications can call ``VIDIOC_REQBUFS`` again to change the number of ...@@ -62,7 +62,7 @@ Applications can call ``VIDIOC_REQBUFS`` again to change the number of
buffers, however this cannot succeed when any buffers are still mapped. buffers, however this cannot succeed when any buffers are still mapped.
A ``count`` value of zero frees all buffers, after aborting or finishing A ``count`` value of zero frees all buffers, after aborting or finishing
any DMA in progress, an implicit any DMA in progress, an implicit
:ref:`VIDIOC_STREAMOFF <vidioc-streamon>`. :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>`.
.. _v4l2-requestbuffers: .. _v4l2-requestbuffers:
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-s-hw-freq-seek: .. _VIDIOC_S_HW_FREQ_SEEK:
*************************** ***************************
ioctl VIDIOC_S_HW_FREQ_SEEK ioctl VIDIOC_S_HW_FREQ_SEEK
...@@ -43,10 +43,10 @@ to tell the driver to search a specific band. If the struct ...@@ -43,10 +43,10 @@ to tell the driver to search a specific band. If the struct
:ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field has the :ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field has the
``V4L2_TUNER_CAP_HWSEEK_PROG_LIM`` flag set, these values must fall ``V4L2_TUNER_CAP_HWSEEK_PROG_LIM`` flag set, these values must fall
within one of the bands returned by within one of the bands returned by
:ref:`VIDIOC_ENUM_FREQ_BANDS <vidioc-enum-freq-bands>`. If the :ref:`VIDIOC_ENUM_FREQ_BANDS <VIDIOC_ENUM_FREQ_BANDS>`. If the
``V4L2_TUNER_CAP_HWSEEK_PROG_LIM`` flag is not set, then these values ``V4L2_TUNER_CAP_HWSEEK_PROG_LIM`` flag is not set, then these values
must exactly match those of one of the bands returned by must exactly match those of one of the bands returned by
:ref:`VIDIOC_ENUM_FREQ_BANDS <vidioc-enum-freq-bands>`. If the :ref:`VIDIOC_ENUM_FREQ_BANDS <VIDIOC_ENUM_FREQ_BANDS>`. If the
current frequency of the tuner does not fall within the selected band it current frequency of the tuner does not fall within the selected band it
will be clamped to fit in the band before the seek is started. will be clamped to fit in the band before the seek is started.
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-streamon: .. _VIDIOC_STREAMON:
*************************************** ***************************************
ioctl VIDIOC_STREAMON, VIDIOC_STREAMOFF ioctl VIDIOC_STREAMON, VIDIOC_STREAMOFF
...@@ -55,14 +55,14 @@ and it removes all buffers from the incoming and outgoing queues. That ...@@ -55,14 +55,14 @@ and it removes all buffers from the incoming and outgoing queues. That
means all images captured but not dequeued yet will be lost, likewise means all images captured but not dequeued yet will be lost, likewise
all images enqueued for output but not transmitted yet. I/O returns to all images enqueued for output but not transmitted yet. I/O returns to
the same state as after calling the same state as after calling
:ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` and can be restarted :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and can be restarted
accordingly. accordingly.
If buffers have been queued with :ref:`VIDIOC_QBUF <vidioc-qbuf>` and If buffers have been queued with :ref:`VIDIOC_QBUF <VIDIOC_QBUF>` and
``VIDIOC_STREAMOFF`` is called without ever having called ``VIDIOC_STREAMOFF`` is called without ever having called
``VIDIOC_STREAMON``, then those queued buffers will also be removed from ``VIDIOC_STREAMON``, then those queued buffers will also be removed from
the incoming queue and all are returned to the same state as after the incoming queue and all are returned to the same state as after
calling :ref:`VIDIOC_REQBUFS <vidioc-reqbufs>` and can be restarted calling :ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>` and can be restarted
accordingly. accordingly.
Both ioctls take a pointer to an integer, the desired buffer or stream Both ioctls take a pointer to an integer, the desired buffer or stream
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _vidioc-subdev-enum-frame-interval: .. _VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL:
*************************************** ***************************************
ioctl VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL ioctl VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL
...@@ -52,7 +52,7 @@ one until EINVAL is returned. ...@@ -52,7 +52,7 @@ one until EINVAL is returned.
Available frame intervals may depend on the current 'try' formats at Available frame intervals may depend on the current 'try' formats at
other pads of the sub-device, as well as on the current active links. other pads of the sub-device, as well as on the current active links.
See :ref:`VIDIOC_SUBDEV_G_FMT <vidioc-subdev-g-fmt>` for more See :ref:`VIDIOC_SUBDEV_G_FMT <VIDIOC_SUBDEV_G_FMT>` for more
information about the try formats. information about the try formats.
Sub-devices that support the frame interval enumeration ioctl should Sub-devices that support the frame interval enumeration ioctl should
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment