home *** CD-ROM | disk | FTP | other *** search
/ Large Pack of OldSkool DOS MOD Trackers / goattracker_2.67.diz < prev    next >
Text File  |  1996-01-01  |  79KB  |  1,877 lines

  1. Goatcompo examplesongs & commandline parameters
  2. -----------------------------------------------
  3.  
  4. Randall: I'll Be A Pimp In Cabrini Green.. (cabrinigreen.sng)  /e1 /s1 /a0ff0
  5. Richard Bayliss: Everlasting Annoyance     (everlasting.sng)   /e0 /s1 /a0f00
  6. Hein: GhostTrackers                           (ghosttrackers.sng) /e0 /s1 /a0f00
  7. Jammer: My Own Hyperspace                  (hyperspace.sng)    /e1 /s1 /a0ff0
  8. Cadaver: On A Sanction From CIA            (sanction.sng)      /e0 /s1 /a0f00
  9. No-XS: Sixpack Of Cola                     (sixpack.sng)       /e0 /s1 /a0f00
  10.  
  11. GoatTracker v2.67
  12. -----------------
  13.  
  14. Editor by Lasse ╓÷rni (loorni@gmail.com)
  15. HardSID 4U support by TΘli Sßndor.
  16. Uses reSID engine by Dag Lem.
  17. Uses 6510 crossassembler from Exomizer2 beta by Magnus Lind.
  18. Uses the SDL library.
  19. GoatTracker icon by Antonio Vera.
  20.  
  21. Distributed under GNU General Public License
  22. (see the file COPYING for details)
  23.  
  24. Covert BitOps homepage:
  25. http://covertbitops.c64.org
  26.  
  27.  
  28. Table of contents
  29. -----------------
  30.  
  31. 1. General information
  32. 1.1 Warnings
  33. 1.2 Compatibility with v1.xx
  34.  
  35. 2. Using GoatTracker
  36. 2.1 Command line options
  37. 2.2 Hardware support
  38. 2.3 Keyboard commands
  39. 2.3.1 General keys
  40. 2.3.2 Pattern edit mode
  41. 2.3.2.1 Protracker note-entry mode
  42. 2.3.2.2 DMC note-entry mode
  43. 2.3.3 Song edit mode
  44. 2.3.4 Instrument edit mode
  45. 2.3.5 Table edit mode
  46. 2.3.6 Songname edit mode
  47. 2.4 Mouse control
  48.  
  49. 3. Song data
  50. 3.1 Orderlist data
  51. 3.2 Pattern data
  52. 3.3 Instrument data
  53. 3.4 Table data
  54. 3.4.1 Wavetable
  55. 3.4.2 Pulsetable
  56. 3.4.3 Filtertable
  57. 3.4.4 Speedtable
  58. 3.5 Playback details
  59. 3.6 Miscellaneous tips
  60. 3.6.1 Limit-based modulation steps
  61. 3.6.2 Precalculated note-independent "hifi player" portamento/vibrato
  62. 3.7 Multispeed tips
  63.  
  64. 4. Using the included utilities
  65. 4.1 INS2SND2.EXE
  66. 4.2 SNGSPLI2.EXE
  67. 4.3 MOD2SNG.EXE
  68. 4.4 BETACONV.EXE
  69.  
  70. 5. Using the songs outside the editor
  71. 5.1 Playroutine options
  72.  
  73. 6. File/data formats description
  74. 6.1 GoatTracker v2 song (.SNG) format
  75. 6.1.1 Song header
  76. 6.1.2 Song orderlists
  77. 6.1.3 Instruments
  78. 6.1.4 Tables
  79. 6.1.5 Patterns header
  80. 6.1.6 Patterns
  81. 6.2 GoatTracker v2 instrument (.INS) format
  82. 6.3 Sound effect data format
  83.  
  84. 7. Recompiling
  85.  
  86. 8. Version history
  87.  
  88.  
  89. 1. General information
  90. ----------------------
  91.  
  92. This program is a tracker-like C64 music editor running on Win32 or Linux
  93. platforms (using the SDL library, see http://www.libsdl.org)
  94.  
  95. GoatTracker v2 adds more commands and uniform step programming tables for
  96. waveform/arpeggio, pulse effects, and filter effects. It is likely much more
  97. complex to learn & master than v1.xx.
  98.  
  99. Familiarity with tracker programs in general, hexadecimal notation, and the
  100. C64's SID chip are required. Consult the C64 Programmer's Reference Guide
  101. (http://project64.c64.org) or AAY64 (http://www.the-dreams.de/aay.html) for
  102. SID chip reference.
  103.  
  104. For filesize & library compatibility reasons, precompiled binaries exist only
  105. for Win32 platform.
  106.  
  107. 1.1 Warnings
  108. ------------
  109.  
  110. 1. Always look at the end of this file for changes! Sometimes keyboard commands
  111.    change etc.
  112.  
  113. 2. Always save your songs in the .SNG-format with F11 key if you plan to
  114.    continue editing! Packed & relocated songs (PRG/BIN/SID) can not be loaded
  115.    back into the editor.
  116.  
  117. 3. Even the reSID emulation is in some cases quite far from the output of a
  118.    real SID. Especially if filters are in use, consider strongly testing your
  119.    tune on a C64 or on a HardSID card. (Using filters has always been
  120.    complicated because every SID tends to sound different.)
  121.  
  122. 4. The editor will stop playing if:
  123.    - The song restart position is illegal (beyond end of song)
  124.    - The sequence of orderlist commands is incorrect
  125.      * In a sequence of both TRANSPOSE & REPEAT, TRANSPOSE must come first
  126.      * The last thing before a RST-endmark should be a pattern number
  127.    - Gateoff timer value is too high compared to song tempo.
  128.    - The song tries to jump directly onto a table row containing a jump (FF xx),
  129.      either with instrument pointers or 8XY, 9XY, AXY commands.
  130.    - The song tries to execute pattern commands 0XY, 8XY or EXY from the
  131.      wavetable.
  132.    These all are error conditions, and trying to pack/relocate such song should
  133.    give an error message.
  134.  
  135. 5. Using delayed wavetable or no wavechange (0x 00, where x is 0-F) in the
  136.    first step of instrument wavetable is unsupported and may result in missing
  137.    notes.
  138.  
  139. 6. When using a playroutine with unbuffered SID-writes (Standard /w unbuffered
  140.    or Minimal) and encountering ADSR-bugs after packing/relocating, you can try
  141.    either:
  142.    1) Set pulse-startpos to nonzero value in the troublesome instruments and
  143.       change the 1stFrame Wave parameter of some instrument slightly, for
  144.       example from $09 to $0B, to disable a playroutine optimization. The
  145.       idea in this is to make the noteinit routine take more CPU cycles.
  146.    2) Use a playroutine with buffered writes to pack/relocate.
  147.    3) Try hardrestart attack parameter $F for alternative SID register write
  148.       order.
  149.  
  150. 7. From v2.18 onwards, wavetable left side values have changed. Delay can
  151.    now be maximum 16 frames (values $00-$0F), and waveform register values
  152.    $00-$0F (inaudible) have been mapped to table values $E0-$EF. For example,
  153.    testbit + gate would be $E9. You need to manually convert values $08-$0F
  154.    from your old songs!
  155.  
  156. 8. From v2.2 onwards, a new table (speedtable) has been added. The portamento,
  157.    vibrato and funktempo commands use it. Old songs will be converted upon
  158.    loading to use the speedtable. Note the keyboard command SHIFT+RETURN
  159.    to convert the old style parameters.
  160.  
  161. 9. From v2.4 onwards, pulse modulation speed has 1 bit added accuracy, so
  162.    you need to double pulsespeeds when composing new songs. Old songs will
  163.    be converted automatically.
  164.  
  165. 10. From v2.59 onwards, gateoff timer parameter high bit disables hardrestart
  166.    and bit $40 disables gateoff. Old songs & instruments will be converted
  167.    automatically.
  168.  
  169. 11. From v2.62 onwards, realtime calculated portamento/vibrato speeds are
  170.    supported. This is activated by having the high bit ($80) set in the speed-
  171.    table left side. Naturally, this means that very high portamento speeds (>=
  172.    $8000) or vibrato speeds (>= $80) become unavailable, but these should not 
  173.    be very useful anyway.
  174.  
  175. 1.2 Compatibility with v1.xx
  176. ----------------------------
  177.  
  178. GoatTracker v2 can load v1.xx songs and instruments, but it saves only in v2
  179. format. Some subtleties (like tricks involving instrument changes) will not
  180. play back exactly like in v1.xx.
  181.  
  182. The only major feature removal is that of the arpeggio command in v2.
  183. Everything that this command does can also be done with wavetables, and the
  184. import feature converts all arpeggio commands to corresponding wavetable
  185. programs.
  186.  
  187.  
  188. 2. Using GoatTracker
  189. --------------------
  190.  
  191. 2.1 Command line options
  192. ------------------------
  193.  
  194. Start Goattracker V2 by typing GOATTRK2 in the command prompt, followed by the
  195. songname to be loaded at startup (optional) and any command line options you
  196. may want. For example "goattrk2 dojo.sng /s1 /e1" to set 1x-speed mode and SID
  197. model 8580 and to load "dojo.sng" on startup.
  198.  
  199. /Axx Set hard restart ADSR parameter in hex. DEFAULT=0F00
  200. /Bxx Set sound buffer length in milliseconds DEFAULT=100
  201. /Cxx Use CatWeasel MK3 PCI SID (0 = off, 1 = on)
  202. /Dxx Pattern row display (0 = decimal, 1 = hexadecimal)
  203. /Exx Set emulated SID model (0 = 6581 1 = 8580) DEFAULT=6581
  204. /Fxx Set custom SID clock cycles per second (0 = use PAL/NTSC default)
  205. /Hxx Use HardSID (0 = off, 1 = HardSID ID0 2 = HardSID ID1 etc.)
  206. /Ixx Set reSID interpolation (0 = off, 1 = on) DEFAULT=off
  207. /Kxx Note-entry mode (0 = PROTRACKER 1 = DMC) DEFAULT=PROTRK.
  208. /Lxx SID memory location in hex. DEFAULT=D400
  209. /Mxx Set sound mixing rate DEFAULT=44100
  210. /Oxx Set pulse optimization/skipping (0 = off, 1 = on) DEFAULT=on
  211. /Rxx Set realtime command optimization/skipping (0 = off, 1 = on) DEFAULT=on
  212. /Sxx Set speed multiplier (0 for 25Hz, 1 for 1x, 2 for 2x etc.)
  213. /Txx Set HardSID interactive mode sound buffer length in milliseconds
  214.      DEFAULT=20, max.buffering=0
  215. /Uxx Set HardSID playback mode sound buffer length in milliseconds
  216.      DEFAULT=400, max.buffering=0
  217. /Vxx Set finevibrato conversion (0 = off, 1 = on) DEFAULT=on
  218. /Zxx Set random reSID write delay in cycles (0 = off) DEFAULT=off
  219. /N   Use NTSC timing
  220. /P   Use PAL timing (DEFAULT)
  221. /W   Write emulated sound output to a file SIDAUDIO.RAW
  222. /?   Show command line options
  223.  
  224. Try the command line options if there are any problems. For example, if you
  225. experience choppy audio you can increase audio buffering with /B option. SDL
  226. seems to have trouble with some soundcards under Windows; you might want to
  227. try even a 500ms buffer, or tweak the hardware acceleration level of the
  228. soundcard (from Control Panel). Also, reSID interpolation will take remarkably
  229. more CPU time and could cause the sound and/or editing to get choppy.
  230.  
  231. Finevibrato mode is on by default. You can change this behaviour with /V
  232. option. Note that finevibrato mode only affects the conversion of old style
  233. vibrato parameters to speedtable format.
  234.  
  235. Pulse optimization /O determines if pulsetable execution will be skipped when
  236. getting new notes or a new pattern. By default it is on. Be warned that
  237. turning it off will increase the rastertime requirements of packed/relocated
  238. songs greatly!
  239.  
  240. Realtime command optimization /R determines if portamento, vibrato & instrument
  241. vibrato will be skipped on tick 0 of each pattern row. By default it is on, as
  242. this is how tracker programs have operated traditionally. Turning it off makes
  243. the commands sound same regardless of tempo but will increase rastertime use.
  244.  
  245. The hard restart ADSR parameter will especially affect how rapid passages of
  246. notes will sound like. 0000 is probably too hard to be useful, except perhaps
  247. with gateoff timer value 1. 0F00 (default) is a lot softer, and 0F01 adds also
  248. a little bit of release to the gateoff phase for even softer sound. 000F makes
  249. the note start very pronounced.
  250.  
  251. Hard restart parameter with attack at maximum (F) enables the use of an
  252. alternative playroutine, where waveform is written before ADSR. This can give
  253. more reliable note triggering, but may change the characteristics of the note's
  254. decay & release.
  255.  
  256. 2.2 Hardware support
  257. --------------------
  258.  
  259. HardSID support is available with the /H option (use first HardSID = /H1,
  260. second = /H2 etc., return to emulated output = /H0). You must have the HardSID
  261. drivers installed to use this feature.
  262.  
  263. CatWeasel MK3 PCI SID support is available with /C option (/C1 to turn on).
  264.  
  265. To use the PC64 cable, you need Daniel Illgen's HardSID-DLL-Clone. Available at
  266. http://dawork.synchronus.de/
  267.  
  268. To enable better support of multispeeds and cycle-exact timing on HardSID
  269. (currently Win32 only), download an enhanced HardSID.dll:
  270.  
  271. For HardSID ISA/PCI cards -
  272. http://sourceforge.net/project/showfiles.php?group_id=9266&release_id=61843
  273.  
  274. For HardSID 4U -
  275. http://www.hardsid.com
  276.  
  277. Cycle-exact HardSID buffer length is separately configurable for interactive
  278. mode (/T option) & playback mode (/U option).
  279.  
  280. HardSID interactive mode:
  281. Low latency mode for jamming and accurate GUI display. Interactive mode can
  282. be activated during song/pattern playback by enabling jamming (space key).
  283.  
  284. HardSID playback mode:
  285. High stability mode to avoid interruptions caused by other applications/poor
  286. drivers/weaker CPU. GUI display is less accurate in this mode. Set the /U
  287. parameter to zero to achieve the maximum stability (less accurate GUI).
  288.  
  289. 2.3 Keyboard commands
  290. ---------------------
  291.  
  292. This program is mainly operated on keyboard. For a list of keyboard commands
  293. press F12 (online help) in the tracker or see the table below:
  294.  
  295. NOTE: SHIFT & CTRL are interchangeable in the commands. You can also use [ ]
  296. or ( ) instead of < >.
  297.  
  298. 2.3.1 General keys
  299. ------------------
  300.  
  301. F1        Play from beginning
  302. F2        Play from current pos.
  303. F3        Play one pattern from current pos.
  304. F4        Stop playing & silence all sounds
  305. F5        Go to pattern editor
  306. F6        Go to song editor
  307. F7        Go to instrument/table editor
  308. F8        Go to songname editor
  309. F9        Pack, relocate & save PRG,SID etc.
  310. F10       Load song (Pattern/Song/Songname mode) or instrument (Instrument mode)
  311. F11       Save song (Pattern/Song/Songname mode) or instrument (Instrument mode)
  312. F12       Online help screen
  313. SHIFT+F1  Play from beginning /w follow play
  314. SHIFT+F2  Play from current pos. /w follow play
  315. SHIFT+F3  Play one pattern from current pos. /w follow play
  316. SHIFT+F4  Mute current channel
  317. SHIFT+F5  Decrease speed multiplier
  318. SHIFT+F6  Increase speed multiplier
  319. SHIFT+F7  Edit hardrestart ADSR parameter
  320. SHIFT+F8  Switch between 6581 and 8580 SID models
  321. SHIFT+,.  Move song startposition on all channels and restart last playmode
  322. TAB       Cycle between editing modes (forwards)
  323. SHIFT+TAB Cycle between editing modes (backwards)
  324. INS       Insert row (Press INS/DEL on endmark to change pattern/song length)
  325. DEL       Delete row
  326. SHIFT+ESC Optimize musicdata, or clear musicdata & set default pattern length
  327. ESC       Exit program
  328.  
  329. 2.3.2 Pattern edit mode
  330. -----------------------
  331.  
  332. - +         Select instrument
  333. / *         Select octave
  334. < >         Select pattern
  335. BACKQUOTE   Select channel
  336. 0-9 & A-F   Enter parameters
  337. SPACE       Switch between jam/editmode
  338. RETURN      (also CAPSLOCK) Insert keyoff
  339.             Enter table (when cursor is over a table-utilizing command)
  340.             Enter instrument (when cursor is over a nonzero instrument number)
  341. SHIFT+RET.  Insert keyon
  342.             Convert portamento/vibrato/funktempo old style parameter to a
  343.             speedtable entry (when cursor is over the command)
  344.             Go into an empty table entry (when parameter is zero on a
  345.             table-utilizing command)
  346. BACKSPACE   Insert rest
  347. SHIFT+BKSP. Insert rest and clear commands
  348. SHIFT+SPACE Play from cursor position
  349. SHIFT+Q     Transpose halfstep up
  350. SHIFT+A     Transpose halfstep down
  351. SHIFT+W     Transpose octave up
  352. SHIFT+S     Transpose octave down
  353. SHIFT+O     Shrink pattern (divide size by 2)
  354. SHIFT+P     Expand pattern (multiply size by 2)
  355. SHIFT+J     Join pattern with next pattern in orderlist
  356. SHIFT+K     Split pattern from edit position
  357. SHIFT+H     Calculate "hifi" left/right shifted speedtable entry for
  358.             portamento or vibrato
  359. SHIFT+I     Invert selection / whole pattern if no selection
  360. SHIFT+CRSR UP,DOWN Mark pattern
  361. SHIFT+CRSR LEFT,RIGHT Select pattern
  362. SHIFT+L     Mark/unmark entire pattern
  363. SHIFT+M,N   Choose highlighting step size
  364. SHIFT+X,C,V Cut,copy,paste pattern
  365. SHIFT+E,R   Copy,paste commands
  366. SHIFT+Z     Cycle autoadvance-mode
  367.  
  368. For pattern joining to work properly, select the pattern you want to join with
  369. the next from the orderlist first (by pressing RETURN on it). Both joining and
  370. splitting will rearrange pattern numbers (for example if you split pattern 00,
  371. pattern 01 will be created and old patterns 01-xx will be shifted forward in
  372. the pattern order)
  373.  
  374. SHIFT+SPACE will play from the pattern onwards if playback was previously
  375. stopped, but if it is pressed while in pattern play mode, it will stay in
  376. the current pattern.
  377.  
  378. There are 2 modes for note entering:
  379.  
  380. 2.3.2.1 Protracker note-entry mode
  381. ----------------------------------
  382.  
  383. This is the default or activated with command line option /K0. There are two
  384. rows of a piano keyboard:
  385.  
  386.   Lower octave     Higher octave
  387.  S D  G H  K L    2 3  5 6 7  9 0
  388. Z X CV B NM , .  Q W ER T Y UI O P
  389.  
  390. Octave (0-7) is selected with / and * keys on the numeric keypad.
  391.  
  392. In this mode there are 2 different autoadvance-modes (the mode can be seen from
  393. the color of the jam/editmode indicator)
  394.  
  395. GREEN - Advance when entering notes & command-databytes
  396. RED - Do not advance automatically
  397.  
  398. 2.3.2.2 DMC note-entry mode
  399. ---------------------------
  400.  
  401. Activated with command line option /K1, there is one row of piano keyboard
  402.  
  403.  W E  T Y U  O P
  404. A S DF G H JK L
  405.  
  406. and octave of a note (sets default octave at the same time) is changed with
  407. number keys 0-7.
  408.  
  409. In this mode there are 3 different autoadvance-modes:
  410.  
  411. GREEN - Advance when entering notes, octaves or command-databytes
  412. YELLOW - Advance when entering notes or command-databytes, not octaves
  413. RED - Do not advance automatically
  414.  
  415. 2.3.3 Song edit mode
  416. --------------------
  417.  
  418. < >         Select subtune
  419. - +         Insert Transpose down/up command (shown as -/+ in the orderlist)
  420. 0-9 & A-F   Enter pattern numbers
  421. SPACE       Set start position for F2 key
  422. BACKSPACE   Set end position for F2 key
  423. RETURN      Go to pattern
  424. SHIFT+R     Insert Repeat command (shown as "R" in the order-list)
  425. SHIFT+CRSR LEFT/RIGHT Mark orderlist
  426. SHIFT+1,2,3 Swap current channel orderlist with channel 1,2,3
  427. SHIFT+X,C,V Cut,copy,paste channel orderlist
  428. SHIFT+L     Mark/unmark entire orderlist
  429. SHIFT+SPACE Set start position on all channels
  430. SHIFT+RET.  Go to pattern on all channels
  431.  
  432. SHIFT+SPACE or SHIFT+BACKSPACE set the start/end mark on all channels to
  433. the same position. To clear the endmark, press BACKSPACE again on it or
  434. at/before the startmark.
  435.  
  436. 2.3.4 Instrument edit mode
  437. --------------------------
  438.  
  439. < >         Select instrument
  440. - +         Select instrument
  441. / *         Select octave
  442. F7          Go to table editor
  443. 0-9 & A-F   Enter parameters
  444. SPACE       Play test note
  445. SHIFT+SPACE Silence test note
  446. RETURN      Go to table position indicated by wave/pulse/filter/vibratopos.
  447. SHIFT+N     Edit instrument name
  448. SHIFT+S     Smart paste an instrument
  449. SHIFT+U     Unlock/lock table scrolling
  450. SHIFT+X,C,V Cut,copy,paste instrument
  451. SHIFT+DEL   (also SHIFT+BACKSPACE) Delete instrument & tabledata
  452. SHIFT+RET.  Set tablepointer to empty position or convert old style vibrato
  453.             parameter
  454.  
  455. The test note will be played on the channel you last were on in the pattern
  456. editor. To hear filtering as intended, be sure to play it on a channel that has
  457. been selected for filtering in the filter parameters.
  458.  
  459. Note that cut,copy,paste instrument do not touch the tabledata, just for the
  460. case you need it in another instrument. If you want to completely get rid of
  461. an instrument + its associated tabledata, press SHIFT+DEL.
  462.  
  463. If wave/pulse/filter/vibrato param. is zero and you press RETURN over
  464. it, you will move to the first free location in the corresponding table. If
  465. you press SHIFT+RETURN, also the instrument parameter will be set accordingly.
  466.  
  467. If vibrato parameter is nonzero and you press SHIFT+RETURN over it, it will
  468. be interpreted as an old style vibrato parameter (left nybble speed, right
  469. nybble depth) and converted to a speedtable entry.
  470.  
  471. "Smart paste" will convert instrument numbers in all patterns if you "move" an
  472. instrument by cut/pasting it.
  473.  
  474. 2.3.5 Table edit mode
  475. ---------------------
  476.  
  477. < >         Select instrument
  478. - +         Select instrument
  479. / *         Select octave
  480. BACKQUOTE   Select table
  481. F7          Go to instrument editor
  482. 0-9 & A-F   Enter parameters
  483. SPACE       Play test note
  484. SHIFT+SPACE Silence test note
  485. RETURN      Go back to wave/pulse/filterpos. parameter
  486. SHIFT+Q,A   Transpose speedtable portamento speed halfstep up/down
  487. SHIFT+W,S   Transpose speedtable portamento speed octave up/down,
  488.             or multiply/divide pulse/filterspeed by 2
  489. SHIFT+L     Convert <limit,speed> modulation step to <time,speed>
  490. SHIFT+N     Negate speed parameter (pulse/filtertable) or relative note
  491.             (wavetable)
  492. SHIFT+O     Optimize current table (remove unused entries)
  493. SHIFT+R     Convert note between absolute/relative in wavetable
  494. SHIFT+U     Unlock/lock table scrolling
  495.  
  496. If you need to insert rows in the beginning of an instrument's wave/pulse/
  497. filtertable, press SHIFT+INS instead of just INS: this way table pointers
  498. pointing to the table first row will not move.
  499.  
  500. For easier programming of negative modulation speeds in pulse/filtertables, you
  501. can first enter a positive speed positive value ($00-$7F) and then press
  502. SHIFT+N to negate it.
  503.  
  504. Conversion between relative and absolute notes will use the basenote C-0 if
  505. octave is 0, C-1 if octave is 1 and so on.
  506.  
  507. When table scrolling is unlocked, each table maintains its separate view
  508. position. To indicate this mode, a "U" letter is visible in the bottom right
  509. part of the screen. By default table scrolling is locked.
  510.  
  511. 2.3.6 Songname edit mode
  512. ------------------------
  513.  
  514. Use cursor UP/DOWN to move between song, author & copyright strings, and
  515. other keys to edit them.
  516.  
  517. 2.4 Mouse control
  518. -----------------
  519.  
  520. By clicking with the left mouse button, you can select the data to edit.
  521.  
  522. By dragging with middle or right mouse button, you can mark orderlist/pattern/
  523. tabledata.
  524.  
  525. Some values like octave or subtune/pattern numbers can be incremented with
  526. the left mouse button and decremented with the right.
  527.  
  528. By holding the middle/right mouse button in the status bar, a menu becomes
  529. active. Continue to hold and click with left button to select options.
  530.  
  531. In the fileselector, confirm loading or entering a directory by double-
  532. clicking. Doubleclick outside the selector to cancel.
  533.  
  534.  
  535. 3. Song data
  536. ------------
  537.  
  538. 3.1 Orderlist data
  539. ------------------
  540.  
  541. A song can consist of up to 32 subtunes. For each subtune's each channel, there
  542. is an orderlist which determines in what order patterns are to be played. In
  543. addition to pattern numbers, there can be TRANSPOSE & REPEAT commands and
  544. finally there is a RST (RESTART) endmark followed by restart position. The
  545. maximum length of an orderlist is 254 pattern numbers/commands + the endmark.
  546.  
  547. TRANSPOSE is measured in halftones. Transpose up (shown as +X) can be 0-14
  548. halftones and transpose down (shown as -X) can be 1-15. Transpose is
  549. automatically reset only when starting the song, not when looping.
  550.  
  551. A REPEAT command (shown as RX) will repeat the pattern following it 1-16 times.
  552. "Repeat 16 times" is displayed as R0.
  553.  
  554. There are some rules for orderlist command order:
  555.  
  556. - If there are both TRANSPOSE and REPEAT commands before a pattern number,
  557.   TRANSPOSE must come first.
  558.  
  559. - The last thing before the RST-endmark must be a pattern number. If you need
  560.   to reset transpose on song repeat, do it in the beginning of the repeat loop.
  561.  
  562. In case of wrong order, the editor will halt playback. This tells that the
  563. resulting packed/relocated song would play incorrectly.
  564.  
  565. 3.2 Pattern data
  566. ----------------
  567.  
  568. Patterns are single-channel only for flexibility & low memory use. They contain
  569. the actual notes, instrument changes & sound commands. A pattern can have
  570. variable length, up to 128 rows. There can be 208 different patterns in a song.
  571.  
  572. The explanation of a pattern row:
  573.  
  574.  Note name
  575.  |
  576.  | Octave
  577.  | |
  578.  | | Instrument number ($01 - $3F, or $00 for no change)
  579.  | | |
  580.  | | |  Command ($0 - $F)
  581.  | | |  |
  582.  | | |  | Databyte
  583.  | | |  | |
  584.  C-1 00 0 00
  585.  
  586. The highest note available in a pattern is G#7. To reach the top three notes
  587. (A-7 to B-7), you can use transpose.
  588.  
  589. In place of a normal note, there can also be one of these special "notes":
  590.  
  591.  ... Rest
  592.  --- Key off (clear gatebit mask)
  593.  +++ Key on (set gatebit mask)
  594.  
  595. The actual state of the gatebit will be the gatebit mask ANDed with data from
  596. the wavetable. A key on cannot set the gatebit if it was explicitly cleared
  597. at the wavetable.
  598.  
  599. Commands 1XY-4XY and FXY bear some resemblance to Soundtracker/Protracker/
  600. Fasttracker effect commands. However, they are different in some ways, so
  601. read their descriptions! Note that there is no "databyte $00 uses the last
  602. databyte"-action in the commands.
  603.  
  604. Command 0XY: Do nothing. Databyte will always be $00.
  605.  
  606. Command 1XY: Portamento up. XY is an index to a 16-bit speed value in the
  607.              speedtable.
  608.  
  609. Command 2XY: Portamento down. XY is an index to a 16-bit speed value in the
  610.              speedtable.
  611.  
  612. Command 3XY: Toneportamento. Raise or lower pitch until target note has been
  613.              reached. XY is an index to a 16-bit speed value in the
  614.              speedtable, or $00 for "tie-note" effect (move pitch instantly to
  615.              target note)
  616.  
  617. Command 4XY: Vibrato. XY is an index to the speed table, where left side
  618.              determines how long until the direction changes (speed)
  619.              and right side determines the amount of pitch change on each tick
  620.              (depth).
  621.  
  622. Command 5XY: Set attack/decay register to value XY.
  623.  
  624. Command 6XY: Set sustain/release register to value XY.
  625.  
  626. Command 7XY: Set waveform register to value XY. If a wavetable is actively
  627.              changing the channel's waveform at the same time, will be
  628.              ineffective.
  629.  
  630. Command 8XY: Set wavetable pointer. $00 stops wavetable execution.
  631.  
  632. Command 9XY: Set pulsetable pointer. $00 stops pulsetable execution.
  633.  
  634. Command AXY: Set filtertable pointer. $00 stops filtertable execution.
  635.  
  636. Command BXY: Set filter control. X is resonance and Y is channel bitmask.
  637.              $00 turns filter off and also stops filtertable execution.
  638.  
  639. Command CXY: Set filter cutoff to XY. Can be ineffective if the filtertable is
  640.              active and also changing the cutoff.
  641.  
  642. Command DXY: Set mastervolume to Y, if X is $0. If X is not $0, value XY is
  643.              copied to the timing mark location, which is playeraddress+$3F.
  644.  
  645. Command EXY: Funktempo. XY is an index to the speedtable, tempo will alternate
  646.              between left side value and right side value on subsequent pattern
  647.              steps. Sets the funktempo active on all channels, but you can use
  648.              the next command to override this per-channel.
  649.  
  650. Command FXY: Set tempo. Values $03-$7F set tempo on all channels, values $83-
  651.              $FF only on current channel (subtract $80 to get actual tempo).
  652.              Tempos $00-$01 recall the funktempo values set by EXY command.
  653.  
  654. Master volume is by default the maximum ($F), but it is only reset when loading
  655. a new song or clearing songdata in the editor, not every time playback starts.
  656. If you change mastervolume, you have to reset it manually in the beginning of
  657. your song.
  658.  
  659. If the command is not 1XY-4XY, instrument vibrato will be active.
  660.  
  661. Note that the one-shot commands 5XY-FXY allow the previous 1XY-4XY command or
  662. instrument vibrato to continue "underneath" them. In section 3.6 (hints & tips)
  663. there is an example of this.
  664.  
  665. 3.3 Instrument data
  666. -------------------
  667.  
  668. You can use up to 63 different instruments in a song. Each instrument is
  669. defined by 9 parameters:
  670.  
  671. Attack/Decay          $0 is fastest attack or decay, $F is slowest
  672.  
  673. Sustain/Release       Sustain level $0 is silent and $F is the loudest. Release
  674.                       behaves like Attack & Decay (F slowest).
  675.  
  676. Wavetable Pos         Wavetable startposition. Value $00 stops the wavetable
  677.                       execution and is not very useful.
  678.  
  679. Pulsetable Pos        Pulsetable startposition. Value $00 will leave pulse
  680.                       execution untouched.
  681.  
  682. Filtertable Pos       Filtertable startposition. Value $00 will leave filter
  683.                       execution untouched. In most cases it makes sense to have
  684.                       a filter-controlling instrument only on one channel at a
  685.                       time.
  686.  
  687. Vibrato Param         Instrument vibrato parameter. An index to the speedtable,
  688.                       see command 4XY.
  689.  
  690. Vibrato Delay         How many ticks until instrument vibrato starts. Value $00
  691.                       turns instrument vibrato off.
  692.  
  693. HR/Gate Timer         How many ticks before note start note fetch, gateoff and
  694.                       hard restart happen. Can be at most tempo-1. So on tempo 4
  695.                       highest acceptable value is 3. Bitvalue $80 disables hard
  696.                       restart and bitvalue $40 disables gateoff.
  697.  
  698. 1stFrame Wave         Waveform used on init frame of the note, usually $09 (gate
  699.                       + testbit). Values $00, $FE and $FF have special meaning:
  700.                       leave waveform unchanged and additionally set gate off
  701.                       ($FE), gate on ($FF), or gate unchanged ($00).
  702.  
  703. In case of illegal (too high) gateoff timer values, the song playback is
  704. stopped.
  705.  
  706. ADSR settings are crucial to getting any sound at all. If all of them are zero
  707. just a very short "click" will be heard. Here is a diagram to help you
  708. visualize the Attack, Decay, Sustain & Release phases:
  709.  
  710.      V      /\            |<- gatebit reset (key-off) at this point
  711.      O     /  \           |
  712.      L    /    \__________|
  713.      U   /                |\
  714.      M  /                 | \
  715.      E /                  |  \
  716. TIME ---------------------------->
  717.          A   D      S       R
  718.  
  719. Some ADSR examples:
  720.  
  721.   A/D 09 Will produce a sound that starts from full volume right away and fades
  722.   S/R 00 to silence automatically. By increasing the Decay value, the fade will
  723.          last longer.
  724.  
  725.   A/D 00 A sound that goes very fast from full volume to sustain level 8.
  726.   S/R 8A If you increase the Decay value, it will go to the sustain level
  727.          slower. After key-off, starts fading out with speed A.
  728.  
  729.   A/D CC A sound that rises slowly to maximum volume, then decays slowly to the
  730.   S/R AF sustain level A and after key-off, fades out to silence very slowly.
  731.  
  732. Instrument legato works as following: When HR/Gate Timer parameter has bit $40
  733. set, no hard restart or gateoff will be performed. When 1st Frame Wave is also
  734. $00, no 1st frame waveform will be set and gate flag is untouched. However wave/
  735. pulse/filterpointers and ADSR are initialized normally. You can also use this in
  736. conjunction with command 8XY to set another wavetable pointer for the note.
  737.  
  738. 3.4 Table data
  739. --------------
  740.  
  741. Tables control the execution of instruments' waveform/arpeggio changes, pulse
  742. modulation, and filter modulation. All the tables are controlled by the left
  743. side bytes, while the right side byte specifies additional parameters.
  744.  
  745. Note that you should never jump directly onto a table jump command (FF) either
  746. with instrument parameters or pattern commands 8XY, 9XY, AXY. Otherwise,
  747. results are undefined.
  748.  
  749. 3.4.1 Wavetable
  750. ---------------
  751.  
  752. Wavetable left side:   00    Leave waveform unchanged
  753.                        01-0F Delay this step by 1-15 frames
  754.                        10-DF Waveform values
  755.                        E0-EF Inaudible waveform values $00-$0F
  756.                        F0-FE Execute command 0XY-EXY. Right side is parameter.
  757.                        FF    Jump. Right side tells position ($00 = stop)
  758.  
  759. Wavetable right side:  00-5F Relative notes
  760.                        60-7F Negative relative notes (lower pitch)
  761.                        80    Keep frequency unchanged
  762.                        81-DF Absolute notes C#0 - B-7
  763.  
  764. Short explanation of waveform bitvalues:
  765. 01 = Gatebit. When on, initiates attack/decay/sustain phase. When off,
  766.      initiates the release phase.
  767. 02 = Synchronize. Creates weird effects using output of another channel
  768. 04 = Ring modulation. Creates weird effects using output of another channel.
  769.      Most effective with the triangle waveform.
  770. 08 = Testbit. Silences sound and resets the oscillator.
  771. 10 = Triangle waveform.
  772. 20 = Sawtooth waveform.
  773. 40 = Pulse waveform.
  774. 80 = Noise waveform.
  775.  
  776. All waveforms except noise can be combined (for example triangle+pulse), but
  777. the effect will be different on 6581 and 8580 SID chips, so use caution.
  778.  
  779. The way how the channels work with synchronize/ringmod:
  780. - When used on channel 1, channel 3's output modulates the sound.
  781. - When used on channel 2, channel 1's output modulates the sound.
  782. - When used on channel 3, channel 2's output modulates the sound.
  783.  
  784. Wavetable delay or no wavechange should not be used in the first step of
  785. instrument wavetable. Otherwise, missing notes may be caused. On the other
  786. hand, if you use 8XY command to jump into a wavetable program, those are
  787. allowed.
  788.  
  789. Using wavetable delay or a wavetable step with no frequency change allows
  790. realtime commands & instrument vibrato to be executed together with wave-
  791. table. Be warned that this has the potential for large rastertime usage!
  792.  
  793. You can execute pattern commands from the wavetable. Right side
  794. is the command parameter. Note that commands 0XY (do nothing), 8XY (set
  795. wavetable pointer) and EXY (funktempo) are illegal and should not be used.
  796. When executing a command, no wave/note will be changed on the same frame.
  797.  
  798. Some examples of wave tables (all examples start on table step 1)
  799.  
  800.   01: 21 00 Sawtooth waveform on note's original pitch.
  801.   02: FF 00
  802.  
  803.   01: 41 00 A flute sound with pulse on the first tick and triangle on all
  804.   02: 11 00 the rest.
  805.   03: FF 00
  806.  
  807.   01: 41 01 A "koto" sound that is one halfstep higher on the first tick and
  808.   02: 40 00 on original pitch the next. Gatebit is also cleared on the second
  809.   03: FF 00 tick.
  810.  
  811.   01: 81 D0 A snaredrum sound, using all absolute notes so it does not depend
  812.   02: 41 AA on which note it's played. Use pulsewidth 800 for best result.
  813.   03: 41 A4
  814.   04: 80 D4
  815.   05: 80 D1
  816.   06: FF 00
  817.  
  818.   01: 81 DF A pulse sound on original pitch, preceded with a short noise (like
  819.   02: 41 00 a hi-hat or something) that has always an absolute pitch of B-7.
  820.   03: FF 00
  821.  
  822.   01: 41 00 A 4-note looping arpeggio sound with pulse waveform. Note that
  823.   02: 00 04 waveform does not change in the looping part.
  824.   03: 00 07
  825.   04: 00 0C
  826.   05: 00 00
  827.   06: FF 02
  828.  
  829.   01: 21 00 A delayed minor chord arpeggio with sawtooth waveform. Each step
  830.   02: 02 03 takes 3 ticks.
  831.   03: 02 07
  832.   04: 02 00
  833.   05: FF 02
  834.  
  835.   01: 41 00 Use pulse first, but then switch between pulse & triangle every 5
  836.   02: 03 80 ticks while frequency remains unchanged (allowing for vibrato &
  837.   03: 11 80 slides).
  838.   04: 03 80
  839.   05: 41 80
  840.   06: FF 02
  841.  
  842.   01: 81 CF Short noise in the beginning, sawtooth, after a short delay change
  843.   02: 21 00 sustain/release (via pattern command 6XY) to $2A.
  844.   03: 08 00
  845.   04: F6 2A
  846.   05: FF 00
  847.  
  848.  
  849. 3.4.2 Pulsetable
  850. ----------------
  851.  
  852. Pulsetable left side:  01-7F Pulse modulation step. Left side indicates time
  853.                              and right side the speed (signed 8-bit value).
  854.                        8X-FX Set pulse width. X is the high 4 bits, right
  855.                              side tells the 8 low bits.
  856.                        FF    Jump. Right side tells position ($00 = stop)
  857.  
  858. Some examples of pulse tables (all examples start on table step 1)
  859.  
  860.   01: 88 00 Set pulse value $800 (middle)
  861.   02: FF 00 Stop pulse execution
  862.  
  863.   01: 80 10 Set pulse value $010 (very thin)
  864.   02: 20 40 For 32 ticks, increase pulse with speed $0040 (64)
  865.   03: 40 E0 For 64 ticks, decrease pulse with speed $FFE0 (-32)
  866.   04: 40 20 For 64 ticks, increase pulse with speed $0020 (32)
  867.   05: FF 03 Jump back to step 03 for a nice loop
  868.  
  869. 3.4.3 Filtertable
  870. -----------------
  871.  
  872. Filtertable left side: 00    Set cutoff, indicated by right side
  873.                        01-7F Filter modulation step. Left side indicates time
  874.                              and right side the speed (signed 8-bit value)
  875.                        80-F0 Set filter parameters. Left side high nybble
  876.                              tells the passband ($90 = lowpass, $A0 = bandpass
  877.                              etc.) and right side tells resonance/channel
  878.                              bitmask, as in command BXY.
  879.                        FF    Jump. Right side tells position ($00 = stop)
  880.  
  881. If "Set filter parameters" is followed by "Set cutoff" directly below, both
  882. will be executed on the same frame.
  883.  
  884. Some examples of filter tables (all examples start on table step 1)
  885.  
  886.   01: 90 F1 Set lowpass, resonance F, channel bitmask 1 (filter channel 1 only)
  887.   02: 00 40 Set cutoff to $40
  888.   03: FF 00 Stop filter execution
  889.  
  890.   01: 80 00 No passband selected, resonance 0, bitmask 0 (no filtered channels)
  891.   02: FF 00 Stop filter execution
  892.  
  893.   01: A0 87 Set bandpass, resonance 8, channel bitmask 7 (filter all channels)
  894.   02: 00 00 Set cutoff to $00
  895.   03: 7F 01 Increase cutoff with speed $01 for 127 ticks
  896.   04: 7F 01 Continue cutoff increase
  897.   05: 7F FF Then decrease back to starting position (speed $FF = -1)...
  898.   06: 7F FF
  899.   07: FF 03 ...and loop back to step 03
  900.  
  901.   01: C0 F2 Set highpass, resonance F, channel bitmask 2 (filter channel 2)
  902.   02: 00 F0 Set cutoff to $F0
  903.   03: 90 F2 On the next frame, change to lowpass...
  904.   04: 00 50 ...and set cutoff $50
  905.   05: FF 00 Stop filter execution
  906.  
  907. Note that the second example could also be achieved simply with pattern command
  908. B00 (set filter control, and stop filter execution, because parameter was $00)
  909.  
  910. 3.4.4 Speedtable
  911. ----------------
  912.  
  913. The speedtable is shared by vibrato, portamento and funktempo. No jump commands
  914. exist.
  915.  
  916. For vibrato:          XX YY Left side tells how long until vibrato direction
  917.                             changes (speed), right side is the value added to
  918.                             pitch each tick (depth).
  919.  
  920. For portamento:       XX YY A 16-bit value added to pitch each tick. Left side
  921.                             is the MSB and the right side the LSB.
  922.  
  923. For funktempo:        XX YY Two 8-bit tempo values that are alternated on each
  924.                             pattern row, starting from the left side.
  925.  
  926. For both vibrato and portamento, if XX has the high bit ($80) set, note 
  927. independent vibrato depth / portamento speed calculation is enabled, and YY
  928. specifies the divisor (higher value -> lower result and more rastertime taken).
  929.  
  930. Vibrato examples:
  931.  
  932.   01: 03 40 Vibrato with speed $03 and depth $40. Corresponds to old vibrato
  933.             parameter $34
  934.   01: 05 04 Speed $05 and depth $04. Slow shallow vibrato, suitable for bass
  935.             notes. Not possible to achieve with old parameters.
  936.   01: 83 04 Speed $03, note-independent depth enabled, depth divisor 4 right-
  937.             shifts (division by 16).
  938.  
  939. Portamento examples:
  940.  
  941.   01: 00 20 Portamento with speed $0020, corresponds to old parameter $08
  942.             (4 * $08 = $0020).
  943.   01: 01 00 Portamento with speed $0100, corresponds to old parameter $40
  944.             (4 * $40 = $0100).
  945.   01: 4F FF Portamento with speed $4fff, loops the pitch highbyte very fast
  946.             so that a SEUCK-like "space" effect is heard. Not possible to
  947.             achieve with old parameters.
  948.   01: 80 01 Note-independent speed enabled, speed divisor 1 rightshift
  949.             (division by 2).
  950.  
  951. Funktempo examples:
  952.  
  953.   01: 09 06 Play tempo $09 on even pattern steps and $06 on odd steps,
  954.             corresponds to old parameter $96.
  955.  
  956.   01: 24 18 The same funktempo adjusted for 4x-multispeed. Not possible to
  957.             achieve with old parameters.
  958.  
  959. Note that you can enter old style vibrato parameters, portamento speeds and
  960. funktempo to patterns & instruments, and when cursor is over the parameter,
  961. press SHIFT+RETURN to create a new speedtable entry corresponding to that
  962. parameter. The parameter will now be overwritten by a speedtable pointer.
  963.  
  964.  
  965. 3.5 Playback details
  966. --------------------
  967.  
  968. Each pattern row is divided into as many 50Hz/60Hz "ticks" as the tempo
  969. indicates. Some ticks are reserved for special actions, and to conserve raster-
  970. time, certain realtime effects/commands (pulse, vibrato, portamento) are
  971. skipped at the same time. Let's assume a tempo of 6 and gateoff timer value 2
  972. and look at what happens on each tick:
  973.  
  974. Tick    Actions
  975. 0       - Initialization of new notes (no audible sound yet)
  976.         - Orderlist advance if necessary
  977.         - Pulsetable execution only if no orderlist advance
  978.         - Wavetable execution
  979.         - "One-shot" commands 5XY-FXY
  980.  
  981. 1       - New notes become audible
  982.         - Pulsetable execution
  983.         - Wavetable or realtime pattern commands 1XY-4XY
  984.  
  985. 2,3     - Pulsetable execution
  986.         - Wavetable or realtime pattern commands 1XY-4XY
  987.  
  988. 4       - New notes fetched from the pattern
  989.         - Gateoff and hard restart for new notes
  990.           (2 ticks before first frame, as gateoff timer indicates)
  991.         - No pulsetable execution
  992.         - Wavetable or realtime pattern commands 1XY-4XY
  993.  
  994. 5       - Pulsetable execution
  995.         - Wavetable or realtime pattern commands 1XY-4XY
  996.  
  997. Filtertable is executed on each tick regardless of what the channels are doing.
  998. Wavetable is never skipped, so arpeggios/drumsounds should always play OK.
  999.  
  1000. With the commandline parameter /O0 (or by clicking the "PO" text on the status
  1001. bar) you can disable pulse skipping. This leads to increased rastertime use but
  1002. can be good for example with tempo 3 tunes.
  1003.  
  1004. Likewise, with the commandline parameter /R0 (or by clicking the "RO" text on
  1005. the status bar) you can disable realtime pattern command skipping on tick 0.
  1006.  
  1007. 3.6 Miscellaneous tips
  1008. ----------------------
  1009.  
  1010. - Patterns will take less memory the less there are command changes. When the
  1011.   song is packed/relocated, for example a long vibrato or portamento command
  1012.   needs to be stored only once as long as the parameter stays the same on
  1013.   subsequent pattern rows.
  1014.  
  1015. - Using instrument vibrato can make 4XY commands unnecessary and save even
  1016.   more memory. Use realtime calculated note-independent speed (see speedtable
  1017.   section) if you want the vibrato to have the same magnitude regardless of 
  1018.   the note.
  1019.  
  1020. - In the instrument parameters, there is no option to stop pulse execution
  1021.   directly. So if you have for example a sawtooth instrument, there might be
  1022.   an "unnecessary" pulsemodulation going on underneath and wasting rastertime.
  1023.   There are two ways you can stop this:
  1024.   1) Make a short pulseprogram like this and use it in the instrument:
  1025.      01: 80 00 Set pulse $000
  1026.      02: FF 00 Stop pulse execution
  1027.   2) Use pattern command 900 to stop pulse execution
  1028.  
  1029. - If you have a realtime command (vibrato/portamento), you can put "one-shot"
  1030.   commands 5XY-FXY inbetween and the realtime command will be unaffected. An
  1031.   example:
  1032.  
  1033.   C-4 01000
  1034.   --- 00401 Begin vibrato with speedtable index $01
  1035.   --- 00401
  1036.   --- 00401
  1037.   --- 0065A Set sustain/release to $5A. Vibrato executes also on this step!
  1038.   --- 00401 Continue vibrato normally
  1039.   --- 00401
  1040.  
  1041.   However, the vibrato would stop immediately if command 0 was encountered.
  1042.  
  1043. - Normally tempo 3 is the fastest you can use. However, by using the funktempo
  1044.   command you can get tempo 2. To do this, create a following speedtable entry:
  1045.   02 02, and point your funktempo command to it. You also need to use gateoff
  1046.   timer 1 in all instruments and disable the pulse-optimization skipping.
  1047.  
  1048. - For very optimized songdata & player you can refrain from using any pattern
  1049.   commands and rely on the instruments' step-programming. Even in this case, you
  1050.   can set song startup default tempo with the Attack/Decay parameter of the last
  1051.   instrument (63), if you otherwise leave this instrument unused.
  1052.  
  1053. 3.6.1 Limit-based modulation steps
  1054. ----------------------------------
  1055.  
  1056. You can enter pulse/filter modulation steps in limit-based format, and convert
  1057. them to time-based with SHIFT+L. For example, you could enter the following in
  1058. the pulsetable:
  1059.  
  1060.   01: 84 00 Set initial pulse to $400
  1061.   02: C0 10 Modulate pulse to $C00 with speed $0010
  1062.   03: 40 10 Modulate pulse back to $400 with speed $0010
  1063.  
  1064. Now position the cursor on step 02 and press SHIFT+L twice, to convert both of
  1065. the modulation steps to usual time-based steps. If necessary, the steps will
  1066. be expanded to several (if the resulting time parameter is over $7F.)
  1067.  
  1068. Remember that the player only understands time-based steps and you always have
  1069. to convert limit-based steps before they play correctly!
  1070.  
  1071. 3.6.2 Precalculated note-independent "hifi player" portamento/vibrato
  1072. ---------------------------------------------------------------------
  1073.  
  1074. From v2.62 onwards, GoatTracker actually supports realtime calculated note 
  1075. independent portamento and vibrato speeds, see speedtable section for this. 
  1076. However, this makes the player bigger and much slower. You can still also use 
  1077. the old method of manually precalculating needed note-independent speeds with 
  1078. the SHIFT+H function, which this section is about.
  1079.  
  1080. The idea is to take the frequency difference between 2 adjacent notes in
  1081. the frequency table and manipulate it by bit shifting left (multiply) or
  1082. right (divide).
  1083.  
  1084. To use, you need a portamento or vibrato command in the pattern, and the note
  1085. you wish to base the calculation on on the current pattern step or before it
  1086. (before it only for toneportamento) The amount of shift is determined by the
  1087. command parameter. A number in the left nybble means shift left and right
  1088. nybble right shift. When you press Shift+H while the cursor is on the command,
  1089. a speedtable entry is created, and the parameter is replaced with a speedtable
  1090. index.
  1091.  
  1092. Some examples:
  1093.  
  1094.   C-3 00110 Take the frequency difference between C-3 & C#3 and shift it left
  1095.             1 times (multiply by 2.)
  1096.  
  1097.   E-4 00000
  1098.   ... 00000
  1099.   G-4 00302 Take the frequency difference between E-4 & F-4 and shift it right
  1100.             2 times (divide by 4.)
  1101.  
  1102. 3.7 Multispeed tips
  1103. -------------------
  1104.  
  1105. - When making multispeed songs, remember to multiply your tempos and also the
  1106.   gateoff timer values! For example, gateoff timer is normally 2, but in a 2X-
  1107.   speed tune the same gateoff length would be achieved with value 4.
  1108.  
  1109. - If you want to keep vibrato the same compared to 1X-speed, you must multiply
  1110.   vibrato speed by the speed multiplier, and divide vibrato depth by the
  1111.   multiplier. Remember also to divide portamento and pulse/filter modulation
  1112.   speeds as necessary.
  1113.  
  1114. - When importing a v1.xx multispeed song, you also need to multiply the
  1115.   gateoff timers.
  1116.  
  1117. - In the instruments, using Attack 0 might result in a very silent first row of
  1118.   the wavetable. You could try increasing the attack, or adding one or more
  1119.   rows of E9 00 (testbit+gate) to the beginning of the wavetable.
  1120.  
  1121.  
  1122. 4. Using the included utilities
  1123. -------------------------------
  1124.  
  1125. 4.1 INS2SND2.EXE
  1126. ---------------
  1127.  
  1128. INS2SND2.EXE converts GoatTracker v1.xx or v2 instruments (.INS-files) into
  1129. sound effects, outputting the data as source code or binary.
  1130.  
  1131. Usage: INS2SND <instrumentfile> <sourcecodefile> <options>
  1132. Options:
  1133. -b output in binary
  1134. -c output in CovertScript format (deprecated)
  1135.  
  1136. Default output is C64 assembler (DASM) style source code
  1137.  
  1138. Look at section 6.3 or run the program without parameters to see the
  1139. limitations of the sound effect system.
  1140.  
  1141. 4.2 SNGSPLI2.EXE
  1142. ----------------
  1143.  
  1144. SNGSPLI2.EXE splits the patterns of a GoatTracker v2 song into smaller pieces
  1145. for memory use optimization. It is comfortable to compose with large patterns
  1146. but usually more efficient memory-wise to use small patterns. Remember! Always
  1147. keep the original song because a pattern-splitted song is much harder to edit
  1148. further.
  1149.  
  1150. Usage: SNGSPLI2 <source> <destination> [target len]
  1151.  
  1152. For example, if a pattern is 64 rows long and the target length is 16, it will
  1153. be split into 4 pieces. A pattern that falls below 2 x target length, will not
  1154. be split at all.
  1155.  
  1156. 4.3 MOD2SNG.EXE
  1157. ---------------
  1158.  
  1159. Dedicated exclusively to T.M.R, this program converts the pattern & orderlist
  1160. data of 4-channel, 31-instrument MOD-files into GoatTracker .SNG files. You
  1161. must choose one channel to leave out, and obviously instruments are not
  1162. converted, except for their names. You can also specify a transpose in
  1163. halfsteps.
  1164.  
  1165. Usage: MOD2SNG <mod> <sng> [channel] [transpose]
  1166.        [channel] is the channel to leave out (1-4), default 4
  1167.        [transpose] is the halfstep transpose added to notes, default 0
  1168.  
  1169. 4.4 BETACONV.EXE
  1170. ----------------
  1171.  
  1172. Converts GT v2 beta songs to new format used by GT v2 RC1 onwards. Old format
  1173. had 47 instruments max. and new has 63 max. Additionally, depending on what
  1174. beta version you used, you can choose to halve vibrato depths and pulse speeds
  1175. to make them play correct in the current version. Warning: the conversion is
  1176. irreversible, so have backups if you overwrite the old versions.
  1177.  
  1178. Usage: BETACONV <source> <destination> [vibdepth] [pulse]
  1179.        [vibdepth] decides whether to halve vibdepth (1=yes 0=no), default 0
  1180.        [pulse] decides whether to halve pulse speed (1=yes 0=no), default 0
  1181.  
  1182.  
  1183. 5. Using the songs outside the editor
  1184. -------------------------------------
  1185.  
  1186. Press F9 in the editor to enter the packer/relocator. Choose playroutine
  1187. options, startaddress, zeropage address (need 2 consecutive locations) and file
  1188. format (PRG/BIN/SID), then type the filename.
  1189.  
  1190. If you use patterns longer than 64 rows, there is the possibility that
  1191. relocation fails because of too complex patterns. Each pattern row can be 0-4
  1192. bytes packed, and the total amount of bytes per one pattern may not exceed 256.
  1193.  
  1194. If wave/pulse/filtertables overflow past row 255 without a jump command or there
  1195. are other serious errors, you get a warning screen and have to fix the error.
  1196.  
  1197. The relocator optimizes & removes when saving:
  1198. - Unused patterns
  1199. - Unused instruments
  1200. - Unused table-entries
  1201. - Selfcontained (ie. no jumps to/from outside) duplicate parts of tables
  1202. - Player code not needed in the playback of the song
  1203.  
  1204. Look at /examples/example1.prg - example4.prg to get an idea how much these
  1205. playroutines take rastertime. No promises!
  1206.  
  1207. The basic functions independent of playroutine options are:
  1208.  
  1209. Init music:
  1210.  
  1211.         LDA #subtunenumber       ;Starting from 0
  1212.         JSR startaddress
  1213.  
  1214. Play one frame of music:
  1215.  
  1216.         JSR startaddress+3
  1217.  
  1218. 5.1 Playroutine options
  1219. -----------------------
  1220.  
  1221. BUFFERED SID-WRITES - Instead of writing each SID value as soon as possible,
  1222. waits for the end of the channel's execution on each frame and then writes the
  1223. registers in one go. Improves sound stability but takes more memory & raster-
  1224. time.
  1225.  
  1226. SOUND EFFECT SUPPORT - Adds a sound effect engine for use in games. Implies
  1227. buffered writes. To use, call in the following way:
  1228.  
  1229.         LDA #<effect        ;Start address of sound effect data
  1230.         LDY #>effect
  1231.         LDX #channel        ;0, 7 or 14 for channels 1-3
  1232.         JSR startaddress+6
  1233.  
  1234. The sound effects have a hardcoded priority system based on their start
  1235. addresses. A sound higher up in memory (bigger address) will never be
  1236. interrupted with a sound lower in memory.
  1237.  
  1238. VOLUME CHANGE SUPPORT - Adds a routine in the player's jumptable to change the
  1239. master volume level. To use, call in the following way:
  1240.  
  1241.         LDA #volume        ;0-15
  1242.         JSR startaddress+6 ;(startaddress+9 with sound effect support)
  1243.  
  1244. Note that the master volume command (DXY) also modifies this same location,
  1245. so it will clash if you also change the volume manually.
  1246.  
  1247. STORE AUTHOR-INFO - Writes the "AUTHOR" string from songname editor to the
  1248. location range (startaddress+$20 - startaddress+$3F). Also enables timing mark
  1249. support. A timing mark is a mastervolume command (DXY) with parameter $10-$FF.
  1250. This parameter will be copied into startaddress+$3F when the command is
  1251. encountered in playback.
  1252.  
  1253. USE ZEROPAGE GHOSTREGS - Instead of writing to the SID, a memory range in the
  1254. zeropage is used for holding the SID register data. This can then be copied
  1255. in the main program to the SID, for example to enable the playroutine & music
  1256. data to reside under the I/O area. Implies buffered writes. A reverse copy loop
  1257. should be used after each call to the playroutine:
  1258.  
  1259.         LDX #$18
  1260. copy:   LDA ghostregs,x
  1261.         STA $D400,x
  1262.         DEX
  1263.         BPL copy
  1264.  
  1265. The copy loop can also be unrolled for more speed.
  1266.  
  1267. Note that when you use the alternative hardrestart method & playroutine (hard-
  1268. restart attack parameter F) the copy loop should not be in reverse order but
  1269. should be for each channel: wave, frequency, pulsewidth, and ADSR last.
  1270.  
  1271. If you are using both sound effect support and ghostregisters, there exists
  1272. a possibility of sound errors in the case that a sound effect has finished,
  1273. and the same channel starts a new pulse-waveform note without setting an
  1274. initial pulsewidth value (for example, like in the beginning of Sanxion loader
  1275. tune). This is because the ghostregisters are shared between music & sound
  1276. effect playback, and the sound effect has already overwritten the previous
  1277. pulse width.
  1278.  
  1279. DISABLE OPTIMIZATIONS - The relocator removes saved playroutine code based on
  1280. what effects & commands the song uses, resulting in a smaller playroutine
  1281. accordingly. If you encounter anomalies in the sound (such as ADSR bugs caused
  1282. by unpredictable timing variation) you can try disabling the optimizations.
  1283. Normally this is not necessary, but is included just in case.
  1284.  
  1285.  
  1286. 6. File/data formats description
  1287. --------------------------------
  1288.  
  1289. The sections in the files appear in the sequential order in which they are
  1290. described.
  1291.  
  1292. 6.1 GoatTracker v2 song (.SNG) format
  1293. -------------------------------------
  1294.  
  1295. 6.1.1 Song header
  1296. -----------------
  1297.  
  1298. Offset  Size    Description
  1299. +0      4       Identification string GTS5
  1300. +4      32      Song name, padded with zeros
  1301. +36     32      Author name, padded with zeros
  1302. +68     32      Copyright string, padded with zeros
  1303. +100    byte    Number of subtunes
  1304.  
  1305. 6.1.2 Song orderlists
  1306. ---------------------
  1307.  
  1308. The orderlist structure repeats first for channels 1,2,3 of first subtune,
  1309. then for channels 1,2,3 of second subtune etc., until all subtunes
  1310. have been gone thru.
  1311.  
  1312. Offset  Size    Description
  1313. +0      byte    Length of this channel's orderlist n, not counting restart pos.
  1314. +1      n+1     The orderlist data:
  1315.                 Values $00-$CF are pattern numbers
  1316.                 Values $D0-$DF are repeat commands
  1317.                 Values $E0-$FE are transpose commands
  1318.                 Value $FF is the RST endmark, followed by a byte that indicates
  1319.                 the restart position
  1320.  
  1321. 6.1.3 Instruments
  1322. -----------------
  1323.  
  1324. Offset  Size    Description
  1325. +0      byte    Amount of instruments n
  1326.  
  1327. Then, this structure repeats n times for each instrument. Instrument 0 (the
  1328. empty instrument) is not stored.
  1329.  
  1330. Offset  Size    Description
  1331. +0      byte    Attack/Decay
  1332. +1      byte    Sustain/Release
  1333. +2      byte    Wavepointer
  1334. +3      byte    Pulsepointer
  1335. +4      byte    Filterpointer
  1336. +5      byte    Vibrato param. (speedtable pointer)
  1337. +6      byte    Vibraro delay
  1338. +7      byte    Gateoff timer
  1339. +8      byte    Hard restart/1st frame waveform
  1340. +9      16      Instrument name
  1341.  
  1342. 6.1.4 Tables
  1343. ------------
  1344.  
  1345. This structure repeats for each of the 4 tables (wavetable, pulsetable,
  1346. filtertable, speedtable).
  1347.  
  1348. Offset  Size    Description
  1349. +0      byte    Amount n of rows in the table
  1350. +1      n       Left side of the table
  1351. +1+n    n       Right side of the table
  1352.  
  1353. 6.1.5 Patterns header
  1354. ---------------------
  1355.  
  1356. Offset  Size    Description
  1357. +0      byte    Number of patterns n
  1358.  
  1359. 6.1.6 Patterns
  1360. --------------
  1361.  
  1362. Repeat n times, starting from pattern number 0.
  1363.  
  1364. Offset  Size    Description
  1365. +0      byte    Length of pattern in rows m
  1366. +1      m*4     Groups of 4 bytes for each row of the pattern:
  1367.                 1st byte: Notenumber
  1368.                           Values $60-$BC are the notes C-0 - G#7
  1369.                           Value $BD is rest
  1370.                           Value $BE is keyoff
  1371.                           Value $BF is keyon
  1372.                           Value $FF is pattern end
  1373.                 2nd byte: Instrument number ($00-$3F)
  1374.                 3rd byte: Command ($00-$0F)
  1375.                 4th byte: Command databyte
  1376.  
  1377. 6.2 GoatTracker v2 instrument (.INS) format
  1378. -------------------------------------------
  1379.  
  1380. Offset  Size    Description
  1381. +0      4       Identification string GTI5
  1382. +4      byte    Attack/Decay
  1383. +5      byte    Sustain/Release
  1384. +6      byte    Wavepointer
  1385. +7      byte    Pulsepointer
  1386. +8      byte    Filterpointer
  1387. +9      byte    Vibrato param. (speedtable pointer)
  1388. +10     byte    Vibrato delay
  1389. +11     byte    Gateoff timer
  1390. +12     byte    Hard restart/1st frame waveform
  1391. +13     16      Instrument name
  1392.  
  1393. After the instrument data, this structure repeats for each of the 4 tables
  1394. (wavetable, pulsetable, filtertable, speedtable).
  1395.  
  1396. Offset  Size    Description
  1397. +0      byte    Amount n of rows in the table
  1398. +1      n       Left side of the table
  1399. +1+n    n       Right side of the table
  1400.  
  1401. Note that the tables are a partial snapshot of the current song the instrument
  1402. was saved from, so upon loading they have to be relocated to the current free
  1403. table locations.
  1404.  
  1405. 6.3 Sound effect data format
  1406. ----------------------------
  1407.  
  1408. Offset  Size    Description
  1409. +0      byte    Attack/Decay
  1410. +1      byte    Sustain/Release
  1411. +2      byte    Pulse width. This value has nybbles reversed from what it looks
  1412.                 like in the editor so a middle pulse $800 will be stored as $08,
  1413.                 and the sound effect routine will put this value to both $D402
  1414.                 and $D403 registers.
  1415. +3      ?       Wavetable. Contains note/waveform pairs (different order than
  1416.                 in instrument wavetable), from which the waveform can be
  1417.                 omitted if unchanged, as the value ranges do not overlap:
  1418.                         Value $00 ends the sound effect
  1419.                         Values $01-$81 are waveforms
  1420.                         Values $82-$DF are absolute notes D-0 - B-7
  1421.                 Note that a note cannot be omitted to store only waveform
  1422.                 changes!
  1423.  
  1424. As you can see, the sound effect format is very simplistic. When converting an
  1425. instrument to a sound effect with INS2SND2, following things cause an error
  1426. message:
  1427.  
  1428. - If the resulting sound effect is more than 128 bytes
  1429. - If the instrument's wavetable contains relative notes, absolute notes C-0 or
  1430.   C#0, or waveforms > 129 ($81)
  1431.  
  1432. The instrument's pulsewidth modulation & filter settings will be completely
  1433. discarded.
  1434.  
  1435.  
  1436. 7. Recompiling
  1437. --------------
  1438.  
  1439. To recompile for Win32, you need the MinGW development enviroment, use the
  1440. file src/makefile.win as makefile.
  1441.  
  1442. To recompile for Linux, use src/makefile.
  1443.  
  1444. In both cases you need the SDL development libraries in addition to the SDL
  1445. runtime, see http://www.libsdl.org.
  1446.  
  1447. Compile first the utilities (datafile & dat2inc) from the src/bme directory,
  1448. and place them to your path.
  1449.  
  1450.  
  1451. 8. Version history
  1452. ------------------
  1453.  
  1454. v2.0Beta  - Original public release
  1455.  
  1456. v2.0      - Fixed crash in DMC-note entry mode.
  1457.           - Fixed v1.xx import pulse conversion, a case where pulse startpos
  1458.             was lower than the pulse low limit was not converted right.
  1459.           - Fixed instrument gatetimer becoming zero (can lead to tempo bugs)
  1460.             when cutting an instrument (SHIFT+X)
  1461.           - Fixed order of SID writes to make editor & C64 playroutine behave
  1462.             as similarly as possible.
  1463.           - Fixed removal of table-entries (when loading an instrument) in
  1464.             case another instrument uses them too.
  1465.           - Fixed toneportamento (3XY) with wavetable delays.
  1466.           - Fixed funktempo in packed/relocated songs.
  1467.           - Fixed behaviour of + & - keys while editing instrument name.
  1468.           - Fixed pattern editor transpose functions.
  1469.           - Added SHIFT+DEL to delete an instrument + its tabledata.
  1470.           - Added SHIFT+INS to insert rows on table first row without having to
  1471.             adjust tablepointers afterwards.
  1472.           - Added SHIFT+W,S for octave transpose.
  1473.           - Added SHIFT+1,2,3 to swap orderlists between channels.
  1474.           - Added SHIFT+BACKSPACE to clear a whole pattern row.
  1475.           - Added optimized playroutines, that will be used if all instruments
  1476.             have the same gateoff timer & 1st wave parameters.
  1477.           - Added duplicate check for v1.xx pulse conversion.
  1478.           - Added BETACONV-utility for conversion from beta format.
  1479.           - Added reSID interpolation option /I.
  1480.           - Added hexadecimal pattern row display option /D.
  1481.           - Added SID memory location parameter /L.
  1482.           - reSID interpolation is on by default.
  1483.           - Changed appearance of pattern special notes (rest, keyoff/on)
  1484.           - Increased amount of instruments to 63 and changed song dataformat.
  1485.           - v1.xx import converts arpeggios to instruments as long as there is
  1486.             room.
  1487.           - Vibrato depth changed back to same as in v1.xx.
  1488.           - Pulse modulation speeds are doubled.
  1489.           - Upon startup, songdata erase, or importing v1.xx data, gatetimer
  1490.             will be set to 2 * multiplier as opposed to just 2.
  1491.           - Optimized size & speed of all playroutines (initialization,
  1492.             checking for new note fetch, pulsetable execution).
  1493.           - Wavetable delay or no-wavechange on first step of instrument is
  1494.             definitely unsupported now! Protection to allow this conflicted
  1495.             with 3XY command.
  1496.  
  1497. v2.01     - Added under-IO gamemusic playroutine.
  1498.  
  1499. v2.02     - Added RETURN when instrument tableparameter (wave/pulse/filter) is
  1500.             0 to get you to the first free table location. SHIFT+RETURN will
  1501.             additionally also set the instrument tableparameter.
  1502.           - Added "set mastervolume"-jump to gamemusic routines.
  1503.           - Improved sound effect handling, when an effect is interrupted by
  1504.             another (less silence between sounds).
  1505.  
  1506. v2.03     - Added execution of realtime commands & instrument vibrato during
  1507.             wavetable delay.
  1508.           - Added wavetable right side value $80 to keep frequency unchanged
  1509.             (as a consequence, the note C-0 will cause the same effect).
  1510.           - Added relocator optimizations: all unnecessary data is stripped
  1511.             when packing/relocating.
  1512.           - Playroutines size-optimized.
  1513.           - Explanation of how different gatetimer values can lead to playback
  1514.             going out of sync (section 3.3).
  1515.           - reSID interpolation is no longer on by default :)
  1516.  
  1517. v2.04     - Added a questionable 25Hz mode (/S0)
  1518.           - Execution of commands on wavetable delay is completely reworked
  1519.             and more consistent now.
  1520.           - Note C-0 is usable again.
  1521.  
  1522. v2.05     - Added instrument legato feature (Hardres/1stwave parameter $00).
  1523.           - ADSR writes moved farther away from wave writes in the standard
  1524.             playroutine noteinit, lessening possibility of ADSR bugs.
  1525.           - Song initialization and pulsetable execution speed/sizeoptimized.
  1526.  
  1527. v2.06     - Packer/relocator tolerates up to 256 bytes long patterns now.
  1528.           - Optimized playroutine sizes.
  1529.  
  1530. v2.07     - Fixed transpose reset with F2/F3 song start (should not happen).
  1531.           - Fixed varying tempo on channels with F2/F3 song start.
  1532.           - Added warning screen to packer/relocator if table execution
  1533.             overflows.
  1534.           - Added writing of PAL/NTSC and 6581/8580 flags according to PSID V2
  1535.             NG specification.
  1536.           - -mwindows added to linker options for no displaying of DOS prompt
  1537.             window (in win32 version).
  1538.  
  1539. v2.08     - Added finevibrato mode (/V command line option).
  1540.           - Optimized playroutine sizes & speed.
  1541.  
  1542. v2.09     - Fixed max.pattern length in Clear Musicdata operation.
  1543.           - Added Minimal playroutine.
  1544.           - First wave value $80 also acts as a proper legato instrument now.
  1545.           - Optimized playroutine sizes & speed.
  1546.           - SID chip type & timing (PAL/NTSC) displayed on top row.
  1547.  
  1548. v2.1      - Added SHIFT+N for negating pulse/filter modulation speeds.
  1549.           - Added no-funktempo & no-octave0 optimizations to playroutines (a
  1550.             total of 8 sub-types for each playroutine).
  1551.           - Maximum speed is 16X now.
  1552.           - Separate song/instrument/packed song directories are remembered
  1553.             during session.
  1554.           - Pathname is displayed in the fileselector.
  1555.           - Filters ** and *.* display all files in the fileselector.
  1556.           - Song entered on commandline will be loaded at startup.
  1557.           - Song filename currently being edited is shown in the titlebar.
  1558.           - Currently edited song filename will be used as default in the
  1559.             "SAVE SONG" and "SAVE MUSIC+PLAYROUTINE" dialogs.
  1560.           - Instrument name will also be used as instrument filename as default
  1561.             in the "SAVE INSTRUMENT" dialog.
  1562.           - UPX used for compression of win32 executables.
  1563.           - Included a short reference of waveform bits (manual only).
  1564.           - Configuration file has clearer structure.
  1565.  
  1566. v2.11     - Added SHIFT+S for smart instrument paste (converts instrument
  1567.             numbers in all patterns, after cut/pasting an instrument).
  1568.           - Added SHIFT+L which allows to write <limit,speed> pulse/filter
  1569.             modulation steps and then convert them to the proper <time,speed>
  1570.             format.
  1571.  
  1572. v2.12     - Playroutine 1 has buffered SID-writes.
  1573.           - Octave 0 is not disabled in routines with sound FX (no matter what
  1574.             the relocator says...)
  1575.  
  1576. v2.13     - Standard playroutine now both in unbuffered and buffered flavors.
  1577.  
  1578. v2.15     - Added SHIFT+I for inverting current pattern selection / whole
  1579.             pattern.
  1580.  
  1581. v2.16     - Fixed octave selection with / * for laptop keyboards.
  1582.           - Empty patterns referenced in the orderlist will be saved when
  1583.             saving a song.
  1584.           - Save dialog will reappear if writing the song/instrument/executable
  1585.             music failed.
  1586.           - Optimized handling of "packed rests" in the playroutines.
  1587.           - Added < > for instrument selection in instrument/table edit modes.
  1588.  
  1589. v2.17     - Fixed initialization of instrument vibrato.
  1590.           - Playroutines size-optimized.
  1591.  
  1592. v2.18     - Wavetable left side values changed. Delay is now $01-$0F and
  1593.             inaudible waveforms (register values $00-$0F) have been mapped to
  1594.             table values $E0-$EF. Old songs using values $08-$0F have to be
  1595.             manually converted!
  1596.  
  1597. v2.2      - Added the speedtable for more precise control of vibrato,
  1598.             portamento and funktempo.
  1599.           - Added SHIFT+O to optimize the speedtable (remove unused entries).
  1600.           - Added SHIFT+R to convert between absolute/relative notes in
  1601.             the wavetable.
  1602.           - Added SHIFT+RETURN in pattern/instrument editor to convert old
  1603.             style portamento, vibrato and funktempo parameters to speedtable
  1604.             entries.
  1605.           - SHIFT+R will paste several effect rows if there is data in pattern
  1606.             copybuffer.
  1607.           - Editing during Follow Play is possible.
  1608.           - Song and instrument format modified for 4 tables. Old 3-table
  1609.             data will be loaded but not saved anymore.
  1610.  
  1611. v2.21     - Fixed NTSC CIA timer value for SID files.
  1612.           - Shift+E will copy several effect rows if pattern has been marked.
  1613.  
  1614. v2.22     - Shift+N will also negate relative wavetable notes.
  1615.           - When converting oldstyle parameters to speedtable entries with
  1616.             SHIFT+RETURN, the speedtable view will shift to the new entry if
  1617.             one was created.
  1618.  
  1619. v2.23     - Fixed SHIFT+INS in wavetable (inserts $E9 $00 now as it should).
  1620.           - Added SHIFT+U to unlock table scrolling.
  1621.           - Added SHIFT+F5/F6 to change speed multiplier.
  1622.  
  1623. v2.24     - Added SHIFT+F7 to edit the hardrestart ADSR parameter.
  1624.           - Added SHIFT+F8 to switch between 6581 and 8580 SID models.
  1625.  
  1626. v2.25     - Added detail to table overflow error message in relocator.
  1627.           - Added stop of playback if a tablepointer gets pointed directly to a
  1628.             jump (would bug in packed/relocated tune).
  1629.           - Added relocator error message for the above case.
  1630.           - Added relocator error message for illegal song restart position.
  1631.           - Not possible to save erroneous packed/relocated songs anymore
  1632.             (now that there is adequate error location).
  1633.           - Added SHIFT+,. to move song startposition on all channels and
  1634.             restart last playmode.
  1635.  
  1636. v2.26     - Fixed relocator complaining of FF parameter in speedtable.
  1637.           - To increase stability, in multispeed mode relocator does not use the
  1638.             "same gatetimer/1st wave" optimization.
  1639.           - Changed Shift+O to optimize the currently edited table, not just
  1640.             speedtable.
  1641.           - Added an option to optimize everything with the SHIFT+ESC clear
  1642.             function. This clears unused patterns, instruments and table-entries.
  1643.  
  1644. v2.27     - Fixed optimize function with different pattern lengths.
  1645.           - Added marking & copy/pasting orderlist data like patterns & tables.
  1646.  
  1647. v2.28     - Added sort of mouse control.
  1648.           - Sound reinitialization when changing multiplier or other parameters
  1649.             is now faster.
  1650.  
  1651. v2.29Beta - Internal reorganization.
  1652.           - New assembler-based relocator that leaves out unused portions of
  1653.             player code.
  1654.           - Instead of choosing a player version, one can choose combinations
  1655.             of player features.
  1656.           - Relocator does not save selfcontained duplicate parts of tables.
  1657.           - Added keys 0-9 & A-Z in the fileselector to move to the
  1658.             corresponding part of the filelist (if found).
  1659.           - Added SHIFT+H to calculate left/right shifted "hifi" speedtable
  1660.             values, according to the frequency of a note.
  1661.  
  1662. v2.3      - Fixed songdata optimize function.
  1663.           - Fixed relocator with no-hardrestart instrument in slot 1.
  1664.           - Fixed relocator handling of effect C (Set cutoff).
  1665.  
  1666. v2.31     - Fixed effect copy/paste.
  1667.           - Added possibility to disable pulseskipping with /O command line
  1668.             option. Warning: causes huge rastertime increase.
  1669.           - Tempo 2 is allowed. See the tips section (3.6) for details.
  1670.  
  1671. v2.32     - Maximum pattern length increased to 128. Do not complain of
  1672.             "pattern too complex" errors :)
  1673.           - Optimized playroutine init in case of only 1 subtune.
  1674.  
  1675. v2.33     - Fixed a bug where relocator was checking pattern 208 (illegal).
  1676.           - Optimized playroutine in case there is no keyoff/keyon used.
  1677.           - Optimized playroutine in case there are no pattern effects used.
  1678.           - Optimized playroutine channel variables in case there is no
  1679.             transpose, repeat, wavedelay and pattern effects.
  1680.           - If not using the last instrument (63), you can control song
  1681.             startup default tempo by using its Attack/Decay parameter.
  1682.  
  1683. v2.34     - Added relocator optimization for using 1 or 2 channels only. To
  1684.             enable, you must use only channels 1 or 1,2 and not be using sound
  1685.             effect support or zeropage ghostregs.
  1686.           - Turning off buffered writes in relocator options works now even
  1687.             if sound effects or zeropage ghostregs are selected (they will be
  1688.             turned off too).
  1689.  
  1690. v2.35     - Auto-creation of speedtable entries will always generate a new
  1691.             entry (except for song loading), duplicate values will be optimized
  1692.             by the relocator.
  1693.           - Pressing SHIFT+RETURN over a speedtable-using pattern command while
  1694.             the parameter is zero, goes to the next empty speedtable entry and
  1695.             sets the command parameter to point to that entry.
  1696.  
  1697. v2.4      - Added one bit of accuracy to pulse modulation speed. A new song-
  1698.             format (identifier GTS4) reflects this, old songs will be converted
  1699.             upon loading.
  1700.           - Added possibility to execute pattern commands from the wavetable.
  1701.  
  1702. v2.41     - Fixed player code assembly errors when using some pattern commands
  1703.             only from the wavetable.
  1704.           - Fixed player code bug with command B when command A is not used.
  1705.           - Fixed SHIFT+O removing table entries pointed to from wavetable
  1706.             pattern commands.
  1707.  
  1708. v2.42     - Fixed frequency table size determination.
  1709.           - Changed behaviour of keyoff in pattern editing changed to use
  1710.             releasenote() like the instrument editor.
  1711.           - Added SHIFT+RETURN when parameter is zero to get you into an empty
  1712.             table entry for 8, 9 and A pattern commands as well.
  1713.           - Added adjustment of table views when changing instrument number
  1714.             in unlocked table scrolling mode.
  1715.           - Added RETURN over nonzero instrument number (in patterns) to go
  1716.             editing that instrument.
  1717.  
  1718. v2.43     - Added duplicate pattern detection/removal to song optimize.
  1719.           - Added pattern shrink/expand (SHIFT+O,P).
  1720.           - Added pattern join/split (SHIFT+J,K).
  1721.  
  1722. v2.44     - Fixed editor playroutine to not execute tick n commands, when a
  1723.             command has already been executed through the wavetable.
  1724.  
  1725. v2.45     - Added possibility to disable realtime pattern command optimization
  1726.             at tick 0 (/Rxx command line option or click the "RO" text on the
  1727.             statusbar) for tempo-independent portamento & vibrato.
  1728.           - To make room on the status bar for the realtime optimization
  1729.             status indicator, finevibrato & pulse optimization indicators have
  1730.             been shortened to "FV" and "PO".
  1731.  
  1732. v2.46     - Added transpose of speedtable portamento speeds (SHIFT+Q,A,W,S)
  1733.             SHIFT+W,S (octave transpose, multiply/divide by 2) also work in
  1734.             pulse & filtertable.
  1735.           - When editing the wavetable, RETURN & SHIFT+RETURN work for wave-
  1736.             table executed commands as in patterns (go to table position
  1737.             pointed by command, create new speedtable entries)
  1738.  
  1739. v2.47     - Added experimental random delay to write of reSID registers, in
  1740.             order to make potential ADSR-bugging on C64 audible. The
  1741.             amount of delay in cycles can be adjusted with /Z command line
  1742.             option.
  1743.           - SHIFT+L in pulsetable creates repeated "set tempo" commands if
  1744.             speed is greater than 127.
  1745.  
  1746. v2.48     - Fixed playroutine to use configurable baseaddress again.
  1747.  
  1748. v2.49     - Added /G command line option, guard 1stwave/gatetimer parameters.
  1749.             When this is on (default), only silent waveforms can be entered
  1750.             as firstwave (only thing that makes sense) and editing gatetimer
  1751.             of one instrument affects all of them, as otherwise bugs in
  1752.             playback result easily. Use /G0 to turn off.
  1753.  
  1754. v2.5      - Fixed "optimize everything" removing the tempo setting in
  1755.             instrument 63.
  1756.           - Fixed default tempo of multispeed tunes in packer/relocator.
  1757.  
  1758. v2.51     - Fixed packing of empty patterns when not using any effects.
  1759.           - Fixed differing gatetimer value in instruments causing playback
  1760.             going out of sync.
  1761.           - /G command line option no longer has to keep gatetimer values the
  1762.             same.
  1763.           - Added high bit of gatetimer value to control whether wavetable
  1764.             execution starts right on the note init frame. If used, will cause
  1765.             significant rastertime increase.
  1766.  
  1767. v2.52     - SHIFT+ENTER in orderlist view takes the next available pattern
  1768.             if pressed on a repeat or transpose command.
  1769.           - Added SHIFT+SPACE in pattern editor to start playback on a specific
  1770.             pattern row.
  1771.  
  1772. v2.53     - Fixed F3 to always play the currently visible patterns.
  1773.           - Added BACKSPACE in the orderlist editor to set playback end position.
  1774.             Only effective when starting playback from position, not beginning.
  1775.  
  1776. v2.54     - Fixed SHIFT+F3.
  1777.           - Changed SHIFT+, . to update the pattern view.
  1778.           - Changed SHIFT+SPACE to remain in pattern playback mode, if it was
  1779.             active.
  1780.  
  1781. v2.55     - Added BACKSPACE in the fileselector to go to the parent dir.
  1782.  
  1783. v2.56     - Song filename cleared on songdata erase.
  1784.           - Added /F to set custom SID clock frequency.
  1785.           - Graphics output routines no longer compare text screen buffer to 
  1786.             previous to find out if it should be updated.
  1787.             
  1788. v2.57     - Added alternative hardrestart method & playroutine that is used when
  1789.             HR attack parameter is at maximum (FF00 or F800 for example) - this 
  1790.             can in theory give better reliability.
  1791.             
  1792. v2.58     - Cleanup, removal of a few questionable features:
  1793.             * Gatetimer high bit to start wavetable immediately
  1794.             * Guard 1stwave parameter
  1795.             
  1796. v2.59     - Songformat version update (GTS5/GTI5)
  1797.           - Gateoff timer parameter bits control now hardrestart disable ($80)
  1798.             & gateoff disable ($40).
  1799.           - 1stFrame Wave can be any from $01-$8F, $00 to leave both waveform
  1800.             & gateflag unchanged, or $FE / $FF to control gateflag but leave
  1801.             waveform unchanged.
  1802.  
  1803. v2.6      - Fixed pattern default length selection display when decrementing
  1804.             from a length of 100 or higher.
  1805.           - Fixed mouse selection of pattern when adjusting an adjacent channel.
  1806.           - Fixed help screen instructions.
  1807.           - Changed resolution to 800x600.
  1808.           - Changed all songname rows to be displayed at the same time.
  1809.           - Changed mouse control to allow pattern column selection even when
  1810.             left mouse button is held down.
  1811.           - Changed speed of PageUp/PageDown scrolling to be faster.
  1812.           - Optimized graphics output.
  1813.           - BME library is no longer needed.
  1814.  
  1815. v2.61     - Added the backquote key (top-left on keyboard) to select channel
  1816.             in pattern edit mode, and to select table in table edit mode. Use 
  1817.             with SHIFT to go backwards.
  1818.           - Added SHIFT+channel number to mute channels in pattern edit mode.
  1819.           
  1820. v2.62     - Added possibility for realtime calculated note independent (hifi)
  1821.             portamento & vibrato. Warning: has potential for huge rastertime
  1822.             increase.
  1823.             
  1824. v2.63     - Fixed note independent portamento & vibrato to use the last note
  1825.             set in wavetable for calculations, instead of the last note in
  1826.             patterndata.
  1827.             
  1828. v2.64     - Fixed paste in table (SHIFT+V) working also without SHIFT pressed. 
  1829.  
  1830. v2.65     - Fixed raw keycodes over 511 interpreted as some other keys in the
  1831.             0-511 range.
  1832.  
  1833. v2.66Beta - Initial cycle-exact HardSID support (Win32 only)
  1834.           - Permit running without sound.
  1835.           
  1836. v2.67     - Configurable cycle-exact HardSID buffer length (separate for inter-
  1837.             active and playback mode, see /T and /U command line options)  
  1838.  
  1839. This is reSID, a reverse engineered software emulation of the MOS6581 SID
  1840. (Sound Interface Device). This chip was used in the Commodore 64 computer.
  1841.  
  1842. reSID is free software. See the file COPYING for copying permission.
  1843.  
  1844. reSID is a C++ library containing a complete emulation of the SID chip.
  1845. This library can be linked into programs emulating the MOS6510 MPU to
  1846. play music made for the Commodore 64 computer. reSID has been successfully
  1847. linked into VICE, a full-fledged Commodore 64 emulator, and SIDPLAY, a
  1848. popular SID tune player. The VICE home page is:
  1849. http://www.cs.cmu.edu/~dsladic/vice/
  1850. A patch for SIDPLAY can be found on the SIDPLAY home page:
  1851. http://www.geocities.com/SiliconValley/Lakes/5147/
  1852.  
  1853. Various SID emulators exist, however reSID should still be of great
  1854. interest to Commodore 64 nostalgics. The emulator engine is cycle-based,
  1855. emulating the internal operations of the SID chip. SID's audio filter is
  1856. modeled as an actual two-integrator-loop biquadratic filter circuit.
  1857. The engine has been developed based on available information on SID, sampling
  1858. of the OSC3 and ENV3 registers, filter theory, and meticulous testing.
  1859. In short, a scientific approach has been taken to model the SID chip as
  1860. accurately as possible.
  1861.  
  1862. To our knowledge reSID is by far the most accurate SID emulator ever created.
  1863. This comes at a price; what is considered a fairly fast CPU at the time of
  1864. this writing is needed to run the emulator.
  1865. Please distribute this file with the SDL runtime environment:
  1866.  
  1867. The Simple DirectMedia Layer (SDL for short) is a cross-platfrom library
  1868. designed to make it easy to write multi-media software, such as games and
  1869. emulators.
  1870.  
  1871. The Simple DirectMedia Layer library source code is available from:
  1872. http://www.libsdl.org/
  1873.  
  1874. This library is distributed under the terms of the GNU LGPL license:
  1875. http://www.gnu.org/copyleft/lesser.html
  1876.  
  1877.