Synthetic Legato

d.healey

Ah now I see. That snippet and the legato script that goes with it is from 2017! The latest version which I linked to was 2019. So I wouldn't rely on that snippet. Also it seems there was a bug in that snippet, the reg bendTime variable seems to be missing from on init.

hisefilo

@d-healey can you post the link here? Can't find it on forum search (thanks in advance:)

d.healey

@hisefilo It's the post before yours - https://forum.hise.audio/topic/228/synthetic-legato/13

hisefilo

@d-healey oh!!! Sorry. Now it's working! What a great script you've done!!

2 questions.

How can I do to dont kill notes on a chord when you play same time a legato note?
Let's say I play G chord and also note D does a legato to E. Is there a way to keep not legato notes to not be killed?

And: What's needed at my end to use part of your script? Shoul I credit you? Should I pay you? Sorry can't totally understand the license model.

d.healey

@hisefilo I think it would require some significant changes to prevent chord notes being killed. One way to do it is when a note is pressed you check if a chord is already playing and if it is you stash those note ids and start a fresh legato phrase. Another way would be to stash all chords by default so that as soon as a chord is played the note IDs are stored independently of legato note ids. There are probably other approaches to this problem too. The tricky part will be trying to avoid all the situations that create hanging notes.

All my none trivial scripts are licensed under the GNU GPL v3 - https://www.gnu.org/licenses/gpl-3.0.en.html - the basic gist is if you use my code in your project you must release your code under the same license.

hisefilo

@d-healey oh. I see. Thought a simple tweak will work but I need to do a new approach then.

I think I will split my sound source into attack and decay so I can change behavior for both independently

d.healey

Actually I just looked at the code again and what you're wanting is probably simpler than I thought.

I've made a modified version that stores chord notes independently in a MIDI list. There are almost certainly some hanging note type bugs but I'll leave those for you to enjoy :)

/*
    Copyright 2018, 2019 David Healey

    This file is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This file is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with This file. If not, see <http://www.gnu.org/licenses/>.
*/

Content.setWidth(730);
Content.setHeight(200);

reg coarseDetune = 0;
reg fineDetune = 0;
reg lastCoarseDetune = 0;
reg lastFineDetune = 0;

reg channel;
reg note = -1;
reg retriggerNote = -1;
reg velocity;
reg interval;
reg fadeTm = 10;
reg bendTm = 10;
reg bendAmt = 0;
reg eventId = -1;
reg chordIds = Engine.createMidiList();
reg lastTime;
reg offset;
reg rate;
const var bendLookup = []; //Generated on init (onControl) and updated when bend amount changed
reg glideNote;
const var notes = [];
notes.reserve(2);

//Breath control
reg lastBreathValue = 0;
reg threshold;

//GUI
const var btnMute = Content.addButton("btnMute", 0, 10);
btnMute.set("text", "Mute");
btnMute.set("tooltip", "Enable this to bypass the script. Still responds to hanging notes.");

const var knbOffset = Content.addKnob("knbOffset", 0, 50);
knbOffset.set("text", "Offset");
knbOffset.setRange(0, 1000, 1);
knbOffset.set("suffix", "ms");
knbOffset.set("tooltip", "Sample start offset time for legato and glide notes.");

const var btnRetrigger = Content.addButton("btnRetrigger", 0, 110);
btnRetrigger.set("text", "CC64 Retrigger");
btnRetrigger.set("tooltip", "When enabled sustain pedal is used to retrigger notes, when disabled sustain pedal will hold legato notes.");

const var knbFadeMin = Content.addKnob("knbFadeMin", 150, 0);
knbFadeMin.set("text", "Fade Tm Min");
knbFadeMin.setRange(0, 1000, 1);
knbFadeMin.set("suffix", "ms");
knbFadeMin.set("tooltip", "Minimum legato fade time.");

const var knbFadeMax = Content.addKnob("knbFadeMax", 150, 50);
knbFadeMax.set("text", "Fade Tm Max");
knbFadeMax.setRange(0, 1000, 1);
knbFadeMax.set("suffix", "ms");
knbFadeMax.set("tooltip", "Maximum legato fade time.");

const var knbFadeOut = Content.addKnob("knbFadeOut", 150, 100);
knbFadeOut.set("text", "Fade Out Ratio");
knbFadeOut.setRange(10, 100, 1);
knbFadeOut.set("suffix", "%");
knbFadeOut.set("tooltip", "Percentage of overall fade time to be used to fade out old notes.");

const var knbBendTm = Content.addKnob("knbBendTm", 300, 0);
knbBendTm.set("text", "Bend Tm");
knbBendTm.setRange(-50, 50, 1);
knbBendTm.set("suffix", "%");
knbBendTm.set("tooltip", "Use this knob to set +-50% of fade time that will be used for bend time.");

const var knbBendMin = Content.addKnob("knbBendMin", 300, 50);
knbBendMin.set("text", "Bend Min");
knbBendMin.setRange(0, 100, 1);
knbBendMin.set("suffix", "ct");
knbBendMin.set("tooltip", "Pitch bend amount for 1 semi-tone.");

const var knbBendMax = Content.addKnob("knbBendMax", 300, 100);
knbBendMax.set("text", "Bend Max");
knbBendMax.setRange(0, 100, 1);
knbBendMax.set("suffix", "ct");
knbBendMax.set("tooltip", "Pitch bend amount for 1 octave.");

const var knbRate = Content.addKnob("knbRate", 450, 0);
knbRate.set("text", "Glide Rate");
knbRate.set("mode", "TempoSync");
knbRate.set("tooltip", "Rate for glide timer relative to current tempo.");

const var btnGlideVel = Content.addButton("btnGlideVel", 450, 60);
btnGlideVel.set("text", "Velocity = Rate");
btnGlideVel.set("tooltip", "When enabled glide rate knob will be controlled by note on velocity.");

const var btnWholeStep = Content.addButton("btnWholeStep", 450, 110);
btnWholeStep.set("text", "Whole Step Glide");
btnWholeStep.set("tooltip", "When enabled glides will be per whole step rather than each semi-tone.");

const var knbMaxGlide = Content.addKnob("knbMaxGlide", 450, 150);
knbMaxGlide.set("text", "Max Glide");
knbMaxGlide.setRange(0, 11, 1);
knbMaxGlide.set("tooltip", "Limits the maximum glide interval. A value of 0 means no limit");

//Breath controller GUI
const var btnBc = Content.addButton("btnBc", 600, 10);
btnBc.set("text", "Breath Control");
btnBc.set("tooltip", "Toggles breath controller mode.");

const var knbBreath = Content.addKnob("knbBreath", 600, 50);
knbBreath.set("text", "Breath");
knbBreath.setRange(0, 127, 1);
knbBreath.set("tooltip", "Breath controller knob, value should be set by CC.");
knbBreath.setControlCallback(breathTrigger);

const var knbThreshold = Content.addKnob("knbThreshold", 600, 100);
knbThreshold.set("text", "Trigger Level");
knbThreshold.setRange(10, 127, 1);
knbThreshold.set("tooltip", "Breath controller trigger threshold.");

/**
 * A lookup table is used for pitch bending to save CPU. This function fills that lookup table based on the min bend and max bend values.
 * @param  {number} minBend The amount of bend for an interval of 1 semitone
 * @param  {number} maxBend The amount of bend for an interval of 12 semitones
  */
inline function updateBendLookupTable(minBend, maxBend)
{
	for (i = 0; i < 12; i++) //Each semitone
	{
		bendLookup[i] = ((i + 1) * (maxBend - minBend)) / 12 + minBend;
	}
}

inline function setLegatoFadeTime(interval, velocity)
{
    local fadeMin = knbFadeMin.getValue();
    local fadeMax = knbFadeMax.getValue();

    //fadeTm is time between notes / 2 (*500), limited to upper and lower range
    fadeTm = Math.range((Engine.getUptime() - lastTime) * 500, fadeMin, fadeMax);

    //Adjust fadeTm based on interval
    fadeTm = fadeTm + (interval * 2);

    //Reduce fadeTm by 30% is velocity > 64
    if (velocity > 64) fadeTm = fadeTm - (fadeTm * 0.3);
}

/**
 * Returns the timer rate for glides
 * @param  {number} interval [The distance between the two notes that will be glided]
 * @return {number}          [Timer rate]
 */
inline function setRate(interval)
{
	rate = knbRate.getValue(); //Get rate knob value

	rate = Engine.getMilliSecondsForTempo(rate) / 1000; //Rate to milliseconds for timer

	rate = Math.max(0.04, rate / interval); //Rate is per glide step - capped at timer's min
}

//Breath controller handler;
inline function breathTrigger(control, value)
{
    if (!btnMute.getValue() && btnBc.getValue())
    {
        //Going up and reached the threshold
        if (value >= threshold && lastBreathValue < threshold && note != -1)
        {
            //Turn off old note
            if (eventId != -1) Synth.noteOffByEventId(eventId);

            //Play new note
            eventId = Synth.playNoteWithStartOffset(channel, note, velocity, 0);
            Synth.addPitchFade(eventId, 0, coarseDetune, fineDetune);  //Add any detuning
        }
        else if (value < threshold && eventId != -1)
        {
            Synth.noteOffByEventId(eventId);
            eventId = -1;
        }

        lastBreathValue = value;
    }
}function onNoteOn()
{
    if (!btnMute.getValue())
    {
        Synth.stopTimer(); //Stop the timer (if it's running)

        if ((Engine.getUptime() - lastTime) > 0.025) //Not a chord
        {
            //Pick up values have been applied to the notes before this point
            lastCoarseDetune = coarseDetune;
            lastFineDetune = fineDetune;
            coarseDetune = Message.getCoarseDetune();
            fineDetune = Message.getFineDetune();

            if (btnBc.getValue() && knbBreath.getValue() < threshold) //If breath controller enabled and the bcc is below the threshold
            {
                Message.ignoreEvent(true); //Ignore the event
            }
            else if (note != -1 && eventId != -1) //If there is a last note
            {
                //Calculate played interval - limit max to 12
                interval = Math.min(Math.abs(note - Message.getNoteNumber()), 12);

                if (Synth.isLegatoInterval() && Synth.isSustainPedalDown() && eventId != -1 && (knbMaxGlide.getValue() == 0 || interval <= knbMaxGlide.getValue())) //Glide
                {
                    Message.ignoreEvent(true);

                    //If glide rate determined by velocity
                    if (btnGlideVel.getValue())
                        knbRate.setValue((Message.getVelocity()/127) * 18);

                    glideNote = note; //First note of glide (same as origin)
                    notes[0] = note; //Origin
                    notes[1] = Message.getNoteNumber(); //Target

                    //Get rate for timer
                    setRate(Math.abs(notes[0] - notes[1]));

                    //Start the timer
                    Synth.startTimer(rate);
                }
                else //Legato
                {
                    //Set global fadeTm value
                    setLegatoFadeTime(interval, Message.getVelocity());

                    //Set global bendTm value
                    bendTm = fadeTm / 100 * (100 + knbBendTm.getValue());

                    //Set global bendAmt value
                    interval > 0 ? bendAmt = bendLookup[interval - 1] : bendAmt = bendLookup[0]; //Get value from lookup table
                    if (note > Message.getNoteNumber()) bendAmt = -bendAmt; //Invert for down interval

                    //Set start offset
                    Message.setStartOffset(offset);

                    //Get coarseDetune and fineDetune for old notes
                    local fadeCoarse = lastCoarseDetune + parseInt((bendAmt+lastFineDetune) / 100);
                    local fadeFine = ((bendAmt+lastFineDetune) % 100);

                    //Fade out old note
                    Synth.addVolumeFade(eventId, fadeTm / 100 * knbFadeOut.getValue(), -100); //Volume
                    Synth.addPitchFade(eventId, bendTm / 100 * knbFadeOut.getValue(), fadeCoarse, fadeFine); //Pitch

                    //Update eventId
                    eventId = Message.makeArtificial();

                    //Get coarseDetune and fineDetune for new note
                    fadeCoarse = coarseDetune + parseInt((-bendAmt+fineDetune) / 100);
                    fadeFine = ((-bendAmt+fineDetune) % 100);

                    //Fade in new note
                    Synth.addVolumeFade(eventId, 0, -99); //Set initial volume
                    Synth.addVolumeFade(eventId, fadeTm, Message.getGain());

                    Synth.addPitchFade(eventId, 0, fadeCoarse, fadeFine); //Set initial detuning
                    Synth.addPitchFade(eventId, bendTm, coarseDetune, fineDetune); //Pitch fade to fineDetune
                }
            }
            else //First note of phrase
            {
                Message.setGain(0);
                eventId = Message.makeArtificial(); //Update eventId
                Synth.addPitchFade(eventId, 0, coarseDetune, fineDetune); //Pitch
            }

            //Update variables
            channel = Message.getChannel();
            retriggerNote = note;
            note = Message.getNoteNumber();
            velocity = Math.max(1, Message.getVelocity());
            lastTime = Engine.getUptime();
        }
        else
        {
            if (eventId != -1)
                chordIds.setValue(Message.getNoteNumber(), eventId); //Stash the old note id
            else
                chordIds.setValue(Message.getNoteNumber(), Message.makeArtificial());
         
            eventId = -1;
        }
    }
}
function onNoteOff()
{
    if (!btnMute.getValue())
    {
        if (Message.getNoteNumber() == retriggerNote)
        {
            retriggerNote = -1;
        }

        //Sustain pedal retrigger
		if (Synth.isSustainPedalDown() && btnRetrigger.getValue())
		{
            retriggerNote = note; //Retrigger note becomes the last note
		}

        if (Message.getNoteNumber() == note)
        {
            if ((Synth.isSustainPedalDown() == 0 && btnRetrigger.getValue() == 0) || btnRetrigger.getValue()) //CC64 sustain
            {
                Message.ignoreEvent(true);

                if (retriggerNote != -1 && (knbBreath.getValue() > threshold || btnBc.getValue() == 0) && eventId != -1)
                {
                    //Get coarseDetune and fineDetune for old notes
                    local fadeCoarse = coarseDetune + parseInt((bendAmt+fineDetune) / 100);
                    local fadeFine = ((bendAmt+fineDetune) % 100);

                    //Fade out old note
                    Synth.addVolumeFade(eventId, fadeTm / 100 * knbFadeOut.getValue(), -100); //Volume
                    Synth.addPitchFade(eventId, bendTm / 100 * knbFadeOut.getValue(), fadeCoarse, fadeFine); //Pitch

                    //Play new note
                    eventId = Synth.playNoteWithStartOffset(channel, retriggerNote+Message.getTransposeAmount(), velocity, offset);

                    //Get coarseDetune and fineDetune for the new note
                    coarseDetune = Message.getCoarseDetune();
                    fineDetune = Message.getFineDetune();

                    fadeCoarse = coarseDetune + parseInt((-bendAmt+fineDetune) / 100);
                    fadeFine = ((-bendAmt+fineDetune) % 100);

                    //Fade in new note
                    Synth.addVolumeFade(eventId, 0, -99); //Set initial volume
                    Synth.addVolumeFade(eventId, fadeTm, 0);

                    Synth.addPitchFade(eventId, 0, fadeCoarse, fadeFine); //Set initial detuning
                    Synth.addPitchFade(eventId, bendTm, coarseDetune, fineDetune); //Pitch fade to fineDetune

                    //Update variables
                    note = retriggerNote;
                    retriggerNote = -1;
                }
                else
                {
                    if (eventId != -1) Synth.noteOffByEventId(eventId);
                    eventId = -1;
                    note = -1;
                }
            }

            Synth.stopTimer();
        }
        else 
        {
            if (chordIds.getValue(Message.getNoteNumber()) != -1)
                Synth.noteOffByEventId(chordIds.getValue(Message.getNoteNumber()));
            
                chordIds.setValue(Message.getNoteNumber(), -1);
        }
    }
    else
    {
        if (eventId != -1) //Prevent hanging notes
        {
            //Turn off old note
            Synth.noteOffByEventId(eventId);
            eventId = -1;
            note = -1;
            Synth.stopTimer();
        }
        
        if (chordIds.getValue(Message.getNoteNumber()) != -1)
            Synth.noteOffByEventId(chordIds.getValue(Message.getNoteNumber()));
            
            chordIds.setValue(Message.getNoteNumber(), -1);
            
    }
}
function onController()
{
    if (!btnMute.getValue())
    {
        //Turn off the last note if the sutain pedal is lifted and last note is still playing
        if (!Synth.isSustainPedalDown() && Synth.getNumPressedKeys() == 0 && eventId != -1)
        {
            Synth.noteOffByEventId(eventId);
            eventId = -1;
            note = -1;
        }
    }
}
function onTimer()
{
    if (!btnMute.getValue())
    {
	    local glideBend = 100;

        notes[1] > notes[0] ? glideNote++ : glideNote--; //Increment/decrement the glideNote number by 1 (a half step)

        //If the whole step button is enabled then increment/decrement the glideNote by another half step
        if (btnWholeStep.getValue()) notes[1] > notes[0] ? glideNote++ : glideNote--;

        //If glide has not completed - i.e. it hasn't reached the target note yet
        if (eventId != -1 && notes[0] != -1 && ((notes[1] > notes[0] && glideNote <= notes[1]) || (notes[1] < notes[0] && glideNote >= notes[1])))
        {
            if (notes[0] > notes[1]) glideBend = -glideBend; //Invert bend for down glide
        }
        else
        {
            notes[0] = notes[1]; //Origin becomes target
            glideNote = notes[1];
            Synth.stopTimer();
        }

		if (Synth.isTimerRunning()) //Timer may have been stopped if glide target reached, so check before proceeding
		{
            //Get coarseDetune and fineDetune for the old note
            local fadeCoarse = lastCoarseDetune + parseInt((glideBend+lastFineDetune) / 100); //Coarse
            local fadeFine = ((glideBend+lastFineDetune) % 100); //Fine

            //Reset old note's pitch trackers
            lastCoarseDetune = 0;
			lastFineDetune = 0;

		    //Fade out old note
			Synth.addPitchFade(eventId, rate*1000, fadeCoarse, fadeFine); //Pitch fade old note to bend amount
			Synth.addVolumeFade(eventId, rate*1000, -100); //Fade out last note

			//Play new note
			eventId = Synth.playNoteWithStartOffset(channel, glideNote, velocity, offset);

			//Fade in new note
			Synth.addVolumeFade(eventId, 0, -99); //Set new note's initial volume
			Synth.addVolumeFade(eventId, rate*1000, 0); //Fade in new note
			Synth.addPitchFade(eventId, 0, 0, -glideBend); //Set new note's initial detuning
			Synth.addPitchFade(eventId, rate*1000, 0, 0); //Pitch fade new note to 0
		}
	}
}
function onControl(number, value)
{
	switch (number)
    {
        case knbOffset:
            offset = Engine.getSamplesForMilliSeconds(value);
        break;

        case knbBendMin: case knbBendMax:
            updateBendLookupTable(knbBendMin.getValue(), knbBendMax.getValue());
        break;

		case knbRate:
			if (Synth.isTimerRunning()) //If timer's already started then update its Rate
			{
				setRate(Math.abs(notes[0] - notes[1]));
				Synth.startTimer(rate);
			}
		break;

		case knbThreshold:
		    threshold = value;
		break;
    }
}

hisefilo

@d-healey thanks man! trying it. The closest I can get to the behavior I want is changing this value. But still not sounding how I need it. I guess I need to figure some other way to get it. (it's for a guitar, not a wind instrument, so will need some custom work)

if ((Engine.getUptime() - lastTime) > 0.325) //Not a chord

Legato ugly example https://www.youtube.com/watch?v=ixMj0eJVb0A

d.healey

@hisefilo That value checks the time between the first note and second note and if that time is greater than the threshold > 0.325 it assumes a legato phrase, if it's less than the threshold it means the two notes were played very fast and it assumes a chord.

Lindon

@d-healey Hi, I'm about to start implementing this script (and thanks a LOT for it) , but theres one very small addition I'd like to add - My instrument has a toggle for Mono/Poly, so right now if toggle = Mono its turning off any/all existing note.

I think I have a few ideas where to start - so do you want to talk about it here or in some chat session and share the results if I can get it to work?

d.healey

@Lindon Let's keep it here for everyone to benefit :)

Lindon

@d-healey sure no problem, well looking at the script I think all I need do is replace this line:

if ((Engine.getUptime() - lastTime) > 0.025) //Not a chord

with

if ((Engine.getUptime() - lastTime) > 0.025)  || (MonoOnly = true)

d.healey

@Lindon Looks good to me, just change = to ==. Actually you can drop the == true altogether.

Lindon

@d-healey OK well I think I dont understand what i'm supposed to do with the script, as its not excuting .. where can I put it?

It's currently in a container(with all the samplers in it) below the one containing the interface....

Oh hang on getting there...

zing. Done. Thanks.

lalalandsynth

@d-healey

Wanted to try this , do i use this script in the midi processor ?

Lindon

@lalalandsynth yep.

lalalandsynth

I am guessing that this cannot glide between adjacent notes?

d.healey

@lalalandsynth It can. It is GPL licensed though so can only be used in a GPL project.

AxiomCrux

@d-healey Your link takes me to a 404 and I can't seem to find an updated version in your git, the only other one that seemed like it could be it was the PortGlide script but that one was also marked with the date 2017

d.healey

@AxiomCrux This is a long thread, which script are you looking for?

Synthetic Legato

20

1.7k

11.8k

102.4k