Documentation/media/uapi/v4l/dev-mem2mem.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 .. _mem2mem:
  11
  12 ********************************
  13 Video Memory-To-Memory Interface
  14 ********************************
  15
  16 A V4L2 memory-to-memory device can compress, decompress, transform, or
  17 otherwise convert video data from one format into another format, in memory.
  18 Such memory-to-memory devices set the ``V4L2_CAP_VIDEO_M2M`` or
  19 ``V4L2_CAP_VIDEO_M2M_MPLANE`` capability. Examples of memory-to-memory
  20 devices are codecs, scalers, deinterlacers or format converters (i.e.
  21 converting from YUV to RGB).
  22
  23 A memory-to-memory video node acts just like a normal video node, but it
  24 supports both output (sending frames from memory to the hardware)
  25 and capture (receiving the processed frames from the hardware into
  26 memory) stream I/O. An application will have to setup the stream I/O for
  27 both sides and finally call :ref:`VIDIOC_STREAMON <VIDIOC_STREAMON>`
  28 for both capture and output to start the hardware.
  29
  30 Memory-to-memory devices function as a shared resource: you can
  31 open the video node multiple times, each application setting up their
  32 own properties that are local to the file handle, and each can use
  33 it independently from the others. The driver will arbitrate access to
  34 the hardware and reprogram it whenever another file handler gets access.
  35 This is different from the usual video node behavior where the video
  36 properties are global to the device (i.e. changing something through one
  37 file handle is visible through another file handle).
  38
  39 One of the most common memory-to-memory device is the codec. Codecs
  40 are more complicated than most and require additional setup for
  41 their codec parameters. This is done through codec controls.
  42 See :ref:`mpeg-controls`.