teeth~
Comb filter with feedforward and feedback delay control
Description
The teeth~ object implements a comb filter, in which a slightly delayed version of a signal is added to itself, causing phase cancellations and a spectrum that looks like a comb.
Discussion
The teeth~ object is a variation of the comb~ object and implements a similar filter formula:
y[n] = a * x[n] + b * x[n - FFdelay] + c * y[n - FBdelay]
Arguments
feedforward-delay[float]ms
optional
Sets the initial value for the feedforward delay, in milliseconds. If a signal is connected to this inlet, the coefficient supplied as an argument for that inlet is ignored. If no argument is present, the delay time defaults to 10 milliseconds.
feedback-delay[float]ms
optional
Sets the initial value for the feedback delay, in milliseconds. If a signal is connected to this inlet, the coefficient supplied as an argument for that inlet is ignored. If no argument is present, the delay time defaults to 10 milliseconds.
gain[float]
optional
Sets the initial value for the gain. If a signal is connected to this inlet, the coefficient supplied as an argument for that inlet is ignored. If no argument is present, the value defaults to 0.
feedforward-gain[float]
optional
Sets the initial value for the feedforward gain. If a signal is connected to this inlet, the coefficient supplied as an argument for that inlet is ignored. If no argument is present, the value defaults to 0.
feedback-gain[float]
optional
Sets the initial value for the feedback gain. If a signal is connected to this inlet, the coefficient supplied as an argument for that inlet is ignored. If no argument is present, the value defaults to 0.
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. background 1 adds the object to the background layer, background 0 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
The filter parameters in inlets 2 to 6 may be specified by a float instead of a signal. If a signal is also connected to the inlet, the float is ignored.
- filter-parameters
[int]
float
The filter parameters in inlets 2 to 6 may be specified by a float instead of a signal. If a signal is also connected to the inlet, the float is ignored.
- filter-parameters
[float]
clear
Clears the teeth~ object's memory of previous outputs, resetting them to 0.
signal
In left inlet: Signal to be filtered. The teeth~ object is a variant of comb~-- a comb filter that mixes the current input sample with earlier input and/or output samples to accentuate and attenuate the input signal at regularly spaced frequency intervals. Unlike the comb~ object, teeth~ adds feedforward and feedback, which adds to the extremity of the effect.
In 2nd inlet: Feedforward - the delay, in milliseconds, before past samples of the input are added to the current input.
In 3rd inlet: Feedback - the delay, in milliseconds, before past samples of the output are added to the current input.
In 4th inlet: Gain coefficient - for scaling the amount of the input sample to be sent to the output.
In 5th inlet: Gain coefficient - for scaling the amount of feedforward to be sent to the output.
In right inlet: Gain coefficient - for scaling the amount of feedback to be sent to the output.
list
The five parameters can be provided as a list in the left inlet. The first number in the list is the feedforward delay, the next number is the feedback delay, the third number is the Gain coefficient for the input sample, the fourth number is the feedforward gain coefficient, and the fifth number is the feedback gain coefficient. If a signal is connected to a given inlet, the coefficient supplied in the list for that inlet is ignored.
- feedforward-delay
[float]
- feedback-delay
[float]
- gain
[float]
- feedforward-gain
[float]
- feedback-gain
[float]
Output
signal
The filtered signal.
See Also
| Name | Description |
|---|---|
| allpass~ | Apply an allpass filter effect |
| comb~ | Apply a comb filter effect |
| delay~ | Delay a signal |
| reson~ | Resonant bandpass filter |