tracktion_TimeStretch.h

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
{
 
class TimeStretcher
{
public:
    //==============================================================================
    TimeStretcher();
 
    ~TimeStretcher();
 
    //==============================================================================
    enum Mode
    {
        disabled = 0,                   
        elastiqueTransient = 1,         
        elastiqueTonal = 2,             
        soundtouchNormal = 3,           
        soundtouchBetter = 4,           
        melodyne = 5,                   
        elastiquePro = 6,               
        elastiqueEfficient = 7,         
        elastiqueMobile = 8,            
        elastiqueMonophonic = 9,        
        rubberbandMelodic = 10,         
        rubberbandPercussive = 11,      
        elastiqueDirectPro = 12,        
        elastiqueDirectEfficient = 13,  
        elastiqueDirectMobile = 14,     
       #if TRACKTION_ENABLE_TIMESTRETCH_ELASTIQUE
        defaultMode = elastiquePro      
       #elif TRACKTION_ENABLE_TIMESTRETCH_RUBBERBAND
        defaultMode = rubberbandMelodic 
       #elif TRACKTION_ENABLE_TIMESTRETCH_SOUNDTOUCH
        defaultMode = soundtouchBetter  
       #else
        defaultMode = disabled          
       #endif
    };
 
    //==============================================================================
    struct ElastiqueProOptions
    {
        ElastiqueProOptions() = default;
        ElastiqueProOptions (const juce::String& string);
 
        juce::String toString() const;
 
        bool operator== (const ElastiqueProOptions&) const;
        bool operator!= (const ElastiqueProOptions&) const;
 
        bool midSideStereo = false;         
        bool syncTimeStrPitchShft = false;  
        bool preserveFormants = false;      
        int envelopeOrder = 64;             
    };
 
    //==============================================================================
    static Mode checkModeIsAvailable (Mode);
 
    static juce::StringArray getPossibleModes (Engine&, bool excludeMelodyne);
 
    static Mode getModeFromName (Engine&, const juce::String& name);
 
    static juce::String getNameOfMode (Mode);
 
    static bool isMelodyne (Mode);
 
    static bool canProcessFor (Mode);
 
    //==============================================================================
    void initialise (double sourceSampleRate, int samplesPerBlock,
                     int numChannels, Mode, ElastiqueProOptions, bool realtime);
 
    bool isInitialised() const;
 
    void reset();
 
    bool setSpeedAndPitch (float speedRatio, float semitones);
 
    int getMaxFramesNeeded() const;
 
    int getFramesNeeded() const;
 
    int processData (const float* const* inChannels, int numSamples, float* const* outChannels);
 
    int processData (AudioFifo& inFifo, int numSamples, AudioFifo& outFifo);
 
    int flush (float* const* outChannels);
 
    struct Stretcher;
 
private:
    std::unique_ptr<Stretcher> stretcher;
    int samplesPerBlockRequested = 0;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TimeStretcher)
};
 
}} // namespace tracktion { inline namespace engine
 
namespace juce
{
    template <>
    struct VariantConverter<tracktion::engine::TimeStretcher::Mode>
    {
        static tracktion::engine::TimeStretcher::Mode fromVar (const var& v)   { return (tracktion::engine::TimeStretcher::Mode) static_cast<int> (v); }
        static var toVar (tracktion::engine::TimeStretcher::Mode v)            { return static_cast<int> (v); }
    };
 
    template <>
    struct VariantConverter<tracktion::engine::TimeStretcher::ElastiqueProOptions>
    {
        static tracktion::engine::TimeStretcher::ElastiqueProOptions fromVar (const var& v) { return tracktion::engine::TimeStretcher::ElastiqueProOptions (v.toString()); }
        static var toVar (const tracktion::engine::TimeStretcher::ElastiqueProOptions& v)   { return v.toString(); }
    };
}