fftin~
Input for a patcher loaded by pfft~
Description
The fftin~ object provides an signal input to a patcher loaded by a pfft~ object.
Discussion
Where the pfft~ object manages the windowing and overlap of the incoming signal, fftin~ applies the windowing function (the envelope) and performs the Fast Fourier Transform.
Arguments
inlet-assignment[int]
optional
window-envelope-function[symbol]
optional
Specifies the window envelope function the fftin~ object will apply to overlapping FFTs on the input signal. The options are square (i.e. no window envelope), hanning (the default), triangle , hamming and blackman (Note: The Blackman window should be used with an overlap of 4 or more). If the symbol nofft is used, then the fftin~ object will not use a windowing envelope and will not perform a Fast Fourier Transform -- it will echo the first half of its input sample window to its real output and the second half of its input sample window to its imaginary output. This can allow you to input raw control signals from outside the parent patcher through inlets in the pfft~ object, provided its overlap is set to 2. Other overlap values may not yield useful results.
Attributes
nofft[int]
With nofft set, fftin~ allows for audio to pass into the subpatcher from pfft~s inlets without performing an fft. There are a few idiosyncratic behaviors for pfft~ in the default half spectrum frame mode and pfft~ in fullspectrum mode, which for legacy reasons behave as they do.
When pfft is in the default half spectrum mode, fftin~ ignores the windowing function, reading from and writing to the first half of the incoming frame from the outer MSP patch.
When pfft is in full spectrum mode, unlike half spectrum mode, fftin~ nofft will apply the windowing function to the real output/input (default hanning).
fftin~ in fullspectrum mode will output the unwindowed values out the imaginary output. To have similar behavior out the real output, set the window to square.
userwindow[symbol]:
When the window attribute is set to user, the userwindow attribute sets which buffer to use as the window function.
window[symbol]: hanning
Set the window function to one of the built in window functions, or a user specified buffer.
Possible values:
'square'
'triangle'
'hanning'
'hamming'
'blackman'
'user'
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]
You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.
patching_rect[4 floats]: 0. 0. 100. 0.
Aliases: patching_position, patching_size
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.
Aliases: presentation_position, presentation_size
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'
valuepopup[int]: 0
For objects with single values, enabling valuepopup will display the object's current value in a popup caption when the mouse is over the object or it is being changed with the mouse.
valuepopuplabel[int]: 0
Sets the source of a text label shown in a value popup caption.
Possible values:
0 = 'None'
1 = 'Hint'
2 = 'Scripting Name'
3 = 'Parameter Long Name'
4 = 'Parameter Short Name'
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
Output
signal
Out left outlet: This output contains the real-values resulting from the Fast Fourier transform performed on the corresponding inlet of the pfft~. This output frame is only half the size of the parent pfft~ object's FFT size because the spectrum of a real input signal is symmetrical and therefore half of it is redundant. The real and imaginary pairs for one spectrum are called a spectral frame.
Out middle outlet: This output contains the imaginary-values resulting from the Fast Fourier transform performed on the corresponding inlet of the pfft~. This output frame is only half the size of the parent pfft~ object's FFT size because the spectrum of a real input signal is symmetrical and therefore half of it is redundant. The real and imaginary pairs for one spectrum are called a spectral frame.
Out right outlet: A stream of samples corresponding to the index of the current bin whose data is being sent out the first two outlets. This is a number from 0 - (frame size - 1). The spectral frame size inside a pfft~ object's subpatch is equal to half the FFT window size.
See Also
| Name | Description |
|---|---|
| cartopol | Convert cartesian to polar coordinates |
| cartopol~ | Signal Cartesian to Polar coordinate conversion |
| fft~ | Fast Fourier transform |
| fftinfo~ | Report information about a patcher loaded by pfft~ |
| fftout~ | Output for a patcher loaded by pfft~ |
| frameaccum~ | Compute "running phase" of successive phase deviation frames |
| framedelta~ | Compute phase deviation between successive FFT frames |
| ifft~ | Inverse fast Fourier transform |
| in | Message input for a patcher loaded by poly~ or pfft~ |
| out | Message output for a patcher loaded by poly~ or pfft~ |
| pfft~ | Spectral processing manager for patchers |
| poltocar | Convert polar to cartesian coordinates |
| poltocar~ | Signal Polar to Cartesian coordinate conversion |
| vectral~ | Vector-based envelope follower |