5bd4bb7817
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>
147 lines
3.4 KiB
ReStructuredText
147 lines
3.4 KiB
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _VIDIOC_SUBDEV_G_SELECTION:
|
|
|
|
**********************************************************
|
|
ioctl VIDIOC_SUBDEV_G_SELECTION, VIDIOC_SUBDEV_S_SELECTION
|
|
**********************************************************
|
|
|
|
Name
|
|
====
|
|
|
|
VIDIOC_SUBDEV_G_SELECTION - VIDIOC_SUBDEV_S_SELECTION - Get or set selection rectangles on a subdev pad
|
|
|
|
|
|
Synopsis
|
|
========
|
|
|
|
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_selection *argp )
|
|
|
|
|
|
Arguments
|
|
=========
|
|
|
|
``fd``
|
|
File descriptor returned by :ref:`open() <func-open>`.
|
|
|
|
``request``
|
|
VIDIOC_SUBDEV_G_SELECTION, VIDIOC_SUBDEV_S_SELECTION
|
|
|
|
``argp``
|
|
|
|
|
|
Description
|
|
===========
|
|
|
|
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
|
|
:ref:`the old subdev crop API <VIDIOC_SUBDEV_G_CROP>`. All the
|
|
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`.
|
|
|
|
|
|
.. _v4l2-subdev-selection:
|
|
|
|
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
|
|
|
|
.. flat-table:: struct v4l2_subdev_selection
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
:widths: 1 1 2
|
|
|
|
|
|
- .. row 1
|
|
|
|
- __u32
|
|
|
|
- ``which``
|
|
|
|
- Active or try selection, from enum
|
|
:ref:`v4l2_subdev_format_whence <v4l2-subdev-format-whence>`.
|
|
|
|
- .. row 2
|
|
|
|
- __u32
|
|
|
|
- ``pad``
|
|
|
|
- Pad number as reported by the media framework.
|
|
|
|
- .. row 3
|
|
|
|
- __u32
|
|
|
|
- ``target``
|
|
|
|
- Target selection rectangle. See :ref:`v4l2-selections-common`.
|
|
|
|
- .. row 4
|
|
|
|
- __u32
|
|
|
|
- ``flags``
|
|
|
|
- Flags. See :ref:`v4l2-selection-flags`.
|
|
|
|
- .. row 5
|
|
|
|
- struct :ref:`v4l2_rect <v4l2-rect>`
|
|
|
|
- ``r``
|
|
|
|
- Selection rectangle, in pixels.
|
|
|
|
- .. row 6
|
|
|
|
- __u32
|
|
|
|
- ``reserved``\ [8]
|
|
|
|
- Reserved for future extensions. Applications and drivers must set
|
|
the array to zero.
|
|
|
|
|
|
Return Value
|
|
============
|
|
|
|
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
|
|
The struct :ref:`v4l2_subdev_selection <v4l2-subdev-selection>`
|
|
``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.
|