2016-07-01 16:42:29 +00:00
|
|
|
.. _VIDIOC_ENUM_FREQ_BANDS:
|
2016-06-30 13:18:56 +00:00
|
|
|
|
|
|
|
|
****************************
|
|
|
|
|
ioctl VIDIOC_ENUM_FREQ_BANDS
|
|
|
|
|
****************************
|
|
|
|
|
|
2016-07-05 18:14:35 +00:00
|
|
|
Name
|
2016-07-05 10:58:48 +00:00
|
|
|
====
|
2016-06-30 13:18:56 +00:00
|
|
|
|
2016-07-05 10:58:48 +00:00
|
|
|
VIDIOC_ENUM_FREQ_BANDS - Enumerate supported frequency bands
|
2016-06-30 13:18:56 +00:00
|
|
|
|
2016-07-05 18:14:35 +00:00
|
|
|
|
|
|
|
|
Synopsis
|
2016-06-30 13:18:56 +00:00
|
|
|
========
|
|
|
|
|
|
2016-08-19 19:53:38 +00:00
|
|
|
.. c:function:: int ioctl( int fd, VIDIOC_ENUM_FREQ_BANDS, struct v4l2_frequency_band *argp )
|
|
|
|
|
:name: VIDIOC_ENUM_FREQ_BANDS
|
2016-06-30 13:18:56 +00:00
|
|
|
|
2016-07-05 10:58:48 +00:00
|
|
|
|
2016-07-05 18:14:35 +00:00
|
|
|
Arguments
|
2016-06-30 13:18:56 +00:00
|
|
|
=========
|
|
|
|
|
|
|
|
|
|
``fd``
|
|
|
|
|
File descriptor returned by :ref:`open() <func-open>`.
|
|
|
|
|
|
|
|
|
|
``argp``
|
2017-09-02 13:54:48 +00:00
|
|
|
Pointer to struct :c:type:`v4l2_frequency_band`.
|
2016-06-30 13:18:56 +00:00
|
|
|
|
|
|
|
|
|
2016-07-05 18:14:35 +00:00
|
|
|
Description
|
2016-06-30 13:18:56 +00:00
|
|
|
===========
|
|
|
|
|
|
|
|
|
|
Enumerates the frequency bands that a tuner or modulator supports. To do
|
|
|
|
|
this applications initialize the ``tuner``, ``type`` and ``index``
|
|
|
|
|
fields, and zero out the ``reserved`` array of a struct
|
2016-08-29 20:37:59 +00:00
|
|
|
:c:type:`v4l2_frequency_band` and call the
|
2016-07-01 17:33:56 +00:00
|
|
|
:ref:`VIDIOC_ENUM_FREQ_BANDS` ioctl with a pointer to this structure.
|
2016-06-30 13:18:56 +00:00
|
|
|
|
|
|
|
|
This ioctl is supported if the ``V4L2_TUNER_CAP_FREQ_BANDS`` capability
|
|
|
|
|
of the corresponding tuner/modulator is set.
|
|
|
|
|
|
|
|
|
|
|
[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 11:14:19 +00:00
|
|
|
.. tabularcolumns:: |p{2.9cm}|p{2.9cm}|p{5.8cm}|p{2.9cm}|p{3.0cm}|
|
|
|
|
|
|
2016-08-29 20:37:59 +00:00
|
|
|
.. c:type:: v4l2_frequency_band
|
2016-08-19 14:14:23 +00:00
|
|
|
|
2016-06-30 13:18:56 +00:00
|
|
|
.. flat-table:: struct v4l2_frequency_band
|
|
|
|
|
:header-rows: 0
|
|
|
|
|
:stub-columns: 0
|
|
|
|
|
:widths: 1 1 2 1 1
|
|
|
|
|
|
[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 11:44:34 +00:00
|
|
|
* - __u32
|
|
|
|
|
- ``tuner``
|
|
|
|
|
- The tuner or modulator index number. This is the same value as in
|
|
|
|
|
the struct :c:type:`v4l2_input` ``tuner`` field and
|
|
|
|
|
the struct :c:type:`v4l2_tuner` ``index`` field, or
|
|
|
|
|
the struct :c:type:`v4l2_output` ``modulator`` field
|
|
|
|
|
and the struct :c:type:`v4l2_modulator` ``index``
|
|
|
|
|
field.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``type``
|
|
|
|
|
- The tuner type. This is the same value as in the struct
|
|
|
|
|
:c:type:`v4l2_tuner` ``type`` field. The type must be
|
|
|
|
|
set to ``V4L2_TUNER_RADIO`` for ``/dev/radioX`` device nodes, and
|
|
|
|
|
to ``V4L2_TUNER_ANALOG_TV`` for all others. Set this field to
|
|
|
|
|
``V4L2_TUNER_RADIO`` for modulators (currently only radio
|
|
|
|
|
modulators are supported). See :c:type:`v4l2_tuner_type`
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``index``
|
|
|
|
|
- Identifies the frequency band, set by the application.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``capability``
|
|
|
|
|
- :cspan:`2` The tuner/modulator capability flags for this
|
|
|
|
|
frequency band, see :ref:`tuner-capability`. The
|
|
|
|
|
``V4L2_TUNER_CAP_LOW`` or ``V4L2_TUNER_CAP_1HZ`` capability must
|
|
|
|
|
be the same for all frequency bands of the selected
|
|
|
|
|
tuner/modulator. So either all bands have that capability set, or
|
|
|
|
|
none of them have that capability.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``rangelow``
|
|
|
|
|
- :cspan:`2` The lowest tunable frequency in units of 62.5 kHz, or
|
|
|
|
|
if the ``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in units
|
|
|
|
|
of 62.5 Hz, for this frequency band. A 1 Hz unit is used when the
|
|
|
|
|
``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is set.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``rangehigh``
|
|
|
|
|
- :cspan:`2` The highest tunable frequency in units of 62.5 kHz,
|
|
|
|
|
or if the ``capability`` flag ``V4L2_TUNER_CAP_LOW`` is set, in
|
|
|
|
|
units of 62.5 Hz, for this frequency band. A 1 Hz unit is used
|
|
|
|
|
when the ``capability`` flag ``V4L2_TUNER_CAP_1HZ`` is set.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``modulation``
|
|
|
|
|
- :cspan:`2` The supported modulation systems of this frequency
|
|
|
|
|
band. See :ref:`band-modulation`.
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
|
|
Currently only one modulation system per frequency band
|
|
|
|
|
is supported. More work will need to be done if multiple
|
|
|
|
|
modulation systems are possible. Contact the linux-media
|
|
|
|
|
mailing list
|
|
|
|
|
(`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__)
|
|
|
|
|
if you need such functionality.
|
|
|
|
|
* - __u32
|
|
|
|
|
- ``reserved``\ [9]
|
|
|
|
|
- Reserved for future extensions.
|
|
|
|
|
|
|
|
|
|
Applications and drivers must set the array to zero.
|
2016-06-30 13:18:56 +00: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 11:14:19 +00:00
|
|
|
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
|
|
|
|
|
|
2016-08-19 14:14:23 +00:00
|
|
|
.. _band-modulation:
|
|
|
|
|
|
2016-06-30 13:18:56 +00:00
|
|
|
.. flat-table:: Band Modulation Systems
|
|
|
|
|
:header-rows: 0
|
|
|
|
|
:stub-columns: 0
|
|
|
|
|
:widths: 3 1 4
|
|
|
|
|
|
[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 11:44:34 +00:00
|
|
|
* - ``V4L2_BAND_MODULATION_VSB``
|
|
|
|
|
- 0x02
|
|
|
|
|
- Vestigial Sideband modulation, used for analog TV.
|
|
|
|
|
* - ``V4L2_BAND_MODULATION_FM``
|
|
|
|
|
- 0x04
|
|
|
|
|
- Frequency Modulation, commonly used for analog radio.
|
|
|
|
|
* - ``V4L2_BAND_MODULATION_AM``
|
|
|
|
|
- 0x08
|
|
|
|
|
- Amplitude Modulation, commonly used for analog radio.
|
2016-06-30 13:18:56 +00:00
|
|
|
|
|
|
|
|
|
2016-07-05 18:14:35 +00:00
|
|
|
Return Value
|
2016-06-30 13:18:56 +00: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 ``tuner`` or ``index`` is out of bounds or the ``type`` field is
|
|
|
|
|
wrong.
|
