2016-06-30 21:18:56 +08:00
|
|
|
|
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
|
|
2016-07-02 00:42:29 +08:00
|
|
|
|
.. _VIDIOC_CROPCAP:
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
|
********************
|
|
|
|
|
ioctl VIDIOC_CROPCAP
|
|
|
|
|
********************
|
|
|
|
|
|
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_CROPCAP - Information about the video cropping and scaling abilities
|
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_CROPCAP, struct v4l2_cropcap *argp )
|
|
|
|
|
:name: VIDIOC_CROPCAP
|
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
|
|
|
|
===========
|
|
|
|
|
|
|
|
|
|
Applications use this function to query the cropping limits, the pixel
|
|
|
|
|
aspect of images and to calculate scale factors. They set the ``type``
|
|
|
|
|
field of a v4l2_cropcap structure to the respective buffer (stream)
|
2016-07-02 01:33:56 +08:00
|
|
|
|
type and call the :ref:`VIDIOC_CROPCAP` ioctl with a pointer to this
|
2016-06-30 21:18:56 +08:00
|
|
|
|
structure. Drivers fill the rest of the structure. The results are
|
|
|
|
|
constant except when switching the video standard. Remember this switch
|
|
|
|
|
can occur implicit when switching the video input or output.
|
|
|
|
|
|
|
|
|
|
This ioctl must be implemented for video capture or output devices that
|
|
|
|
|
support cropping and/or scaling and/or have non-square pixels, and for
|
|
|
|
|
overlay devices.
|
|
|
|
|
|
2016-08-30 04:37:59 +08:00
|
|
|
|
.. c:type:: v4l2_cropcap
|
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_cropcap
|
|
|
|
|
: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
|
|
|
|
|
- ``type``
|
|
|
|
|
- Type of the data stream, set by the application. Only these types
|
2017-05-08 22:35:06 +08:00
|
|
|
|
are valid here: ``V4L2_BUF_TYPE_VIDEO_CAPTURE``, ``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE``,
|
|
|
|
|
``V4L2_BUF_TYPE_VIDEO_OUTPUT``, ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE`` and
|
|
|
|
|
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. See :c:type:`v4l2_buf_type` and the note above.
|
[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
|
|
|
|
* - struct :ref:`v4l2_rect <v4l2-rect-crop>`
|
|
|
|
|
- ``bounds``
|
|
|
|
|
- Defines the window within capturing or output is possible, this
|
|
|
|
|
may exclude for example the horizontal and vertical blanking
|
|
|
|
|
areas. The cropping rectangle cannot exceed these limits. Width
|
|
|
|
|
and height are defined in pixels, the driver writer is free to
|
|
|
|
|
choose origin and units of the coordinate system in the analog
|
|
|
|
|
domain.
|
|
|
|
|
* - struct :ref:`v4l2_rect <v4l2-rect-crop>`
|
|
|
|
|
- ``defrect``
|
|
|
|
|
- Default cropping rectangle, it shall cover the "whole picture".
|
|
|
|
|
Assuming pixel aspect 1/1 this could be for example a 640 × 480
|
|
|
|
|
rectangle for NTSC, a 768 × 576 rectangle for PAL and SECAM
|
|
|
|
|
centered over the active picture area. The same co-ordinate system
|
|
|
|
|
as for ``bounds`` is used.
|
|
|
|
|
* - struct :c:type:`v4l2_fract`
|
|
|
|
|
- ``pixelaspect``
|
|
|
|
|
- This is the pixel aspect (y / x) when no scaling is applied, the
|
|
|
|
|
ratio of the actual sampling frequency and the frequency required
|
|
|
|
|
to get square pixels.
|
|
|
|
|
|
|
|
|
|
When cropping coordinates refer to square pixels, the driver sets
|
|
|
|
|
``pixelaspect`` to 1/1. Other common values are 54/59 for PAL and
|
|
|
|
|
SECAM, 11/10 for NTSC sampled according to [:ref:`itu601`].
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
2017-05-08 22:35:06 +08:00
|
|
|
|
.. note::
|
|
|
|
|
Unfortunately in the case of multiplanar buffer types
|
|
|
|
|
(``V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE`` and ``V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE``)
|
|
|
|
|
this API was messed up with regards to how the :c:type:`v4l2_cropcap` ``type`` field
|
|
|
|
|
should be filled in. Some drivers only accepted the ``_MPLANE`` buffer type while
|
|
|
|
|
other drivers only accepted a non-multiplanar buffer type (i.e. without the
|
|
|
|
|
``_MPLANE`` at the end).
|
|
|
|
|
|
|
|
|
|
Starting with kernel 4.13 both variations are allowed.
|
|
|
|
|
|
2016-06-30 21:18:56 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. _v4l2-rect-crop:
|
|
|
|
|
|
[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_rect
|
|
|
|
|
: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
|
|
|
|
* - __s32
|
|
|
|
|
- ``left``
|
|
|
|
|
- Horizontal offset of the top, left corner of the rectangle, in
|
|
|
|
|
pixels.
|
|
|
|
|
* - __s32
|
|
|
|
|
- ``top``
|
|
|
|
|
- Vertical offset of the top, left corner of the rectangle, in
|
|
|
|
|
pixels.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``width``
|
|
|
|
|
- Width of the rectangle, in pixels.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``height``
|
|
|
|
|
- Height of the rectangle, in pixels.
|
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
|
2016-08-30 04:37:59 +08:00
|
|
|
|
The struct :c:type:`v4l2_cropcap` ``type`` is
|
2016-06-30 21:18:56 +08:00
|
|
|
|
invalid.
|
2016-07-20 20:39:42 +08:00
|
|
|
|
|
|
|
|
|
ENODATA
|
|
|
|
|
Cropping is not supported for this input or output.
|