tracktion_ProjectItem.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 ProjectItem   : public Selectable,
                      public juce::ReferenceCountedObject,
                      private juce::Timer,
                      private juce::AsyncUpdater
{
public:
    //==============================================================================
    enum class Category
    {
        none,
        edit,
        recorded,
        exports,
        archives,
        imported,
        rendered,
        frozen,
        video
    };
 
    enum class RenameMode
    {
        always,
        local,
        never
    };
 
    enum class SetNameMode
    {
        doDefault,
        forceRename,
        forceNoRename
    };
 
    using Ptr = juce::ReferenceCountedObjectPtr<ProjectItem>;
    using Array = juce::ReferenceCountedArray<ProjectItem>;
 
    //==============================================================================
    ProjectItem (Engine&, ProjectItemID, juce::InputStream*);
 
    //==============================================================================
    ProjectItem (Engine&,
                 const juce::String& name,
                 const juce::String& type,
                 const juce::String& desc,
                 const juce::String& file,
                 Category,
                 double length,
                 ProjectItemID);
 
    ~ProjectItem() override;
 
    //==============================================================================
    juce::String getSelectableDescription() override;
    void selectionStatusChanged (bool isNowSelected) override;
 
    //==============================================================================
    ProjectItemID getID() const noexcept            { return itemID; }
 
    juce::ReferenceCountedObjectPtr<Project> getProject() const;
 
    // checks whether it's been removed from its project
    bool hasBeenDeleted() const;
 
    static const char* waveItemType() noexcept      { return "wave"; }
    static const char* editItemType() noexcept      { return "edit"; }
    static const char* midiItemType() noexcept      { return "midi"; }
    static const char* videoItemType() noexcept     { return "video"; }
 
    const juce::String& getType() const;
 
    bool isWave() const noexcept                    { return getType() == waveItemType(); }
    bool isMidi() const noexcept                    { return getType() == midiItemType(); }
    bool isEdit() const noexcept                    { return getType() == editItemType(); }
    bool isVideo() const noexcept                   { return getType() == videoItemType(); }
 
    const juce::String& getName() const;
    void setName (const juce::String& name, SetNameMode mode);
 
    Category getCategory() const;
    void setCategory (Category cat);
 
    // get/set a persistent string property with a name. Setting to empty removes it
    juce::String getNamedProperty (const juce::String& name) const;
    void setNamedProperty (const juce::String& name, const juce::String& value);
 
    juce::String getDescription() const;
    void setDescription (const juce::String& newDesc);
 
    juce::Array<TimePosition> getMarkedPoints() const;
    void setMarkedPoints (const juce::Array<TimePosition>& points);
 
    void copyAllPropertiesFrom (const ProjectItem& other);
 
    bool convertEditFile();
 
    double getLength() const;
    void setLength (double length);
 
    juce::String getProjectName() const;
 
    juce::File getEditPreviewFile() const;
 
    juce::File getEditThumbnailFile() const;
 
    //==============================================================================
    juce::File getSourceFile();
    juce::String getRawFileName() const       { return file; }
    juce::String getFileName() const;
 
    enum class FileMode
    {
        absolute,
        relative,
        relativeIfWithinProject
    };
 
    void setSourceFile (const juce::File&, FileMode mode = FileMode::relativeIfWithinProject);
    bool isForFile (const juce::File&);
    bool isAbsolutePath() const;
    void convertToRelativePath();
    void convertToAbsolutePath();
 
    void renameSourceFile();
 
    Ptr createCopy();
 
    void sendChange();
 
    //==============================================================================
    bool copySectionToNewFile (const juce::File& destFile,
                               juce::File& actualFileCreated,
                               double startTime,
                               double length);
 
    bool deleteSourceFile();
 
    void verifyLength();
 
    void changeProjectId (int oldID, int newID);
 
    //==============================================================================
    void writeToStream (juce::OutputStream&) const;
 
    juce::StringArray getSearchTokens() const;
 
    Engine& engine; 
private:
    friend class ProjectManager;
    friend class Project;
 
    ProjectItemID itemID;
    juce::String type, objectName, description, file;
    double length = 0;
    juce::File sourceFile, newDstFile;
 
    void timerCallback() override;
    void handleAsyncUpdate() override;
 
    juce::File getRelativeFile (const juce::String&) const;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ProjectItem)
};
 
}} // namespace tracktion { inline namespace engine