XMidi Changes for Version 1.2

• Consolidated command line syntax.

  The syntax of the command line (as well as constructor calls) is now the same for XM and MX. However, these changes are "backward compatible". This means that any correct command lines (or constructor calls) from version 1.1 will work with this version.

  There are additions to the options for these utilities, which are explained below.

• New public methods for XM and MX. The constructors are essentially unchanged, as well as the "old" public methods (xMidiToMidi in XM and midiToXMidi in MX).

  Each class has two new public methods. Class XM has xMidiToDoc and docToMidi, while class MX has midiToDoc and docToXMidi. The "old" public methods invoke these new methods, but they can be invoked from outside as well.

  It is important to note that this change to the public interface adds functionality without changing the existing interface. Calls using the old methods should work just fine.

  Also, I have "broken out" a couple of classes, made them public, and made some methods public. All of this is for the purpose of making the javadoc documentation as complete and helpful as possible.

• The "-q" option has been added to the command line. This will work in conjunction with the -p option to allow the use of a helper class (which implements com.palserv.XMidi.Parser) which is not in the com.palserv.XMidi package.

  Formerly, the string following the -p option was appended to "com.palserv.XMidi." to yield the fully qualified class name within this package.

  Now, by using the -q option, the string following the -p option will be taken as a fully qualified string. Thus, no assumptions about the package for the helper class. This should make things a bit more flexible and user friendly. Of course, the added class must be in the classpath!

• The "-v" option has been added to the command line. This is the "verbose" option. If coded, it means to include additional (optional) attributes in the output XMidi file (from MX) which will make the result more "human readable".

  As of this writing (1/9/01), the changes include:

  • The NAME attribute of the NOTE_OFF, NOTE_ON and AFTER tags. This is the name of the note in human readable form, for example: "Ab", "G", "C#", etc. This says nothing about the register.
  • The REGISTER attribute of the NOTE_OFF, NOTE_ON and AFTER tags. This is the register of the note. I have used numbers from -5 to 5 to indicate the register. Each register consists of 12 notes starting from "C" and going to "B". Register 0 (zero) goes from "middle C" to the "B" above "middle C".
  • The NAME attribute of the CONTROL tag. This gives a verbal description of the the control event, for example:
    • "Chorus Level" for control event 93
    • "Foot Pedal (coarse)" for control event 4
    • "Sustenuto Pedal (on/off)" for control event 66
    • etc.
  Interestingly enough, the DTD from version 1.1 included these attributes. I didn't have to change the DTD at all!

  By making it a command line option, you can include the verbose attributes by coding -v, and leave them out by not coding it. Coding -v will add substantial bulk to the XMidi file without any effect on a MIDI file produced from it. But if you are going to look at the the XMidi file in a text editor, browser, word processor, or XML editor, then these attributes might prove very valuable.