]> Shamusworld >> Repos - ardour-manual/blobdiff - include/export-format-profiles.html
whitespace change to test commit hook
[ardour-manual] / include / export-format-profiles.html
index 2778546a4900adaca317805d8fd81d3fc9f716d2..5f43d26d640f48d0454d53eab8c317c90534d1c5 100644 (file)
 
-<h2>Export Format Profiles</h2>
+<figure class="right">
+  <img src="/images/edit-export-format-profile.png" alt="The 'Edit Export Format Profile' dialog">
+  <figcaption>
+    The 'Edit Export Format Profile' dialog
+  </figcaption>
+</figure>
 
 <p>
-An Export Format Profile specifies the file format in which Ardour will export
-audio files, and also other audio file export options.
+  An Export Format Profile specifies the file format in which Ardour will export
+  audio files, and also other audio file export options.
 </p>
-
 <p>
-Export Format Profiles are edited via the 'Edit Export Format Profile' dialog.
+  Export Format Profiles are edited via the <kbd class="menu">Edit Export Format
+  Profile</kbd> dialog.
 </p>
 
-<img src="/images/edit-export-format-profile.png" />
-<p>
-<h3>Normalize</h3>
+<h2>Label</h2>
 <p>
-If enabled, peak levels of exported files will be normalized to the level chosen here.
+  The <kbd class="menu">Label</kbd> field allows to choose the name which will be
+  shown for this format in the drop-down list of export formats in the
+  'File Formats' tab of the <a href="@@export-dialog">Export dialog</a>.
 </p>
 
-<h3>Trim/Add silence at start/end</h3>
+<h2>Pre Process</h2>
 <p>
-
+  If enabled, levels of exported files will be normalized to the level chosen here.
+  The normalization can be either:
 </p>
 
-<h3>Compatibility/Quality/File format/Sample rate</h3>
-<h4>Compatibility</h4>
+<ul>
+  <li>Peak, which adjusts the gain to bring the highest signal peak to the
+    chosen level (in <acronym title="decibels relative to full scale">dBFS</acronym>),
+  </li>
+  <li>Loudness, which adjusts the gain to bring the average amplitude to the
+    chosen level (in <acronym title="loudness units relative to full scale">LUFS</acronym>),
+    without exceeding the chosen true-peak value (in
+    <acronym title="decibels true peak">dBTP</acronym>).
+    EBU R128 is only available for mono or stereo sounds while true-peak works
+    for any channel layout.
+  </li>
+</ul>
+
+<h3>Trim silence at start/end</h3>
 <p>
-Selecting an item in the 'Compatibility' column will display options in the
-other columns that are incompatible with that item in red.
+  These checkboxes allow to remove any part Ardour considers silent (&lt; &minus;90dB),
+  at the beginning or/and end of each exported track.
 </p>
 
-<h4>Quality</h4>
+<h3>Add silence at start/end</h3>
 <p>
-The appropriate item in the 'Quality' column will be highlighted when you
-choose a file format. Clicking on items in the 'Quality' column currently
-doesn't seem to do anything useful.
+  These checkboxes allow to add silence at the beginning or/and end of each
+  exported track. The duration of the added silence can be manually fixed in the
+  adjacent 'timer' input fields.
 </p>
 
-<h4>File format</h4>
+<h2>Watermark</h2>
 <p>
-This column contains a list of Ardour's supported export file types. Click on
-the format you want to use.
+  This section adds watermarks to the exported audio (e.g. for limited/demo
+  distribution), by overwriting part of the audio with white noise in the
+  exported file.
 </p>
-
-<h4>Sample rate</h4>
 <p>
-You can explicitly choose the sample rate of your exported files here, or
-choose 'Session rate' to export in the current session's sample rate, without
-sample rate conversion.
+  Both the <dfn>Mode</dfn> (how often and how long) and <dfn>Noise Level</dfn>
+  (how loud) can be set.
 </p>
 
-<h4>Sample rate conversion quality</h4>
+<h2>Format</h2>
+
+<h3>Compatibility</h3>
 <p>
-If your chosen sample rate does not match the current session's sample rate,
-choose the sample rate conversion quality here. Better quality options are
-slower.
+  Selecting an item in the 'Compatibility' emphasizes the settings in the other
+  columns that are compatible with the selected standard, by turning incompatible
+  options red. When an incompatible quality/format/sample rate is selected, the
+  compatibility column checkbox disappears.
 </p>
 
-<h3>Options</h3>
+<h3>Quality</h3>
 <p>
-Options relevant to the chosen file format will appear here.
-Categories of audio file format are:
-<ul>
-<li>Linear encoding</li>
-<li>Broadcast Wave</li>
-<li>Ogg Vorbis</li>
-<li>FLAC</li>
-</ul>
+  The appropriate item in the 'Quality' column will be highlighted when a file format
+  is chosen. At the moment, selecting a Quality setting does not show the
+  compatible File formats.
+</p>
 
+<h3>File format</h3>
 <p>
-Available options include a selection of the following:</p>
-
-<h4>Sample Format</h4>
+  This column contains a list of Ardour's supported export file types. Selecting
+  one updates the options underneath it.
+</p>
 <p>
-Choose the bit depth of exported files.
+       Note: For mp3 export ardour relies on ffmpeg to encode the file. This comes bundled
+       with the video-tools (and is always available when you install the official Ardour
+       binary.
 </p>
 
-<h4>Dithering</h4>
+<h3>Sample rate</h3>
 <p>
-If the exported files bit depth is less than Ardour's native bit depth,
-choose the dithering algorithm to use.
+  A specific sample rate can be chosen for the exported files, or the current session's
+  sample rate (by choosing 'Session rate'), without sample rate conversion.
 </p>
 
-<h4>Create CUE file/Create TOC file</h4>
+<h2>Encoding</h2>
 <p>
-As well as exporting an audio file, create a file (in CUE or TOC format
-respectively) containg CD track information, as defined in the
-<a href="/ardours-interface/editor-lists/ranges-and-marks-list/">Ranges &amp; Marks List</a>.
+  Options relevant to the chosen file format will appear just to the right of the
+  Compatibility/Quality/File format/Sample rate table.
+</p>
 
+<h3>Sample rate conversion quality</h3>
+<p>
+  In case the chosen sample rate does not match the current session's sample rate,
+  the sample rate conversion quality can be chosen here. Better quality options are
+  slower.
+</p>
 
-<h4>Tag with session's metadata</h4>
+<h2>Metadata</h2>
 <p>
-If the exported file format supports metadata, use data entered in the
-<a href="/working-with-sessions/metadata/">Session Metadata</a>
-window to tag the exported files.
+  These options are presented whatever the chosen format is:
 </p>
 
+<h3>Tag file with session's metadata</h3>
+<p>
+  If the exported file format supports metadata (e.g. FLAC, Ogg Vorbis), use data
+  entered in the <a href="@@metadata">Session Metadata</a> window to tag the
+  exported files.
+</p>
 
-<h3>Label</h3>
+<h3>Create CUE/TOC/chapter mark file</h3>
 <p>
-The 'Label' field lets you choose the name which will be shown for this format
-in the drop-down list of export formats in the 'File Formats' tab of the
-<a href="/exporting/export-dialog/">Export dialog</a>.
+  As well as exporting an audio file, Ardour can create a file (in CUE, TOC or MP4ch format
+  respectively) containing CD track information, as defined in the
+  <a href="@@the-ranges-and-marks-lists">Ranges &amp; Marks List</a>.
+  Those files can then be used to either burn a CD or DVD, or to create "chapters"
+  inside a compatible mp4 video container.
 
-<h3>Command to run post-export</h3>
+<h2>Post Export</h2>
 <p>
-If this is not blank, it is considered as a command to be run after the export
-of each file. Either the command must exist in $PATH, or you can specify an
-absolute path to an executable file here.
+  If this is not blank, it is considered as a command to be run after the export
+  of each file. Either the command must exist in $PATH, or an absolute path to
+  an executable file can be specified here.
 </p>
 
 <p>
-Certain sequences are allowed here to stand for the exported file name and the
-like. Currently these are:
-<dl>
-<dt><code>%f</code></dt>
-<dd>Full path &amp; filename of the exported audio file</dd>
-<dt><code>%d</code></dt>
-<dd>Directory containing the exported audio file (including trailing directory separator)</dd>
-<dt><code>%b</code></dt>
-<dd>Basename of the exported audio file (without extension)</dd>
-<dt><code>%s</code></dt>
-<dd>Path to the current session file</dd>
-<dt><code>%n</code></dt>
-<dd>Name of the current session file</dd>
-<dt><code>%%</code></dt>
-<dd>A literal percent sign</dd>
-</dl>
-<p>
-Any part of the command-line enclosed in double-quotes (") will be used as-is.
+  Certain sequences are allowed here to stand for the exported file name and
+  various parameters. Currently these are:
+</p>
 
-{% children %}
+<ul>
+       <li><dfn>%a</dfn>: Artist name</li>
+       <li><dfn>%b</dfn>: File's base-name</li>
+       <li><dfn>%c</dfn>: Copyright</li>
+       <li><dfn>%d</dfn>: File's directory</li>
+       <li><dfn>%f</dfn>: File's full absolute path</li>
+       <li><dfn>%l</dfn>: Lyricist</li>
+       <li><dfn>%n</dfn>: Session name</li>
+       <li><dfn>%o</dfn>: Conductor</li>
+       <li><dfn>%t</dfn>: Title</li>
+       <li><dfn>%z</dfn>: Organization</li>
+       <li><dfn>%A</dfn>: Album</li>
+       <li><dfn>%C</dfn>: Comment</li>
+       <li><dfn>%E</dfn>: Engineer</li>
+       <li><dfn>%G</dfn>: Genre</li>
+       <li><dfn>%L</dfn>: Total track count</li>
+       <li><dfn>%M</dfn>: Mixer</li>
+       <li><dfn>%N</dfn>: Timespan name</li>
+       <li><dfn>%O</dfn>: Composer</li>
+       <li><dfn>%P</dfn>: Producer</li>
+       <li><dfn>%S</dfn>: Disc subtitle</li>
+       <li><dfn>%T</dfn>: Track number</li>
+       <li><dfn>%Y</dfn>: Year</li>
+       <li><dfn>%Z</dfn>: Country</li>
+</ul>
+
+<p>
+  Any part of the command-line enclosed in double-quotes (") will be used as-is.
+</p>
 
+<p>
+  For example, exporting an mp3 file can be done by inserting <code>lame -b320 %f</code>
+  which will convert the exported audio file ('%f') to a 320 kbs mp3 using the lame encoder
+  (provided lame is installed first on the system).
+</p>