Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[media] DocBook: add missing AUDIO_* ioctls

Add the missing AUDIO_* ioctls and document the V4L2 replacements for the
various DVB AUDIO ioctls that were (ab)used by V4L2.

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

authored by

Hans Verkuil and committed by
Mauro Carvalho Chehab
a9d134f2 510f0a0f

+112 -1
+112 -1
Documentation/DocBook/media/dvb/audio.xml
··· 1 1 <title>DVB Audio Device</title> 2 2 <para>The DVB audio device controls the MPEG2 audio decoder of the DVB hardware. It 3 3 can be accessed through <emphasis role="tt">/dev/dvb/adapter0/audio0</emphasis>. Data types and and 4 - ioctl definitions can be accessed by including <emphasis role="tt">linux/dvb/video.h</emphasis> in your 4 + ioctl definitions can be accessed by including <emphasis role="tt">linux/dvb/audio.h</emphasis> in your 5 5 application. 6 6 </para> 7 7 <para>Please note that some DVB cards don&#8217;t have their own MPEG decoder, which results in 8 8 the omission of the audio and video device. 9 9 </para> 10 + <para> 11 + These ioctls were also used by V4L2 to control MPEG decoders implemented in V4L2. The use 12 + of these ioctls for that purpose has been made obsolete and proper V4L2 ioctls or controls 13 + have been created to replace that functionality.</para> 10 14 11 15 <section id="audio_data_types"> 12 16 <title>Audio Data Types</title> ··· 562 558 role="subsection"><title>AUDIO_SET_MUTE</title> 563 559 <para>DESCRIPTION 564 560 </para> 561 + <para>This ioctl is for DVB devices only. To control a V4L2 decoder use the V4L2 562 + &VIDIOC-DECODER-CMD; with the <constant>V4L2_DEC_CMD_START_MUTE_AUDIO</constant> flag instead.</para> 565 563 <informaltable><tgroup cols="1"><tbody><row><entry 566 564 align="char"> 567 565 <para>This ioctl call asks the audio device to mute the stream that is currently being ··· 736 730 role="subsection"><title>AUDIO_CHANNEL_SELECT</title> 737 731 <para>DESCRIPTION 738 732 </para> 733 + <para>This ioctl is for DVB devices only. To control a V4L2 decoder use the V4L2 734 + <constant>V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK</constant> control instead.</para> 739 735 <informaltable><tgroup cols="1"><tbody><row><entry 740 736 align="char"> 741 737 <para>This ioctl call asks the Audio Device to select the requested channel if possible.</para> ··· 776 768 align="char"> 777 769 <para>Select the output format of the audio (mono left/right, 778 770 stereo).</para> 771 + </entry> 772 + </row></tbody></tgroup></informaltable> 773 + &return-value-dvb; 774 + 775 + </section><section id="AUDIO_BILINGUAL_CHANNEL_SELECT" 776 + role="subsection"><title>AUDIO_BILINGUAL_CHANNEL_SELECT</title> 777 + <para>DESCRIPTION 778 + </para> 779 + <para>This ioctl is obsolete. Do not use in new drivers. It has been replaced by 780 + the V4L2 <constant>V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK</constant> control 781 + for MPEG decoders controlled through V4L2.</para> 782 + <informaltable><tgroup cols="1"><tbody><row><entry 783 + align="char"> 784 + <para>This ioctl call asks the Audio Device to select the requested channel for bilingual streams if possible.</para> 785 + </entry> 786 + </row></tbody></tgroup></informaltable> 787 + <para>SYNOPSIS 788 + </para> 789 + <informaltable><tgroup cols="1"><tbody><row><entry 790 + align="char"> 791 + <para>int ioctl(int fd, int request = 792 + AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t);</para> 793 + </entry> 794 + </row></tbody></tgroup></informaltable> 795 + <para>PARAMETERS 796 + </para> 797 + <informaltable><tgroup cols="2"><tbody><row><entry 798 + align="char"> 799 + <para>int fd</para> 800 + </entry><entry 801 + align="char"> 802 + <para>File descriptor returned by a previous call to open().</para> 803 + </entry> 804 + </row><row><entry 805 + align="char"> 806 + <para>int request</para> 807 + </entry><entry 808 + align="char"> 809 + <para>Equals AUDIO_BILINGUAL_CHANNEL_SELECT for this 810 + command.</para> 811 + </entry> 812 + </row><row><entry 813 + align="char"> 814 + <para>audio_channel_select_t 815 + ch</para> 816 + </entry><entry 817 + align="char"> 818 + <para>Select the output format of the audio (mono left/right, 819 + stereo).</para> 820 + </entry> 821 + </row> 822 + </tbody></tgroup></informaltable> 823 + &return-value-dvb; 824 + 825 + </section><section id="AUDIO_GET_PTS" 826 + role="subsection"><title>AUDIO_GET_PTS</title> 827 + <para>DESCRIPTION 828 + </para> 829 + <para>This ioctl is obsolete. Do not use in new drivers. If you need this functionality, 830 + then please contact the linux-media mailing list (&v4l-ml;).</para> 831 + <informaltable><tgroup cols="1"><tbody><row><entry 832 + align="char"> 833 + <para>This ioctl call asks the Audio Device to return the current PTS timestamp.</para> 834 + </entry> 835 + </row></tbody></tgroup></informaltable> 836 + <para>SYNOPSIS 837 + </para> 838 + <informaltable><tgroup cols="1"><tbody><row><entry 839 + align="char"> 840 + <para>int ioctl(int fd, int request = 841 + AUDIO_GET_PTS, __u64 *pts);</para> 842 + </entry> 843 + </row></tbody></tgroup></informaltable> 844 + <para>PARAMETERS 845 + </para> 846 + <informaltable><tgroup cols="2"><tbody><row><entry 847 + align="char"> 848 + <para>int fd</para> 849 + </entry><entry 850 + align="char"> 851 + <para>File descriptor returned by a previous call to open().</para> 852 + </entry> 853 + </row><row><entry 854 + align="char"> 855 + <para>int request</para> 856 + </entry><entry 857 + align="char"> 858 + <para>Equals AUDIO_GET_PTS for this 859 + command.</para> 860 + </entry> 861 + </row><row><entry 862 + align="char"> 863 + <para>__u64 *pts 864 + </para> 865 + </entry><entry 866 + align="char"> 867 + <para>Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 / ISO/IEC 13818-1. 868 + </para> 869 + <para> 870 + The PTS should belong to the currently played 871 + frame if possible, but may also be a value close to it 872 + like the PTS of the last decoded frame or the last PTS 873 + extracted by the PES parser.</para> 779 874 </entry> 780 875 </row></tbody></tgroup></informaltable> 781 876 &return-value-dvb;