org.midica.file.write

Class MidiExporter

java.lang.Object

org.midica.file.write.Exporter

org.midica.file.write.MidiExporter

Direct Known Subclasses:

AbcExporter, LilypondExporter, MusescoreExporter

public class MidiExporter
extends Exporter

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

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private ExportResult	exportResult
private java.lang.String	fileCharset Source charset, specified in the sequence.
protected java.lang.String	sourceCharset (default) charset used to read the currently loaded file (or its text-based messages)
protected java.lang.String	targetCharset Target charset for text-based messages.

Constructor Summary

Constructors

Constructor and Description
MidiExporter() Creates a new MIDI exporter.

Method Summary

Modifier and Type	Method and Description
protected javax.sound.midi.Sequence	cloneSequence() Creates a modified copy of the loaded sequence.
private javax.sound.midi.MidiEvent	convertCharset(javax.sound.midi.MidiEvent oldEvent, java.lang.String text, java.lang.String fileCharset, int type, long tick, int trackNum) Converts the text of a META message into the target charset.
ExportResult	export(java.io.File file) Exports a MIDI file.
protected java.lang.String	getTargetCharset() Determins and returns the target charset from the according charset combobox.
protected boolean	mustIncludeRp026Tags() Determins if RP-026 tags (charset switch or meta info) shall be included into the exported MIDI file or not.
private javax.sound.midi.MidiEvent	removeCharsetSwitch(javax.sound.midi.MidiEvent oldEvent, java.lang.String text, int type, long tick, int trackNum) Removes all charset switch tags from the event’s text.

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

sourceCharset

protected java.lang.String sourceCharset

(default) charset used to read the currently loaded file (or its text-based messages)

targetCharset

protected java.lang.String targetCharset

Target charset for text-based messages.

fileCharset

private java.lang.String fileCharset

Source charset, specified in the sequence.

exportResult

private ExportResult exportResult

Constructor Detail

MidiExporter

public MidiExporter()

Creates a new MIDI exporter.

Method Detail

export

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

Exports a MIDI file.

Specified by:

export in class Exporter

Parameters:

file - MIDI file.

Returns:

Empty data structure (warnings are not used for MIDI exports).

Throws:

ExportException - If the file can not be exported correctly.

getTargetCharset

protected java.lang.String getTargetCharset()

Determins and returns the target charset from the according charset combobox.

Can be overridden to return a charset from a different combobox or a hard-coded value, depending on the format.

Returns:

the target charset.

cloneSequence

protected javax.sound.midi.Sequence cloneSequence()
                                           throws javax.sound.midi.InvalidMidiDataException

Creates a modified copy of the loaded sequence. Adds a meta event for the target charset. Removes meta events for all other charset switches. Removes meta events for key presses and key releases.

Returns:

copied and modified MIDI Sequence.

Throws:

javax.sound.midi.InvalidMidiDataException - if the new MIDI (copied) sequence cannot be created.

mustIncludeRp026Tags

protected boolean mustIncludeRp026Tags()

Determins if RP-026 tags (charset switch or meta info) shall be included into the exported MIDI file or not.

Returns true per default but can be overridden by a derived class.

Returns:

true to indicate that RP-026 tags should be used.

convertCharset

private javax.sound.midi.MidiEvent convertCharset(javax.sound.midi.MidiEvent oldEvent,
                                                  java.lang.String text,
                                                  java.lang.String fileCharset,
                                                  int type,
                                                  long tick,
                                                  int trackNum)

Converts the text of a META message into the target charset.

Parameters:

oldEvent - The original MIDI event.

text - The text of the meta message.

fileCharset - Last charset, specified in the MIDI stream.

type - META message type.

tick - Tickstamp.

trackNum - Track number.

Returns:

the new meta event with the converted text or the original event, if the text cannot be converted.

removeCharsetSwitch

private javax.sound.midi.MidiEvent removeCharsetSwitch(javax.sound.midi.MidiEvent oldEvent,
                                                       java.lang.String text,
                                                       int type,
                                                       long tick,
                                                       int trackNum)

Removes all charset switch tags from the event’s text.

Parameters:

oldEvent - The original MIDI event.

text - The text of the meta message.

type - META message type.

tick - Tickstamp.

trackNum - Track number.

Returns:

the new event with the changed text or null if the text is empty after the changes.