From: Ed Ward Date: Thu, 3 Jan 2019 14:28:07 +0000 (+0100) Subject: More passive form, updated screenshots, updated 'export' and 'vbap panners' X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=91db92553d42c43e3ee2f59f83f6bd0dddb0d8c1;hp=88d6f39b5f8b0f791b6833bb1512aa774b59d4f8;p=ardour-manual More passive form, updated screenshots, updated 'export' and 'vbap panners' --- diff --git a/include/export-dialog.html b/include/export-dialog.html index 1b59252..91a9699 100644 --- a/include/export-dialog.html +++ b/include/export-dialog.html @@ -1,18 +1,11 @@

- When you have finished mixing your session, you probably want to export it to a sound + When a session is finished mixing, one probably wants to export it to a sound file to burn to a CD, upload to the web, or whatever. Session > Export > Export to Audio file(s)… shows the Export Dialog to do this.

-

- You can also export the outputs of multiple tracks and busses all at once via - Session > Export > Stem Export…. -

- -

File Format

- -
+
The Export window
The Export window @@ -20,45 +13,57 @@

- This tab contains controls for the format of the exported audio file. - You can enable more than one format here, in which case each will be exported in turn. + The outputs of multiple tracks and busses all at once can also be exported via + Session > Export > Stem Export…. +

+ +

File Format

+ +

+ This tab contains controls for the format of the exported audio file(s). + More than one format can be enabled here, in which case each will be exported in turn. Ardour is supplied with a list of export formats, including:

- You can edit these formats, or create your own, with the "Edit Export Format Profile" dialog, which - appears when you click the "Edit" or "New" button to the right of the drop-down list of formats. + These formats can be edited, or new ones created, with the "Edit Export Format Profile" dialog, which + appears when clicking the Edit or + New buttons to the right of the drop-down list of + formats.

- You can also create a 'Preset' consisting of one or more formats. Ardour provides some ready-made presets, too: + Presets can also be created, consisting of one or more formats. Ardour + provides some ready-made presets, too:

The location

@@ -83,30 +88,12 @@
  • A time (also in multiple format).
    • -

    Soundcloud upload

    -

    - When 'Upload to Soundcloud' is ticked on in any format's tab, a pane containing fields - to enter in Soundcloud account details (email and password), and what should happen - to the uploaded files will become visible. +

    + As in the screenshot above, when writing a file could erase a present file with + the same name, Ardour shows a yellow warning line in the bottom of the window, and + a button to list all the files that would be erased and replaced.

    -
    - Exporting to Soundcloud -
    - Exporting to Soundcloud -
    -
    - - - - - - - - -
    Make files publicChoose whether to make uploaded files available to anyone via the Soundcloud web site.
    Open uploaded files in browserOpen each file on soundcloud in your browser after upload. - If you don't enable this, you can still see the URLs in the Log window.
    Make files downloadableChoose whether to allow downloading of files uploaded to Soundcloud.
    -

    Analyze exported audio

    @@ -155,8 +142,16 @@

    - This tab allows you to select the range (or ranges) of the timeline to export. By default, "session" is + This tab allows to select the range (or ranges) of the timeline to export. By default, "session" is enabled—this will export the whole session from the start marker to the end marker. + Any loop or range present in the session can be chosen, or a combination thereof. +

    +

    + The realtime checkboxes allow to export audio as it is played, + and not freewheeling to render the file as fast as Ardour can. This can prevent + odd behaviours from some plugins (reverbs, etc...). This can be chosen globally + (with the Realtime Export checkbox at the top) or individually on a per time span basis, with + the RT checkbox next to each time span.

    Channels

    @@ -169,7 +164,8 @@

    - Here you can choose which outputs (tracks or busses) should be sent to the exported file. + This tab decides which outputs (tracks or busses) should be sent to the exported + file. By default, only the Master Bus is sent.

    Stem Export

    @@ -182,10 +178,16 @@

    - If you chose 'Stem Export', the 'Channels' tab appears slightly differently: + Stem exporting allows to transfer files between different systems and softwares + by exporting each track individually, including silence, to keep them in sync. +

    +

    + If 'Stem Export' is chosen, the 'Channels' tab appears slightly differently: in this case each chosen channel (track or bus) is exported to its own file, - instead of all channels being mixed together into a single file. You can - choose to export either the region contents or the track output here in this - case. + instead of all channels being mixed together into a single file. +

    +

    + The exported tracks or busses can, by checking Apply + track/bus processing, be exported with the effects/processors applied, + so that the destination system does not need those effects plugins.

    - diff --git a/include/export-format-profiles.html b/include/export-format-profiles.html index 732b365..f98386e 100644 --- a/include/export-format-profiles.html +++ b/include/export-format-profiles.html @@ -2,116 +2,143 @@

    Export Format Profiles

    -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.

    -Export Format Profiles are edited via the 'Edit Export Format Profile' dialog. + Export Format Profiles are edited via the Edit Export Format + Profile dialog.

    - -

    +

    + The 'Edit Export Format Profile' dialog +
    + The 'Edit Export Format Profile' dialog +
    +
    +

    Normalize

    -If enabled, peak levels of exported files will be normalized to the level chosen here. + If enabled, levels of exported files will be normalized to the level chosen here. + The normalization can be either:

    -

    Trim/Add silence at start/end

    -

    +

    +

    Trim silence at start/end

    +

    + These checkboxes allow to remove any part Ardour considers silent (0dB), + at the beginning or/and end of each exported track.

    +

    Add silence at start/end

    +

    + 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 + adjascent 'timer' input fields. +

    Compatibility/Quality/File format/Sample rate

    +

    Compatibility

    -Selecting an item in the 'Compatibility' column will display options in the -other columns that are incompatible with that item in red. + Selecting an item in the 'Compatibility' emphasizes the settinggs 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 disapears.

    Quality

    -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. + The appropriate item in the 'Quality' column will be highlighted a file format + is chosen. At the moment, selecting a Quality settings does not show the + compatible File formats.

    File format

    -This column contains a list of Ardour's supported export file types. Click on -the format you want to use. + This column contains a list of Ardour's supported export file types. Selecting + one updates the options underneath it.

    Sample rate

    -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. + 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.

    Sample rate conversion quality

    -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. + 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.

    -

    Options

    -

    -Options relevant to the chosen file format will appear here. -Categories of audio file format are: -

    - +

    Format Options

    -Available options include a selection of the following:

    + Options relevant to the chosen file format will appear just under the + Compatibility/Quality/File format/Sample rate table. +

    -

    Sample Format

    +

    Tag with session's metadata

    -Choose the bit depth of exported files. + If the exported file format supports metadata (e.g. FLAC, Ogg Vorbis), use data + entered in the Session Metadata window to tag the + exported files.

    -

    Dithering

    +

    Sample Format and Dithering

    -If the exported files bit depth is less than Ardour's native bit depth, -choose the dithering algorithm to use. + The Sample Format is the bit depth of exported files, + i.e. the numbers of values a sample can have. Increasing the sample format + results in a better defined audio file at the cost of increasing the file size.

    - -

    Create CUE file/Create TOC file

    -As well as exporting an audio file, create a file (in CUE or TOC format -respectively) containing CD track information, as defined in the -Ranges & Marks List. - + If the exported files bit depth is less than Ardour's native bit depth + (32 bits floating point by default), the dithering algorithm, that chooses how + to compute the conversion can be chosen in the Dithering + column. +

    -

    Tag with session's metadata

    +

    Options

    -If the exported file format supports metadata, use data entered in the -Session Metadata -window to tag the exported files. + These options are presented whatever the chosen format is:

    +

    Create CUE/TOC/chapter mark file

    +

    + 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 + Ranges & Marks List. + Those files can then be used to either burn a CD or DVD, or to create "chapters" + inside a compatible mp4 video container.

    Label

    -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 -Export dialog. + The Label 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 Export dialog. +

    Command to run post-export

    -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.

    -Certain sequences are allowed here to stand for the exported file name and the -like. Currently these are: + Certain sequences are allowed here to stand for the exported file name and + various parameters. Currently these are: @@ -126,6 +153,13 @@ like. Currently these are:
    %f Full path and filename of the exported audio file
    %% A literal percent sign
    +

    -Any part of the command-line enclosed in double-quotes (") will be used as-is. + Any part of the command-line enclosed in double-quotes (") will be used as-is. +

    +

    + As an exemple, exporting an mp3 file can be done by inserting lame -b320 %f + 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). +

    diff --git a/include/getting-more-plugins.html b/include/getting-more-plugins.html index 8bc5947..eb7a301 100644 --- a/include/getting-more-plugins.html +++ b/include/getting-more-plugins.html @@ -9,62 +9,37 @@

    LADSPA

    LV2

    Linux VST (LXVST)

    @@ -75,20 +50,20 @@
  • Argotlunar http://argotlunar.info/
    • -

    How do I install plugins?

    +

    How to install plugins?

    Linux

    - Installation will vary a little depending on how you get plugins. If - your repository has a particular plugin package, just install it using - the normal software package management tool for your system. Most - Linux distributions that are good for audio work will have most of - the LADSPA and LV2 plugins mentioned above available in ready-to-use - forms. + Installation will vary a little depending on how the plugins have + been obtained. If a particular plugin package appears in the local repository, + installing it using is done by using the normal software package management + tool for the system. Most Linux distributions that are good for audio work + will have most of the LADSPA and LV2 plugins mentioned above available in + ready-to-use form.

    - Finding them will typically require searching your + Finding them will typically require searching the distribution's repository to find the name of the package. The tools for doing this vary from distribution to distribution. A good place to start searching is with the name of the package (e.g. "caps" or @@ -96,36 +71,34 @@ distributions call their packages for a given set of plugins.

    - If the package isn't available, then you can build the plugins from - source (plugins are generally fairly easy to compile if you've ever - done this sort of thing before). + If the package isn't available, then the plugins can be built from + source (plugins are generally fairly easy to compile and well-documented).

    LADSPA plugins are shared library files. They need to be installed in either /usr/lib/ladspa, /usr/local/lib/ladspa or in a directory - mentioned in your LADSPA_PATH environment variable. + mentioned in the local LADSPA_PATH environment variable.

    LV2 plugins are folders/directories. They need to be installed in either /usr/lib/lv2, /usr/local/lib/lv2 or a directory - mentioned in your LV2_PATH environment variable. + mentioned in the local LV2_PATH environment variable.

    Linux VST (LXVST) plugins are distributed as shared library files. They are typically installed in /usr/lib/lxvst, - /usr/local/lib/lxvst or a directory mentioned in your LXVST_PATH + /usr/local/lib/lxvst or a directory mentioned in the local LXVST_PATH environment variable.

    OS X

    - Unless you're a particularly technical computer user, building and + Except for the particularly technical computer user, building and installing plugins in the LV2 (or LADSPA) format is probably not something worth planning on.

    - Most of the plugins you are likely to use on OS X will be in Apple's + Most of the plugins likely to be used on OS X will be in Apple's AudioUnit format. These have their own installation process that tends to just work.

    - diff --git a/include/managing-plugin-presets.html b/include/managing-plugin-presets.html index 9fb6a89..2bd871c 100644 --- a/include/managing-plugin-presets.html +++ b/include/managing-plugin-presets.html @@ -5,7 +5,12 @@ These include 4 controls for managing plugin presets.

    -

    Add pictures

    +
    + The plugin presets toolbar +
    + The plugin presets toolbar. +
    +

    What Is a Plugin Preset?

    @@ -20,45 +25,43 @@

    The Preset Selector

    - The preset selector is a regular selector that can be + The preset selector (1) is a regular selector that can be clicked to display a list of all known presets for this plugin. This - will include presets that you have created yourself, and for some + will include presets that have been created by the user, and for some plugin formats, presets that come with the plugin itself.

    -

    Load a New Preset

    +

    Loading a New Preset

    - Click on the preset selector to pop up a menu showing the names of - all available presets. Click on the name of the preset you wish to load. - The preset will be loaded—you may see various controls in the - plugin editor change to reflect the new value of some or all parameters. + Clicking on the preset selector pops up a menu showing the names of + all available presets. Clicking on the name of a preset loads it, and various + controls in the plugin editor change to reflect the new value of some or all + parameters.

    -

    Create a Preset

    +

    Creating a Preset

    - To save the current plugin settings as a new preset, click on the - Add button at the top of the window. A dialog - will appear to ask for the name of the preset. + Saving the current plugin settings as a new preset is done by clicking on the + Add button (2) at the top of the window. A dialog + will appear asking for a name for the preset.

    -

    Save a Preset

    +

    Saving a Preset

    - If you wish to modify the settings in an existing preset, first use - the preset selector to load the preset, then adjust the settings as - you wish. When done, click the Save button - and the new values will be stored, overwriting the previous version - of this preset. + To modify the settings in an existing preset, the preset selector must be used + to load the preset, then, when the settings have been adjusted, the + Save button (3) clicked. The new values will be stored, + overwriting the previous version of this preset.

    -

    Delete a preset

    +

    Deleting a preset

    - To delete an existing preset, use the preset selector to load the preset. - Click the Delete button, and the preset will be - removed. The preset selector turn blank, showing that no preset is + Deleting an existing preset is achieved by loading the preset first, then + clicking the Delete button (4). The preset will be + removed, and the preset selector turns blank, showing that no preset is currently loaded (although the settings will stay as they were).

    - diff --git a/include/vbap-panner.html b/include/vbap-panner.html index fb08bf3..4da43e2 100644 --- a/include/vbap-panner.html +++ b/include/vbap-panner.html @@ -1,8 +1,8 @@

    Ardour's VBAP panner is currently in development, and its semantics may - change in the near future, possibly affecting your mixes. Please do not - rely on it for important production work while the dust settles.
    + change in the near future, possibly affecting mixes using it. It is advised not + to rely on it for important production work while the dust settles.
    The Panner only works in fixed static mode, it does not support automation playback.

    @@ -15,7 +15,7 @@

    Basic concepts

    - VBAP was developed by Ville Pulkki at Aalto University, Helsinki, in 2001. + VBAP was developed by Ville Pulkki at Aalto University, Helsinki, in 1997. It works by distributing the signal to the speakers nearest to the desired direction with appropriate weightings, aiming to create a maximally sharp phantom source by using as few speakers as possible: @@ -28,15 +28,15 @@

  • and three speakers in the general 3D case.

    • - Thus, if you move the panner onto a speaker, you can be sure that only - this speaker will get any signal. This is handy when you need precise - 1:1 routing.
    + Thus, if the panner is moved onto a speaker, only this speaker will get any + signal. This is handy when precise 1:1 routing is needed. +

    +

    The drawback of VBAP is that a moving source will constantly change its - apparent sharpness, as it transitions between the three states mentioned - above. + apparent sharpness, as it transitions between the three states mentioned above.

    - A horizontal VBAP panner has one parameter, the azimuth + An horizontal VBAP panner has one parameter, the azimuth angle. A full-sphere panner offers an additional elevation angle control.

    @@ -49,6 +49,14 @@

    Speaker layout

    + +
    + The VBAP panner with 5 outputs +
    + The VBAP panner with 5 outputs +
    +
    +

    Each VBAP panner is specific to its speaker layout—the panner has @@ -56,17 +64,25 @@ implementation must therefore include the possibility to define this layout.

    -The VBAP panner with 5 outputs +

    Ardour currently uses a simplified approach: if a track or bus has more - than two output channels (which implies stereo), it assumes that you - have N speakers distributed in a regular N-gon. That means that for - irregular layouts such as 5.1 or 7.1, the direction you dial in will - differ a bit from the actual auditory result, but you can still achieve - any desired spatialisation. + than two output channels (which implies stereo), it assumes that there are + N speakers distributed in a regular N-gon. That means that for + irregular layouts such as 5.1 or 7.1, the direction dialed in will + differ a bit from the actual auditory result, but any desired spatialisation + can still be achieved.

    -

    Experimental 3D VBAP

    -The VBAP panner with 10 outputs, in experimental 3D mode + +

    Experimental 3D VBAP

    +
    + The VBAP panner with 10 outputs, in experimental 3D mode +
    + The VBAP panner with 10 outputs, in experimental 3D mode +
    +
    + +

    For tracks with 10 outputs, Ardour will currently assume a 3-dimensional speaker layout corresponding to Auro-3D 10.1, which is a horizontal 5.1 @@ -74,12 +90,18 @@ "voice-of-god" speaker at the zenith.

    -

    N:M panning

    -The VBAP panner in 4 in, 5 out mode +

    N:M panning

    + +
    + The VBAP panner in 4 in, 5 out mode +
    + The VBAP panner in 4 in, 5 out mode +
    +
    +

    For tracks and busses with more than one input, Ardour will (for now) assume that - you wish to distribute the inputs symmetrically along the latitude around + the inputs are distributed symmetrically along the latitude around the panner direction. The width parameter controls the opening angle of the distribution sector.

    - diff --git a/source/images/edit-export-format-profile.png b/source/images/edit-export-format-profile.png index 2c234ae..c296c26 100644 Binary files a/source/images/edit-export-format-profile.png and b/source/images/edit-export-format-profile.png differ diff --git a/source/images/export-dialog-channels.png b/source/images/export-dialog-channels.png index ff54b02..d13315e 100644 Binary files a/source/images/export-dialog-channels.png and b/source/images/export-dialog-channels.png differ diff --git a/source/images/export-dialog-file-format.png b/source/images/export-dialog-file-format.png index aa935d6..ff3caf0 100644 Binary files a/source/images/export-dialog-file-format.png and b/source/images/export-dialog-file-format.png differ diff --git a/source/images/export-dialog-stem-export.png b/source/images/export-dialog-stem-export.png index 3a0ad57..bd1e559 100644 Binary files a/source/images/export-dialog-stem-export.png and b/source/images/export-dialog-stem-export.png differ diff --git a/source/images/export-dialog-timespan.png b/source/images/export-dialog-timespan.png index 4a4879c..45e8253 100644 Binary files a/source/images/export-dialog-timespan.png and b/source/images/export-dialog-timespan.png differ