Documentation/media/uapi/v4l/func-read.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _func-read:
   4
   5 ***********
   6 V4L2 read()
   7 ***********
   8
   9 Name
  10 ====
  11
  12 v4l2-read - Read from a V4L2 device
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. code-block:: c
  19
  20     #include <unistd.h>
  21
  22
  23 .. c:function:: ssize_t read( int fd, void *buf, size_t count )
  24     :name: v4l2-read
  25
  26 Arguments
  27 =========
  28
  29 ``fd``
  30     File descriptor returned by :ref:`open() <func-open>`.
  31
  32 ``buf``
  33    Buffer to be filled
  34
  35 ``count``
  36   Max number of bytes to read
  37
  38 Description
  39 ===========
  40
  41 :ref:`read() <func-read>` attempts to read up to ``count`` bytes from file
  42 descriptor ``fd`` into the buffer starting at ``buf``. The layout of the
  43 data in the buffer is discussed in the respective device interface
  44 section, see ##. If ``count`` is zero, :ref:`read() <func-read>` returns zero
  45 and has no other results. If ``count`` is greater than ``SSIZE_MAX``,
  46 the result is unspecified. Regardless of the ``count`` value each
  47 :ref:`read() <func-read>` call will provide at most one frame (two fields)
  48 worth of data.
  49
  50 By default :ref:`read() <func-read>` blocks until data becomes available. When
  51 the ``O_NONBLOCK`` flag was given to the :ref:`open() <func-open>`
  52 function it returns immediately with an ``EAGAIN`` error code when no data
  53 is available. The :ref:`select() <func-select>` or
  54 :ref:`poll() <func-poll>` functions can always be used to suspend
  55 execution until data becomes available. All drivers supporting the
  56 :ref:`read() <func-read>` function must also support :ref:`select() <func-select>` and
  57 :ref:`poll() <func-poll>`.
  58
  59 Drivers can implement read functionality in different ways, using a
  60 single or multiple buffers and discarding the oldest or newest frames
  61 once the internal buffers are filled.
  62
  63 :ref:`read() <func-read>` never returns a "snapshot" of a buffer being filled.
  64 Using a single buffer the driver will stop capturing when the
  65 application starts reading the buffer until the read is finished. Thus
  66 only the period of the vertical blanking interval is available for
  67 reading, or the capture rate must fall below the nominal frame rate of
  68 the video standard.
  69
  70 The behavior of :ref:`read() <func-read>` when called during the active picture
  71 period or the vertical blanking separating the top and bottom field
  72 depends on the discarding policy. A driver discarding the oldest frames
  73 keeps capturing into an internal buffer, continuously overwriting the
  74 previously, not read frame, and returns the frame being received at the
  75 time of the :ref:`read() <func-read>` call as soon as it is complete.
  76
  77 A driver discarding the newest frames stops capturing until the next
  78 :ref:`read() <func-read>` call. The frame being received at :ref:`read() <func-read>`
  79 time is discarded, returning the following frame instead. Again this
  80 implies a reduction of the capture rate to one half or less of the
  81 nominal frame rate. An example of this model is the video read mode of
  82 the bttv driver, initiating a DMA to user memory when :ref:`read() <func-read>`
  83 is called and returning when the DMA finished.
  84
  85 In the multiple buffer model drivers maintain a ring of internal
  86 buffers, automatically advancing to the next free buffer. This allows
  87 continuous capturing when the application can empty the buffers fast
  88 enough. Again, the behavior when the driver runs out of free buffers
  89 depends on the discarding policy.
  90
  91 Applications can get and set the number of buffers used internally by
  92 the driver with the :ref:`VIDIOC_G_PARM <VIDIOC_G_PARM>` and
  93 :ref:`VIDIOC_S_PARM <VIDIOC_G_PARM>` ioctls. They are optional,
  94 however. The discarding policy is not reported and cannot be changed.
  95 For minimum requirements see :ref:`devices`.
  96
  97
  98 Return Value
  99 ============
 100
 101 On success, the number of bytes read is returned. It is not an error if
 102 this number is smaller than the number of bytes requested, or the amount
 103 of data required for one frame. This may happen for example because
 104 :ref:`read() <func-read>` was interrupted by a signal. On error, -1 is
 105 returned, and the ``errno`` variable is set appropriately. In this case
 106 the next read will start at the beginning of a new frame. Possible error
 107 codes are:
 108
 109 EAGAIN
 110     Non-blocking I/O has been selected using O_NONBLOCK and no data was
 111     immediately available for reading.
 112
 113 EBADF
 114     ``fd`` is not a valid file descriptor or is not open for reading, or
 115     the process already has the maximum number of files open.
 116
 117 EBUSY
 118     The driver does not support multiple read streams and the device is
 119     already in use.
 120
 121 EFAULT
 122     ``buf`` references an inaccessible memory area.
 123
 124 EINTR
 125     The call was interrupted by a signal before any data was read.
 126
 127 EIO
 128     I/O error. This indicates some hardware problem or a failure to
 129     communicate with a remote device (USB camera etc.).
 130
 131 EINVAL
 132     The :ref:`read() <func-read>` function is not supported by this driver, not
 133     on this device, or generally not on this type of device.