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

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _capture:
  11
  12 ***********************
  13 Video Capture Interface
  14 ***********************
  15
  16 Video capture devices sample an analog video signal and store the
  17 digitized images in memory. Today nearly all devices can capture at full
  18 25 or 30 frames/second. With this interface applications can control the
  19 capture process and move images from the driver into user space.
  20
  21 Conventionally V4L2 video capture devices are accessed through character
  22 device special files named ``/dev/video`` and ``/dev/video0`` to
  23 ``/dev/video63`` with major number 81 and minor numbers 0 to 63.
  24 ``/dev/video`` is typically a symbolic link to the preferred video
  25 device.
  26
  27 .. note:: The same device file names are used for video output devices.
  28
  29
  30 Querying Capabilities
  31 =====================
  32
  33 Devices supporting the video capture interface set the
  34 ``V4L2_CAP_VIDEO_CAPTURE`` or ``V4L2_CAP_VIDEO_CAPTURE_MPLANE`` flag in
  35 the ``capabilities`` field of struct
  36 :c:type:`v4l2_capability` returned by the
  37 :ref:`VIDIOC_QUERYCAP` ioctl. As secondary device
  38 functions they may also support the :ref:`video overlay <overlay>`
  39 (``V4L2_CAP_VIDEO_OVERLAY``) and the :ref:`raw VBI capture <raw-vbi>`
  40 (``V4L2_CAP_VBI_CAPTURE``) interface. At least one of the read/write or
  41 streaming I/O methods must be supported. Tuners and audio inputs are
  42 optional.
  43
  44
  45 Supplemental Functions
  46 ======================
  47
  48 Video capture devices shall support :ref:`audio input <audio>`,
  49 :ref:`tuner`, :ref:`controls <control>`,
  50 :ref:`cropping and scaling <crop>` and
  51 :ref:`streaming parameter <streaming-par>` ioctls as needed. The
  52 :ref:`video input <video>` ioctls must be supported by all video
  53 capture devices.
  54
  55
  56 Image Format Negotiation
  57 ========================
  58
  59 The result of a capture operation is determined by cropping and image
  60 format parameters. The former select an area of the video picture to
  61 capture, the latter how images are stored in memory, i. e. in RGB or YUV
  62 format, the number of bits per pixel or width and height. Together they
  63 also define how images are scaled in the process.
  64
  65 As usual these parameters are *not* reset at :ref:`open() <func-open>`
  66 time to permit Unix tool chains, programming a device and then reading
  67 from it as if it was a plain file. Well written V4L2 applications ensure
  68 they really get what they want, including cropping and scaling.
  69
  70 Cropping initialization at minimum requires to reset the parameters to
  71 defaults. An example is given in :ref:`crop`.
  72
  73 To query the current image format applications set the ``type`` field of
  74 a struct :c:type:`v4l2_format` to
  75 ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` or
  76 ``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE`` and call the
  77 :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` ioctl with a pointer to this
  78 structure. Drivers fill the struct
  79 :c:type:`v4l2_pix_format` ``pix`` or the struct
  80 :c:type:`v4l2_pix_format_mplane` ``pix_mp``
  81 member of the ``fmt`` union.
  82
  83 To request different parameters applications set the ``type`` field of a
  84 struct :c:type:`v4l2_format` as above and initialize all
  85 fields of the struct :c:type:`v4l2_pix_format`
  86 ``vbi`` member of the ``fmt`` union, or better just modify the results
  87 of :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`, and call the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`
  88 ioctl with a pointer to this structure. Drivers may adjust the
  89 parameters and finally return the actual parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
  90 does.
  91
  92 Like :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` the :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctl
  93 can be used to learn about hardware limitations without disabling I/O or
  94 possibly time consuming hardware preparations.
  95
  96 The contents of struct :c:type:`v4l2_pix_format` and
  97 struct :c:type:`v4l2_pix_format_mplane` are
  98 discussed in :ref:`pixfmt`. See also the specification of the
  99 :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`, :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` ioctls for
 100 details. Video capture devices must implement both the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>`
 101 and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl, even if :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ignores all
 102 requests and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does.
 103 :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` is optional.
 104
 105
 106 Reading Images
 107 ==============
 108
 109 A video capture device may support the :ref:`read() function <func-read>`
 110 and/or streaming (:ref:`memory mapping <func-mmap>` or
 111 :ref:`user pointer <userp>`) I/O. See :ref:`io` for details.