tracktion_AutomationCurve.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 AutomationCurve
{
public:
    AutomationCurve();
    AutomationCurve (const juce::ValueTree& parent, const juce::ValueTree& state);
    AutomationCurve (const AutomationCurve&);
    ~AutomationCurve();
 
    void setState (const juce::ValueTree&);
    void setParentState (const juce::ValueTree&);
    void setOwnerParameter (AutomatableParameter*);
 
    AutomatableParameter* getOwnerParameter() const noexcept        { return ownerParam; }
 
    //==============================================================================
    struct AutomationPoint
    {
        AutomationPoint() noexcept = default;
 
        AutomationPoint (TimePosition t, float v, float c) noexcept
            : time (t), value (v), curve (c)
        {
            jassert (c >= -1.0 && c <= 1.0);
            jassert (t.inSeconds() >= 0);
        }
 
        juce::ValueTree toValueTree() const;
 
        TimePosition time;
        float value = 0, curve = 0;
 
        bool operator< (const AutomationPoint& other) const     { return time < other.time; }
    };
 
    //==============================================================================
    int getNumPoints() const noexcept;
    TimeDuration getLength() const;
    juce::Range<float> getValueLimits() const;
 
    AutomationPoint getPoint (int index) const noexcept;
    TimePosition getPointTime (int index) const noexcept;
    float getPointValue (int index) const noexcept;
    float getPointCurve (int index) const noexcept;
 
    CurvePoint getBezierHandle (int index) const noexcept;
    CurvePoint getBezierPoint (int index) const noexcept;
    void getBezierEnds (int index, double& x1, float& y1, double& x2, float& y2) const noexcept;
 
    float getValueAt (TimePosition) const;
 
    int indexBefore (TimePosition) const;
    int nextIndexAfter (TimePosition) const;
 
    // returns the index of the next index after this point, xToYRatio is 1 scren unit in value / 1 screen unit in time
    int getNearestPoint (TimePosition&, float& v, double xToYRatio) const;
 
    int countPointsInRegion (TimeRange) const;
 
    //==============================================================================
    void clear();
 
    // returns index of new point
    int addPoint (TimePosition, float value, float curve);
    void removePoint (int index);
    void removePointsInRegion (TimeRange);
    void removeRegionAndCloseGap (TimeRange);
    void removeRedundantPoints (TimeRange);
 
    juce::Array<AutomationPoint> getPointsInRegion (TimeRange) const;
 
    // returns the new index of the point, which may have changed
    int movePoint (int index, TimePosition, float newValue, bool removeInterveningPoints);
 
    void setPointTime (int index, TimePosition);
    void setPointValue (int index, float newValue);
    void setCurveValue (int index, float newCurve);
 
    //==============================================================================
    void mergeOtherCurve (const AutomationCurve& source,
                          TimeRange destRange,
                          TimePosition sourceStartTime,
                          TimeDuration fadeLength,
                          bool leaveOpenAtStart,
                          bool leaveOpenEnded);
 
    void simplify (TimeRange, double minTimeDifference, float minValueDifference);
    void rescaleAllTimes (double factor);
    void addToAllTimes (TimeDuration delta);
    void rescaleValues (float factor, TimeRange);
    void addToValues (float valueDelta, TimeRange);
 
    static double getBezierXfromT (double t, double x1, double xb, double x2);
    static float getBezierYFromX (double t, double x1, float y1, double xb, float yb, double x2, float y2);
 
    static void removeAllAutomationCurvesRecursively (const juce::ValueTree&);
 
    juce::ValueTree parentState, state;
 
private:
    AutomatableParameter* ownerParam = nullptr;
 
    juce::UndoManager* getUndoManager() const;
    void addPointAtIndex (int index, TimePosition, float v, float c);
    void checkParenthoodStatus();
 
    JUCE_LEAK_DETECTOR (AutomationCurve)
};
 
//==============================================================================
int simplify (AutomationCurve&, int strength, TimeRange);
 
}} // namespace tracktion { inline namespace engine