tracktion_EditClipRenderJob.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 EditRenderJob   : public RenderManager::Job
{
public:
    //==============================================================================
    static Ptr getOrCreateRenderJob (Engine&, Renderer::Parameters&, bool deleteEdit,
                                     bool silenceOnBackup, bool reverse);
 
    static Ptr getOrCreateRenderJob (Engine&, const AudioFile& destFile, const RenderOptions&, ProjectItemID itemID,
                                     bool silenceOnBackup, bool reverse);
 
    //==============================================================================
    ~EditRenderJob() override;
 
    const Renderer::Parameters& getParams() const noexcept  { return params; }
 
    juce::AudioThumbnail& getAudioThumbnail()               { return thumbnailToUpdate; }
 
    bool isMidi() const noexcept                            { return params.createMidiFile; }
 
    Renderer::RenderResult& getResult()                     { return result; }
 
    juce::String getLastError() const;
 
protected:
    //==============================================================================
    bool setUpRender() override;
    bool renderNextBlock() override;
    bool completeRender() override;
    void setLastError (const juce::String&);
 
private:
    //==============================================================================
    struct RenderPass
    {
        RenderPass (EditRenderJob&, Renderer::Parameters&, const juce::String& description);
        ~RenderPass();
 
        bool initialise();
 
        EditRenderJob& owner;
        Renderer::Parameters r;
        const juce::String desc;
        ProjectItem::Category originalCategory;
        juce::TemporaryFile tempFile;
        std::unique_ptr<Renderer::RenderTask> task;
    };
 
    RenderOptions renderOptions;
    const ProjectItemID itemID;
 
    Renderer::Parameters params;
    juce::OptionalScopedPointer<Edit> editDeleter;
    std::unique_ptr<Edit::ScopedRenderStatus> renderStatus;
    juce::OwnedArray<RenderPass> renderPasses;
    bool silenceOnBackup, reverse;
    Renderer::RenderResult result;
 
    juce::String lastError;
    juce::CriticalSection errorLock;
 
    juce::AudioThumbnail thumbnailToUpdate;
 
    void renderSeparateTracks();
    bool generateSilence (const juce::File& fileToWriteTo);
 
    //==============================================================================
    EditRenderJob (Engine&, const Renderer::Parameters&, bool deleteEdit, bool silenceOnBackup, bool reverse);
 
    EditRenderJob (Engine&, const AudioFile& destFile, const RenderOptions&, ProjectItemID itemID,
                   bool silenceOnBackup, bool reverse);
 
    //==============================================================================
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (EditRenderJob)
};
 
}} // namespace tracktion { inline namespace engine