buffir~
buffer-based FIR filter
Description
Use buffir~ object when you need a finite impulse response (FIR) filter that convolves an input signal with samples from an input buffer.
Arguments
buffer-name[symbol]
optional
read-offset[int or float]samples
optional
Attributes
Common Box Attributes
annotation[symbol]
Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.
background[int]: 0
Adds or removes the object from the patcher's background layer.
adds the object to the background layer, removes it. Objects in the background layer are shown behind all objects in the default foreground layer.
color[4 floats]
Sets the color for the object box outline.
fontface[int]
Sets the type style used by the object. The options are:
plain
bold
italic
bold italic
Possible values:
0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'
fontname[symbol]
Sets the object's font.
fontsize[float]
Sets the object's font size (in points).
Possible values:
'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'
hint[symbol]
Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.
ignoreclick[int]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
JS Painter File
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.
presentation[int]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 0. 0. 0. 0.
Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.
rect[4 floats]
write-only
Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).
size[2 floats]
write-only
Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.
textcolor[4 floats]
Sets the color for the object's text in RGBA format.
textjustification[int]
Sets the justification for the object's text.
Possible values:
0 = 'left'
1 = 'center'
2 = 'right'
varname[symbol]
Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.
Messages
int
float
clear
The word
erases (zeroes) the current input history for the filter.
(mouse)
set
The word 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.
, followed by the name of a- buffer-name
[symbol]
- read-offset
[int]
- read-duration
[int]
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 |
---|---|
biquad~ | Two-pole, two-zero filter |
buffer~ | Store audio samples |
cascade~ | Cascaded series of biquad filters |