Base class wich contains all the stuff to build a Wave Table Synth. More...

Inheritance diagram for MidiPlayerTK.MidiSynth:

Public Types
enum	ModeSpatializer { Channel , Track }

Public Member Functions
void	MPTK_ClearAllSound (bool destroyAudioSource=false, int _idSession=-1)

void	MPTK_InitSynth (int channelCount=16, bool preserveChannelInfo=false)

void	MPTK_ResetStat ()

void	MPTK_StartSequencerMidi ()

void	MPTK_StartSynth ()

void	MPTK_StopSynth ()

IEnumerator	MPTK_WaitAllNotesOff (int _idSession=-1)

delegate void	OnAudioFrameStartHandler (double synthTime)

Static Public Member Functions
static StringBuilder	MPTK_BuildInfoSynth (MidiSynth synth)
	Build a string with performance and information about the MIDI reader and the MIDI synthesizer. DEBUG_PERF_AUDIO DEBUG_HISTO_DSPSIZE DEBUG_PERF_MIDI More...

Public Attributes
bool	MPTK_ApplyModLfo

bool	MPTK_ApplyRealTimeModulator

bool	MPTK_ApplyVibLfo

bool	MPTK_AudioSettingFromUnity

bool	MPTK_AutoBuffer = true

int	MPTK_AutoCleanVoiceLimit

bool	MPTK_CorePlayer

float	MPTK_CutOffVolume = 0.0001f

bool	MPTK_DirectSendToPlayer

MPTKEffectSoundFont	MPTK_EffectSoundFont

MPTKEffectUnity	MPTK_EffectUnity
	Unlike SoundFont effects, they applied to the whole player. On the other hand, the Unity effects parameters are rich and, obviously based on Uniy algo! https://docs.unity3d.com/Manual/class-AudioEffectMixer.html Only most important effect are integrated in Maestro: Reverb and Chorus. On need, others effects could be added. More...

bool	MPTK_EnableChangeTempo

bool	MPTK_EnableFreeSynthRate = false

bool	MPTK_EnablePanChange

bool	MPTK_EnablePresetDrum

int	MPTK_InstrumentNum

bool	MPTK_KillByExclusiveClass = true

float	MPTK_LeanSynthStarting = 0.05f

bool	MPTK_LogEvents

bool	MPTK_LogWave

bool	MPTK_ReleaseSameNote = true

uint	MPTK_ReleaseTimeMin = 500000

float	MPTK_ReleaseTimeMod = 1f

bool	MPTK_SpatialSynthEnabled

int	MPTK_StatVoiceCountActive

int	MPTK_StatVoiceCountFree

int	MPTK_StatVoiceCountPlaying

int	MPTK_StatVoiceCountReused

int	MPTK_StatVoicePlayed

int	MPTK_StatVoiceRatioReused

int	MPTK_ThreadMidiWait = 10

bool	MPTK_WeakDevice

Action< int, long, int, int >	OnBeatEvent
	Action is executed at each beat and received these parameters: More...

EventSynthClass	OnEventSynthAwake

EventSynthClass	OnEventSynthStarted

Func< MPTKEvent, bool >	OnMidiEvent

bool	playOnlyFirstWave

Static Public Attributes
const float	FLUID_CHORUS_DEFAULT_DEPTH = 4.25f

const float	FLUID_CHORUS_DEFAULT_LEVEL = 0.6f

const int	FLUID_CHORUS_DEFAULT_N = 3

const float	FLUID_CHORUS_DEFAULT_SPEED = 0.2f

const float	FLUID_CHORUS_DEFAULT_WIDTH = 10f

const float	FLUID_REVERB_DEFAULT_DAMP = 0.3f

const float	FLUID_REVERB_DEFAULT_LEVEL = 0.7f

const float	FLUID_REVERB_DEFAULT_ROOMSIZE = 0.5f

const float	FLUID_REVERB_DEFAULT_WIDTH = 0.8f

static List< MidiFilePlayer >	SpatialSynths

Properties
int	MPTK_IndexSynthBuffSize `[get, set]`

int	MPTK_IndexSynthRate `[get, set]`

string	MPTK_InstrumentPlayed `[get]`

bool	MPTK_IsSpatialSynthMaster `[get]`

bool	MPTK_KeepPlayingNonLooped `[get, set]`

float	MPTK_MaxDistance `[get, set]`

bool	MPTK_PauseOnDistance `[get, set]`

bool	MPTK_Spatialize `[get, set]`

int	MPTK_SpatialSynthIndex `[get]`

int	MPTK_SynthRate `[get, set]`

int	MPTK_ThreadMidiPriority `[get, set]`

string	MPTK_TrackName `[get]`

int	MPTK_TransExcludedChannel `[get, set]`

int	MPTK_Transpose `[get, set]`

float	MPTK_Volume `[get, set]`

Events
OnAudioFrameStartHandler	OnAudioFrameStart

Detailed Description

Base class wich contains all the stuff to build a Wave Table Synth.

Load SoundFont and samples, process midi event, play voices, controllers, generators ...
This class is inherited by others class to build these prefabs: MidiStreamPlayer, MidiFilePlayer, MidiInReader.
It is not recommended to instanciate directly this class, rather add prefabs to the hierarchy of your scene. and use attributs and methods from an instance of them in your script. Example:

midiFilePlayer.MPTK_ChorusDelay = 0.2
midiStreamPlayer.MPTK_InitSynth()

class extension pro

Version: Maestro Pro

Member Enumeration Documentation

◆ ModeSpatializer

enum MidiPlayerTK.MidiSynth.ModeSpatializer

Spatializer Mode for the prefab MidiSpatializer

Version: Maestro Pro

Enumerator
Channel	Spatial Synth are enabled to dispatch note-on by channels. As a reminder, only one instrument at at time can be played by a MIDI channel Instrument (preset) are defined by channel with the MIDI message MPTKCommand.PatchChange
Track	Spatial Synth are enabled to dispatch note-on by tracks defined in the MIDI. As a reminder, multiple channels can be played on a tracks, so multiple instruments can be played on a Synth. Track name are defined with the Meta MIDI message SequenceTrackName. This MIDI message is always defined in MIDI, so name can be missing.

Member Function Documentation

◆ MPTK_BuildInfoSynth()

static StringBuilder MidiPlayerTK.MidiSynth.MPTK_BuildInfoSynth ( MidiSynth synth )

static

Build a string with performance and information about the MIDI reader and the MIDI synthesizer. DEBUG_PERF_AUDIO DEBUG_HISTO_DSPSIZE DEBUG_PERF_MIDI

Parameters

synth

Returns

◆ MPTK_ClearAllSound()

void MidiPlayerTK.MidiSynth.MPTK_ClearAllSound	(	bool	destroyAudioSource = `false`,
		int	_idSession = `-1`
	)

Clear all sound by sending note off.
That could take some seconds because release time for sample need to be played.

if (GUILayout.Button("Clear"))

midiStreamPlayer.MPTK_ClearAllSound(true);

Parameters

destroyAudioSource	useful only in non core mode
_idSession	clear only for sample playing with this session, -1 for all (default)

◆ MPTK_InitSynth()

void MidiPlayerTK.MidiSynth.MPTK_InitSynth	(	int	channelCount = `16`,
		bool	preserveChannelInfo = `false`
	)

Initialize the synthetizer:

channels informartion: instrument & bank selected, pitch, volume, ...
voices cache,
synth modulator. This method is call by MidiFilePlayer with MPTK_Play()
But in some cases, you could have to call MPTK_InitSynth to restaure initial condition of the synth (mainly useful with MidiStreamPlayer)

Parameters

channelCount	Number of channel to create. Default is 16. Any other values are experimental!
preserveChannelInfo	if true, the channel information will not be reset, Default is false: reinit also channel information

◆ MPTK_ResetStat()

void MidiPlayerTK.MidiSynth.MPTK_ResetStat ( )

Reset voices statistics

◆ MPTK_StartSequencerMidi()

void MidiPlayerTK.MidiSynth.MPTK_StartSequencerMidi ( )

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.

◆ MPTK_StartSynth()

void MidiPlayerTK.MidiSynth.MPTK_StartSynth ( )

Start processing samples by the synth and the MIDI sequencer. Useful only if MPTK_StopSynth has been called and MidiStreamPlayer.

Version: 2.11.2

◆ MPTK_StopSynth()

void MidiPlayerTK.MidiSynth.MPTK_StopSynth ( )

Stop processing samples by the synth and the MIDI sequencer. See also MPTK_StartSynth.

◆ MPTK_WaitAllNotesOff()

IEnumerator MidiPlayerTK.MidiSynth.MPTK_WaitAllNotesOff ( int _idSession = -1 )

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 ***

     // Call this method with: StartCoroutine(NextPreviousWithWait(false)); 
     // See TestMidiFilePlayerScripting.cs
     public IEnumerator NextPreviousWithWait(bool next)
     {
         midiFilePlayer.MPTK_Stop();
         yield return midiFilePlayer.MPTK_WaitAllNotesOff(midiFilePlayer.IdSession);
         if (next)
             midiFilePlayer.MPTK_Next();
         else
             midiFilePlayer.MPTK_Previous();
         CurrentIndexPlaying = midiFilePlayer.MPTK_MidiIndex;
     yield return 0;
}

Parameters

_idSession clear only for samples playing with this session, -1 for all

Returns

◆ OnAudioFrameStartHandler()

delegate void MidiPlayerTK.MidiSynth.OnAudioFrameStartHandler ( double synthTime )

Delegate for the event OnAudioFrameStartHandler. see OnAudioFrameStart.

Version: Maestro Pro

Parameters

synthTime

Member Data Documentation

◆ FLUID_CHORUS_DEFAULT_DEPTH

const float MidiPlayerTK.MidiSynth.FLUID_CHORUS_DEFAULT_DEPTH = 4.25f

static

Default chorus depth

◆ FLUID_CHORUS_DEFAULT_LEVEL

const float MidiPlayerTK.MidiSynth.FLUID_CHORUS_DEFAULT_LEVEL = 0.6f

static

Default chorus level

◆ FLUID_CHORUS_DEFAULT_N

const int MidiPlayerTK.MidiSynth.FLUID_CHORUS_DEFAULT_N = 3

static

Default chorus voice count

◆ FLUID_CHORUS_DEFAULT_SPEED

const float MidiPlayerTK.MidiSynth.FLUID_CHORUS_DEFAULT_SPEED = 0.2f

static

Default chorus speed

◆ FLUID_CHORUS_DEFAULT_WIDTH

const float MidiPlayerTK.MidiSynth.FLUID_CHORUS_DEFAULT_WIDTH = 10f

static

Default chorus width gradually stereo effect

◆ FLUID_REVERB_DEFAULT_DAMP

const float MidiPlayerTK.MidiSynth.FLUID_REVERB_DEFAULT_DAMP = 0.3f

static

Default reverb damping

◆ FLUID_REVERB_DEFAULT_LEVEL

const float MidiPlayerTK.MidiSynth.FLUID_REVERB_DEFAULT_LEVEL = 0.7f

static

Default reverb level

◆ FLUID_REVERB_DEFAULT_ROOMSIZE

const float MidiPlayerTK.MidiSynth.FLUID_REVERB_DEFAULT_ROOMSIZE = 0.5f

static

Default reverb room size

◆ FLUID_REVERB_DEFAULT_WIDTH

const float MidiPlayerTK.MidiSynth.FLUID_REVERB_DEFAULT_WIDTH = 0.8f

static

Default reverb width

◆ MPTK_ApplyModLfo

bool MidiPlayerTK.MidiSynth.MPTK_ApplyModLfo

Apply LFO effect defined in the SoundFont

◆ MPTK_ApplyRealTimeModulator

bool MidiPlayerTK.MidiSynth.MPTK_ApplyRealTimeModulator

Apply real time modulatoreffect defined in the SoundFont: pitch bend, control change, enveloppe modulation

◆ MPTK_ApplyVibLfo

bool MidiPlayerTK.MidiSynth.MPTK_ApplyVibLfo

Apply vibrato effect defined in the SoundFont

◆ MPTK_AudioSettingFromUnity

bool MidiPlayerTK.MidiSynth.MPTK_AudioSettingFromUnity

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!

◆ MPTK_AutoBuffer

bool MidiPlayerTK.MidiSynth.MPTK_AutoBuffer = true

Voice buffering is important to get better performance.

if enabled
- move all voices state OFF from Active to Free list
- automatic cleaning of the free list
else
- voices state OFF are removed from the Active list But you can disable this fonction with this parameter.

◆ MPTK_AutoCleanVoiceLimit

int MidiPlayerTK.MidiSynth.MPTK_AutoCleanVoiceLimit

Free voices older than MPTK_AutoCleanVoiceLimit are removed when count is over than MPTK_AutoCleanVoiceTime

◆ MPTK_CorePlayer

bool MidiPlayerTK.MidiSynth.MPTK_CorePlayer

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)

◆ MPTK_CutOffVolume

float MidiPlayerTK.MidiSynth.MPTK_CutOffVolume = 0.0001f

When amplitude of a sample is below this value the playing of sample is stopped.
Can be increase for better performance (when a lot of samples are played concurrently) but with degraded quality because sample could be stopped too early. Remember: Amplitude can varying between 0 and 1.

Version: 2.9.1 // was 0.03

◆ MPTK_DirectSendToPlayer

bool MidiPlayerTK.MidiSynth.MPTK_DirectSendToPlayer

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.

◆ MPTK_EffectSoundFont

MPTKEffectSoundFont MidiPlayerTK.MidiSynth.MPTK_EffectSoundFont

A SoundFont contains parameters to apply three kinds of effects: low-pass filter, reverb, chorus.
These parameters can be specifics for each instruments and even each voices.
Maestro MPTK effects are based on FluidSynth algo effects modules. Furthermore, to get more liberty from SoundFont, Maestro Pro can increase or decrease the impact of effects (from the inspector or by script). To summarize:

Effects are applied individually to each voices, yet they are statically defined within the SoundFont.
Maestro parameters can be adjusted to increase or decrease the default values set in the SoundFont.
These adjustments will be applied across the entire prefab, but the effect will depend on the initial settings defined in the SoundFont preset.
Please note that these effects require additional CPU resources. See more detailed information here https://paxstellar.fr/sound-effects/
Note
By default, only low-filter effect is enabled in Maestro.
To enable them, you’ll need to adjust the settings from the prefab inspector (Synth Parameters / SoundFont Effect) or by script!
For enhanced sound quality, it’s beneficial to add a low-filter effect, it is enabled by default..
// Find a MPTK Prefab, will works also for MidiStreamPlayer, MidiExternalPlayer ... all classes which inherit from MidiSynth.

MidiFilePlayer fp = FindFirstObjectByType<MidiFilePlayer>();

fp.MPTK_EffectSoundFont.EnableFilter = true;

fp.MPTK_EffectSoundFont.FilterFreqOffset = 500;

MidiPlayerTK.MidiFilePlayer
Play a MIDI file from the MidiDB. This class must be used with the prefab MidiFilePlayer....
Definition: MidiFilePlayer.cs:69

◆ MPTK_EffectUnity

MPTKEffectUnity MidiPlayerTK.MidiSynth.MPTK_EffectUnity

Unlike SoundFont effects, they applied to the whole player. On the other hand, the Unity effects parameters are rich and, obviously based on Uniy algo!
https://docs.unity3d.com/Manual/class-AudioEffectMixer.html
Only most important effect are integrated in Maestro: Reverb and Chorus. On need, others effects could be added.

Note

Unity effects integration modules are exclusively available with the Maestro MPTK Pro version.
By default, these effects are disabled in Maestro.
To enable them, you’ll need to adjust the settings from the prefab inspector: Synth Parameters / Unity Effect.
Each settings are available by script.
// Find a MPTK Prefab, will works also for MidiStreamPlayer, MidiExternalPlayer ... all classes which inherit from MidiSynth.

MidiFilePlayer fp = FindFirstObjectByType<MidiFilePlayer>();

fp.MPTK_EffectUnity.EnableReverb = true;

fp.MPTK_EffectUnity.ReverbDelay= 0.09f;

MidiPlayerTK.MPTKEffectUnity.ReverbDelay
float ReverbDelay
Definition: MPTKEffectUnityPro.cs:231

MidiPlayerTK.MidiSynth.MPTK_EffectUnity
MPTKEffectUnity MPTK_EffectUnity
Unlike SoundFont effects, they applied to the whole player. On the other hand, the Unity effects para...
Definition: MidiSynthPro.cs:200

◆ MPTK_EnableChangeTempo

bool MidiPlayerTK.MidiSynth.MPTK_EnableChangeTempo

Enable MIDI events tempo change from the MIDI file when playing. If disabled, only the first tempo change found in the MIDI will be applied (or 120 if not tempo change). Disable it when you want to change tempo by your script.

◆ MPTK_EnableFreeSynthRate

bool MidiPlayerTK.MidiSynth.MPTK_EnableFreeSynthRate = false

Allow direct setting of the Synth Rate

◆ MPTK_EnablePanChange

bool MidiPlayerTK.MidiSynth.MPTK_EnablePanChange

Should change pan from MIDI Events or from SoundFont ?
Pan is disabled when Spatialization is activated.

◆ MPTK_EnablePresetDrum

bool MidiPlayerTK.MidiSynth.MPTK_EnablePresetDrum

Should accept change Preset for Drum canal 9 (drum) ?
Could sometimes create unexpected music with MIDI files not compliant with the MIDI standard. Example that could produce unexpected music. Generally, default drum bank is set to 128. With these events on channel 9,
preset 0 of the bank 0 will be selected for the drum ... and that will be, in general, a piano

Bank change channel 9 = 0
Preset change channel 9 = 0 @Attention
with MidiFilePlayer, MPTK_EnablePresetDrum isset to false by default
with MidiStreamPlayer, MPTK_EnablePresetDrum is set to true by default (all the MIDI events are generated by your script. Also, you know what!)

◆ MPTK_InstrumentNum

int MidiPlayerTK.MidiSynth.MPTK_InstrumentNum

When spatialization is track mode, contains the last instrument (preset) played.

Version: Maestro Pro

◆ MPTK_KillByExclusiveClass

bool MidiPlayerTK.MidiSynth.MPTK_KillByExclusiveClass = true

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.

◆ MPTK_LeanSynthStarting

float MidiPlayerTK.MidiSynth.MPTK_LeanSynthStarting = 0.05f

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.

◆ MPTK_LogEvents

bool MidiPlayerTK.MidiSynth.MPTK_LogEvents

Log MIDI events (v2.9.0 moved from MidiFilePlayer)

◆ MPTK_LogWave

bool MidiPlayerTK.MidiSynth.MPTK_LogWave

Log for each sample to be played

◆ MPTK_ReleaseSameNote

bool MidiPlayerTK.MidiSynth.MPTK_ReleaseSameNote = true

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.

◆ MPTK_ReleaseTimeMin

uint MidiPlayerTK.MidiSynth.MPTK_ReleaseTimeMin = 500000

[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.

◆ MPTK_ReleaseTimeMod

float MidiPlayerTK.MidiSynth.MPTK_ReleaseTimeMod = 1f

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.

◆ MPTK_SpatialSynthEnabled

bool MidiPlayerTK.MidiSynth.MPTK_SpatialSynthEnabled

In spatialization mode not all MidiSynths are enabled.

Version: Maestro Pro

◆ MPTK_StatVoiceCountActive

int MidiPlayerTK.MidiSynth.MPTK_StatVoiceCountActive

Count of the active voices (playing and releasing) - Readonly

◆ MPTK_StatVoiceCountFree

int MidiPlayerTK.MidiSynth.MPTK_StatVoiceCountFree

Count of the free voices for reusing on need.
Voice older than AutoCleanVoiceTime are removed but only when count is over than AutoCleanVoiceLimit - Readonly

◆ MPTK_StatVoiceCountPlaying

int MidiPlayerTK.MidiSynth.MPTK_StatVoiceCountPlaying

Count of the active voices (playing excluding voices in release step) - Readonly

◆ MPTK_StatVoiceCountReused

int MidiPlayerTK.MidiSynth.MPTK_StatVoiceCountReused

Count of the voices reused - Readonly

◆ MPTK_StatVoicePlayed

int MidiPlayerTK.MidiSynth.MPTK_StatVoicePlayed

Count of voice played since the start of the synth

◆ MPTK_StatVoiceRatioReused

int MidiPlayerTK.MidiSynth.MPTK_StatVoiceRatioReused

Percentage of voice reused during the synth life. 0: any reuse, 100:all voice reused (unattainable, of course!)

◆ MPTK_ThreadMidiWait

int MidiPlayerTK.MidiSynth.MPTK_ThreadMidiWait = 10

Delay in milliseconds the MIDI thread waits before reading each MIDI events groups.

◆ MPTK_WeakDevice

bool MidiPlayerTK.MidiSynth.MPTK_WeakDevice

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.

◆ OnBeatEvent

Action<int, long, int, int> MidiPlayerTK.MidiSynth.OnBeatEvent

Action is executed at each beat and received these parameters:

time: time in milliseconds since the start of the playing MIDI.
tick: current tick.
measure: current measure (start from 1).
beat: current beat (start from 1).

Note

OnBeatEvent is executed at each beat even if there is there no MIDI event on the beat.
Accuracy is garanteed (internal thread).
Direct call to Unity API is not possible but Debug.Log and Maestro API (example, play a sound at each beat) are allowed.

Version: Maestro Pro

 
                // OnBeatEvent (pro) is triggered by the MPTK MIDI sequencer at each beat independantly of MIDI events 
                //    - OnBeatEvent is executed at each beat even if there is there no MIDI event on the beat.
                //    - Accuracy is garanteed (internal thread).
                //    - Direct call to Unity API is not possible (but you have access to all your script variables and most part of the MPTK API).
                // Parameters received: 
                //    - time        Time in milliseconds since the start of the playing MIDI.
                //    - tick        Current tick of the beat.
                //    - measure     Current measure (start from 1).
                //    - beat        Current beat (start from 1).
                midiFilePlayer.OnBeatEvent = (int time, long tick, int measure, int beat) =>
                {
                    if (FoldOutMetronome)
                    {
                        // Calculate the value to be displayed on the FoldOut Metronome and on the log
                        beatTimeTick = $"Time: {TimeSpan.FromMilliseconds(time)} Tick: {tick}";
                        beatMeasure = $"Beat/Measure: {beat}/{measure}";
 
                        Debug.Log($"OnBeatEvent - {beatTimeTick} Signature segment:{midiFilePlayer.MPTK_MidiLoaded.MPTK_CurrentSignMap.Index} {beatMeasure}");
 
                        // for testing interaction with Maestro MPTK player
                        if (stopPlayingAtMeasure != -1 && measure >= stopPlayingAtMeasure)
                            // Stops playback of the MIDI file. But the triggering event could be still playing (too late for stop it).
                            midiFilePlayer.MPTK_Stop(false);
 
                        // Plays an extra drum sound with each beat
                        midiFilePlayer.MPTK_PlayDirectEvent(new MPTKEvent()
                        {
                            Command = MPTKCommand.NoteOn,
                            Channel = 9,
                            Value = instrumentMetronome,
                            Velocity = volumeMetronome,
                            Measure = measure,
                            Beat = beat
                        });
                    }
                };

◆ OnEventSynthAwake

EventSynthClass MidiPlayerTK.MidiSynth.OnEventSynthAwake

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).

...
   midiStreamPlayer.OnEventSynthAwake.AddListener(StartLoadingSynth);
...
public void StartLoadingSynth(string name)
{
    Debug.LogFormat("Synth {0} loading", name);
}

◆ OnEventSynthStarted

EventSynthClass MidiPlayerTK.MidiSynth.OnEventSynthStarted

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).

 
        public void EndLoadingSynth(string name)
        {
            Debug.Log($"EndLoadingSynth - Synth {name} loaded, now change bank and preset");
 
            if (MAX_CHANNEL != 16)
                // MIDI standard is limited to 16 channels.
                // With MidiStream it's possible to extend channels number until 256.
                // Warning: it's not possible to create MIDI file with channels number over 16.
                midiStreamPlayer.MPTK_InitSynth(MAX_CHANNEL);
 
            // Mandatory for updating UI list but not for playing sample.
            // The default instrument and drum banks are defined with the popup "SoundFont Setup Alt-F" in the Unity editor.
            // This method can be used by script to change the instrument bank and build presets available for it: MPTK_ListPreset.
            MidiPlayerGlobal.MPTK_SelectBankInstrument(CurrentBank);
 
            // Don't forget to initialize your MidiStreamPlayer variable, see link below:
            // https://paxstellar.fr/api-mptk-v2/#DefinedVariablePrefab
 
            // Channel 0: set Piano (if SoundFont is GeneralUser GS v1.471)
            // Define bank with CurrentBank (value defined in inspector to 0).
            midiStreamPlayer.MPTK_PlayEvent(new MPTKEvent() { Command = MPTKCommand.ControlChange, Controller = MPTKController.BankSelectMsb, Value = CurrentBank, Channel = StreamChannel, });
            Debug.LogFormat($"   Bank '{CurrentBank}' defined on channel {StreamChannel}");
 
            // Defined preset with CurrentPreset (value defined in inspector to 0).
            midiStreamPlayer.MPTK_Channels[StreamChannel].PresetNum = CurrentPreset;
            Debug.LogFormat($"   Preset '{midiStreamPlayer.MPTK_Channels[StreamChannel].PresetName}' defined on channel {StreamChannel}");
 
            // Playing a preset from another bank in the channel 1
 
            // Channel 1: set Laser Gun (if SoundFont is GeneralUser GS v1.471)
            // TBD int channel = 1, bank = 2, preset = 127;
            //midiStreamPlayer.MPTK_PlayEvent(new MPTKEvent() { Command = MPTKCommand.ControlChange, Controller = MPTKController.BankSelectMsb, Value = bank, Channel = channel, });
            //midiStreamPlayer.MPTK_ChannelPresetChange(channel, preset);
            // Before v2.10.1 Debug.LogFormat($"   Preset '{MidiPlayerGlobal.MPTK_GetPatchName(bank, preset)}' defined on channel {channel} and bank {bank}");
        }
 

◆ OnMidiEvent

Func<MPTKEvent, bool> MidiPlayerTK.MidiSynth.OnMidiEvent

This function is called by the MIDI sequencer before sending the MIDI message to the MIDI synthesizer.
From version 2.10.0 the callback must return a boolean (see example). true to keep the event, false to skip it.

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
Many changes are possible on the MIDI event: change note, velocity, channel, skip ..., even changing the MIDI type of the message!!!
See below some examples of run-time changes.

Version: Maestro Pro

Note

The callback is running on a system thread not on the Unity thread. Unity API call is not possible except for the Debug.Log (to be gently used, it consumes CPU)
Avoid heavy processing or waiting inside the callback otherwise MIDI playing accuracy will be bad.
The midiEvent is passed by reference to the callback, so re-instanciate object (midiEvent = new MPTKEvent()) or set to null, has no effect!
MIDI position attributs (Tick and RealTime) can be used in your algo but changing their values has no effect, it's too late!
Changing SetTempo event is too late for the MIDI Sequencer (already taken into account). But you can use midiFilePlayer.CurrentTempo to change the tempo

: Some examples:
// See TestMidiFilePlayerScripting.cs for the demo.

void Start()

{

MidiFilePlayer midiFilePlayer = FindFirstObjectByType<MidiFilePlayer>();

midiFilePlayer.OnMidiEvent = PreProcessMidi;

}

// Some example

bool PreProcessMidi(MPTKEvent midiEvent)

{

bool playEvent=true;

switch (midiEvent.Command)

{

case MPTKCommand.NoteOn:

if (midiEvent.Channel != 9)

// transpose 2 octaves

midiEvent.Value += 24;

else

// Drums are muted

playEvent= false;

break;

case MPTKCommand.PatchChange:

// Remove all patch change: all channels will played the default preset 0!!!

midiEvent.Command = MPTKCommand.MetaEvent;

midiEvent.Meta = MPTKMeta.TextEvent;

midiEvent.Info = "Patch Change removed";

break;

case MPTKCommand.MetaEvent:

if (midiEvent.Meta == MPTKMeta.SetTempo)

// Tempo forced to 100

midiFilePlayer.CurrentTempo = 100

break;

}

// true: plays this event, false to skip

return playEvent;

}

MidiPlayerTK.MPTKEvent.Meta
MPTKMeta Meta
Definition: MPTKEvent.cs:111

MidiPlayerTK.MPTKEvent.Command
MPTKCommand Command
Definition: MPTKEvent.cs:99

MidiPlayerTK.MPTKEvent.Channel
int Channel
Definition: MPTKEvent.cs:158

MidiPlayerTK.MPTKMeta
MPTKMeta
Definition: MPTKEnum.cs:321

◆ playOnlyFirstWave

bool MidiPlayerTK.MidiSynth.playOnlyFirstWave

Preset are often composed with 2 or more samples, classically for left and right channel. Check this to play only the first sample found

◆ SpatialSynths

List<MidiFilePlayer> MidiPlayerTK.MidiSynth.SpatialSynths

static

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.

Property Documentation

◆ MPTK_IndexSynthBuffSize

int MidiPlayerTK.MidiSynth.MPTK_IndexSynthBuffSize

getset

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.

◆ MPTK_IndexSynthRate

int MidiPlayerTK.MidiSynth.MPTK_IndexSynthRate

getset

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.

◆ MPTK_InstrumentPlayed

string MidiPlayerTK.MidiSynth.MPTK_InstrumentPlayed

get

If spatialization is track mode, contains the last instrument played on this track.

Version: Maestro Pro

◆ MPTK_IsSpatialSynthMaster

bool MidiPlayerTK.MidiSynth.MPTK_IsSpatialSynthMaster

get

True if this MidiSynth is the master synth responsible to read midi events and to dispatch to other MidiSynths

Version: Maestro Pro

◆ MPTK_KeepPlayingNonLooped

bool MidiPlayerTK.MidiSynth.MPTK_KeepPlayingNonLooped

getset

When the value is true, NoteOff and Duration for non-looped samples are ignored and the samples play through to the end.

◆ MPTK_MaxDistance

float MidiPlayerTK.MidiSynth.MPTK_MaxDistance

getset

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.

◆ MPTK_PauseOnDistance

bool MidiPlayerTK.MidiSynth.MPTK_PauseOnDistance

getset

[obsolete] replaced by MPTK_Spatialize"); V2.83

◆ MPTK_Spatialize

bool MidiPlayerTK.MidiSynth.MPTK_Spatialize

getset

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

◆ MPTK_SpatialSynthIndex

int MidiPlayerTK.MidiSynth.MPTK_SpatialSynthIndex

get

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.

◆ MPTK_SynthRate

int MidiPlayerTK.MidiSynth.MPTK_SynthRate

getset

Get the the current synth rate or set free value (only if MPTK_EnableFreeSynthRate is true).

◆ MPTK_ThreadMidiPriority

int MidiPlayerTK.MidiSynth.MPTK_ThreadMidiPriority

getset

The MIDI thread’s priority shows how frequently a thread gains the access to CPU. The default value is 0 (normal), you can increase the priority to 1 and 2 (higher).
This is useful when the hardware is weak, to get a more stable reading of the MIDI.

Note: : A higher priority thread might consume all the CPU time. It's recommended to set MPTK_ThreadMidiWait higher than 5 ms.

◆ MPTK_TrackName

string MidiPlayerTK.MidiSynth.MPTK_TrackName

get

If spatialization is track mode, contains the last name of the track .

Version: Maestro Pro

◆ MPTK_TransExcludedChannel

int MidiPlayerTK.MidiSynth.MPTK_TransExcludedChannel

getset

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.

◆ MPTK_Transpose

int MidiPlayerTK.MidiSynth.MPTK_Transpose

getset

Transpose note from -24 to 24

◆ MPTK_Volume

float MidiPlayerTK.MidiSynth.MPTK_Volume

getset

Global Volume between 0 and 1.

Event Documentation

◆ OnAudioFrameStart

OnAudioFrameStartHandler MidiPlayerTK.MidiSynth.OnAudioFrameStart

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.

Version: Maestro Pro

: // See Assets\MidiPlayer\Demo\ProDemos\Script\EuclideSeq\TestEuclideanRhythme.cs for the full code.

public void Play()

{

if (IsPlaying)

midiStream.OnAudioFrameStart += PlayHits;

else

midiStream.OnAudioFrameStart -= PlayHits;

}

private void PlayHits(double synthTimeMS)

{

if (lastSynthTime <= 0d)

// First call, init the last time

lastSynthTime = synthTimeMS;

// Calculate time in millisecond since the last loop

double deltaTime = synthTimeMS - lastSynthTime;

lastSynthTime = synthTimeMS;

timeMidiFromStartPlay += deltaTime;

// Calculate time since last beat played

timeSinceLastBeat += deltaTime;

// Slider SldTempo in BPM.

// 60 BPM means 60 beats in each minute, 1 beat per second, 1000 ms between beat.

// 120 BPM would be twice as fast: 120 beats in each minute, 2 per second, 500 ms between beat.

// Calculate the delay between two quarter notes in millisecond

CurrentTempo = (60d / SldTempo.Value) * 1000d;

// Is it time to play a hit ?

if (IsPlaying && timeSinceLastBeat > CurrentTempo)

{

timeSinceLastBeat = 0d;

CurrentBeat++;

}

}

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Events

Detailed Description

Member Enumeration Documentation

◆ ModeSpatializer

Member Function Documentation

◆ MPTK_BuildInfoSynth()

◆ MPTK_ClearAllSound()

◆ MPTK_InitSynth()

◆ MPTK_ResetStat()

◆ MPTK_StartSequencerMidi()

◆ MPTK_StartSynth()

◆ MPTK_StopSynth()

◆ MPTK_WaitAllNotesOff()

◆ OnAudioFrameStartHandler()

Member Data Documentation

◆ FLUID_CHORUS_DEFAULT_DEPTH

◆ FLUID_CHORUS_DEFAULT_LEVEL

◆ FLUID_CHORUS_DEFAULT_N

◆ FLUID_CHORUS_DEFAULT_SPEED

◆ FLUID_CHORUS_DEFAULT_WIDTH

◆ FLUID_REVERB_DEFAULT_DAMP

◆ FLUID_REVERB_DEFAULT_LEVEL

◆ FLUID_REVERB_DEFAULT_ROOMSIZE

◆ FLUID_REVERB_DEFAULT_WIDTH

◆ MPTK_ApplyModLfo

◆ MPTK_ApplyRealTimeModulator

◆ MPTK_ApplyVibLfo

◆ MPTK_AudioSettingFromUnity

◆ MPTK_AutoBuffer

◆ MPTK_AutoCleanVoiceLimit

◆ MPTK_CorePlayer

◆ MPTK_CutOffVolume

◆ MPTK_DirectSendToPlayer

◆ MPTK_EffectSoundFont

◆ MPTK_EffectUnity

◆ MPTK_EnableChangeTempo

◆ MPTK_EnableFreeSynthRate

◆ MPTK_EnablePanChange

◆ MPTK_EnablePresetDrum

◆ MPTK_InstrumentNum

◆ MPTK_KillByExclusiveClass

◆ MPTK_LeanSynthStarting

◆ MPTK_LogEvents

◆ MPTK_LogWave

◆ MPTK_ReleaseSameNote

◆ MPTK_ReleaseTimeMin

◆ MPTK_ReleaseTimeMod

◆ MPTK_SpatialSynthEnabled

◆ MPTK_StatVoiceCountActive

◆ MPTK_StatVoiceCountFree

◆ MPTK_StatVoiceCountPlaying

◆ MPTK_StatVoiceCountReused

◆ MPTK_StatVoicePlayed

◆ MPTK_StatVoiceRatioReused

◆ MPTK_ThreadMidiWait

◆ MPTK_WeakDevice

◆ OnBeatEvent

◆ OnEventSynthAwake

◆ OnEventSynthStarted

◆ OnMidiEvent

◆ playOnlyFirstWave

◆ SpatialSynths

Property Documentation

◆ MPTK_IndexSynthBuffSize

◆ MPTK_IndexSynthRate

◆ MPTK_InstrumentPlayed

◆ MPTK_IsSpatialSynthMaster

◆ MPTK_KeepPlayingNonLooped

◆ MPTK_MaxDistance

◆ MPTK_PauseOnDistance

◆ MPTK_Spatialize

◆ MPTK_SpatialSynthIndex

◆ MPTK_SynthRate

◆ MPTK_ThreadMidiPriority