org.midica.file.write

Class Decompiler

java.lang.Object

org.midica.file.write.Exporter

org.midica.file.write.Decompiler

Direct Known Subclasses:

AldaExporter, MidicaPLExporter

public abstract class Decompiler
extends Exporter

This is the base class of all decompiling exporters, translating MIDI into something else.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
protected static byte	ALDA
protected static boolean	ALL_SYLLABLES_ORPHANED
protected static long	CHORD_NOTE_OFF_TOLERANCE
protected static long	CHORD_NOTE_ON_TOLERANCE
protected static long	CHORD_VELOCITY_TOLERANCE
protected static java.util.TreeMap<java.lang.String,java.lang.Integer>	chordCount lowest note – chord count
protected static java.util.TreeMap<java.lang.String,java.lang.String>	chords comma-separated note bytes – chord name
protected static java.util.TreeMap<java.lang.String,java.util.ArrayList<java.lang.String>>	chordsByBaseNote lowest note – comma-separated note bytes (This structure is only needed for the sorting: lowest note first, then chord name)
protected java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.String>>	commentHistory
protected static byte	CTRL_CHANGE_MODE
static boolean	DEFAULT_ALL_SYLLABLES_ORPHANED
static long	DEFAULT_CHORD_NOTE_OFF_TOLERANCE
static long	DEFAULT_CHORD_NOTE_ON_TOLERANCE
static long	DEFAULT_CHORD_VELOCITY_TOLERANCE
static byte	DEFAULT_CTRL_CHANGE_MODE
static float	DEFAULT_DURATION_RATIO_TOLERANCE
static java.lang.String	DEFAULT_EXTRA_GLOBALS_STR
static boolean	DEFAULT_KARAOKE_ONE_CHANNEL
static byte	DEFAULT_LENGTH_STRATEGY
static long	DEFAULT_LENGTH_TICK_TOLERANCE
static float	DEFAULT_MAX_DURATION_TO_KEEP
static long	DEFAULT_MAX_TARGET_TICKS_ON
static float	DEFAULT_MIN_DURATION_TO_KEEP
static long	DEFAULT_MIN_TARGET_TICKS_ON
static boolean	DEFAULT_MUST_ADD_CONFIG
static boolean	DEFAULT_MUST_ADD_QUALITY_SCORE
static boolean	DEFAULT_MUST_ADD_STATISTICS
static boolean	DEFAULT_MUST_ADD_STRATEGY_STAT
static boolean	DEFAULT_MUST_ADD_TICK_COMMENTS
static byte	DEFAULT_ORPHANED_SYLLABLES
static boolean	DEFAULT_USE_DOTTED_NOTES
static boolean	DEFAULT_USE_DOTTED_RESTS
static boolean	DEFAULT_USE_KARAOKE
static boolean	DEFAULT_USE_PRE_DEFINED_CHORDS
static boolean	DEFAULT_USE_TRIPLETTED_NOTES
static boolean	DEFAULT_USE_TRIPLETTED_RESTS
protected static float	DURATION_RATIO_TOLERANCE
protected static byte	ET_INLINE_BLK
protected static byte	ET_INSTR
protected static byte	ET_NOTES
protected static ExportResult	exportResult
protected static java.util.TreeSet<java.lang.Long>	EXTRA_GLOBALS
protected static int	format
static byte	INLINE_BLOCK
protected java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Byte[]>>	instrumentHistory
protected static java.util.ArrayList<Instrument>	instrumentsByChannel stores the current state of each channel
protected static java.util.TreeMap<java.lang.String,Instrument>	instrumentsByName
protected static boolean	isSoftKaraoke
protected static boolean	KARAOKE_ONE_CHANNEL
protected static byte	LENGTH_STRATEGY
protected static long	LENGTH_TICK_TOLERANCE
protected java.util.ArrayList<java.lang.Byte>	lyricsChannels channels that can be used for lyrics, sorted by priority
protected java.util.TreeMap<java.lang.Long,java.lang.String>	lyricsSyllables
protected static float	MAX_DURATION_TO_KEEP
protected static long	MAX_SOURCE_TICKS_ON
protected static long	MAX_TARGET_TICKS_ON
protected static byte	MIDICA
protected static float	MIN_DURATION_TO_KEEP
protected static long	MIN_SOURCE_TICKS_ON
protected static long	MIN_TARGET_TICKS_ON
protected static boolean	MUST_ADD_CONFIG
protected static boolean	MUST_ADD_QUALITY_SCORE
protected static boolean	MUST_ADD_STATISTICS
protected static boolean	MUST_ADD_STRATEGY_STAT
protected static boolean	MUST_ADD_TICK_COMMENTS
protected static java.lang.String	NEW_LINE
protected java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.lang.Byte>>>	noteHistory
protected static java.util.TreeMap<java.lang.Long,java.lang.String>	noteLength
protected java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>>>	noteOnOff
protected static byte	NP_DURATION
protected static byte	NP_END_TICK
protected static byte	NP_LENGTH
protected static byte	NP_LYRICS
protected static byte	NP_MULTIPLE
protected static byte	NP_NOTE_NUM
protected static byte	NP_OFF_TICK
protected static byte	NP_VELOCITY
protected static byte	ORPHANED_SYLLABLES
protected static java.util.TreeMap<java.lang.Long,java.lang.String>	restLength
static byte	SLICE_BEGIN_BLOCK
protected static java.util.ArrayList<Slice>	slices Stores each slice of the sequence.
protected static int	sourceResolution
protected static byte	STAT_NOTE_DURATIONS
protected static byte	STAT_NOTE_MULTIPLE
protected static byte	STAT_NOTE_SUMMANDS
protected static byte	STAT_NOTE_TRIPLETS
protected static byte	STAT_NOTE_VELOCITIES
protected static byte	STAT_NOTES
protected static byte	STAT_REST_SKIPPED
protected static byte	STAT_REST_SUMMANDS
protected static byte	STAT_REST_TRIPLETS
protected static byte	STAT_RESTS
private static byte	STAT_STRATEGY_DURATION
private static byte	STAT_STRATEGY_NEXT_ON
private static byte	STAT_STRATEGY_PRESS
protected static byte	STAT_TOTAL
private java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.lang.Integer>>	statistics Stores statistics to estimate the decompilation quality and to count the used strategies.
static byte	STRATEGY_DURATION_NEXT_PRESS
static byte	STRATEGY_DURATION_PRESS
static byte	STRATEGY_NEXT_DURATION_PRESS
static byte	STRATEGY_NEXT_PRESS
static byte	STRATEGY_PRESS
protected static int	targetResolution
protected static boolean	USE_DOTTED_NOTES
protected static boolean	USE_DOTTED_RESTS
protected static boolean	USE_KARAOKE
protected static boolean	USE_PRE_DEFINED_CHORDS
protected static boolean	USE_TRIPLETTED_NOTES
protected static boolean	USE_TRIPLETTED_RESTS

Constructor Summary

Constructors

Constructor and Description
Decompiler()

Method Summary

Modifier and Type	Method and Description
private void	addInstrumentsToSlices() Adds all ticks to the timeline with at least one instrument change.
private void	addLyricsToSlices() Adds syllables to the slices’ timelines.
private void	addNotesToSlices() Fills the timeline structures of the slices with note-on events regarding chords and single notes.
private void	addQualityDetailsLine(java.lang.StringBuilder stats, java.lang.String name, java.lang.String count, double percentage, java.lang.Double subScore) Adds a line to the quality statistics, if configured.
protected void	addWarningRestSkipped(java.lang.Long tick, java.lang.Long ticks, java.lang.Byte channel) Creates a warning caused by a skipped rest.
private void	adjustOffTick(java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>> channelOnOff, byte channel, byte note, long offTick, long crdOffTick) Adjusts the Note-OFF tick of a note so that it can join a chord.
private static float	calculateDuration(long noteTicks, long pressTicks) Calculates the duration ratio.
protected int	calculateTicks(int factor, int divisor) Calculates the tick length of a note, based on the current MIDI sequence’s resolution and in relation to a quarter note.
protected java.lang.String	createConfig() Creates the block with configuration variables that has been used for decompilation.
protected abstract java.lang.String	createOutput() Creates the format-specific string to be written to the exported file.
protected java.lang.String	createQualityStats() Creates the quality statistics to be printed at the end of the produced file.
private java.lang.String	createQualityStatsPart(java.util.TreeMap<java.lang.Byte,java.lang.Integer> subStat) Creates the quality statistics for one part (either a channel or total).
protected abstract java.lang.String	createRest(byte channel, long ticks, long beginTick, java.lang.String syllable) Creates a rest.
protected java.lang.String	createRestBeforeSlice(Slice slice) Creates a rest before a new slice begins, if necessary.
protected java.lang.String	createStrategyStats() Creates the strategy statistics to be printed at the end of the produced file.
private java.lang.String	createStrategyStatsPart(java.util.TreeMap<java.lang.Byte,java.lang.Integer> subStat) Creates the strategy statistics for one part (either a channel or total).
protected java.lang.String	createTickDescription(long tick, boolean withCommentSymbol) Creates a tick description that can be used in tick comments.
ExportResult	export(java.io.File file) Decompiles a MIDI sequence and writes the result either into the given file or to the standard output.
protected java.lang.String	getCommentSymbol() Returns the comment symbol of the current format.
protected Instrument	getFurthestInstrument() Calculates and returns the most advanced instrument.
protected java.util.ArrayList<java.lang.Long>	getLengthsForSum(long ticks, boolean isRest) Splits a note or rest length into several lengths that can be used for a length sum.
private long	getNoteLengthByPressTicks(long ticks) Guesses the theoretical note length just by choosing the next possible pre-defined length.
protected long[]	getNoteLengthProperties(long onTick, long offTick, byte channel) Calculates the note length string and duration percentage of a note (or chord).
private void	groupNotes() Groups notes with note-on/note-off/velocity differences that are smaller than the according tolerances.
protected void	incrementStats(java.lang.Byte type, java.lang.Byte channel) Increments the statistics for the channel and total.
protected abstract void	init() Initializes format-specific data structures.
private void	initInstruments() Initializes and resets the instruments structures so that their configurations can be tracked.
protected abstract java.util.TreeMap<java.lang.Long,java.lang.String>	initLengths(boolean rest) Calculates which tick length corresponds to which note or rest length.
private void	initStatistics() Initializes data structures for statistics.
private java.lang.String	makeChordName(java.util.TreeSet<java.lang.Byte> notes, java.lang.String csvNotes) Creates a new unique name for the chord consisting of the given notes.
private void	organizeChords(java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>> notes, boolean isPercussion) Receives the notes that are pressed at one tick and channel.
private void	postprocessLengths(java.util.TreeMap<java.lang.Long,java.lang.String> lengths) Removes lengths that are too small to make sense according to the source resolution.
private java.util.ArrayList<java.lang.Byte>	prioritizeChannelsForLyrics() Prioritizes the channels for karaoke usage.
private void	refreshConfig() Re-reads all config variables that are relevant for decompilation.
private void	splitSequence() Splits the sequence into slices between global commands.

Methods inherited from class org.midica.file.write.Exporter

createFile

Methods inherited from class java.lang.Object

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

Field Detail

MIDICA

protected static final byte MIDICA

See Also:

Constant Field Values

ALDA

protected static final byte ALDA

See Also:

Constant Field Values

ET_INSTR

protected static final byte ET_INSTR

See Also:

Constant Field Values

ET_NOTES

protected static final byte ET_NOTES

See Also:

Constant Field Values

ET_INLINE_BLK

protected static final byte ET_INLINE_BLK

See Also:

Constant Field Values

NP_VELOCITY

protected static final byte NP_VELOCITY

See Also:

Constant Field Values

NP_OFF_TICK

protected static final byte NP_OFF_TICK

See Also:

Constant Field Values

NP_END_TICK

protected static final byte NP_END_TICK

See Also:

Constant Field Values

NP_LENGTH

protected static final byte NP_LENGTH

See Also:

Constant Field Values

NP_DURATION

protected static final byte NP_DURATION

See Also:

Constant Field Values

NP_MULTIPLE

protected static final byte NP_MULTIPLE

See Also:

Constant Field Values

NP_LYRICS

protected static final byte NP_LYRICS

See Also:

Constant Field Values

NP_NOTE_NUM

protected static final byte NP_NOTE_NUM

See Also:

Constant Field Values

STAT_TOTAL

protected static final byte STAT_TOTAL

See Also:

Constant Field Values

STAT_RESTS

protected static final byte STAT_RESTS

See Also:

Constant Field Values

STAT_REST_SKIPPED

protected static final byte STAT_REST_SKIPPED

See Also:

Constant Field Values

STAT_REST_TRIPLETS

protected static final byte STAT_REST_TRIPLETS

See Also:

Constant Field Values

STAT_REST_SUMMANDS

protected static final byte STAT_REST_SUMMANDS

See Also:

Constant Field Values

STAT_NOTES

protected static final byte STAT_NOTES

See Also:

Constant Field Values

STAT_NOTE_VELOCITIES

protected static final byte STAT_NOTE_VELOCITIES

See Also:

Constant Field Values

STAT_NOTE_DURATIONS

protected static final byte STAT_NOTE_DURATIONS

See Also:

Constant Field Values

STAT_NOTE_TRIPLETS

protected static final byte STAT_NOTE_TRIPLETS

See Also:

Constant Field Values

STAT_NOTE_SUMMANDS

protected static final byte STAT_NOTE_SUMMANDS

See Also:

Constant Field Values

STAT_NOTE_MULTIPLE

protected static final byte STAT_NOTE_MULTIPLE

See Also:

Constant Field Values

STAT_STRATEGY_NEXT_ON

private static final byte STAT_STRATEGY_NEXT_ON

See Also:

Constant Field Values

STAT_STRATEGY_DURATION

private static final byte STAT_STRATEGY_DURATION

See Also:

Constant Field Values

STAT_STRATEGY_PRESS

private static final byte STAT_STRATEGY_PRESS

See Also:

Constant Field Values

NEW_LINE

protected static final java.lang.String NEW_LINE

INLINE_BLOCK

public static final byte INLINE_BLOCK

See Also:

Constant Field Values

SLICE_BEGIN_BLOCK

public static final byte SLICE_BEGIN_BLOCK

See Also:

Constant Field Values

STRATEGY_NEXT_DURATION_PRESS

public static final byte STRATEGY_NEXT_DURATION_PRESS

See Also:

Constant Field Values

STRATEGY_DURATION_NEXT_PRESS

public static final byte STRATEGY_DURATION_NEXT_PRESS

See Also:

Constant Field Values

STRATEGY_NEXT_PRESS

public static final byte STRATEGY_NEXT_PRESS

See Also:

Constant Field Values

STRATEGY_DURATION_PRESS

public static final byte STRATEGY_DURATION_PRESS

See Also:

Constant Field Values

STRATEGY_PRESS

public static final byte STRATEGY_PRESS

See Also:

Constant Field Values

DEFAULT_MUST_ADD_TICK_COMMENTS

public static final boolean DEFAULT_MUST_ADD_TICK_COMMENTS

See Also:

Constant Field Values

DEFAULT_MUST_ADD_CONFIG

public static final boolean DEFAULT_MUST_ADD_CONFIG

See Also:

Constant Field Values

DEFAULT_MUST_ADD_QUALITY_SCORE

public static final boolean DEFAULT_MUST_ADD_QUALITY_SCORE

See Also:

Constant Field Values

DEFAULT_MUST_ADD_STATISTICS

public static final boolean DEFAULT_MUST_ADD_STATISTICS

See Also:

Constant Field Values

DEFAULT_MUST_ADD_STRATEGY_STAT

public static final boolean DEFAULT_MUST_ADD_STRATEGY_STAT

See Also:

Constant Field Values

DEFAULT_LENGTH_STRATEGY

public static final byte DEFAULT_LENGTH_STRATEGY

See Also:

Constant Field Values

DEFAULT_MIN_TARGET_TICKS_ON

public static final long DEFAULT_MIN_TARGET_TICKS_ON

See Also:

Constant Field Values

DEFAULT_MAX_TARGET_TICKS_ON

public static final long DEFAULT_MAX_TARGET_TICKS_ON

See Also:

Constant Field Values

DEFAULT_MIN_DURATION_TO_KEEP

public static final float DEFAULT_MIN_DURATION_TO_KEEP

See Also:

Constant Field Values

DEFAULT_MAX_DURATION_TO_KEEP

public static final float DEFAULT_MAX_DURATION_TO_KEEP

See Also:

Constant Field Values

DEFAULT_LENGTH_TICK_TOLERANCE

public static final long DEFAULT_LENGTH_TICK_TOLERANCE

See Also:

Constant Field Values

DEFAULT_DURATION_RATIO_TOLERANCE

public static final float DEFAULT_DURATION_RATIO_TOLERANCE

See Also:

Constant Field Values

DEFAULT_USE_PRE_DEFINED_CHORDS

public static final boolean DEFAULT_USE_PRE_DEFINED_CHORDS

See Also:

Constant Field Values

DEFAULT_CHORD_NOTE_ON_TOLERANCE

public static final long DEFAULT_CHORD_NOTE_ON_TOLERANCE

See Also:

Constant Field Values

DEFAULT_CHORD_NOTE_OFF_TOLERANCE

public static final long DEFAULT_CHORD_NOTE_OFF_TOLERANCE

See Also:

Constant Field Values

DEFAULT_CHORD_VELOCITY_TOLERANCE

public static final long DEFAULT_CHORD_VELOCITY_TOLERANCE

See Also:

Constant Field Values

DEFAULT_USE_DOTTED_NOTES

public static final boolean DEFAULT_USE_DOTTED_NOTES

See Also:

Constant Field Values

DEFAULT_USE_DOTTED_RESTS

public static final boolean DEFAULT_USE_DOTTED_RESTS

See Also:

Constant Field Values

DEFAULT_USE_TRIPLETTED_NOTES

public static final boolean DEFAULT_USE_TRIPLETTED_NOTES

See Also:

Constant Field Values

DEFAULT_USE_TRIPLETTED_RESTS

public static final boolean DEFAULT_USE_TRIPLETTED_RESTS

See Also:

Constant Field Values

DEFAULT_USE_KARAOKE

public static final boolean DEFAULT_USE_KARAOKE

See Also:

Constant Field Values

DEFAULT_ALL_SYLLABLES_ORPHANED

public static final boolean DEFAULT_ALL_SYLLABLES_ORPHANED

See Also:

Constant Field Values

DEFAULT_ORPHANED_SYLLABLES

public static final byte DEFAULT_ORPHANED_SYLLABLES

See Also:

Constant Field Values

DEFAULT_KARAOKE_ONE_CHANNEL

public static final boolean DEFAULT_KARAOKE_ONE_CHANNEL

See Also:

Constant Field Values

DEFAULT_CTRL_CHANGE_MODE

public static final byte DEFAULT_CTRL_CHANGE_MODE

See Also:

Constant Field Values

DEFAULT_EXTRA_GLOBALS_STR

public static final java.lang.String DEFAULT_EXTRA_GLOBALS_STR

See Also:

Constant Field Values

format

protected static int format

MUST_ADD_TICK_COMMENTS

protected static boolean MUST_ADD_TICK_COMMENTS

MUST_ADD_CONFIG

protected static boolean MUST_ADD_CONFIG

MUST_ADD_QUALITY_SCORE

protected static boolean MUST_ADD_QUALITY_SCORE

MUST_ADD_STATISTICS

protected static boolean MUST_ADD_STATISTICS

MUST_ADD_STRATEGY_STAT

protected static boolean MUST_ADD_STRATEGY_STAT

LENGTH_STRATEGY

protected static byte LENGTH_STRATEGY

MAX_TARGET_TICKS_ON

protected static long MAX_TARGET_TICKS_ON

MIN_TARGET_TICKS_ON

protected static long MIN_TARGET_TICKS_ON

MIN_SOURCE_TICKS_ON

protected static long MIN_SOURCE_TICKS_ON

MAX_SOURCE_TICKS_ON

protected static long MAX_SOURCE_TICKS_ON

MIN_DURATION_TO_KEEP

protected static float MIN_DURATION_TO_KEEP

MAX_DURATION_TO_KEEP

protected static float MAX_DURATION_TO_KEEP

LENGTH_TICK_TOLERANCE

protected static long LENGTH_TICK_TOLERANCE

DURATION_RATIO_TOLERANCE

protected static float DURATION_RATIO_TOLERANCE

USE_PRE_DEFINED_CHORDS

protected static boolean USE_PRE_DEFINED_CHORDS

CHORD_NOTE_ON_TOLERANCE

protected static long CHORD_NOTE_ON_TOLERANCE

CHORD_NOTE_OFF_TOLERANCE

protected static long CHORD_NOTE_OFF_TOLERANCE

CHORD_VELOCITY_TOLERANCE

protected static long CHORD_VELOCITY_TOLERANCE

USE_DOTTED_NOTES

protected static boolean USE_DOTTED_NOTES

USE_DOTTED_RESTS

protected static boolean USE_DOTTED_RESTS

USE_TRIPLETTED_NOTES

protected static boolean USE_TRIPLETTED_NOTES

USE_TRIPLETTED_RESTS

protected static boolean USE_TRIPLETTED_RESTS

USE_KARAOKE

protected static boolean USE_KARAOKE

ALL_SYLLABLES_ORPHANED

protected static boolean ALL_SYLLABLES_ORPHANED

ORPHANED_SYLLABLES

protected static byte ORPHANED_SYLLABLES

KARAOKE_ONE_CHANNEL

protected static boolean KARAOKE_ONE_CHANNEL

CTRL_CHANGE_MODE

protected static byte CTRL_CHANGE_MODE

EXTRA_GLOBALS

protected static java.util.TreeSet<java.lang.Long> EXTRA_GLOBALS

sourceResolution

protected static int sourceResolution

targetResolution

protected static int targetResolution

exportResult

protected static ExportResult exportResult

isSoftKaraoke

protected static boolean isSoftKaraoke

instrumentsByChannel

protected static java.util.ArrayList<Instrument> instrumentsByChannel

stores the current state of each channel

instrumentsByName

protected static java.util.TreeMap<java.lang.String,Instrument> instrumentsByName

noteLength

protected static java.util.TreeMap<java.lang.Long,java.lang.String> noteLength

restLength

protected static java.util.TreeMap<java.lang.Long,java.lang.String> restLength

chords

protected static java.util.TreeMap<java.lang.String,java.lang.String> chords

comma-separated note bytes – chord name

chordCount

protected static java.util.TreeMap<java.lang.String,java.lang.Integer> chordCount

lowest note – chord count

chordsByBaseNote

protected static java.util.TreeMap<java.lang.String,java.util.ArrayList<java.lang.String>> chordsByBaseNote

lowest note – comma-separated note bytes (This structure is only needed for the sorting: lowest note first, then chord name)

lyricsChannels

protected java.util.ArrayList<java.lang.Byte> lyricsChannels

channels that can be used for lyrics, sorted by priority

instrumentHistory

protected java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Byte[]>> instrumentHistory

commentHistory

protected java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.String>> commentHistory

noteHistory

protected java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.lang.Byte>>> noteHistory

noteOnOff

protected java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>>> noteOnOff

lyricsSyllables

protected java.util.TreeMap<java.lang.Long,java.lang.String> lyricsSyllables

statistics

private java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.lang.Integer>> statistics

Stores statistics to estimate the decompilation quality and to count the used strategies. Parts of this structure:

• channel number (or a higher number for the total statistic)
• type number (value of the STAT_… variable)
• appearance count

slices

protected static java.util.ArrayList<Slice> slices

Stores each slice of the sequence.

A slice begins either with (one or more) global commands or at tick 0.

It ends either one tick before a global command or at the end of the sequence.

index – slice

Constructor Detail

Decompiler

public Decompiler()

Method Detail

init

protected abstract void init()

Initializes format-specific data structures.

createOutput

protected abstract java.lang.String createOutput()

Creates the format-specific string to be written to the exported file.

Returns:

the output file content.

createRest

protected abstract java.lang.String createRest(byte channel,
                                               long ticks,
                                               long beginTick,
                                               java.lang.String syllable)

Creates a rest.

Parameters:

channel - MIDI channel

ticks - tick length of the rest to create

beginTick - used for the tick comment (negative value: don’t include a tick comment)

syllable - a lyrics syllable or (in most cases): null

Returns:

the channel command containing the rest.

initLengths

protected abstract java.util.TreeMap<java.lang.Long,java.lang.String> initLengths(boolean rest)

Calculates which tick length corresponds to which note or rest length. That depends on the resolution of the current MIDI sequence.

Parameters:

rest - true to initialize REST lengths, false for NOTE lengths

Returns:

Mapping between tick length and note length for the syntax.

export

public ExportResult export(java.io.File file)
                    throws ExportException

Decompiles a MIDI sequence and writes the result either into the given file or to the standard output.

Specified by:

export in class Exporter

Parameters:

file - target file to be written.

Returns:

warnings that occured during the export.

Throws:

ExportException - if the file can not be exported correctly.

refreshConfig

private void refreshConfig()

Re-reads all config variables that are relevant for decompilation.

initStatistics

private void initStatistics()

Initializes data structures for statistics. This is used for the following statistics:

• quality statistics (to estimate the decompilation quality)
• strategy statistics (counts which strategy is used how often)

initInstruments

private void initInstruments()

Initializes and resets the instruments structures so that their configurations can be tracked.

prioritizeChannelsForLyrics

private java.util.ArrayList<java.lang.Byte> prioritizeChannelsForLyrics()

Prioritizes the channels for karaoke usage.

Calculates the following values for each channel:

• notes: number of ticks with a note or chord
• matches: number of ticks with a note or chords that can be used for a syllable
• relevance: matches divided by notes
• coverage: matches divided by the total number of syllables
• priority: relevance plus coverage

Sorts the channels by priority and returns them.

Reasons for this approach:

Often we have the following facts:

• One channel is mainly used for the lead vocals.
• Another channel is mainly used for background vocals, e.g. only for the refrain, together with the lead vocals channel.
• Another channel (e.g. the percussion channel) has also a lot of matches because it contains a lot of notes.

In this case the lead vocal channel is the best choice.

But the background vocals could have a better relevance, and the percussion channel could have the best coverage.

However the lead vocal channel has probably the highest sum (relevance + coverage). That’s why we choose this approach.

Returns:

channels usable for lyrics, sorted by priority.

postprocessLengths

private void postprocessLengths(java.util.TreeMap<java.lang.Long,java.lang.String> lengths)

Removes lengths that are too small to make sense according to the source resolution.

The following lengths are removed:

• lengths with zero ticks
• lengths with less than half ticks of the next longer length

The last step is necessary to avoid length sums like /4+256+256. Can happen due to rounding errors of very small lengths.

Parameters:

lengths - note or rest lengths

splitSequence

private void splitSequence()

Splits the sequence into slices between global commands. Adds the global commands to the according slices.

The following messages are regarded as global commands:

• tempo changes
• key signature
• time signature

Creates warnings for ignored short messages.

addInstrumentsToSlices

private void addInstrumentsToSlices()

Adds all ticks to the timeline with at least one instrument change.

groupNotes

private void groupNotes()

Groups notes with note-on/note-off/velocity differences that are smaller than the according tolerances.

adjustOffTick

private void adjustOffTick(java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>> channelOnOff,
                           byte channel,
                           byte note,
                           long offTick,
                           long crdOffTick)

Adjusts the Note-OFF tick of a note so that it can join a chord.

Checks if there is another ON/OFF between source and target OFF tick.

In this case: Doesn’t adjust the OFF tick and creates a warning instead.

Parameters:

channelOnOff - noteOnOff structure for the channel in question (note, offTick, onOff)

channel - MIDI channel

note - note number

offTick - current Note-OFF tick

crdOffTick - target Note-OFF tick (Note-OFF tick of the chord)

addNotesToSlices

private void addNotesToSlices()

Fills the timeline structures of the slices with note-on events regarding chords and single notes.

organizeChords

private void organizeChords(java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>> notes,
                            boolean isPercussion)

Receives the notes that are pressed at one tick and channel. Puts them together as chords, if possible.

In case of percussion instruments, inline chords are used. Otherwise predefined chords are used.

Parameters:

notes - Notes, pressed at a certain tick in a certain channel.

isPercussion - true for channel 9, otherwise false.

makeChordName

private java.lang.String makeChordName(java.util.TreeSet<java.lang.Byte> notes,
                                       java.lang.String csvNotes)

Creates a new unique name for the chord consisting of the given notes.

Parameters:

notes - The notes of the chord.

csvNotes - Comma-separated note bytes.

Returns:

the new chord name.

addLyricsToSlices

private void addLyricsToSlices()

Adds syllables to the slices’ timelines.

If there are any notes or chords played in the same tick as the syllable, the syllable is added to one of them (according to the channel’s priority).

If there are no notes or chords played in the syllable’s tick, the syllable is added to a special timeline as an option to a rest inside a nestable block.

calculateTicks

protected int calculateTicks(int factor,
                             int divisor)

Calculates the tick length of a note, based on the current MIDI sequence’s resolution and in relation to a quarter note. The given factor and divisor influences the resulting note length. If factor and divisor are the same, the resulting length is exactly one quarter note.

Parameters:

factor - the factor to multiply the quarter note with

divisor - the divisor to divide the quarter note with

Returns:

mathematically rounded result of resolution * factor / divisor

getLengthsForSum

protected java.util.ArrayList<java.lang.Long> getLengthsForSum(long ticks,
                                                               boolean isRest)

Splits a note or rest length into several lengths that can be used for a length sum.

Parameters:

ticks - total tick length of the note or rest length

isRest - true for a rest, false for a note.

Returns:

the single lengths in ticks.

getNoteLengthProperties

protected long[] getNoteLengthProperties(long onTick,
                                         long offTick,
                                         byte channel)

Calculates the note length string and duration percentage of a note (or chord).

• the note length string is the 3rd column of a MidicaPL channel command or the number following the note in ALDA.
• the duration percentage is the duration option of a MidicaPL channel command or the quantization attribute in ALDA

For the calculation, one of the following strategies is used:

• The length between note-ON and note-ON of the next note, if this is reasonable.
• The length according to the channel’s current duration ratio.
• The lowest possible of the predefined values, that is higher than the note press length.

The priority of the actually chosen strategy to be used is controlled by the configuration.

Parameters:

onTick - Note-ON tick of the note.

offTick - Note-OFF tick of the note.

Returns:

the following values:

• note length in ticks (according to the source resolution)
• duration in percent (rounded mathematically)

getNoteLengthByPressTicks

private long getNoteLengthByPressTicks(long ticks)

Guesses the theoretical note length just by choosing the next possible pre-defined length.

Parameters:

ticks - tick difference between note-ON and note-OFF.

Returns:

the guessed note length.

calculateDuration

private static float calculateDuration(long noteTicks,
                                       long pressTicks)

Calculates the duration ratio.

Parameters:

noteTicks - full (theoretical) note length in ticks

pressTicks - number of ticks that the note is pressed (from note-ON to note-OFF)

Returns:

the duration ratio

createRestBeforeSlice

protected java.lang.String createRestBeforeSlice(Slice slice)

Creates a rest before a new slice begins, if necessary.

The rest is only necessary if no channel has reached the slice’s begin tick yet.

With the slice’s beginning, all channels are synchronized. Therefore the rest is only necessary in one channel.

Steps:

• calculation of the furthest tick
• choosing the according channel
• adding the rest in this channel

Parameters:

slice - the sequence slice

Returns:

the created rest, or an empty string if no rest is created.

getFurthestInstrument

protected Instrument getFurthestInstrument()

Calculates and returns the most advanced instrument. (Advanced in terms of “current ticks”).

Returns null, if no instrument is used at all.

Returns:

the most advanced instrument, or null

incrementStats

protected void incrementStats(java.lang.Byte type,
                              java.lang.Byte channel)

Increments the statistics for the channel and total.

Parameters:

type - statistics type

channel - MIDI channel

addWarningRestSkipped

protected void addWarningRestSkipped(java.lang.Long tick,
                                     java.lang.Long ticks,
                                     java.lang.Byte channel)

Creates a warning caused by a skipped rest.

Parameters:

tick - the tick where the rest should have occurred.

ticks - length of the skipped rest in ticks

channel - MIDI channel

createQualityStats

protected java.lang.String createQualityStats()

Creates the quality statistics to be printed at the end of the produced file.

Returns:

quality statistics block

createQualityStatsPart

private java.lang.String createQualityStatsPart(java.util.TreeMap<java.lang.Byte,java.lang.Integer> subStat)

Creates the quality statistics for one part (either a channel or total).

Parameters:

subStat - statistic structure for the part (channel or total)

Returns:

the created statistics.

addQualityDetailsLine

private void addQualityDetailsLine(java.lang.StringBuilder stats,
                                   java.lang.String name,
                                   java.lang.String count,
                                   double percentage,
                                   java.lang.Double subScore)

Adds a line to the quality statistics, if configured.

Parameters:

stats - the statistic line

name - which kind of sub score (e.g. Summands, Triplets, …)

count - number of occurrences

percentage - percentage of occurrences

subScore - sub score to be added (or null, if no sub score is used)

createStrategyStats

protected java.lang.String createStrategyStats()

Creates the strategy statistics to be printed at the end of the produced file.

Returns:

strategy statistics block

createStrategyStatsPart

private java.lang.String createStrategyStatsPart(java.util.TreeMap<java.lang.Byte,java.lang.Integer> subStat)

Creates the strategy statistics for one part (either a channel or total).

Parameters:

subStat - statistic structure for the part (channel or total)

Returns:

the created statistics.

createConfig

protected java.lang.String createConfig()

Creates the block with configuration variables that has been used for decompilation.

Returns:

configuration block

createTickDescription

protected java.lang.String createTickDescription(long tick,
                                                 boolean withCommentSymbol)

Creates a tick description that can be used in tick comments. The description contains the given tick in source and target resolution.

Parameters:

tick - MIDI tickstamp (in source resolution).

withCommentSymbol - prefixes a comment symbol, if true

Returns:

the comment string.

getCommentSymbol

protected java.lang.String getCommentSymbol()

Returns the comment symbol of the current format.

Returns:

comment symbol.