Add comments

Author: jsiegle

Plugins/IntanRecordingController/RHD2000Editor.cpp

@@ -737,6 +737,7 @@ void RHD2000Editor::handleAsyncUpdate()
 	canvas->updateImpedance(impedanceData->streams, impedanceData->channels, impedanceData->magnitudes, impedanceData->phases);
     if (saveImpedances)
     {
+        // this may not work with new Record Node architecture
 		CoreServices::RecordNode::createNewrecordingDir();
 
 		String path(CoreServices::RecordNode::getRecordingPath().getFullPathName()

Source/Processors/RecordNode/BinaryFormat/BinaryRecording.cpp

@@ -695,4 +695,4 @@ RecordEngineManager* BinaryRecording::getEngineManager()
 void BinaryRecording::setParameter(EngineParameter& parameter)
 {
 	boolParameter(0, m_saveTTLWords);
-}
+}

Source/Processors/RecordNode/RecordEngine.h

@@ -65,7 +65,7 @@ class PLUGIN_API RecordEngine
 	/** All the public methods (except registerManager) are called by RecordNode or RecordingThread:
 	When acquisition starts (in the specified order):
 	1-resetChannels
-	2-registerProcessor, addChannel, registerSpikeSource, addspikeelectrode
+	2-registerProcessor, addChannel, registerSpikeSource, addSpikeElectrode
 	3-configureEngine (which calls setParameter)
 	3-startAcquisition
 	When recording starts (in the specified order):

Source/Processors/RecordNode/RecordNode.cpp

@@ -172,7 +172,7 @@ String RecordNode::generateDirectoryName()
 
 	AccessClass::getControlPanel()->setDateText(datestring);
 
-	if (filename.length() < 24)
+	if (filename.length() < 24) // this is a hack
 		filename += datestring;
 	else
 		filename = filename.substring(0, filename.length() - 1);
@@ -183,23 +183,27 @@ String RecordNode::generateDirectoryName()
 
 }
 
+// called by FifoMonitor
 File RecordNode::getDataDirectory()
 {
 	return dataDirectory;
 }
 
+// called by RecordNodeEditor
 void RecordNode::setDataDirectory(File directory)
 {
 	dataDirectory = directory;
 	newDirectoryNeeded = true;
 }
 
+// called by RecordNode::startRecording and RHD2000Editor (should be removed)
 void RecordNode::createNewDirectory()
 {
 	rootFolder = File(dataDirectory.getFullPathName() + File::separator + generateDirectoryName() + File::separator + getName() + " " + String(getNodeId()));
 	newDirectoryNeeded = false;
 }
 
+// called by RecordEngine
 String RecordNode::generateDateString() const
 {
 
@@ -235,35 +239,42 @@ String RecordNode::generateDateString() const
 
 }
 
+// called by CoreServices
 int RecordNode::getExperimentNumber() const
 {
 	LOGD(__FUNCTION__, " = ", experimentNumber);
 	return experimentNumber;
 }
 
+// called by CoreServices
 int RecordNode::getRecordingNumber() const
 {
 	LOGD(__FUNCTION__, " = ", recordingNumber);
 	return recordingNumber;
 }
 
+// called by ProcessorGraph::createNewProcessor
 AudioProcessorEditor* RecordNode::createEditor()
 {
 	editor = new RecordNodeEditor(this, true);
 	return editor;
 }
 
+// Juce method, not used
 void RecordNode::prepareToPlay(double sampleRate, int estimatedSamplesPerBlock)
 {
 	/* This gets called right when the play button is pressed*/
 }
 
+// called by RecordEngine when saving the signal chain
 const String &RecordNode::getLastSettingsXml() const
 {
 	return lastSettingsText;
 }
 
-/* Use this function to change paramaters while recording...*/
+/* Use this function to change parameters while recording...*/
+// Called by:
+// - EngineConfigComponent (3, 0.0f) -- used to disable record thread (deprecated?)
 void RecordNode::setParameter(int parameterIndex, float newValue)
 {
 	editor->updateParameterButtons(parameterIndex);
@@ -276,17 +287,20 @@ void RecordNode::setParameter(int parameterIndex, float newValue)
 
 }
 
+// Called by ProcessorGraph::enableProcessors()
 void RecordNode::updateRecordChannelIndexes()
 {
 	//Keep the nodeIDs of the original processor from each channel comes from
 	updateChannelIndexes(false);
 }
 
+// Called when deleting FifoMonitor
 void RecordNode::updateChannelStates(int srcIndex, int subProcIdx, std::vector<bool> channelStates)
 {
 	this->dataChannelStates[srcIndex][subProcIdx] = channelStates;
 }
 
+// called by updateSettings (could be refactored)
 void RecordNode::updateSubprocessorMap()
 {
 
@@ -384,40 +398,48 @@ void RecordNode::updateSubprocessorMap()
     }
 }
 
+// called by GenericProcessor, RecordNodeEditor, SourceProcessorInfo,
+// TimestampSourceSelectionComponent
 int RecordNode::getNumSubProcessors() const
 {
 	return numSubprocessors;
 }
 
+// called by RecordNodeEditor (when loading), SyncControlButton
 void RecordNode::setMasterSubprocessor(int srcIndex, int subProcIdx)
 {
 	synchronizer->setMasterSubprocessor(srcIndex, subProcIdx);
 }
 
+// called by RecordNodeEditor (when loading), SyncControlButton
 void RecordNode::setSyncChannel(int srcIndex, int subProcIdx, int channel)
 {
 	syncChannelMap[srcIndex][subProcIdx] = channel;
 	synchronizer->setSyncChannel(srcIndex, subProcIdx, syncOrderMap[srcIndex][subProcIdx]+channel);
 }
 
+// called by SyncControlButton
 int RecordNode::getSyncChannel(int srcIndex, int subProcIdx)
 {
 	return syncChannelMap[srcIndex][subProcIdx];
 	//return synchronizer->getSyncChannel(srcIndex, subProcIdx);
 }
 
+// called by SyncControlButton
 bool RecordNode::isMasterSubprocessor(int srcIndex, int subProcIdx)
 {
 	return (srcIndex == synchronizer->masterProcessor && subProcIdx == synchronizer->masterSubprocessor);
 }
 
+// called by GenericProcessor::update()
 void RecordNode::updateSettings()
 {
 
 	updateSubprocessorMap();
 
 }
 
+// called by GenericProcessor::enableProcessor
 bool RecordNode::enable()
 {
 
@@ -439,6 +461,7 @@ bool RecordNode::enable()
 
 }
 
+// called by GenericProcessor::setRecording()
 void RecordNode::startRecording()
 {
 
@@ -559,6 +582,7 @@ void RecordNode::startRecording()
 
 }
 
+// called by GenericProcessor::setRecording()
 void RecordNode::stopRecording()
 {
 
@@ -592,7 +616,7 @@ void RecordNode::handleEvent(const EventChannel* eventInfo, const MidiMessage& e
 		if (!msgCenterMessages.contains(Event::getTimestamp(event)))
 		{
 			msgCenterMessages.add(Event::getTimestamp(event));
-			std::cout << "Received event." << std::endl;
+			std::cout << "Received message." << std::endl;
 		}
 		else
 			return;
@@ -602,7 +626,7 @@ void RecordNode::handleEvent(const EventChannel* eventInfo, const MidiMessage& e
 
 	if (recordEvents) 
 	{
-		
+		// flags whether or not to write events
 
 		int64 timestamp = Event::getTimestamp(event);
 		uint64 eventChan = event.getChannel();
@@ -622,11 +646,10 @@ void RecordNode::handleEvent(const EventChannel* eventInfo, const MidiMessage& e
 
 }
 
-
+// only called if recordSpikes is true
 void RecordNode::handleSpike(const SpikeChannel* spikeInfo, const MidiMessage& event, int samplePosition)
 {
-
-
+    
 	SpikeEventPtr newSpike = SpikeEvent::deserializeFromMessage(event, spikeInfo);
 	if (!newSpike) 
 	{
@@ -747,30 +770,35 @@ void RecordNode::process(AudioSampleBuffer& buffer)
 
 }
 
+// called by process method
 bool RecordNode::isFirstChannelInRecordedSubprocessor(int ch)
 {
 	return std::find(startRecChannels.begin(), startRecChannels.end(), ch) != startRecChannels.end();
 }
 
+// called by ProcessorGraph::connectProcessors
 void RecordNode::registerProcessor(const GenericProcessor* sourceNode)
 {
 	settings.numInputs += sourceNode->getNumOutputs();
 	setPlayConfigDetails(getNumInputs(), getNumOutputs(), 44100.0, 128);
 	recordEngine->registerProcessor(sourceNode);
 }
 
+// not called
 void RecordNode::registerSpikeSource(const GenericProcessor *processor)
 {
 	recordEngine->registerSpikeSource(processor);
 }
 
+// not called
 int RecordNode::addSpikeElectrode(const SpikeChannel *elec)
 {
 	spikeChannelArray.add(new SpikeChannel(*elec));
 	recordEngine->addSpikeElectrode(spikeElectrodeIndex, elec);
 	return spikeElectrodeIndex++;
 }
 
+// called in RecordNode::handleSpike
 void RecordNode::writeSpike(const SpikeEvent *spike, const SpikeChannel *spikeElectrode)
 {
 	//if (isRecording && shouldRecord)
@@ -783,23 +811,27 @@ void RecordNode::writeSpike(const SpikeEvent *spike, const SpikeChannel *spikeEl
 	}
 }
 
+// FileNameComponent listener
 void RecordNode::filenameComponentChanged(FilenameComponent *fnc)
 {
 
 	dataDirectory = fnc->getCurrentFile();
 	newDirectoryNeeded = true;
 }
 
+// not called?
 float RecordNode::getFreeSpace() const
 {
 	return 1.0f - float(dataDirectory.getBytesFreeOnVolume()) / float(dataDirectory.getVolumeTotalSize());
 }
 
+// not called?
 void RecordNode::registerRecordEngine(RecordEngine *engine)
 {
 	engineArray.add(engine);
 }
 
+// not called?
 void RecordNode::clearRecordEngines()
 {
 	engineArray.clear();

Source/Processors/RecordNode/RecordNode.h

@@ -46,9 +46,21 @@ class RecordNode : public GenericProcessor, public FilenameComponentListener
 
 public:
 
+    /** Constructor
+      - Creates: DataQueue, EventQueue, SpikeQueue, Synchronizer,
+        RecordThread, EventMonitor
+      - Sets the Record Engine
+      - Gets the Recording Directory from the control panel
+      - Sets a bunch of internal variables
+     */
 	RecordNode();
+    
+    /** Destructor
+            - Doesn't need to delete anything manually
+     */
 	~RecordNode();
 
+    /** If messageCenter event channel is not present in EventChannelArray, add it*/
 	void connectToMessageCenter();
 
 	void updateRecordChannelIndexes();
@@ -127,6 +139,7 @@ class RecordNode : public GenericProcessor, public FilenameComponentListener
     bool isSyncReady;
 
     //TODO: Need to validate these new methods
+    /** Deprecated*/
 	void addInputChannel(const GenericProcessor* sourceNode, int chan);
 
     /** Must be called by a spike recording source on the "enable" method