Skip to main content

gain​

gain(
    @gain 1
    @resamplingfiltersize 11
    @resamplingmode 'sinc'
    @ampunit 0
    @envampunit 0
    @envtimeunit 2
) -> llll

Generates an audio process operation for modifying a buffer's gain.

Arguments​

  • @gain [int/float/llll]: gain amount, as either a single number or envelope. (default: 1).
  • @resamplingfiltersize [int]: resampling filter size, in samples. (default: 11).
  • @resamplingmode [symbol]: resampling mode. (default: 'sinc').
    • 'sinc'
    • 'nearest neighbor'
    • 'sample and hold'
    • 'linear'
    • 'quad'
    • 'cubic'
  • @ampunit [int]: amplitude unit. (default: 0).
    • 0: linear
    • 1: decibels
  • @envampunit [int]: amplitude unit for @gain envelope. (default: 0).
    • 0: linear
    • 1: decibels
  • @envtimeunit [int]: time unit for @gain envelope. (default: 2).
    • 0: milliseconds
    • 1: samples
    • 2: duration ratio
    • 3: milliseconds difference
    • 4: samples difference

Output​

gain operation [llll]

Usage​

gain is meant to be used with the process function:

$buffer = importaudio('singing.wav'); ## input buffer
$op = gain([0 1 0] [1 0 -0.25]); ## processing operation
$buffer = $buffer.process($op); ## apply processing
$buffer.inspect('after gain process')