Path: blob/master/Documentation/DocBook/dvb/audio.xml
10823 views
<title>DVB Audio Device</title>1<para>The DVB audio device controls the MPEG2 audio decoder of the DVB hardware. It2can be accessed through <emphasis role="tt">/dev/dvb/adapter0/audio0</emphasis>. Data types and and3ioctl definitions can be accessed by including <emphasis role="tt">linux/dvb/video.h</emphasis> in your4application.5</para>6<para>Please note that some DVB cards don’t have their own MPEG decoder, which results in7the omission of the audio and video device.8</para>910<section id="audio_data_types">11<title>Audio Data Types</title>12<para>This section describes the structures, data types and defines used when talking to the13audio device.14</para>1516<section id="audio_stream_source_t">17<title>audio_stream_source_t</title>18<para>The audio stream source is set through the AUDIO_SELECT_SOURCE call and can take19the following values, depending on whether we are replaying from an internal (demux) or20external (user write) source.21</para>22<programlisting>23typedef enum {24AUDIO_SOURCE_DEMUX,25AUDIO_SOURCE_MEMORY26} audio_stream_source_t;27</programlisting>28<para>AUDIO_SOURCE_DEMUX selects the demultiplexer (fed either by the frontend or the29DVR device) as the source of the video stream. If AUDIO_SOURCE_MEMORY30is selected the stream comes from the application through the <emphasis role="tt">write()</emphasis> system31call.32</para>3334</section>35<section id="audio_play_state_t">36<title>audio_play_state_t</title>37<para>The following values can be returned by the AUDIO_GET_STATUS call representing the38state of audio playback.39</para>40<programlisting>41typedef enum {42AUDIO_STOPPED,43AUDIO_PLAYING,44AUDIO_PAUSED45} audio_play_state_t;46</programlisting>4748</section>49<section id="audio_channel_select_t">50<title>audio_channel_select_t</title>51<para>The audio channel selected via AUDIO_CHANNEL_SELECT is determined by the52following values.53</para>54<programlisting>55typedef enum {56AUDIO_STEREO,57AUDIO_MONO_LEFT,58AUDIO_MONO_RIGHT,59} audio_channel_select_t;60</programlisting>6162</section>63<section id="struct_audio_status">64<title>struct audio_status</title>65<para>The AUDIO_GET_STATUS call returns the following structure informing about various66states of the playback operation.67</para>68<programlisting>69typedef struct audio_status {70boolean AV_sync_state;71boolean mute_state;72audio_play_state_t play_state;73audio_stream_source_t stream_source;74audio_channel_select_t channel_select;75boolean bypass_mode;76} audio_status_t;77</programlisting>7879</section>80<section id="struct_audio_mixer">81<title>struct audio_mixer</title>82<para>The following structure is used by the AUDIO_SET_MIXER call to set the audio83volume.84</para>85<programlisting>86typedef struct audio_mixer {87unsigned int volume_left;88unsigned int volume_right;89} audio_mixer_t;90</programlisting>9192</section>93<section id="audio_encodings">94<title>audio encodings</title>95<para>A call to AUDIO_GET_CAPABILITIES returns an unsigned integer with the following96bits set according to the hardwares capabilities.97</para>98<programlisting>99#define AUDIO_CAP_DTS 1100#define AUDIO_CAP_LPCM 2101#define AUDIO_CAP_MP1 4102#define AUDIO_CAP_MP2 8103#define AUDIO_CAP_MP3 16104#define AUDIO_CAP_AAC 32105#define AUDIO_CAP_OGG 64106#define AUDIO_CAP_SDDS 128107#define AUDIO_CAP_AC3 256108</programlisting>109110</section>111<section id="struct_audio_karaoke">112<title>struct audio_karaoke</title>113<para>The ioctl AUDIO_SET_KARAOKE uses the following format:114</para>115<programlisting>116typedef117struct audio_karaoke{118int vocal1;119int vocal2;120int melody;121} audio_karaoke_t;122</programlisting>123<para>If Vocal1 or Vocal2 are non-zero, they get mixed into left and right t at 70% each. If both,124Vocal1 and Vocal2 are non-zero, Vocal1 gets mixed into the left channel and Vocal2 into the125right channel at 100% each. Ff Melody is non-zero, the melody channel gets mixed into left126and right.127</para>128129</section>130<section id="audio_attributes">131<title>audio attributes</title>132<para>The following attributes can be set by a call to AUDIO_SET_ATTRIBUTES:133</para>134<programlisting>135typedef uint16_t audio_attributes_t;136/⋆ bits: descr. ⋆/137/⋆ 15-13 audio coding mode (0=ac3, 2=mpeg1, 3=mpeg2ext, 4=LPCM, 6=DTS, ⋆/138/⋆ 12 multichannel extension ⋆/139/⋆ 11-10 audio type (0=not spec, 1=language included) ⋆/140/⋆ 9- 8 audio application mode (0=not spec, 1=karaoke, 2=surround) ⋆/141/⋆ 7- 6 Quantization / DRC (mpeg audio: 1=DRC exists)(lpcm: 0=16bit, ⋆/142/⋆ 5- 4 Sample frequency fs (0=48kHz, 1=96kHz) ⋆/143/⋆ 2- 0 number of audio channels (n+1 channels) ⋆/144</programlisting>145</section></section>146<section id="audio_function_calls">147<title>Audio Function Calls</title>148149150<section id="audio_fopen">151<title>open()</title>152<para>DESCRIPTION153</para>154<informaltable><tgroup cols="1"><tbody><row><entry155align="char">156<para>This system call opens a named audio device (e.g. /dev/dvb/adapter0/audio0)157for subsequent use. When an open() call has succeeded, the device will be ready158for use. The significance of blocking or non-blocking mode is described in the159documentation for functions where there is a difference. It does not affect the160semantics of the open() call itself. A device opened in blocking mode can later161be put into non-blocking mode (and vice versa) using the F_SETFL command162of the fcntl system call. This is a standard system call, documented in the Linux163manual page for fcntl. Only one user can open the Audio Device in O_RDWR164mode. All other attempts to open the device in this mode will fail, and an error165code will be returned. If the Audio Device is opened in O_RDONLY mode, the166only ioctl call that can be used is AUDIO_GET_STATUS. All other call will167return with an error code.</para>168</entry>169</row></tbody></tgroup></informaltable>170<para>SYNOPSIS171</para>172<informaltable><tgroup cols="1"><tbody><row><entry173align="char">174<para>int open(const char ⋆deviceName, int flags);</para>175</entry>176</row></tbody></tgroup></informaltable>177<para>PARAMETERS178</para>179<informaltable><tgroup cols="2"><tbody><row><entry180align="char">181<para>const char182*deviceName</para>183</entry><entry184align="char">185<para>Name of specific audio device.</para>186</entry>187</row><row><entry188align="char">189<para>int flags</para>190</entry><entry191align="char">192<para>A bit-wise OR of the following flags:</para>193</entry>194</row><row><entry195align="char">196</entry><entry197align="char">198<para>O_RDONLY read-only access</para>199</entry>200</row><row><entry201align="char">202</entry><entry203align="char">204<para>O_RDWR read/write access</para>205</entry>206</row><row><entry207align="char">208</entry><entry209align="char">210<para>O_NONBLOCK open in non-blocking mode</para>211</entry>212</row><row><entry213align="char">214</entry><entry215align="char">216<para>(blocking mode is the default)</para>217</entry>218</row></tbody></tgroup></informaltable>219<para>ERRORS220</para>221<informaltable><tgroup cols="2"><tbody><row><entry222align="char">223<para>ENODEV</para>224</entry><entry225align="char">226<para>Device driver not loaded/available.</para>227</entry>228</row><row><entry229align="char">230<para>EINTERNAL</para>231</entry><entry232align="char">233<para>Internal error.</para>234</entry>235</row><row><entry236align="char">237<para>EBUSY</para>238</entry><entry239align="char">240<para>Device or resource busy.</para>241</entry>242</row><row><entry243align="char">244<para>EINVAL</para>245</entry><entry246align="char">247<para>Invalid argument.</para>248</entry>249</row></tbody></tgroup></informaltable>250251</section>252<section id="audio_fclose">253<title>close()</title>254<para>DESCRIPTION255</para>256<informaltable><tgroup cols="1"><tbody><row><entry257align="char">258<para>This system call closes a previously opened audio device.</para>259</entry>260</row></tbody></tgroup></informaltable>261<para>SYNOPSIS262</para>263<informaltable><tgroup cols="1"><tbody><row><entry264align="char">265<para>int close(int fd);</para>266</entry>267</row></tbody></tgroup></informaltable>268<para>PARAMETERS269</para>270<informaltable><tgroup cols="2"><tbody><row><entry271align="char">272<para>int fd</para>273</entry><entry274align="char">275<para>File descriptor returned by a previous call to open().</para>276</entry>277</row></tbody></tgroup></informaltable>278<para>ERRORS279</para>280<informaltable><tgroup cols="2"><tbody><row><entry281align="char">282<para>EBADF</para>283</entry><entry284align="char">285<para>fd is not a valid open file descriptor.</para>286</entry>287</row></tbody></tgroup></informaltable>288289</section>290<section id="audio_fwrite">291<title>write()</title>292<para>DESCRIPTION293</para>294<informaltable><tgroup cols="1"><tbody><row><entry295align="char">296<para>This system call can only be used if AUDIO_SOURCE_MEMORY is selected297in the ioctl call AUDIO_SELECT_SOURCE. The data provided shall be in298PES format. If O_NONBLOCK is not specified the function will block until299buffer space is available. The amount of data to be transferred is implied by300count.</para>301</entry>302</row></tbody></tgroup></informaltable>303<para>SYNOPSIS304</para>305<informaltable><tgroup cols="1"><tbody><row><entry306align="char">307<para>size_t write(int fd, const void ⋆buf, size_t count);</para>308</entry>309</row></tbody></tgroup></informaltable>310<para>PARAMETERS311</para>312<informaltable><tgroup cols="2"><tbody><row><entry313align="char">314<para>int fd</para>315</entry><entry316align="char">317<para>File descriptor returned by a previous call to open().</para>318</entry>319</row><row><entry320align="char">321<para>void *buf</para>322</entry><entry323align="char">324<para>Pointer to the buffer containing the PES data.</para>325</entry>326</row><row><entry327align="char">328<para>size_t count</para>329</entry><entry330align="char">331<para>Size of buf.</para>332</entry>333</row></tbody></tgroup></informaltable>334<para>ERRORS335</para>336<informaltable><tgroup cols="2"><tbody><row><entry337align="char">338<para>EPERM</para>339</entry><entry340align="char">341<para>Mode AUDIO_SOURCE_MEMORY not selected.</para>342</entry>343</row><row><entry344align="char">345<para>ENOMEM</para>346</entry><entry347align="char">348<para>Attempted to write more data than the internal buffer can349hold.</para>350</entry>351</row><row><entry352align="char">353<para>EBADF</para>354</entry><entry355align="char">356<para>fd is not a valid open file descriptor.</para>357</entry>358</row></tbody></tgroup></informaltable>359360</section><section361role="subsection"><title>AUDIO_STOP</title>362<para>DESCRIPTION363</para>364<informaltable><tgroup cols="1"><tbody><row><entry365align="char">366<para>This ioctl call asks the Audio Device to stop playing the current stream.</para>367</entry>368</row></tbody></tgroup></informaltable>369<para>SYNOPSIS370</para>371<informaltable><tgroup cols="1"><tbody><row><entry372align="char">373<para>int ioctl(int fd, int request = AUDIO_STOP);</para>374</entry>375</row></tbody></tgroup></informaltable>376<para>PARAMETERS377</para>378<informaltable><tgroup cols="2"><tbody><row><entry379align="char">380<para>int fd</para>381</entry><entry382align="char">383<para>File descriptor returned by a previous call to open().</para>384</entry>385</row><row><entry386align="char">387<para>int request</para>388</entry><entry389align="char">390<para>Equals AUDIO_STOP for this command.</para>391</entry>392</row></tbody></tgroup></informaltable>393<para>ERRORS394</para>395<informaltable><tgroup cols="2"><tbody><row><entry396align="char">397<para>EBADF</para>398</entry><entry399align="char">400<para>fd is not a valid open file descriptor</para>401</entry>402</row><row><entry403align="char">404<para>EINTERNAL</para>405</entry><entry406align="char">407<para>Internal error.</para>408</entry>409</row></tbody></tgroup></informaltable>410411</section><section412role="subsection"><title>AUDIO_PLAY</title>413<para>DESCRIPTION414</para>415<informaltable><tgroup cols="1"><tbody><row><entry416align="char">417<para>This ioctl call asks the Audio Device to start playing an audio stream from the418selected source.</para>419</entry>420</row></tbody></tgroup></informaltable>421<para>SYNOPSIS422</para>423<informaltable><tgroup cols="1"><tbody><row><entry424align="char">425<para>int ioctl(int fd, int request = AUDIO_PLAY);</para>426</entry>427</row></tbody></tgroup></informaltable>428<para>PARAMETERS429</para>430<informaltable><tgroup cols="2"><tbody><row><entry431align="char">432<para>int fd</para>433</entry><entry434align="char">435<para>File descriptor returned by a previous call to open().</para>436</entry>437</row><row><entry438align="char">439<para>int request</para>440</entry><entry441align="char">442<para>Equals AUDIO_PLAY for this command.</para>443</entry>444</row></tbody></tgroup></informaltable>445<para>ERRORS446</para>447<informaltable><tgroup cols="2"><tbody><row><entry448align="char">449<para>EBADF</para>450</entry><entry451align="char">452<para>fd is not a valid open file descriptor</para>453</entry>454</row><row><entry455align="char">456<para>EINTERNAL</para>457</entry><entry458align="char">459<para>Internal error.</para>460</entry>461</row></tbody></tgroup></informaltable>462463</section><section464role="subsection"><title>AUDIO_PAUSE</title>465<para>DESCRIPTION466</para>467<informaltable><tgroup cols="1"><tbody><row><entry468align="char">469<para>This ioctl call suspends the audio stream being played. Decoding and playing470are paused. It is then possible to restart again decoding and playing process of471the audio stream using AUDIO_CONTINUE command.</para>472</entry>473</row><row><entry474align="char">475<para>If AUDIO_SOURCE_MEMORY is selected in the ioctl call476AUDIO_SELECT_SOURCE, the DVB-subsystem will not decode (consume)477any more data until the ioctl call AUDIO_CONTINUE or AUDIO_PLAY is478performed.</para>479</entry>480</row></tbody></tgroup></informaltable>481<para>SYNOPSIS482</para>483<informaltable><tgroup cols="1"><tbody><row><entry484align="char">485<para>int ioctl(int fd, int request = AUDIO_PAUSE);</para>486</entry>487</row></tbody></tgroup></informaltable>488<para>PARAMETERS489</para>490<informaltable><tgroup cols="2"><tbody><row><entry491align="char">492<para>int fd</para>493</entry><entry494align="char">495<para>File descriptor returned by a previous call to open().</para>496</entry>497</row><row><entry498align="char">499<para>int request</para>500</entry><entry501align="char">502<para>Equals AUDIO_PAUSE for this command.</para>503</entry>504</row></tbody></tgroup></informaltable>505<para>ERRORS506</para>507<informaltable><tgroup cols="2"><tbody><row><entry508align="char">509<para>EBADF</para>510</entry><entry511align="char">512<para>fd is not a valid open file descriptor.</para>513</entry>514</row><row><entry515align="char">516<para>EINTERNAL</para>517</entry><entry518align="char">519<para>Internal error.</para>520</entry>521</row></tbody></tgroup></informaltable>522523</section><section524role="subsection"><title>AUDIO_SELECT_SOURCE</title>525<para>DESCRIPTION526</para>527<informaltable><tgroup cols="1"><tbody><row><entry528align="char">529<para>This ioctl call informs the audio device which source shall be used530for the input data. The possible sources are demux or memory. If531AUDIO_SOURCE_MEMORY is selected, the data is fed to the Audio Device532through the write command.</para>533</entry>534</row></tbody></tgroup></informaltable>535<para>SYNOPSIS536</para>537<informaltable><tgroup cols="1"><tbody><row><entry538align="char">539<para>int ioctl(int fd, int request = AUDIO_SELECT_SOURCE,540audio_stream_source_t source);</para>541</entry>542</row></tbody></tgroup></informaltable>543<para>PARAMETERS544</para>545<informaltable><tgroup cols="2"><tbody><row><entry546align="char">547<para>int fd</para>548</entry><entry549align="char">550<para>File descriptor returned by a previous call to open().</para>551</entry>552</row><row><entry553align="char">554<para>int request</para>555</entry><entry556align="char">557<para>Equals AUDIO_SELECT_SOURCE for this command.</para>558</entry>559</row><row><entry560align="char">561<para>audio_stream_source_t562source</para>563</entry><entry564align="char">565<para>Indicates the source that shall be used for the Audio566stream.</para>567</entry>568</row></tbody></tgroup></informaltable>569<para>ERRORS570</para>571<informaltable><tgroup cols="2"><tbody><row><entry572align="char">573<para>EBADF</para>574</entry><entry575align="char">576<para>fd is not a valid open file descriptor.</para>577</entry>578</row><row><entry579align="char">580<para>EINTERNAL</para>581</entry><entry582align="char">583<para>Internal error.</para>584</entry>585</row><row><entry586align="char">587<para>EINVAL</para>588</entry><entry589align="char">590<para>Illegal input parameter.</para>591</entry>592</row></tbody></tgroup></informaltable>593594</section><section595role="subsection"><title>AUDIO_SET_MUTE</title>596<para>DESCRIPTION597</para>598<informaltable><tgroup cols="1"><tbody><row><entry599align="char">600<para>This ioctl call asks the audio device to mute the stream that is currently being601played.</para>602</entry>603</row></tbody></tgroup></informaltable>604<para>SYNOPSIS605</para>606<informaltable><tgroup cols="1"><tbody><row><entry607align="char">608<para>int ioctl(int fd, int request = AUDIO_SET_MUTE,609boolean state);</para>610</entry>611</row></tbody></tgroup></informaltable>612<para>PARAMETERS613</para>614<informaltable><tgroup cols="2"><tbody><row><entry615align="char">616<para>int fd</para>617</entry><entry618align="char">619<para>File descriptor returned by a previous call to open().</para>620</entry>621</row><row><entry622align="char">623<para>int request</para>624</entry><entry625align="char">626<para>Equals AUDIO_SET_MUTE for this command.</para>627</entry>628</row><row><entry629align="char">630<para>boolean state</para>631</entry><entry632align="char">633<para>Indicates if audio device shall mute or not.</para>634</entry>635</row><row><entry636align="char">637</entry><entry638align="char">639<para>TRUE Audio Mute</para>640</entry>641</row><row><entry642align="char">643</entry><entry644align="char">645<para>FALSE Audio Un-mute</para>646</entry>647</row></tbody></tgroup></informaltable>648<para>ERRORS649</para>650<informaltable><tgroup cols="2"><tbody><row><entry651align="char">652<para>EBADF</para>653</entry><entry654align="char">655<para>fd is not a valid open file descriptor.</para>656</entry>657</row><row><entry658align="char">659<para>EINTERNAL</para>660</entry><entry661align="char">662<para>Internal error.</para>663</entry>664</row><row><entry665align="char">666<para>EINVAL</para>667</entry><entry668align="char">669<para>Illegal input parameter.</para>670</entry>671</row></tbody></tgroup></informaltable>672673</section><section674role="subsection"><title>AUDIO_SET_AV_SYNC</title>675<para>DESCRIPTION676</para>677<informaltable><tgroup cols="1"><tbody><row><entry678align="char">679<para>This ioctl call asks the Audio Device to turn ON or OFF A/V synchronization.</para>680</entry>681</row></tbody></tgroup></informaltable>682<para>SYNOPSIS683</para>684<informaltable><tgroup cols="1"><tbody><row><entry685align="char">686<para>int ioctl(int fd, int request = AUDIO_SET_AV_SYNC,687boolean state);</para>688</entry>689</row></tbody></tgroup></informaltable>690<para>PARAMETERS691</para>692<informaltable><tgroup cols="2"><tbody><row><entry693align="char">694<para>int fd</para>695</entry><entry696align="char">697<para>File descriptor returned by a previous call to open().</para>698</entry>699</row><row><entry700align="char">701<para>int request</para>702</entry><entry703align="char">704<para>Equals AUDIO_AV_SYNC for this command.</para>705</entry>706</row><row><entry707align="char">708<para>boolean state</para>709</entry><entry710align="char">711<para>Tells the DVB subsystem if A/V synchronization shall be712ON or OFF.</para>713</entry>714</row><row><entry715align="char">716</entry><entry717align="char">718<para>TRUE AV-sync ON</para>719</entry>720</row><row><entry721align="char">722</entry><entry723align="char">724<para>FALSE AV-sync OFF</para>725</entry>726</row></tbody></tgroup></informaltable>727<para>ERRORS728</para>729<informaltable><tgroup cols="2"><tbody><row><entry730align="char">731<para>EBADF</para>732</entry><entry733align="char">734<para>fd is not a valid open file descriptor.</para>735</entry>736</row><row><entry737align="char">738<para>EINTERNAL</para>739</entry><entry740align="char">741<para>Internal error.</para>742</entry>743</row><row><entry744align="char">745<para>EINVAL</para>746</entry><entry747align="char">748<para>Illegal input parameter.</para>749</entry>750</row></tbody></tgroup></informaltable>751752</section><section753role="subsection"><title>AUDIO_SET_BYPASS_MODE</title>754<para>DESCRIPTION755</para>756<informaltable><tgroup cols="1"><tbody><row><entry757align="char">758<para>This ioctl call asks the Audio Device to bypass the Audio decoder and forward759the stream without decoding. This mode shall be used if streams that can’t be760handled by the DVB system shall be decoded. Dolby DigitalTM streams are761automatically forwarded by the DVB subsystem if the hardware can handle it.</para>762</entry>763</row></tbody></tgroup></informaltable>764<para>SYNOPSIS765</para>766<informaltable><tgroup cols="1"><tbody><row><entry767align="char">768<para>int ioctl(int fd, int request =769AUDIO_SET_BYPASS_MODE, boolean mode);</para>770</entry>771</row></tbody></tgroup></informaltable>772<para>PARAMETERS773</para>774<informaltable><tgroup cols="2"><tbody><row><entry775align="char">776<para>int fd</para>777</entry><entry778align="char">779<para>File descriptor returned by a previous call to open().</para>780</entry>781</row><row><entry782align="char">783<para>int request</para>784</entry><entry785align="char">786<para>Equals AUDIO_SET_BYPASS_MODE for this787command.</para>788</entry>789</row><row><entry790align="char">791<para>boolean mode</para>792</entry><entry793align="char">794<para>Enables or disables the decoding of the current Audio795stream in the DVB subsystem.</para>796</entry>797</row><row><entry798align="char">799</entry><entry800align="char">801<para>TRUE Bypass is disabled</para>802</entry>803</row><row><entry804align="char">805</entry><entry806align="char">807<para>FALSE Bypass is enabled</para>808</entry>809</row></tbody></tgroup></informaltable>810<para>ERRORS811</para>812<informaltable><tgroup cols="2"><tbody><row><entry813align="char">814<para>EBADF</para>815</entry><entry816align="char">817<para>fd is not a valid open file descriptor.</para>818</entry>819</row><row><entry820align="char">821<para>EINTERNAL</para>822</entry><entry823align="char">824<para>Internal error.</para>825</entry>826</row><row><entry827align="char">828<para>EINVAL</para>829</entry><entry830align="char">831<para>Illegal input parameter.</para>832</entry>833</row></tbody></tgroup></informaltable>834835</section><section836role="subsection"><title>AUDIO_CHANNEL_SELECT</title>837<para>DESCRIPTION838</para>839<informaltable><tgroup cols="1"><tbody><row><entry840align="char">841<para>This ioctl call asks the Audio Device to select the requested channel if possible.</para>842</entry>843</row></tbody></tgroup></informaltable>844<para>SYNOPSIS845</para>846<informaltable><tgroup cols="1"><tbody><row><entry847align="char">848<para>int ioctl(int fd, int request =849AUDIO_CHANNEL_SELECT, audio_channel_select_t);</para>850</entry>851</row></tbody></tgroup></informaltable>852<para>PARAMETERS853</para>854<informaltable><tgroup cols="2"><tbody><row><entry855align="char">856<para>int fd</para>857</entry><entry858align="char">859<para>File descriptor returned by a previous call to open().</para>860</entry>861</row><row><entry862align="char">863<para>int request</para>864</entry><entry865align="char">866<para>Equals AUDIO_CHANNEL_SELECT for this867command.</para>868</entry>869</row><row><entry870align="char">871<para>audio_channel_select_t872ch</para>873</entry><entry874align="char">875<para>Select the output format of the audio (mono left/right,876stereo).</para>877</entry>878</row></tbody></tgroup></informaltable>879<para>ERRORS880</para>881<informaltable><tgroup cols="2"><tbody><row><entry882align="char">883<para>EBADF</para>884</entry><entry885align="char">886<para>fd is not a valid open file descriptor.</para>887</entry>888</row><row><entry889align="char">890<para>EINTERNAL</para>891</entry><entry892align="char">893<para>Internal error.</para>894</entry>895</row><row><entry896align="char">897<para>EINVAL</para>898</entry><entry899align="char">900<para>Illegal input parameter ch.</para>901</entry>902</row></tbody></tgroup></informaltable>903904</section><section905role="subsection"><title>AUDIO_GET_STATUS</title>906<para>DESCRIPTION907</para>908<informaltable><tgroup cols="1"><tbody><row><entry909align="char">910<para>This ioctl call asks the Audio Device to return the current state of the Audio911Device.</para>912</entry>913</row></tbody></tgroup></informaltable>914<para>SYNOPSIS915</para>916<informaltable><tgroup cols="1"><tbody><row><entry917align="char">918<para>int ioctl(int fd, int request = AUDIO_GET_STATUS,919struct audio_status ⋆status);</para>920</entry>921</row></tbody></tgroup></informaltable>922<para>PARAMETERS923</para>924<informaltable><tgroup cols="2"><tbody><row><entry925align="char">926<para>int fd</para>927</entry><entry928align="char">929<para>File descriptor returned by a previous call to open().</para>930</entry>931</row><row><entry932align="char">933<para>int request</para>934</entry><entry935align="char">936<para>Equals AUDIO_GET_STATUS for this command.</para>937</entry>938</row><row><entry939align="char">940<para>struct audio_status941*status</para>942</entry><entry943align="char">944<para>Returns the current state of Audio Device.</para>945</entry>946</row></tbody></tgroup></informaltable>947<para>ERRORS948</para>949<informaltable><tgroup cols="2"><tbody><row><entry950align="char">951<para>EBADF</para>952</entry><entry953align="char">954<para>fd is not a valid open file descriptor.</para>955</entry>956</row><row><entry957align="char">958<para>EINTERNAL</para>959</entry><entry960align="char">961<para>Internal error.</para>962</entry>963</row><row><entry964align="char">965<para>EFAULT</para>966</entry><entry967align="char">968<para>status points to invalid address.</para>969</entry>970</row></tbody></tgroup></informaltable>971972</section><section973role="subsection"><title>AUDIO_GET_CAPABILITIES</title>974<para>DESCRIPTION975</para>976<informaltable><tgroup cols="1"><tbody><row><entry977align="char">978<para>This ioctl call asks the Audio Device to tell us about the decoding capabilities979of the audio hardware.</para>980</entry>981</row></tbody></tgroup></informaltable>982<para>SYNOPSIS983</para>984<informaltable><tgroup cols="1"><tbody><row><entry985align="char">986<para>int ioctl(int fd, int request =987AUDIO_GET_CAPABILITIES, unsigned int ⋆cap);</para>988</entry>989</row></tbody></tgroup></informaltable>990<para>PARAMETERS991</para>992<informaltable><tgroup cols="2"><tbody><row><entry993align="char">994<para>int fd</para>995</entry><entry996align="char">997<para>File descriptor returned by a previous call to open().</para>998</entry>999</row><row><entry1000align="char">1001<para>int request</para>1002</entry><entry1003align="char">1004<para>Equals AUDIO_GET_CAPABILITIES for this1005command.</para>1006</entry>1007</row><row><entry1008align="char">1009<para>unsigned int *cap</para>1010</entry><entry1011align="char">1012<para>Returns a bit array of supported sound formats.</para>1013</entry>1014</row></tbody></tgroup></informaltable>1015<para>ERRORS1016</para>1017<informaltable><tgroup cols="2"><tbody><row><entry1018align="char">1019<para>EBADF</para>1020</entry><entry1021align="char">1022<para>fd is not a valid open file descriptor.</para>1023</entry>1024</row><row><entry1025align="char">1026<para>EINTERNAL</para>1027</entry><entry1028align="char">1029<para>Internal error.</para>1030</entry>1031</row><row><entry1032align="char">1033<para>EFAULT</para>1034</entry><entry1035align="char">1036<para>cap points to an invalid address.</para>1037</entry>1038</row></tbody></tgroup></informaltable>10391040</section><section1041role="subsection"><title>AUDIO_CLEAR_BUFFER</title>1042<para>DESCRIPTION1043</para>1044<informaltable><tgroup cols="1"><tbody><row><entry1045align="char">1046<para>This ioctl call asks the Audio Device to clear all software and hardware buffers1047of the audio decoder device.</para>1048</entry>1049</row></tbody></tgroup></informaltable>1050<para>SYNOPSIS1051</para>1052<informaltable><tgroup cols="1"><tbody><row><entry1053align="char">1054<para>int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER);</para>1055</entry>1056</row></tbody></tgroup></informaltable>1057<para>PARAMETERS1058</para>1059<informaltable><tgroup cols="2"><tbody><row><entry1060align="char">1061<para>int fd</para>1062</entry><entry1063align="char">1064<para>File descriptor returned by a previous call to open().</para>1065</entry>1066</row><row><entry1067align="char">1068<para>int request</para>1069</entry><entry1070align="char">1071<para>Equals AUDIO_CLEAR_BUFFER for this command.</para>1072</entry>1073</row></tbody></tgroup></informaltable>1074<para>ERRORS1075</para>1076<informaltable><tgroup cols="2"><tbody><row><entry1077align="char">1078<para>EBADF</para>1079</entry><entry1080align="char">1081<para>fd is not a valid open file descriptor.</para>1082</entry>1083</row><row><entry1084align="char">1085<para>EINTERNAL</para>1086</entry><entry1087align="char">1088<para>Internal error.</para>1089</entry>1090</row></tbody></tgroup></informaltable>10911092</section><section1093role="subsection"><title>AUDIO_SET_ID</title>1094<para>DESCRIPTION1095</para>1096<informaltable><tgroup cols="1"><tbody><row><entry1097align="char">1098<para>This ioctl selects which sub-stream is to be decoded if a program or system1099stream is sent to the video device. If no audio stream type is set the id has to be1100in [0xC0,0xDF] for MPEG sound, in [0x80,0x87] for AC3 and in [0xA0,0xA7]1101for LPCM. More specifications may follow for other stream types. If the stream1102type is set the id just specifies the substream id of the audio stream and only1103the first 5 bits are recognized.</para>1104</entry>1105</row></tbody></tgroup></informaltable>1106<para>SYNOPSIS1107</para>1108<informaltable><tgroup cols="1"><tbody><row><entry1109align="char">1110<para>int ioctl(int fd, int request = AUDIO_SET_ID, int1111id);</para>1112</entry>1113</row></tbody></tgroup></informaltable>1114<para>PARAMETERS1115</para>1116<informaltable><tgroup cols="2"><tbody><row><entry1117align="char">1118<para>int fd</para>1119</entry><entry1120align="char">1121<para>File descriptor returned by a previous call to open().</para>1122</entry>1123</row><row><entry1124align="char">1125<para>int request</para>1126</entry><entry1127align="char">1128<para>Equals AUDIO_SET_ID for this command.</para>1129</entry>1130</row><row><entry1131align="char">1132<para>int id</para>1133</entry><entry1134align="char">1135<para>audio sub-stream id</para>1136</entry>1137</row></tbody></tgroup></informaltable>1138<para>ERRORS1139</para>1140<informaltable><tgroup cols="2"><tbody><row><entry1141align="char">1142<para>EBADF</para>1143</entry><entry1144align="char">1145<para>fd is not a valid open file descriptor.</para>1146</entry>1147</row><row><entry1148align="char">1149<para>EINTERNAL</para>1150</entry><entry1151align="char">1152<para>Internal error.</para>1153</entry>1154</row><row><entry1155align="char">1156<para>EINVAL</para>1157</entry><entry1158align="char">1159<para>Invalid sub-stream id.</para>1160</entry>1161</row></tbody></tgroup></informaltable>11621163</section><section1164role="subsection"><title>AUDIO_SET_MIXER</title>1165<para>DESCRIPTION1166</para>1167<informaltable><tgroup cols="1"><tbody><row><entry1168align="char">1169<para>This ioctl lets you adjust the mixer settings of the audio decoder.</para>1170</entry>1171</row></tbody></tgroup></informaltable>1172<para>SYNOPSIS1173</para>1174<informaltable><tgroup cols="1"><tbody><row><entry1175align="char">1176<para>int ioctl(int fd, int request = AUDIO_SET_MIXER,1177audio_mixer_t ⋆mix);</para>1178</entry>1179</row></tbody></tgroup></informaltable>1180<para>PARAMETERS1181</para>1182<informaltable><tgroup cols="2"><tbody><row><entry1183align="char">1184<para>int fd</para>1185</entry><entry1186align="char">1187<para>File descriptor returned by a previous call to open().</para>1188</entry>1189</row><row><entry1190align="char">1191<para>int request</para>1192</entry><entry1193align="char">1194<para>Equals AUDIO_SET_ID for this command.</para>1195</entry>1196</row><row><entry1197align="char">1198<para>audio_mixer_t *mix</para>1199</entry><entry1200align="char">1201<para>mixer settings.</para>1202</entry>1203</row></tbody></tgroup></informaltable>1204<para>ERRORS1205</para>1206<informaltable><tgroup cols="2"><tbody><row><entry1207align="char">1208<para>EBADF</para>1209</entry><entry1210align="char">1211<para>fd is not a valid open file descriptor.</para>1212</entry>1213</row><row><entry1214align="char">1215<para>EINTERNAL</para>1216</entry><entry1217align="char">1218<para>Internal error.</para>1219</entry>1220</row><row><entry1221align="char">1222<para>EFAULT</para>1223</entry><entry1224align="char">1225<para>mix points to an invalid address.</para>1226</entry>1227</row></tbody></tgroup></informaltable>12281229</section><section1230role="subsection"><title>AUDIO_SET_STREAMTYPE</title>1231<para>DESCRIPTION1232</para>1233<informaltable><tgroup cols="1"><tbody><row><entry1234align="char">1235<para>This ioctl tells the driver which kind of audio stream to expect. This is useful1236if the stream offers several audio sub-streams like LPCM and AC3.</para>1237</entry>1238</row></tbody></tgroup></informaltable>1239<para>SYNOPSIS1240</para>1241<informaltable><tgroup cols="1"><tbody><row><entry1242align="char">1243<para>int ioctl(fd, int request = AUDIO_SET_STREAMTYPE,1244int type);</para>1245</entry>1246</row></tbody></tgroup></informaltable>1247<para>PARAMETERS1248</para>1249<informaltable><tgroup cols="2"><tbody><row><entry1250align="char">1251<para>int fd</para>1252</entry><entry1253align="char">1254<para>File descriptor returned by a previous call to open().</para>1255</entry>1256</row><row><entry1257align="char">1258<para>int request</para>1259</entry><entry1260align="char">1261<para>Equals AUDIO_SET_STREAMTYPE for this1262command.</para>1263</entry>1264</row><row><entry1265align="char">1266<para>int type</para>1267</entry><entry1268align="char">1269<para>stream type</para>1270</entry>1271</row></tbody></tgroup></informaltable>1272<para>ERRORS1273</para>1274<informaltable><tgroup cols="2"><tbody><row><entry1275align="char">1276<para>EBADF</para>1277</entry><entry1278align="char">1279<para>fd is not a valid open file descriptor</para>1280</entry>1281</row><row><entry1282align="char">1283<para>EINVAL</para>1284</entry><entry1285align="char">1286<para>type is not a valid or supported stream type.</para>1287</entry>1288</row></tbody></tgroup></informaltable>12891290</section><section1291role="subsection"><title>AUDIO_SET_EXT_ID</title>1292<para>DESCRIPTION1293</para>1294<informaltable><tgroup cols="1"><tbody><row><entry1295align="char">1296<para>This ioctl can be used to set the extension id for MPEG streams in DVD1297playback. Only the first 3 bits are recognized.</para>1298</entry>1299</row></tbody></tgroup></informaltable>1300<para>SYNOPSIS1301</para>1302<informaltable><tgroup cols="1"><tbody><row><entry1303align="char">1304<para>int ioctl(fd, int request = AUDIO_SET_EXT_ID, int1305id);</para>1306</entry>1307</row></tbody></tgroup></informaltable>1308<para>PARAMETERS1309</para>1310<informaltable><tgroup cols="2"><tbody><row><entry1311align="char">1312<para>int fd</para>1313</entry><entry1314align="char">1315<para>File descriptor returned by a previous call to open().</para>1316</entry>1317</row><row><entry1318align="char">1319<para>int request</para>1320</entry><entry1321align="char">1322<para>Equals AUDIO_SET_EXT_ID for this command.</para>1323</entry>1324</row><row><entry1325align="char">1326<para>int id</para>1327</entry><entry1328align="char">1329<para>audio sub_stream_id</para>1330</entry>1331</row></tbody></tgroup></informaltable>1332<para>ERRORS1333</para>1334<informaltable><tgroup cols="2"><tbody><row><entry1335align="char">1336<para>EBADF</para>1337</entry><entry1338align="char">1339<para>fd is not a valid open file descriptor</para>1340</entry>1341</row><row><entry1342align="char">1343<para>EINVAL</para>1344</entry><entry1345align="char">1346<para>id is not a valid id.</para>1347</entry>1348</row></tbody></tgroup></informaltable>13491350</section><section1351role="subsection"><title>AUDIO_SET_ATTRIBUTES</title>1352<para>DESCRIPTION1353</para>1354<informaltable><tgroup cols="1"><tbody><row><entry1355align="char">1356<para>This ioctl is intended for DVD playback and allows you to set certain1357information about the audio stream.</para>1358</entry>1359</row></tbody></tgroup></informaltable>1360<para>SYNOPSIS1361</para>1362<informaltable><tgroup cols="1"><tbody><row><entry1363align="char">1364<para>int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES,1365audio_attributes_t attr );</para>1366</entry>1367</row></tbody></tgroup></informaltable>1368<para>PARAMETERS1369</para>1370<informaltable><tgroup cols="2"><tbody><row><entry1371align="char">1372<para>int fd</para>1373</entry><entry1374align="char">1375<para>File descriptor returned by a previous call to open().</para>1376</entry>1377</row><row><entry1378align="char">1379<para>int request</para>1380</entry><entry1381align="char">1382<para>Equals AUDIO_SET_ATTRIBUTES for this command.</para>1383</entry>1384</row><row><entry1385align="char">1386<para>audio_attributes_t1387attr</para>1388</entry><entry1389align="char">1390<para>audio attributes according to section ??</para>1391</entry>1392</row></tbody></tgroup></informaltable>1393<para>ERRORS1394</para>1395<informaltable><tgroup cols="2"><tbody><row><entry1396align="char">1397<para>EBADF</para>1398</entry><entry1399align="char">1400<para>fd is not a valid open file descriptor</para>1401</entry>1402</row><row><entry1403align="char">1404<para>EINVAL</para>1405</entry><entry1406align="char">1407<para>attr is not a valid or supported attribute setting.</para>1408</entry>1409</row></tbody></tgroup></informaltable>14101411</section><section1412role="subsection"><title>AUDIO_SET_KARAOKE</title>1413<para>DESCRIPTION1414</para>1415<informaltable><tgroup cols="1"><tbody><row><entry1416align="char">1417<para>This ioctl allows one to set the mixer settings for a karaoke DVD.</para>1418</entry>1419</row></tbody></tgroup></informaltable>1420<para>SYNOPSIS1421</para>1422<informaltable><tgroup cols="1"><tbody><row><entry1423align="char">1424<para>int ioctl(fd, int request = AUDIO_SET_STREAMTYPE,1425audio_karaoke_t ⋆karaoke);</para>1426</entry>1427</row></tbody></tgroup></informaltable>1428<para>PARAMETERS1429</para>1430<informaltable><tgroup cols="2"><tbody><row><entry1431align="char">1432<para>int fd</para>1433</entry><entry1434align="char">1435<para>File descriptor returned by a previous call to open().</para>1436</entry>1437</row><row><entry1438align="char">1439<para>int request</para>1440</entry><entry1441align="char">1442<para>Equals AUDIO_SET_STREAMTYPE for this1443command.</para>1444</entry>1445</row><row><entry1446align="char">1447<para>audio_karaoke_t1448*karaoke</para>1449</entry><entry1450align="char">1451<para>karaoke settings according to section ??.</para>1452</entry>1453</row></tbody></tgroup></informaltable>1454<para>ERRORS1455</para>1456<informaltable><tgroup cols="2"><tbody><row><entry1457align="char">1458<para>EBADF</para>1459</entry><entry1460align="char">1461<para>fd is not a valid open file descriptor</para>1462</entry>1463</row><row><entry1464align="char">1465<para>EINVAL</para>1466</entry><entry1467align="char">1468<para>karaoke is not a valid or supported karaoke setting.</para>1469</entry>1470</row></tbody></tgroup></informaltable>1471</section>1472</section>147314741475