c2b66cafdf
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>
128 lines
3.5 KiB
ReStructuredText
128 lines
3.5 KiB
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _VIDIOC_G_AUDIO:
|
|
|
|
************************************
|
|
ioctl VIDIOC_G_AUDIO, VIDIOC_S_AUDIO
|
|
************************************
|
|
|
|
Name
|
|
====
|
|
|
|
VIDIOC_G_AUDIO - VIDIOC_S_AUDIO - Query or select the current audio input and its attributes
|
|
|
|
|
|
Synopsis
|
|
========
|
|
|
|
.. c:function:: int ioctl( int fd, VIDIOC_G_AUDIO, struct v4l2_audio *argp )
|
|
:name: VIDIOC_G_AUDIO
|
|
|
|
.. c:function:: int ioctl( int fd, VIDIOC_S_AUDIO, const struct v4l2_audio *argp )
|
|
:name: VIDIOC_S_AUDIO
|
|
|
|
|
|
Arguments
|
|
=========
|
|
|
|
``fd``
|
|
File descriptor returned by :ref:`open() <func-open>`.
|
|
|
|
``argp``
|
|
|
|
|
|
Description
|
|
===========
|
|
|
|
To query the current audio input applications zero out the ``reserved``
|
|
array of a struct :c:type:`v4l2_audio` and call the
|
|
:ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` ioctl with a pointer to this structure. Drivers fill
|
|
the rest of the structure or return an ``EINVAL`` error code when the device
|
|
has no audio inputs, or none which combine with the current video input.
|
|
|
|
Audio inputs have one writable property, the audio mode. To select the
|
|
current audio input *and* change the audio mode, applications initialize
|
|
the ``index`` and ``mode`` fields, and the ``reserved`` array of a
|
|
struct :c:type:`v4l2_audio` structure and call the :ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>`
|
|
ioctl. Drivers may switch to a different audio mode if the request
|
|
cannot be satisfied. However, this is a write-only ioctl, it does not
|
|
return the actual new audio mode.
|
|
|
|
|
|
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
|
|
|
|
.. c:type:: v4l2_audio
|
|
|
|
.. flat-table:: struct v4l2_audio
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
:widths: 1 1 2
|
|
|
|
* - __u32
|
|
- ``index``
|
|
- Identifies the audio input, set by the driver or application.
|
|
* - __u8
|
|
- ``name``\ [32]
|
|
- Name of the audio input, a NUL-terminated ASCII string, for
|
|
example: "Line In". This information is intended for the user,
|
|
preferably the connector label on the device itself.
|
|
* - __u32
|
|
- ``capability``
|
|
- Audio capability flags, see :ref:`audio-capability`.
|
|
* - __u32
|
|
- ``mode``
|
|
- Audio mode flags set by drivers and applications (on
|
|
:ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` ioctl), see :ref:`audio-mode`.
|
|
* - __u32
|
|
- ``reserved``\ [2]
|
|
- Reserved for future extensions. Drivers and applications must set
|
|
the array to zero.
|
|
|
|
|
|
|
|
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
|
|
|
|
.. _audio-capability:
|
|
|
|
.. flat-table:: Audio Capability Flags
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
:widths: 3 1 4
|
|
|
|
* - ``V4L2_AUDCAP_STEREO``
|
|
- 0x00001
|
|
- This is a stereo input. The flag is intended to automatically
|
|
disable stereo recording etc. when the signal is always monaural.
|
|
The API provides no means to detect if stereo is *received*,
|
|
unless the audio input belongs to a tuner.
|
|
* - ``V4L2_AUDCAP_AVL``
|
|
- 0x00002
|
|
- Automatic Volume Level mode is supported.
|
|
|
|
|
|
|
|
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
|
|
|
|
.. _audio-mode:
|
|
|
|
.. flat-table:: Audio Mode Flags
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
:widths: 3 1 4
|
|
|
|
* - ``V4L2_AUDMODE_AVL``
|
|
- 0x00001
|
|
- AVL mode is on.
|
|
|
|
|
|
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.
|
|
|
|
EINVAL
|
|
No audio inputs combine with the current video input, or the number
|
|
of the selected audio input is out of bounds or it does not combine.
|