home *** CD-ROM | disk | FTP | other *** search
/ Sound, Music & MIDI Collection 2 / SMMVOL2.bin / MIDI_PAT / MDF40.ZIP / MDF.DOC < prev    next >
Encoding:
Text File  |  1994-10-01  |  10.1 KB  |  255 lines
  1.  
  2.  
  3.           MIDI DATA FILER ver 4.0, October 1994 by Kai Risku
  4.           ==================================================
  5.  
  6. This is a very easy-to-use program that will send and receive midi sysex
  7. dumps on a PC. The dumps are stored as raw files and are compatible with
  8. sysex dumps used by most sequencing programs. The dumps can be several
  9. hundred kilobytes in size (limited by available memory).
  10.  
  11. The program can be configured for different speeds, port addresses,
  12. filtering of sysex-data only, automatic receive termination after a
  13. specified timeout, default extension of sysex files and more.
  14.  
  15. Supports the following midi interfaces: MPU, SB and GUS.
  16.  
  17.  
  18. How to save MIDI-data to a file:
  19. ================================
  20.  
  21. You just start MDF with a non-existent filename as argument. When MDF
  22. reports 'Start dump' you can start a sysex-dump manually from your
  23. synthesizer or press any key to abort. A dot will be displayed for every
  24. sysex block received (so you can see that the computer is actually
  25. getting some data).
  26.  
  27. After the dump is done, MDF will report how many bytes have been
  28. received, save those in the file you specified and exit automatically.
  29.  
  30. The amount of data you can receive is limited by the available memory
  31. below 640k (minus about 40k for MDF itself).
  32.  
  33.  
  34. How to send the data back to the synthesizer:
  35. =============================================
  36.  
  37. Oh, you have already guessed that one, but I just want to say it anyway.
  38. Run MDF with the name of the file you want to send to your synthesizer
  39. as the argument. MDF will send the contents of the file and inform you
  40. of how many bytes has been sent. You can press ESC if you wish to abort
  41. the transfer.
  42.  
  43.  
  44. Doing things both ways
  45. ======================
  46.  
  47. You can also list several filenames on the command line, and in this
  48. case MDF loops through every filename and sends each file that exists,
  49. and receives for every file that does not already exist. This way you
  50. can have a dump request in a file and automatically capture the result
  51. in another file.
  52.  
  53.  
  54.  
  55. Configuring MDF using the MDF.INI file:
  56. =======================================
  57.  
  58. When starting up MDF, the program will look for a file named MDF.INI in
  59. the same directory as MDF.EXE is in. If the INI-file cannot be found, a
  60. supported midi interfaced is searched for and a fresh INI-file will be
  61. created. If MDF cannot find any interface automatically, the INI-file
  62. will be created with default settings for a MPU interface, and you must
  63. manually set the correct type, address and irq yourself. The file is in
  64. plain ASCII format and can be edited with any ascii editor.
  65.  
  66. These are the valid options and what they specify (case is not
  67. significant, and everything after a semi-colon on a line is ignored):
  68.  
  69. Interface=type
  70.  
  71.         where type is either MPU, SB or GUS.
  72.  
  73. Port=addr
  74.  
  75.         where addr is the address of the midi interface. The address
  76.         can be given in decimal or hex. To specify hex mode, you
  77.         must either have '0x' before the address, or the character
  78.         'h' after. The default address for an MPU-interface can be
  79.         written these ways; Port=816, Port=0x330 or Port=330h
  80.         The SoundBlaster and Gravis UltraSound are usually on port 0x220.
  81.  
  82. Irq=num
  83.  
  84.         where num is the IRQ to use for the currently select interface.
  85.         MPU normally uses 2, SoundBlaster 7 or 5, Gravis UltraSound 5.
  86.         This needs to be set to the correct irq for your interface, or
  87.         the program may lock up when you use it. Specify -1 to use
  88.         polling routines.
  89.  
  90. Delay1=n
  91.  
  92.         where n is a decimal integer specifying the delay between
  93.         each byte sent. A larger value means slower sending.
  94.  
  95. Delay2=n
  96.  
  97.         where n is a decimal integer specifying a delay in
  98.         milliseconds between each sysex block sent.
  99.  
  100. Timeout=n
  101.  
  102.         where n is a decimal integer in milliseconds specifying how
  103.         long MDF should wait for more data to arrive before finishing
  104.         the receive. Increase this if MDF stops receiving in the middle
  105.         of the dump.
  106.  
  107. Extension=ext
  108.  
  109.         where ext is a filename extension with a maximum of three
  110.         characters. This extension will be used as default if the given
  111.         filename has no extension and does not match any file.
  112.  
  113. SysexOnly=boolean
  114.  
  115.         where boolean is one of '1', '0', 'True', 'False', 'Yes' or
  116.         'No' (only the first character is used and case is not
  117.         significant). This setting controls if all incoming data
  118.         should be put in the file, or if only proper sysex data should
  119.         be saved (in the latter case only data between sysex start and
  120.         end markers is saved, everything else is filtered out). This
  121.         option is by default set to True, but you can change it if you
  122.         want to save other than sysex data to a file.
  123.  
  124. RealtimeData=boolean
  125.  
  126.         where boolean is of the same type as in the setting above.
  127.         This setting is by default set to False, but can be set to
  128.         True to enable receiving of Midi Realtime data (bytes with
  129.         hex code F8 or above). Note that for this to work, SysexOnly
  130.         must be set to False (naturally).
  131.  
  132. Echo=boolean
  133.  
  134.         where boolean is of the same type as in the setting above.
  135.         This setting defaults to False, but if set to True MDF
  136.         will echo back incoming data between sysex-blocks while
  137.         sending out data. (With this set to True, I can actually
  138.         play on my synth module while uploading a new bank of
  139.         sounds to it, because MDF echoes what I am playing on the
  140.         midi keyboard to the module between each small chunk of
  141.         sysex-data being sent to the module. *Your* mileage may
  142.         vary.)
  143.  
  144.  
  145. If it does not work:
  146. ====================
  147.  
  148. - check that you have the right type of interface set in MDF.INI,
  149.   the port address is correct and the correct irq is selected
  150.   (or try using irq -1 for polling mode if you are not sure).
  151. - some synthesizers can choke if the computer dumps data too fast.
  152.   Increase the delays specified in MDF.INI to slow down the sending.
  153. - there can be some problems when receiving a dump if the
  154.   synthesizer dumps data too fast and you have a slow computer.
  155.   You should therefore keep an eye on the size of the received data
  156.   as this will be too small if data has been lost (receiving the data
  157.   twice and comparing the two files is also a rather good check).
  158. - You cannot use handshake-dumps with this program, because
  159.   practically every synth has its own format for this. Make sure
  160.   that you start a one-way dump from your synthesizer.
  161.  
  162.  
  163. Revision history
  164. ================
  165.  
  166. New in version 4.0:
  167.         Total rewrite of low-level midi I/O to allow modules for
  168.         different interfaces to easily be written. Interrupt-driven
  169.         I/O implemented. Added support for SoundBlaster and Gravis
  170.         UltraSound. Multiple files can be listed on the command line.
  171.         Added option to filter out midi realtime data, and option
  172.         to echo back incoming data while sending a sysex-file.
  173.  
  174. New in version 3.2:
  175.         Added option to filter out any data not enclosed in a proper
  176.         sysex-format (enclosed by 0xF0 and 0xF7).
  177.  
  178. New in version 3.1:
  179.         Fixed bug that occasionally saved some garbage at the
  180.         end of the file when receiving. Tweaked the documentation.
  181.  
  182. New in version 3.0:
  183.         Sysex dumps are no longer limited to 64 kbytes. Receiving
  184.         sysex data is only limited by your dos memory (below 640k).
  185.         The receive timeout can now be specified in MDF.INI.
  186.         Program selfcheck added and large portions of the code
  187.         rewritten to improve the program in several ways.
  188.  
  189. New in version 2.6:
  190.         The address of the midi interface can be set in MDF.INI
  191.  
  192. New in version 2.5:
  193.         You can now change the default filename extension
  194.         using MDF.INI
  195.  
  196. New in version 2.4:
  197.         Ctrl-C is now trapped, so you cannot break out of the
  198.         program and leave the midi interface in UART mode.
  199.  
  200. New in version 2.3:
  201.         Added an INI-file for user-configurable delays while
  202.         sending. Modified text output and removed some
  203.         unnecessary texts.
  204.  
  205. New in version 2.2:
  206.         More code cleanup. Incoming data during sysex-send
  207.         to synthesizer will be sent back out when possible.
  208.         Error-handling improved.
  209.  
  210. New in version 2.1:
  211.         The default extension MDF for files created was changed
  212.         to SYX for compatibility with other software.
  213.         Active sensing has earlier caused some trouble, but
  214.         this has now been fixed as well as a small bug causing
  215.         a time-out if you don't start the dump fast enough
  216.         after you started the program.
  217.  
  218. New in version 2.0:
  219.         Document added (this piece of text). Improved routines
  220.         with faster code. Corrected some minor bugs. This was
  221.         the first "official" release.
  222.  
  223.  
  224.  
  225. #include <std_disclaimer.h>:
  226. ============================
  227.  
  228.                 Copyright (c) 1990-1994 Kai Risku
  229.  
  230. MDF is offered to you "AS IS" without any warranty. This software has
  231. been thoroughly tested but no guarantee is given that it will work on
  232. every computer. The copyright owner may not be held liable for any
  233. damages, direct or consequential, which may result from the the use of
  234. this program.
  235.  
  236. This program is freely distributable. You may use the software and
  237. share it with all your friends (and foes) as long as the program is
  238. supplied in its original, unmodified form, which includes this
  239. documentation. This program must not be distributed for profit.
  240.  
  241. If you have any questions, ideas, suggestions for improvements or if
  242. you are interested in the source then feel free to contact me...
  243.  
  244. If this program is worth anything to you, I would appreciate any token
  245. of gratitude you can think of. User support is highly dependent on the
  246. subjective value of your appreciation in a not necessarily causal
  247. manner, as well as the amount of temporal slack in author-space.
  248.  
  249.  
  250. Snailmail:      Kai Risku         Email (internet):  Kai.Risku@hut.fi
  251.                 Kronvik                
  252.                 65410 Sundom           Email strongly preferred!!!
  253.                 Finland
  254.  
  255.