Shamusworld >> Repos - ardour-manual/blob - include/plugin-manager.html

   1
   2 <p>
   3   The <dfn>Plugin Manager</dfn> provides a convenient interface to various
   4   operations on plugins and is the primary troubleshooting tools when something
   5   goes wrong with plugins. It works on both physical plugin files and
   6   the plugins index.
   7 </p>
   8
   9 <figure class=center>
  10 <img src="/images/plugin-manager.png" alt="The Plugin Manager window" width="100%" />
  11 <figcaption class=center>The Plugin Manager window</figcaption>
  12 </figure>
  13
  14 <h2>What is a plugins index?</h2>
  15
  16 <p>
  17   For each type of a plugin (e.g. VST3 or LV2) there are pre-configured paths
  18   where these plugins are located. Every time Ardour runs, it re-scans plugins
  19   in these paths and recreates an index — a kind of inventory of available
  20   plugins. Whenever you open the <a href="@@plugin-selector">Plugin Selector</a>
  21   dialog, Ardour reads the list of available plugins from that index and
  22   displays them for you to pick.
  23 </p>
  24
  25 <p>
  26   Re-scanning paths is important because it's common for plugins to change on
  27   the disk (e.g. when you installed a newer version) or get removed (when you
  28   don't need a plugin anymore). Sometimes plugins get corrupted due to
  29   a hardware failure. Indexing them often helps identifying issues early on,
  30   and the Plugin Manager helps reviewing the general state of affairs with
  31   plugins.
  32 </p>
  33
  34 <h2>Plugins info</h2>
  35
  36 The main part of the Plugin Manager window is the table where all plugins known
  37 to Ardour are listed. You can use it to both view information about a plugin and
  38 control some of its aspects:
  39
  40 <table class="dl">
  41   <tr>
  42       <th>Status</th>
  43       <td>Ardour will displays the status of every plug-in file. See below
  44       for more information</td>
  45   </tr>
  46   <tr>
  47       <th>Ign</th>
  48       <td>Do not load this plugin file at all</td>
  49   </tr>
  50   <tr>
  51       <th>Fav</th>
  52       <td>Set or unset the Favorite status for a plugin</td>
  53   </tr>
  54   <tr>
  55       <th>Hide</th>
  56       <td>Load this plugin file, but do not show it in the Plugin Selector</td>
  57   </tr>
  58   <tr>
  59       <th>Type</th>
  60       <td>The name of the API this plugin has been built with:
  61       VST2, VST3, AU, LADSPA, LV2</td>
  62   </tr>
  63   <tr>
  64       <th>File/ID</th>
  65       <td>Displays the file name for LADSPA, VST2, and VST3, as well as
  66       the ID for LV2 and AU</td>
  67   </tr>
  68   <tr>
  69       <th>Name</th>
  70       <td>User-visible name of the plugin</td>
  71   </tr>
  72   <tr>
  73       <th>Creator</th>
  74       <td>Developer of team of developers who created the plugin</td>
  75   </tr>
  76   <tr>
  77       <th>Tags</th>
  78       <td>Metadata that classifies the plugin by type,
  79       e.g. 'instrument|synth' or 'analyser'</td>
  80   </tr>
  81 </table>
  82
  83 <p>
  84   The Status field specifically has the following options:
  85 </p>
  86
  87 <table class="dl">
  88   <tr>
  89     <th>OK</th>
  90     <td>The plugin file has loaded without any issues and the information
  91     in the cache about it is up to date</td>
  92   </tr>
  93   <tr>
  94     <th>New</th>
  95     <td>The plugin file has just been discovered and successfully loaded
  96     for the first time</td>
  97   </tr>
  98   <tr>
  99     <th>Updated</th>
 100     <td>The plugin file changed on the disk, the plugin cache has been updated
 101     accordingly, the plugin file loaded successfully</td>
 102   </tr>
 103   <tr>
 104     <th>Concealed</th>
 105     <td>VST2 if corresponding VST3 exists.  same for LV1 when LV2 exists</td>
 106   </tr>
 107   <tr>
 108     <th>Error</th>
 109     <td>There was a problem loading the plugin file</td>
 110   </tr>
 111   <tr>
 112     <th>Stale</th>
 113     <td>A VSTx/AU plugin changed on the disk but hasn't been re-scanned
 114     by Ardour yet</td>
 115   </tr>
 116   <tr>
 117     <th>Incompatible</th>
 118     <td>Scan the plugin failed. Typical reasons are 32/64-bit mismatch,
 119     attempt to load a .dll on Linux or a .dylib on Windows</td>
 120   </tr>
 121 </table>
 122
 123 <p>
 124   The <kbd class="menu">Plugin Count</kbd> section in the sidebar provides
 125   basic information on available plugins: how many plugins of every supported
 126   type are available through Ardour in total, how many failed to load, and
 127   how many are missing.
 128 </p>
 129
 130 <h2>Searching</h2>
 131
 132 <p>
 133   FIXME
 134 </p>
 135
 136 <h2>Scan actions</h2>
 137
 138 <p>
 139   FIXME
 140 </p>
 141
 142 <h2>Preferences</h2>
 143
 144 <p>
 145   FIXME
 146 </p>
 147