home *** CD-ROM | disk | FTP | other *** search
/ MIDICraft's MIDINET CD-ROM / MIDICraft's MIDINET CD-ROM.iso / KORG_I-S / SOFTWARE / MF2T.ZIP / readme.txt < prev    next >
Encoding:
Text File  |  1995-11-29  |  9.0 KB  |  236 lines
  1.         MF2T/T2MF
  2.  
  3. Two programs to manipulate standard midifiles.
  4.  
  5. mf2t is a program that reads a standard midifile (format 0 or 1) and
  6. writes an ASCII representation of it that is both compact and easily parsable.
  7.  
  8. t2mf is the companion program that reparses the text representation
  9. into a midifile.
  10. -----------------------------------------------------------------------
  11. Please report any problems, suggestion for improvement, or actual
  12. improvements to:
  13.  
  14. Piet van Oostrum, Dept of Computer Science, Utrecht University,
  15. P.O. Box 80.089, 2508 TB Utrecht, The Netherlands
  16. email: piet@cs.ruu.nl
  17.  
  18. -----------------------------------------------------------------------
  19. You can do with this program what you like, but if you think it is
  20. useful I would appreciate if you send me some of your midifiles. Not
  21. ones that I can find on the Internet. And only PD ones. Please send
  22. them uu- or btoa-encoded. Zoo and Arc archives (encoded) are also OK,
  23. Zip and Lharc may be problematic.
  24. ------------------------------------------------------------------------
  25.  
  26. The text representation is chosen such that it is easily recognized and
  27. manipulated by programs like sed, awk or perl. Yet it is also humanly
  28. readable so that it can be manipulated with an ordianary text editor.
  29.  
  30. In this way you can make changes to your midifiles using these
  31. powerful programs or even a Fortran program :=). Or you can write
  32. algorithmic compositions using a familiar programming language.
  33.  
  34. The programs use the midifile library written by Tim Thompson
  35. (tjt@blink.att.com) and updated by Michael Czeiszperger (mike@pan.com).
  36. However, there were some bugs in the write code and I added some
  37. features that I needed. I also changes some of the names to cope with
  38. the 7-character limit for external identifiers in the Sozobon
  39. compiler. I will make an updated version of the library available
  40. soon. I also anticipate to split the read and write portions.
  41.  
  42. Usage:
  43.     mf2t [-mntv] [-f[n]] [midifile [textfile]]
  44.     
  45.     translate midifile to textfile.
  46.     
  47. When textfile is not given, the text is written to standard output.
  48. When midifile is not given it is read from standard input. The meaning
  49. of the options is:
  50.  
  51. -m    merge partial sysex into a single sysex message
  52. -n    write notes in symbolic rather than numeric form. A-C
  53.     optionally followed by # (sharp) followed by octave number.
  54. -b    or
  55. -t    event times are written as bar:beat:click rather than a click number
  56. -v    use a slightly more verbose output
  57. -f<n>    fold long text and hex entries into more lines <n>=line length
  58.     (default 80).
  59.  
  60.     t2mf [-r] [[textfile] midifile]
  61.     
  62.     translate textfile to midifile.
  63.     
  64. When textfile is not given, text is read from standard input, when
  65. midifile is not given it is written to standard output.
  66. NOTE: This will give incorrect results on MS-DOS. Always specify the
  67. midifile on MS-DOS!!
  68.  
  69. -r    Use running status
  70.  
  71. Note that if one file is given it is always the midifile. This is so
  72. that on systems like Unix you can write a pipeline:
  73.  
  74.     mf2t x.mid | sed ... | t2mf y.mid
  75.     
  76. Format of the textfile:
  77. -----------------------
  78.  
  79. The following representation of the midievents is generated (between
  80. [] the form when -v is used:
  81.  
  82. File header:        Mfile <format> <ntrks> <division>
  83. Start of track:        MTrk
  84. End of track:        TrkEnd
  85.  
  86. Note On:        On <ch> <note> <vol>
  87. Note Off:        Off <ch> <note> <vol>
  88. Poly Pressure:        PoPr[PolyPr] <ch> <note> <val>
  89. Channel Pressure:    ChPr[ChanPr] <ch> <val>
  90. Controller parameter:    Par[Param] <ch> <con> <val>
  91. Pitch bend:        Pb <ch> <val>
  92. Program change:        PrCh[ProgCh] <ch> <prog>
  93. Sysex message:        SysEx <hex>
  94. Arbutrary midi bytes:    Arb <hex>
  95.  
  96. Sequence nr:        Seqnr <num>
  97. Key signature:        KeySig <num> <manor>
  98. Tempo:            Tempo <num>
  99. Time signature:        TimeSig <num>/<num> <num> <num>
  100. SMPTE event:        SMPTE <num> <num> <num> <num> <num>
  101.  
  102. Meta text events:    Meta <texttype> <string>
  103. Meta end of track:    Meta TrkEnd
  104. Sequencer specific:    SeqSpec <type> <hex>
  105. Misc meta events:    Meta <type> <hex>
  106.  
  107. The <> have the following meaning:
  108.  
  109. <ch>        ch=<num>
  110. <note>        n=<noteval>  [note=<noteval>]
  111. <vol>        v=<num> [vol=<num>]
  112. <val>        v=<num> [val=<num>]
  113. <con>        c=<num> [con=<num>]
  114. <prog>        p=<num> [prog=<num>]
  115. <manor>        minor or major
  116. <noteval>    either a <num> or A-G optionally followed by #,
  117.         followed by <num> without intermediate spaces.
  118.  
  119. <texttype>    Text Copyright SeqName TrkName InstrName Lyric Marker Cue
  120.         or <type>
  121. <type>        a hex number of the form 0xab
  122. <hex>        a sequence of 2-digit hex numbers (without 0x)
  123.         separated by space
  124. <string>    a string between double quotes (like "text").
  125.  
  126. Channel numbers are 1-based, all other numbers are as they appear in
  127. the midifile.
  128. <division> is either a positive number (giving the time resolution in
  129. clicks per quarter note) or a negative number followed by a positive
  130. number (giving SMPTE timing).
  131. <format> <ntrks> <num> are decimal numbers.
  132. The <num> in the Pb is the real value (two midibytes combined)
  133. In Tempo it is a long (32 bits) value. Others are in the interval 0-127
  134. The SysEx sequence contains the leading F0 and the trailing F7.
  135.  
  136. In a string certain characters are escaped:
  137. " and \ are escaped with a \
  138. a zero byte is written as \0
  139. CR and LF are written as \r and \n respectively
  140. other non-printable characters are written as \x<2 hex digits>
  141. When -f is given long strings and long hex sequences are folded by inserting
  142. \<newline><tab>. If in a string the next character would be a space or
  143. tab it will be escaped by \
  144. This facility is for those programs that have a limited buffer length.
  145. Of course parsing is more difficult with this option (see below).
  146.  
  147. Input:
  148. ------
  149. t2mf will accept all formats that mf2t can produce, plus a number of others.
  150. Input is case insensitive (except in strings) and extra tabs and
  151. spaces are allowed. Newlines are required but empty lines are allowed.
  152. Comment starts with # at the beginning of a lexical item and continues
  153. to the end of the line. The only other places where a # is legal are
  154. insides strings and as a sharp symbol in a symbolic note.
  155.  
  156. In symbolic notes + and # are allowed for sharp, b and - for flat.
  157.  
  158. In bar:beat:click time the : may also be /
  159.  
  160. On input a string may also contain \t for a tab, and in a folded
  161. string any whitespace at the beginning of a continuation line is skipped.
  162.  
  163. Hex sequences may be input without intervening spaces if each byte is
  164. given as exactly 2 hex digits.
  165.  
  166. Hex sequences may be given where a string is required and vice versa.
  167.  
  168. Hex numbers of the form 0xaaa and decimal numbers are equivalent.
  169. Also allowed as numbers are "bank numbers" of the form '123. In fact
  170. this is equivalent to the octal number 012 (subtract 1 from each
  171. digit, digits 1-8 allowed). The letters a-h may also be used for 1-8.
  172.  
  173. The input is checked for correctness but not extensively. An
  174. errormessage will generally imply that the resulting midifile is illegal.
  175.  
  176. Implementation:
  177. ---------------
  178.  
  179. I have compiled the programs on an Atari ST with the Sozobon compiler and
  180. the dlibs library. The scanner is generated using flex 2.3. The output of
  181. flex (t2mflex.c) is included for those that do not have flex.  The module
  182. yyread.c is a flex library module that you need on TOS (and on MSDOS).  The
  183. corresponding makefile is makefile.st. For Unix use makefile.unx. For
  184. Borland C on MSDOS use makefile.bcc. For Microsoft C on MSDOS makefile.msc.
  185. The makefiles may need minor changes for other systems.
  186.  
  187. Useful hints:
  188. -------------
  189.  
  190. channel number can be recognized by the regular expression /ch=/.
  191. note numbers by /n=/ or /note=/, program numbers by /p=/ or /prog=/.
  192. Meta events by /^Meta/ or /^SeqSpec/.
  193. Text events by /"/, continued lines by /\\$/, continuation lines by /$\t/
  194. (that was a TAB character).
  195.  
  196. In awk each parameter is a field, in perl you can use split to get the
  197. parameters (except for strings).
  198.  
  199. The following perl script changes note off messages to note on with
  200. vol=0, deletes controller 3 changes, makes some note reassignments on
  201. channel 10, and changes the channel numbers from channel 1 depending
  202. on the track number. 
  203.  
  204. ------------------------------- test.pl -------------------------------
  205. %drum = (62, 36, 63, 47, 65, 61, 67, 40, 68, 54);
  206.  
  207. while (<>) {
  208.     next if /c=3/;
  209.     s/Off(.*)v=[0-9]*/On\1v=0/;
  210.     if (/ch=10/ && /n=([0-9]*)/ && $drum{$1}) {
  211.         s/n=$1/"n=".$drum{$1}/e;
  212.     }
  213.     if (/^MTrk/) {++$trknr ; print "track $trknr\n";}
  214.     if ($trknr > 2) { s/ch=1\b/ch=3/; }
  215.     else  { s/ch=1\b/ch=4/; }
  216.     print || die "Error: $!\n";
  217. }    
  218. ------------------------------------------------------------------------
  219.  
  220. and this is the corresponding awk script.
  221.  
  222. ------------------------------- test.awk -------------------------------
  223. BEGIN { drum[62] = 36; drum[63] = 47; drum[65] = 61; \
  224.     drum[67] = 40; drum[68] = 54 }
  225. /c=3/ { next }
  226. ($2 == "Off") { $2 = "On"; $5 = "v=0" }
  227. /ch=10/ { n = substr($4, 3); if (n in drum) $4 = "n=" drum[n] }
  228. /^MTrk/ { trknr++ }
  229. /ch=1 / { if (trknr > 2) { $3 = "ch=2" } else { $3 = "ch=3" } } 
  230. { print }
  231. ------------------------------------------------------------------------
  232.  
  233. Good luck!
  234.  
  235. $Id: readme.,v 1.6 1995/09/23 22:27:48 piet Rel $
  236.