2016-06-30 21:18:56 +08:00
|
|
|
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
|
|
2016-07-02 00:42:29 +08:00
|
|
|
.. _VIDIOC_ENUMINPUT:
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
**********************
|
|
|
|
|
ioctl VIDIOC_ENUMINPUT
|
|
|
|
|
**********************
|
|
|
|
|
|
2016-07-06 02:14:35 +08:00
|
|
|
Name
|
2016-07-05 18:58:48 +08:00
|
|
|
====
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2016-07-05 18:58:48 +08:00
|
|
|
VIDIOC_ENUMINPUT - Enumerate video inputs
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2016-07-06 02:14:35 +08:00
|
|
|
|
|
|
|
|
Synopsis
|
2016-06-30 21:18:56 +08:00
|
|
|
========
|
|
|
|
|
|
2016-08-20 03:53:38 +08:00
|
|
|
.. c:function:: int ioctl( int fd, VIDIOC_ENUMINPUT, struct v4l2_input *argp )
|
|
|
|
|
:name: VIDIOC_ENUMINPUT
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2016-07-05 18:58:48 +08:00
|
|
|
|
2016-07-06 02:14:35 +08:00
|
|
|
Arguments
|
2016-06-30 21:18:56 +08:00
|
|
|
=========
|
|
|
|
|
|
|
|
|
|
``fd``
|
|
|
|
|
File descriptor returned by :ref:`open() <func-open>`.
|
|
|
|
|
|
|
|
|
|
``argp``
|
|
|
|
|
|
|
|
|
|
|
2016-07-06 02:14:35 +08:00
|
|
|
Description
|
2016-06-30 21:18:56 +08:00
|
|
|
===========
|
|
|
|
|
|
|
|
|
|
To query the attributes of a video input applications initialize the
|
|
|
|
|
``index`` field of struct :ref:`v4l2_input <v4l2-input>` and call the
|
2016-07-02 01:33:56 +08:00
|
|
|
:ref:`VIDIOC_ENUMINPUT` ioctl with a pointer to this structure. Drivers
|
2016-07-03 22:53:09 +08:00
|
|
|
fill the rest of the structure or return an ``EINVAL`` error code when the
|
2016-06-30 21:18:56 +08:00
|
|
|
index is out of bounds. To enumerate all inputs applications shall begin
|
2016-07-03 22:53:09 +08:00
|
|
|
at index zero, incrementing by one until the driver returns ``EINVAL``.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
|
[media] docs-rst: add tabularcolumns to all tables
LaTeX doesn't handle too well auto-width on tables, and ReST
markup requires an special tag to give it the needed hints.
As we're using A4 paper, we have 17cm of useful spaces. As
most media tables have widths, let's use it to generate the
needed via the following perl script:
my ($line_size, $table_header, $has_cols) = (17.5, 0, 0);
my $out;
my $header = "";
my @widths = ();
sub round { $_[0] > 0 ? int($_[0] + .5) : -int(-$_[0] + .5) }
while (<>) {
if (!$table_header) {
$has_cols = 1 if (m/..\s+tabularcolumns::/);
if (m/..\s+flat-table::/) {
$table_header = 1;
$header = $_;
next;
}
$out .= $_;
next;
}
$header .= $_;
@widths = split(/ /, $1) if (m/:widths:\s+(.*)/);
if (m/^\n$/) {
if (!$has_cols && @widths) {
my ($tot, $t, $i) = (0, 0, 0);
foreach my $v(@widths) { $tot += $v; };
$out .= ".. tabularcolumns:: |";
for ($i = 0; $i < scalar @widths - 1; $i++) {
my $v = $widths[$i];
my $w = round(10 * ($v * $line_size) / $tot) / 10;
$out .= sprintf "p{%.1fcm}|", $w;
$t += $w;
}
my $w = $line_size - $t;
$out .= sprintf "p{%.1fcm}|\n\n", $w;
}
$out .= $header;
$table_header = 0;
$has_cols = 0;
$header = "";
@widths = ();
}
}
print $out;
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-17 19:14:19 +08:00
|
|
|
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
|
|
|
|
|
|
2016-08-19 22:14:23 +08:00
|
|
|
.. _v4l2-input:
|
|
|
|
|
|
2016-06-30 21:18:56 +08:00
|
|
|
.. flat-table:: struct v4l2_input
|
|
|
|
|
:header-rows: 0
|
|
|
|
|
:stub-columns: 0
|
|
|
|
|
:widths: 1 1 2
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- .. row 1
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``index``
|
|
|
|
|
|
|
|
|
|
- Identifies the input, set by the application.
|
|
|
|
|
|
|
|
|
|
- .. row 2
|
|
|
|
|
|
|
|
|
|
- __u8
|
|
|
|
|
|
2016-07-13 19:43:30 +08:00
|
|
|
- ``name``\ [32]
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- Name of the video input, a NUL-terminated ASCII string, for
|
2016-07-05 03:25:48 +08:00
|
|
|
example: "Vin (Composite 2)". This information is intended for the
|
|
|
|
|
user, preferably the connector label on the device itself.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 3
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``type``
|
|
|
|
|
|
|
|
|
|
- Type of the input, see :ref:`input-type`.
|
|
|
|
|
|
|
|
|
|
- .. row 4
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``audioset``
|
|
|
|
|
|
|
|
|
|
- Drivers can enumerate up to 32 video and audio inputs. This field
|
2016-07-05 03:25:48 +08:00
|
|
|
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.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2016-07-05 03:25:48 +08:00
|
|
|
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.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2016-07-05 03:25:48 +08:00
|
|
|
For details on audio inputs and how to select the current input
|
|
|
|
|
see :ref:`audio`.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 5
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``tuner``
|
|
|
|
|
|
|
|
|
|
- Capture devices can have zero or more tuners (RF demodulators).
|
2016-07-05 03:25:48 +08:00
|
|
|
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 :ref:`v4l2_tuner <v4l2-tuner>` field ``index``. For
|
|
|
|
|
details on tuners see :ref:`tuner`.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 6
|
|
|
|
|
|
|
|
|
|
- :ref:`v4l2_std_id <v4l2-std-id>`
|
|
|
|
|
|
|
|
|
|
- ``std``
|
|
|
|
|
|
|
|
|
|
- Every video input supports one or more different video standards.
|
2016-07-05 03:25:48 +08:00
|
|
|
This field is a set of all supported standards. For details on
|
|
|
|
|
video standards and how to switch see :ref:`standard`.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 7
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``status``
|
|
|
|
|
|
|
|
|
|
- This field provides status information about the input. See
|
2016-07-05 03:25:48 +08:00
|
|
|
:ref:`input-status` for flags. With the exception of the sensor
|
|
|
|
|
orientation bits ``status`` is only valid when this is the current
|
|
|
|
|
input.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 8
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``capabilities``
|
|
|
|
|
|
|
|
|
|
- This field provides capabilities for the input. See
|
2016-07-05 03:25:48 +08:00
|
|
|
:ref:`input-capabilities` for flags.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 9
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
2016-07-13 19:43:30 +08:00
|
|
|
- ``reserved``\ [3]
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- Reserved for future extensions. Drivers must set the array to
|
2016-07-05 03:25:48 +08:00
|
|
|
zero.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[media] docs-rst: add tabularcolumns to all tables
LaTeX doesn't handle too well auto-width on tables, and ReST
markup requires an special tag to give it the needed hints.
As we're using A4 paper, we have 17cm of useful spaces. As
most media tables have widths, let's use it to generate the
needed via the following perl script:
my ($line_size, $table_header, $has_cols) = (17.5, 0, 0);
my $out;
my $header = "";
my @widths = ();
sub round { $_[0] > 0 ? int($_[0] + .5) : -int(-$_[0] + .5) }
while (<>) {
if (!$table_header) {
$has_cols = 1 if (m/..\s+tabularcolumns::/);
if (m/..\s+flat-table::/) {
$table_header = 1;
$header = $_;
next;
}
$out .= $_;
next;
}
$header .= $_;
@widths = split(/ /, $1) if (m/:widths:\s+(.*)/);
if (m/^\n$/) {
if (!$has_cols && @widths) {
my ($tot, $t, $i) = (0, 0, 0);
foreach my $v(@widths) { $tot += $v; };
$out .= ".. tabularcolumns:: |";
for ($i = 0; $i < scalar @widths - 1; $i++) {
my $v = $widths[$i];
my $w = round(10 * ($v * $line_size) / $tot) / 10;
$out .= sprintf "p{%.1fcm}|", $w;
$t += $w;
}
my $w = $line_size - $t;
$out .= sprintf "p{%.1fcm}|\n\n", $w;
}
$out .= $header;
$table_header = 0;
$has_cols = 0;
$header = "";
@widths = ();
}
}
print $out;
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-17 19:14:19 +08:00
|
|
|
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
|
|
|
|
|
|
2016-08-19 22:14:23 +08:00
|
|
|
.. _input-type:
|
|
|
|
|
|
2016-06-30 21:18:56 +08:00
|
|
|
.. flat-table:: Input Types
|
|
|
|
|
:header-rows: 0
|
|
|
|
|
:stub-columns: 0
|
|
|
|
|
:widths: 3 1 4
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- .. row 1
|
|
|
|
|
|
|
|
|
|
- ``V4L2_INPUT_TYPE_TUNER``
|
|
|
|
|
|
|
|
|
|
- 1
|
|
|
|
|
|
|
|
|
|
- This input uses a tuner (RF demodulator).
|
|
|
|
|
|
|
|
|
|
- .. row 2
|
|
|
|
|
|
|
|
|
|
- ``V4L2_INPUT_TYPE_CAMERA``
|
|
|
|
|
|
|
|
|
|
- 2
|
|
|
|
|
|
|
|
|
|
- Analog baseband input, for example CVBS / Composite Video,
|
2016-07-05 03:25:48 +08:00
|
|
|
S-Video, RGB.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2016-08-19 01:31:47 +08:00
|
|
|
.. tabularcolumns:: |p{4.8cm}|p{2.6cm}|p{10.1cm}|
|
|
|
|
|
|
2016-08-19 22:14:23 +08:00
|
|
|
.. _input-status:
|
|
|
|
|
|
2016-06-30 21:18:56 +08:00
|
|
|
.. flat-table:: Input Status Flags
|
|
|
|
|
:header-rows: 0
|
|
|
|
|
:stub-columns: 0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- .. row 1
|
|
|
|
|
|
|
|
|
|
- :cspan:`2` General
|
|
|
|
|
|
|
|
|
|
- .. row 2
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_NO_POWER``
|
|
|
|
|
|
|
|
|
|
- 0x00000001
|
|
|
|
|
|
|
|
|
|
- Attached device is off.
|
|
|
|
|
|
|
|
|
|
- .. row 3
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_NO_SIGNAL``
|
|
|
|
|
|
|
|
|
|
- 0x00000002
|
|
|
|
|
|
2016-07-05 03:25:48 +08:00
|
|
|
-
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 4
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_NO_COLOR``
|
|
|
|
|
|
|
|
|
|
- 0x00000004
|
|
|
|
|
|
|
|
|
|
- The hardware supports color decoding, but does not detect color
|
2016-07-05 03:25:48 +08:00
|
|
|
modulation in the signal.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 5
|
|
|
|
|
|
|
|
|
|
- :cspan:`2` Sensor Orientation
|
|
|
|
|
|
|
|
|
|
- .. row 6
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_HFLIP``
|
|
|
|
|
|
|
|
|
|
- 0x00000010
|
|
|
|
|
|
|
|
|
|
- The input is connected to a device that produces a signal that is
|
2016-07-05 03:25:48 +08:00
|
|
|
flipped horizontally and does not correct this before passing the
|
|
|
|
|
signal to userspace.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 7
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_VFLIP``
|
|
|
|
|
|
|
|
|
|
- 0x00000020
|
|
|
|
|
|
|
|
|
|
- The input is connected to a device that produces a signal that is
|
2016-07-05 03:25:48 +08:00
|
|
|
flipped vertically and does not correct this before passing the
|
2016-07-10 22:57:43 +08:00
|
|
|
signal to userspace.
|
|
|
|
|
.. note:: A 180 degree rotation is the same as HFLIP | VFLIP
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 8
|
|
|
|
|
|
|
|
|
|
- :cspan:`2` Analog Video
|
|
|
|
|
|
|
|
|
|
- .. row 9
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_NO_H_LOCK``
|
|
|
|
|
|
|
|
|
|
- 0x00000100
|
|
|
|
|
|
|
|
|
|
- No horizontal sync lock.
|
|
|
|
|
|
|
|
|
|
- .. row 10
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_COLOR_KILL``
|
|
|
|
|
|
|
|
|
|
- 0x00000200
|
|
|
|
|
|
|
|
|
|
- A color killer circuit automatically disables color decoding when
|
2016-07-05 03:25:48 +08:00
|
|
|
it detects no color modulation. When this flag is set the color
|
|
|
|
|
killer is enabled *and* has shut off color decoding.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 11
|
|
|
|
|
|
|
|
|
|
- :cspan:`2` Digital Video
|
|
|
|
|
|
|
|
|
|
- .. row 12
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_NO_SYNC``
|
|
|
|
|
|
|
|
|
|
- 0x00010000
|
|
|
|
|
|
|
|
|
|
- No synchronization lock.
|
|
|
|
|
|
|
|
|
|
- .. row 13
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_NO_EQU``
|
|
|
|
|
|
|
|
|
|
- 0x00020000
|
|
|
|
|
|
|
|
|
|
- No equalizer lock.
|
|
|
|
|
|
|
|
|
|
- .. row 14
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_NO_CARRIER``
|
|
|
|
|
|
|
|
|
|
- 0x00040000
|
|
|
|
|
|
|
|
|
|
- Carrier recovery failed.
|
|
|
|
|
|
|
|
|
|
- .. row 15
|
|
|
|
|
|
|
|
|
|
- :cspan:`2` VCR and Set-Top Box
|
|
|
|
|
|
|
|
|
|
- .. row 16
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_MACROVISION``
|
|
|
|
|
|
|
|
|
|
- 0x01000000
|
|
|
|
|
|
|
|
|
|
- Macrovision is an analog copy prevention system mangling the video
|
2016-07-05 03:25:48 +08:00
|
|
|
signal to confuse video recorders. When this flag is set
|
|
|
|
|
Macrovision has been detected.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 17
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_NO_ACCESS``
|
|
|
|
|
|
|
|
|
|
- 0x02000000
|
|
|
|
|
|
|
|
|
|
- Conditional access denied.
|
|
|
|
|
|
|
|
|
|
- .. row 18
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_ST_VTR``
|
|
|
|
|
|
|
|
|
|
- 0x04000000
|
|
|
|
|
|
|
|
|
|
- VTR time constant. [?]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[media] docs-rst: add tabularcolumns to all tables
LaTeX doesn't handle too well auto-width on tables, and ReST
markup requires an special tag to give it the needed hints.
As we're using A4 paper, we have 17cm of useful spaces. As
most media tables have widths, let's use it to generate the
needed via the following perl script:
my ($line_size, $table_header, $has_cols) = (17.5, 0, 0);
my $out;
my $header = "";
my @widths = ();
sub round { $_[0] > 0 ? int($_[0] + .5) : -int(-$_[0] + .5) }
while (<>) {
if (!$table_header) {
$has_cols = 1 if (m/..\s+tabularcolumns::/);
if (m/..\s+flat-table::/) {
$table_header = 1;
$header = $_;
next;
}
$out .= $_;
next;
}
$header .= $_;
@widths = split(/ /, $1) if (m/:widths:\s+(.*)/);
if (m/^\n$/) {
if (!$has_cols && @widths) {
my ($tot, $t, $i) = (0, 0, 0);
foreach my $v(@widths) { $tot += $v; };
$out .= ".. tabularcolumns:: |";
for ($i = 0; $i < scalar @widths - 1; $i++) {
my $v = $widths[$i];
my $w = round(10 * ($v * $line_size) / $tot) / 10;
$out .= sprintf "p{%.1fcm}|", $w;
$t += $w;
}
my $w = $line_size - $t;
$out .= sprintf "p{%.1fcm}|\n\n", $w;
}
$out .= $header;
$table_header = 0;
$has_cols = 0;
$header = "";
@widths = ();
}
}
print $out;
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-17 19:14:19 +08:00
|
|
|
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
|
|
|
|
|
|
2016-08-19 22:14:23 +08:00
|
|
|
.. _input-capabilities:
|
|
|
|
|
|
2016-06-30 21:18:56 +08:00
|
|
|
.. flat-table:: Input capabilities
|
|
|
|
|
:header-rows: 0
|
|
|
|
|
:stub-columns: 0
|
|
|
|
|
:widths: 3 1 4
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- .. row 1
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_CAP_DV_TIMINGS``
|
|
|
|
|
|
|
|
|
|
- 0x00000002
|
|
|
|
|
|
|
|
|
|
- This input supports setting video timings by using
|
2016-07-05 03:25:48 +08:00
|
|
|
VIDIOC_S_DV_TIMINGS.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 2
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_CAP_STD``
|
|
|
|
|
|
|
|
|
|
- 0x00000004
|
|
|
|
|
|
|
|
|
|
- This input supports setting the TV standard by using
|
2016-07-05 03:25:48 +08:00
|
|
|
VIDIOC_S_STD.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 3
|
|
|
|
|
|
|
|
|
|
- ``V4L2_IN_CAP_NATIVE_SIZE``
|
|
|
|
|
|
|
|
|
|
- 0x00000008
|
|
|
|
|
|
|
|
|
|
- This input supports setting the native size using the
|
2016-07-05 03:25:48 +08:00
|
|
|
``V4L2_SEL_TGT_NATIVE_SIZE`` selection target, see
|
|
|
|
|
:ref:`v4l2-selections-common`.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
|
2016-07-06 02:14:35 +08:00
|
|
|
Return Value
|
2016-06-30 21:18:56 +08:00
|
|
|
============
|
|
|
|
|
|
|
|
|
|
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_input <v4l2-input>` ``index`` is out of
|
|
|
|
|
bounds.
|