metdetection

Class Runner

java.lang.Object

metdetection.Runner

public class Runner
extends java.lang.Object

The Runner class is the interface which runs all of the different parts of the beattracking project directly. This is used as an interface between Main, which interprets the command line arguments, and the actual functionality of this project.

Author:

Andrew McLeod - 3 Sept, 2015

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_BEAT_TRACKER The default beat tracker to use.
static java.lang.String	DEFAULT_HIERARCHY_MODEL The default hierarchy model to use.
static java.lang.String	DEFAULT_VOICE_SPLITTER The default voice splitter to use.

Constructor Summary

Constructors

Constructor and Description
Runner()

Method Summary

Methods

Modifier and Type	Method and Description
static EventParser	parseFile(java.io.File file, NoteEventParser parser, TimeTracker tt) Parse the given file with the given objects.
static EventParser	parseFile(java.io.File file, NoteEventParser parser, TimeTracker tt, boolean useChannel) Parse the given file with the given objects.
static KernEventParser	parseKernFile(java.io.File file, NoteEventParser parser, TimeTracker tt) Parse the given **kern file using the given objects.
static MidiEventParser	parseMidiFile(java.io.File file, NoteEventParser parser, TimeTracker tt, boolean useChannel) Parse the given MIDI file using the given objects.
static void	performInference(MidiModel model, NoteListGenerator nlg) Perform inference on the given model.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VOICE_SPLITTER

public static final java.lang.String DEFAULT_VOICE_SPLITTER

The default voice splitter to use.

See Also:

Constant Field Values

DEFAULT_BEAT_TRACKER

public static final java.lang.String DEFAULT_BEAT_TRACKER

The default beat tracker to use.

See Also:

Constant Field Values

DEFAULT_HIERARCHY_MODEL

public static final java.lang.String DEFAULT_HIERARCHY_MODEL

The default hierarchy model to use.

See Also:

Constant Field Values

Constructor Detail

Runner

public Runner()

Method Detail

parseFile

public static EventParser parseFile(java.io.File file,
                    NoteEventParser parser,
                    TimeTracker tt)
                             throws java.io.IOException,
                                    javax.sound.midi.InvalidMidiDataException

Parse the given file with the given objects. Use this method if you don't know specifically whether the file is a **kern file or a MIDI file, and you don't care whether to use channels or tracks as the gold standard voice if it is a MIDI file. (This method simply passes the arguments through to parseFile(File, NoteEventParser, TimeTracker, boolean), with useChannel set to the default value (true).
This method first tries to detect the file's type by its extension (.mid, .midi, or .krn). If the extension is something else, or there is some error parsing the file, both MIDI and **kern are tried to see if either works.
If you know the file type already, you should use either parseKernFile(File, NoteEventParser, TimeTracker) (for **kern files) or parseMidiFile(File, NoteEventParser, TimeTracker, boolean) (for MIDI files).

Parameters:

file - The file to parse.

parser - The NoteEventParser to pass note events to.

tt - The TimeTracker to pass time events to.

Returns:

The EventParser used to parse the given file.

Throws:

javax.sound.midi.InvalidMidiDataException - If there was invalid MIDI data in the given File (And parsing as a **kern file didn't work).

java.io.IOException - If there was some I/O error when parsing as MIDI, or some syntax error when parsing as **kern (and neither worked).

parseFile

public static EventParser parseFile(java.io.File file,
                    NoteEventParser parser,
                    TimeTracker tt,
                    boolean useChannel)
                             throws java.io.IOException,
                                    javax.sound.midi.InvalidMidiDataException

Parse the given file with the given objects. Use this method if you don't know specifically whether the file is a **kern file or a MIDI file, but if it is a MIDI file, you know whether to use channels or tracks as the gold standard voices. If you don't know, you should use parseFile(File, NoteEventParser, TimeTracker), as it simply passes the arguments through to this method, using the default value for useChannel.
This method first tries to detect the file's type by its extension (.mid, .midi, or .krn). If the extension is something else, or there is some error parsing the file, both MIDI and **kern are tried to see if either works.
If you know the file type already, you should use either parseKernFile(File, NoteEventParser, TimeTracker) (for **kern files) or parseMidiFile(File, NoteEventParser, TimeTracker, boolean) (for MIDI files).

Parameters:

file - The file to parse.

parser - The NoteEventParser to pass note events to.

tt - The TimeTracker to pass time events to.

Returns:

The EventParser used to parse the given file.

Throws:

java.io.IOException - The File was unable to be parsed for some reason.

javax.sound.midi.InvalidMidiDataException - The File contained invalid MIDI data.

parseMidiFile

public static MidiEventParser parseMidiFile(java.io.File file,
                            NoteEventParser parser,
                            TimeTracker tt,
                            boolean useChannel)
                                     throws javax.sound.midi.InvalidMidiDataException,
                                            java.io.IOException

Parse the given MIDI file using the given objects.

Parameters:

file - The MIDI File we wish to parse.

parser - The NoteEventParser we want our EventParser to pass note events to.

tt - The TimeTracker we want our EventParser to pass time events to.

useChannel - Whether we want to use channels as a gold standard voice (TRUE), or tracks (FALSE), when parsing midi.

Returns:

The MidiEventParser to be used for this song.

Throws:

javax.sound.midi.InvalidMidiDataException - If the File contains invalid MIDI data.

java.io.IOException - If there was an error reading the File.

parseKernFile

public static KernEventParser parseKernFile(java.io.File file,
                            NoteEventParser parser,
                            TimeTracker tt)
                                     throws java.io.IOException

Parse the given **kern file using the given objects.

Parameters:

file - The **kern File we wish to parse.

parser - The NoteEventParser we want our EventParser to pass note events to.

tt - The TimeTracker we want our EventParser to pass time events to.

Returns:

The KernEventParser to be used for this song.

Throws:

java.io.IOException - If there was some error reading or parsing the file.

performInference

public static void performInference(MidiModel model,
                    NoteListGenerator nlg)

Perform inference on the given model.

Parameters:

model - The model on which we want to perform inference.

nlg - The NoteListGenerator which will give us the incoming note lists.