tracktion_Project.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 Project  : public juce::ReferenceCountedObject,
                 public Selectable,
                 private juce::AsyncUpdater
{
public:
    //==============================================================================
    ~Project() override;
 
    //==============================================================================
    bool save();
    void handleAsyncUpdate() override;
 
    //==============================================================================
    bool isValid() const;
    bool isReadOnly() const;
    bool isTemporary() const                                  { return temporary; }
 
    int getProjectID() const;
    juce::String getName() const;
    juce::String getDescription() const;
    const juce::File& getProjectFile() const noexcept         { return file; }
    juce::File getDefaultDirectory() const;
    juce::File getDirectoryForMedia (ProjectItem::Category category) const;
 
    void setName (const juce::String& newName);
    void setDescription (const juce::String& newDesc);
 
    void createNewProjectId();
 
    juce::String getProjectProperty (const juce::String& name) const;
    void setProjectProperty (const juce::String& name, const juce::String& value);
 
    void refreshProjectPropertiesFromFile();
 
    bool isLibraryProject() const;
    bool askAboutTempoDetect (const juce::File&, bool& shouldSetAutoTempo) const;
 
    juce::Array<ProjectItemID> findOrphanItems();
 
    //==============================================================================
    int getNumProjectItems();
    ProjectItemID getProjectItemID (int index);
    juce::Array<ProjectItemID> getAllProjectItemIDs() const;
    juce::Array<int> getAllItemIDs() const;
    ProjectItem::Ptr getProjectItemAt (int index);
    juce::Array<ProjectItem::Ptr> getAllProjectItems();
    int getIndexOf (ProjectItemID) const;
 
    ProjectItem::Ptr getProjectItemForID (ProjectItemID);
    ProjectItem::Ptr getProjectItemForFile (const juce::File& file);
 
    //==============================================================================
    ProjectItem::Ptr createNewItem (const juce::File& fileToReference,
                                    const juce::String& type,
                                    const juce::String& name,
                                    const juce::String& description,
                                    const ProjectItem::Category cat,
                                    bool atTopOfList);
 
    bool removeProjectItem (ProjectItemID, bool deleteSourceMaterial);
 
    void moveProjectItem (int indexToMoveFrom, int indexToMoveTo);
 
    ProjectItem::Ptr createNewEdit();
 
    void redirectIDsFromProject (int oldProjId, int newProjId);
 
    //==============================================================================
    enum NagMode
    {
        nagAsk,     
        nagAutoYes, 
        nagAutoNo   
    };
 
    void mergeArchiveContents (const juce::File& archiveFile);
 
    void mergeOtherProjectIntoThis (const juce::File& otherProject);
 
    void refreshFolderStructure();
    void createDefaultFolders();
 
    //==============================================================================
    enum ProjectSortType
    {
        SortByName,
        SortByDesc,
        SortByType,
        SortByLength,
        SortBySize,
        SortByModified,
        SortByCreated,
    };
 
    //==============================================================================
    void searchFor (juce::Array<ProjectItemID>& results, SearchOperation&);
 
    //==============================================================================
    juce::String getSelectableDescription() override;
 
    void lockFile();
    void unlockFile();
 
    using Ptr = juce::ReferenceCountedObjectPtr<Project>;
 
    Engine& engine;
    ProjectManager& projectManager;
 
private:
    friend class ProjectItem;
    friend class ProjectManager;
 
    juce::File file;
    int projectId = 0;
 
    juce::NamedValueSet properties;
    juce::CriticalSection objectLock, propertyLock;
 
    std::unique_ptr<juce::BufferedInputStream> stream;
    std::unique_ptr<juce::FileInputStream> fileLockingStream;
 
    struct ObjectInfo
    {
        int itemID = 0, fileOffset = 0;
        ProjectItem::Ptr item;
    };
 
    juce::Array<ObjectInfo> objects;
    int objectOffset = 0, indexOffset = 0;
    bool readOnly = false, hasChanged = false, temporary = false;
 
    Project (Engine&, ProjectManager&, const juce::File&);
 
    juce::BufferedInputStream* getInputStream();
 
    void load();
    void saveTo (juce::FileOutputStream&);
    bool readProjectHeader (juce::InputStream&, bool clearObjectInfo = true);
    void loadAllProjectItems();
    bool loadProjectItem (ObjectInfo&);
    void ensureFolderCreated (ProjectItem::Category);
    void changed() override;
 
    ProjectItem::Ptr quickAddProjectItem (const juce::String& relPathName,
                                          const juce::String& type,
                                          const juce::String& name,
                                          const juce::String& description,
                                          const ProjectItem::Category cat,
                                          ProjectItemID newID);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Project)
};
 
}} // namespace tracktion { inline namespace engine