Wave1i Class Reference
[WaveTable Synthesis]
Wavetable synthesis with 1 interpolating (high-quality) oscillator.
More...
#import <Wave1i.h>
Public Member Functions | |
| (id) | - init |
| Sent by the MKOrchestra only when a new MKSynthPatch has just been created and before its MKUnitGenerator connections have been made, as defined by the MKPatchTemplate. | |
| (id) | - controllerValues: |
| Sent by the MKSynthInstrument to a MKSynthPatch when a new tag stream begins, before the noteOn: message is sent. | |
| (id) | - noteOnSelf: |
| aNote is assumed to be a noteOn or noteDur. | |
| (id) | - preemptFor: |
| Preempts envelope, if any. | |
| (id) | - noteUpdateSelf: |
| aNote is assumed to be a noteUpdate and the receiver is assumed to be currently playing a MKNote. | |
| (double) | - noteOffSelf: |
| aNote is assumed to be a noteOff. | |
| (id) | - noteEndSelf |
| Resest instance variables to default values. | |
Static Public Member Functions | |
| (id) | + patchTemplateFor: |
| Returns a default template. | |
Detailed Description
Wavetable synthesis with 1 interpolating (high-quality) oscillator.Wave1i is a single-interpolating-oscillator wavetable MKSynthPatch with an amplitude and frequency envelope. Wave1 (a subclass of Wave1i) is identical, but it uses a non-interpolating-oscillator (lower quality, but uses less DSP computation.) Wave1i is used as the root class for a number of wavetable MKSynthPatches.
Here is a diagram of Wave1:
When using this MKSynthPatch in an interactive real-time context, such as playing from a MIDI keyboard, call MKUseRealTimeEnvelopes() before allocating the MKSynthPatch.
Parameter Interpretation
ampEnv - Amplitude envelope. Default is an envelope that is always a constant 1.0.
amp - Amplitude. In the range 0.0:1.0. amp1 is a synonym for amp. Default is 0.1.
amp0 - Amplitude when the envelope is at 0.0. amp is amplitude when the envelope is at 1.0. amp1 is a synonym for amp. Default is 0.0.
ampAtt - Time of attack portion of envelope in seconds. If this parameter is not present, the times in the envelope are used verbatim.
ampRel - Time of release portion of envelope in seconds. If this parameter is not present, the times in the envelope are used verbatim.
bearing - Left/right panning of signal. In range -45.0:45.0. -45.0 is far left. Default is 0.0.
controlChange - This parameter is the MIDI controller number to be affected. It is used in conjunction with the parameter controlVal, which provides the value the controller is set to. This SynthPatch uses MIDI volume (controller 7) to adjust output volume as an attenuation of the final output signal. The default for MIDI volume is 127.
controlVal - See controlChange.
freq - Frequency in Hz. freq1 is a synonym for freq. Default is A440.
freqEnv - Frequency envelope. Default is an envelope that is always a constant 1.0.
freq0 -Fundamental frequency when the envelope is at 0. freq is frequency when the envelope is at 1. freq1 is a synonym for freq. Default is 0.0.
freqAtt -Time of attack portion of envelope in seconds. If this parameter is not present, the times in the envelope are used verbatim.
freqRel -Time of release portion of envelope in seconds. If this parameter is not present, the times in the envelope are used verbatim.
keyNum - The MIDI key number, an alternative to freq. If both freq and keyNum are present, freq, takes precedence. In the range 0:127.
pitchBend - Modifies frequency (or keyNum) as a 14 bit integer. A value of MIDI_ZEROBEND (defined as 0x2000 in <mididriver/midi_spec.h>) gives no bend. 0 is maximum negative bend. 0x3fff is maximum positive bend. See TuningSystem class for details. May give unexpected results when combined with frequency envelopes. Default is MIDI_ZEROBEND.
pitchBendSensitivity - A value of 0.0 means pitchBend has no effect. A value of 1.0 means pitch bend corresponds to plus or minus a semitone. Larger values give larger pitch deviation. Default is 3.0.
portamento - Portamento time. In a phrase, the transition time to a note from the immediately preceding note. Overrides the time values of the first segment of the envelopes. Note that portamento is applied after the attack-time parameters.
waveform - WaveTable used for the oscillator (only the carrier, in the case of FM). Defaults to sine. Note that the WaveTable you supply is normalized so that its peak amplitude is 1.0.
waveLen - Length of wavetable. Defaults to an optimal value. May only be set at the start of a phrase or with a noteUpdate that has no noteTag.
phase - Initial phase of wavetable in degrees. Rarely needed. Default is 0.0.
velocity - A MIDI parameter. In range 0:127. The default is 64. Velocity scales amplitude by an amount deteremined by velocitySensitivity. Some SynthPatches also scale brightness or FM index based on velocity.
velocitySensitivity - In range 0.0:1.0. Default is 0.5. When velocitySensitivity is 0, velocity has no effect.
Member Function Documentation
| + (id) patchTemplateFor: | (MKNote *) | currentNote |
Returns a default template.
currentNote is ignored.
- Parameters:
-
currentNote is a MKNote instance.
- Returns:
- An (id).
Reimplemented from MKSynthPatch.
| - (id) init |
Sent by the MKOrchestra only when a new MKSynthPatch has just been created and before its MKUnitGenerator connections have been made, as defined by the MKPatchTemplate.
- Returns:
- Returns an id. A subclass may override the init method to provide additional initialization. A return of nil aborts the creation and frees the new MKSynthPatch. The default implementation does nothing and returns the receiver.
Reimplemented from MKSynthPatch.
| - (id) controllerValues: | (id) | controllers |
Sent by the MKSynthInstrument to a MKSynthPatch when a new tag stream begins, before the noteOn: message is sent.
The default implementation does nothing. You may override it in a subclass as desired.
Note that the sustain pedal controller is handled automatically by the MKSynthPatch class. Note that pitchbend is not a controller in MIDI. Thus the current pitchbend is included in the MKNote passed to noteOn:, not in the HashTable. See the HashTable spec sheet for details on how to access the values in controllers. The table should not be altered by the receiver.
- Parameters:
-
controllers is a HashTable that describes the state of the MIDI controllers by mapping integer controller numbers to integer controller values.
- Returns:
- Returns an id.
Reimplemented from MKSynthPatch.
| - (id) noteOnSelf: | (MKNote *) | aNote |
aNote is assumed to be a noteOn or noteDur.
This method triggers (or retriggers) the MKNote's envelopes, if any. If this is a new phrase, all instance variables are set to default values, then the values are read from the MKNote.
- Parameters:
-
aNote is an MKNote instance.
- Returns:
- Returns an id.
Reimplemented from MKSynthPatch.
| - (id) preemptFor: | (MKNote *) | aNote |
Preempts envelope, if any.
- Parameters:
-
aNote is an MKNote instance.
- Returns:
- Returns an id.
Reimplemented from MKSynthPatch.
| - (id) noteUpdateSelf: | (MKNote *) | aNote |
aNote is assumed to be a noteUpdate and the receiver is assumed to be currently playing a MKNote.
Sets parameters as specified in aNote.
- Parameters:
-
aNote is an MKNote instance.
- Returns:
- Returns an id.
Reimplemented from MKSynthPatch.
| - (double) noteOffSelf: | (MKNote *) | aNote |
aNote is assumed to be a noteOff.
This method causes the MKNote's envelopes (if any) to begin its release portion and returns the time for the envelopes to finish. Also sets any parameters present in aNote.
- Parameters:
-
aNote is an MKNote instance.
- Returns:
- Returns a double as the time for the envelope to finish in beats.
Reimplemented from MKSynthPatch.
| - (id) noteEndSelf |
The documentation for this class was generated from the following file:
