2016-06-30 21:18:56 +08:00
|
|
|
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
|
|
2016-07-02 00:42:29 +08:00
|
|
|
.. _VIDIOC_SUBDEV_ENUM_FRAME_SIZE:
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
***********************************
|
|
|
|
|
ioctl VIDIOC_SUBDEV_ENUM_FRAME_SIZE
|
|
|
|
|
***********************************
|
|
|
|
|
|
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_SUBDEV_ENUM_FRAME_SIZE - Enumerate media bus frame sizes
|
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_SUBDEV_ENUM_FRAME_SIZE, struct v4l2_subdev_frame_size_enum * argp )
|
|
|
|
|
:name: VIDIOC_SUBDEV_ENUM_FRAME_SIZE
|
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
|
|
|
===========
|
|
|
|
|
|
|
|
|
|
This ioctl allows applications to enumerate all frame sizes supported by
|
|
|
|
|
a sub-device on the given pad for the given media bus format. Supported
|
|
|
|
|
formats can be retrieved with the
|
2016-07-02 00:58:44 +08:00
|
|
|
:ref:`VIDIOC_SUBDEV_ENUM_MBUS_CODE`
|
2016-06-30 21:18:56 +08:00
|
|
|
ioctl.
|
|
|
|
|
|
|
|
|
|
To enumerate frame sizes applications initialize the ``pad``, ``which``
|
|
|
|
|
, ``code`` and ``index`` fields of the struct
|
[media] docs-rst: fix cross-references for videodev2.h
There are several broken references there, due to the conversion to
C domain. Fix them using this shell script and manually adjust what's
broken:
# funcs is a file with the broken functions/references
for i in $(cat funcs|sort|uniq|perl -ne 'print "$1\n" if (m/(\S+)$/)'); do
i=${i//-/_}
echo $i
j=${i//_/-}
for k in $(git grep -l "_$j:" Documentation/); do
sed s,\_$j\:,"c\:type\:\: $i", <$k >a && mv a $k
done
for k in $(git grep -l "$j" Documentation/media/*.exceptions); do
sed s,$j,":c\:type\:\`$i\`", <$k >a && mv a $k
done
for k in $(git grep -l "$j" Documentation/); do
sed "s,:ref:\`$i <$j>\`,:c:type:\`$i\`," <$k >a && mv a $k
sed "s,:ref:\`$j\`,:c:type:\`$i\`," <$k >a && mv a $k
sed -E "s,:ref:\`(.*)<$j>\`,:c:type:\`\1<$i>\`," <$k >a && mv a $k
done
for k in $(git grep -l "<$j>" include/media); do
sed -E "s,:ref:\`(.*)<$j>\`,enum \&$i," <$k >a && mv a $k
done
done
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-08 17:41:26 +08:00
|
|
|
:c:type:`v4l2_subdev_mbus_code_enum` and
|
2016-07-02 01:33:56 +08:00
|
|
|
call the :ref:`VIDIOC_SUBDEV_ENUM_FRAME_SIZE` ioctl with a pointer to the
|
2016-06-30 21:18:56 +08:00
|
|
|
structure. Drivers fill the minimum and maximum frame sizes or return an
|
|
|
|
|
EINVAL error code if one of the input parameters is invalid.
|
|
|
|
|
|
|
|
|
|
Sub-devices that only support discrete frame sizes (such as most
|
|
|
|
|
sensors) will return one or more frame sizes with identical minimum and
|
|
|
|
|
maximum values.
|
|
|
|
|
|
|
|
|
|
Not all possible sizes in given [minimum, maximum] ranges need to be
|
|
|
|
|
supported. For instance, a scaler that uses a fixed-point scaling ratio
|
|
|
|
|
might not be able to produce every frame size between the minimum and
|
|
|
|
|
maximum values. Applications must use the
|
2016-07-02 00:42:29 +08:00
|
|
|
:ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctl to try the
|
2016-06-30 21:18:56 +08:00
|
|
|
sub-device for an exact supported frame size.
|
|
|
|
|
|
|
|
|
|
Available frame sizes may depend on the current 'try' formats at other
|
|
|
|
|
pads of the sub-device, as well as on the current active links and the
|
|
|
|
|
current values of V4L2 controls. See
|
2016-07-02 00:58:44 +08:00
|
|
|
:ref:`VIDIOC_SUBDEV_G_FMT` for more
|
2016-06-30 21:18:56 +08:00
|
|
|
information about try formats.
|
|
|
|
|
|
|
|
|
|
|
[media] docs-rst: fix cross-references for videodev2.h
There are several broken references there, due to the conversion to
C domain. Fix them using this shell script and manually adjust what's
broken:
# funcs is a file with the broken functions/references
for i in $(cat funcs|sort|uniq|perl -ne 'print "$1\n" if (m/(\S+)$/)'); do
i=${i//-/_}
echo $i
j=${i//_/-}
for k in $(git grep -l "_$j:" Documentation/); do
sed s,\_$j\:,"c\:type\:\: $i", <$k >a && mv a $k
done
for k in $(git grep -l "$j" Documentation/media/*.exceptions); do
sed s,$j,":c\:type\:\`$i\`", <$k >a && mv a $k
done
for k in $(git grep -l "$j" Documentation/); do
sed "s,:ref:\`$i <$j>\`,:c:type:\`$i\`," <$k >a && mv a $k
sed "s,:ref:\`$j\`,:c:type:\`$i\`," <$k >a && mv a $k
sed -E "s,:ref:\`(.*)<$j>\`,:c:type:\`\1<$i>\`," <$k >a && mv a $k
done
for k in $(git grep -l "<$j>" include/media); do
sed -E "s,:ref:\`(.*)<$j>\`,enum \&$i," <$k >a && mv a $k
done
done
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-08 17:41:26 +08:00
|
|
|
.. c:type:: v4l2_subdev_frame_size_enum
|
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-06-30 21:18:56 +08:00
|
|
|
.. flat-table:: struct v4l2_subdev_frame_size_enum
|
|
|
|
|
: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.
|
|
|
|
|
|
|
|
|
|
- .. row 2
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``pad``
|
|
|
|
|
|
|
|
|
|
- Pad number as reported by the media controller API.
|
|
|
|
|
|
|
|
|
|
- .. row 3
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``code``
|
|
|
|
|
|
|
|
|
|
- The media bus format code, as defined in
|
2016-07-05 03:25:48 +08:00
|
|
|
:ref:`v4l2-mbus-format`.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 4
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``min_width``
|
|
|
|
|
|
|
|
|
|
- Minimum frame width, in pixels.
|
|
|
|
|
|
|
|
|
|
- .. row 5
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``max_width``
|
|
|
|
|
|
|
|
|
|
- Maximum frame width, in pixels.
|
|
|
|
|
|
|
|
|
|
- .. row 6
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``min_height``
|
|
|
|
|
|
|
|
|
|
- Minimum frame height, in pixels.
|
|
|
|
|
|
|
|
|
|
- .. row 7
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``max_height``
|
|
|
|
|
|
|
|
|
|
- Maximum frame height, in pixels.
|
|
|
|
|
|
|
|
|
|
- .. row 8
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
|
|
|
|
- ``which``
|
|
|
|
|
|
|
|
|
|
- Frame sizes to be enumerated, from enum
|
2016-07-05 03:25:48 +08:00
|
|
|
:ref:`v4l2_subdev_format_whence <v4l2-subdev-format-whence>`.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- .. row 9
|
|
|
|
|
|
|
|
|
|
- __u32
|
|
|
|
|
|
2016-07-13 19:43:30 +08:00
|
|
|
- ``reserved``\ [8]
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
- Reserved for future extensions. Applications and drivers must set
|
2016-07-05 03:25:48 +08:00
|
|
|
the array to zero.
|
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
|
[media] docs-rst: fix cross-references for videodev2.h
There are several broken references there, due to the conversion to
C domain. Fix them using this shell script and manually adjust what's
broken:
# funcs is a file with the broken functions/references
for i in $(cat funcs|sort|uniq|perl -ne 'print "$1\n" if (m/(\S+)$/)'); do
i=${i//-/_}
echo $i
j=${i//_/-}
for k in $(git grep -l "_$j:" Documentation/); do
sed s,\_$j\:,"c\:type\:\: $i", <$k >a && mv a $k
done
for k in $(git grep -l "$j" Documentation/media/*.exceptions); do
sed s,$j,":c\:type\:\`$i\`", <$k >a && mv a $k
done
for k in $(git grep -l "$j" Documentation/); do
sed "s,:ref:\`$i <$j>\`,:c:type:\`$i\`," <$k >a && mv a $k
sed "s,:ref:\`$j\`,:c:type:\`$i\`," <$k >a && mv a $k
sed -E "s,:ref:\`(.*)<$j>\`,:c:type:\`\1<$i>\`," <$k >a && mv a $k
done
for k in $(git grep -l "<$j>" include/media); do
sed -E "s,:ref:\`(.*)<$j>\`,enum \&$i," <$k >a && mv a $k
done
done
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-08 17:41:26 +08:00
|
|
|
:c:type:`v4l2_subdev_frame_size_enum`
|
2016-06-30 21:18:56 +08:00
|
|
|
``pad`` references a non-existing pad, the ``code`` is invalid for
|
|
|
|
|
the given pad or the ``index`` field is out of bounds.
|
