diff --git a/include/additional-resources.html b/include/additional-resources.html index 6628cc21..17081cc2 100644 --- a/include/additional-resources.html +++ b/include/additional-resources.html @@ -7,7 +7,7 @@ diff --git a/include/bundle-manager.html b/include/bundle-manager.html new file mode 100644 index 00000000..c402deb2 --- /dev/null +++ b/include/bundle-manager.html @@ -0,0 +1,76 @@ +

+ The Bundle Manager simplifies connecting I/O channels in cases + where similarly purposed instruments/mics are scattered across + a multi-channel audio interface. A common scenario is recording a drumkit + with 6 mics. If you need to re-route the mics in the session, instead of + connecting each and every one of them separately, you can create a bundle + and connect just the bundle. +

+

+ Bundles can be created for both sources (e.g. mic inputs) and destinations + (e.g. studio monitors). You can create as many bundles as you like. +

+ +
+ Bundle Manager main window +
+ Bundle Manager main window +
+
+ +

Creating a bundle

+ +

+ Click New button to create a new bundle. + In the newly opened dialog, give it a name, choose whether you want this + to be a bundle of source or destination channels, then connect the ports + that you want to collect to the bundle port. +

+ +
+ Bundle Manager connection setup +
+ Bundle Manager connection setup +
+
+ +

+ Close the dialog to apply changes. +

+ +

Connecting a bundle

+ +

+ When you connect a bundle to a port, it works as a convenience proxy + for the physical ports. Clicking to connect a bundle to an output + automatically creates connections in the actual ports. +

+ +
+ Bundle routing in the Audio Connection Manager +
+ Bundle routing in the Audio Connection Manager +
+
+ +

Editing and deleting bundles

+ +

+ At any time you can re-open the Bundle Manager window, select a bundle, + click Edit and change connection of physical + ports to the bundle. Close the window to apply changes. +

+ +

+ You can easily delete an existing bundle. Open the Bundle Manager window, + select a bundle, click Delete. +

+ +

Reusing bundles

+ +

+ As bundles are part of a session rather than a global setting, you can + save them as part of a template for further reuse. Simply create a new + session, create and connect tracks, busses, and bundles, then save your + session as a template. Choose this template when creating a new session. +

\ No newline at end of file diff --git a/include/import-dialog.html b/include/import-dialog.html index 9fb0a5a9..3fb1d81d 100644 --- a/include/import-dialog.html +++ b/include/import-dialog.html @@ -1,6 +1,6 @@
- The import window + The import window
The import window.
@@ -15,8 +15,10 @@

Importing audio and MIDI data into the session is done with the - Add Existing Media dialog, accessed by the - Session > Import menu. + Add Existing Media dialog, accessed either by the + Session > Import menu or, if any tracks have + already been added, by right-clicking on the canvas of the Editor + window and choosing Insert Existing Media.

The Soundfile Information Box

@@ -88,6 +90,34 @@ quality of the resampling process, if the sampling rate of the source file differs from the session rate.

+

+ There are three MIDI-specific options as well. First off, you can set a track + naming scheme: +

+ + + + +
by track numberwill automatically assign every track a name that consists of the imported file name and a track number
by track namewill
by instrument namewill
+

+

+ You can also optionally import a tempo map from a MIDI file. + The Use MIDI Tempo Map (if defined) option appears + when a MIDI file is selected in the file selection dialog. +

+

+ The last MIDI-specific option is Import MIDI Markers + (if any). If those are present in a MIDI file, they will be rendered + right above MIDI clips on the canvas. Editing the MIDI markers is currently + unavailable. +

+
+ MIDI markers imported from a .mid file +
+ MIDI markers imported from a .mid file +
+
+

Finally, and most importantly, the files can be linked or copied to the session with the Copy files to session checkbox. Please read diff --git a/include/microsoft-windows.html b/include/microsoft-windows.html index c4adf9ff..b1935afb 100644 --- a/include/microsoft-windows.html +++ b/include/microsoft-windows.html @@ -6,20 +6,29 @@

Installing Ardour

    -
  1. Download the latest windows build from the download page.
  2. -
  3. Run the installer and follow the prompts.
  4. +
  5. + Download the latest windows build from the download page. +
  6. +
  7. + Run the installer and follow the prompts. +

How to help

diff --git a/include/monitor-setup-in-ardour.html b/include/monitor-setup-in-ardour.html index 25faf448..5935e929 100644 --- a/include/monitor-setup-in-ardour.html +++ b/include/monitor-setup-in-ardour.html @@ -1,50 +1,22 @@ -

Ardour has three main settings which affect how - monitoring is performed. The first is - Edit > Preferences > Monitoring > - Record monitoring handled by. There are two or three - options here, depending on the capabilities - of the hardware. -

-

The other two settings are more complex. One is - Tape machine mode, found in the - same dialog, and the other is the - Session > Properties > Monitoring - automatically follows transport state setting. +

+ Ardour has two main settings which affect how monitoring is performed. + The first is Edit > Preferences > Monitoring > + Record monitoring handled by. There are two or three options here, + depending on the capabilities of the hardware.

- Monitoring also depends on the state of the track's record-enable button, - the session record-enable button, and on whether or not the transport is - rolling. + The other setting is the Session > Properties > + Track Input Monitoring automatically follows transport state + (auto-input). +

+

+ Monitoring also depends on the state of the track's record-enable button + and the session record-enable button, as well as on whether or not the + transport is rolling.

-

Software or Hardware Monitoring Modes

If Ardour is set to external monitoring, Ardour does not do any monitoring.

- -

Monitoring in Non-Tape-Machine Mode

-

- When Tape-Machine mode is off, and a track is armed, Ardour - always monitors the live input, except in one case: if the transport is - rolling, the session is not recording, and auto-input is active, - the playback from an armed track will be heard. -

-

- Unarmed tracks will play back their contents from disc, unless the - transport is stopped and auto-input is enabled. - In this case, the track monitors its live input. -

- -

Monitoring in Tape-Machine Mode

- -

- In Tape-Machine mode, when a track is armed, its behaviour is - the same as in non-tape-machine mode. -

-

- Unarmed tracks however will always just play back their contents from - disk; the live input will never be monitored. -

- diff --git a/include/performance-meters.html b/include/performance-meters.html new file mode 100644 index 00000000..1d6ace1c --- /dev/null +++ b/include/performance-meters.html @@ -0,0 +1,17 @@ +

+ The Performance Meters window provides low-level metering + of the digital signal processing taking place inside Ardour. + One of the scenarios where this is useful is when you need to determine + whether Ardour is in charge for excessive xruns. +

+ +
+The Performance Meters window +
The Performance Meters window
+
+ +

+ This window displays worst case scenario measurements that do not necessarily match the DSP meter in the top right corner of the window. To see average + and standard deviation values, hover either the Engine or the Session values + with the mouse pointer to see the tooltip. +

diff --git a/include/plugin-dsp-load.html b/include/plugin-dsp-load.html new file mode 100644 index 00000000..e25b4351 --- /dev/null +++ b/include/plugin-dsp-load.html @@ -0,0 +1,44 @@ +

+ The Plugin DSP Load window is helpful in cases where + some of the plugins need too much CPU time to process buffers, + resulting in audible clicks and pops in the output, but you aren't + quire sure which ones are causing this exactly or you do know, + but you need actual stats. +

+ +
+The Plugin DSP Load window +
The Plugin DSP Load window
+
+ +

+ For each plugin in use, there is a chart and numeric data that represents + minumum, maximum, and average CPU time used, as well as standard deviation. + This, along with simple color coding — green for safe amount of CPU time, + red for too much CPU time required — gives you a good overview of what's + going on in the session. +

+ +
+The Plugin DSP Load window +
Plugin DSP Load chart legend
+
+ + +

+ The Plugin DSP Load window has basic sorting options: by worst-case load + or by average load. This helps easily locating the worst offenders. You + can also click to reset all stats. +

+ +

+ You can use the data provided by the Plugin DSP Load window to decide + whether you want to replace a plugin with a less resource-hungry one, + freeze a track, or report a potential bug to the plugin's developer and + wait for an update. +

+ +

+ It's worth noting that certain type of plugins, like convolution reverbs + and guitar amp simulators, tend to consume more resources. +

\ No newline at end of file diff --git a/include/plugin-manager.html b/include/plugin-manager.html index 4efe28a5..14c2fe13 100644 --- a/include/plugin-manager.html +++ b/include/plugin-manager.html @@ -1,93 +1,191 @@

- The Plugin Selector serves two purposes. Primarily it is used to - control the display status of plugins. It can also be used to find and insert - plugins into the Processor Box. It is - displayed either by a double-click in the Processor Box or by - choosing New Plugin > Plugin Selector… - from the Processor Box context menu. -

- -

- Displayed for each plugin is the status (favorite, hidden), - name, tags, creator (author), type, and the number of audio and MIDI - connections. The plugins can be sorted by clicking on a column header. + The Plugin Manager provides a convenient interface to various + operations on plugins and is the primary troubleshooting tools when something + goes wrong with plugins. It works on both plugin files and the plugins index.

-The Plugin Selector window -
The Plugin Selector window.
+The Plugin Manager window +
The Plugin Manager window
-

Plugin Display Status

+

What is a plugins index?

- Clicking on a Fav(orite) or Hide radio button changes - a plugin's display status. - Clicking on an already selected radio button will cancel it, returning the - plugin to the normal display status. Plugins marked as a favorite show up in - the Processor Box context menu under - New Plugin > Favorites and in the - Favorite Plugins window. Setting the hide - radio button on a plugin will keep the plugin from showing in the - Processor Box context menus - New Plugin > By Creator or - New Plugin > By Category. + For each type of a plugin (e.g. VST3 or AU) there are pre-configured paths + where these plugins are located. Every time Ardour runs, it re-scans plugins + in these paths and recreates an index — a kind of inventory of available + plugins. Whenever you open the Plugin Selector + dialog, Ardour reads the list of available plugins from that index and + displays them for you to pick.

-

Filtering Listed Plugins

-

- The bottom left part of the Plugin Selector is used to filter the listed + Re-scanning paths is important because it's common for plugins to change on + the disk (e.g. when you installed a newer version) or get removed (when you + don't need a plugin anymore). Sometimes plugins get corrupted due to + a hardware failure. Indexing them often helps identifying issues early on, + and the Plugin Manager helps reviewing the general state of affairs with plugins.

-

- The center Filter column allows to show only some of the plugins, based - on what they are, their properties, format, creator... -

-

- Moreover, direct text search are available in the the Search text-field - on the bottom left. Only the plugins that match all the search terms - (space separated) will show up in the upper list. -

-

- This textual search can be matched against Name and/or Tags by checking - the relevant momentary buttons under the search field. - Ignore Filters when searching displays all the matching - plugins, regardless of the active Filters. -

- -

Tags

- Tags are text labels that can be used to mark a plugin. They are totally - free in their content, allowing the user to mark a plugin with whatever - info is relevant to him, but cannot include spaces (as spaces are used - to separate tags) or special characters except dashes, colons and underscores. -

-

- Adding or removing tags is as simple as editing the Tags for Selected Plugin - field while the targeted plugin is selected. -

-

- Ardour comes with a large selection of tags for provided or usual plugins, - that are used by default but can be modified at will. It is possible to - go back to this "standard" tagging for a plugin by clicking the - Reset button. + Ardour also treats LV2 plugins slightly differently and scans them on startup + unconditionally. You can disable the scanning of VST2, VST3, and AU plugins + entirely in the Preferences dialog.

-

Inserting Plugins in the Processor Box

+

Plugins info

+ +The main part of the Plugin Manager window is the table where all plugins known +to Ardour are listed. You can use it to both view information about a plugin and +control some of its aspects: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusArdour will displays the status of every plug-in file. See below + for more information
IgnDo not load this plugin file at all
FavSet or unset the Favorite status for a plugin
HideLoad this plugin file, but do not show it in the Plugin Selector
TypeThe name of the API this plugin has been built with: + VST2, VST3, AU, LADSPA, LV2
File/IDDisplays the file name for LADSPA, VST2, and VST3, as well as + the ID for LV2 and AU
NameUser-visible name of the plugin
CreatorDeveloper of team of developers who created the plugin
TagsMetadata that classifies the plugin by type, + e.g. 'instrument|synth' or 'analyser'

- The bottom-right part of the Plugin Selector Plugins to be connected - shows plugins that have been selected for insertion into the - Processor Box. A plugin can be added by either double clicking - the plugin entry in the top part, or, if already selected in top left part, - by clicking the Add button. -

- -

- Plugins can be removed from the right part with a double click, or, if - already selected, by clicking Remove. + The Status field specifically has the following options:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OKThe plugin file has loaded without any issues and the information + in the cache about it is up to date
NewThe plugin file has just been discovered and successfully loaded + for the first time
UpdatedThe plugin file changed on the disk, the plugin cache has been updated + accordingly, the plugin file loaded successfully
ConcealedA VST2 plugin will be hidden from Plugin Selector, if a corresponding + VST3 plugin exists. The same applies to LV1 (LADSPA) and LV2
ErrorThere was a problem loading the plugin file
StaleA plugin changed on the disk but hasn't been re-scanned + by Ardour yet
IncompatibleScan the plugin failed. Typical reasons are 32/64-bit mismatch, + attempt to load a .dll on Linux or a .dylib on Windows
+ +

+ The Plugin Count section in the sidebar provides + basic information on available plugins: how many plugins of every supported + type are available through Ardour in total, how many failed to load, and + how many are missing. +

+ +

Searching

+ +

+ You can search for a specific plugin or a group of plugins. Simply place the + cursor inside the input text box in the upper left corner and type. Ardour + will search in the index +

+ +

+ By default, Ardour will search through plugin names, makers, and file names. + Additionally, you can search through Type, Tags, and Paths. +

+ +

Scan actions

+ +

+ This section of the sidebar contains commands that operate + on the plugins index. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Discover New/UpdatedThis will run a full scan on all known paths to plugin of all supported types
Update Index OnlyThis will check which plugins were updated without scanning them
Re-scan SelectedThis will re-scan plugin files selected in the main part of the window
Re-scan FaultyThis will only re-scan plugins that previously failed to load
Re-scan AllThis will re-scan all currently known plugins
Clear Staled Scan LogThis will remove all entries from the index on plugins that changed + on the disk but haven't been re-scanned
+ +

Preferences

+ +

+ This section of the sidebar allows settings paths to VST2 and VST3 plugins, + as well as quickly open the Preferences dialog + on the Plugins page where you can set various options + for scanning plugins and controlling their default behavior. +

diff --git a/include/plugin-selector.html b/include/plugin-selector.html new file mode 100644 index 00000000..4efe28a5 --- /dev/null +++ b/include/plugin-selector.html @@ -0,0 +1,93 @@ + +

+ The Plugin Selector serves two purposes. Primarily it is used to + control the display status of plugins. It can also be used to find and insert + plugins into the Processor Box. It is + displayed either by a double-click in the Processor Box or by + choosing New Plugin > Plugin Selector… + from the Processor Box context menu. +

+ +

+ Displayed for each plugin is the status (favorite, hidden), + name, tags, creator (author), type, and the number of audio and MIDI + connections. The plugins can be sorted by clicking on a column header. +

+ +
+The Plugin Selector window +
The Plugin Selector window.
+
+ +

Plugin Display Status

+ +

+ Clicking on a Fav(orite) or Hide radio button changes + a plugin's display status. + Clicking on an already selected radio button will cancel it, returning the + plugin to the normal display status. Plugins marked as a favorite show up in + the Processor Box context menu under + New Plugin > Favorites and in the + Favorite Plugins window. Setting the hide + radio button on a plugin will keep the plugin from showing in the + Processor Box context menus + New Plugin > By Creator or + New Plugin > By Category. +

+ +

Filtering Listed Plugins

+ +

+ The bottom left part of the Plugin Selector is used to filter the listed + plugins. +

+

+ The center Filter column allows to show only some of the plugins, based + on what they are, their properties, format, creator... +

+

+ Moreover, direct text search are available in the the Search text-field + on the bottom left. Only the plugins that match all the search terms + (space separated) will show up in the upper list. +

+

+ This textual search can be matched against Name and/or Tags by checking + the relevant momentary buttons under the search field. + Ignore Filters when searching displays all the matching + plugins, regardless of the active Filters. +

+ +

Tags

+ +

+ Tags are text labels that can be used to mark a plugin. They are totally + free in their content, allowing the user to mark a plugin with whatever + info is relevant to him, but cannot include spaces (as spaces are used + to separate tags) or special characters except dashes, colons and underscores. +

+

+ Adding or removing tags is as simple as editing the Tags for Selected Plugin + field while the targeted plugin is selected. +

+

+ Ardour comes with a large selection of tags for provided or usual plugins, + that are used by default but can be modified at will. It is possible to + go back to this "standard" tagging for a plugin by clicking the + Reset button. +

+ +

Inserting Plugins in the Processor Box

+ +

+ The bottom-right part of the Plugin Selector Plugins to be connected + shows plugins that have been selected for insertion into the + Processor Box. A plugin can be added by either double clicking + the plugin entry in the top part, or, if already selected in top left part, + by clicking the Add button. +

+ +

+ Plugins can be removed from the right part with a double click, or, if + already selected, by clicking Remove. +

+ diff --git a/include/preferences.html b/include/preferences.html index 48285631..5dd57c2c 100644 --- a/include/preferences.html +++ b/include/preferences.html @@ -164,13 +164,13 @@ GUI Lock