2018-08-30 22:15:26 +08:00
|
|
|
.. Permission is granted to copy, distribute and/or modify this
|
|
|
|
|
.. document under the terms of the GNU Free Documentation License,
|
|
|
|
|
.. Version 1.1 or any later version published by the Free Software
|
|
|
|
|
.. Foundation, with no Invariant Sections, no Front-Cover Texts
|
|
|
|
|
.. and no Back-Cover Texts. A copy of the license is included at
|
|
|
|
|
.. Documentation/media/uapi/fdl-appendix.rst.
|
|
|
|
|
..
|
|
|
|
|
.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
|
|
|
|
|
|
2016-07-02 00:42:29 +08:00
|
|
|
.. _VIDIOC_SUBDEV_G_SELECTION:
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
**********************************************************
|
|
|
|
|
ioctl VIDIOC_SUBDEV_G_SELECTION, VIDIOC_SUBDEV_S_SELECTION
|
|
|
|
|
**********************************************************
|
|
|
|
|
|
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_G_SELECTION - VIDIOC_SUBDEV_S_SELECTION - Get or set selection rectangles on a subdev pad
|
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_G_SELECTION, struct v4l2_subdev_selection *argp )
|
|
|
|
|
:name: VIDIOC_SUBDEV_G_SELECTION
|
|
|
|
|
|
|
|
|
|
.. c:function:: int ioctl( int fd, VIDIOC_SUBDEV_S_SELECTION, struct v4l2_subdev_selection *argp )
|
|
|
|
|
:name: VIDIOC_SUBDEV_S_SELECTION
|
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``
|
2017-09-02 21:54:48 +08:00
|
|
|
Pointer to struct :c:type:`v4l2_subdev_selection`.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
|
2016-07-06 02:14:35 +08:00
|
|
|
Description
|
2016-06-30 21:18:56 +08:00
|
|
|
===========
|
|
|
|
|
|
|
|
|
|
The selections are used to configure various image processing
|
|
|
|
|
functionality performed by the subdevs which affect the image size. This
|
|
|
|
|
currently includes cropping, scaling and composition.
|
|
|
|
|
|
|
|
|
|
The selection API replaces
|
2016-07-02 00:42:29 +08:00
|
|
|
:ref:`the old subdev crop API <VIDIOC_SUBDEV_G_CROP>`. All the
|
2016-06-30 21:18:56 +08:00
|
|
|
function of the crop API, and more, are supported by the selections API.
|
|
|
|
|
|
|
|
|
|
See :ref:`subdev` for more information on how each selection target
|
|
|
|
|
affects the image processing pipeline inside the subdevice.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Types of selection targets
|
|
|
|
|
--------------------------
|
|
|
|
|
|
|
|
|
|
There are two types of selection targets: actual and bounds. The actual
|
|
|
|
|
targets are the targets which configure the hardware. The BOUNDS target
|
|
|
|
|
will return a rectangle that contain all possible actual rectangles.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Discovering supported features
|
|
|
|
|
------------------------------
|
|
|
|
|
|
|
|
|
|
To discover which targets are supported, the user can perform
|
|
|
|
|
``VIDIOC_SUBDEV_G_SELECTION`` on them. Any unsupported target will
|
|
|
|
|
return ``EINVAL``.
|
|
|
|
|
|
|
|
|
|
Selection targets and flags are documented in
|
|
|
|
|
:ref:`v4l2-selections-common`.
|
|
|
|
|
|
|
|
|
|
|
[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_selection
|
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_selection
|
|
|
|
|
:header-rows: 0
|
|
|
|
|
:stub-columns: 0
|
|
|
|
|
:widths: 1 1 2
|
|
|
|
|
|
[media] v4l: doc: Remove row numbers from tables
Shorten the tables by removing row numbers in comments, allowing for
later insertion of rows with minimal diffs.
All changes have been generated by the following script.
import io
import re
import sys
def process_table(fname, data):
if fname.endswith('hist-v4l2.rst'):
data = re.sub(u'\n{1,2}\t( ?) -( ?) ?', u'\n\t\\1 -\\2', data, flags = re.MULTILINE)
data = re.sub(u'\n(\t| )- \.\. row [0-9]+\n\t ?-( ?) ?', u'\\1* -\\2', data, flags = re.MULTILINE)
else:
data = re.sub(u'\n{1,2} -( ?) ?', u'\n -\\1', data, flags = re.MULTILINE)
data = re.sub(u'(\n?)(\n\n - \.\. row 1\n)', u'\n\\2', data, flags = re.MULTILINE)
data = re.sub(u'\n - \.\. row [0-9]+\n -( ?) ?', u' * -\\1', data, flags = re.MULTILINE)
data = re.sub(u'\n - \.\. row [0-9]+\n \.\. (_[A-Z0-9_`-]*:)', u'\n - .. \\1', data, flags = re.MULTILINE)
data = re.sub(u'\n - \.\. (_[A-Z0-9_`-]*:)\n -', u' * .. \\1\n\n -', data, flags = re.MULTILINE)
data = re.sub(u'^ - ', u' -', data, flags = re.MULTILINE)
data = re.sub(u'^(\t{1,2}) ', u'\\1', data, flags = re.MULTILINE)
return data
def process_file(fname, data):
buf = io.StringIO(data)
output = ''
in_table = False
table_separator = 0
for line in buf.readlines():
if line.find('.. flat-table::') != -1:
in_table = True
table = ''
elif in_table and not re.match('^[\t\n]|( )', line):
in_table = False
output += process_table(fname, table)
if in_table:
table += line
else:
output += line
if in_table:
in_table = False
output += process_table(fname, table)
return output
fname = sys.argv[1]
data = file(fname, 'rb').read().decode('utf-8')
data = process_file(fname, data)
file(fname, 'wb').write(data.encode('utf-8'))
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
2016-09-05 19:44:34 +08:00
|
|
|
* - __u32
|
|
|
|
|
- ``which``
|
|
|
|
|
- Active or try selection, from enum
|
|
|
|
|
:ref:`v4l2_subdev_format_whence <v4l2-subdev-format-whence>`.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``pad``
|
|
|
|
|
- Pad number as reported by the media framework.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``target``
|
|
|
|
|
- Target selection rectangle. See :ref:`v4l2-selections-common`.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``flags``
|
|
|
|
|
- Flags. See :ref:`v4l2-selection-flags`.
|
|
|
|
|
* - struct :c:type:`v4l2_rect`
|
|
|
|
|
- ``r``
|
|
|
|
|
- Selection rectangle, in pixels.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``reserved``\ [8]
|
|
|
|
|
- Reserved for future extensions. Applications and drivers must set
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
EBUSY
|
|
|
|
|
The selection rectangle can't be changed because the pad is
|
|
|
|
|
currently busy. This can be caused, for instance, by an active video
|
|
|
|
|
stream on the pad. The ioctl must not be retried without performing
|
|
|
|
|
another action to fix the problem first. Only returned by
|
|
|
|
|
``VIDIOC_SUBDEV_S_SELECTION``
|
|
|
|
|
|
|
|
|
|
EINVAL
|
[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
|
|
|
The struct :c:type:`v4l2_subdev_selection`
|
2016-06-30 21:18:56 +08:00
|
|
|
``pad`` references a non-existing pad, the ``which`` field
|
|
|
|
|
references a non-existing format, or the selection target is not
|
|
|
|
|
supported on the given subdev pad.
|