Decompiler (Midica 1.5.6

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 java.lang.String`	`BLOCK_INDENT`
`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`
`private static int`	`compactLineMinLength`
`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 int`	`DEFAULT_ELEMENTS_PER_LINE`
`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 int`	`DEFAULT_MAX_BARLINE_TOL`
`static float`	`DEFAULT_MAX_DURATION_TO_KEEP`
`static long`	`DEFAULT_MAX_TICKS_ON_AT_480`
`static float`	`DEFAULT_MIN_DURATION_TO_KEEP`
`static long`	`DEFAULT_MIN_TICKS_ON_AT_480`
`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 byte`	`DEFAULT_SYNTAX_TYPE`
`static boolean`	`DEFAULT_USE_BARLINES`
`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 int`	`ELEMENTS_PER_LINE`
`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 boolean`	`isSoftKaraoke`
`protected static boolean`	`KARAOKE_ONE_CHANNEL`
`protected static byte`	`LENGTH_STRATEGY`
`protected static long`	`LENGTH_TICK_TOLERANCE`
`protected static byte`	`LM_DOT`
`protected static byte`	`LM_NONE`
`protected static byte`	`LM_TRIPLET`
`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 int`	`MAX_BARLINE_TOL`
`protected static float`	`MAX_DURATION_TO_KEEP`
`protected static long`	`MAX_SOURCE_TICKS_ON`
`protected static long`	`MAX_TICKS_ON_AT_480`
`protected static java.util.TreeMap<java.lang.Long,java.lang.Long>`	`measureLengthHistory` tick – measure length
`protected static byte`	`MIDICA`
`protected static float`	`MIN_DURATION_TO_KEEP`
`protected static long`	`MIN_SOURCE_TICKS_ON`
`protected static long`	`MIN_TICKS_ON_AT_480`
`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.lang.StringBuilder`	`output`
`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 java.util.ArrayList<Instrument>`	`srcInstrByChannel` stores the current state of each channel
`protected static java.util.TreeMap<java.lang.String,Instrument>`	`srcInstrByName`
`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`
`static byte`	`SYNTAX_COMPACT`
`static byte`	`SYNTAX_LOWLEVEL`
`protected static byte`	`SYNTAX_TYPE`
`protected static int`	`targetResolution`
`protected static java.util.ArrayList<Instrument>`	`tgtInstrByChannel`
`protected static java.util.TreeMap<java.lang.String,Instrument>`	`tgtInstrByName`
`protected static boolean`	`USE_BARLINES`
`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()

Constructors
Constructor and Description
`Decompiler()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
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 long`	`calculateTicks(int factor, int divisor, int modifier, boolean forTarget)` Calculates the tick length of a note, based on the current MIDI sequence’s source or target 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 void`	`createRest(byte channel, long ticks, java.lang.String syllable)` Creates a rest.
`protected void`	`createRestBeforeSlice(Slice slice)` Creates a rest before a new slice begins, if necessary.
`protected void`	`createSpacesBeforeComment()` Creates as many spaces as needed so that a comment can be created.
`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 void`	`createTickDescription(long srcTick, long tgtTick, boolean withCommentSymbol)` Creates a tick description that can be used in tick comments.
`protected void`	`createTickLineComment(long srcBeginTick, long srcEndTick, long tgtBeginTick, long tgtEndTick)` Creates a tick comment for a line that can have several notes/chords/rests.
`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.
`protected void`	`resetTickCommentLineLength()` Resets the minimum length of a line (only used for line tick comments).
`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
  - LM_NONE
```
protected static final byte LM_NONE
```
    See Also:
    
    Constant Field Values
  - LM_TRIPLET
```
protected static final byte LM_TRIPLET
```
    See Also:
    
    Constant Field Values
  - LM_DOT
```
protected static final byte LM_DOT
```
    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
```
  - BLOCK_INDENT
```
protected static final java.lang.String BLOCK_INDENT
```
    See Also:
    
    Constant Field Values
  - 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
  - SYNTAX_LOWLEVEL
```
public static final byte SYNTAX_LOWLEVEL
```
    See Also:
    
    Constant Field Values
  - SYNTAX_COMPACT
```
public static final byte SYNTAX_COMPACT
```
    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_TICKS_ON_AT_480
```
public static final long DEFAULT_MIN_TICKS_ON_AT_480
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_TICKS_ON_AT_480
```
public static final long DEFAULT_MAX_TICKS_ON_AT_480
```
    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_SYNTAX_TYPE
```
public static final byte DEFAULT_SYNTAX_TYPE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ELEMENTS_PER_LINE
```
public static final int DEFAULT_ELEMENTS_PER_LINE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_USE_BARLINES
```
public static final boolean DEFAULT_USE_BARLINES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_BARLINE_TOL
```
public static final int DEFAULT_MAX_BARLINE_TOL
```
    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_TICKS_ON_AT_480
```
protected static long MAX_TICKS_ON_AT_480
```
  - MIN_TICKS_ON_AT_480
```
protected static long MIN_TICKS_ON_AT_480
```
  - 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
```
  - SYNTAX_TYPE
```
protected static byte SYNTAX_TYPE
```
  - ELEMENTS_PER_LINE
```
protected static int ELEMENTS_PER_LINE
```
  - USE_BARLINES
```
protected static boolean USE_BARLINES
```
  - MAX_BARLINE_TOL
```
protected static int MAX_BARLINE_TOL
```
  - 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
```
  - srcInstrByChannel
```
protected static java.util.ArrayList<Instrument> srcInstrByChannel
```
    stores the current state of each channel
  - tgtInstrByChannel
```
protected static java.util.ArrayList<Instrument> tgtInstrByChannel
```
  - srcInstrByName
```
protected static java.util.TreeMap<java.lang.String,Instrument> srcInstrByName
```
  - tgtInstrByName
```
protected static java.util.TreeMap<java.lang.String,Instrument> tgtInstrByName
```
  - 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)
  - measureLengthHistory
```
protected static java.util.TreeMap<java.lang.Long,java.lang.Long> measureLengthHistory
```
    tick – measure length
  - compactLineMinLength
```
private static int compactLineMinLength
```
  - output
```
protected static java.lang.StringBuilder output
```
  - 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 void createRest(byte channel,
                                   long ticks,
                                   java.lang.String syllable)
```
    Creates a rest.
    
    Parameters:
    
    channel - MIDI channel
    
    ticks - tick length of the rest to create
    
    syllable - a lyrics syllable or (in most cases): null
  - 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.
    
    The created rest lengths should contain a few more very short lengths. This is needed because rests should be less tolerant than notes.
    
    This enables us to use more common lengths for notes but let the exported sequence be still as close as possible to the original one.
    
    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.
  - resetTickCommentLineLength
```
protected void resetTickCommentLineLength()
```
    Resets the minimum length of a line (only used for line tick comments). Should be called before a new channel starts.
  - calculateTicks
```
protected long calculateTicks(int factor,
                              int divisor,
                              int modifier,
                              boolean forTarget)
```
    Calculates the tick length of a note, based on the current MIDI sequence’s source or target 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
    
    modifier - LM_TRIPLET for a tripletted note, LM_DOT for a dotted note
    
    forTarget - true to use target resolution, false for source resolution
    
    Returns:
    
    mathematically rounded result of: resolution * factor / divisor (modified by the modifier)
  - 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 void 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
  - 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 void createTickDescription(long srcTick,
                                     long tgtTick,
                                     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:
    
    srcTick - MIDI tickstamp in source resolution
    
    tgtTick - MIDI tickstamp in target resolution
    
    withCommentSymbol - prefixes a comment symbol, if true
  - createTickLineComment
```
protected void createTickLineComment(long srcBeginTick,
                                     long srcEndTick,
                                     long tgtBeginTick,
                                     long tgtEndTick)
```
    Creates a tick comment for a line that can have several notes/chords/rests. (E.g. compact syntax or alda)
    
    Parameters:
    
    srcBeginTick - MIDI tickstamp of the begin tick (in source resolution).
    
    srcEndTick - MIDI tickstamp of the end tick (in source resolution).
    
    tgtBeginTick - MIDI tickstamp of the begin tick (in target resolution).
    
    tgtEndTick - MIDI tickstamp of the end tick (in target resolution).
  - createSpacesBeforeComment
```
protected void createSpacesBeforeComment()
```
    Creates as many spaces as needed so that a comment can be created.
  - getCommentSymbol
```
protected java.lang.String getCommentSymbol()
```
    Returns the comment symbol of the current format.
    
    Returns:
    
    comment symbol.

Class Decompiler

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

MIDICA

ALDA

ET_INSTR

ET_NOTES

ET_INLINE_BLK

LM_NONE

LM_TRIPLET

LM_DOT

NP_VELOCITY

NP_OFF_TICK

NP_END_TICK

NP_LENGTH

NP_DURATION

NP_MULTIPLE

NP_LYRICS

NP_NOTE_NUM

STAT_TOTAL

STAT_RESTS

STAT_REST_SKIPPED

STAT_REST_TRIPLETS

STAT_REST_SUMMANDS

STAT_NOTES

STAT_NOTE_VELOCITIES

STAT_NOTE_DURATIONS

STAT_NOTE_TRIPLETS

STAT_NOTE_SUMMANDS

STAT_NOTE_MULTIPLE

STAT_STRATEGY_NEXT_ON

STAT_STRATEGY_DURATION

STAT_STRATEGY_PRESS

NEW_LINE

BLOCK_INDENT

INLINE_BLOCK

SLICE_BEGIN_BLOCK

STRATEGY_NEXT_DURATION_PRESS

STRATEGY_DURATION_NEXT_PRESS

STRATEGY_NEXT_PRESS

STRATEGY_DURATION_PRESS

STRATEGY_PRESS

SYNTAX_LOWLEVEL

SYNTAX_COMPACT

DEFAULT_MUST_ADD_TICK_COMMENTS

DEFAULT_MUST_ADD_CONFIG

DEFAULT_MUST_ADD_QUALITY_SCORE

DEFAULT_MUST_ADD_STATISTICS

DEFAULT_MUST_ADD_STRATEGY_STAT

DEFAULT_LENGTH_STRATEGY

DEFAULT_MIN_TICKS_ON_AT_480

DEFAULT_MAX_TICKS_ON_AT_480

DEFAULT_MIN_DURATION_TO_KEEP

DEFAULT_MAX_DURATION_TO_KEEP

DEFAULT_LENGTH_TICK_TOLERANCE

DEFAULT_DURATION_RATIO_TOLERANCE

DEFAULT_USE_PRE_DEFINED_CHORDS

DEFAULT_CHORD_NOTE_ON_TOLERANCE

DEFAULT_CHORD_NOTE_OFF_TOLERANCE

DEFAULT_CHORD_VELOCITY_TOLERANCE

DEFAULT_USE_DOTTED_NOTES

DEFAULT_USE_DOTTED_RESTS

DEFAULT_USE_TRIPLETTED_NOTES

DEFAULT_USE_TRIPLETTED_RESTS

DEFAULT_USE_KARAOKE

DEFAULT_ALL_SYLLABLES_ORPHANED

DEFAULT_ORPHANED_SYLLABLES

DEFAULT_KARAOKE_ONE_CHANNEL

DEFAULT_CTRL_CHANGE_MODE

DEFAULT_SYNTAX_TYPE

DEFAULT_ELEMENTS_PER_LINE

DEFAULT_USE_BARLINES

DEFAULT_MAX_BARLINE_TOL

DEFAULT_EXTRA_GLOBALS_STR

format

MUST_ADD_TICK_COMMENTS