Merge tag 'docs-5.0-fixes' of git://git.lwn.net/linux
[sfrench/cifs-2.6.git] / Documentation / media / uapi / dvb / audio.rst
1 .. Permission is granted to copy, distribute and/or modify this
2 .. document under the terms of the GNU Free Documentation License,
3 .. Version 1.1 or any later version published by the Free Software
4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
5 .. and no Back-Cover Texts. A copy of the license is included at
6 .. Documentation/media/uapi/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10 .. _dvb_audio:
11
12 #######################
13 Digital TV Audio Device
14 #######################
15
16 The Digital TV audio device controls the MPEG2 audio decoder of the Digital
17 TV hardware. It can be accessed through ``/dev/dvb/adapter?/audio?``. Data
18 types and and ioctl definitions can be accessed by including
19 ``linux/dvb/audio.h`` in your application.
20
21 Please note that some Digital TV cards don’t have their own MPEG decoder, which
22 results in the omission of the audio and video device.
23
24 These ioctls were also used by V4L2 to control MPEG decoders implemented
25 in V4L2. The use of these ioctls for that purpose has been made obsolete
26 and proper V4L2 ioctls or controls have been created to replace that
27 functionality.
28
29
30 .. toctree::
31     :maxdepth: 1
32
33     audio_data_types
34     audio_function_calls