Audacity Dev
Githubaudacityteam.org
en - English (main)
en - English (main)
  • Audacity Dev resources
  • Getting started
    • BUILDING.md
    • Introduction to Audacity development
    • Codebase overview
    • Coding standards
      • Making Audacity Doxygenable
    • Strings & translatable code
  • Scripting
    • Developing your own plugins and scripts
    • Scripting reference
    • Creating your own Nyquist Plugins
      • Headers Reference
      • Plugin Reference
      • Widgets Reference
      • Basics
        • Delay Basics
        • Independent Stereo Volume Basics
        • Prompt Basics
        • Volume Basics
      • Tutorials
        • File Button Tutorial
        • Macro Tutorial
        • Property List Tutorial
        • Stereo Tracks Tutorial
        • The *SCRATCH* Symbol Tutorial
    • Creating custom themes
  • Refactoring
    • 4 steps to make an effect stateless
Powered by GitBook
On this page
  • LISP vs SAL
  • Changing the Volume of an Audacity Track
Edit on GitHub
Export as PDF
  1. Scripting
  2. Creating your own Nyquist Plugins
  3. Basics

Volume Basics

This page explains how to use Nyquist to change the volume of Audacity tracks in different ways.

PreviousPrompt BasicsNextTutorials

Last updated 2 years ago

Note: All [comments] and [explanations] are written in square brackets, so they cannot be confused with (Lisp code).

LISP vs SAL

SAL is a new alternative syntax to LISP. Although Nyquist is based on the LISP programming language, you can write almost any Nyquist program in SAL. Most people prefer SAL syntax to LISP syntax because SAL is a bit more like popular programming languages that include Java, C, and Python.

You can specify which one you're using with the respective :

;codetype lisp
;codetype sal

You can only use one or the other in your script.

Changing the Volume of an Audacity Track

To change the volume of an Audacity track with Nyquist, the easiest way is to use the Nyquist function:

(scale number sound)

scale(number, sound)

The "scale" function multiplies the amplitude [volume] of the "sound" by the given "number". A number of 0.5 will make the sound become only half as loud as before, while a number of 2 will make the sound become double as loud as before.

Example:

See for an explanation how the Nyquist prompt works.

  • To run this example in the Nyquist Prompt, ensure that "Use legacy (version 3) syntax" is not selected.

  • For more information about the *track*** ** keyword, refer to the

1. Create an audio track with some audio [eg a short recording]

2. Now click Tools > Nyquist Prompt. A window with a text field will appear where you can type in:

(scale 0.5 *track*)

Important: Do not forget to type the parentheses. The parentheses are part of the Lisp language Nyquist is based on. Without the parentheses the Nyquist Lisp interpreter will not be able to understand your code.

return scale(0.5, *track*)

Important: Do not forget to type the parens and comma. These are part of the SAL language.

After clicking "OK" in the "Nyquist Prompt" window the "scale" function will take the Audacity sound and return a "scaled-down" sound with half the volume to Audacity. The result of the last computation of the Nyquist code always gets automatically returned to Audacity.

If you try "scale" with big numbers you will notice that you can return sounds with volumes taller than the Audacity track which will sound very distorted if you play them afterwards in Audacity. So an important lesson to learn is that Nyquist gives you the freedom to do whatever you want but it's now on you to take care that the result will still sound good afterwards.

MULT may be used with numbers, sounds or multi-channel sounds. When using MULT with a sound and a number, each sample value in the selected sound is multiplied by the number, which is essentially the same as using the SCALE command.

(mult *track* 0.5)
return mult(*track*, 0.5)

An alternative command for amplifying a sound is the command.

MULT
SCALE
Prompt Basics
Plugin Reference
codetype header