Supress FIFO fill percentages below 5%, which are expected after increasing write block size

Author: jsiegle

Source/Processors/RecordNode/DataQueue.cpp

@@ -279,7 +279,18 @@ float DataQueue::writeAllChannels (const AudioBuffer<float>& buffer,
     }
 
     // Return usage from last channel (all should be the same)
-    const float usage = 1.0f - (float) m_fifos[m_numChans - 1]->getFreeSpace() / (float) m_fifos[m_numChans - 1]->getTotalSize();
+    return getFifoUsage();
+}
+
+float DataQueue::getFifoUsage() const
+{
+    const float freeSpace = (float) m_fifos[m_numChans - 1]->getFreeSpace();
+    const float totalSize = (float) m_fifos[m_numChans - 1]->getTotalSize();
+
+    const float usage = 1.0f - (freeSpace / totalSize);
+
+    //LOGC ("DataQueue::getFifoUsage: usage = ", usage, " (free: ", freeSpace, ", total: ", totalSize, ")");
+
     return usage;
 }
 

Source/Processors/RecordNode/DataQueue.h

@@ -121,6 +121,9 @@ class DataQueue
     /** Fills the sample number buffer for the stream */
     void fillSampleNumbers (int index, int size, int64 sampleNumber);
 
+    /** Returns the fraction of the FIFO currently in use */
+    float getFifoUsage() const;
+
     int lastIdx;
 
     OwnedArray<AbstractFifo> m_fifos;

Source/Processors/RecordNode/RecordNode.cpp

@@ -928,6 +928,7 @@ void RecordNode::startRecording()
     }
 
     recordThread->setFileComponents (rootFolder, experimentNumber, recordingNumber);
+    recordThread->openFiles();
     recordThread->startThread (Thread::Priority::highest);
 
     if (settingsNeeded)

Source/Processors/RecordNode/RecordNodeEditor.cpp

@@ -120,15 +120,31 @@ StreamMonitor::StreamMonitor (RecordNode* rn, uint64 id)
     selectedChannels = 0;
     totalChannels = rn->getDataStream (streamId)->getChannelCount();
 
-    startTimerHz (10);
+    startTimerHz (5);
 }
 
 StreamMonitor::~StreamMonitor() {}
 
 void StreamMonitor::timerCallback()
 {
     if (((RecordNode*) processor)->recordThread->isThreadRunning())
-        setFillPercentage (((RecordNode*) processor)->fifoUsage[streamId]);
+    {
+        float fifoUsage = ((RecordNode*) processor)->fifoUsage[streamId];
+
+        // Scale the fill percentage to reduce noise from expected low values:
+        // - Values <= 5% are displayed as 0%
+        // - Values between 5% and 10% are scaled to 0-10%
+        // - Values above 10% are displayed linearly
+        float scaledUsage;
+        if (fifoUsage <= 0.05f)
+            scaledUsage = 0.0f;
+        else if (fifoUsage <= 0.10f)
+            scaledUsage = (fifoUsage - 0.05f) * 2.0f;  // Maps 0.05-0.10 to 0.0-0.10
+        else
+            scaledUsage = fifoUsage;
+
+        setFillPercentage (scaledUsage);
+    }
     else
         setFillPercentage (0.0);
 }

Source/Processors/RecordNode/RecordThread.cpp

@@ -96,11 +96,8 @@ void RecordThread::setFirstBlockFlag (bool state)
     this->notify();
 }
 
-void RecordThread::run()
+void RecordThread::openFiles()
 {
-    spikesReceived = 0;
-    spikesWritten = 0;
-
     // Initialize per-channel sample numbers
     sampleNumbers.clear();
     for (int chan = 0; chan < m_numChannels; ++chan)
@@ -114,17 +111,23 @@ void RecordThread::run()
     m_perStreamTimestampIdxs.resize (numStreams);
     m_perStreamSampleNumbers.resize (numStreams, 0);
 
-    bool closeEarly = true;
-
-    //1-Open Files
-    m_cleanExit = false;
-    closeEarly = false;
-    Array<int64> initSampleNumbers;
-
     m_engine->openFiles (m_rootFolder, m_experimentNumber, m_recordingNumber);
 
     if (recordNode != nullptr)
         recordNode->notifyRecordThreadFilesOpened();
+}
+
+void RecordThread::run()
+{
+    // 1-Initialize counters
+    spikesReceived = 0;
+    spikesWritten = 0;
+
+    bool closeEarly = false;
+    int numStreams = recordNode->getNumDataStreams();
+
+    m_cleanExit = false;
+    Array<int64> initSampleNumbers;
 
     //2-Wait until the first block has arrived, so we can align the timestamps
     bool isWaiting = false;
@@ -137,7 +140,7 @@ void RecordThread::run()
         wait (1);
     }
 
-    // Get initial sample numbers from each stream's queue
+    // 3 - Get initial sample numbers from each stream's queue
     int globalChan = 0;
     for (int streamIdx = 0; streamIdx < numStreams; streamIdx++)
     {
@@ -165,12 +168,12 @@ void RecordThread::run()
     }
     m_engine->updateLatestSampleNumbers (initSampleNumbers);
 
-    //3-Normal loop
+    //4 - Normal loop
     while (! threadShouldExit())
         writeData (m_minWriteSamples, m_maxWriteSamples, BLOCK_MAX_WRITE_EVENTS, BLOCK_MAX_WRITE_SPIKES);
 
     //LOGD(__FUNCTION__, " Exiting record thread");
-    //4-Before closing the thread, try to write the remaining samples
+    //5 - Before closing the thread, try to write the remaining samples
 
     LOGD ("Closing all files");
 

Source/Processors/RecordNode/RecordThread.h

@@ -72,6 +72,9 @@ class RecordThread : public Thread
     /** Sets the pointers to the data queues (one per stream), event queue, and spike queue */
     void setQueuePointers (OwnedArray<DataQueue>* dataQueues, EventMsgQueue* events, SpikeMsgQueue* spikes);
 
+    /** Opens files prior to starting recording */
+    void openFiles();
+
     /** Runs the thread */
     void run() override;