/[gentoo]/xml/htdocs/doc/en/alsa-guide.xml
Gentoo

Contents of /xml/htdocs/doc/en/alsa-guide.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.49 - (hide annotations) (download) (as text)
Sun Mar 6 12:27:59 2005 UTC (9 years, 9 months ago) by swift
Branch: MAIN
Changes since 1.48: +4 -4 lines
File MIME type: application/xml
#83665 - Fix OSS compatibility issue

1 cam 1.42 <?xml version="1.0" encoding="UTF-8"?>
2 swift 1.49 <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/alsa-guide.xml,v 1.48 2005/02/05 14:16:29 swift Exp $ -->
3 drobbins 1.1 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4    
5 cam 1.42 <guide link="/doc/en/alsa-guide.xml">
6 drobbins 1.1 <title>Gentoo Linux ALSA Guide</title>
7 swift 1.20 <author title="Author">
8     <mail link="zu@pandora.be">Vincent Verleye</mail>
9 drobbins 1.1 </author>
10 swift 1.20 <author title="Author">
11     <mail link="g2boojum@gentoo.org">Grant Goodyear</mail>
12 peesh 1.10 </author>
13 swift 1.20 <author title="Author">
14     <mail link="agenkin@gentoo.org">Arcady Genkin</mail>
15 peesh 1.10 </author>
16 erwin 1.26 <author title="Author">
17     <mail link="eradicator@gentoo.org">Jeremy Huddleston</mail>
18     </author>
19 swift 1.18 <author title="Editor"><!-- zhen@gentoo.org -->
20 cam 1.42 John P. Davis
21 drobbins 1.1 </author>
22 swift 1.20 <author title="Editor">
23     <mail link="swift@gentoo.org">Sven Vermeulen</mail>
24 swift 1.12 </author>
25 swift 1.20 <author title="Editor">
26     <mail link="bennyc@gentoo.org">Benny Chuang</mail>
27 bennyc 1.14 </author>
28 swift 1.20 <author title="Editor">
29     <mail link="blubber@gentoo.org">Tiemo Kieft</mail>
30 blubber 1.16 </author>
31 erwin 1.26 <author title="Editor">
32     <mail link="erwin@gentoo.org">Erwin</mail>
33     </author>
34 drobbins 1.1
35     <abstract>
36 cam 1.42 This guide will show you how to set up the Advanced Linux Sound Architecture
37     (ALSA) on Gentoo Linux. In addition to the Gentoo Linux Desktop Configuration
38 swift 1.20 Guide, this guide is supposed to give you more information on this subject.
39     </abstract>
40 drobbins 1.1
41 swift 1.25 <license/>
42    
43 swift 1.49 <version>1.5.11</version>
44     <date>2005-03-06</date>
45 drobbins 1.1
46     <chapter>
47 swift 1.35 <title>The Advanced Linux Sound Architecture</title>
48 drobbins 1.1 <section>
49 swift 1.20 <title>What is ALSA?</title>
50 drobbins 1.1 <body>
51 swift 1.20
52 drobbins 1.1 <p>
53 swift 1.35 ALSA is the <e>Advanced Linux Sound Architecture</e>, a project dedicated to the
54     development of a high-quality Linux sound subsystem. It has replaced OSS
55     (<e>Open Sound System</e>) as default sound subsystem in the 2.6 kernel series.
56 drobbins 1.1 </p>
57    
58     <p>
59 swift 1.35 ALSA provides efficient support for all types of audio interfaces, is fully
60     modularized, is SMP and thread-safe and provides a high-quality user space
61     library called <e>alsa-lib</e> to simplify application programming. It also
62     provides a backwards compatibility layer with OSS.
63 drobbins 1.1 </p>
64 swift 1.20
65 drobbins 1.1 </body>
66     </section>
67     </chapter>
68     <chapter>
69 swift 1.35 <title>Installing ALSA</title>
70 drobbins 1.1 <section>
71 swift 1.35 <title>USE Flags</title>
72 swift 1.17 <body>
73    
74     <p>
75 swift 1.35 Gentoo provides an <c>alsa</c> USE flag which you should set in
76 cam 1.42 <path>/etc/make.conf</path> to allow our available packages to compile with
77 swift 1.35 ALSA support. If you have <c>oss</c> in your USE variable as well, ALSA will
78     compile with OSS backward compatibility.
79 swift 1.17 </p>
80    
81     </body>
82     </section>
83     <section>
84 swift 1.35 <title>Kernel Modules</title>
85 drobbins 1.1 <body>
86 swift 1.20
87 drobbins 1.1 <p>
88 swift 1.35 First of all, before continuing, make sure your kernel has <e>Sound Card
89     Support</e> enabled. If you used <c>genkernel</c> to build your kernel, then
90 neysx 1.46 this is automatically true. Otherwise reconfigure your kernel. Additionally,
91     make sure you disable <e>Open Sound System</e> in your kernel configuration.
92     If you don't, your system may try to use these drivers rather than the alsa
93     ones. If you see a message about 'sound card not detected' and you are sure
94     you have the correct driver, this is probably the reason.
95 drobbins 1.1 </p>
96 swift 1.20
97 dertobi123 1.45 <warn>
98 neysx 1.46 If you use a 2.6 kernel, you may use the drivers provided in the kernel, but
99     we still recommend that you use media-sound/alsa-driver as they are more up
100     to date than what is provided in the kernel tree. If you still wish to use
101     the drivers provided with your kernel, you can skip the rest of this section
102     and continue with <uri link="#alsa-utils">Installing the ALSA Utils</uri>.
103 dertobi123 1.45 </warn>
104 swift 1.20
105     <p>
106 neysx 1.46 The first step in installing your sound drivers is figuring out what sound
107     card you have. If you don't already know, an easy trick is to search
108     for "audio" in the output of the <c>lspci</c> command. You can install
109     this tool with <c>emerge pciutils</c>.
110 drobbins 1.1 </p>
111 swift 1.20
112 swift 1.35 <pre caption="Finding out the soundcard type">
113 neysx 1.40 # <i>lspci | grep -i audio</i>
114     Multimedia audio controller: VIA Technologies, Inc. VT82C686 AC97 Audio Controller (rev 64).
115 drobbins 1.1 </pre>
116 swift 1.20
117 drobbins 1.1 <p>
118 swift 1.35 Now go to the <uri link="http://www.alsa-project.org/alsa-doc">ALSA Soundcard
119     Matrix</uri> and search for your soundcard. In the above example you should go
120     to the "VIA" manufacturer. You will receive a table with the known chipsets of
121     that vendor. The chipset in the above example is "via82c686"; the "Details" link
122 swift 1.41 then informs me that the driver is called <path>via82xx</path>. This is all the
123     information you need, so you can safely discard the rest of that document.
124 drobbins 1.1 </p>
125 swift 1.20
126 swift 1.35 <p>
127     Based on this information we can now install the <c>alsa-driver</c> for our
128     soundcard. First edit <path>/etc/make.conf</path> and <e>add</e> a new option
129     called ALSA_CARDS to it. Inside this variable you declare the soundcard driver
130     you want to use:
131     </p>
132 swift 1.20
133 swift 1.35 <pre caption="Editing /etc/make.conf for ALSA_CARDS">
134     ALSA_CARDS="via82xx"
135 erwin 1.26 </pre>
136    
137 neysx 1.46 <warn>
138     If you have multiple sound cards in your system, separate them with a comma
139     in the ALSA_CARDS variable. Ex: ALSA_CARDS="via82xx,emu10k1"
140     </warn>
141    
142 erwin 1.26 <p>
143 neysx 1.46 If you want OSS compatibility (highly recommended), you should add 'oss' to
144     your USE flags in <path>/etc/make.conf</path>. After that, you are ready to
145     install <c>alsa-driver</c>:
146 erwin 1.26 </p>
147    
148 swift 1.35 <pre caption="Installing ALSA Drivers">
149     # <i>emerge alsa-driver</i>
150     </pre>
151 swift 1.20
152 drobbins 1.1 <impo>
153 swift 1.35 Whenever you (re)compile your kernel sources, chances are that the ALSA drivers
154 neysx 1.46 will be deleted. It is therefore adviseable to rerun <c>emerge alsa-driver</c>
155     every time you (re)compile your kernel. Note that this will compile the
156     drivers for the kernel in /usr/src/linux, NOT the running kernel.
157 drobbins 1.1 </impo>
158 swift 1.20
159 drobbins 1.1 </body>
160     </section>
161 swift 1.35 <section id="alsa-utils">
162     <title>Installing the ALSA Utils</title>
163 drobbins 1.1 <body>
164    
165     <p>
166 neysx 1.46 If the in-kernel OSS compatibility is not sufficient for your needs, you will
167     want to install <c>alsa-oss</c>. This will provide you with the 'aoss'
168     executable which can be used as demonstrated:
169 drobbins 1.1 </p>
170 swift 1.20
171 neysx 1.46 <pre caption="More OSS compatibility layer">
172 swift 1.35 # <i>emerge alsa-oss</i>
173 neysx 1.46 # <i>aoss mpg123 music.mp3</i>
174 blubber 1.16 </pre>
175    
176 drobbins 1.1 <p>
177 swift 1.35 Now install the ALSA Utils on your system (this is mandatory):
178 drobbins 1.1 </p>
179 swift 1.20
180 swift 1.35 <pre caption="Installing ALSA Utils">
181     # <i>emerge alsa-utils</i>
182 drobbins 1.1 </pre>
183 swift 1.20
184 drobbins 1.1 <p>
185 swift 1.35 Now that the utils are installed, it is time to configure ALSA...
186 drobbins 1.1 </p>
187 swift 1.20
188 drobbins 1.1 </body>
189     </section>
190 swift 1.35 </chapter>
191     <chapter>
192     <title>Configuring ALSA</title>
193 drobbins 1.1 <section>
194 swift 1.35 <title>Automatically Loading the Kernel Modules</title>
195 drobbins 1.1 <body>
196 swift 1.20
197 drobbins 1.1 <p>
198 swift 1.35 If you use a modular kernel (such as when using <c>genkernel</c>) you have to
199 neysx 1.46 edit <path>/etc/modules.d/alsa</path> so that it activates the necessary
200     modules at boot time. For the soundcard in our example:
201 drobbins 1.1 </p>
202 swift 1.12
203 swift 1.35 <pre caption="/etc/modules.d/alsa">
204     alias snd-card-0 snd-via82xx
205     <comment># The following is only needed when you want OSS compatibility</comment>
206 swift 1.49 alias sound-slot-0 snd-via82xx
207 drobbins 1.1 alias /dev/mixer snd-mixer-oss
208     alias /dev/dsp snd-pcm-oss
209     alias /dev/midi snd-seq-oss
210     </pre>
211 swift 1.20
212 drobbins 1.1 <p>
213 swift 1.35 Now run <c>modules-update</c> to save the changes you made to the
214     <path>alsa</path> file into <path>/etc/modules.conf</path>:
215 swift 1.20 </p>
216    
217     <pre caption="Running modules-update">
218 bennyc 1.14 # <i>modules-update</i>
219 drobbins 1.1 </pre>
220 swift 1.20
221 swift 1.35 </body>
222     </section>
223     <section>
224     <title>Verifying the Device Files</title>
225     <body>
226 swift 1.20
227 drobbins 1.1 <p>
228 neysx 1.46 This should be done automatically for you on recent installs, but if you run
229     into problems, check that your ALSA devices and permissions are set correctly
230     by your /dev manager. If you use DevFS, check <path>/etc/devfsd.conf</path>
231 drobbins 1.1 </p>
232 swift 1.20
233 seo 1.8 <pre caption="/etc/devfsd.conf">
234 drobbins 1.1 # ALSA/OSS stuff
235     # Comment/change these if you want to change the permissions on
236     # the audio devices
237     LOOKUP snd MODLOAD ACTION snd
238     LOOKUP dsp MODLOAD
239     LOOKUP mixer MODLOAD
240     LOOKUP midi MODLOAD
241     REGISTER sound/.* PERMISSIONS root.audio 660
242     REGISTER snd/.* PERMISSIONS root.audio 660
243     </pre>
244 swift 1.20
245 drobbins 1.1 </body>
246     </section>
247     <section>
248 swift 1.35 <title>Having ALSA Activated at Boot</title>
249 drobbins 1.1 <body>
250 swift 1.20
251 drobbins 1.1 <p>
252 swift 1.35 To activate ALSA support at boot, add the <c>alsasound</c> init script to the
253     boot runlevel:
254 swift 1.20 </p>
255    
256 swift 1.35 <pre caption="Adding alsasound to the boot runlevel">
257 blubber 1.16 # <i>rc-update add alsasound boot</i>
258 swift 1.35 # <i>/etc/init.d/alsasound start</i>
259 drobbins 1.1 </pre>
260 swift 1.20
261 drobbins 1.1 </body>
262     </section>
263     <section>
264 swift 1.35 <title>Unmute the Channels</title>
265 drobbins 1.1 <body>
266 swift 1.20
267 drobbins 1.1 <p>
268 swift 1.35 By default, all sound channels are muted. To fix this, run <c>amixer</c>:
269 drobbins 1.1 </p>
270 swift 1.20
271 swift 1.35 <pre caption="Running amixer">
272     # <i>amixer</i>
273 drobbins 1.1 </pre>
274 swift 1.20
275 drobbins 1.1 <p>
276 swift 1.35 If <c>amixer</c> produces lots of output then you're ready to unmute the
277     channels. If you receive an error, doublecheck that your soundcard module is
278     started.
279 drobbins 1.1 </p>
280 swift 1.20
281 drobbins 1.1 <p>
282 swift 1.35 Now unmute the <e>Master</e> and <e>PCM</e> channels. If this isn't sufficient,
283     also unmute the <e>Center</e> and <e>Surround</e> channels.
284 drobbins 1.1 </p>
285 swift 1.20
286 swift 1.35 <pre caption="Unmuting the sound channels">
287 cam 1.47 <comment>(If you prefer an ncurses method:)</comment>
288    
289 neysx 1.46 # <i>alsamixer</i>
290    
291 cam 1.47 <comment>(or)</comment>
292 neysx 1.46
293 swift 1.48 # <i>amixer set Master 100% unmute</i>
294     # <i>amixer set PCM 100% unmute</i>
295 swift 1.35 <comment>(Only if the above isn't sufficient:)</comment>
296 swift 1.48 # <i>amixer set Center 100% unmute</i>
297     # <i>amixer set Surround 100% unmute</i>
298     # <i>amixer set Headphone 100% unmute</i>
299 drobbins 1.1 </pre>
300 swift 1.20
301 neysx 1.46
302 swift 1.20 <p>
303 swift 1.35 To check if your sound works, play a wave file (using <c>aplay</c>), mp3 (using
304     <c>mpg123</c> or even <c>mplayer</c>) or any other sound file for that matter.
305 drobbins 1.1 </p>
306 swift 1.20
307 erwin 1.26 </body>
308     </section>
309     </chapter>
310     <chapter>
311 swift 1.35 <title>Activating MIDI Support</title>
312 erwin 1.26 <section>
313 swift 1.35 <title>Installing the Necessary Packages</title>
314 erwin 1.26 <body>
315    
316     <p>
317 swift 1.35 Some soundcards come with onboard MIDI synthesizers. To use them, you must first
318     install the <c>awesfx</c> package:
319 erwin 1.26 </p>
320    
321 swift 1.35 <pre caption="Installing the awesfx package">
322 erwin 1.26 # <i>emerge awesfx</i>
323     </pre>
324    
325     <p>
326 swift 1.35 If you have a collection of sound fonts somewhere, place them in
327     <path>/usr/share/sfbank</path>. For instance, the SBLive has a sound font file
328     called <path>8MBGMSFX.SF2</path> or <path>CT4GMSFX.SF2</path>.
329 erwin 1.26 </p>
330    
331     <p>
332 cam 1.39 After copying over the sound font, select them using <c>asfxload</c>:
333 erwin 1.26 </p>
334    
335 swift 1.35 <pre caption="Loading the sound font">
336 cam 1.39 # <i>asfxload /usr/share/sfbank/8MBGMSFX.SF2</i>
337 erwin 1.26 </pre>
338    
339 swift 1.35 <p>
340     You must have this command run every time you boot, so it is adviseable to add
341     it to <path>/etc/conf.d/local.start</path> as well.
342     </p>
343 erwin 1.26
344 swift 1.32 <p>
345     If you can't find soundfonts on your driver CD you can download some online from
346     <uri>http://www.parabola.demon.co.uk/alsa/awe64.html</uri>.
347     </p>
348    
349 erwin 1.26 </body>
350     </section>
351     <section>
352     <title>Timidity++ Virtual Synthesizer</title>
353     <body>
354    
355     <p>
356 swift 1.35 If your sound card does not come with a hardware synthesizer (or you don't want
357     to use it), you can use <c>timidity++</c> to provide you with a virtual
358 erwin 1.26 synthesizer. Start by emerging this package:
359     </p>
360    
361     <pre caption="Installing Timidity++">
362     # <i>emerge timidity++</i>
363     </pre>
364    
365     <p>
366 swift 1.35 For timidity to play sounds, it needs a soundfont. If you do not have any,
367 neysx 1.46 install <c>timidity-eawpatches</c> or <c>timidity-shompatches</c> which will
368     give you some soundfonts. You can have multiple soundfont configurations
369     installed, and you can place your own in <path>/usr/share/timidity/</path>.
370     To switch between different timidity configurations, you should use the
371     <e>timidity-update</e> tool provided in the timidity++ package.
372 cam 1.33 </p>
373    
374 neysx 1.46 <pre caption="Installing soundfonts">
375 cam 1.33 # <i>emerge timidity-eawpatches</i>
376 cam 1.47 # <i>timidity-update -g -s eawpatches</i>
377 neysx 1.46
378 cam 1.47 <comment>(or)</comment>
379 neysx 1.46
380     # <i>emerge timidity-shompatches</i>
381 cam 1.47 # <i>timidity-update -g -s shompatches</i>
382 cam 1.33 </pre>
383    
384     <p>
385 swift 1.35 Don't forget to add <c>timidity</c> to the default runlevel.
386 erwin 1.26 </p>
387    
388 swift 1.35 <pre caption="Adding timidity to the default runlevel">
389 erwin 1.26 # <i>rc-update add timidity default</i>
390     # <i>/etc/init.d/timidity start</i>
391     </pre>
392    
393     </body>
394     </section>
395     <section>
396     <title>Testing MIDI Support</title>
397     <body>
398    
399     <p>
400 cam 1.42 You can use <c>aplaymidi</c> from the ALSA Utils to test your MIDI
401     configuration.
402 swift 1.20 </p>
403    
404 drobbins 1.1 <p>
405 swift 1.35 To see what MIDI output ports are available on your system, use the <c>-l</c>
406     option:
407 erwin 1.26 </p>
408    
409 swift 1.35 <pre caption="Viewing the MIDI output ports">
410 cam 1.42 # <i>aplaymidi -l</i>
411 erwin 1.26 </pre>
412    
413     <p>
414 swift 1.35 If all looks fine, try playing a MIDI file to make sure everything works. With
415 cam 1.42 the <c>-p</c> option you define what MIDI port you want to use.
416 drobbins 1.1 </p>
417 swift 1.20
418 swift 1.35 <pre caption="Playing a MIDI file">
419 cam 1.42 # <i>aplaymidi -p 65:0 "Final Fantasy 7 - Aerith' Theme.mid"</i>
420 erwin 1.26 </pre>
421    
422 drobbins 1.1 </body>
423     </section>
424     </chapter>
425     <chapter>
426 swift 1.35 <title>Final Remarks</title>
427 drobbins 1.1 <section>
428 swift 1.35 <title>Tools and Firmware</title>
429 drobbins 1.1 <body>
430 swift 1.20
431     <p>
432 swift 1.35 Some specific sound cards can benefit from certain tools provided by the
433 cam 1.36 <c>alsa-tools</c> and <c>alsa-firmware</c> packages. If you need
434 swift 1.35 <c>alsa-tools</c>, be sure to define the ALSA_TOOLS variable in
435     <path>/etc/make.conf</path> with the tools you require. For instance:
436 swift 1.20 </p>
437    
438 swift 1.35 <pre caption="Selecting ALSA Tools in /etc/make.conf">
439     ALSA_TOOLS="as10k1 ac3dec"
440 drobbins 1.1 </pre>
441 swift 1.20
442 erwin 1.26 <p>
443 swift 1.35 Then install the <c>alsa-tools</c> (and/or <c>alsa-firmware</c>) package(s):
444 erwin 1.26 </p>
445    
446 swift 1.35 <pre caption="Installing ALSA Tools">
447     # <i>emerge alsa-tools</i>
448 erwin 1.26 </pre>
449    
450     </body>
451     </section>
452     <section>
453 swift 1.21 <title>Activating Joystick Support</title>
454     <body>
455    
456     <p>
457     If your soundcard has a joystick plug, you might be interested in activating
458 bennyc 1.37 joystick support for your soundcard. If so, start by verifying if your soundcard
459 swift 1.21 driver has a joystick parameter. You can verify this by running <c>modinfo</c>
460 swift 1.35 against your kernel module. For instance, for the <c>snd-via82xx</c>:
461 swift 1.21 </p>
462    
463     <pre caption="Running modinfo">
464     # <i>modinfo snd-via82xx</i>
465     filename: /lib/modules/2.4.22-ck2/snd-via82xx.o
466     description: "VIA VT82xx audio"
467     author: "Jaroslav Kysela &lt;perex@suse.cz&gt;"
468     license: "GPL"
469 swift 1.35 parm: index int array (min = 1, max = 8), description "Index value for
470     VIA 82xx bridge."
471     parm: id string array (min = 1, max = 8), description "ID string for VIA
472     82xx bridge."
473     parm: enable int array (min = 1, max = 8), description "Enable audio part
474     of VIA 82xx bridge."
475     parm: mpu_port long array (min = 1, max = 8), description "MPU-401 port.
476     (VT82C686x only)"
477     <i>parm: joystick int array (min = 1, max = 8), description "Enable
478     joystick. (VT82C686x only)"</i>
479 cam 1.42 parm: ac97_clock int array (min = 1, max = 8), description "AC'97 codec
480 swift 1.35 clock (default 48000Hz)."
481 cam 1.42 parm: dxs_support int array (min = 1, max = 8), description "Support for
482     DXS channels (0 = auto, 1 = enable, 2 = disable, 3 = 48k only, 4 =
483 swift 1.35 no VRA)
484 swift 1.21 </pre>
485    
486     <p>
487 swift 1.35 If it has the <c>joystick</c> parameter, append <c>joystick=1</c> to your
488     <c>options</c> line in <path>/etc/modules.d/alsa</path>. For instance:
489 swift 1.21 </p>
490    
491     <pre caption="Adding the joystick parameter">
492     alias snd-card-0 snd-via82xx
493     options snd-via82xx joystick=1
494     </pre>
495 swift 1.17
496     </body>
497     </section>
498 drobbins 1.1 <section>
499 swift 1.35 <title>Resources</title>
500 drobbins 1.1 <body>
501 swift 1.20
502 drobbins 1.1 <ul>
503 swift 1.35 <li><uri link="http://www.alsa-project.org">The ALSA Project</uri></li>
504     <li><uri link="http://www.djcj.org">ALSA Howto's and FAQs</uri></li>
505     <li><uri link="http://linux-sound.org">Linux Sound/MIDI Software</uri></li>
506 drobbins 1.1 </ul>
507 swift 1.20
508 drobbins 1.1 </body>
509     </section>
510     </chapter>
511     </guide>

  ViewVC Help
Powered by ViewVC 1.1.20