Refactor and clean up SessionSettings.pde with initial Save/Load settings (WIP)

Author: retiutut

OpenBCI_GUI/ControlPanel.pde

@@ -266,7 +266,7 @@ class ControlPanel {
         sb.append("OpenBCISession_");
         sb.append(dataLogger.getSessionName());
         sb.append(File.separator);
-        sessionSettings.setSessionPath(sb.toString());
+        dataLogger.setSessionPath(sb.toString());
     }
 
     public void setBrainFlowStreamerOutput() {
@@ -910,10 +910,8 @@ class SessionDataBox {
         createODFButton("odfButton", "OpenBCI", dataLogger.getDataLoggerOutputFormat(), x + padding, y + padding*2 + 18 + 58, (w-padding*3)/2, 24);
         createBDFButton("bdfButton", "BDF+", dataLogger.getDataLoggerOutputFormat(), x + padding*2 + (w-padding*3)/2, y + padding*2 + 18 + 58, (w-padding*3)/2, 24);
 
-        createMaxDurationDropdown("maxFileDuration", Arrays.asList(sessionSettings.fileDurations));
-
-        
-        
+        List<String> fileDurationList = EnumHelper.getEnumStrings(OdfFileDuration.class);
+        createMaxDurationDropdown("maxFileDuration", fileDurationList, odfFileDuration);
     }
 
     public void update() {
@@ -1012,10 +1010,10 @@ class SessionDataBox {
         });
     }
 
-    private void createMaxDurationDropdown(String name, List<String> _items){
+    private void createMaxDurationDropdown(String name, List<String> _items, OdfFileDuration defaultValue) {
         maxDurationDropdown = sessionData_cp5.addScrollableList(name)
             .setOpen(false)
-            .setColor(sessionSettings.dropdownColors)
+            .setColor(dropdownColorsGlobal)
             .setOutlineColor(150)
             //.setColorBackground(OPENBCI_BLUE) // text field bg color
             .setColorValueLabel(OPENBCI_DARKBLUE)       // text color
@@ -1033,7 +1031,7 @@ class SessionDataBox {
         maxDurationDropdown
             .getCaptionLabel() //the caption label is the text object in the primary bar
             .toUpperCase(false) //DO NOT AUTOSET TO UPPERCASE!!!
-            .setText(sessionSettings.fileDurations[sessionSettings.defaultOBCIMaxFileSize])
+            .setText(defaultValue.getString())
             .setFont(p4)
             .setSize(14)
             .getStyle() //need to grab style before affecting the paddingTop
@@ -1042,7 +1040,7 @@ class SessionDataBox {
         maxDurationDropdown
             .getValueLabel() //the value label is connected to the text objects in the dropdown item bars
             .toUpperCase(false) //DO NOT AUTOSET TO UPPERCASE!!!
-            .setText(sessionSettings.fileDurations[sessionSettings.defaultOBCIMaxFileSize])
+            .setText(defaultValue.getString())
             .setFont(h5)
             .setSize(12) //set the font size of the item bars to 14pt
             .getStyle() //need to grab style before affecting the paddingTop
@@ -1052,7 +1050,7 @@ class SessionDataBox {
             public void controlEvent(CallbackEvent theEvent) {    
                 if (theEvent.getAction() == ControlP5.ACTION_BROADCAST) {
                     int n = (int)(theEvent.getController()).getValue();
-                    sessionSettings.setLogFileDurationChoice(n);
+                    dataLogger.setLogFileDurationChoice(n);
                     println("ControlPanel: Chosen Recording Duration: " + n);
                 } else if (theEvent.getAction() == ControlP5.ACTION_ENTER) {
                     lockOutsideElements(true);
@@ -1775,7 +1773,7 @@ class BrainFlowStreamerBox {
     private void createDropdown(String name){
         bfFileSaveOption = bfStreamerCp5.addScrollableList(name)
             .setOpen(false)
-            .setColor(sessionSettings.dropdownColors)
+            .setColor(dropdownColorsGlobal)
             .setOutlineColor(150)
             .setSize(167, (dataWriterBfEnum.values().length + 1) * 24)
             .setBarHeight(24) //height of top/primary bar
@@ -2164,7 +2162,7 @@ class SDBox {
 
         sdList = cp5_sdBox.addScrollableList(name)
             .setOpen(false)
-            .setColor(sessionSettings.dropdownColors)
+            .setColor(dropdownColorsGlobal)
             .setOutlineColor(150)
             .setSize(w - padding*2, 2*24)//temporary size
             .setBarHeight(24) //height of top/primary bar

OpenBCI_GUI/DataLogger.pde

@@ -8,6 +8,10 @@ class DataLogger {
     public final int OUTPUT_SOURCE_ODF = 1; // The OpenBCI CSV Data Format
     public final int OUTPUT_SOURCE_BDF = 2; // The BDF data format http://www.biosemi.com/faq/file_format.htm
     private int outputDataSource;
+    private String sessionPath = "";
+    private boolean logFileIsOpen = false;
+    private long logFileStartTime;
+    private long logFileMaxDurationNano = -1;
 
     DataLogger() {
         //Default to OpenBCI CSV Data Format
@@ -33,7 +37,7 @@ class DataLogger {
 
     private void saveNewData() {
         //If data is available, save to playback file...
-        if(!sessionSettings.isLogFileOpen()) {
+        if(!isLogFileOpen()) {
             return;
         }
 
@@ -54,21 +58,21 @@ class DataLogger {
     }
 
     public void limitRecordingFileDuration() {
-        if (sessionSettings.isLogFileOpen() && outputDataSource == OUTPUT_SOURCE_ODF && sessionSettings.maxLogTimeReached()) {
+        if (isLogFileOpen() && outputDataSource == OUTPUT_SOURCE_ODF && maxLogTimeReached()) {
             println("DataLogging: Max recording duration reached for OpenBCI data format. Creating a new recording file in the session folder.");
             closeLogFile();
             openNewLogFile(directoryManager.getFileNameDateTime());
-            sessionSettings.setLogFileStartTime(System.nanoTime());
+            setLogFileStartTime(System.nanoTime());
         }
     }
 
     public void onStartStreaming() {
         if (outputDataSource > OUTPUT_SOURCE_NONE && eegDataSource != DATASOURCE_PLAYBACKFILE) {
             //open data file if it has not already been opened
-            if (!sessionSettings.isLogFileOpen()) {
+            if (!isLogFileOpen()) {
                 openNewLogFile(directoryManager.getFileNameDateTime());
             }
-            sessionSettings.setLogFileStartTime(System.nanoTime());
+            setLogFileStartTime(System.nanoTime());
         }
 
         //Print BrainFlow Streamer Info here after ODF and BDF println
@@ -111,7 +115,7 @@ class DataLogger {
                 // Do nothing...
                 break;
         }
-        sessionSettings.setLogFileIsOpen(true);
+        setLogFileIsOpen(true);
     }
 
     /**
@@ -159,7 +163,7 @@ class DataLogger {
                 // Do nothing...
                 break;
         }
-        sessionSettings.setLogFileIsOpen(false);
+        setLogFileIsOpen(false);
     }
 
     private void closeLogFileBDF() {
@@ -188,22 +192,61 @@ class DataLogger {
         sessionName = s;
     }
 
-    public final String getSessionName() {
+    public String getSessionName() {
         return sessionName;
     }
+
+    
+    public void setSessionPath (String _path) {
+        sessionPath = _path;
+    }
+
+    public String getSessionPath() {
+        return sessionPath;
+    }
+
 
     public void setBfWriterFolder(String _folderName, String _folderPath) {
         fileWriterBF.setBrainFlowStreamerFolderName(_folderName, _folderPath);
     }
 
     public void setBfWriterDefaultFolder() {
-        if (sessionSettings.getSessionPath() != "") {
-            sessionSettings.setSessionPath(directoryManager.getRecordingsPath() + "OpenBCISession_" + sessionName);
+        if (getSessionPath() != "") {
+            setSessionPath(directoryManager.getRecordingsPath() + "OpenBCISession_" + sessionName);
         }
-        fileWriterBF.setBrainFlowStreamerFolderName(sessionName, sessionSettings.getSessionPath());
+        fileWriterBF.setBrainFlowStreamerFolderName(sessionName, getSessionPath());
     }
 
     public String getBfWriterFilePath() {
         return fileWriterBF.getBrainFlowStreamerRecordingFileName();
     }
+
+    
+    private void setLogFileIsOpen(boolean _toggle) {
+        logFileIsOpen = _toggle;
+    }
+
+    private boolean isLogFileOpen() {
+        return logFileIsOpen;
+    }
+
+    private void setLogFileStartTime(long _time) {
+        logFileStartTime = _time;
+        verbosePrint("Settings: LogFileStartTime = " + _time);
+    }
+
+    public void setLogFileDurationChoice(int n) {
+        int fileDurationMinutes = odfFileDuration.values()[n].getValue();
+        logFileMaxDurationNano = fileDurationMinutes * 1000000000L * 60;
+        println("Settings: LogFileMaxDuration = " + fileDurationMinutes + " minutes");
+    }
+
+    //Only called during live mode && using OpenBCI Data Format
+    private boolean maxLogTimeReached() {
+        if (logFileMaxDurationNano < 0) {
+            return false;
+        } else {
+            return (System.nanoTime() - logFileStartTime) > (logFileMaxDurationNano);
+        }
+    }
 };

OpenBCI_GUI/DataWriterBF.pde

@@ -48,6 +48,7 @@ public class DataWriterBF {
     }
 
     public void setBrainFlowStreamerFolderName(String _folderName, String _folderPath) {
+        //FIX ME ?
         //sessionSettings.setSessionPath(directoryManager.getRecordingsPath() + "OpenBCISession_" + _sessionName + File.separator);
         folderName = _folderName;
         folderPath = _folderPath;

OpenBCI_GUI/DataWriterODF.pde

@@ -7,8 +7,8 @@ public class DataWriterODF {
     protected String headerFirstLineString = "%OpenBCI Raw EXG Data";
 
     DataWriterODF(String _sessionName, String _fileName) {
-        sessionSettings.setSessionPath(directoryManager.getRecordingsPath() + "OpenBCISession_" + _sessionName + File.separator);
-        fname = sessionSettings.getSessionPath();
+        dataLogger.setSessionPath(directoryManager.getRecordingsPath() + "OpenBCISession_" + _sessionName + File.separator);
+        fname = dataLogger.getSessionPath();
         fname += fileNamePrependString;
         fname += _fileName;
         fname += ".txt";
@@ -21,8 +21,8 @@ public class DataWriterODF {
     DataWriterODF(String _sessionName, String _fileName, String _fileNamePrependString, String _headerFirstLineString) {
         fileNamePrependString = _fileNamePrependString;
         headerFirstLineString = _headerFirstLineString;
-        sessionSettings.setSessionPath(directoryManager.getRecordingsPath() + "OpenBCISession_" + _sessionName + File.separator);
-        fname = sessionSettings.getSessionPath();
+        dataLogger.setSessionPath(directoryManager.getRecordingsPath() + "OpenBCISession_" + _sessionName + File.separator);
+        fname = dataLogger.getSessionPath();
         fname += fileNamePrependString;
         fname += _fileName;
         fname += ".txt";

OpenBCI_GUI/EnumHelper.pde

@@ -0,0 +1,28 @@
+//Used for Widget Dropdown Enums
+interface IndexingInterface {
+    public int getIndex();
+    public String getString();
+}
+
+/**
+ * Helper class for working with IndexingInterface enums
+ */
+public static class EnumHelper {
+    /**
+     * Generic method to get enum strings as a list
+     */
+    public static <T extends IndexingInterface> List<String> getListAsStrings(T[] values) {
+        List<String> enumStrings = new ArrayList<>();
+        for (T enumValue : values) {
+            enumStrings.add(enumValue.getString());
+        }
+        return enumStrings;
+    }
+    
+    /**
+     * Get list of strings for an enum class that implements IndexingInterface
+     */
+    public static <T extends Enum<T> & IndexingInterface> List<String> getEnumStrings(Class<T> enumClass) {
+        return getListAsStrings(enumClass.getEnumConstants());
+    }
+}

OpenBCI_GUI/FileDurationEnum.pde

@@ -0,0 +1,32 @@
+public enum OdfFileDuration implements IndexingInterface {
+    FIVE_MINUTES (0, 5, "5 Minutes"),
+    FIFTEEN_MINUTES (1, 15, "15 Minutes"),
+    THIRTY_MINUTES (2, 30, "30 Minutes"),
+    SIXTY_MINUTES (3, 60, "60 Minutes"),
+    ONE_HUNDRED_TWENTY_MINUTES (4, 120, "120 Minutes"),
+    NO_LIMIT (5, -1, "No Limit");
+
+    private int index;
+    private int duration;
+    private String label;
+
+    OdfFileDuration(int _index, int _duration, String _label) {
+        this.index = _index;
+        this.duration = _duration;
+        this.label = _label;
+    }
+
+    @Override
+    public String getString() {
+        return label;
+    }
+
+    @Override
+    public int getIndex() {
+        return index;
+    }
+
+    public int getValue() {
+        return duration;
+    }
+}

OpenBCI_GUI/OpenBCI_GUI.pde

@@ -121,6 +121,7 @@ String sdData_fname = "N/A"; //only used if loading input data from a sd file
 DataSource currentBoard = new BoardNull();
 
 DataLogger dataLogger = new DataLogger();
+OdfFileDuration odfFileDuration = OdfFileDuration.SIXTY_MINUTES;
 
 // Intialize interface protocols
 InterfaceSerial iSerial = new InterfaceSerial(); //This is messy, half-deprecated code. See comments in InterfaceSerial.pde - Nov. 2020
@@ -256,6 +257,8 @@ final color SIGNAL_CHECK_YELLOW = color(221, 178, 13); //Same color as yellow ch
 final color SIGNAL_CHECK_YELLOW_LOWALPHA = color(221, 178, 13, 150);
 final color SIGNAL_CHECK_RED = BOLD_RED;
 final color SIGNAL_CHECK_RED_LOWALPHA = color(224, 56, 45, 150);
+public CColor dropdownColorsGlobal = new CColor();
+        
 
 //Channel Colors -- Defaulted to matching the OpenBCI electrode ribbon cable
 //Channel Colors -- Defaulted to matching the OpenBCI electrode ribbon cable
@@ -379,6 +382,13 @@ void setup() {
 
     openbciLogoCog = loadImage("obci-logo-blu-cog.png");
 
+    dropdownColorsGlobal.setActive((int)BUTTON_PRESSED); //bg color of box when pressed
+    dropdownColorsGlobal.setForeground((int)BUTTON_HOVER); //when hovering over any box (primary or dropdown)
+    dropdownColorsGlobal.setBackground((int)color(255)); //bg color of boxes (including primary)
+    dropdownColorsGlobal.setCaptionLabel((int)color(1, 18, 41)); //color of text in primary box
+    // dropdownColorsGlobal.setValueLabel((int)color(1, 18, 41)); //color of text in all dropdown boxes
+    dropdownColorsGlobal.setValueLabel((int)color(100)); //color of text in all dropdown boxes
+
     // check if the current directory is writable
     File dummy = new File(sketchPath());
     if (!dummy.canWrite()) {
@@ -1063,7 +1073,6 @@ void systemInitSession() {
 //Global function to update the number of channels
 void updateGlobalChannelCount(int _channelCount) {
     globalChannelCount = _channelCount;
-    sessionSettings.sessionSettingsChannelCount = _channelCount; //used in SoftwareSettings.pde only
     fftBuff = new ddf.minim.analysis.FFT[globalChannelCount];  //reinitialize the FFT buffer
     println("OpenBCI_GUI: Channel count set to " + str(globalChannelCount));
 }
@@ -1076,7 +1085,7 @@ void introAnimation() {
     float transparency = 0;
 
     if (millis() >= sessionSettings.introAnimationInit) {
-        transparency = map(millis() - sessionSettings.introAnimationInit, t1, sessionSettings.introAnimationDuration, 0, 255);
+        transparency = map(millis() - sessionSettings.introAnimationInit, t1, sessionSettings.INTRO_ANIMATION_DURATION, 0, 255);
         verbosePrint(String.valueOf(transparency));
         tint(255, transparency);
         //draw OpenBCI Logo Front & Center
@@ -1090,7 +1099,7 @@ void introAnimation() {
     }
 
     //Exit intro animation when the duration has expired AND the Control Panel is ready
-    if ((millis() >= sessionSettings.introAnimationInit + sessionSettings.introAnimationDuration)
+    if ((millis() >= sessionSettings.introAnimationInit + sessionSettings.INTRO_ANIMATION_DURATION)
         && controlPanel != null) {
         systemMode = SYSTEMMODE_PREINIT;
         controlPanel.open();