Documentation/media/uapi/v4l/vidioc-enum-fmt.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_ENUM_FMT:
   4
   5 *********************
   6 ioctl VIDIOC_ENUM_FMT
   7 *********************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_ENUM_FMT - Enumerate image formats
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, VIDIOC_ENUM_FMT, struct v4l2_fmtdesc *argp )
  19     :name: VIDIOC_ENUM_FMT
  20
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :ref:`open() <func-open>`.
  27
  28 ``argp``
  29
  30
  31 Description
  32 ===========
  33
  34 To enumerate image formats applications initialize the ``type`` and
  35 ``index`` field of struct :c:type:`v4l2_fmtdesc` and call
  36 the :ref:`VIDIOC_ENUM_FMT` ioctl with a pointer to this structure. Drivers
  37 fill the rest of the structure or return an ``EINVAL`` error code. All
  38 formats are enumerable by beginning at index zero and incrementing by
  39 one until ``EINVAL`` is returned.
  40
  41 .. note::
  42
  43    After switching input or output the list of enumerated image
  44    formats may be different.
  45
  46
  47 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  48
  49 .. c:type:: v4l2_fmtdesc
  50
  51 .. flat-table:: struct v4l2_fmtdesc
  52     :header-rows:  0
  53     :stub-columns: 0
  54     :widths:       1 1 2
  55
  56     * - __u32
  57       - ``index``
  58       - Number of the format in the enumeration, set by the application.
  59         This is in no way related to the ``pixelformat`` field.
  60     * - __u32
  61       - ``type``
  62       - Type of the data stream, set by the application. Only these types
  63         are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``,
  64         ``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE``,
  65         ``V4L2_BUF_TYPE_VIDEO_OUTPUT``,
  66         ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE`` and
  67         ``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type`.
  68     * - __u32
  69       - ``flags``
  70       - See :ref:`fmtdesc-flags`
  71     * - __u8
  72       - ``description``\ [32]
  73       - Description of the format, a NUL-terminated ASCII string. This
  74         information is intended for the user, for example: "YUV 4:2:2".
  75     * - __u32
  76       - ``pixelformat``
  77       - The image format identifier. This is a four character code as
  78         computed by the v4l2_fourcc() macro:
  79     * - :cspan:`2`
  80
  81         .. _v4l2-fourcc:
  82
  83         ``#define v4l2_fourcc(a,b,c,d)``
  84
  85         ``(((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))``
  86
  87         Several image formats are already defined by this specification in
  88         :ref:`pixfmt`.
  89
  90         .. attention::
  91
  92            These codes are not the same as those used
  93            in the Windows world.
  94     * - __u32
  95       - ``reserved``\ [4]
  96       - Reserved for future extensions. Drivers must set the array to
  97         zero.
  98
  99
 100
 101 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
 102
 103 .. _fmtdesc-flags:
 104
 105 .. flat-table:: Image Format Description Flags
 106     :header-rows:  0
 107     :stub-columns: 0
 108     :widths:       3 1 4
 109
 110     * - ``V4L2_FMT_FLAG_COMPRESSED``
 111       - 0x0001
 112       - This is a compressed format.
 113     * - ``V4L2_FMT_FLAG_EMULATED``
 114       - 0x0002
 115       - This format is not native to the device but emulated through
 116         software (usually libv4l2), where possible try to use a native
 117         format instead for better performance.
 118
 119
 120 Return Value
 121 ============
 122
 123 On success 0 is returned, on error -1 and the ``errno`` variable is set
 124 appropriately. The generic error codes are described at the
 125 :ref:`Generic Error Codes <gen-errors>` chapter.
 126
 127 EINVAL
 128     The struct :c:type:`v4l2_fmtdesc` ``type`` is not
 129     supported or the ``index`` is out of bounds.