org.midica.file.write

Class AldaExporter

java.lang.Object

org.midica.file.write.Exporter

org.midica.file.write.Decompiler

org.midica.file.write.AldaExporter

public class AldaExporter
extends Decompiler

This class is used to export the currently loaded MIDI sequence as an ALDA source file.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private Instrument	currentInstrument
private java.lang.String	currentKeySig
private int	currentSliceNumber
static java.util.ArrayList<java.lang.String>	instrumentNames
static java.util.ArrayList<java.lang.String>	noteNames
static java.util.ArrayList<java.lang.Byte>	noteOctaves
private static java.util.regex.Pattern	tripletPattern
private java.util.TreeSet<Instrument>	usedInSlice

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
AldaExporter() Creates a new MidicaPL exporter.

Method Summary

Modifier and Type	Method and Description
private java.lang.String	createChordNotes(Slice slice, byte channel, long tick, java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>> events) Creates a chord - all notes beginning in the same tick in the same channel.
private java.lang.String	createCommandsFromTimeline(Slice slice, byte channel) Creates notes and instrument changes from a slice’s timeline.
private java.lang.String	createGlobalAttributes(Slice slice) Creates a string with global attributes for the given slice.
private java.lang.String	createInstrumentChange(byte channel, long tick) Creates one instrument line for an instrument change in the given channel and tick.
protected java.lang.String	createMarker() Creates a marker in the current instrument to mark the end of a slice.
private java.lang.String	createNote(byte channel, java.util.TreeMap<java.lang.Byte,java.lang.String> properties) Prints a single note.
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	getKeySignature() Calculates and returns the value for the key signature attribute.
private java.lang.String	getTriplet(long base) Calculates and returns a (rounded) triplet note length.
void	init() Initializes MidicaPL specific data structures.
private void	initInstrumentNames() Initializes all possible MIDI instrument numbers with an ALDA instrument name.
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	initNoteNames() Initializes all possible MIDI note numbers with an ALDA instrument and octave name.

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

instrumentNames

public static java.util.ArrayList<java.lang.String> instrumentNames

noteNames

public static java.util.ArrayList<java.lang.String> noteNames

noteOctaves

public static java.util.ArrayList<java.lang.Byte> noteOctaves

currentSliceNumber

private int currentSliceNumber

currentInstrument

private Instrument currentInstrument

usedInSlice

private java.util.TreeSet<Instrument> usedInSlice

currentKeySig

private java.lang.String currentKeySig

tripletPattern

private static java.util.regex.Pattern tripletPattern

Constructor Detail

AldaExporter

public AldaExporter()

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 notes and instrument changes from a slice’s timeline.

Steps:

• Adds the following missing properties and elements to the notes of the timeline:
  • properties:
    • length property for each note/chord
    • multiple property, if neccessary
  • elements:
    • rests, if necessary
  • instrument changes:
    • if a program change is found
    • if a note is played for the first time in a channel
• 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)

createInstrumentChange

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

Creates one instrument line for an instrument change in the given channel and tick. If there is no instrument change event found in the MIDI sequence, the default instrument (piano) is used.

Parameters:

channel - MIDI channel

tick - MIDI tick

Returns:

the created lines.

createGlobalAttributes

private java.lang.String createGlobalAttributes(Slice slice)

Creates a string with global attributes for the given slice.

Global attributes are:

• tempo changes
• key signature

Parameters:

slice - the sequence slice

Returns:

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

createChordNotes

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

Creates a chord - all notes beginning in the same tick in the same channel.

Steps:

If necessary, creates an instrument change

If necessary, jumps to the marker at the begin of the current slice

If necessary, adds a REST to reach the current tick.

Checks the note-END tick of the shortest note

Adds a (smaller) rest to the chord, if the lowest END tick is further than the next ON tick or the slice’s end

Prints all notes and (if necessary) the rest

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.

createNote

private java.lang.String createNote(byte channel,
                                    java.util.TreeMap<java.lang.Byte,java.lang.String> properties)

Prints a single note.

The note may be a part of a chord or a single note.

Parts of the note are:

• attributes, if needed (quant, vol)
• octave switch, if needed
• name
• length, if needed

Parameters:

channel - MIDI channel

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

Returns:

the created note.

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.

createMarker

protected java.lang.String createMarker()

Creates a marker in the current instrument to mark the end of a slice.

Returns:

the created marker

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.

getTriplet

private java.lang.String getTriplet(long base)

Calculates and returns a (rounded) triplet note length.

Parameters:

base - the base note length to be tripleted

Returns:

the triplet symbol

initInstrumentNames

private void initInstrumentNames()

Initializes all possible MIDI instrument numbers with an ALDA instrument name.

initNoteNames

private void initNoteNames()

Initializes all possible MIDI note numbers with an ALDA instrument and octave name. Takes the current key signature into account.

getKeySignature

private java.lang.String getKeySignature()

Calculates and returns the value for the key signature attribute.

Returns:

the key signature