org.midica.file.write

Class Slice

java.lang.Object

org.midica.file.write.Slice

public class Slice
extends java.lang.Object

This class is used by the MidicaPlExporter to store a sequence slice.

A slice is a part of a sequence, beginning either in tick 0 or with a global command.

It ends either with the next global command or at the end of the sequence.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private long	beginTick
private long	endTick
private java.util.TreeMap<java.lang.String,java.lang.String>	globalCommands
private java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.lang.Byte>>>	noteHistory
private java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>>>	noteOnOff
private java.util.TreeMap<java.lang.Long,java.lang.String>	syllableRestTimeline Timeline for rests that are only there for syllables.
private java.util.ArrayList<java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>>>>>	timelines The timelines have the following structure: channel – tick – type – name – property – value For instrument changes: channel tick type = ET_INSTR name = null For notes or chords: channel tick type: ET_INSTR or ET_NOTES name: note or chord name property: VELOCITY, OFF_TICK, LENGTH, … value

Constructor Summary

Constructors

Constructor and Description
Slice(long beginTick) Creates a new sequence slice.

Method Summary

Modifier and Type	Method and Description
void	addGlobalCmd(java.lang.String key, java.lang.String value) Adds a global command to be put at the begin tick of the slice.
void	addInstrChange(long tick, int channel) Adds an instrument change to the given channel’s timeline.
void	addNotesToTimeline(long tick, byte channel, java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>> notesOrChords) Adds the given notes and/or chords to the channel’s timeline.
void	addSyllableRest(long tick, java.lang.String syllable, byte channel, byte orphaned, long resolution) Adds a lyrics syllable as an option to a rest command.
private void	addToTimeline(long tick, int channel, byte key, java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>> notesOrChords) Adds something to a channel’s timeline.
java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.lang.Byte>>>	filterNotes(java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.lang.Byte>>> noteHistory) Copies the given structure to the slice, omitting all entries that are not related to the slice’s tick scope.
java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>>>	filterOnOff(java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>>> noteOnOff) Copies the given structure to the slice, omitting all entries that are not related to the slice’s tick scope.
long	getBeginTick() Returns the begin tick of the slice.
long	getEndTick() Returns the end tick of the slice, or -1, if an end tick has not yet been set.
java.util.TreeMap<java.lang.String,java.lang.String>	getGlobalCommands() Returns the global commands from the beginning of the slice.
static Slice	getSliceByTick(java.util.ArrayList<Slice> slices, long tick) Returns the slice belonging to the given tick.
java.util.TreeMap<java.lang.Long,java.lang.String>	getSyllableRestTimeline() Returns the special timeline only for rests with syllables.
java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>>>>	getTimeline(int channel) Returns the timeline for the given channel.
boolean	hasSyllableRests() Determins if the slice contains rests with syllables.
void	setEndTick(long endTick) Sets the end tick of the slice.

Methods inherited from class java.lang.Object

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

Field Detail

beginTick

private long beginTick

endTick

private long endTick

globalCommands

private java.util.TreeMap<java.lang.String,java.lang.String> globalCommands

noteHistory

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

noteOnOff

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

timelines

private java.util.ArrayList<java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>>>>> timelines

The timelines have the following structure:

channel – tick – type – name – property – value

For instrument changes:

• channel
• tick
• type = ET_INSTR
• name = null

For notes or chords:

• channel
• tick
• type: ET_INSTR or ET_NOTES
• name: note or chord name
• property: VELOCITY, OFF_TICK, LENGTH, …
• value

syllableRestTimeline

private java.util.TreeMap<java.lang.Long,java.lang.String> syllableRestTimeline

Timeline for rests that are only there for syllables.

• tick
• value: syllable

Constructor Detail

Slice

public Slice(long beginTick)

Creates a new sequence slice.

Parameters:

beginTick - MIDI tick where the slice begins.

Method Detail

getSliceByTick

public static Slice getSliceByTick(java.util.ArrayList<Slice> slices,
                                   long tick)

Returns the slice belonging to the given tick.

Parameters:

slices - all slices

tick - MIDI tick

Returns:

the matching slice.

getBeginTick

public long getBeginTick()

Returns the begin tick of the slice.

Returns:

the begin tick of the slice.

setEndTick

public void setEndTick(long endTick)

Sets the end tick of the slice.

Parameters:

endTick - the end tick of the slice.

getEndTick

public long getEndTick()

Returns the end tick of the slice, or -1, if an end tick has not yet been set.

Returns:

the end tick of the slice or -1.

hasSyllableRests

public boolean hasSyllableRests()

Determins if the slice contains rests with syllables.

Returns:

true, if the slice contains rests with syllables, otherwise: false.

addGlobalCmd

public void addGlobalCmd(java.lang.String key,
                         java.lang.String value)

Adds a global command to be put at the begin tick of the slice.

Parameters:

key - ID of the global command.

value - value of the global command.

getGlobalCommands

public java.util.TreeMap<java.lang.String,java.lang.String> getGlobalCommands()

Returns the global commands from the beginning of the slice.

Returns:

the global commands.

addInstrChange

public void addInstrChange(long tick,
                           int channel)

Adds an instrument change to the given channel’s timeline.

Parameters:

tick - MIDI tick

channel - MIDI channel

addNotesToTimeline

public void addNotesToTimeline(long tick,
                               byte channel,
                               java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>> notesOrChords)

Adds the given notes and/or chords to the channel’s timeline.

Parameters:

tick - MIDI tick

channel - MIDI channel

notesOrChords - all notes and chords that begin at this channel and tick

addSyllableRest

public void addSyllableRest(long tick,
                            java.lang.String syllable,
                            byte channel,
                            byte orphaned,
                            long resolution)

Adds a lyrics syllable as an option to a rest command. This is needed if there is no note/chord being played at the tick when the syllable appears.

According to the orphaned parameter one of the following strategies is used to add the rest:

• The rest is added to a special timeline and later added inside a nestable block that contains only rests.
• The rest is added to the timeline of notes/chords and is later added inline.

Parameters:

tick - MIDI tick

syllable - Lyrics syllable for Karaoke

channel - MIDI channel

orphaned - either Decompiler.INLINE or Decompiler.BLOCK

resolution - source resolution of the sequence

getTimeline

public java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>>>> getTimeline(int channel)

Returns the timeline for the given channel.

Parameters:

channel - MIDI channel

Returns:

the timeline

getSyllableRestTimeline

public java.util.TreeMap<java.lang.Long,java.lang.String> getSyllableRestTimeline()

Returns the special timeline only for rests with syllables.

Returns:

the timeline for rests with syllables.

filterNotes

public java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.lang.Byte>>> filterNotes(java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.lang.Byte>>> noteHistory)

Copies the given structure to the slice, omitting all entries that are not related to the slice’s tick scope. Returns the copied (filtered) structure.

An entry is copied, if:

• tick >= scope’s beginTick; and:
• tick < scope’s endTick

Parameters:

noteHistory - structure containing channel, tick, note and velocity

Returns:

the filtered structure.

filterOnOff

public java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>>> filterOnOff(java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>>> noteOnOff)

Copies the given structure to the slice, omitting all entries that are not related to the slice’s tick scope. Returns the copied (filtered) structure.

An entry is copied, if:

• it’s within the slice’s scope (>= beginTick or < endTick); or:
• it’s a Note-OFF in a later slice but the note has been pressed in the slice’s scope and has not yet been released.

Parameters:

noteOnOff - structure containing channel, tick, note and on/off

Returns:

the filtered structure.

addToTimeline

private void addToTimeline(long tick,
                           int channel,
                           byte key,
                           java.util.TreeMap<java.lang.String,java.util.TreeMap<java.lang.Byte,java.lang.String>> notesOrChords)

Adds something to a channel’s timeline. This ‘something’ can be one of:

• an instrument change marker (meaning: one or more instrument changes)
• a collection of notes and/or chords beginning at the same tick and channel

Parameters:

tick - MIDI tick

channel - MIDI channel

key - ID of the event

notesOrChords - all notes and chords that begin at this channel and tick (or null in case of an instrument change marker)