tracktion_LoopInfo.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 LoopInfo
{
public:
    LoopInfo (Engine&);
 
    LoopInfo (const LoopInfo&);
 
    LoopInfo (Engine&, const juce::ValueTree&, juce::UndoManager*);
 
    LoopInfo (Engine&, const juce::File&);
 
    LoopInfo (Engine&, const juce::AudioFormatReader*, const juce::AudioFormat*, const juce::File& f);
 
    LoopInfo& operator= (const LoopInfo&);
 
    //==============================================================================
    double getBpm (const AudioFileInfo&) const;
 
    double getBeatsPerSecond (const AudioFileInfo&) const;
 
    void setBpm (double newBpm, const AudioFileInfo&);
 
    //==============================================================================
    int getDenominator() const;
 
    int getNumerator() const;
 
    void setDenominator (int newDenominator);
 
    void setNumerator (int newNumerator);
 
    double getNumBeats() const;
 
    void setNumBeats (double newNumBeats);
 
    //==============================================================================
    bool isLoopable() const;
 
    bool isOneShot() const;
 
    //==============================================================================
    int getRootNote() const;
 
    void setRootNote (int note);
 
    //==============================================================================
    SampleCount getInMarker() const;
 
    SampleCount getOutMarker() const;
 
    void setInMarker (SampleCount);
 
    void setOutMarker (SampleCount);
 
    //==============================================================================
    enum class LoopPointType
    {
        manual = 0, 
        automatic   
    };
 
    struct LoopPoint
    {
        SampleCount pos = 0;                        
        LoopPointType type = LoopPointType::manual; 
        bool isAutomatic() const        { return type == LoopPointType::automatic; }
    };
 
    int getNumLoopPoints() const;
 
    LoopPoint getLoopPoint (int index) const;
 
    void addLoopPoint (SampleCount, LoopPointType);
 
    void changeLoopPoint (int index, SampleCount, LoopPointType);
 
    void deleteLoopPoint (int index);
 
    void clearLoopPoints();
 
    void clearLoopPoints (LoopPointType);
 
    //==============================================================================
    int getNumTags() const;
 
    void clearTags();
 
    juce::String getTag (int index) const;
 
    void addTag (const juce::String& tag);
 
    void addTags (const juce::StringArray& tags);
 
    Engine& engine;         
    juce::ValueTree state;  
private:
    juce::CriticalSection lock;
    juce::UndoManager* um = nullptr;
    bool maintainParent = false;
 
    void init (const juce::AudioFormatReader*, const juce::AudioFormat*, const juce::File& file);
    void initialiseMissingProps();
    void duplicateIfShared();
    LoopInfo& copyFrom (const juce::ValueTree&);
    void removeChildIfEmpty (const juce::Identifier&);
    juce::ValueTree getLoopPoints() const;
    juce::ValueTree getOrCreateLoopPoints();
    juce::ValueTree getTags() const;
    juce::ValueTree getOrCreateTags();
    void setBpm (double newBpm, double currentBpm);
    
    bool deduceTempo (const juce::File& file, const juce::AudioFormatReader&);
    std::optional<float> getCueTempo (const juce::StringPairArray& metadata);
    std::optional<float> getFileNameTempo (const juce::String& rawName);
    std::optional<int> getFileNameRootNote (const juce::String& rawName);
 
    template<typename Type>
    void setProp (const juce::Identifier& i, Type v)
    {
        duplicateIfShared();
        const juce::ScopedLock sl (lock);
        state.setProperty (i, v, um);
    }
 
    template<typename Type>
    Type getProp (const juce::Identifier& i) const
    {
        const juce::ScopedLock sl (lock);
        return state.getProperty (i);
    }
 
    JUCE_LEAK_DETECTOR (LoopInfo)
};
 
}} // namespace tracktion { inline namespace engine