metdetection.utils

Class MidiNote

java.lang.Object

metdetection.utils.MidiNote

All Implemented Interfaces:

java.lang.Comparable<MidiNote>

public class MidiNote
extends java.lang.Object
implements java.lang.Comparable<MidiNote>

A MidiNote represents a single instance of a played midi note. It contains information on the note's pitch, onset, offset, and velocity, as well as which MidiChord it is assigned to.

MidiNotes are Comparable, and their natural ordering is determined strictly by each note's onsetTime. That means that the compareTo(MidiNote) method will return 0 if two notes are compared which have the same onset time. For this reason, MidiNotes should not be used in any SortedSets, since they test for equality based soleley on the compareTo method, and will therefore not be able to hold multiple notes with the same onset time.

Author:

Andrew McLeod - 23 October, 2014

Field Summary

Fields

Modifier and Type	Field and Description
private int	correctVoice The gold standard voice which this note came from.
private int	guessedVoice The index of the guessed voice of this note.
private long	offsetTick The offset tick of this note, or 0 if it is still active.
private long	offsetTime The offset time of this note, measured in microseconds, or 0 if it is still active.
private long	onsetTick The onset tick of this note.
private long	onsetTime The onset time of this note, measured in microseconds.
private int	pitch The key number of this note.
private int	velocity The velocity of this note.

Constructor Summary

Constructors

Constructor and Description
MidiNote(int key, int velocity, long onsetTime, long onsetTick, int correctVoice, int guessedVoice) Constructor for a new note.

Method Summary

Methods

Modifier and Type	Method and Description
void	close(long offsetTime, long offsetTick) Turns off this note at the given time and tick.
int	compareTo(MidiNote o)
boolean	equals(java.lang.Object o)
private java.util.List<Beat>	getBeatsAroundTime(long time, java.util.List<Beat> beats)
int	getCorrectVoice() Get the gold standard voice of this note.
long	getDurationTime() Get the duration of this MidiNote in microseconds.
int	getGuessedVoice() Get the guessed voice of this note.
static java.lang.String	getNoteName(int pitch) Get the note name of the given MIDI pitch value.
Beat	getOffsetBeat(java.util.List<Beat> beats)
long	getOffsetTick() Gets the offset tick of this note.
long	getOffsetTime() Gets the offset time of this note.
Beat	getOnsetBeat(java.util.List<Beat> beats)
long	getOnsetTick() Gets the onset tick of this note.
long	getOnsetTime() Gets the onset time of this note.
int	getPitch() Gets the key number of this note.
int	getVelocity() Get the velocity of this note.
boolean	isActive() Returns whether this note is active (still on) or not.
boolean	overlaps(MidiNote other) Return whether this note overlaps another MidiNote in time.
void	setCorrectVoice(int correctVoice) Set the correctVoice of this note to a new value.
void	setGuessedVoice(int voice) Set the guessed voice of this note to the given value.
void	setOffset(long offsetTime, long offsetTick) Move this note's offset to the given location.
void	setOnset(long onsetTime, long onsetTick) Move this note's onset to the given location.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

correctVoice

private int correctVoice

The gold standard voice which this note came from.

onsetTime

private long onsetTime

The onset time of this note, measured in microseconds.

onsetTick

private long onsetTick

The onset tick of this note.

offsetTime

private long offsetTime

The offset time of this note, measured in microseconds, or 0 if it is still active.

offsetTick

private long offsetTick

The offset tick of this note, or 0 if it is still active.

velocity

private int velocity

The velocity of this note.

pitch

private int pitch

The key number of this note. For piano, it should be on the range 21 to 108 inclusive.

guessedVoice

private int guessedVoice

The index of the guessed voice of this note.

Constructor Detail

MidiNote

public MidiNote(int key,
        int velocity,
        long onsetTime,
        long onsetTick,
        int correctVoice,
        int guessedVoice)

Constructor for a new note.

Parameters:

key - pitch

velocity - velocity

onsetTime - onsetTime

onsetTick - onsetTick

correctVoice - correctVoice

guessedVoice - guessedVoice

Method Detail

setOnset

public void setOnset(long onsetTime,
            long onsetTick)

Move this note's onset to the given location.

Parameters:

onsetTime - onsetTime

onsetTick - onsetTick

setOffset

public void setOffset(long offsetTime,
             long offsetTick)

Move this note's offset to the given location.

Parameters:

offsetTime - offsetTime

offsetTick - offsetTick

isActive

public boolean isActive()

Returns whether this note is active (still on) or not. A note will be active

Returns:

True if this note is active. False otherwise.

close

public void close(long offsetTime,
         long offsetTick)

Turns off this note at the given time and tick.

Parameters:

offsetTime - offsetTime

offsetTick - offsetTick

overlaps

public boolean overlaps(MidiNote other)

Return whether this note overlaps another MidiNote in time.

Parameters:

other - The note we want to check for overlap. This can be null, in which case we will return false.

Returns:

True if the notes overlap. False otherwise.

getOnsetTime

public long getOnsetTime()

Gets the onset time of this note.

Returns:

onsetTime

getOnsetTick

public long getOnsetTick()

Gets the onset tick of this note.

Returns:

onsetTick

getOffsetTime

public long getOffsetTime()

Gets the offset time of this note.

Returns:

offsetTime

getOffsetTick

public long getOffsetTick()

Gets the offset tick of this note.

Returns:

offsetTick

getDurationTime

public long getDurationTime()

Get the duration of this MidiNote in microseconds.

Returns:

The duration in microseconds.

getPitch

public int getPitch()

Gets the key number of this note.

Returns:

pitch

getVelocity

public int getVelocity()

Get the velocity of this note.

Returns:

velocity

getCorrectVoice

public int getCorrectVoice()

Get the gold standard voice of this note.

Returns:

correctVoice

setCorrectVoice

public void setCorrectVoice(int correctVoice)

Set the correctVoice of this note to a new value.

Parameters:

correctVoice - correctVoice

setGuessedVoice

public void setGuessedVoice(int voice)

Set the guessed voice of this note to the given value.

Parameters:

voice - guessedVoice

getGuessedVoice

public int getGuessedVoice()

Get the guessed voice of this note.

Returns:

guessedVoice

getOnsetBeat

public Beat getOnsetBeat(java.util.List<Beat> beats)

getOffsetBeat

public Beat getOffsetBeat(java.util.List<Beat> beats)

getBeatsAroundTime

private java.util.List<Beat> getBeatsAroundTime(long time,
                                      java.util.List<Beat> beats)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(MidiNote o)

Specified by:

compareTo in interface java.lang.Comparable<MidiNote>

getNoteName

public static java.lang.String getNoteName(int pitch)

Get the note name of the given MIDI pitch value. Accidentals are currently all written as sharps.

Parameters:

pitch - The MIDI pitch value whose note name we want, on the range 0-127

Returns:

The note name of the given MIDI pitch value