home *** CD-ROM | disk | FTP | other *** search
/ Large Pack of OldSkool DOS MOD Trackers / goattracker_2.70.zip / readme.txt < prev    next >
Text File  |  2010-01-31  |  80KB  |  1,856 lines

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