Name

VIDIOC_ENUMINPUT — Enumerate video inputs

Synopsis

int ioctl(int fd,
 int request,
 struct v4l2_input *argp);
 

Arguments

fd

File descriptor returned by open().

request

VIDIOC_ENUMINPUT

argp

Description

To query the attributes of a video input applications initialize the index field of struct v4l2_input and call the VIDIOC_ENUMINPUT ioctl with a pointer to this structure. Drivers fill the rest of the structure or return an EINVAL error code when the index is out of bounds. To enumerate all inputs applications shall begin at index zero, incrementing by one until the driver returns EINVAL.

Table A.38. struct v4l2_input

__u32indexIdentifies the input, set by the application.
__u8name[32]Name of the video input, a NUL-terminated ASCII string, for example: "Vin (Composite 2)". This information is intended for the user, preferably the connector label on the device itself.
__u32typeType of the input, see Table A.39, “Input Types”.
__u32audioset

Drivers can enumerate up to 32 video and audio inputs. This field shows which audio inputs were selectable as audio source if this was the currently selected video input. It is a bit mask. The LSB corresponds to audio input 0, the MSB to input 31. Any number of bits can be set, or none.

When the driver does not enumerate audio inputs no bits must be set. Applications shall not interpret this as lack of audio support. Some drivers automatically select audio sources and do not enumerate them since there is no choice anyway.

For details on audio inputs and how to select the current input see the section called “Audio Inputs and Outputs”.

__u32tunerCapture devices can have zero or more tuners (RF demodulators). When the type is set to V4L2_INPUT_TYPE_TUNER this is an RF connector and this field identifies the tuner. It corresponds to struct v4l2_tuner field index. For details on tuners see the section called “Tuners and Modulators”.
v4l2_std_idstdEvery video input supports one or more different video standards. This field is a set of all supported standards. For details on video standards and how to switch see the section called “Video Standards”.
__u32statusThis field provides status information about the input. See Table A.40, “Input Status Flags” for flags. With the exception of the sensor orientation bits status is only valid when this is the current input.
__u32capabilitiesThis field provides capabilities for the input. See Table A.41, “Input capabilities” for flags.
__u32reserved[3]Reserved for future extensions. Drivers must set the array to zero.

Table A.39. Input Types

V4L2_INPUT_TYPE_TUNER1This input uses a tuner (RF demodulator).
V4L2_INPUT_TYPE_CAMERA2Analog baseband input, for example CVBS / Composite Video, S-Video, RGB.

Table A.40. Input Status Flags

General
V4L2_IN_ST_NO_POWER0x00000001Attached device is off.
V4L2_IN_ST_NO_SIGNAL0x00000002 
V4L2_IN_ST_NO_COLOR0x00000004The hardware supports color decoding, but does not detect color modulation in the signal.
Sensor Orientation
V4L2_IN_ST_HFLIP0x00000010The input is connected to a device that produces a signal that is flipped horizontally and does not correct this before passing the signal to userspace.
V4L2_IN_ST_VFLIP0x00000020The input is connected to a device that produces a signal that is flipped vertically and does not correct this before passing the signal to userspace. Note that a 180 degree rotation is the same as HFLIP | VFLIP
Analog Video
V4L2_IN_ST_NO_H_LOCK0x00000100No horizontal sync lock.
V4L2_IN_ST_COLOR_KILL0x00000200A color killer circuit automatically disables color decoding when it detects no color modulation. When this flag is set the color killer is enabled and has shut off color decoding.
Digital Video
V4L2_IN_ST_NO_SYNC0x00010000No synchronization lock.
V4L2_IN_ST_NO_EQU0x00020000No equalizer lock.
V4L2_IN_ST_NO_CARRIER0x00040000Carrier recovery failed.
VCR and Set-Top Box
V4L2_IN_ST_MACROVISION0x01000000Macrovision is an analog copy prevention system mangling the video signal to confuse video recorders. When this flag is set Macrovision has been detected.
V4L2_IN_ST_NO_ACCESS0x02000000Conditional access denied.
V4L2_IN_ST_VTR0x04000000VTR time constant. [?]

Table A.41. Input capabilities

V4L2_IN_CAP_DV_TIMINGS0x00000002This input supports setting video timings by using VIDIOC_S_DV_TIMINGS.
V4L2_IN_CAP_STD0x00000004This input supports setting the TV standard by using VIDIOC_S_STD.

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 Generic Error Codes chapter.

EINVAL

The struct v4l2_input index is out of bounds.