Browse Source

Allow ALSA and DSP acronyms from the wiki

pull/2/merge
falkTX 5 years ago
parent
commit
4495c9b0e9
8 changed files with 29 additions and 33 deletions
  1. +13
    -13
      Documentation:Manual:alsa_and_kxstudio.php
  2. +4
    -4
      Documentation:Manual:cadence_introduction.php
  3. +1
    -1
      Documentation:Manual:included_and_recommended_apps.php
  4. +3
    -3
      Documentation:Manual:jack_configuration.php
  5. +4
    -4
      Documentation:Manual:linux_audio_overview.php
  6. +3
    -3
      Documentation:Manual:simple_claudia_studio.php
  7. +1
    -1
      Documentation:Manual:useful_links_and_getting_help.php
  8. +0
    -4
      _manual/create-manual-pages.py

+ 13
- 13
Documentation:Manual:alsa_and_kxstudio.php View File

@@ -9,7 +9,7 @@ include_once("includes/header.php");
<div class="level1">

<p>
The Advanced Linux Sound Architecture is the primary sound system used by Linux. Even those who only plan to use JACK with the FFADO (FireWire) drivers should still have familiarity with ALSA.
The Advanced Linux Sound Architecture is the primary sound system used by Linux. Even those who only plan to use JACK with the FFADO (FireWire) drivers should still have familiarity with <acronym title="Advanced Linux Sound Architecture">ALSA</acronym>.
</p>

</div>
@@ -18,7 +18,7 @@ The Advanced Linux Sound Architecture is the primary sound system used by Linux.
<div class="level2">

<p>
The main ALSA mixer included with KXStudio is called kmix. You can use kmix to adjust audio input and output levels, mute and unmute channels and change other non-FireWire audio device settings such as selecting between SPDIF and analog inputs if your device has such features. The kmix system tray icon looks like this:
The main <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> mixer included with KXStudio is called kmix. You can use kmix to adjust audio input and output levels, mute and unmute channels and change other non-FireWire audio device settings such as selecting between SPDIF and analog inputs if your device has such features. The kmix system tray icon looks like this:
</p>

<p>
@@ -34,7 +34,7 @@ If you have a scrollwheel function on a mouse or trackpad, you can hover over th
</p>

<p>
Here we see the main kmix mixer window. kmix displays the controls for each ALSA device on its own separate tab. In this screenshot the &#039;HDA Intel&#039; onboard audio device is selected.
Here we see the main kmix mixer window. kmix displays the controls for each <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> device on its own separate tab. In this screenshot the &#039;HDA Intel&#039; onboard audio device is selected.
</p>

<p>
@@ -46,7 +46,7 @@ In the bottom right corner of the mixer window there is a tool icon. This icon a
</p>

<p>
Whilst there is a standard defined for USB audio devices, relatively few devices fully comply with it. What this means for ALSA and USB devices is that sometimes you will see no controls under kmix for some USB devices or controls may not function as expected. Such issues may be worked around by inserting an app such as Non mixer or jack_mixer between an audio source and the problematic output device until the issue is fixed within ALSA.
Whilst there is a standard defined for USB audio devices, relatively few devices fully comply with it. What this means for <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> and USB devices is that sometimes you will see no controls under kmix for some USB devices or controls may not function as expected. Such issues may be worked around by inserting an app such as Non mixer or jack_mixer between an audio source and the problematic output device until the issue is fixed within <acronym title="Advanced Linux Sound Architecture">ALSA</acronym>.
</p>

</div>
@@ -55,7 +55,7 @@ Whilst there is a standard defined for USB audio devices, relatively few devices
<div class="level2">

<p>
Cadence is primarily used to control and monitor the various Linux sound systems, including ALSA, under KXStudio. The main Cadence window has a &#039;JACK bridges&#039; section which contains two ALSA/JACK bridges - one for ALSA audio and one for MIDI. You will not hear audio produced by ALSA-only apps when JACK is running if the ALSA audio bridge is stopped. Likewise, you will be unable to access MIDI devices if the ALSA MIDI bridge isn&#039;t running when JACK is.
Cadence is primarily used to control and monitor the various Linux sound systems, including <acronym title="Advanced Linux Sound Architecture">ALSA</acronym>, under KXStudio. The main Cadence window has a &#039;JACK bridges&#039; section which contains two <acronym title="Advanced Linux Sound Architecture">ALSA</acronym>/JACK bridges - one for <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> audio and one for MIDI. You will not hear audio produced by <acronym title="Advanced Linux Sound Architecture">ALSA</acronym>-only apps when JACK is running if the <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> audio bridge is stopped. Likewise, you will be unable to access MIDI devices if the <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> MIDI bridge isn&#039;t running when JACK is.
</p>

</div>
@@ -64,7 +64,7 @@ Cadence is primarily used to control and monitor the various Linux sound systems
<div class="level2">

<p>
As JACK increases in popularity, it is more widely supported. However, several apps are still ALSA-only. Such apps will have their audio channeled via the same ALSA to JACK bridge. These include:
As JACK increases in popularity, it is more widely supported. However, several apps are still <acronym title="Advanced Linux Sound Architecture">ALSA</acronym>-only. Such apps will have their audio channeled via the same <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> to JACK bridge. These include:
</p>

<p>
@@ -72,7 +72,7 @@ As JACK increases in popularity, it is more widely supported. However, several a
</p>

<p>
<strong>Skype</strong> If you don&#039;t require webcam or video support then it is recommended you use Mumble instead of Skype for VOIP. Although Mumble doesn&#039;t yet officially support JACK, there is a build of Mumble with JACK support available from the KXStudio repositories. However, if you need to use Skype it works fine provided the ALSA audio bridge is running.
<strong>Skype</strong> If you don&#039;t require webcam or video support then it is recommended you use Mumble instead of Skype for VOIP. Although Mumble doesn&#039;t yet officially support JACK, there is a build of Mumble with JACK support available from the KXStudio repositories. However, if you need to use Skype it works fine provided the <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> audio bridge is running.
</p>

<p>
@@ -80,7 +80,7 @@ As JACK increases in popularity, it is more widely supported. However, several a
</p>

<p>
Some other apps have only partial JACK support. These work with JACK directly, have their own JACK connections, and function without the ALSA to JACK bridge, but their connections are not persistent. They will temporarily connect to JACK while playing but drop their connection as soon as playback is stopped. Examples of these apps are:
Some other apps have only partial JACK support. These work with JACK directly, have their own JACK connections, and function without the <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> to JACK bridge, but their connections are not persistent. They will temporarily connect to JACK while playing but drop their connection as soon as playback is stopped. Examples of these apps are:
</p>

<p>
@@ -105,27 +105,27 @@ Hence, none of these offer the individual audio routing functionality or other f
<div class="level2">

<p>
The following commands can be useful for troubleshooting ALSA issues in a terminal:
The following commands can be useful for troubleshooting <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> issues in a terminal:
</p>
<pre class="code">alsamixer</pre>

<p>
The original ALSA mixer
The original <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> mixer
</p>
<pre class="code">cat /proc/asound/cards</pre>

<p>
Displays attached ALSA devices
Displays attached <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> devices
</p>
<pre class="code">cat ~/.asoundrc</pre>

<p>
Displays your ALSA configuration file
Displays your <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> configuration file
</p>
<pre class="code">sudo alsactl store 0</pre>

<p>
Saves the current settings for ALSA device 0
Saves the current settings for <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> device 0
</p>

</div>


+ 4
- 4
Documentation:Manual:cadence_introduction.php View File

@@ -66,7 +66,7 @@ Replace &lt;username&gt; with a KXStudio user name when you run that command in
</p>

<p>
<strong>DSP Load</strong> is the current CPU load estimated by JACK. If it gets too high you may experience performance issues.
<strong><acronym title="Digital Signal Processing">DSP</acronym> Load</strong> is the current CPU load estimated by JACK. If it gets too high you may experience performance issues.
</p>

<p>
@@ -124,15 +124,15 @@ Cadence&#039;s main window integrates the control of a few &#039;JACK bridges&#0
</p>

<p>
The ALSA audio bridge enables one or more ALSA audio applications to access your JACK device when it is started. Most everybody will want to ensure this is kept running alongside JACK as it enables audio for non-JACK apps such as Firefox. If you have chosen for JACK to start at boot then the ALSA audio bridge also gets started automatically.
The <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> audio bridge enables one or more <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> audio applications to access your JACK device when it is started. Most everybody will want to ensure this is kept running alongside JACK as it enables audio for non-JACK apps such as Firefox. If you have chosen for JACK to start at boot then the <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> audio bridge also gets started automatically.
</p>

<p>
The ALSA MIDI bridge needs to be running if you want to use any MIDI hardware.
The <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> MIDI bridge needs to be running if you want to use any MIDI hardware.
</p>

<p>
PulseAudio is not included by default with KXStudio and the PulseAudio bridge will not function until it has been installed. Most applications which use PA can use ALSA or JACK instead so there is often no need for PA and its bridge.
PulseAudio is not included by default with KXStudio and the PulseAudio bridge will not function until it has been installed. Most applications which use PA can use <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> or JACK instead so there is often no need for PA and its bridge.
</p>

</div>


+ 1
- 1
Documentation:Manual:included_and_recommended_apps.php View File

@@ -126,7 +126,7 @@ Many of these apps are, or will be, included on the KXStudio DVD. Those not incl
</li>
<li class="level1"><div class="li"> <strong>scribus</strong> Professional layout and publishing software</div>
</li>
<li class="level1"><div class="li"> <strong>setBfree</strong> Great sounding DSP B3 Hammond organ emulator LV2 plugin </div>
<li class="level1"><div class="li"> <strong>setBfree</strong> Great sounding <acronym title="Digital Signal Processing">DSP</acronym> B3 Hammond organ emulator LV2 plugin </div>
</li>
<li class="level1"><div class="li"> <strong>smplayer</strong> Excellent audio and video playback app</div>
</li>


+ 3
- 3
Documentation:Manual:jack_configuration.php View File

@@ -22,11 +22,11 @@ Most of JACK&#039;s important configuration options are set within the Driver ta
<div class="level2">

<p>
The driver column to the left selects which JACK driver you wish to configure and use next time you start JACK with Cadence. Those using FireWire devices should use the FireWire driver but otherwise you should select ALSA for your JACK driver.
The driver column to the left selects which JACK driver you wish to configure and use next time you start JACK with Cadence. Those using FireWire devices should use the FireWire driver but otherwise you should select <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> for your JACK driver.
</p>

<p>
The top 3 drop-down options within Cadence&#039;s ALSA driver configuration are the most important as these let you select which device(s) to use for physical audio IO. If &#039;Duplex Mode&#039; is enabled then you can assign different ALSA devices to handle Input and Output individually. This could be useful, for example, if you need a mic input but wanted to have your sound output via a USB audio device that doesn&#039;t have a mic input. In this case you could use your computers onboard ALSA device, which likely does have a mic input, as a separate input device. If Duplex Mode is not selected then the top drop-down is used to select the ALSA device to use for both audio input and output.
The top 3 drop-down options within Cadence&#039;s <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> driver configuration are the most important as these let you select which device(s) to use for physical audio IO. If &#039;Duplex Mode&#039; is enabled then you can assign different <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> devices to handle Input and Output individually. This could be useful, for example, if you need a mic input but wanted to have your sound output via a USB audio device that doesn&#039;t have a mic input. In this case you could use your computers onboard <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> device, which likely does have a mic input, as a separate input device. If Duplex Mode is not selected then the top drop-down is used to select the <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> device to use for both audio input and output.
</p>

</div>
@@ -86,7 +86,7 @@ RTIRQ_NAME_LIST=“firewire snd usb i8042”
</p>

<p>
Here we see FireWire devices have priority over ALSA and USB devices because its mentioned first. If you are mainly running JACK on a USB device you may wish to make usb the first item in the list by editing that line in the rtirq config file with a command such as:
Here we see FireWire devices have priority over <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> and USB devices because its mentioned first. If you are mainly running JACK on a USB device you may wish to make usb the first item in the list by editing that line in the rtirq config file with a command such as:
</p>
<pre class="code">kdesudo kate /etc/default/rtirq</pre>



+ 4
- 4
Documentation:Manual:linux_audio_overview.php View File

@@ -18,11 +18,11 @@ Anyone intending to use GNU/Linux as a platform for audio or video production wi
<div class="level2">

<p>
<a href="http://www.alsa-project.org" class="urlextern" title="http://www.alsa-project.org" rel="nofollow">ALSA</a>, the Advanced Linux Sound Architecture, is a collection of drivers and libraries that provide Linux with audio and MIDI support for onboard, PCI, and USB audio hardware. ALSA doesn&#039;t support FireWire audio devices — that requires FFADO and JACK (see below).
<a href="http://www.alsa-project.org" class="urlextern" title="http://www.alsa-project.org" rel="nofollow">ALSA</a>, the Advanced Linux Sound Architecture, is a collection of drivers and libraries that provide Linux with audio and MIDI support for onboard, PCI, and USB audio hardware. <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> doesn&#039;t support FireWire audio devices — that requires FFADO and JACK (see below).
</p>

<p>
ALSA alone is insufficient for most AV production tasks because only one application can access an ALSA device at any one time. JACK and Pulseaudio were created mainly to overcome this restriction although they target different use cases. KXStudio includes an ALSA/JACK bridge program called “snd-aloop daemon” which enables the user to run ALSA-only apps alongside JACK and other JACK-native software. This bridge is turned on by default when JACK is started - see the <a target="_blank" href="http://wiki.linuxaudio.org/wiki/cadence_introduction" class="wikilink1" target="_parent" title="cadence_introduction">Cadence</a> instructions for more information.
<acronym title="Advanced Linux Sound Architecture">ALSA</acronym> alone is insufficient for most AV production tasks because only one application can access an <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> device at any one time. JACK and Pulseaudio were created mainly to overcome this restriction although they target different use cases. KXStudio includes an <acronym title="Advanced Linux Sound Architecture">ALSA</acronym>/JACK bridge program called “snd-aloop daemon” which enables the user to run <acronym title="Advanced Linux Sound Architecture">ALSA</acronym>-only apps alongside JACK and other JACK-native software. This bridge is turned on by default when JACK is started - see the <a target="_blank" href="http://wiki.linuxaudio.org/wiki/cadence_introduction" class="wikilink1" target="_parent" title="cadence_introduction">Cadence</a> instructions for more information.
</p>

</div>
@@ -40,7 +40,7 @@ The <a href="http://jackaudio.org" class="urlextern" title="http://jackaudio.org
<div class="level2">

<p>
<a href="http://ffado.org/" class="urlextern" title="http://ffado.org/" rel="nofollow">FFADO</a> provides Free FireWire Audio Drivers (the “O” is for .Org). Unlike ALSA, FFADO depends upon JACK and does not work independently. Hence, when you select a FireWire audio device for use by JACK under the Cadence driver configuration, you are using the FFADO drivers.
<a href="http://ffado.org/" class="urlextern" title="http://ffado.org/" rel="nofollow">FFADO</a> provides Free FireWire Audio Drivers (the “O” is for .Org). Unlike <acronym title="Advanced Linux Sound Architecture">ALSA</acronym>, FFADO depends upon JACK and does not work independently. Hence, when you select a FireWire audio device for use by JACK under the Cadence driver configuration, you are using the FFADO drivers.
</p>

</div>
@@ -49,7 +49,7 @@ The <a href="http://jackaudio.org" class="urlextern" title="http://jackaudio.org
<div class="level2">

<p>
<a href="http://pulseaudio.org" class="urlextern" title="http://pulseaudio.org" rel="nofollow">PulseAudio</a> (PA) is a sound server which, like JACK, runs on top of ALSA to provide functions such as allowing more than one application to use an ALSA device simultaneously. Pulse is targetted at regular desktop and mobile users rather than low-latency audio production. Cadence includes a PulseAudio/JACK bridge enabling you to run PulseAudio apps under JACK, but there are very few apps which support PA without supporting JACK or ALSA. KXStudio does not include PulseAudio as part of the default installation, but it is easily installed with the package manager if required.
<a href="http://pulseaudio.org" class="urlextern" title="http://pulseaudio.org" rel="nofollow">PulseAudio</a> (PA) is a sound server which, like JACK, runs on top of <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> to provide functions such as allowing more than one application to use an <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> device simultaneously. Pulse is targetted at regular desktop and mobile users rather than low-latency audio production. Cadence includes a PulseAudio/JACK bridge enabling you to run PulseAudio apps under JACK, but there are very few apps which support PA without supporting JACK or <acronym title="Advanced Linux Sound Architecture">ALSA</acronym>. KXStudio does not include PulseAudio as part of the default installation, but it is easily installed with the package manager if required.
</p>

</div>


+ 3
- 3
Documentation:Manual:simple_claudia_studio.php View File

@@ -17,7 +17,7 @@ KXStudio includes an app called Claudia which uses the LADISH JACK session manag
</p>

<p>
The use of Claudia and LADISH is best demonstrated with a simple example scenario. Let&#039;s say that you frequently find yourself wanting to record audio from a non-JACK app such as Firefox and you use qtractor to record the audio. To do this you must ensure JACK and Cadence&#039;s ALSA audio bridge are running and you must connect the alsa2jack capture ports to qtractor&#039;s JACK inputs. In this guide we will create a simple LADISH studio with Claudia that will start JACK and the ALSA bridges, load qtractor and connect alsa2jack to its inputs so its ready to record from Firefox at boot.
The use of Claudia and LADISH is best demonstrated with a simple example scenario. Let&#039;s say that you frequently find yourself wanting to record audio from a non-JACK app such as Firefox and you use qtractor to record the audio. To do this you must ensure JACK and Cadence&#039;s <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> audio bridge are running and you must connect the alsa2jack capture ports to qtractor&#039;s JACK inputs. In this guide we will create a simple LADISH studio with Claudia that will start JACK and the <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> bridges, load qtractor and connect alsa2jack to its inputs so its ready to record from Firefox at boot.
</p>

</div>
@@ -39,7 +39,7 @@ Claudia&#039;s interface is divided into four main areas when a studio is loaded
<div class="level2">

<p>
If you&#039;ve not already got JACK running, then now is a good time to start it. You can either start JACK from Cadence, choose &#039;Start Studio&#039; from Claudia&#039;s studio menu or push F5 in Claudia. When you do this, you will notice Claudia&#039;s transport controls become available and at least two items appear on the studio canvas - the JACK &#039;Hardware Capture&#039; and &#039;Hardware Playback&#039; ports. These are only visible in Claudia when the JACK server is running. For the purposes of this example we also need the Cadence ALSA audio bridge to be running. When you have the ALSA audio bridge running you will see an extra two items (JACK clients) in Claudia&#039;s studio editing area- alsa2jack, which gets auto-connected to the Hardware Playback ports, and jack2alsa which gets auto-connected to the Hardware capture ports.
If you&#039;ve not already got JACK running, then now is a good time to start it. You can either start JACK from Cadence, choose &#039;Start Studio&#039; from Claudia&#039;s studio menu or push F5 in Claudia. When you do this, you will notice Claudia&#039;s transport controls become available and at least two items appear on the studio canvas - the JACK &#039;Hardware Capture&#039; and &#039;Hardware Playback&#039; ports. These are only visible in Claudia when the JACK server is running. For the purposes of this example we also need the Cadence <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> audio bridge to be running. When you have the <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> audio bridge running you will see an extra two items (JACK clients) in Claudia&#039;s studio editing area- alsa2jack, which gets auto-connected to the Hardware Playback ports, and jack2alsa which gets auto-connected to the Hardware capture ports.
</p>

</div>
@@ -57,7 +57,7 @@ Now we shall add qtractor into our studio by choosing &#039;Add New…&#039; fro
<div class="level2">

<p>
We want this studio to automatically connect the outputs of alsa2jack (which outputs the sound of all non-JACK apps, such as Firefox) into qtractor so we must connect one to the other. Left-click on capture_1 within the alsa2jack box then, keeping the mouse button pressed, drag your pointer over the Master/in_1 input of qtractor, then let go. You should then see a blue line connecting the alsa2jack client to qtractor&#039;s input port - this indicates you have created a JACK connection between the two. Now do the same for alsa2jack&#039;s capture_2 and qtractor&#039;s Master/in_2 so that both the left and right channels will get sent from ALSA to qtractor. Finally, connect qtractor&#039;s Master/out_1 and Master/out_2 to the Hardware Playback ports so that you can hear qtractors output. That completes our studio configuration so save the studio, which should look something like this:
We want this studio to automatically connect the outputs of alsa2jack (which outputs the sound of all non-JACK apps, such as Firefox) into qtractor so we must connect one to the other. Left-click on capture_1 within the alsa2jack box then, keeping the mouse button pressed, drag your pointer over the Master/in_1 input of qtractor, then let go. You should then see a blue line connecting the alsa2jack client to qtractor&#039;s input port - this indicates you have created a JACK connection between the two. Now do the same for alsa2jack&#039;s capture_2 and qtractor&#039;s Master/in_2 so that both the left and right channels will get sent from <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> to qtractor. Finally, connect qtractor&#039;s Master/out_1 and Master/out_2 to the Hardware Playback ports so that you can hear qtractors output. That completes our studio configuration so save the studio, which should look something like this:
</p>

<p>


+ 1
- 1
Documentation:Manual:useful_links_and_getting_help.php View File

@@ -32,7 +32,7 @@ For more info on the KXStudio applications such as Cadence, Claudia and Catia
<div class="level3">

<p>
To check to see if your sound device is supported by GNU/Linux, check the ALSA SoundCard Matrix
To check to see if your sound device is supported by GNU/Linux, check the <acronym title="Advanced Linux Sound Architecture">ALSA</acronym> SoundCard Matrix
</p>

<p>


+ 0
- 4
_manual/create-manual-pages.py View File

@@ -87,10 +87,6 @@ for page in manualPages:
readPart5 = readPart5.replace('href="/wiki/', 'target="_blank" href="http://wiki.linuxaudio.org/wiki/')
readPart5 = readPart5.replace('title="wiki:', 'title="')

# TODO: remove this
readPart5 = readPart5.replace('<acronym title="Advanced Linux Sound Architecture">ALSA</acronym>','ALSA')
readPart5 = readPart5.replace('<acronym title="Digital Signal Processing">DSP</acronym>','DSP')

# FIXME: this should happen on the wiki
readPart5 = readPart5.replace("kxstudio.sourceforge.net", "kxstudio.linuxaudio.org")



Loading…
Cancel
Save