Effects Preferences

Gale 12Aug14: I think it would be better if the Enable Effects types were links to the anchors in Effect Menu and if the note div then pointed that out.

• Peter 26Aug14: I provided links for all but VAMP - the only VAMP stuff I can find is on the Analyze Menu page - do we want to link there, as there is no reference at all to VAMP on te Effect Menu page?
• Gale 26Aug14: I added the link. Perhaps it is least confusing to move the note into the text (done)? LADSPA, LV2 and Nyquist plugins can also be generators but I don't think we want to get into that complexity.

Accessed by: Edit > Preferences... > Effects    (on a Mac Audacity > Preferences... > Effects)

Click on any of the other Preferences sections in the above image to go directly to that Preferences page.

Enable Effects

Provides controls to enable each type of effect supported by your operating system. The links in the list below provide installation instructions for each type of effect.

• Audio Unit: Check to enable Audio Unit effects (Mac only).
• LADSPA: Check to enable LADSPA effects.
• LV2: Check to enable LV2 effects.
• Nyquist: Check to enable Nyquist effects.
• VAMP: Check to enable VAMP analysis effects.
• VST: Check to enable VST effects. (Windows and Mac only)

You must exit and restart Audacity for these changes to take effect.

Effect Options

• Effects in menus are:
  • Sorted by effect name: Effects are listed in one long menu, sorted by effect name, with built-in effects above the divider and plugins below the divider.
  • Sorted by publisher and effect name: Effects are listed in one long menu, sorted by publisher and effect name, with built-in effects above the divider and plugins below the divider.
  • Sorted by type and effect name: Effects are listed in one long menu, sorted by type and effect name, with built-in effects above the divider and plugins below the divider.
  • Grouped by Publisher: Effects are listed in sub-menus, with sub-menus for each effect publisher. Sub-menus for built-in effects are above the divider and sub-menus for plugins are below the divider.
  • Grouped by type: Effects are listed in sub-menus, with sub-menus for each effect type. Sub-menus for built-in effects are above the divider and sub-menus for plugins are below the divider.
• Maximum effects per group (0 to disable): This setting affects how the effects are grouped if either of the "grouped by" options are chosen. Setting this to a value other than 0 will create sub-menus of the sub-menus for each publisher or type, with each sub-sub-menu containing the chosen maximum number of items.

Plugin Options

• Check for updated plugins when Audacity starts: When this option is checked, ToDo-1 what happens?
• Rescan plugins next time Audacity is started: When this option is checked, the next time Audacity is launched it will scan for plugins and display the "Register Plugins" dialog, detailed below.

Register Plugins dialog

• Bill 15Dec2014: Trying the Register Plugins dialog here.
  • ToDo-1 Does this work here?
  • ToDo-1 New image needed
  • ToDo-1 Is the 'advice' note still valid for VST on Windows?

When you use Audacity for the first time, or check "Rescan for plugins next time Audacity is started", it will scan for plugins. The following "Register Plugins" dialog will appear where you can choose which plugins to load into the Audacity Effect Menu.

The loading of LADSPA, VST and Audio Unit plugin effects is controlled by this dialog. All LV2 and Nyquist plugin effects detected by Audacity will always load. Audacity's built-in effects always load.

If you don't see the dialog as expected, you can use ALT + TAB to task switch to the dialog or press the "Audacity is starting up..." Windows Taskbar button. On Mac, use OPTION + TAB to task switch.

The names of the detected plugins will be listed alphabetically for each folder in the Path column. All list items have their checkboxes checked by default, the green checkmark indicating that the plugin will be loaded. To load all the detected plugins, just click OK then Audacity itself will launch. If you deselect some items by mistake, you can quickly re-enable the entire list by choosing the Select All button. The Clear All button lets you disable the entire list. This provides a quick method of then enabling only a few plugins in a long list.

To disable loading of a specific plugin, left-click the item's row or checkbox which removes the checkmark. Similarly, click to re-enable a disabled item. Using the keyboard, press Up arrow, Down arrow, Page Up or Page Down to navigate the list then press Space to check or uncheck the current item's checkbox. Finally, click OK to load the enabled plugins and launch Audacity.

The black arrow in the list (as in the image above) indicates which plugin is currently being loaded.

Providing you click OK and the enabled plugins load successfully, then next time you launch Audacity there will be no Register Plugins dialog. The plugins that you previously enabled in the dialog will appear in the Effect menu, ready to be used when you select them.

If you click Cancel in the dialog or if loading a faulty plugin causes Audacity to crash, the "Register Plugins" dialog will appear again next time you launch Audacity. If Audacity crashed you can therefore use the dialog to experiment by disabling plugins that may have crashed. Alternatively, before restarting Audacity you can look in the pluginregistry.cfg file in the Audacity folder for application data. This file will list which plugins Audacity had managed to load before it crashed.

Audacity looks in the following locations for plugins controlled by this dialog

• VST:
  • Mac and Windows:
    • The Audacity plug-ins folder:
      • On Windows and OS X the "plug-ins" folder is in the directory where Audacity resides - usually C:\Program Files on Windows or the "Applications" folder on OS X.
  • Windows:
    • C:\Program Files\Steinberg\VSTPlugins (or C:\Program Files (x86)\Steinberg\VSTPlugins on 64-bit systems).
    • Windows Registry key HKCU\Software\VST\VSTPluginsPath
    • Windows Registry key HKLM\Software\VST\VSTPluginsPath
    • The path specified by the "VST_PATH" environment variable
  • Mac OS X:
    • ~/Library/Audio/Plug-Ins/VST
    • /Library/Audio/Plug-Ins/VST
    • The path specified by the "VST_PATH" environment variable

Gale 03Aug14: ToDo Paths are needed where VST's are searched for on Linux.

• Steve 10Aug14: VST disabled on Linux for 2.0.6 so downgraded to Px.
• Linux:

• LADSPA:
  • All operating systems:
    • The path specified by the LADSPA_PATH environment variable
    • The Audacity plug-ins folder
      • On Windows and OS X the "plug-ins" folder is in the directory where Audacity resides - usually C:\Program Files on Windows or the "Applications" folder on OS X.
      • On Linux, the "plug-ins" folder is in usr/share/audacity if you installed an Audacity package supplied by your distribution, or usr/local/share/audacity if you compiled Audacity from source code. Optionally a plugin folder can be created in the home directory ~/.audacity-files/plug-ins.
  • additionally on OS X:
    • ~/Library/Audio/Plug-Ins/LADSPA
    • /Library/Audio/Plug-Ins/LADSPA
  • additionally on Linux/Unix:
    • ~/.ladspa
    • /usr/local/lib/ladspa
    • /usr/lib/ladspa
    • $LIBDIR/ladspa

• Audio Units:
  • Macintosh:
    • ~/Library/Audio/Plug-Ins/Components (user plugins)
    • /Library/Audio/Plug-Ins/Components (system-wide plugins)

Gale 10Aug14: ToDo "and Linux" needs adding to below sentence when Audacity supports VST Linux.

The "Install VST Effects" dialog will list extra files on Windows that are not VST effects. Gale 04Aug14: ToDo Any 64-bit VST's on Linux probably are seen by 64-bit builds of Audacity, which needs testing. Steve 10Aug14: VST disabled on Linux for 2.0.6 so downgraded to Px. The list will include VST instruments, 64-bit VST effects and VST 3 plugins. Audacity does not support any of these and therefore these will not load. On Windows, the two shipped LADPSA plugins (hard_limiter_1413.dll and sc4_1882.dll) will also be listed, as will any optional LADSPA DLL plugins you may have installed. These LADSPA plugins will load whether you enable them in the dialog or not. Steve 10Aug14: Currently disabled on Linux. Similarly on Linux, all SO plugin files will be listed in the locations searched for VST's, even if those files are LADSPA or LV2 plugins that are already installed.