ardour/manual
13
0
Fork 0
Code Pull Requests Releases Activity

Updated the preferences page for 6.7, splitted newopen-session to create a dedicated audio-midi-setup page, corrected the links accordingly

Browse Source
This commit is contained in:
Ed Ward 2021-05-26 23:05:58 +02:00 committed by Len Ovens
parent 500fea9a1b
commit da709fc5a6
7 changed files with 1272 additions and 1158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
include/audio-midi-setup.html Normal file
View File

@ -0,0 +1,70 @@
<h2 class="clear">Audio/MIDI Setup</h2>
<figure class="center">
<img src="/images/Audio-MIDI_Setup.png" alt="The Audio/MIDI Setup Dialog"/>
<figcaption>
The Audio/MIDI Setup Dialog
</figcaption>
</figure>
<p>
This window exposes the different audio options to be used by Ardour for the
current work session, for hardware and software and is made of:
</p>
<table class="dl">
<tr><th>Audio System</th>
<td>Depending on the operating system, Ardour can possibly use different audio
systems, e.g. on Linux, both <abbr title="Advanced Linux Sound Architecture">
ALSA</abbr> and <abbr title="JACK Audio Connection Kit">JACK</abbr> are
available.
</td></tr>
<tr><th>Driver</th>
<td>
On Mac OS X this will typically be <kbd class="menu">CoreAudio</kbd>. On Linux usually
this will be either <kbd class="menu"><abbr title="Free Firewire Audio Driver fOr
linux">FFADO</abbr></kbd>
or <kbd class="menu"><abbr title="Advanced Linux Sound
Architecture">ALSA</abbr></kbd>, depending on whether or not a firewire device
is used. Advanced users on all platforms may also
use <kbd class="menu">NetJack</kbd> which provides network audio I/O.
</td></tr>
<tr><th>Device</th>
<td>The selector should show all available interfaces provided by the
driver above and which are capable of duplex operation.
<p class="warning">
When using an Intel Mac running OS X and the builtin audio
interface, its separate input and output devices must be <a href="@@using-more-than-one-audio-device">
merged</a> first into a single "aggregate device" before Ardour will be able
to use it.
</p>
</td></tr>
<tr><th>Sample Rate</th>
<td>
The selector will allow to select from any sample rate supported by the device
selected above it.
</td></tr>
<tr><th>Buffer Size</th>
<td>
The size of the buffer used by the audio interface can be adjusted
to allow for either lower latency, or lower CPU usage and higher
latency.
</td></tr>
<tr><th>Input/Output Channels</th>
<td>
Specifies the number of hardware channels to use. The
default is <kbd class="menu">all available channels</kbd>.</td></tr>
<tr><th>Hardware Input/Output Latency</th>
<td>Specify the hardware delay in samples for precise latency compensation.</td></tr>
<tr><th>Calibrate</th>
<td>
This button runs a semi-automated guided process to obtain
precise hardware latency measurements for the above option.</td></tr>
<tr><th>MIDI System</th>
<td>
Selects the MIDI driver to use. On Mac OS X, this will be <kbd
class="menu">CoreMIDI</kbd>. On Linux, this will follow the audio backend.
If the Audio backend is ALSA, midi will be alsa also. If the backend is
JACK, it can be changed between two legacy
ALSA drivers or the (preferred) new JACK+ALSA implementation.</td></tr>
</table>

71
include/newopen-session-dialog.html
View File

@ -93,77 +93,8 @@
</p>
<p>
Whether or not a template is used, and before the "Template Setup" dialog, the
Audio/MIDI Setup will be shown.
<a href="@@audio-midi-setup">Audio/MIDI Setup</a> will be shown.
</p>
<h2 class="clear">Audio/MIDI Setup</h2>
<figure class="left">
<img class="mini" src="/images/Audio-MIDI_Setup.png" alt="The Audio/MIDI Setup Dialog"/>
<figcaption>
The Audio/MIDI Setup Dialog
</figcaption>
</figure>
<p>
This window exposes the different audio options to be used by Ardour for the
current work session, for hardware and software and is made of:
</p>
<table class="dl">
<tr><th>Audio System</th>
<td>Depending on the operating system, Ardour can possibly use different audio
systems, e.g. on Linux, both <abbr title="Advanced Linux Sound Architecture">
ALSA</abbr> and <abbr title="JACK Audio Connection Kit">JACK</abbr> are
available.
</td></tr>
<tr><th>Driver</th>
<td>
On Mac OS X this will typically be <kbd class="menu">CoreAudio</kbd>. On Linux usually
this will be either <kbd class="menu"><abbr title="Free Firewire Audio Driver fOr
linux">FFADO</abbr></kbd>
or <kbd class="menu"><abbr title="Advanced Linux Sound
Architecture">ALSA</abbr></kbd>, depending on whether or not a firewire device
is used. Advanced users on all platforms may also
use <kbd class="menu">NetJack</kbd> which provides network audio I/O.
</td></tr>
<tr><th>Device</th>
<td>The selector should show all available interfaces provided by the
driver above and which are capable of duplex operation.
<p class="warning">
When using an Intel Mac running OS X and the builtin audio
interface, its separate input and output devices must be <a href="@@using-more-than-one-audio-device">
merged</a> first into a single "aggregate device" before Ardour will be able
to use it.
</p>
</td></tr>
<tr><th>Sample Rate</th>
<td>
The selector will allow to select from any sample rate supported by the device
selected above it.
</td></tr>
<tr><th>Buffer Size</th>
<td>
The size of the buffer used by the audio interface can be adjusted
to allow for either lower latency, or lower CPU usage and higher
latency.
</td></tr>
<tr><th>Input/Output Channels</th>
<td>
Specifies the number of hardware channels to use. The
default is <kbd class="menu">all available channels</kbd>.</td></tr>
<tr><th>Hardware Input/Output Latency</th>
<td>Specify the hardware delay in samples for precise latency compensation.</td></tr>
<tr><th>Calibrate</th>
<td>
This button runs a semi-automated guided process to obtain
precise hardware latency measurements for the above option.</td></tr>
<tr><th>MIDI System</th>
<td>
Selects the MIDI driver to use. On Mac OS X, this will be <kbd
class="menu">CoreMIDI</kbd>. On Linux, this will follow the audio backend.
If the Audio backend is ALSA, midi will be alsa also. If the backend is
JACK, it can be changed between two legacy
ALSA drivers or the (preferred) new JACK+ALSA implementation.</td></tr>
</table>

2224
include/preferences.html
View File

File diff suppressed because it is too large Load Diff

2
include/status-bar.html
View File

@ -52,7 +52,7 @@
<tr>
<th>Audio:</th>
<td>
opens the <a href="@@newopen-session-dialog">Audio MIDI Setup</a>
opens the <a href="@@audio-midi-setup">Audio MIDI Setup</a>
window.
</td>
</tr>

2
include/the-window-menu.html
View File

@ -4,7 +4,7 @@
</p>
<table class="dl">
<tr><th>&square; Audio/MIDI Setup</th><td>Shows the <a href="@@newopen-session-dialog"><kbd class="menu">Audio/MIDI Setup</kbd> window</a>, where the sound system configuration can be modified</td></tr>
<tr><th>&square; Audio/MIDI Setup</th><td>Shows the <a href="@@audio-midi-setup"><kbd class="menu">Audio/MIDI Setup</kbd> window</a>, where the sound system configuration can be modified</td></tr>
<tr><th>Editor</th>
<tr><th class="sub1">Show Editor</th><td>Switches to the Editor view</td></tr>

7
master-doc.txt
View File

@ -713,6 +713,13 @@ uri: working-with-sessions/the-new-session-dialog
part: subchapter
---
---
title: Audio/MIDI Setup
include: audio-midi-setup.html
link: audio-midi-setup
part: subchapter
---
---
title: Renaming a Session
include: renaming-a-session.html

BIN
source/images/preferences.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 20 KiB