Improve GUI display during MIDI record in various ways.

git-svn-id: svn://localhost/ardour2/branches/3.0@7875 d708f5d6-7413-0410-9779-e7cbd77b26cf

4 files changed, 16 insertions, 5 deletions

diff --git a/libs/ardour/ardour/midi_source.h b/libs/ardour/ardour/midi_source.h
index 3bad6d6ddc..221bfd13f0 100644
--- a/libs/ardour/ardour/midi_source.h
+++ b/libs/ardour/ardour/midi_source.h
@@ -91,7 +91,10 @@ class MidiSource : virtual public Source
 
 	static PBD::Signal1<void,MidiSource*> MidiSourceCreated;
 
-	// Signal a range of recorded data is available for reading from model()
+	/** Emitted when a range of recorded data is available for reading from model().
+	 *  First parameter is the start of the range in session frames.
+	 *  Second parameter is the number of frames.
+	 */
 	mutable PBD::Signal2<void,framepos_t,nframes_t> ViewDataRangeReady;
 
 	XMLNode& get_state ();
diff --git a/libs/ardour/midi_diskstream.cc b/libs/ardour/midi_diskstream.cc
index 932b9bb2c9..0ac67fae82 100644
--- a/libs/ardour/midi_diskstream.cc
+++ b/libs/ardour/midi_diskstream.cc
@@ -1143,7 +1143,7 @@ MidiDiskstream::set_record_enabled (bool yn)
 void
 MidiDiskstream::engage_record_enable ()
 {
-    bool rolling = _session.transport_speed() != 0.0f;
+	bool const rolling = _session.transport_speed() != 0.0f;
 
 	g_atomic_int_set (&_record_enabled, 1);
 
diff --git a/libs/ardour/midi_source.cc b/libs/ardour/midi_source.cc
index b105aa00c5..ebb2d17696 100644
--- a/libs/ardour/midi_source.cc
+++ b/libs/ardour/midi_source.cc
@@ -251,6 +251,10 @@ MidiSource::midi_read (Evoral::EventSink<nframes_t>& dst, framepos_t source_star
 	}
 }
 
+/** Write data from a MidiRingBuffer to this source.
+ *  @param source Source to read from.
+ *  @param source_start This source's start position in session frames.
+ */
 nframes_t
 MidiSource::midi_write (MidiRingBuffer<nframes_t>& source, framepos_t source_start, nframes_t duration)
 {
@@ -311,7 +315,7 @@ MidiSource::clone (Evoral::MusicalTime begin, Evoral::MusicalTime end)
         boost::shared_ptr<MidiSource> newsrc = boost::dynamic_pointer_cast<MidiSource>(
                 SourceFactory::createWritable(DataType::MIDI, _session,
                                               newpath, false, _session.frame_rate()));
-        
+
         newsrc->set_timeline_position(_timeline_position);
 	newsrc->copy_interpolation_from (this);
 	newsrc->copy_automation_state_from (this);
diff --git a/libs/ardour/smf_source.cc b/libs/ardour/smf_source.cc
index 4ddbba8457..322c4dff97 100644
--- a/libs/ardour/smf_source.cc
+++ b/libs/ardour/smf_source.cc
@@ -201,7 +201,10 @@ SMFSource::read_unlocked (Evoral::EventSink<nframes_t>& destination, framepos_t
 	return duration;
 }
 
-/** All stamps in audio frames */
+/** Write data to this source from a MidiRingBuffer.
+ *  @param source Buffer to read from.
+ *  @param position This source's start position in session frames.
+ */
 nframes_t
 SMFSource::write_unlocked (MidiRingBuffer<nframes_t>& source, framepos_t position, nframes_t duration)
 {
@@ -243,6 +246,7 @@ SMFSource::write_unlocked (MidiRingBuffer<nframes_t>& source, framepos_t positio
 			break;
 		}
 
+		/* convert from session time to time relative to the source start */
 		assert(time >= position);
 		time -= position;
 
@@ -262,7 +266,7 @@ SMFSource::write_unlocked (MidiRingBuffer<nframes_t>& source, framepos_t positio
 	Evoral::SMF::flush();
 	free(buf);
 
-	ViewDataRangeReady(position + _last_write_end, duration); /* EMIT SIGNAL */
+	ViewDataRangeReady (_last_write_end, duration); /* EMIT SIGNAL */
 
 	return duration;
 }