metdetection.parsing

Class QuantisationMeter

java.lang.Object

metdetection.parsing.QuantisationMeter

All Implemented Interfaces:

NoteEventParser

public class QuantisationMeter
extends java.lang.Object
implements NoteEventParser

A QuantisationMeter is able to measure the quantisation level of a given piece. It parses note on events, and measures each note as it occurs, thus saving the memory space of actually having to load the notes in to memory.

Author:

Andrew McLeod - 6 October, 2016

Field Summary

Fields

Modifier and Type	Field and Description
private int	divisions The number of divisions per quarter note to use when measuring.
private int	numMeasuredNotes The number of notes we've measured so far.
private double	quantisationErrorTotal The total quantisation error of the notes we've seen so far.
private TimeTracker	timeTracker The time tracker to use to measure quantisation.

Constructor Summary

Constructors

Constructor and Description
QuantisationMeter(TimeTracker tt, int divisions) Create a new quantisation meter with the given TimeTracker and number of divisions per quarter note.

Method Summary

Methods

Modifier and Type	Method and Description
double	getQuantisationError() Get the average quantisation error out of the notes we've seen so far.
void	noteOff(int key, long tick, int channel) Process a Note Off event.
MidiNote	noteOn(int key, int velocity, long tick, int channel) Process a Note On event.

Methods inherited from class java.lang.Object

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

Field Detail

timeTracker

private TimeTracker timeTracker

The time tracker to use to measure quantisation.

quantisationErrorTotal

private double quantisationErrorTotal

The total quantisation error of the notes we've seen so far.

numMeasuredNotes

private int numMeasuredNotes

The number of notes we've measured so far.

divisions

private int divisions

The number of divisions per quarter note to use when measuring.

Constructor Detail

QuantisationMeter

public QuantisationMeter(TimeTracker tt,
                 int divisions)

Create a new quantisation meter with the given TimeTracker and number of divisions per quarter note.

Parameters:

tt - timeTracker

divisions - divisions

Method Detail

noteOn

public MidiNote noteOn(int key,
              int velocity,
              long tick,
              int channel)

Description copied from interface: NoteEventParser

Process a Note On event.

Specified by:

noteOn in interface NoteEventParser

Parameters:

key - The key pressed. This will be a number between 1 and 88 for piano.

velocity - The velocity of the press. This is a value between 1 and 127 inclusive.

tick - The midi tick location of this event.

channel - The midi channel this note came from.

Returns:

The MidiNote we just created.

noteOff

public void noteOff(int key,
           long tick,
           int channel)
             throws javax.sound.midi.InvalidMidiDataException

Description copied from interface: NoteEventParser

Process a Note Off event.

Specified by:

noteOff in interface NoteEventParser

Parameters:

key - The midi key which has been turned off. This value is between 39 and 127, inclusive, for piano.

tick - The midi tick location of this event.

channel - The midi channel this note came from.

Throws:

javax.sound.midi.InvalidMidiDataException - If a note off event doesn't match any previously seen note on events.

getQuantisationError

public double getQuantisationError()

Get the average quantisation error out of the notes we've seen so far.

Returns:

The average quantisation error over all of the notes we've seen so far.