tracktion_RenderManager.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 RenderManager   : private juce::DeletedAtShutdown,
                        private juce::AsyncUpdater
{
public:
    //==============================================================================
    class Job  : public ThreadPoolJobWithProgress,
                 private juce::MessageListener,
                 private juce::Timer
    {
    public:
        //==============================================================================
        using Ptr = juce::ReferenceCountedObjectPtr<Job>;
 
        ~Job() override;
 
        JobStatus runJob() override;
 
        float getCurrentTaskProgress() override             { return progress; }
 
        void cancelJob();
 
        void cleanUpDanglingJob()                           { selfReference = nullptr; }
 
        //==============================================================================
        void incReferenceCount() noexcept                   { ++refCount; }
        bool decReferenceCountWithoutDeleting() noexcept;
        int getReferenceCount() const noexcept              { return refCount.get(); }
 
        //==============================================================================
        struct Listener
        {
            virtual ~Listener() {}
            virtual void jobStarted (RenderManager::Job&) {}
            virtual void jobFinished (RenderManager::Job&, bool completedOk) = 0;
        };
 
        void addListener (Listener* l)                      { listeners.add (l); }
        void removeListener (Listener* l)                   { listeners.remove (l); }
 
        //==============================================================================
        Engine& engine;
        AudioFile proxy;
        std::atomic<float> progress { 0 };
 
        virtual bool setUpRender() = 0;
 
        virtual bool renderNextBlock() = 0;
 
        virtual bool completeRender() = 0;
 
    protected:
        //==============================================================================
        Job (Engine&, const AudioFile& proxy); // don't instantiate directly!
 
    private:
        //==============================================================================
        struct UpdateMessage  : public juce::Message
        {
            enum Type
            {
                started,
                succeded,
                cancelled,
                unknown
            };
 
            UpdateMessage (Type t) : type (t) {}
 
            static Type getType (const juce::Message& message)
            {
                if (auto um = dynamic_cast<const UpdateMessage*> (&message))
                    return um->type;
 
                return unknown;
            }
 
            Type type;
 
            JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (UpdateMessage)
        };
 
        //==============================================================================
        enum { messageRetryTimeout = 50 };
 
        juce::ListenerList<Listener> listeners;
        juce::Atomic<int> refCount;
        Ptr selfReference;
        juce::CriticalSection messageLock, finishedLock;
        juce::Array<UpdateMessage::Type> messagesToResend;
        bool isInitialised = false, hasFinished = false;
 
        void sendCompletionMessages (bool success);
 
        void handleMessage (const juce::Message&) override;
        void timerCallback() override;
 
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Job)
    };
 
    //==============================================================================
    RenderManager (Engine&);
    ~RenderManager() override;
 
    void cleanUp();
 
    //==============================================================================
    static AudioFile getAudioFileForHash (Engine&, const juce::File& directory, HashCode hash);
 
    Job::Ptr getRenderJobWithoutCreating (const AudioFile& audioFile)       { return findJob (audioFile); }
 
    juce::ReferenceCountedArray<Job> getRenderJobsWithoutCreating (const AudioFile&);
 
    int getNumJobs() noexcept;
 
    //==============================================================================
    static juce::StringRef getFileRenderPrefix()      { return "render_"; }
 
    bool isProxyBeingGenerated (const AudioFile& proxyFile) noexcept;
 
    float getProportionComplete (const AudioFile& proxyFile, float defaultVal) noexcept;
 
    Engine& engine;
 
private:
    //==============================================================================
    juce::Array<Job*> jobs, danglingJobs;
    juce::OwnedArray<Job> jobsToDelete;
    juce::CriticalSection jobListLock, deleteListLock;
 
    Job::Ptr findJob (const AudioFile&) noexcept;
    void addJobInternal (Job*) noexcept;
    void removeJobInternal (Job*) noexcept;
    void addJobToPool (Job*) noexcept;
    void deleteJob (Job*);
 
    void handleAsyncUpdate() override;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (RenderManager)
};
 
}} // namespace tracktion { inline namespace engine