buffir~ Reference

buffer-based FIR filter

buffir~

Description

Use buffir~ object when you need a finite impulse response (FIR) filter that convolves an input signal with samples from an input buffer.

Examples

buffir~ lets you use slices of a buffer~ as an impulse response for an FIR filter

Arguments

buffer-name [symbol]

The name of a buffer~ object which buffir~ uses to filter the input signal.

read-offset [int or float]

Optional
Unitssamples

The offset, in samples, into the buffer~ object before buffir~ begins reading samples to construct the filter. The default is 0.

read-duration [int or float]

Optional
Unitssamples

The size, in samples, of the slice in the buffer~ which buffir~ will use for the filter. The default is 0, and the maximum is 4096.

Attributes

Common Box Attributes

Messages

int

Arguments

read-offset [int]
In middle inlet: The offset into the filter buffer~ from which buffir~ begins to read, in samples.

In right inlet: The size (in samples) of the slice from the buffer~ which is used to filter the input signal (the maximum is 4096).

float

Arguments

read-offset [float]
In middle inlet: The offset into the filter buffer~ from which buffir~ begins to read, in samples.

In right inlet: The size (in samples) of the slice from the buffer~ which is used to filter the input signal (the maximum is 4096).

clear

The word clear erases (zeroes) the current input history for the filter.

(mouse)

Double-clicking on buffir~ opens a display window where you can view the contents of the buffir~ object.

set

Arguments

buffer-name [symbol]
read-offset [int]
read-duration [int]
The word set, followed by the name of a buffer~ object, an int which specifies sample offset, and an optional int which specifies a number of samples, specifies the name of a buffer~ object which buffir~ uses to filter its input signal.

signal

In left inlet: The signal to be convolved with samples from the buffer~.

In middle inlet: The offset (in samples) into the filter buffer~ from which the buffir~ object begins to read.

In right inlet: The size of the slice from the filter buffer~ which is used to filter the input signal, in samples. The maximum is 4096.

Output

signal

The filtered signal, based on a convolution of the input signal with samples in the buffer~.

See Also

Name Description
Sound Processing Techniques Sound Processing Techniques
biquad~
buffer~
cascade~
Audio Filtering Audio Filtering