org.midica.file.write

Class MidicaPLExporter

java.lang.Object

org.midica.file.write.Exporter

org.midica.file.write.Decompiler

org.midica.file.write.MidicaPLExporter

public class MidicaPLExporter
extends Decompiler

This class is used to export the currently loaded MIDI sequence as a MidicaPL source file.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	FORMAT_CH_CMD_CHANNEL
private java.lang.String	FORMAT_CH_CMD_CRD
private java.lang.String	FORMAT_CH_CMD_LENGTH

Fields inherited from class org.midica.file.write.Decompiler

ALDA, ALL_SYLLABLES_ORPHANED, CHORD_NOTE_OFF_TOLERANCE, CHORD_NOTE_ON_TOLERANCE, CHORD_VELOCITY_TOLERANCE, chordCount, chords, chordsByBaseNote, commentHistory, CTRL_CHANGE_MODE, DEFAULT_ALL_SYLLABLES_ORPHANED, DEFAULT_CHORD_NOTE_OFF_TOLERANCE, DEFAULT_CHORD_NOTE_ON_TOLERANCE, DEFAULT_CHORD_VELOCITY_TOLERANCE, DEFAULT_CTRL_CHANGE_MODE, DEFAULT_DURATION_RATIO_TOLERANCE, DEFAULT_EXTRA_GLOBALS_STR, DEFAULT_KARAOKE_ONE_CHANNEL, DEFAULT_LENGTH_STRATEGY, DEFAULT_LENGTH_TICK_TOLERANCE, DEFAULT_MAX_DURATION_TO_KEEP, DEFAULT_MAX_TARGET_TICKS_ON, DEFAULT_MIN_DURATION_TO_KEEP, DEFAULT_MIN_TARGET_TICKS_ON, DEFAULT_MUST_ADD_CONFIG, DEFAULT_MUST_ADD_QUALITY_SCORE, DEFAULT_MUST_ADD_STATISTICS, DEFAULT_MUST_ADD_STRATEGY_STAT, DEFAULT_MUST_ADD_TICK_COMMENTS, DEFAULT_ORPHANED_SYLLABLES, DEFAULT_USE_DOTTED_NOTES, DEFAULT_USE_DOTTED_RESTS, DEFAULT_USE_KARAOKE, DEFAULT_USE_PRE_DEFINED_CHORDS, DEFAULT_USE_TRIPLETTED_NOTES, DEFAULT_USE_TRIPLETTED_RESTS, DURATION_RATIO_TOLERANCE, ET_INLINE_BLK, ET_INSTR, ET_NOTES, exportResult, EXTRA_GLOBALS, format, INLINE_BLOCK, instrumentHistory, instrumentsByChannel, instrumentsByName, isSoftKaraoke, KARAOKE_ONE_CHANNEL, LENGTH_STRATEGY, LENGTH_TICK_TOLERANCE, lyricsChannels, lyricsSyllables, MAX_DURATION_TO_KEEP, MAX_SOURCE_TICKS_ON, MAX_TARGET_TICKS_ON, MIDICA, MIN_DURATION_TO_KEEP, MIN_SOURCE_TICKS_ON, MIN_TARGET_TICKS_ON, MUST_ADD_CONFIG, MUST_ADD_QUALITY_SCORE, MUST_ADD_STATISTICS, MUST_ADD_STRATEGY_STAT, MUST_ADD_TICK_COMMENTS, NEW_LINE, noteHistory, noteLength, noteOnOff, NP_DURATION, NP_END_TICK, NP_LENGTH, NP_LYRICS, NP_MULTIPLE, NP_NOTE_NUM, NP_OFF_TICK, NP_VELOCITY, ORPHANED_SYLLABLES, restLength, SLICE_BEGIN_BLOCK, slices, sourceResolution, STAT_NOTE_DURATIONS, STAT_NOTE_MULTIPLE, STAT_NOTE_SUMMANDS, STAT_NOTE_TRIPLETS, STAT_NOTE_VELOCITIES, STAT_NOTES, STAT_REST_SKIPPED, STAT_REST_SUMMANDS, STAT_REST_TRIPLETS, STAT_RESTS, STAT_TOTAL, STRATEGY_DURATION_NEXT_PRESS, STRATEGY_DURATION_PRESS, STRATEGY_NEXT_DURATION_PRESS, STRATEGY_NEXT_PRESS, STRATEGY_PRESS, targetResolution, USE_DOTTED_NOTES, USE_DOTTED_RESTS, USE_KARAOKE, USE_PRE_DEFINED_CHORDS, USE_TRIPLETTED_NOTES, USE_TRIPLETTED_RESTS

Constructor Summary

Constructors

Constructor and Description
MidicaPLExporter() Creates a new MidicaPL exporter.

Method Summary

Modifier and Type	Method and Description
private java.lang.String	appendTickComment(java.lang.String line, long tick) Appends a tick comment to the given line, if tick comments are configured.
private java.lang.String	createChordDefinitions() Creates the CHORD definitions.
private java.lang.String	createCommandsFromTimeline(Slice slice, byte channel) Creates channel commands and instrument changes from a slice’s timeline.
private java.lang.String	createGlobalCommands(Slice slice) Creates a string with global commands for the given slice.
private java.lang.String	createInitialInstrumentsBlock() Creates the initial INSTRUMENTS block.
private java.lang.String	createInlineBlock(byte channel, long tick, Slice slice) Creates an inline block with a multiple option.
private java.lang.String	createInstrLine(long tick, byte channel) Creates one line inside an INSTRUMENTS block or one single instrument change line.
private java.lang.String	createInstrumentChange(byte channel, long tick) Creates one INSTRUMENT line for an instrument change in the given channel and tick.
private java.lang.String	createMetaBlock() Creates the META block, if the sequence contains any META information.
private java.lang.String	createNoteLines(Slice slice, byte channel, long tick, java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>> events) Creates lines for all notes or chords that are played in a certain channel and begin at a certain tick.
java.lang.String	createOutput() Creates the MidicaPL string to be written into the export file.
protected java.lang.String	createRest(byte channel, long ticks, long beginTick, java.lang.String syllable) Creates a channel command with a rest.
private java.lang.String	createSingleNoteLine(byte channel, java.lang.String noteName, java.util.TreeMap<java.lang.Byte,java.lang.String> noteOrCrd, long tick) Prints a single channel command for a note or chord.
private java.lang.String	createSliceBeginBlock(Slice slice, byte channel) Creates a nestable block with the ‘multiple’ option at the beginning of a slice.
private java.lang.String	createSoftKaraokeBlock(java.util.HashMap<java.lang.String,java.lang.Object> karaokeInfo) Creates the SOFT_KARAOKE block inside of the META block.
private java.lang.String	escapeSyllable(java.lang.String syllable) Escapes special characters in syllables.
void	init() Initializes MidicaPL specific data structures.
java.util.TreeMap<java.lang.Long,java.lang.String>	initLengths(boolean rest) Calculates which tick length corresponds to which note or rest length.

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

addWarningRestSkipped, calculateTicks, createConfig, createQualityStats, createRestBeforeSlice, createStrategyStats, createTickDescription, export, getCommentSymbol, getFurthestInstrument, getLengthsForSum, getNoteLengthProperties, incrementStats

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

FORMAT_CH_CMD_CHANNEL

private java.lang.String FORMAT_CH_CMD_CHANNEL

FORMAT_CH_CMD_CRD

private java.lang.String FORMAT_CH_CMD_CRD

FORMAT_CH_CMD_LENGTH

private java.lang.String FORMAT_CH_CMD_LENGTH

Constructor Detail

MidicaPLExporter

public MidicaPLExporter()

Creates a new MidicaPL exporter.

Method Detail

init

public void init()

Initializes MidicaPL specific data structures.

Specified by:

init in class Decompiler

createOutput

public java.lang.String createOutput()

Creates the MidicaPL string to be written into the export file.

Specified by:

createOutput in class Decompiler

Returns:

MidicaPL string to be written into the export file

createCommandsFromTimeline

private java.lang.String createCommandsFromTimeline(Slice slice,
                                                    byte channel)

Creates channel commands and instrument changes from a slice’s timeline.

Steps:

• Adds the following missing properties and elements to the notes and chords of the timeline:
  • properties:
    • length property for each note/chord
    • multiple property, if neccessary
  • elements:
    • rests, if necessary
• Creates the commands

Parameters:

slice - the sequence slice

channel - MIDI channel

Returns:

the created commands (or an empty string, if the slice’s timeline doesn’t contain anything in the given channel)

createMetaBlock

private java.lang.String createMetaBlock()

Creates the META block, if the sequence contains any META information.

Returns:

the META block, or an empty string if the sequence doesn’t contain any meta information.

createSoftKaraokeBlock

private java.lang.String createSoftKaraokeBlock(java.util.HashMap<java.lang.String,java.lang.Object> karaokeInfo)

Creates the SOFT_KARAOKE block inside of the META block. This is called only if the sequence uses SOFT KARAOKE.

Parameters:

karaokeInfo - Karaoke information extracted from the sequence.

Returns:

the created block.

createInitialInstrumentsBlock

private java.lang.String createInitialInstrumentsBlock()

Creates the initial INSTRUMENTS block.

Returns:

the created block.

createInstrumentChange

private java.lang.String createInstrumentChange(byte channel,
                                                long tick)

Creates one INSTRUMENT line for an instrument change in the given channel and tick.

Parameters:

channel - MIDI channel

tick - MIDI tick

Returns:

the created lines.

createInstrLine

private java.lang.String createInstrLine(long tick,
                                         byte channel)

Creates one line inside an INSTRUMENTS block or one single instrument change line.

If tick is 0, a line inside a block is created. Otherwise it’s an instrument change line.

Returns an empty string, if no instruments must be defined or changed in the given channel and tick.

At the beginning this method is called for each channel (0-15). This considers:

• bank selects at tick 0
• program changes at tick 0
• channels without a program change that are used anyway

Afterwards this method is called for every tick and channel that contains one or more program changes at a tick higher than 0.

Parameters:

tick - The tickstamp of the program change event; or 0 during initialization.

channel - The channel number.

Returns:

the instrument line or an empty string.

createChordDefinitions

private java.lang.String createChordDefinitions()

Creates the CHORD definitions.

Returns:

the CHORD commands.

createGlobalCommands

private java.lang.String createGlobalCommands(Slice slice)

Creates a string with global commands for the given slice.

Parameters:

slice - the sequence slice

Returns:

the created string (or an empty string, if the slice doesn’t contain any global commands)

createSliceBeginBlock

private java.lang.String createSliceBeginBlock(Slice slice,
                                               byte channel)

Creates a nestable block with the ‘multiple’ option at the beginning of a slice.

This block doesn’t contain any notes. It may contain only:

• rests
• rests with (orphaned) syllables
• (in the future) control changes

Parameters:

slice - the sequence slice

channel - MIDI channel

Returns:

the created block.

createInlineBlock

private java.lang.String createInlineBlock(byte channel,
                                           long tick,
                                           Slice slice)

Creates an inline block with a multiple option.

Adds a rest before the block, if necessary.

Parameters:

channel - MIDI channel

tick - MIDI tick

slice - the sequence slice

Returns:

the created block.

createNoteLines

private java.lang.String createNoteLines(Slice slice,
                                         byte channel,
                                         long tick,
                                         java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>> events)

Creates lines for all notes or chords that are played in a certain channel and begin at a certain tick.

Steps:

If necessary, adds a REST so that the current tick is reached.

Chooses the LAST note/chord command to be printed.

Prints all lines apart from the last one, and adds the MULTIPLE option.

Prints the last line, and adds the MULTIPLE option only if necessary.

Increments current channel ticks (if the last element has no MULTIPLE option).

Strategy to choose the LAST note/chord command:

Choose a note/chord ending in the same tick when the next note/chord starts, if available and in the same slice.

- no MULTIPLE option needed for the last note/chord
- no rests are necessary

Choose a note/chord ending at the end of the slice, if possible, and not later than the next ON-tick

- no MULTIPLE option needed for the last note/chord
- rests must be added LATER but not now

Choose the longest note/chord ending BEFORE the NEXT note/chord starts, if available.

- no MULTIPLE option needed for the last note/chord
- rest(s) must be added

Choose any other note/chord.

- all chords/notes need the MULTIPLE option, even the last one.
- rest(s) must be added

Parameters:

slice - the sequence slice

channel - MIDI channel

tick - MIDI tick

events - All notes/chords with the same note-ON tick in the same channel (comes from the slice’s timeline)

Returns:

the created note lines.

createSingleNoteLine

private java.lang.String createSingleNoteLine(byte channel,
                                              java.lang.String noteName,
                                              java.util.TreeMap<java.lang.Byte,java.lang.String> noteOrCrd,
                                              long tick)

Prints a single channel command for a note or chord.

Parameters:

channel - MIDI channel

noteName - note or chord name

noteOrCrd - note properties (from the slice’s timeline)

tick - MIDI tickstamp.

Returns:

the created line.

createRest

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

Creates a channel command with a rest.

Specified by:

createRest in class Decompiler

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.

escapeSyllable

private java.lang.String escapeSyllable(java.lang.String syllable)

Escapes special characters in syllables.

Parameters:

syllable - The syllable to be escaped.

Returns:

the replaced syllable.

initLengths

public 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 will contain a view 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.

Specified by:

initLengths in class Decompiler

Parameters:

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

Returns:

Mapping between tick length and note length for the syntax.

appendTickComment

private java.lang.String appendTickComment(java.lang.String line,
                                           long tick)

Appends a tick comment to the given line, if tick comments are configured. Otherwise the given line is returned unchanged.

Parameters:

line - the line to be completed by a comment

tick - MIDI tick

Returns:

the changed or unchanged line