metdetection.parsing

Class KernEventParser

java.lang.Object

metdetection.parsing.KernEventParser

All Implemented Interfaces:

EventParser

public class KernEventParser
extends java.lang.Object
implements EventParser

A KernEventParser parses notes in from a kern file.
One KernEventParser is required per kern file.

Author:

Andrew McLeod - 5 Sept, 2016

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.util.List<MidiNote>>	goldStandard The gold standard voices from this song.
private static java.util.regex.Pattern	noteDurationPattern A Regex pattern to grab a note duration from a **kern file.
private NoteEventParser	noteEventParser The NoteTracker which will keep track of the notes for this song.
private static java.util.regex.Pattern	notePitchPattern A Regex pattern to grab a note pitch from a **kern file.
private java.io.File	song The song we are parsing.
private TimeTracker	timeTracker The TimeTracker which will handle timing information for this song.
static int	WHOLE_NOTE_DURATION_TICKS The duration of a whole note, in ticks.

Constructor Summary

Constructors

Constructor and Description
KernEventParser(java.io.File kernFile, NoteEventParser noteEventParser, TimeTracker timeTracker) Creates a new KernEventParser

Method Summary

Methods

Modifier and Type	Method and Description
private int	getDuration(int length, int dotCount, int lineNum) Get the length in ticks of a note or rest with the given value and dots.
private int	getDuration(java.lang.String voice, int lineNum) Get the duration, in ticks, of the given note or rest marker.
java.util.List<java.util.List<MidiNote>>	getGoldStandardVoices() Get a List of the gold standard voices from this song.
private int	getOffsetAboveCFromChar(char pitch) Get the offset (in semitones) above C of the given pitch.
private int	getPitch(java.lang.String pitch) Get the pitch number of the given note data.
private int	getPitch(java.lang.String voice, int lineNum) Get the pitch of the given note or rest marker.
private void	handleIndicator(java.lang.String indicator, int lineNum) Handle the given indicator read from the **kern file.
void	run() Parse the loaded file to the loaded NoteEventParser.

Methods inherited from class java.lang.Object

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

Field Detail

WHOLE_NOTE_DURATION_TICKS

public static final int WHOLE_NOTE_DURATION_TICKS

The duration of a whole note, in ticks.

See Also:

Constant Field Values

noteDurationPattern

private static final java.util.regex.Pattern noteDurationPattern

A Regex pattern to grab a note duration from a **kern file.
Group 1 will be the number duration, and group 2 will be any dots.

notePitchPattern

private static final java.util.regex.Pattern notePitchPattern

A Regex pattern to grab a note pitch from a **kern file.
Group 1 will be the pitch, and group 2 will be the accidentals.

timeTracker

private TimeTracker timeTracker

The TimeTracker which will handle timing information for this song.

noteEventParser

private final NoteEventParser noteEventParser

The NoteTracker which will keep track of the notes for this song.

song

private final java.io.File song

The song we are parsing.

goldStandard

private java.util.List<java.util.List<MidiNote>> goldStandard

The gold standard voices from this song.

Constructor Detail

KernEventParser

public KernEventParser(java.io.File kernFile,
               NoteEventParser noteEventParser,
               TimeTracker timeTracker)

Creates a new KernEventParser

Parameters:

kernFile - The kern file we will parse.

noteEventParser - The NoteEventParser to pass events to when we run this parser.

timeTracker - timeTracker

Method Detail

run

public void run()
         throws java.io.IOException

Parse the loaded file to the loaded NoteEventParser.

Specified by:

run in interface EventParser

Throws:

java.io.IOException - If an I/O error occurred while reading the file.

getDuration

private int getDuration(java.lang.String voice,
              int lineNum)
                 throws java.io.IOException

Get the duration, in ticks, of the given note or rest marker.

Parameters:

voice - A note or rest marker.

lineNum - The line number the note or rest marker came from.

Returns:

The duration of the given marker in ticks.

Throws:

java.io.IOException - If no duration is found.

getDuration

private int getDuration(int length,
              int dotCount,
              int lineNum)

Get the length in ticks of a note or rest with the given value and dots.

Parameters:

length - The value of the note, in **kern format. 1 = whole note, 2 = half note, etc.

dotCount - The number of dots after the note.

lineNum - The line number this duration was found on.

Returns:

The length of the note in ticks.

getPitch

private int getPitch(java.lang.String voice,
           int lineNum)
              throws java.io.IOException

Get the pitch of the given note or rest marker. A rest will return -1.

Parameters:

voice - A note or rest marker.

lineNum - The line number the note or rest marker came from.

Returns:

The pitch of the given note, or -1 if it is a rest.

Throws:

java.io.IOException - If no rest or pitch is found.

getPitch

private int getPitch(java.lang.String pitch)

Get the pitch number of the given note data.

Parameters:

pitch - The **kern pitch String.

Returns:

The pitch number, where 60 is C4.

handleIndicator

private void handleIndicator(java.lang.String indicator,
                   int lineNum)
                      throws java.io.IOException

Handle the given indicator read from the **kern file.

Parameters:

indicator - The indicator we need to parse.

lineNum - The line number the indicator came from.

Throws:

java.io.IOException - If some error occurred in parsing the indicator.

getOffsetAboveCFromChar

private int getOffsetAboveCFromChar(char pitch)

Get the offset (in semitones) above C of the given pitch.

Parameters:

pitch - The pitch character we want the offset above C for.

Returns:

The offset above C of the given pitch character, or -1 if invalid.

getGoldStandardVoices

public java.util.List<java.util.List<MidiNote>> getGoldStandardVoices()

Get a List of the gold standard voices from this song.

Specified by:

getGoldStandardVoices in interface EventParser

Returns:

A List of the gold standard voices from this song.