summaryrefslogtreecommitdiff
path: root/Documentation/media/uapi/v4l/vidioc-enum-fmt.rst
blob: 257c624e27be0001bcaa744a51397be3d15e9e3d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
.. -*- coding: utf-8; mode: rst -*-

.. _VIDIOC_ENUM_FMT:

*********************
ioctl VIDIOC_ENUM_FMT
*********************

Name
====

VIDIOC_ENUM_FMT - Enumerate image formats


Synopsis
========

.. cpp:function:: int ioctl( int fd, int request, struct v4l2_fmtdesc *argp )


Arguments
=========

``fd``
    File descriptor returned by :ref:`open() <func-open>`.

``request``
    VIDIOC_ENUM_FMT

``argp``


Description
===========

To enumerate image formats applications initialize the ``type`` and
``index`` field of struct :ref:`v4l2_fmtdesc <v4l2-fmtdesc>` and call
the :ref:`VIDIOC_ENUM_FMT` ioctl with a pointer to this structure. Drivers
fill the rest of the structure or return an ``EINVAL`` error code. All
formats are enumerable by beginning at index zero and incrementing by
one until ``EINVAL`` is returned.

Note that after switching input or output the list of enumerated image
formats may be different.


.. _v4l2-fmtdesc:

.. flat-table:: struct v4l2_fmtdesc
    :header-rows:  0
    :stub-columns: 0
    :widths:       1 1 2


    -  .. row 1

       -  __u32

       -  ``index``

       -  Number of the format in the enumeration, set by the application.
	  This is in no way related to the ``pixelformat`` field.

    -  .. row 2

       -  __u32

       -  ``type``

       -  Type of the data stream, set by the application. Only these types
	  are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``,
	  ``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE``,
	  ``V4L2_BUF_TYPE_VIDEO_OUTPUT``,
	  ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE`` and
	  ``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :ref:`v4l2-buf-type`.

    -  .. row 3

       -  __u32

       -  ``flags``

       -  See :ref:`fmtdesc-flags`

    -  .. row 4

       -  __u8

       -  ``description``\ [32]

       -  Description of the format, a NUL-terminated ASCII string. This
	  information is intended for the user, for example: "YUV 4:2:2".

    -  .. row 5

       -  __u32

       -  ``pixelformat``

       -  The image format identifier. This is a four character code as
	  computed by the v4l2_fourcc() macro:

    -  .. row 6

       -  :cspan:`2`


	  .. _v4l2-fourcc:
	  .. code-block:: c

	      #define v4l2_fourcc(a,b,c,d) (((__u32)(a)<<0)|((__u32)(b)<<8)|((__u32)(c)<<16)|((__u32)(d)<<24))

	  Several image formats are already defined by this specification in
	  :ref:`pixfmt`. Note these codes are not the same as those used
	  in the Windows world.

    -  .. row 7

       -  __u32

       -  ``reserved``\ [4]

       -  Reserved for future extensions. Drivers must set the array to
	  zero.



.. _fmtdesc-flags:

.. flat-table:: Image Format Description Flags
    :header-rows:  0
    :stub-columns: 0
    :widths:       3 1 4


    -  .. row 1

       -  ``V4L2_FMT_FLAG_COMPRESSED``

       -  0x0001

       -  This is a compressed format.

    -  .. row 2

       -  ``V4L2_FMT_FLAG_EMULATED``

       -  0x0002

       -  This format is not native to the device but emulated through
	  software (usually libv4l2), where possible try to use a native
	  format instead for better performance.


Return Value
============

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.

EINVAL
    The struct :ref:`v4l2_fmtdesc <v4l2-fmtdesc>` ``type`` is not
    supported or the ``index`` is out of bounds.