media/v4l/vidioc-enuminput.rst

1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
13 VIDIOC_ENUMINPUT - Enumerate video inputs
38 index is out of bounds. To enumerate all inputs applications shall begin
45 .. flat-table:: struct v4l2_input
46     :header-rows:  0
47     :stub-columns: 0
48     :widths:       1 1 2
50     * - __u32
51       - ``index``
52       - Identifies the input, set by the application.
53     * - __u8
54       - ``name``\ [32]
55       - Name of the video input, a NUL-terminated ASCII string, for
56 	example: "Vin (Composite 2)". This information is intended for the
58     * - __u32
59       - ``type``
60       - Type of the input, see :ref:`input-type`.
61     * - __u32
62       - ``audioset``
63       - Drivers can enumerate up to 32 video and audio inputs. This field
64 	shows which audio inputs were selectable as audio source if this
69 	When the driver does not enumerate audio inputs no bits must be
74 	For details on audio inputs and how to select the current input
76     * - __u32
77       - ``tuner``
78       - Capture devices can have zero or more tuners (RF demodulators).
83     * - :ref:`v4l2_std_id <v4l2-std-id>`
84       - ``std``
85       - Every video input supports one or more different video standards.
86 	This field is a set of all supported standards. For details on
88     * - __u32
89       - ``status``
90       - This field provides status information about the input. See
91 	:ref:`input-status` for flags. With the exception of the sensor
94     * - __u32
95       - ``capabilities``
96       - This field provides capabilities for the input. See
97 	:ref:`input-capabilities` for flags.
98     * - __u32
99       - ``reserved``\ [3]
100       - Reserved for future extensions. Drivers must set the array to
106 .. _input-type:
108 .. flat-table:: Input Types
109     :header-rows:  0
110     :stub-columns: 0
113     * - ``V4L2_INPUT_TYPE_TUNER``
114       - 1
115       - This input uses a tuner (RF demodulator).
116     * - ``V4L2_INPUT_TYPE_CAMERA``
117       - 2
118       - Any non-tuner video input, for example Composite Video,
119 	S-Video, HDMI, camera sensor. The naming as ``_TYPE_CAMERA`` is historical,
121     * - ``V4L2_INPUT_TYPE_TOUCH``
122       - 3
123       - This input is a touch device for capturing raw touch data.
128 .. _input-status:
130 .. flat-table:: Input Status Flags
131     :header-rows:  0
132     :stub-columns: 0
134     * - :cspan:`2` General
135     * - ``V4L2_IN_ST_NO_POWER``
136       - 0x00000001
137       - Attached device is off.
138     * - ``V4L2_IN_ST_NO_SIGNAL``
139       - 0x00000002
140       -
141     * - ``V4L2_IN_ST_NO_COLOR``
142       - 0x00000004
143       - The hardware supports color decoding, but does not detect color
145     * - :cspan:`2` Sensor Orientation
146     * - ``V4L2_IN_ST_HFLIP``
147       - 0x00000010
148       - The input is connected to a device that produces a signal that is
151     * - ``V4L2_IN_ST_VFLIP``
152       - 0x00000020
153       - The input is connected to a device that produces a signal that is
157     * - :cspan:`2` Analog Video
158     * - ``V4L2_IN_ST_NO_H_LOCK``
159       - 0x00000100
160       - No horizontal sync lock.
161     * - ``V4L2_IN_ST_COLOR_KILL``
162       - 0x00000200
163       - A color killer circuit automatically disables color decoding when
166     * - ``V4L2_IN_ST_NO_V_LOCK``
167       - 0x00000400
168       - No vertical sync lock.
169     * - ``V4L2_IN_ST_NO_STD_LOCK``
170       - 0x00000800
171       - No standard format lock in case of auto-detection format
173     * - :cspan:`2` Digital Video
174     * - ``V4L2_IN_ST_NO_SYNC``
175       - 0x00010000
176       - No synchronization lock.
177     * - ``V4L2_IN_ST_NO_EQU``
178       - 0x00020000
179       - No equalizer lock.
180     * - ``V4L2_IN_ST_NO_CARRIER``
181       - 0x00040000
182       - Carrier recovery failed.
183     * - :cspan:`2` VCR and Set-Top Box
184     * - ``V4L2_IN_ST_MACROVISION``
185       - 0x01000000
186       - Macrovision is an analog copy prevention system mangling the video
189     * - ``V4L2_IN_ST_NO_ACCESS``
190       - 0x02000000
191       - Conditional access denied.
192     * - ``V4L2_IN_ST_VTR``
193       - 0x04000000
194       - VTR time constant. [?]
199 .. _input-capabilities:
201 .. flat-table:: Input capabilities
202     :header-rows:  0
203     :stub-columns: 0
206     * - ``V4L2_IN_CAP_DV_TIMINGS``
207       - 0x00000002
208       - This input supports setting video timings by using
210     * - ``V4L2_IN_CAP_STD``
211       - 0x00000004
212       - This input supports setting the TV standard by using
214     * - ``V4L2_IN_CAP_NATIVE_SIZE``
215       - 0x00000008
216       - This input supports setting the native size using the
218 	:ref:`v4l2-selections-common`.
223 On success 0 is returned, on error -1 and the ``errno`` variable is set
225 :ref:`Generic Error Codes <gen-errors>` chapter.