[MPTK PRO] Read MIDI events from a MIDI keyboard connected to your Windows or Mac desktop. This class must be used with the prefab MidiInReader
More...
Public Types | |
enum | ModeSpatializer { Channel , Track } |
Public Member Functions | |
int | MPTK_ChannelBankGetIndex (int channel) |
int | MPTK_ChannelControllerGet (int channel, int controller) |
int | MPTK_ChannelCount () |
bool | MPTK_ChannelEnableGet (int channel) |
void | MPTK_ChannelEnableSet (int channel, bool enable) |
int | MPTK_ChannelForcedPresetGet (int channel) |
bool | MPTK_ChannelForcedPresetSet (int channel, int preset, int bank=-1) |
string | MPTK_ChannelInfo (int channel) |
int | MPTK_ChannelNoteCount (int channel) |
bool | MPTK_ChannelPresetChange (int channel, int preset, int bank=-1) |
int | MPTK_ChannelPresetGetIndex (int channel) |
string | MPTK_ChannelPresetGetName (int channel) |
float | MPTK_ChannelVolumeGet (int channel) |
void | MPTK_ChannelVolumeSet (int channel, float volume) |
void | MPTK_ChorusSetDefault () |
void | MPTK_ClearAllSound (bool destroyAudioSource=false, int _idSession=-1) |
void | MPTK_InitSynth (int channelCount=16) |
void | MPTK_ResetStat () |
void | MPTK_ReverbSetDefault () |
void | MPTK_SFChorusSetDefault () |
void | MPTK_SFFilterSetDefault () |
void | MPTK_SFReverbSetDefault () |
void | MPTK_StartSequencerMidi () |
void | MPTK_StopSynth () |
IEnumerator | MPTK_WaitAllNotesOff (int _idSession=-1) |
delegate void | OnAudioFrameStartHandler (double synthTime) |
Static Public Attributes | |
static List< MidiFilePlayer > | SpatialSynths |
Events | |
OnAudioFrameStartHandler | OnAudioFrameStart |
[MPTK PRO] Read MIDI events from a MIDI keyboard connected to your Windows or Mac desktop. This class must be used with the prefab MidiInReader
There is no need to writing a script. For a simple usage, all the job can be done in the prefab inspector.
See example of use in TestMidiInputScripting.cs
More information here https://paxstellar.fr/prefab-midiinreader/
|
inherited |
[MPTK PRO] Spatializer Mode for the prefab MidiSpatializer
Enumerator | |
---|---|
Channel | Spatial Synth are enabled to dispatch note-on by channels. |
Track | Spatial Synth are enabled to dispatch note-on by tracks defined in the MIDI. |
|
inherited |
Get the current bank associated to the channel.
Each MIDI channel can play a different preset and bank.
channel | MIDI channel must be between 0 and 15 |
|
inherited |
Get the current preset name for the channel.
Each MIDI channel can play a different preset.
channel | MIDI channel must be between 0 and 15 |
controller | MIDI Controller must be between 0 and 127. See MPTKEvent::Controller |
|
inherited |
Get channel length. The midi norm is 16, but MPTK can manage up to 32 channels (experimental).
channel | must be between 0 and 15 |
|
inherited |
Is channel is enabled or disabled.
channel | channel, must be between 0 and 15 |
|
inherited |
Disable (mute) or enable (unmute) a MIDI channel.
channel | must be between 0 and 15 |
enable | true to unmute (default), false to mute channel |
|
inherited |
Set forced preset on the channel. MIDI will allways playing with this preset even if a MIDI Preset Change message is received.
Set to -1 to disable this behavior.
channel |
|
inherited |
Set a Preset on a channel to force the MIDI Synth to always playing with this instrument even if MIDI 'Preset Change' or 'Bank change' messages are received.
Set Preset to -1 to restore the Preset and Bank defined in the MIDI file.
channel | 0 to 15 channel |
preset | Preset to force in the range 0 to 127 preset. Set to -1 to restore the Preset and Bank known from the MIDI file. |
bank | Optionnal. Bank to force in the range 0 to 128. Set to -1 to restore to the last bank known from the MIDI file. |
Another example with MidiExternalPlayer.
|
inherited |
Build an information string about the channel. It's also a good pretext to display an example of Channel API.
Exemple of return
channel | index channel |
|
inherited |
Get count of notes played since the start of the MIDI.
channel | must be between 0 and 15 |
|
inherited |
Change the Preset and/or Bank associated to a Channel.
The new value of the bank or preset are registered in the channel even if the preset or bannk is not found.
Each channel can have a different bank/preset set.
Note 1: When bank is changed, the preset list is not updated (MidiPlayerGlobal.MPTK_ListPreset). Call MidiPlayerGlobal.MPTK_SelectBankInstrument to refresh this list.
Note 2: When playing a MIDI file, MIDI messages like "Patch Change" and "ControlChange BankSelectMsb" will override value registered with this method.
Note 3: To change globally the bank, use instead the global methods: MidiPlayerGlobal.MPTK_SelectBankInstrument or MidiPlayerGlobal.MPTK_SelectBankDrum.
Note 4: The method MPTK_ChannelForcedPresetSet can be used to force the preset whatever the MIDI messages.
channel | 0 to 15. There is 16 channels available in the MIDI norm. |
preset | The total number of presets available depend on the soundfont selected |
bank | Optionnal, if not set or -1 the current bank will be applied (or default bank if never set). Default bank is defined globally: menu MPTK / SoundFont Setup. |
|
inherited |
Get channel preset index.
channel | must be between 0 and 15 |
|
inherited |
Get the current preset name for the channel.
Each MIDI channel can play a different preset.
channel | MIDI channel must be between 0 and 15 |
|
inherited |
Get the volume of the channel
channel | must be between 0 and 15 |
|
inherited |
Set the volume for a channel as a percentage.
channel | must be between 0 and 15 or -1 to apply to all channels |
volume | percentage of volume from the global volume for the channel, must be between 0 and 1 |
|
inherited |
[MPTK PRO] Set Chorus Unity default value as defined with Unity.
|
inherited |
Clear all sound by sending note off.
That could take some seconds because release time for sample need to be played.
destroyAudioSource | usefull only in non core mode |
_idSession | clear only for sample playing with this session, -1 for all (default) |
|
inherited |
Initialize the synthetizer: channel, voices, modulator.
It's not usefull to call this method if you are using prefabs (MidiFilePlayer, MidiStreamPlayer, ...).
Each gameObjects created from these prefabs have their own, autonomous and isolated synth.
channelCount | Number of channel to create, default 16. Any other values are experimental! |
|
inherited |
Reset voices statistics
|
inherited |
[MPTK PRO] Set Reverb Unity default value as defined with Unity.
|
inherited |
[MPTK PRO] Set Chrous SoundFont default value as defined in fluidsynth.
FLUID_CHORUS_DEFAULT_N 3
FLUID_CHORUS_DEFAULT_LEVEL 2.0 but set to 0.9 (thank John)
FLUID_CHORUS_DEFAULT_SPEED 0.3
FLUID_CHORUS_DEFAULT_DEPTH 8.0
FLUID_CHORUS_DEFAULT_TYPE FLUID_CHORUS_MOD_SINE
WIDTH 10
|
inherited |
[MPTK PRO] Set Filter SoundFont default value as defined in fluidsynth.
|
inherited |
[MPTK PRO] Set Reverb SoundFont default value as defined in fluidsynth.
FLUID_REVERB_DEFAULT_ROOMSIZE 0.2f
FLUID_REVERB_DEFAULT_DAMP 0.0f
FLUID_REVERB_DEFAULT_WIDTH 0.5f
FLUID_REVERB_DEFAULT_LEVEL 0.9f
Default chorus voice count
|
inherited |
Start the MIDI sequencer: each midi events are read and play in a dedicated thread.
This thread is automatically started by prefabs MidiFilePlayer, MidiListPlayer, MidiExternalPlayer.
|
inherited |
Stop processing samples by the synth and the MIDI sequencer.
|
inherited |
Wait until all notes are off.
That could take some seconds due to the samples release time.
Therefore, the method exit after a timeout of 3 seconds.
*** Use this method only as a coroutine ***
_idSession | clear only for samples playing with this session, -1 for all |
|
inherited |
[MPTK PRO] Delegate for the event OnAudioFrameStartHandler. see OnAudioFrameStart
synthTime |
|
inherited |
Apply LFO effect defined in the SoundFont
|
inherited |
Apply real time modulatoreffect defined in the SoundFont: pitch bend, control change, enveloppe modulation
|
inherited |
[MPTK PRO] Apply chorus effect as defined in the SoundFont.
This effect is processed with the fluidsynth algo independently on each voices but with a small decrease of performace (10%).
|
inherited |
[MPTK PRO] Apply frequency low-pass filter as defined in the SoundFont.
This effect is processed with the fluidsynth algo independently on each voices but with a small decrease of performace (40%).
|
inherited |
[MPTK PRO] Apply reverberation effect as defined in the SoundFont.
This effect is processed with the fluidsynth algo independently on each voices but with a small decrease of performace (40%).
|
inherited |
Apply vibrato effect defined in the SoundFont
|
inherited |
If true then rate synth and buffer size will be automatically defined by Unity in accordance of the capacity of the hardware. - V2.89.0 -
Look at Unity menu "Edit / Project Settings..." and select between best latency and best performance.
If false, then rate and buffer size can be defined manually ... but with the risk of bad audio quality. It's more an experimental capacities!
|
inherited |
Voice buffering is important to get better performance. But you can disable this fonction with this parameter.
|
inherited |
Free voices older than MPTK_AutoCleanVoiceLimit are removed when count is over than MPTK_AutoCleanVoiceTime
|
inherited |
If true then MIDI events are read and play from a dedicated thread.
If false, MidiSynth will use AudioSource gameobjects to play sound.
This properties must be defined before running the application from the inspector.
The default is true.
Warning: The non core mode player (MPTK_CorePlayer=false) will be removed with the next major version (V3)
|
inherited |
When amplitude is below this value the playing of sample is stopped (voice_off).
Can be increase for better performance but with degraded quality because sample could be stopped earlier. Remember: Amplitude can varying between 0 and 1.
|
inherited |
If true (default) then MIDI events are sent automatically to the midi player.
Set to false if you want to process events without playing sound.
OnEventNotesMidi Unity Event can be used to process each notes.
|
inherited |
Should accept change tempo from MIDI Events ?
|
inherited |
Allow direct setting of the Synth Rate
|
inherited |
Should change pan from MIDI Events or from SoundFont ?
Pan is disabled when Spatialization is activated.
|
inherited |
Should accept change Preset for Drum canal 10 ?
Disabled by default. Could sometimes create bad sound with midi files not really compliant with the MIDI norm.
|
inherited |
V2.83 Find the exclusive class of this voice. If set, kill all voices that match the exclusive class
and are younger than the first voice process created by this noteon event.
|
inherited |
V2.873 - A lean startup of the volume of the synth is useful to avoid weird sound at the beginning of the application (in some cases).
This parameter sets the speed of the increase of the volume of the audio source.
Set to 1 for an immediate full volume at start.
bool MidiPlayerTK.MidiInReader.MPTK_LogEvents |
Log midi events
|
inherited |
Log for each wave to be played
bool MidiPlayerTK.MidiInReader.MPTK_ReadMidiInput |
Read Midi input
|
inherited |
V2.83. If the same note is hit twice on the same channel, then the older voice process is advanced to the release stage.
It's the default Midi processing.
|
inherited |
[Only when CorePlayer=False] Define a minimum release time at noteoff in 100 iem nanoseconds.
Default 50 ms is a good tradeoff. Below some unpleasant sound could be heard. Useless when MPTK_CorePlayer is true.
|
inherited |
When a note is stopped with a noteoff or when the duration is over, note continue to play for a short time depending the instrument.
This parameter is a multiplier to increase or decrease the default release time defined in the SoundFont for each instrument.
Recommended values between 0.1 and 10. Default is 1 (no modification of the release time).
Performance issue: the longer it lasts the more CPU is used after the noteon. With a long release time, a lot of samples will be played simultaneously.
|
inherited |
Reset channel information when MIDI start playing. V2.89.0
|
inherited |
[MPTK PRO] Chorus level is defined in the SoundFont in the range [0, 1].
This parameter is added to the the default SoundFont value.
Range must be [-1, 1]
|
inherited |
[MPTK PRO] Frequency cutoff is defined in the SoundFont for each notes.
This parameter increase or decrease the default SoundFont value. Range: -2000 to 3000
|
inherited |
[MPTK PRO] Reverberation level is defined in the SoundFont in the range [0, 1].
This parameter is added to the the default SoundFont value.
Range must be [-1, 1]
|
inherited |
[MPTK PRO] In spatialization mode not all MidiSynths are enabled.
|
inherited |
Count of the active voices (playing) - Readonly
|
inherited |
Count of the free voices for reusing on need.
Voice older than AutoCleanVoiceTime are removed but only when count is over than AutoCleanVoiceLimit - Readonly
|
inherited |
Count of voice played since the start of the synth
|
inherited |
Percentage of voice reused during the synth life. 0: any reuse, 100:all voice reused (unattainable, of course!)
|
inherited |
Should play on a weak device (cheaper smartphone) ? Apply only with AudioSource mode (MPTK_CorePlayer=False).
Playing MIDI files with WeakDevice activated could cause some bad interpretation of MIDI Event, consequently bad sound.
EventMidiClass MidiPlayerTK.MidiInReader.OnEventInputMidi |
Define unity event to trigger when note available from the Midi file.
|
inherited |
Unity event fired at awake of the synthesizer. Name of the gameobject component is passed as a parameter.
Setting this callback function by script (AddListener) is not recommended. It's better to set callback function from the inspector.
Example of script (but it's recommended to set callback function from the inspector).
|
inherited |
Unity event fired at start of the synthesizer. Name of the gameobject component is passed as a parameter.
Setting this callback function by script (AddListener) is not recommended. It's better to set callback function from the inspector.
Example of script (it's recommended to set callback function from the inspector).
|
inherited |
[MPTK PRO] V2.89.0 - This function is called by the MIDI sequencer before sending the MIDI message to the MIDI synthesizer.
It can be used like a MIDI events preprocessor: it's possible to change the value of the MIDI events and therefore change the playback of the song.
The callback function receives a MPTKEvent object by reference (normal, it's a C# class).
Look at https://mptkapi.paxstellar.com/d9/d50/class_midi_player_t_k_1_1_m_p_t_k_event.html
A lot change is possible on the MIDI event: change note, velocity, channel, ..., even changing the MIDI type of the message!!!
See below some examples of changes.
|
inherited |
Preset are often composed with 2 or more samples, classically for left and right channel. Check this to play only the first sample found
|
staticinherited |
Contains each Midi Synth for each channel or track when the prefab MidiSpatializer is used and IsMidiChannelSpace=true.
Warning: only one MidiSpatializer can be used in a hierarchy.
|
getsetinherited |
[MPTK PRO] Apply Chorus Unity effect to the AudioSource. The effect is applied to all voices.
|
getsetinherited |
[MPTK PRO] Apply Reverb Unity effect to the AudioSource. The effect is applied to all voices.
|
getsetinherited |
[MPTK PRO] Chorus delay in ms.
Range from 0.1 to 100. Default = 40 ms.
|
getsetinherited |
[MPTK PRO] Chorus modulation depth.
Range from 0 to 1. Default = 0.03.
|
getsetinherited |
[MPTK PRO] Volume of original signal to pass to output.
Range from 0 to 1. Default = 0.5.
|
getsetinherited |
[MPTK PRO] Chorus modulation rate in hz.
Range from 0 to 20. Default = 0.8 hz.
|
getsetinherited |
[MPTK PRO] Volume of 1st chorus tap.
Range from 0 to 1. Default = 0.5.
|
getsetinherited |
[MPTK PRO] Volume of 2nd chorus tap. This tap is 90 degrees out of phase of the first tap.
Range from 0 to 1. Default = 0.5.
|
getsetinherited |
[MPTK PRO] Volume of 3rd chorus tap. This tap is 90 degrees out of phase of the second tap.
Range from 0 to 1. Default = 0.5.
|
getsetinherited |
Set or Get synth buffer size -1:default, 0:64, 1;128, 2:256, 3:512, 4:1024, 5:2048.
The change is global for all prefab. It's better to stop playing for all prefab before changing on fly to avoid bad noise or crash.
|
getsetinherited |
Set or Get sample rate output of the synth. -1:default, 0:24000, 1:36000, 2:48000, 3:60000, 4:72000, 5:84000, 6:96000.
It's better to stop playing before changing on fly to avoid bad noise.
|
getinherited |
[MPTK PRO] If spatialization is track mode, contains the last instrument played on this track
|
getinherited |
[MPTK PRO] True if this MidiSynth is the master synth responsible to read midi events and to dispatch to other MidiSynths
|
getsetinherited |
V2.83 When the value is true, NoteOff and Duration for non-looped samples are ignored and the samples play through to the end.
|
getsetinherited |
If MPTK_Spatialize is enabled, the volume of the audio source depends on the distance between the audio source and the listener.
Beyong this distance, the volume is set to 0 and the midi player is paused. No effect if MPTK_Spatialize is disabled.
|
getsetinherited |
[obsolete] replaced by MPTK_Spatialize"); V2.83
|
getsetinherited |
[MPTK PRO] Decay HF Ratio : High-frequency to low-frequency decay time ratio.
Ranges from 0.1 to 2.0.
|
getsetinherited |
[MPTK PRO] Reverberation decay time at low-frequencies in seconds.
Ranges from 0.1 to 20. Default is 1.
|
getsetinherited |
[MPTK PRO] Late reverberation delay time relative to first reflection in seconds.
Ranges from 0 to 0.1. Default is 0.04
|
getsetinherited |
[MPTK PRO] Reverberation density (modal density) in percent.
Ranges from 0 to 1.
|
getsetinherited |
[MPTK PRO] Reverberation diffusion (echo density) in percent.
Ranges from 0 to 1. Default is 1.
|
getsetinherited |
[MPTK PRO] Mix level of dry signal in output.
Ranges from 0 to 1.
|
getsetinherited |
[MPTK PRO] Reference high frequency in Hz.
Ranges from 1000 to 20000. Default is 5000
|
getsetinherited |
[MPTK PRO] Late reverberation level relative to room effect.
Ranges from 0 to 1.
|
getsetinherited |
[MPTK PRO] Reference low-frequency in Hz.
Ranges from 20 to 1000. Default is 250
|
getsetinherited |
[MPTK PRO] Late reverberation level relative to room effect.
Ranges from -10000.0 to 2000.0. Default is 0.0.
|
getsetinherited |
[MPTK PRO] Early reflections level relative to room effect.
Ranges from 0 to 1.
|
getsetinherited |
[MPTK PRO] Room effect level at low frequencies.
Ranges from 0 to 1.
|
getsetinherited |
[MPTK PRO] Room effect high-frequency level.
Ranges from 0 to 1.
|
getsetinherited |
[MPTK PRO] Room effect low-frequency level.
Ranges from 0 to 1.
|
getsetinherited |
[MPTK PRO] Set the SoundFont chorus effect depth
Chorus depth [0, 256]
V2.88.2
|
getsetinherited |
[MPTK PRO] Set the SoundFont chorus effect level [0, 10]
V2.88.2 - becomes a parameter and default value set to 0.9 (was 2f, thank John)
|
getsetinherited |
[MPTK PRO] Set the SoundFont chorus effect speed
Chorus speed in Hz [0.1, 5]
V2.88.2
|
getsetinherited |
[MPTK PRO] Set the SoundFont chorus effect width
The chorus unit process a monophonic input signal and produces stereo output controlled by WIDTH macro.
Width allows to get a gradually stereo effect from minimum (monophonic) to maximum stereo effect. [0, 10]
V2.88.2
|
getsetinherited |
[MPTK PRO] Quality Factor is defined in the SoundFont for each notes.
This parameter increase or decrease the default SoundFont value. Range: -96 to 96.
|
getsetinherited |
[MPTK PRO] Set the SoundFont reverb effect damp [0,1].
Controls the reverb time frequency dependency. This controls the reverb time for the frequency sample rate/2
When 0, the reverb time for high frequencies is the same as for DC frequency.
When > 0, high frequencies have less reverb time than lower frequencies.
V2.88.2
|
getsetinherited |
[MPTK PRO] Set the SoundFont reverb effect level
V2.88.2
|
getsetinherited |
[MPTK PRO] Set the SoundFont reverb effect room size. Controls concave reverb time between 0 (0.7 s) and 1 (12.5 s)
V2.88.2
|
getsetinherited |
[MPTK PRO] Set the SoundFont reverb effect width [0,100].
Controls the left/right output separation.
When 0, there are no separation and the signal on left and right output is the same.This sounds like a monophonic signal.
When 100, the separation between left and right is maximum.
V2.88.2
|
getsetinherited |
Should the Spatialization effect must be enabled?
See here how to setup spatialization with Unity https://paxstellar.fr/midi-file-player-detailed-view-2/#Foldout-Spatialization-Parameters if MPTK_Spatialize is true:
AudioSource.maxDistance = MPTK_MaxDistance
AudioSource.spatialBlend = 1
AudioSource.spatialize = true
AudioSource.spatializePostEffects = true
|
getinherited |
Index of the MidiSynth for the dedicated Channel or Track when the prefab MidiSpatializer is used.
If MPTK_ModeSpatializer = Channel then represent the playing channel.
If MPTK_ModeSpatializer = Track then represent the playing track.
The value is -1 for the Midi reader because no voice is played.
|
getsetinherited |
Get the the current synth rate or set free value (only if MPTK_EnableFreeSynthRate is true).
|
getinherited |
[MPTK PRO] If spatialization is track mode, contains the last name of the track
|
getsetinherited |
Transpose will apply to all channels except this one. Set to -1 to apply to all channel. V2.89.0
Default is 9 because generally we don't want to transpose drum channel.
|
getsetinherited |
Transpose note from -24 to 24
|
getsetinherited |
Global Volume. apply to all channels.
Must be >=0 and <= 1
|
inherited |
[MPTK PRO] this event is triggered at each start of a new audio frame from the audio engine.
The parameter (double) is the current synth time in milliseconds. See example of use.
The callbach function will not run on the Unity thread, so you can't call Unity API except Debug.Log.