X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=include%2Fplugin-manager.html;h=14c2fe13dea0a917cda7e1033f6f13d20059720d;hb=a26b49e5c69ac38d5465c62623994e8a81f1b6b3;hp=4efe28a561d8a5d73ed4b02100aa4fd2cdc78db4;hpb=0310a5e092f41f6777502a8ffbdbc74bbba55959;p=ardour-manual diff --git a/include/plugin-manager.html b/include/plugin-manager.html index 4efe28a..14c2fe1 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.
-- 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.
-- 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... + 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.
+ +Status | +Ardour will displays the status of every plug-in file. See below + for more information | +
---|---|
Ign | +Do not load this plugin file at all | +
Fav | +Set or unset the Favorite status for a plugin | +
Hide | +Load this plugin file, but do not show it in the Plugin Selector | +
Type | +The name of the API this plugin has been built with: + VST2, VST3, AU, LADSPA, LV2 | +
File/ID | +Displays the file name for LADSPA, VST2, and VST3, as well as + the ID for LV2 and AU | +
Name | +User-visible name of the plugin | +
Creator | +Developer of team of developers who created the plugin | +
Tags | +Metadata that classifies the plugin by type, + e.g. 'instrument|synth' or 'analyser' | +
- 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. + The Status field specifically has the following options:
+ +OK | +The plugin file has loaded without any issues and the information + in the cache about it is up to date | +
---|---|
New | +The plugin file has just been discovered and successfully loaded + for the first time | +
Updated | +The plugin file changed on the disk, the plugin cache has been updated + accordingly, the plugin file loaded successfully | +
Concealed | +A VST2 plugin will be hidden from Plugin Selector, if a corresponding + VST3 plugin exists. The same applies to LV1 (LADSPA) and LV2 | +
Error | +There was a problem loading the plugin file | +
Stale | +A plugin changed on the disk but hasn't been re-scanned + by Ardour yet | +
Incompatible | +Scan the plugin failed. Typical reasons are 32/64-bit mismatch, + attempt to load a .dll on Linux or a .dylib on Windows | +
- 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. + 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.
-- 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. + 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
+- Adding or removing tags is as simple as editing the Tags for Selected Plugin - field while the targeted plugin is selected. + By default, Ardour will search through plugin names, makers, and file names. + Additionally, you can search through Type, Tags, and Paths.
+ +- 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. + This section of the sidebar contains commands that operate + on the plugins index.
-Discover New/Updated | +This will run a full scan on all known paths to plugin of all supported types | +
---|---|
Update Index Only | +This will check which plugins were updated without scanning them | +
Re-scan Selected | +This will re-scan plugin files selected in the main part of the window | +
Re-scan Faulty | +This will only re-scan plugins that previously failed to load | +
Re-scan All | +This will re-scan all currently known plugins | +
Clear Staled Scan Log | +This will remove all entries from the index on plugins that changed + on the disk but haven't been re-scanned | +
- 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. + 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.
-