Changeset 1434 for trunk/src/org/apollo/io/AudioPathManager.java

Timestamp:

10/02/19 14:19:48 (5 years ago)

Author:

bln4

Message:

Implementation of ProfileManager. Refactor + additional content for how new profiles are created. The refactoring split out the creation of the default profile from user profiles. Refactoring revealed a long term bug that was causing user profiles to generate with incorrect information. The additional content fixed this bug by introducing the ${USER.NAME} variable, so that the default profile frameset can specify resource locations located in the users resource directory.

org.expeditee.auth.AuthenticatorBrowser
org.expeditee.auth.account.Create
org.expeditee.gui.Browser
org.expeditee.gui.management.ProfileManager
org.expeditee.setting.DirectoryListSetting
org.expeditee.setting.ListSetting
org.expeditee.settings.UserSettings

Implementation of ResourceManager as a core location to get resources from the file system. Also the additional variable ${CURRENT_FRAMESET} to represent the current frameset, so that images can be stored in the directory of the current frameset. This increases portability of framesets.

org.expeditee.gui.FrameIO
org.expeditee.gui.management.ResourceManager
org.expeditee.gui.management.ResourceUtil
Audio:

#NB: Audio used to only operate on a single directory. This has been updated to work in a same way as images. That is: when you ask for a specific resouce, it looks to the user settings to find a sequence of directories to look at in order until it manages to find the desired resource.

There is still need however for a single(ish) source of truth for the .banks and .mastermix file. Therefore these files are now always located in resource-<username>\audio.
org.apollo.agents.MelodySearch
org.apollo.audio.structure.AudioStructureModel
org.apollo.audio.util.MultiTrackPlaybackController
org.apollo.audio.util.SoundDesk
org.apollo.gui.FrameLayoutDaemon
org.apollo.io.AudioPathManager
org.apollo.util.AudioPurger
org.apollo.widgets.FramePlayer
org.apollo.widgets.SampledTrack

Images:

org.expeditee.items.ItemUtils

Frames:

org.expeditee.gui.FrameIO

Fixed a error in the FramePlayer class caused by an incorrect use of toArray().

org.apollo.widgets.FramePlayer

Added several short cut keys to allow for the Play/Pause (Ctrl + P), mute (Ctrl + M) and volume up/down (Ctrl + +/-) when hovering over SampledTrack widgets.

org.apollo.widgets.SampledTrack

Changed the way that Authenticate.login parses the new users profile to be more consistance with other similar places in code.

org.expeditee.auth.account.Authenticate

Encapsulated _body, _surrogateItemsBody and _primaryItemsBody in Frame class. Also changed getBody function to take a boolean flag as to if it should respect the current surrogate mode. If it should then it makes sure that labels have not changed since last time getBody was called.

org.expeditee.gui.Frame

File:

• trunk/src/org/apollo/io/AudioPathManager.java (modified) (7 diffs)

trunk/src/org/apollo/io/AudioPathManager.java

@@ -7 +7 @@
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Random;
+import java.util.function.Predicate;
 
 import org.apollo.audio.structure.AudioStructureModel;
 import org.apollo.util.ApolloSystemLog;
 import org.apollo.util.RegExpFileFilter;
-import org.expeditee.auth.AuthenticatorBrowser;
+import org.expeditee.gui.DisplayController;
 import org.expeditee.gui.FrameIO;
+import org.expeditee.gui.management.ResourceManager;
 import org.expeditee.settings.UserSettings;
 
@@ -29 +33 @@
 
         /** Suffixed with the native file separator */
-        public static String AUDIO_HOME_DIRECTORY = null;
+        public static String AUDIO_USERNAME_HOME_DIRECTORY = null;
         
         /** Stores all virtual names created by this repository. */
@@ -39 +43 @@
 
         private static Random rand = new Random(System.currentTimeMillis());
-
-        // **** DB
-        // Some work to be done here => remove dependency in code on 'AUDIO_HOME_DIRECTORY'
-        // and change it to use audio dir list from UserSettings
-        public static void changeParentAndSubFolders(String newFolder) {
-                
-                if (AuthenticatorBrowser.isAuthenticationRequired() && System.getProperty("user.name").equals(AuthenticatorBrowser.USER_NOBODY)) {
-                        System.err.println("**** AudioPathManager::changeParentAndSubFolder(): Nothing to do for user '" + AuthenticatorBrowser.USER_NOBODY + "'");
-                        return;
-                }
-                
-                if (UserSettings.PublicAndPrivateResources) {
-                        //String resourcesPublicPath = FrameIO.PARENT_FOLDER + "resources-public" + File.separator;
-                        String userName = UserSettings.UserName.get();
-                        //String resourcesPrivateIndividualPath = FrameIO.PARENT_FOLDER + "resources-" + userName + File.separator;
-                        if (AuthenticatorBrowser.isAuthenticationRequired()) {
-                                System.err.println("**** AudioPathManager::changeParentAndSubFolder(): Setting 'audio' folder to resources-" + userName);
-                        }
-                        //AUDIO_HOME_DIRECTORY = resourcesPrivateIndividualPath + "audio" + File.separatorChar;
-                        AUDIO_HOME_DIRECTORY = FrameIO.AUDIO_PRIVATE_PATH;
-                }
-                else {
-                        AUDIO_HOME_DIRECTORY = FrameIO.PARENT_FOLDER + "audio" + File.separatorChar;;
-                }
-        }
-        
-        public static void activateAndScanAudioDir()
-        {
-                changeParentAndSubFolders(FrameIO.PARENT_FOLDER);
-                
-                // Ensure audio directory exists
-                File dir = new File(AUDIO_HOME_DIRECTORY);
-                if (!dir.exists()) {
-                        if (!dir.mkdir()) {
-                                ApolloSystemLog.println("Unable to create missing audio home directory");
-                        }
-                }
-
+        
+        // TODO: this function called during startup?  In browser construction?  When FrameIO.changeParentAndSubFolders() is called?  Separation of apollo from expeditee core?
+        public static void activateAndScanAudioDirs() {
+                // If we are in old regime then there is no AUDIO_USERNAME_PRIVATE_PATH.
+                AUDIO_USERNAME_HOME_DIRECTORY = FrameIO.AUDIO_USERNAME_PRIVATE_PATH == null ? FrameIO.AUDIO_PATH : FrameIO.AUDIO_USERNAME_PRIVATE_PATH;
+                
                 // Load counter
-                loadCounter(AUDIO_HOME_DIRECTORY);
-        }
-        
+                loadCounter();
+        }
         
         /**
          * Loads the counter
-         * @param dir The dir where the audio files live.
-         */
-        private static void loadCounter(String audio_dir_str) {
-                File audio_dir = new File(audio_dir_str);
-                
-                String[] files = getAudioFileNames(audio_dir);
-                if (files == null) { // Due to IO exception
-                        ApolloSystemLog.printError("Failed to read audio directory");
-                        return;
-                }
+         */
+        private static void loadCounter() {
+                List<String> audioFileNames = getAudioFileNames();
+                
                 long count = 0;
-                if (files != null) {
-                        for (String f : files) {
-        
-                                int start = -1, end = -1;
-                                for (int i = 0; i < f.length(); i++) {
-                                        if (Character.isDigit(f.charAt(i)) && start == -1) {
-                                                start = i;
-                                        } else if (!Character.isDigit(f.charAt(i)) && start != -1) {
-                                                end = i;
-                                                break;
-                                        }
-                                }
-                                
-                                if (start >= 0 && end == -1) {
-                                        end = f.length();
-                                }
-        
-                                if (start > 0 && end >= start) { // not start >= 0 since missing preable
-        
-                                        String tmp = f.substring(start, end);
-                                        long l = Long.parseLong(tmp);
-                                        if (l >= count)
-                                                count = l + 1;
-                                }
-                        }
-                }
-
+                for (String f : audioFileNames) {
+                        
+                        int start = -1, end = -1;
+                        for (int i = 0; i < f.length(); i++) {
+                                if (Character.isDigit(f.charAt(i)) && start == -1) {
+                                        start = i;
+                                } else if (!Character.isDigit(f.charAt(i)) && start != -1) {
+                                        end = i;
+                                        break;
+                                }
+                        }
+                        
+                        if (start >= 0 && end == -1) {
+                                end = f.length();
+                        }
+
+                        if (start > 0 && end >= start) { // not start >= 0 since missing preable
+
+                                String tmp = f.substring(start, end);
+                                long l = Long.parseLong(tmp);
+                                if (l >= count)
+                                        count = l + 1;
+                        }
+                }
                 counter = count;
-        }
-        
-        /**
-         * @param dir
-         * @return
-         *              Null if an IO exception occurs
-         */
-        private static String[] getAudioFileNames(File dir) {
-                return dir.list(new RegExpFileFilter("^[A-Z]+\\d+.*$"));
         }
         
@@ -140 +93 @@
          *              read list of files.
          */
-        public static String[] getAudioFileNames() {
-                File audioDir = new File(AUDIO_HOME_DIRECTORY);
-                if (!audioDir.exists() || !audioDir.isDirectory()) return null;
-                return getAudioFileNames(audioDir);
+        public static List<String> getAudioFileNames() {
+                Predicate<File> isFile = file -> {
+                        File dirForFile = file.toPath().getParent().toFile();
+                        if (!dirForFile.exists()) {
+                                if (!dirForFile.mkdir()) {
+                                        ApolloSystemLog.println("Unable to create missing audio directory: " + dirForFile.toString());
+                                }
+                        }
+                        if (file.isFile()) {
+                                return true;
+                        }
+                        return false;
+                };              
+                List<File> allFilesInAudioDirectories = ResourceManager.gatherAudioResources(isFile, DisplayController.getCurrentFrame());
+                List<String> audioFileNames = new ArrayList<String>(); 
+                RegExpFileFilter regExpFileFilter = new RegExpFileFilter("^[A-Z]+\\d+.*$");
+                for (File file: allFilesInAudioDirectories) {
+                        if (regExpFileFilter.accept(file, file.getAbsolutePath())) {
+                                audioFileNames.add(file.getName());
+                        }
+                }
+                return audioFileNames;
         }
         
@@ -168 +139 @@
                 String filename = generateRandomFilenameBase() + "." + extension;
                 
-                File f = new File(AUDIO_HOME_DIRECTORY + filename);
+                File f = new File(AUDIO_USERNAME_HOME_DIRECTORY + filename);
 
                 if (AudioStructureModel.getInstance().getTrackGraphInfo(filename, null) != null ||
@@ -206 +177 @@
 
                 // Build the filename string
-                return preamble + counter;
+                return UserSettings.UserName.get() + preamble + counter;
                 
         }
@@ -222 +193 @@
 
                 // Ensure that the name base file exists. Assumes the audio home directory exists.
-                File vnameBase = new File(AUDIO_HOME_DIRECTORY + VIRTUAL_NAME_BASEFILE);
+                File vnameBase = new File(AUDIO_USERNAME_HOME_DIRECTORY + VIRTUAL_NAME_BASEFILE);
                 if (!vnameBase.exists()) {
                         try {