Implement Note Types

data/themes/classic/style.css

@@ -143,6 +143,7 @@ lmms--gui--PianoRoll {
 	qproperty-backgroundShade: rgba( 255, 255, 255, 10 );
 	qproperty-noteModeColor: rgb( 255, 255, 255 );
 	qproperty-noteColor: rgb( 119, 199, 216 );
+	qproperty-stepNoteColor: #9b1313;
 	qproperty-noteTextColor: rgb( 255, 255, 255 );
 	qproperty-noteOpacity: 128;
 	qproperty-noteBorders: true; /* boolean property, set false to have borderless notes */

data/themes/default/style.css

@@ -175,6 +175,7 @@ lmms--gui--PianoRoll {
 	qproperty-backgroundShade: rgba(255, 255, 255, 10);
 	qproperty-noteModeColor: #0bd556;
 	qproperty-noteColor: #0bd556;
+	qproperty-stepNoteColor: #9b1313;
 	qproperty-noteTextColor: #ffffff;
 	qproperty-noteOpacity: 165;
 	qproperty-noteBorders: false; /* boolean property, set false to have borderless notes */

include/DataFile.h

@@ -128,6 +128,7 @@ class LMMS_EXPORT DataFile : public QDomDocument
 	void upgrade_bbTcoRename();
 	void upgrade_sampleAndHold();
 	void upgrade_midiCCIndexing();
+	void upgrade_noteTypes();
 
 	// List of all upgrade methods
 	static const std::vector<UpgradeMethod> UPGRADE_METHODS;

include/Note.h

@@ -107,6 +107,16 @@ class LMMS_EXPORT Note : public SerializingObject
 	Note( const Note & note );
 	~Note() override;
 
+	// Note types
+	enum class Type
+	{
+		Regular = 0,
+		Step
+	};
+
+	Type type() const { return m_type; }
+	inline void setType(Type t) { m_type = t; }
+
 	// used by GUI
 	inline void setSelected( const bool selected ) { m_selected = selected; }
 	inline void setOldKey( const int oldKey ) { m_oldKey = oldKey; }
@@ -253,6 +263,8 @@ class LMMS_EXPORT Note : public SerializingObject
 	TimePos m_length;
 	TimePos m_pos;
 	DetuningHelper * m_detuning;
+
+	Type m_type = Type::Regular;
 };
 
 using NoteVector = std::vector<Note*>;

include/PianoRoll.h

@@ -73,6 +73,7 @@ class PianoRoll : public QWidget
 	Q_PROPERTY(QColor lineColor MEMBER m_lineColor)
 	Q_PROPERTY(QColor noteModeColor MEMBER m_noteModeColor)
 	Q_PROPERTY(QColor noteColor MEMBER m_noteColor)
+	Q_PROPERTY(QColor stepNoteColor MEMBER m_stepNoteColor)
 	Q_PROPERTY(QColor ghostNoteColor MEMBER m_ghostNoteColor)
 	Q_PROPERTY(QColor noteTextColor MEMBER m_noteTextColor)
 	Q_PROPERTY(QColor ghostNoteTextColor MEMBER m_ghostNoteTextColor)
@@ -466,6 +467,7 @@ protected slots:
 	QColor m_lineColor;
 	QColor m_noteModeColor;
 	QColor m_noteColor;
+	QColor m_stepNoteColor;
 	QColor m_noteTextColor;
 	QColor m_ghostNoteColor;
 	QColor m_ghostNoteTextColor;

plugins/MidiExport/MidiExport.cpp

@@ -27,6 +27,7 @@
 
 #include "MidiExport.h"
 
+#include "Engine.h"
 #include "TrackContainer.h"
 #include "DataFile.h"
 #include "InstrumentTrack.h"
@@ -279,6 +280,7 @@ void MidiExport::writeMidiClip(MidiNoteVector &midiClip, const QDomNode& n,
 		mnote.volume = qMin(qRound(base_volume * LocaleHelper::toDouble(note.attribute("vol", "100")) * (127.0 / 200.0)), 127);
 		mnote.time = base_time + note.attribute("pos", "0").toInt();
 		mnote.duration = note.attribute("len", "0").toInt();
+		mnote.type = static_cast<Note::Type>(note.attribute("type", "0").toInt());
 		midiClip.push_back(mnote);
 	}
 }
@@ -311,6 +313,7 @@ void MidiExport::writePatternClip(MidiNoteVector& src, MidiNoteVector& dst,
 			note.pitch = srcNote.pitch;
 			note.time = base + time;
 			note.volume = srcNote.volume;
+			note.type = srcNote.type;
 			dst.push_back(note);
 		}
 	}
@@ -329,9 +332,9 @@ void MidiExport::processPatternNotes(MidiNoteVector& nv, int cutPos)
 			next = cur;
 			cur = it->time;
 		}
-		if (it->duration < 0)
+		if (it->type == Note::Type::Step)
 		{
-			it->duration = qMin(qMin(-it->duration, next - cur), cutPos - it->time);
+			it->duration = qMin(qMin(DefaultBeatLength, next - cur), cutPos - it->time);
 		}
 	}
 }

plugins/MidiExport/MidiExport.h

@@ -30,6 +30,7 @@
 
 #include "ExportFilter.h"
 #include "MidiFile.hpp"
+#include "Note.h"
 
 class QDomNode;
 
@@ -46,6 +47,7 @@ struct MidiNote
 	uint8_t pitch;
 	int duration;
 	uint8_t volume;
+	Note::Type type;
 
 	inline bool operator<(const MidiNote &b) const
 	{
@@ -63,6 +65,16 @@ class MidiExport: public ExportFilter
 	MidiExport();
 	~MidiExport() override = default;
 
+	// Default Beat Length in ticks for step notes
+	// TODO: The beat length actually varies per note, however the method that
+	// calculates it (InstrumentTrack::beatLen) requires a NotePlayHandle to do
+	// so. While we don't figure out a way to hold the beat length of each note
+	// on its member variables, we will use a default value as a beat length that
+	// will be used as an upper limit of the midi note length. This doesn't worsen
+	// the current logic used for MidiExport because right now the beat length is
+	// not even considered during the generation of the MIDI.
+	static constexpr int DefaultBeatLength = 1500;
+
 	gui::PluginView* instantiateView(QWidget *) override
 	{
 		return nullptr;

src/core/DataFile.cpp

@@ -42,6 +42,7 @@
 #include "embed.h"
 #include "GuiApplication.h"
 #include "LocaleHelper.h"
+#include "Note.h"
 #include "PluginFactory.h"
 #include "ProjectVersion.h"
 #include "SongEditor.h"
@@ -79,7 +80,8 @@ const std::vector<DataFile::UpgradeMethod> DataFile::UPGRADE_METHODS = {
 	&DataFile::upgrade_automationNodes  ,   &DataFile::upgrade_extendedNoteRange,
 	&DataFile::upgrade_defaultTripleOscillatorHQ,
 	&DataFile::upgrade_mixerRename      ,   &DataFile::upgrade_bbTcoRename,
-	&DataFile::upgrade_sampleAndHold    ,   &DataFile::upgrade_midiCCIndexing
+	&DataFile::upgrade_sampleAndHold    ,   &DataFile::upgrade_midiCCIndexing,
+	&DataFile::upgrade_noteTypes
 };
 
 // Vector of all versions that have upgrade routines.
@@ -1662,6 +1664,24 @@ void DataFile::upgrade_automationNodes()
 	}
 }
 
+// Convert the negative length notes to StepNotes
+void DataFile::upgrade_noteTypes()
+{
+	const auto notes = elementsByTagName("note");
+
+	for (int i = 0; i < notes.size(); ++i)
+	{
+		auto note = notes.item(i).toElement();
+
+		const auto noteSize = note.attribute("len").toInt();
+		if (noteSize < 0)
+		{
+			note.setAttribute("len", DefaultTicksPerBar / 16);
+			note.setAttribute("type", static_cast<int>(Note::Type::Step));
+		}
+	}
+}
+
 
 /** \brief Note range has been extended to match MIDI specification
  *

src/core/Note.cpp

@@ -74,7 +74,8 @@ Note::Note( const Note & note ) :
 	m_panning( note.m_panning ),
 	m_length( note.m_length ),
 	m_pos( note.m_pos ),
-	m_detuning( nullptr )
+	m_detuning(nullptr),
+	m_type(note.m_type)
 {
 	if( note.m_detuning )
 	{
@@ -179,6 +180,7 @@ void Note::saveSettings( QDomDocument & doc, QDomElement & parent )
 	parent.setAttribute( "pan", m_panning );
 	parent.setAttribute( "len", m_length );
 	parent.setAttribute( "pos", m_pos );
+	parent.setAttribute("type", static_cast<int>(m_type));
 
 	if( m_detuning && m_length )
 	{
@@ -197,6 +199,9 @@ void Note::loadSettings( const QDomElement & _this )
 	m_panning = _this.attribute( "pan" ).toInt();
 	m_length = _this.attribute( "len" ).toInt();
 	m_pos = _this.attribute( "pos" ).toInt();
+	// Default m_type value is 0, which corresponds to RegularNote
+	static_assert(0 == static_cast<int>(Type::Regular));
+	m_type = static_cast<Type>(_this.attribute("type", "0").toInt());
 
 	if( _this.hasChildNodes() )
 	{

src/core/NotePlayHandle.cpp

@@ -53,7 +53,7 @@ NotePlayHandle::NotePlayHandle( InstrumentTrack* instrumentTrack,
 								NotePlayHandle *parent,
 								int midiEventChannel,
 								Origin origin ) :
-	PlayHandle( Type::NotePlayHandle, _offset ),
+	PlayHandle( PlayHandle::Type::NotePlayHandle, _offset ),
 	Note( n.length(), n.pos(), n.key(), n.getVolume(), n.getPanning(), n.detuning() ),
 	m_pluginData( nullptr ),
 	m_instrumentTrack( instrumentTrack ),

src/core/TimePos.cpp

@@ -23,6 +23,7 @@
  *
  */
 
+#include <cassert>
 #include "TimePos.h"
 
 #include "MeterModel.h"
@@ -161,11 +162,11 @@ tick_t TimePos::getTickWithinBeat( const TimeSig &sig ) const
 
 f_cnt_t TimePos::frames( const float framesPerTick ) const
 {
-	if( m_ticks >= 0 )
-	{
-		return static_cast<f_cnt_t>( m_ticks * framesPerTick );
-	}
-	return 0;
+	// Before, step notes used to have negative length. This
+	// assert is a safeguard against negative length being
+	// introduced again (now using Note Types instead #5902)
+	assert(m_ticks >= 0);
+	return static_cast<f_cnt_t>(m_ticks * framesPerTick);
 }
 
 double TimePos::getTimeInMilliseconds( bpm_t beatsPerMinute ) const
@@ -221,4 +222,4 @@ double TimePos::ticksToMilliseconds(double ticks, bpm_t beatsPerMinute)
 }
 
 
-} // namespace lmms
+} // namespace lmms