tracktion_PitchShift.cpp

Go to the documentation of this file.

 /*
    ,--.                     ,--.     ,--.  ,--.
  ,-'  '-.,--.--.,--,--.,---.|  |,-.,-'  '-.`--' ,---. ,--,--,      Copyright 2024
  '-.  .-'|  .--' ,-.  | .--'|     /'-.  .-',--.| .-. ||      \   Tracktion Software
    |  |  |  |  \ '-'  \ `--.|  \  \  |  |  |  |' '-' '|  ||  |       Corporation
    `---' `--'   `--`--'`---'`--'`--' `---' `--' `---' `--''--'    www.tracktion.com
 
    Tracktion Engine uses a GPL/commercial licence - see LICENCE.md for details.
*/
 
namespace tracktion { inline namespace engine
{
 
struct PitchShiftPlugin::Pimpl
{
    static constexpr int samplesPerBlock = 512;
 
    Pimpl (PitchShiftPlugin& p) : owner (p)
    {
    }
 
    void initialise (double sr, float semitonesUp, TimeStretcher::Mode newMode, TimeStretcher::ElastiqueProOptions newOptions)
    {
        if (timestretcher == nullptr || mode != newMode || elastiqueOptions != newOptions)
        {
            mode = newMode;
            elastiqueOptions = newOptions;
            timestretcher = std::make_unique<TimeStretcher>();
        }
 
        if (! timestretcher->isInitialised())
        {
            timestretcher->initialise (sr, samplesPerBlock, 2, mode, elastiqueOptions, true);
            jassert (timestretcher->isInitialised());
        }
 
        if (timestretcher->isInitialised())
        {
            timestretcher->reset();
            timestretcher->setSpeedAndPitch (1.0f, semitonesUp);
 
            latencySamples = timestretcher->getMaxFramesNeeded();
 
            inputFifo.setSize (2, latencySamples + 2000);
            outputFifo.setSize (2, latencySamples + 2000);
        }
 
        inputFifo.reset();
        outputFifo.reset();
 
        outputFifo.writeSilence (latencySamples);
 
        latencySeconds = latencySamples / sr;
    }
 
    void applyToBuffer (const PluginRenderContext& fc, float semis)
    {
        SCOPED_REALTIME_CHECK
 
        if (timestretcher->isInitialised())
        {
            auto newMode = (TimeStretcher::Mode) owner.mode.get();
            auto newOptions = owner.elastiqueOptions.get();
 
            if (newMode != mode || newOptions != elastiqueOptions)
                initialise (owner.sampleRate, semis, newMode, newOptions);
 
            inputFifo.write (*fc.destBuffer, fc.bufferStartSample, fc.bufferNumSamples);
 
            if (! timestretcher->setSpeedAndPitch (1.0f, semis))
                jassertfalse;
 
            // Loop until output FIFO has enough samples to proceed
            {
                int needed = timestretcher->getFramesNeeded();
 
                for (;;)
                {
                    if (inputFifo.getNumReady() < needed)
                        break;
 
                    if (outputFifo.getFreeSpace() < samplesPerBlock)
                        break;
 
                    timestretcher->processData (inputFifo, needed, outputFifo);
                    needed = timestretcher->getFramesNeeded();
 
                    if (outputFifo.getNumReady() >= fc.bufferNumSamples)
                        break;
                }
            }
 
            if (outputFifo.getNumReady() < fc.bufferNumSamples)
            {
                jassertfalse;
                fc.destBuffer->clear (fc.bufferStartSample, fc.bufferNumSamples);
            }
            else
            {
                outputFifo.read (*fc.destBuffer, fc.bufferStartSample, fc.bufferNumSamples);
            }
 
            if (fc.bufferForMidiMessages != nullptr)
                fc.bufferForMidiMessages->addToNoteNumbers (juce::roundToInt (semis));
        }
    }
 
    PitchShiftPlugin& owner;
 
    std::unique_ptr<TimeStretcher> timestretcher;
    TimeStretcher::Mode mode = TimeStretcher::disabled;
    TimeStretcher::ElastiqueProOptions elastiqueOptions;
 
    AudioFifo inputFifo { 2, 2000 }, outputFifo { 2, 2000 };
 
    int latencySamples = 8192;
    double latencySeconds = latencySamples / 44100.0;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Pimpl)
};
 
//==============================================================================
PitchShiftPlugin::PitchShiftPlugin (PluginCreationInfo info) : Plugin (info)
{
    pimpl = std::make_unique<Pimpl> (*this);
 
    auto um = getUndoManager();
 
    semitones = addParam ("semitones up", TRANS("Semitones"),
                          { -PitchShiftPlugin::getMaximumSemitones(), PitchShiftPlugin::getMaximumSemitones() },
                          [] (float value)            { return std::abs (value) < 0.01f ? "(" + TRANS("Original pitch") + ")"
                                                                                        : getSemitonesAsString (value); },
                          [] (const juce::String& s)  { return juce::jlimit (-PitchShiftPlugin::getMaximumSemitones(),
                                                                             PitchShiftPlugin::getMaximumSemitones(),
                                                                             s.getFloatValue()); });
 
    semitonesValue.referTo (state, IDs::semitonesUp, um);
    mode.referTo (state, IDs::mode, um, (int) TimeStretcher::defaultMode);
    elastiqueOptions.referTo (state, IDs::elastiqueOptions, um);
 
    semitones->attachToCurrentValue (semitonesValue);
}
 
PitchShiftPlugin::PitchShiftPlugin (Edit& ed, const juce::ValueTree& v)
    : PitchShiftPlugin (PluginCreationInfo (ed, v, false))
{
}
 
PitchShiftPlugin::~PitchShiftPlugin()
{
    notifyListenersOfDeletion();
 
    semitones->detachFromCurrentValue();
}
 
juce::ValueTree PitchShiftPlugin::create()
{
    return createValueTree (IDs::PLUGIN,
                            IDs::type, xmlTypeName);
}
 
const char* PitchShiftPlugin::xmlTypeName = "pitchShifter";
 
//==============================================================================
void PitchShiftPlugin::initialise (const PluginInitialisationInfo& info)
{
    pimpl->initialise (info.sampleRate, semitones->getCurrentValue(),
                       (TimeStretcher::Mode) mode.get(), elastiqueOptions.get());
}
 
void PitchShiftPlugin::deinitialise()
{
}
 
void PitchShiftPlugin::applyToBuffer (const PluginRenderContext& fc)
{
    pimpl->applyToBuffer (fc, semitones->getCurrentValue());
 
    clearChannels (*fc.destBuffer, 2, -1, fc.bufferStartSample, fc.bufferNumSamples);
}
 
double PitchShiftPlugin::getLatencySeconds()
{
    return pimpl->latencySeconds;
}
 
juce::String PitchShiftPlugin::getSelectableDescription()
{
    return TRANS("Pitch Shifter Plugin");
}
 
void PitchShiftPlugin::restorePluginStateFromValueTree (const juce::ValueTree& v)
{
    copyPropertiesToCachedValues (v, semitonesValue, mode);
 
    for (auto p : getAutomatableParameters())
        p->updateFromAttachedValue();
}
 
}} // namespace tracktion { inline namespace engine