tracktion_FreezePoint.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 FreezePointPlugin    : public Plugin
{
public:
    // matches the global settings
    enum Position
    {
        beforeAllPlugins = 0,
        preFader,
        postFader
    };
 
    struct ScopedTrackUnsoloer
    {
        ScopedTrackUnsoloer (Edit& e);
        ~ScopedTrackUnsoloer();
 
        Edit& edit;
        juce::BigInteger soloed, soloIsolated;
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ScopedTrackUnsoloer)
    };
 
    struct ScopedTrackSoloIsolator
    {
        ScopedTrackSoloIsolator (Edit& e, Track::Array&);
        ~ScopedTrackSoloIsolator();
 
        Edit& edit;
        Track::Array tracks;
        juce::BigInteger muted, notSoloIsolated;
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ScopedTrackSoloIsolator)
    };
 
    struct ScopedPluginDisabler
    {
        ScopedPluginDisabler (Track& track, juce::Range<int> pluginsToDisable);
        ~ScopedPluginDisabler();
 
    private:
        Track& track;
        juce::Range<int> indexes;
        juce::BigInteger enabled;
 
        void enablePlugins (bool enable);
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ScopedPluginDisabler)
    };
 
    struct ScopedTrackFreezer
    {
        ScopedTrackFreezer (FreezePointPlugin& o);
        ~ScopedTrackFreezer();
 
        EditItemID trackID;
        FreezePointPlugin& owner;
        bool wasFrozen;
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ScopedTrackFreezer)
    };
 
    static std::unique_ptr<ScopedTrackFreezer> createTrackFreezer (const Plugin::Ptr&);
 
    FreezePointPlugin (PluginCreationInfo);
    ~FreezePointPlugin() override;
 
    static const char* getPluginName()      { return NEEDS_TRANS("Freeze Point"); }
    static juce::ValueTree create();
 
    //==============================================================================
    static const char* xmlTypeName;
 
    void initialiseFully() override;
    juce::String getName() const override               { return TRANS("Freeze"); }
    juce::String getPluginType() override               { return xmlTypeName; }
    juce::String getTooltip() override                  { return TRANS("Track will freeze up to this plugin"); }
    juce::String getSelectableDescription() override    { return TRANS("Freeze Point Plugin"); }
    bool producesAudioWhenNoAudioInput() override       { return false; }
    bool canBeAddedToClip() override                    { return false; }
    bool canBeAddedToRack() override                    { return false; }
    bool canBeAddedToMaster() override                  { return false; }
    bool canBeDisabled() override                       { return false; }
    bool needsConstantBufferSize() override             { return false; }
 
    void initialise (const PluginInitialisationInfo&) override;
    void deinitialise() override;
    void applyToBuffer (const PluginRenderContext&) override;
    int getNumOutputChannelsGivenInputs (int numInputChannels) override     { return numInputChannels; }
 
    bool isTrackFrozen() const;
    void freezeTrack (bool shouldBeFrozen);
 
private:
    //==============================================================================
    int lastFreezeIndex = -1;
 
    void updateTrackFreezeStatus();
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (FreezePointPlugin)
};
 
}} // namespace tracktion { inline namespace engine