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
|
2020-03-04 17:21:39 +08:00
|
|
|
.. Documentation/userspace-api/media/fdl-appendix.rst.
|
2018-08-30 22:15:26 +08:00
|
|
|
..
|
|
|
|
|
.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
|
|
|
|
|
|
2016-07-02 00:42:29 +08:00
|
|
|
.. _VIDIOC_SUBDEV_G_CROP:
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
************************************************
|
|
|
|
|
ioctl VIDIOC_SUBDEV_G_CROP, VIDIOC_SUBDEV_S_CROP
|
|
|
|
|
************************************************
|
|
|
|
|
|
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_CROP - VIDIOC_SUBDEV_S_CROP - Get or set the crop rectangle 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_CROP, struct v4l2_subdev_crop *argp )
|
|
|
|
|
:name: VIDIOC_SUBDEV_G_CROP
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2016-08-20 03:53:38 +08:00
|
|
|
.. c:function:: int ioctl( int fd, VIDIOC_SUBDEV_S_CROP, const struct v4l2_subdev_crop *argp )
|
|
|
|
|
:name: VIDIOC_SUBDEV_S_CROP
|
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_crop`.
|
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
|
|
|
===========
|
|
|
|
|
|
2016-07-10 22:57:43 +08:00
|
|
|
.. note::
|
2016-06-30 21:18:56 +08:00
|
|
|
|
2016-07-02 00:58:44 +08:00
|
|
|
This is an :ref:`obsolete` interface and may be removed
|
2016-06-30 21:18:56 +08:00
|
|
|
in the future. It is superseded by
|
2016-07-02 00:42:29 +08:00
|
|
|
:ref:`the selection API <VIDIOC_SUBDEV_G_SELECTION>`.
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
To retrieve the current crop rectangle applications set the ``pad``
|
[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
|
|
|
field of a struct :c:type:`v4l2_subdev_crop` to the
|
2016-06-30 21:18:56 +08:00
|
|
|
desired pad number as reported by the media API and the ``which`` field
|
|
|
|
|
to ``V4L2_SUBDEV_FORMAT_ACTIVE``. They then call the
|
|
|
|
|
``VIDIOC_SUBDEV_G_CROP`` ioctl with a pointer to this structure. The
|
2016-07-03 22:53:09 +08:00
|
|
|
driver fills the members of the ``rect`` field or returns ``EINVAL`` error
|
2016-06-30 21:18:56 +08:00
|
|
|
code if the input arguments are invalid, or if cropping is not supported
|
|
|
|
|
on the given pad.
|
|
|
|
|
|
|
|
|
|
To change the current crop rectangle applications set both the ``pad``
|
|
|
|
|
and ``which`` fields and all members of the ``rect`` field. They then
|
|
|
|
|
call the ``VIDIOC_SUBDEV_S_CROP`` ioctl with a pointer to this
|
|
|
|
|
structure. The driver verifies the requested crop rectangle, adjusts it
|
|
|
|
|
based on the hardware capabilities and configures the device. Upon
|
[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
|
|
|
return the struct :c:type:`v4l2_subdev_crop`
|
2016-06-30 21:18:56 +08:00
|
|
|
contains the current format as would be returned by a
|
|
|
|
|
``VIDIOC_SUBDEV_G_CROP`` call.
|
|
|
|
|
|
|
|
|
|
Applications can query the device capabilities by setting the ``which``
|
|
|
|
|
to ``V4L2_SUBDEV_FORMAT_TRY``. When set, 'try' crop rectangles are not
|
|
|
|
|
applied to the device by the driver, but are mangled exactly as active
|
|
|
|
|
crop rectangles and stored in the sub-device file handle. Two
|
|
|
|
|
applications querying the same sub-device would thus not interact with
|
|
|
|
|
each other.
|
|
|
|
|
|
2020-05-07 23:12:49 +08:00
|
|
|
If the subdev device node has been registered in read-only mode, calls to
|
|
|
|
|
``VIDIOC_SUBDEV_S_CROP`` are only valid if the ``which`` field is set to
|
|
|
|
|
``V4L2_SUBDEV_FORMAT_TRY``, otherwise an error is returned and the errno
|
|
|
|
|
variable is set to ``-EPERM``.
|
|
|
|
|
|
2016-06-30 21:18:56 +08:00
|
|
|
Drivers must not return an error solely because the requested crop
|
|
|
|
|
rectangle doesn't match the device capabilities. They must instead
|
|
|
|
|
modify the rectangle to match what the hardware can provide. The
|
|
|
|
|
modified format should be as close as possible to the original request.
|
|
|
|
|
|
|
|
|
|
|
[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_crop
|
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_crop
|
|
|
|
|
: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
|
|
|
|
|
- ``pad``
|
|
|
|
|
- Pad number as reported by the media framework.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``which``
|
|
|
|
|
- Crop rectangle to get or set, from enum
|
|
|
|
|
:ref:`v4l2_subdev_format_whence <v4l2-subdev-format-whence>`.
|
|
|
|
|
* - struct :c:type:`v4l2_rect`
|
|
|
|
|
- ``rect``
|
|
|
|
|
- Crop rectangle boundaries, 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 crop 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_CROP``
|
|
|
|
|
|
|
|
|
|
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_crop` ``pad``
|
2016-06-30 21:18:56 +08:00
|
|
|
references a non-existing pad, the ``which`` field references a
|
|
|
|
|
non-existing format, or cropping is not supported on the given
|
|
|
|
|
subdev pad.
|
2020-05-07 23:12:49 +08:00
|
|
|
|
|
|
|
|
EPERM
|
|
|
|
|
The ``VIDIOC_SUBDEV_S_CROP`` ioctl has been called on a read-only subdevice
|
|
|
|
|
and the ``which`` field is set to ``V4L2_SUBDEV_FORMAT_ACTIVE``.
|