Run make format on the manual

git-svn-id: svn://localhost/ardour2/branches/2.0-ongoing@3257 d708f5d6-7413-0410-9779-e7cbd77b26cf
This commit is contained in:
Tim Mayberry 2008-04-16 09:43:35 +00:00
parent b714a5fed2
commit 9aeccd52c8
3 changed files with 303 additions and 207 deletions

View file

@ -65,10 +65,10 @@
</para> </para>
<para> <para>
Regions are a somewhat special case in that they may contain <emphasis> Regions are a somewhat special case in that they may contain
sync points</emphasis>. If a region contains a sync point, the region start <emphasis> sync points</emphasis>. If a region contains a sync point,
position is ignored and the sync point is aligned to the grid. This allows the region start position is ignored and the sync point is aligned to
you to align a 'hit point' to the desitred grid. the grid. This allows you to align a 'hit point' to the desitred grid.
</para> </para>
<variablelist> <variablelist>

View file

@ -39,85 +39,90 @@
<section id="setup-monitoring"> <section id="setup-monitoring">
<title>Monitoring</title> <title>Monitoring</title>
<para> <para>
While monitoring is a broad term, here we use it to refer to the While monitoring is a broad term, here we use it to refer to the
signal a track delivers to its channel for further processing. signal a track delivers to its channel for further processing. There
There are two available monitoring states. are two available monitoring states. These are 'input' (the signal
These are being delivered to a track for potential recording), and 'off-disk'
'input' (the signal being delivered to a track for potential recording), and (material you have already recorded, or silence in the absence of a
'off-disk' (material you have already recorded, or silence in the absence of a region). region).
</para> </para>
</section> </section>
<section id="setup-hardware-monitoring"> <section id="setup-hardware-monitoring">
<title>Hardware Monitoring</title> <title>Hardware Monitoring</title>
<para> <para>
Some multichannel audio interfaces have the ability to route an input signal Some multichannel audio interfaces have the ability to route an input
directly to an output with very low or no latency. This is useful if your computer hardware signal directly to an output with very low or no latency. This is
is connected to the tape sends and returns of a mixing console. useful if your computer hardware is connected to the tape sends and
Whenever monitoring is set to input on a track, the track's input port is connected to its returns of a mixing console. Whenever monitoring is set to input on a
output in hardware (as would happen on a multitrack tape recorder). track, the track's input port is connected to its output in hardware
Hardware monitoring provides the best quality assurance for an engineer, as the signal path (as would happen on a multitrack tape recorder). Hardware monitoring
is exactly the same for input and off-disk monitoring. provides the best quality assurance for an engineer, as the signal
Level differences can be heard immediately, as can other gremlins that may ruin your recording. path is exactly the same for input and off-disk monitoring. Level
The hardware monitoring setting is only useful for interfaces supporting this feature. differences can be heard immediately, as can other gremlins that may
ruin your recording. The hardware monitoring setting is only useful
for interfaces supporting this feature.
</para> </para>
</section> </section>
<section id="setup-software-monitoring"> <section id="setup-software-monitoring">
<title>Software Monitoring</title> <title>Software Monitoring</title>
<para> <para>
Software monitoring uses software to perform input monitoring. Software monitoring uses software to perform input monitoring. When
When set to monitor input, a tracks input signal is passed to its channel set to monitor input, a tracks input signal is passed to its channel
as if it were coming from disk, allowing plugins to be heard while recording. as if it were coming from disk, allowing plugins to be heard while
This introduces an inevitable processing delay, or latency, to the input signal. recording. This introduces an inevitable processing delay, or latency,
The size of the delay depends on the current JACK configuration, which should to the input signal. The size of the delay depends on the current JACK
be set to as short as possible while recording. configuration, which should be set to as short as possible while
recording.
</para> </para>
</section> </section>
<section id="setup-latency"> <section id="setup-latency">
<title>Latency</title> <title>Latency</title>
<para></para> <para></para>
</section> </section>
<section id="setup-external-monitoring"> <section id="setup-external-monitoring">
<title>External Monitoring</title> <title>External Monitoring</title>
<para> <para>
External Monitoring will silence the output of a track whenever the track is set External Monitoring will silence the output of a track whenever the
to monitor input. It is useful if you are listening to the input signal track is set to monitor input. It is useful if you are listening to
using a path outside your computer (eg a mixing console). the input signal using a path outside your computer (eg a mixing
console).
</para> </para>
</section> </section>
<section id="tape-machine-mode"> <section id="tape-machine-mode">
<title>Tape Machine Mode</title> <title>Tape Machine Mode</title>
<para> <para>
Nearly all traditional tape recorders use the same monitoring model. Nearly all traditional tape recorders use the same monitoring model.
Normally only tracks that are record-enabled will monitor input with the Normally only tracks that are record-enabled will monitor input with
transport stopped. the transport stopped. Tape machine mode emulates this behaviour. Some
Tape machine mode emulates this behaviour. simpler machines (like a famous product by Alesis) switch all tracks
Some simpler machines (like a famous product by Alesis) switch all tracks to to input on stop when auto-input is enabled, regardless of
input on stop when auto-input is enabled, regardless of record-enable state. record-enable state. Disabling Tape Machine Mode switches to a
Disabling Tape Machine Mode switches to a behaviour that mimics this type of recorder. behaviour that mimics this type of recorder. Be warned that if you
Be warned that if you disable Tape Machine Mode, many tracks sharing the same input disable Tape Machine Mode, many tracks sharing the same input (in
(in software monitoring mode) will sum that input through the master buss software monitoring mode) will sum that input through the master buss
(potentially including several plugins) whenever the transport is stopped. (potentially including several plugins) whenever the transport is
Since setting up a sound usually involves listening to the input with the transport stopped. Since setting up a sound usually involves listening to the
stopped, you might not be hearing the sound you are about to record! input with the transport stopped, you might not be hearing the sound
Disabling this mode can also lead to surprising acoustic feedback. you are about to record! Disabling this mode can also lead to
Tape Machine Mode is off by default. surprising acoustic feedback. Tape Machine Mode is off by default.
</para> </para>
</section> </section>
<section id="setup-auto-input"> <section id="setup-auto-input">
<title>Auto-Input</title> <title>Auto-Input</title>
<para> <para>
When a track is record-enabled, it is set to monitor input When a track is record-enabled, it is set to monitor input regardless
regardless of the transport state. Auto input switches to off-disk monitoring of the transport state. Auto input switches to off-disk monitoring
when play is engaged. When Ardour is actually recording, the track will be set to when play is engaged. When Ardour is actually recording, the track
monitor input again. will be set to monitor input again. Auto-Input is useful for
Auto-Input is useful for performing punch-ins. Disable auto-input when performing performing punch-ins. Disable auto-input when performing 'dry runs' of
'dry runs' of an overdub to allow a performer to hear themselves while the transport is rolling. an overdub to allow a performer to hear themselves while the transport
is rolling.
</para> </para>
</section> </section>
@ -262,12 +267,13 @@
<section id="setup-punch-recording"> <section id="setup-punch-recording">
<title>Punch Recording</title> <title>Punch Recording</title>
<para> <para>
Once you have recorded material onto a track, the simplest way to punch in Once you have recorded material onto a track, the simplest way to
(or drop in as it is known elsewhere) is to roll the transport and press the punch in (or drop in as it is known elsewhere) is to roll the
master record button at the desired in point. Assuming the desired track is transport and press the master record button at the desired in point.
record enabled, its monitoring state will be switched and recording will begin. Assuming the desired track is record enabled, its monitoring state
Pressing it again disengages record. will be switched and recording will begin. Pressing it again
If repeatable punch-ins are required, you may use auto punch. disengages record. If repeatable punch-ins are required, you may use
auto punch.
</para> </para>
</section> </section>

View file

@ -1,43 +1,49 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="ch-using-existing-audio"> <chapter id="ch-using-existing-audio">
<title>Using Existing Audio</title> <title>Using Existing Audio</title>
<para>
<para>There are two primary ways to bring data into Ardour: recording it There are two primary ways to bring data into Ardour: recording it
within a session from a live sound source or importing pre-existing audio within a session from a live sound source or importing pre-existing
files. This section covers the various ways to import audio into a audio files. This section covers the various ways to import audio into a
session.</para> session.
</para>
<section id="importing-and-embedding"> <section id="importing-and-embedding">
<title>Importing and Embedding</title> <title>Importing and Embedding</title>
<para>
<para>Importing and embedding are two different methods of using existing Importing and embedding are two different methods of using existing
audio files on your computer (or network file system) within a session. audio files on your computer (or network file system) within a
They differ in one key respect:</para> session. They differ in one key respect:
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>Importing</term> <term>Importing</term>
<listitem> <listitem>
<para>An existing audio file is copied to the session's sounds <para>
folder, and is converted into the session's native format (WAVE or An existing audio file is copied to the session's sounds folder,
Broadcast WAVE depending on your choice) and sample rate. At this and is converted into the session's native format (WAVE or
time, no control over the conversion process is offered. If sample Broadcast WAVE depending on your choice) and sample rate. At
rate conversion is required, it will be carried out at the highest this time, no control over the conversion process is offered. If
quality that Ardour can provide. This means that it can be rather sample rate conversion is required, it will be carried out at
slow (many minutes to import an audio file lasting a few the highest quality that Ardour can provide. This means that it
minutes).</para> can be rather slow (many minutes to import an audio file lasting
a few minutes).
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Embedding</term> <term>Embedding</term>
<listitem> <listitem>
<para>An existing audio file is used as a the source for a region, <para>
but is not copied or modified in any way.</para> An existing audio file is used as a the source for a region, but
is not copied or modified in any way.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -45,266 +51,350 @@
<section id="supported-external-audio-file-formats"> <section id="supported-external-audio-file-formats">
<title>Supported External Audio File Formats</title> <title>Supported External Audio File Formats</title>
<para>
<para>The list of audio file formats that Ardour can import/embed is quite The list of audio file formats that Ardour can import/embed is quite
long. It is based on the functionality offered by libsndfile, an excellent long. It is based on the functionality offered by libsndfile, an
and widely used software library by Australian programmer Erik de Castro excellent and widely used software library by Australian programmer
Lopo. As libsndfile's capabilities expand, so will Ardour's abilities to Erik de Castro Lopo. As libsndfile's capabilities expand, so will
import (and export) new formats. Ogg/Vorbis (an excellent, unpatented and Ardour's abilities to import (and export) new formats. Ogg/Vorbis (an
license free audio compression format similar to MP3) is planned for the excellent, unpatented and license free audio compression format
near future. Currently, supported formats include:</para> similar to MP3) is planned for the near future. Currently, supported
formats include:
</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Microsoft WAV</para> <para>
Microsoft WAV
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>SGI/Apple AIFF/AIFC</para> <para>
SGI/Apple AIFF/AIFC
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Sun AU/Snd</para> <para>
Sun AU/Snd
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Raw (headerless)</para> <para>
Raw (headerless)
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Paris Audio File (PAF)</para> <para>
Paris Audio File (PAF)
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Commodore IFF/SVX</para> <para>
Commodore IFF/SVX
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Sphere/NIST WAV</para> <para>
Sphere/NIST WAV
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>IRCAM SF</para> <para>
IRCAM SF
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Creative VOC</para> <para>
Creative VOC
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>SoundForge W64</para> <para>
SoundForge W64
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>GNU Octave MAT4.4</para> <para>
GNU Octave MAT4.4
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Portable Voice Format</para> <para>
Portable Voice Format
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Fasttracker 2 XI</para> <para>
Fasttracker 2 XI
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>HMM Tool Kit HTK</para> <para>
HMM Tool Kit HTK
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>Sample encodings supported include:</para> <para>
Sample encodings supported include:
</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Unsigned and signed 8, 16, 24 and 32 bit PCM</para> <para>
Unsigned and signed 8, 16, 24 and 32 bit PCM
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>IEEE 32 and 64 floating point</para> <para>
IEEE 32 and 64 floating point
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>U-LAW</para> <para>
U-LAW
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>A-LAW</para> <para>
A-LAW
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>IMA ADPCM</para> <para>
IMA ADPCM
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>MS ADPCM</para> <para>
MS ADPCM
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>GSM 6.10</para> <para>
GSM 6.10
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>G721/723 ADPCM</para> <para>
G721/723 ADPCM
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>12/16/24 bit DWVW</para> <para>
12/16/24 bit DWVW
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>OK Dialogic ADPCM</para> <para>
OK Dialogic ADPCM
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>8/16 DPCM</para> <para>
8/16 DPCM
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
<section id="using-audio-files"> <section id="using-audio-files">
<title>Using audio files as tracks or regions?</title> <title>Using audio files as tracks or regions?</title>
<para>
<para>When you want to use existing audio files in an Ardour session, the When you want to use existing audio files in an Ardour session, the
first choice you need to make is whether you want to bring the files in as first choice you need to make is whether you want to bring the files
tracks or as new regions. Consider the two following scenarios:</para> in as tracks or as new regions. Consider the two following scenarios:
</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>you have an 8 track recording of existing material, with 1 audio <para>
file per track</para> you have an 8 track recording of existing material, with 1 audio
file per track
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>you have a sample library containing 500 small audio <para>
files</para> you have a sample library containing 500 small audio files
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>In the first case, your goal is probably to have 8 tracks (at <para>
least), with each track containing a single audio file. In the second In the first case, your goal is probably to have 8 tracks (at least),
case, its a lot more likely that you simply want to be able to use any of with each track containing a single audio file. In the second case,
the samples easily, but do not want any tracks created as a direct result its a lot more likely that you simply want to be able to use any of
of the import/embed. It is very important that you understand this the samples easily, but do not want any tracks created as a direct
distinction: many new users think there should be a "simple" way to import result of the import/embed. It is very important that you understand
existing audio without understanding that the goal of importing/embedding this distinction: many new users think there should be a "simple" way
is not always the same.</para> to import existing audio without understanding that the goal of
importing/embedding is not always the same.
</para>
<para>Ardour provides two different options when importing. You can <para>
import/embed audio files as new tracks, or you can import/embed them into Ardour provides two different options when importing. You can
the region list, where they will be available as regions to put into new import/embed audio files as new tracks, or you can import/embed them
or existing tracks. You can also insert import/embed audio files directly into the region list, where they will be available as regions to put
into an existing track.</para> into new or existing tracks. You can also insert import/embed audio
files directly into an existing track.
</para>
</section> </section>
<section id="how-to-import-embed"> <section id="how-to-import-embed">
<title>How to import/embed</title> <title>How to import/embed</title>
<para>
There are three pathways for importing/embedding an audio file into a
session. One is initiated from the File menu, one is initiated from
the track context menu, and one is initiated from the region list.
These methods are all equivalent: they open the file import dialog.
Once the dialog is open, you can choose to add new audio as new
tracks, as regions in the region list, or as audio in the selected
track. You can change this behavior once the dialog is opened.
</para>
<para>There are three pathways for importing/embedding an audio file into <para>
a session. One is initiated from the File menu, one is initiated from the <caution>
track context menu, and one is initiated from the region list. These <para>
methods are all equivalent: they open the file import dialog. Once the If you want to import a file directly into an existing track, you
dialog is open, you can choose to add new audio as new tracks, as regions must have the track selected in the editor before beginning the
in the region list, or as audio in the selected track. You can change this import.
behavior once the dialog is opened.</para> </para>
</caution>
<para><caution> If you use Nautilus as your file manager, you can easily import files
<para>If you want to import a file directly into an existing track, into your project by dragging them onto the desired track, then
you must have the track selected in the editor before beginning the releasing the mouse button. The file will then be
import. </para> <link
</caution>If you use Nautilus as your file manager, you can easily linkend="gt-embed">embedded</link> into your session.
import files into your project by dragging them onto the desired track, </para>
then releasing the mouse button. The file will then be <link
linkend="gt-embed">embedded</link> into your session.</para>
</section> </section>
<section id="how-to-embed-a-file"> <section id="how-to-embed-a-file">
<title>Working with Tags</title> <title>Working with Tags</title>
<para>
<para>A "tag" is bit of information, or <emphasis>metadata</emphasis>, A "tag" is bit of information, or <emphasis>metadata</emphasis>, that
that is associated with a data file. Specifically, tags are keywords or is associated with a data file. Specifically, tags are keywords or
terms that you feel have some relevance to a particular soundfile. Ardour terms that you feel have some relevance to a particular soundfile.
can store these tags in a seachable database so that you can quickly Ardour can store these tags in a seachable database so that you can
search for sounds based on the tags that you have assigned to them. For quickly search for sounds based on the tags that you have assigned to
example you can assign the term "120bpm" to a sound, and then when you them. For example you can assign the term "120bpm" to a sound, and
search for this tag, the file will appear in the search list. Tags are then when you search for this tag, the file will appear in the search
independent of the filename or anything else about the file. Tags, and the list. Tags are independent of the filename or anything else about the
file paths that they are associated with, are stored in a file called file. Tags, and the file paths that they are associated with, are
"sfdb" in your Ardour user folder. </para> stored in a file called "sfdb" in your Ardour user folder.
</para>
<section id="embedding-via-the-region-list"> <section id="embedding-via-the-region-list">
<title>Adding tags to a file</title> <title>Adding tags to a file</title>
<orderedlist> <orderedlist>
<listitem> <listitem>
<para>Select a file in the import dialog.</para> <para>
Select a file in the import dialog.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Enter the tags in the box to the right labeled "Tags".</para> <para>
Enter the tags in the box to the right labeled "Tags".
</para>
</listitem> </listitem>
</orderedlist> </orderedlist>
<para>
<para>Tags are stored when the input box loses focus, there is no reason Tags are stored when the input box loses focus, there is no reason
to explicitly "save" them.</para> to explicitly "save" them.
</para>
</section> </section>
<section id="embedding-from-a-track"> <section id="embedding-from-a-track">
<title>Searching for files using tags</title> <title>Searching for files using tags</title>
<orderedlist> <orderedlist>
<listitem> <listitem>
<para>Select the "Search Tags" tab on the import dialog.</para> <para>
Select the "Search Tags" tab on the import dialog.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Enter the tag(s) to search for and press "Search".</para> <para>
Enter the tag(s) to search for and press "Search".
</para>
</listitem> </listitem>
</orderedlist> </orderedlist>
<para>
<para>Files which have been "tagged" with the input terms will appear in Files which have been "tagged" with the input terms will appear in
the results window. You can audition these files and apply tags to them the results window. You can audition these files and apply tags to
from this window.</para> them from this window.
</para>
</section> </section>
</section> </section>
<section id="searching-freesound"> <section id="searching-freesound">
<title>Searching Freesound for soundfiles (optional)</title> <title>Searching Freesound for soundfiles (optional)</title>
<para>
Freesound (http://freesound.iua.upf.edu/) is an online database with
thousands of soundfiles which can be freely used in many projects
(visit Freesound for the exact licensing terms). Ardour has an option
to download files directly from freesound directly from the import
dialog. Freesound files are tagged with metadata which you can use to
search for relevant sounds.
</para>
<para>Freesound (http://freesound.iua.upf.edu/) is an online database with <para>
thousands of soundfiles which can be freely used in many projects (visit To enable the Freesound search engine inside Ardour, you must build
Freesound for the exact licensing terms). Ardour has an option to download Ardour with the option FREESOUND=yes, and you must have the "curl"
files directly from freesound directly from the import dialog. Freesound library installed. This is currently optional but may later become a
files are tagged with metadata which you can use to search for relevant standard feature of Ardour.
sounds.</para> </para>
<para>To enable the Freesound search engine inside Ardour, you must build <para>
Ardour with the option FREESOUND=yes, and you must have the "curl" library To download files from Freesound, you must first register for a
installed. This is currently optional but may later become a standard username and password on the freesound website. Enter this information
feature of Ardour.</para> into the text entry boxes, enter your tags to search for, and then
click "Start Downloading". Ardour will begin downloading files, and
the "Start Downloading" button will change to say "Cancel". Clicking
the "Cancel" button will wait until the currently downloading file is
finished, then the button will switch back to "Start Downloading". The
button will also say "Start Downloading" once Ardour has downloaded
all of the files that match the given tag. In the future there may be
better indication of the file progress and better filtering on the
filetypes that are downloaded.
</para>
<para>To download files from Freesound, you must first register for a <para>
username and password on the freesound website. Enter this information If you later search for the same terms, you will see that the files
into the text entry boxes, enter your tags to search for, and then click appear in the list more quickly, because any files in the search set
"Start Downloading". Ardour will begin downloading files, and the "Start that are already downloaded won't have to be downloaded again.
Downloading" button will change to say "Cancel". Clicking the "Cancel" </para>
button will wait until the currently downloading file is finished, then
the button will switch back to "Start Downloading". The button will also
say "Start Downloading" once Ardour has downloaded all of the files that
match the given tag. In the future there may be better indication of the
file progress and better filtering on the filetypes that are
downloaded.</para>
<para>If you later search for the same terms, you will see that the files <para>
appear in the list more quickly, because any files in the search set that Sounds that are downloaded from Freesound will automatically be given
are already downloaded won't have to be downloaded again.</para> tags in Ardour that match their tags in the Freesound database. This
means that once they are downloaded, Ardour can search for the local
<para>Sounds that are downloaded from Freesound will automatically be files very quickly using the "Search Tags" tab.
given tags in Ardour that match their tags in the Freesound database. This </para>
means that once they are downloaded, Ardour can search for the local files
very quickly using the "Search Tags" tab.</para>
</section> </section>
<!--
<!--
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Some_Subsection.xml" /> href="Some_Subsection.xml" />
--> -->