home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaMiscModsCD3.iso / _PROGRAMME / TOOLS / Optim19.lha / Optim19 / optim19.doc < prev    next >
Encoding:
Text File  |  1997-10-07  |  5.4 KB  |  137 lines
  1.                            ModuleOptimizer V1.91
  2.  
  3.               The ProTracker or NoiseTracker module optimizer
  4.  
  5.  
  6. REQUIREMENTS
  7. Any Amiga with at least dos.library V36.
  8. Xfdmaster.library V36+ - optionable.
  9. ReqTools.library - optionable.
  10.  
  11. DESCRIPTION
  12. ModuleOptimizer is small CLI utility written in assembler for deleting
  13. of unused data in ProTracker's 4 channels song or module to reduce its
  14. length. It can be called from icon too and installing to DOpus is very
  15. easy. For more comfortable use, Xfdmaster.library and ReqTools.library
  16. are recomended. Without Xfdmaster.library ModuleOptimizer can not unpack
  17. any file and without ReqTools.library you can not select a module to
  18. optimize by nice filerequester but basic function of ModuleOptimizer
  19. is not reduced.
  20. It is not easy to test if some data are really ProTracker's module or song.
  21. There are many module identifiers (M.K., M!K!, FLT4, FLT8,...) and I don't
  22. know all so I decided to test module not only by this way. ModuleOptimize
  23. prints only warning, when finds non standard module identifier and
  24. continues on testing. It tests all samples parameters (volume, length,
  25. repeat, replen, finetune) not to be out of range. It also tests if
  26. filelength is not shorter than 2108 bytes - this is length of module with
  27. 1 pattern and no samples. But after program testing (thanks to SLAM)
  28. I have to add a TakeTracker (FastTracker) module recognizing because of
  29. ModuleOptimizer does optimize even these TakeTracker modules and it was
  30. bad! So if you try to optimize TakeTracker module ModuleOptimizer aborts
  31. work with message.
  32.  
  33. INSTALLATION AND START
  34. To install it, simply copy ModuleOptimizer to your C: directory or where
  35. do you want. If you start it from icon, ModuleOptimizer try to open its own
  36. window for standard text output. To close window press return when you have
  37. read all messages. The following arguments and options are provided:
  38.  
  39. FROM=MODULE/A,TO=OPTMODULE/K,QUIET/S,ABOUT/S,CLR=CLEARSAMPLENAMES/S
  40.  
  41. FROM
  42. Complete path and name of module (song) to optimize. If only filename is
  43. specified, current directory is used as path to file. If you specify only
  44. FROM argument (without TO), only optimize report will be printed (without
  45. any saving).
  46.  
  47. TO
  48. Complete path and name of module (song) to save to. If only filename is
  49. specified, current directory is used as path to file. If this argument is
  50. NOT specified, see above.
  51.  
  52. QUIET - option
  53. Disable printing of messages. Only error messages or ABOUT are always
  54. printed.
  55.  
  56. ABOUT - option
  57. Prints small usage list.
  58.  
  59. CLR - option
  60. Enable to clear all samplenames in module (song). It can be used for better
  61. crunching.
  62.  
  63. Examples:
  64.  
  65. optim19 ram:harleymusic
  66. Only prints an optimize report.
  67.  
  68. optim19 "ram:knulla kuk !!!" TO "ram:knulla kuk !!!.opt"
  69. Prints an optimize report and saves an optimized module.
  70.  
  71. optim19 dragonsfunk TO dragonsfunk CLR QUIET
  72. Save optimized module to same name. Clears samplenames in module. Doesn't
  73. print anything, if all OK.
  74.  
  75. optim19 ABOUT
  76. Prints small usage list.
  77.  
  78. optim19
  79. If you start it without any arguments you can select module to optimize by
  80. nice filerequester. After selecting it you can select optimized
  81. (destination) module by the same nice filerequester. If you cancel this
  82. second filerequester, only optimized report will be printed.
  83.  
  84. DOpus install:
  85. You can install ModuleOptimizer into DOpus. It is very easy. Just enter
  86. to button edit screen in ConfigOpus. Click to button where you want to have
  87. ModuleOptimizer. In Name entry type "OptimMod". In New entry select
  88. AmigaDOS and select a path and name of ModuleOptimizer. Than select
  89. function {f}. Set these flags: CD source, Do all files and Output window.
  90. Set value of Close delay to -1. It is all. Now you have a button which
  91. tests selected modules (songs) in DOpus output window.
  92.  
  93. If something goes wrong an error message with description is printed. So I
  94. hope you understand every problem which can occur.
  95.  
  96.  
  97. HOW IT WORKS
  98. ModuleOptimizer does several tests for better gain of bytes:
  99.  
  100. Unused patterns: Often there are some unused patterns in module (song)
  101. left by composer. These patterns are not used in pattermap.
  102. Gain from each unused pattern is 1024 bytes.
  103.  
  104. Same patterns: Sometimes (but a little) there are some same patterns in
  105. module (song). Gain from each same pattern is 1024 bytes.
  106.  
  107. Unused samples: Very often there are some unused samples in module (song)
  108. left by composer. Gain from unused samples depends on its length, but often
  109. there are large unused samples, so gain could be very good.
  110.  
  111. Samples lengths: Sometimes the samples length is greater than used length.
  112. Used length of sample data is from start of sample to end of its loop (if
  113. any). Data after loop end are unused and could be deleted.
  114.  
  115. Superfluous data: Length of module equals to: header data+patterns
  116. data+samples data. In some modules I have tested, there was data after end
  117. of smaples data. This bytes are unused and could be deleted.
  118.  
  119. BUGS
  120. Through first version to V1.9 there were many bugs. I tried to catch all of
  121. them, but who knows... If you find out some bugs, please send me e-mail
  122. with bug description, your system configuration and module (song) with
  123. which ModuleOptimizer was buggy. Thanks.
  124.  
  125. COPYRIGHT AND DISCLAIMER
  126. This program is freeware, so no financial donations required.
  127. Redistribution allowed if the package is left unchanged. The author is
  128. not responsible for any damage caused by the use or misuse of this
  129. documentation and/or the program(s) it describes.
  130.  
  131. AUTHOR
  132. Please send bug reports and ideas to e-mail:
  133.  
  134. galaxie1@mbox.vol.cz
  135.  
  136.                         Jan Poruba
  137.