Nyquist Plug-ins

From Audacity Wiki
Jump to: navigation, search
Audacity supports Nyquist  effects on all operating systems, and includes a number of Nyquist plug-ins. You can download additional Nyquist plug-ins, edit their behavior, or even write your own. Nyquist Plug-ins are merely plain text files which can be opened and studied using any simple text editor. That's how many people learned Nyquist programming!
 
Related article(s):


Plug-in Downloads

We host a large collection of Nyquist plug-ins for use in Audacity.


Installation

On Windows and OS X, place new Nyquist plug-ins in the Plug-Ins folder inside your Audacity installation folder and restart Audacity. Your installation folder is usually under C:\Program Files on Windows computers, or under Mac Hard Disk > Applications on OS X.

On Linux, place new Nyquist plug-ins in one of the following locations:

  • /usr/share/audacity/plug-ins if Audacity was installed from a repository package
  • /usr/local/share/audacity/plug-ins if you compiled Audacity from source code
  • ~/.audacity-files/plug-ins which is a per-user directory for which super-user privileges are not required (Note: The .audacity-files folder is not created during installation so must be created manually)
  • in a Nyquist directory specified in the AUDACITY_PATH environment variable.

Restart Audacity then new plug-ins will be visible in either the Effect, Analyze, or Generate menu depending on the Nyquist plug-in's defined type.

For those using an Audacity package provided by their distribution: Generally it is better *not* to put extra plug-ins in /usr/share/audacity/plug-ins. This is because a new Audacity package may overwrite those extra plug-ins.

Exploring further

To learn more about Nyquist programming, why not load the .lsp files from the Audacity "Nyquist" folder or the .ny files from the Audacity "Plug-Ins" folder into your favorite text editor and try to find out how they work? There is some introductory advice on this page of the main Audacity web site. Additional information about programming Nyquist plug-ins can be found at Nyquist Plug-ins Reference.

If you are especially interested in Nyquist in Audacity, we strongly recommend visiting the Nyquist board of the Audacity Forum (you can subscribe to any board or forum by clicking "Subscribe forum" at the bottom of the relevant page). There is also an audacity-nyquist mailing list that sometimes has topics regarding development of Audacity's Nyquist interface.

There is no Nyquist console in Audacity, but you can use Effect > Nyquist Prompt to run a single Nyquist command. Code for Nyquist plug-ins that generate audio can be quickly tested (without having to select audio first) with this Nyquist Generate Prompt. If you can compile Audacity, you can use an Audacity module called Nyquist Workbench to run Nyquist code in a graphical interface.

Personal tools