PresetBundler.h

Go to the documentation of this file.

#pragma once
namespace krotos
{
    class PresetBundler
    {
      public:
        PresetBundler(File preset);
 
        PresetBundler(ValueTree presetData);
 
        static const String BundleFileExtension;
 
        struct AudioAsset
        {
            // local audio asset filepath
            String assetPath; // e.g. "C:\myPath\elements\WIND.wav"
            // filename and subdirectory ID to be used in bundle
            String assetID; // e.g. Asset1\WIND.wav
        };
 
        bool createBundle(File outputLocation, String& errors);
 
        static File openBundle(File bundleArchive);
 
        static File getPresetFromBundleDirectory(File bundleDirectory);
 
        static bool validateBundleDirectory(File bundleDirectory);
 
        static bool isABundlePreset(const File& preset);
 
        int setMaximumBundleSizeInMegaBytes(int newSizeMb) { m_maxSizeMegaBytes = newSizeMb; }
 
        void setPresetFileExtension(String fileExtension);
 
        static File getSandboxDirectory();
        static File getSandboxDirectoryForBundle(const File& bundleFile);
 
        static File getAudioAssetDirectoryForBundle(const File& bundleFile);
 
        static File getPresetDirectoryForBundle(const File& bundleFile);
 
        // Folder name for bundle preset, including a '/' suffix
        static const String PresetSubdirectory;
        // Folder name for audio files, including a '/' suffix
        static const String AudioAssetsSubdirectory;
 
      protected:
        // Get the bundle root path for the preset export
        File getExportBundleRoot();
        // Create a directory in temp as the bundle root
        bool createBundleFileStructure();
        // Clean up the temp bundle root
        void cleanUpFileStructure();
        // Collects asset data using the preset
        std::vector<AudioAsset> getAssetsListFromPreset();
        // Copy the preset file into the bundle root
        File copyPresetForExport(String nameForPresetFile);
        // Copy audio files into the bundle root (.wav, .aif, .aiff, .ogg, .flac)
        void copyAudioAssetsForExport();
        // Updates the file paths in the bundled preset to match the bundled assets
        void processExportedPresetFile(File exportPreset);
        // Creates the .kspb archive file
        File buildBundleArchive(String outputDirectoryPath);
        // Provides an estimate of the bundle size. Does not include any file compression
        // excludes the preset file
        int getEstimatedAssetsSizeMB();
        // Returns a list of any files in the preset that cannot be found on the computer
        String listMissingFiles();
        // Used for unit testing the asset file paths
        std::vector<AudioAsset> getAssetFilepaths() { return m_assetFilepaths; };
        // Users custom factory assets directory path
        String m_factoryAssetsDirectory;
 
      private:
        void initialise(ValueTree presetData);
 
        void clenseExportIDs();
        bool isValueAudioFile(String value);
        bool isValueMultipleFiles(String value);
 
        void getPresetFilepaths(StringArray& listOfFiles, XmlElement widgetElement);
        void findPathAttributesRecursive(StringArray& listOfFiles, XmlElement customParamsElement);
        // Note: This function will not replace paths in an xml tag that contains multiple paths
        // e.g. <TAG value="/My/File/path.wav&#10;/My/File/path2.wav">
        // At present this is only the case in a deprecated parameter in the coreEngine kwidget.
        // These do not require replacing as the kwidget duplicates them into SAMPLES child
        // elements which nicely contain a single path each, these elements will be replaced successfully.
        void replacePaths(XmlElement& widgetElement);
        void replacePathRecursive(XmlElement& widgetElement);
        // converts OS style & checks for custom factory asset paths
        String convertFilepath(String filepathFromPreset);
 
        static String m_presetFileExtension;
        String m_bundleRootId;
        ValueTree m_presetFile;
        std::vector<AudioAsset> m_assetFilepaths;
        int m_maxSizeMegaBytes{1000};
    };
} // namespace krotos