Skip to content

Commit a0a39b3

Browse files
braindigitalisbraindigitalis
committed
more sound docs
1 parent be4d7e9 commit a0a39b3

3 files changed

Lines changed: 86 additions & 19 deletions

File tree

‎docpages/basic-language-reference/BASIC_SOUND.md‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,25 @@ Retro Rocket’s audio system has five main parts:
1111
The driver is the low-level hardware backend (e.g. `MODLOAD "ac97"`).
1212
It is specific to your sound card in your PC. Without a driver, **no audio commands will work**.
1313

14+
Currently supported sound cards:
15+
16+
| Device | Description | Command |
17+
|--------|----------------------------------------------------|------------------|
18+
| AC'97 | Audio Codec ’97; legacy PCI audio standard | `MODLOAD "ac97"` |
19+
| HDA | High Definition Audio; Azalia (successor to AC’97) | `MODLOAD "hda"` |
20+
1421
### Codecs
1522

1623
A codec is a small specialised program that knows how to **decode audio files** into the raw data format used by Retro Rocket.
1724
Codecs are provided as kernel modules, just like drivers, and must be loaded before you can use them.
1825

19-
* WAV support is built in and always available.
20-
* MP3 support is available via the `mp3.ko` module (`MODLOAD "mp3"`).
21-
* FLAC support is available via the `flac.ko` module (`MODLOAD "flac"`).
22-
* OGG Vorbis support is available via the `ogg.ko` module (`MODLOAD "ogg"`)
23-
* MOD support is available via the `mod.ko` module (`MODLOAD "mod"`)
26+
| Format | Description | Command |
27+
|--------|-----------------------------------------------------|------------------------|
28+
| WAV | Uncompressed PCM; built-in and always available | *(no module required)* |
29+
| MP3 | MPEG-1 Layer III compressed audio | `MODLOAD "mp3"` |
30+
| FLAC | Free Lossless Audio Codec | `MODLOAD "flac"` |
31+
| OGG | Ogg Vorbis compressed audio | `MODLOAD "ogg"` |
32+
| MOD | Amiga-style tracker modules (ProTracker, etc.) | `MODLOAD "mod"` |
2433

2534
If you try to load any file type except WAV without first loading the corresponding codec module, you will receive an error as the file type will be unrecognised.
2635

‎docs/audio-basics.html‎

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,16 +102,32 @@ <h3 class="doxsection"><a class="anchor" id="drivers"></a>
102102
Drivers</h3>
103103
<p>The driver is the low-level hardware backend (e.g. <span class="tt">MODLOAD "ac97"</span>). <br />
104104
It is specific to your sound card in your PC. Without a driver, <b>no audio commands will work</b>.</p>
105+
<p>Currently supported sound cards:</p>
106+
<table class="markdownTable">
107+
<tr class="markdownTableHead">
108+
<th class="markdownTableHeadNone">Device </th><th class="markdownTableHeadNone">Description </th><th class="markdownTableHeadNone">Command </th></tr>
109+
<tr class="markdownTableRowOdd">
110+
<td class="markdownTableBodyNone">AC'97 </td><td class="markdownTableBodyNone">Audio Codec ’97; legacy PCI audio standard </td><td class="markdownTableBodyNone"><span class="tt">MODLOAD "ac97"</span> </td></tr>
111+
<tr class="markdownTableRowEven">
112+
<td class="markdownTableBodyNone">HDA </td><td class="markdownTableBodyNone">High Definition Audio; Azalia (successor to AC’97) </td><td class="markdownTableBodyNone"><span class="tt">MODLOAD "hda"</span> </td></tr>
113+
</table>
105114
<h3 class="doxsection"><a class="anchor" id="codecs"></a>
106115
Codecs</h3>
107116
<p>A codec is a small specialised program that knows how to <b>decode audio files</b> into the raw data format used by Retro Rocket. Codecs are provided as kernel modules, just like drivers, and must be loaded before you can use them.</p>
108-
<ul>
109-
<li>WAV support is built in and always available.</li>
110-
<li>MP3 support is available via the <span class="tt">mp3.ko</span> module (<span class="tt">MODLOAD "mp3"</span>).</li>
111-
<li>FLAC support is available via the <span class="tt">flac.ko</span> module (<span class="tt">MODLOAD "flac"</span>).</li>
112-
<li>OGG Vorbis support is available via the <span class="tt">ogg.ko</span> module (<span class="tt">MODLOAD "ogg"</span>)</li>
113-
<li>MOD support is available via the <span class="tt">mod.ko</span> module (<span class="tt">MODLOAD "mod"</span>)</li>
114-
</ul>
117+
<table class="markdownTable">
118+
<tr class="markdownTableHead">
119+
<th class="markdownTableHeadNone">Format </th><th class="markdownTableHeadNone">Description </th><th class="markdownTableHeadNone">Command </th></tr>
120+
<tr class="markdownTableRowOdd">
121+
<td class="markdownTableBodyNone">WAV </td><td class="markdownTableBodyNone">Uncompressed PCM; built-in and always available </td><td class="markdownTableBodyNone"><em>(no module required)</em> </td></tr>
122+
<tr class="markdownTableRowEven">
123+
<td class="markdownTableBodyNone">MP3 </td><td class="markdownTableBodyNone">MPEG-1 Layer III compressed audio </td><td class="markdownTableBodyNone"><span class="tt">MODLOAD "mp3"</span> </td></tr>
124+
<tr class="markdownTableRowOdd">
125+
<td class="markdownTableBodyNone">FLAC </td><td class="markdownTableBodyNone">Free Lossless Audio Codec </td><td class="markdownTableBodyNone"><span class="tt">MODLOAD "flac"</span> </td></tr>
126+
<tr class="markdownTableRowEven">
127+
<td class="markdownTableBodyNone">OGG </td><td class="markdownTableBodyNone">Ogg Vorbis compressed audio </td><td class="markdownTableBodyNone"><span class="tt">MODLOAD "ogg"</span> </td></tr>
128+
<tr class="markdownTableRowOdd">
129+
<td class="markdownTableBodyNone">MOD </td><td class="markdownTableBodyNone">Amiga-style tracker modules (ProTracker, etc.) </td><td class="markdownTableBodyNone"><span class="tt">MODLOAD "mod"</span> </td></tr>
130+
</table>
115131
<p>If you try to load any file type except WAV without first loading the corresponding codec module, you will receive an error as the file type will be unrecognised.</p>
116132
<h3 class="doxsection"><a class="anchor" id="streams"></a>
117133
Streams</h3>

‎docs/xml/audio-basics.xml‎

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,58 @@
1111
<sect3 id="audio-basics_1drivers">
1212
<title>Drivers</title><para>The driver is the low-level hardware backend (e.g. <computeroutput>MODLOAD &quot;ac97&quot;</computeroutput>). <linebreak/>
1313
It is specific to your sound card in your PC. Without a driver, <bold>no audio commands will work</bold>.</para>
14+
<para>Currently supported sound cards:</para>
15+
<para><table rows="3" cols="3"><row>
16+
<entry thead="yes"><para>Device </para>
17+
</entry><entry thead="yes"><para>Description </para>
18+
</entry><entry thead="yes"><para>Command </para>
19+
</entry></row>
20+
<row>
21+
<entry thead="no"><para>AC&apos;97 </para>
22+
</entry><entry thead="no"><para>Audio Codec ’97; legacy PCI audio standard </para>
23+
</entry><entry thead="no"><para><computeroutput>MODLOAD &quot;ac97&quot;</computeroutput> </para>
24+
</entry></row>
25+
<row>
26+
<entry thead="no"><para>HDA </para>
27+
</entry><entry thead="no"><para>High Definition Audio; Azalia (successor to AC’97) </para>
28+
</entry><entry thead="no"><para><computeroutput>MODLOAD &quot;hda&quot;</computeroutput> </para>
29+
</entry></row>
30+
</table>
31+
</para>
1432
</sect3>
1533
<sect3 id="audio-basics_1codecs">
1634
<title>Codecs</title><para>A codec is a small specialised program that knows how to <bold>decode audio files</bold> into the raw data format used by Retro Rocket. Codecs are provided as kernel modules, just like drivers, and must be loaded before you can use them.</para>
17-
<para><itemizedlist>
18-
<listitem><para>WAV support is built in and always available.</para>
19-
</listitem><listitem><para>MP3 support is available via the <computeroutput>mp3.ko</computeroutput> module (<computeroutput>MODLOAD &quot;mp3&quot;</computeroutput>).</para>
20-
</listitem><listitem><para>FLAC support is available via the <computeroutput>flac.ko</computeroutput> module (<computeroutput>MODLOAD &quot;flac&quot;</computeroutput>).</para>
21-
</listitem><listitem><para>OGG Vorbis support is available via the <computeroutput>ogg.ko</computeroutput> module (<computeroutput>MODLOAD &quot;ogg&quot;</computeroutput>)</para>
22-
</listitem><listitem><para>MOD support is available via the <computeroutput>mod.ko</computeroutput> module (<computeroutput>MODLOAD &quot;mod&quot;</computeroutput>)</para>
23-
</listitem></itemizedlist>
35+
<para><table rows="6" cols="3"><row>
36+
<entry thead="yes"><para>Format </para>
37+
</entry><entry thead="yes"><para>Description </para>
38+
</entry><entry thead="yes"><para>Command </para>
39+
</entry></row>
40+
<row>
41+
<entry thead="no"><para>WAV </para>
42+
</entry><entry thead="no"><para>Uncompressed PCM; built-in and always available </para>
43+
</entry><entry thead="no"><para><emphasis>(no module required)</emphasis> </para>
44+
</entry></row>
45+
<row>
46+
<entry thead="no"><para>MP3 </para>
47+
</entry><entry thead="no"><para>MPEG-1 Layer III compressed audio </para>
48+
</entry><entry thead="no"><para><computeroutput>MODLOAD &quot;mp3&quot;</computeroutput> </para>
49+
</entry></row>
50+
<row>
51+
<entry thead="no"><para>FLAC </para>
52+
</entry><entry thead="no"><para>Free Lossless Audio Codec </para>
53+
</entry><entry thead="no"><para><computeroutput>MODLOAD &quot;flac&quot;</computeroutput> </para>
54+
</entry></row>
55+
<row>
56+
<entry thead="no"><para>OGG </para>
57+
</entry><entry thead="no"><para>Ogg Vorbis compressed audio </para>
58+
</entry><entry thead="no"><para><computeroutput>MODLOAD &quot;ogg&quot;</computeroutput> </para>
59+
</entry></row>
60+
<row>
61+
<entry thead="no"><para>MOD </para>
62+
</entry><entry thead="no"><para>Amiga-style tracker modules (ProTracker, etc.) </para>
63+
</entry><entry thead="no"><para><computeroutput>MODLOAD &quot;mod&quot;</computeroutput> </para>
64+
</entry></row>
65+
</table>
2466
</para>
2567
<para>If you try to load any file type except WAV without first loading the corresponding codec module, you will receive an error as the file type will be unrecognised.</para>
2668
</sect3>

0 commit comments

Comments
 (0)