https://wiki.multimedia.cx/api.php?action=feedcontributions&feedformat=atom&user=GreaseMonkeyMultimediaWiki - User contributions [en]2026-05-01T08:23:52ZUser contributionsMediaWiki 1.39.5https://wiki.multimedia.cx/index.php?title=Impulse_Tracker&diff=14183Impulse Tracker2012-10-15T07:04:51Z<p>GreaseMonkey: Hxx (vibrato) documented. as far as i know, this is about as accurate as it gets.</p>
<hr />
<div>* Extension: it<br />
<br />
==File Format==<br />
''TODO''<br />
<br />
''it would be interesting to find out how the MIDI/timestamp stuff after the pointer list works... the other TODOs I (GM) know about''<br />
<br />
==IT214 sample compression==<br />
<br />
If bit 3 (0x08 compressed samples) is set, the sample is compressed.<br />
<br />
* Compression is split into blocks, where the '''uncompressed size''' is 0x8000 '''bytes''' (0x4000 samples for 16-bit, and 0x8000 otherwise).<br />
* Once a block is decompressed (or at least fails to decompress), the data is then delta decoded.<br />
* The sample conversion flags are applied '''per-block''' rather than for the whole sample. These are probably applied after delta decoding.<br />
* IT215 samples are IT214-compressed samples with the "Delta" flag (not the "Byte Delta" flag) set in the conversion flags.<br />
* Each compressed block starts with a 16-bit length field, and then the bitstream is encoded in little-endian binary (LSB up).<br />
* There is a "bit width" initially set to 9 for 8-bit samples, and 17 for 16-bit samples.<br />
* The "bit width" is changed by special values inside their respective types. If such a special value is not triggered, the values are read as signed values, and unpacked<br />
* There are three types of blocks, which we will call A, B, and C.<br />
** Type A: Bit widths 1 through 6. Special value is 1 in the top bit and 0s for the rest. If such a value is triggered, it then reads 3 (8-bit) or 4 (16-bit) bits for calculating the new bit width (see below).<br />
** Type B: Bit widths 7 through n, where n is 8 for 8-bit samples and 16 for 16-bit. Special values are 0...0100 through 1...1011 for 8-bit and 0...01000 through 1...10111 for 16-bit. If such a value is triggered, subtract 0...0100 (8-bit) or 0...01000 (16-bit) and use that to calculate the new bit width (see below).<br />
** Type C: Bit width n+1. If the top bit is set, the lower 8 bits plus 1 are the new bit width.<br />
* Barring type C, the new width selected is (v+1), except where v+1 >= the previous bit width, in which case the new width is v+1.<br />
* If an invalid bit width is selected (only possible in type C), the decompressor '''terminates and leaves all the remaining values as 0 before delta decoding.'''<br />
* The defacto standard for compressed stereo samples (as set by XMPlay) is to decompress the left channel '''entirely separately''' from the right channel (where the data follows immediately afterwards), rather than decompress them together and separate afterwards.<br />
<br />
''if this is a bit too messy, feel free to tidy it up''<br />
<br />
==Playback notes==<br />
''TODO''<br />
<br />
===Resonant filters===<br />
<br />
The resonant filter (added in 2.14p3) uses the following formula:<br />
<br />
*K[n] = a * S[n] + b * K[n-1] + c * K[n-2]<br />
<br />
where:<br />
<br />
*K[n] is the outputted value at time n<br />
*S[n] is the input value at time n<br />
*a = 1/(1+d+e)<br />
*b = (d+2e) / (1+d+e)<br />
*c = -e / (1+d+e)<br />
<br />
where:<br />
<br />
*d = 2pr+2p-1<br />
*e = r^2<br />
<br />
where:<br />
<br />
*r = playback_frequency * (2.0*PI*110.0*(2.0^0.25)) / (2^(cutoff/24.0))<br />
*p = 10^((-resonance*24.0)/(128.0f*20.0f))<br />
<br />
Some formulae can be simplified:<br />
*d = (2p)(r+1)-1<br />
*b = (d+2e)*a<br />
*c = -e*a<br />
<br />
<br />
IT uses a table for 2p, and calculates r on the fly. The number "(2.0*PI*110.0*(2.0^0.25))" is precalculated.<br />
<br />
For more information:<br />
*[http://schismtracker.org/wiki/Resonant%20Filters Formulae + source code snippets from Jeffrey Lim]<br />
<br />
===Effects===<br />
<br />
====Axx====<br />
Set song speed.<br />
<br />
====Bxx====<br />
Jump to Order.<br />
*If this comes after an SBx loop command, '''the effect is done as-is'''.<br />
<br />
====Cxx====<br />
Break to row.<br />
*If this comes after an SBx loop command, '''the effect is ignored'''. ''TODO: look into how this information is relayed''<br />
<br />
====Dxx====<br />
Volume slide.<br />
<br />
====Exx====<br />
Pitch slide down.<br />
<br />
====Fxx====<br />
Pitch slide up.<br />
<br />
====Gxx====<br />
Slide to note.<br />
<br />
====Hxy====<br />
Vibrato with speed x*4, depth y*4.<br />
<br />
This behaves in a very weird way, and virtually nothing does it right (though most do it "acceptably close").<br />
<br />
Vibrato retriggers in the following situations:<br />
*When the last time vibrato was used, it was on a different instrument and/or sample ''(TODO: confirm which)''<br />
<br />
Vibrato does NOT retrigger on:<br />
*New note<br />
*New instrument/sample, barring the exception given above<br />
<br />
''TODO: look into "random waveform".''<br />
<br />
*'''Pre-add''' the vibrato speed to the vibrato offset, except when Old Effects is enabled and this is tick 0.<br />
*Load the value "v" from the selected vibrato table (available in ITTECH.TXT)<br />
**Note that "random" does NOT use a table, but actually spits out a random number.<br />
*Multiply v by the vibrato depth.<br />
*If old effects are enabled, '''v = ~(v<<1)''' (in other words, v = -(v*2+1)).<br />
*If negative, do a '''one's compliment''' negation of v (that is, v = -(v+1)), and use the slide down tables (or for Amiga slides, just remember to slide down instead of up). Otherwise, use the slide up tables.<br />
*v = (v'''+32''')>>6 (that is, v = (v+32)/64). Yes, this is rounded.<br />
*If using linear slides, check if v < 16. If so, do a fine slide by v. Otherwise, do a normal slide by v>>2 (that is, v/4). '''It only does one or the other.'''<br />
*Otherwise, just do a fine Amiga slide by v.<br />
<br />
====Ixy====<br />
Tremor with ontime x and offtime y.<br />
<br />
====Jxy====<br />
Arpeggio.<br />
<br />
====Kxx====<br />
Dual command: H00 & Dxx<br />
<br />
====Lxx====<br />
Dual command: G00 & Dxx<br />
<br />
====Mxx====<br />
Set channel volume.<br />
* If xx is > 0x40, '''the effect is ignored.'''<br />
<br />
====Nxx====<br />
Channel volume slide.<br />
<br />
====Oxx====<br />
Set sample offset.<br />
<br />
====Pxy====<br />
Panning slide.<br />
<br />
====Qxy====<br />
Retrig.<br />
<br />
====Rxy====<br />
Tremolo with speed x, depth y.<br />
<br />
====Sxy - Miscellaneous effects====<br />
<br />
=====S0x=====<br />
Set filter. Not implemented in Impulse Tracker.<br />
<br />
* '''S00 - repeats the last nonzero Sxx effect for the channel.'''<br />
<br />
=====S1x=====<br />
Set glissando control. Not implemented in Impulse Tracker.<br />
<br />
=====S2x=====<br />
Set finetune. Not Implemented in Impulse Tracker.<br />
<br />
=====S3x=====<br />
Set vibrato waveform.<br />
<br />
Values for x:<br />
*0: Sine wave<br />
*1: Ramp down<br />
*2: Square wave<br />
*3: Random wave<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
<br />
=====S4x=====<br />
Set tremolo waveform.<br />
<br />
Uses the same waveform table as S3x. '''If x > 3, the effect is ignored.'''<br />
<br />
=====S5x=====<br />
Set panbrello waveform.<br />
<br />
Uses the same waveform table as S3x.<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
* This effect '''retriggers the panbrello waveform position'''.<br />
<br />
=====S6x=====<br />
Pattern delay for x ticks.<br />
<br />
=====S70=====<br />
Past note cut.<br />
<br />
=====S71=====<br />
Past note off.<br />
<br />
=====S72=====<br />
Past note fade.<br />
<br />
=====S73=====<br />
Set NNA to note cut.<br />
<br />
=====S74=====<br />
Set NNA to continue.<br />
<br />
=====S75=====<br />
Set NNA to note off.<br />
<br />
=====S76=====<br />
Set NNA to note fade.<br />
<br />
=====S77=====<br />
Turn off volume envelope.<br />
<br />
=====S78=====<br />
Turn on volume envelope.<br />
<br />
=====S79=====<br />
Turn off panning envelope.<br />
<br />
=====S7A=====<br />
Turn on panning envelope.<br />
<br />
=====S7B=====<br />
Turn off pitch envelope.<br />
<br />
=====S7C=====<br />
Turn on pitch envelope.<br />
<br />
=====S8x=====<br />
Set panning position.<br />
<br />
=====S91=====<br />
Set surround sound.<br />
<br />
=====SAy=====<br />
Set high value of sample offset yxx00h<br />
<br />
=====SBx=====<br />
Pattern loop.<br />
<br />
=====SCx=====<br />
Note cut after x ticks.<br />
<br />
=====SDx=====<br />
Note delay for x ticks.<br />
<br />
=====SEx=====<br />
Pattern delay for x rows<br />
<br />
=====SFx=====<br />
Set parameterised MIDI macro.<br />
<br />
====Txx====<br />
Set Tempo.<br />
<br />
====Uxy====<br />
Fine vibrato with speed x*4, depth y.<br />
<br />
====Vxx====<br />
Set global volume.<br />
* If xx is > 0x80, '''the effect is ignored.'''<br />
<br />
====Wxy====<br />
Global volume slide.<br />
* IT versions < 1.06 had a bug where a slide up would clip to 0 instead of 128.<br />
<br />
====Xxx====<br />
Set panning position. Sets panning to '''(xx + 2) div 4'''<br />
<br />
====Yxy====<br />
Panbrello with speed x, depth y.<br />
<br />
* '''If the panbrello waveform is set to 'Random', then the speed is interpreted as a delay'''.<br />
<br />
====Zxx====<br />
MIDI Macros<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Impulse_Tracker&diff=13810Impulse Tracker2012-01-23T08:43:48Z<p>GreaseMonkey: /* Resonant filters */ trying to make this more accurate</p>
<hr />
<div>* Extension: it<br />
<br />
==File Format==<br />
''TODO''<br />
<br />
''it would be interesting to find out how the MIDI/timestamp stuff after the pointer list works... the other TODOs I (GM) know about''<br />
<br />
==IT214 sample compression==<br />
<br />
If bit 3 (0x08 compressed samples) is set, the sample is compressed.<br />
<br />
* Compression is split into blocks, where the '''uncompressed size''' is 0x8000 '''bytes''' (0x4000 samples for 16-bit, and 0x8000 otherwise).<br />
* Once a block is decompressed (or at least fails to decompress), the data is then delta decoded.<br />
* The sample conversion flags are applied '''per-block''' rather than for the whole sample. These are probably applied after delta decoding.<br />
* IT215 samples are IT214-compressed samples with the "Delta" flag (not the "Byte Delta" flag) set in the conversion flags.<br />
* Each compressed block starts with a 16-bit length field, and then the bitstream is encoded in little-endian binary (LSB up).<br />
* There is a "bit width" initially set to 9 for 8-bit samples, and 17 for 16-bit samples.<br />
* The "bit width" is changed by special values inside their respective types. If such a special value is not triggered, the values are read as signed values, and unpacked<br />
* There are three types of blocks, which we will call A, B, and C.<br />
** Type A: Bit widths 1 through 6. Special value is 1 in the top bit and 0s for the rest. If such a value is triggered, it then reads 3 (8-bit) or 4 (16-bit) bits for calculating the new bit width (see below).<br />
** Type B: Bit widths 7 through n, where n is 8 for 8-bit samples and 16 for 16-bit. Special values are 0...0100 through 1...1011 for 8-bit and 0...01000 through 1...10111 for 16-bit. If such a value is triggered, subtract 0...0100 (8-bit) or 0...01000 (16-bit) and use that to calculate the new bit width (see below).<br />
** Type C: Bit width n+1. If the top bit is set, the lower 8 bits plus 1 are the new bit width.<br />
* Barring type C, the new width selected is (v+1), except where v+1 >= the previous bit width, in which case the new width is v+1.<br />
* If an invalid bit width is selected (only possible in type C), the decompressor '''terminates and leaves all the remaining values as 0 before delta decoding.'''<br />
* The defacto standard for compressed stereo samples (as set by XMPlay) is to decompress the left channel '''entirely separately''' from the right channel (where the data follows immediately afterwards), rather than decompress them together and separate afterwards.<br />
<br />
''if this is a bit too messy, feel free to tidy it up''<br />
<br />
==Playback notes==<br />
''TODO''<br />
<br />
===Resonant filters===<br />
<br />
The resonant filter (added in 2.14p3) uses the following formula:<br />
<br />
*K[n] = a * S[n] + b * K[n-1] + c * K[n-2]<br />
<br />
where:<br />
<br />
*K[n] is the outputted value at time n<br />
*S[n] is the input value at time n<br />
*a = 1/(1+d+e)<br />
*b = (d+2e) / (1+d+e)<br />
*c = -e / (1+d+e)<br />
<br />
where:<br />
<br />
*d = 2pr+2p-1<br />
*e = r^2<br />
<br />
where:<br />
<br />
*r = playback_frequency * (2.0*PI*110.0*(2.0^0.25)) / (2^(cutoff/24.0))<br />
*p = 10^((-resonance*24.0)/(128.0f*20.0f))<br />
<br />
Some formulae can be simplified:<br />
*d = (2p)(r+1)-1<br />
*b = (d+2e)*a<br />
*c = -e*a<br />
<br />
<br />
IT uses a table for 2p, and calculates r on the fly. The number "(2.0*PI*110.0*(2.0^0.25))" is precalculated.<br />
<br />
For more information:<br />
*[http://schismtracker.org/wiki/Resonant%20Filters Formulae + source code snippets from Jeffrey Lim]<br />
<br />
===Effects===<br />
<br />
====Axx====<br />
Set song speed.<br />
<br />
====Bxx====<br />
Jump to Order.<br />
*If this comes after an SBx loop command, '''the effect is done as-is'''.<br />
<br />
====Cxx====<br />
Break to row.<br />
*If this comes after an SBx loop command, '''the effect is ignored'''. ''TODO: look into how this information is relayed''<br />
<br />
====Dxx====<br />
Volume slide.<br />
<br />
====Exx====<br />
Pitch slide down.<br />
<br />
====Fxx====<br />
Pitch slide up.<br />
<br />
====Gxx====<br />
Slide to note.<br />
<br />
====Hxy====<br />
Vibrato with speed x, depth y.<br />
<br />
====Ixy====<br />
Tremor with ontime x and offtime y.<br />
<br />
====Jxy====<br />
Arpeggio.<br />
<br />
====Kxx====<br />
Dual command: H00 & Dxx<br />
<br />
====Lxx====<br />
Dual command: G00 & Dxx<br />
<br />
====Mxx====<br />
Set channel volume.<br />
* If xx is > 0x40, '''the effect is ignored.'''<br />
<br />
====Nxx====<br />
Channel volume slide.<br />
<br />
====Oxx====<br />
Set sample offset.<br />
<br />
====Pxy====<br />
Panning slide.<br />
<br />
====Qxy====<br />
Retrig.<br />
<br />
====Rxy====<br />
Tremolo with speed x, depth y.<br />
<br />
====Sxy - Miscellaneous effects====<br />
<br />
=====S0x=====<br />
Set filter. Not implemented in Impulse Tracker.<br />
<br />
* '''S00 - repeats the last nonzero Sxx effect for the channel.'''<br />
<br />
=====S1x=====<br />
Set glissando control. Not implemented in Impulse Tracker.<br />
<br />
=====S2x=====<br />
Set finetune. Not Implemented in Impulse Tracker.<br />
<br />
=====S3x=====<br />
Set vibrato waveform.<br />
<br />
Values for x:<br />
*0: Sine wave<br />
*1: Ramp down<br />
*2: Square wave<br />
*3: Random wave<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
<br />
=====S4x=====<br />
Set tremolo waveform.<br />
<br />
Uses the same waveform table as S3x. '''If x > 3, the effect is ignored.'''<br />
<br />
=====S5x=====<br />
Set panbrello waveform.<br />
<br />
Uses the same waveform table as S3x.<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
* This effect '''retriggers the panbrello waveform position'''.<br />
<br />
=====S6x=====<br />
Pattern delay for x ticks.<br />
<br />
=====S70=====<br />
Past note cut.<br />
<br />
=====S71=====<br />
Past note off.<br />
<br />
=====S72=====<br />
Past note fade.<br />
<br />
=====S73=====<br />
Set NNA to note cut.<br />
<br />
=====S74=====<br />
Set NNA to continue.<br />
<br />
=====S75=====<br />
Set NNA to note off.<br />
<br />
=====S76=====<br />
Set NNA to note fade.<br />
<br />
=====S77=====<br />
Turn off volume envelope.<br />
<br />
=====S78=====<br />
Turn on volume envelope.<br />
<br />
=====S79=====<br />
Turn off panning envelope.<br />
<br />
=====S7A=====<br />
Turn on panning envelope.<br />
<br />
=====S7B=====<br />
Turn off pitch envelope.<br />
<br />
=====S7C=====<br />
Turn on pitch envelope.<br />
<br />
=====S8x=====<br />
Set panning position.<br />
<br />
=====S91=====<br />
Set surround sound.<br />
<br />
=====SAy=====<br />
Set high value of sample offset yxx00h<br />
<br />
=====SBx=====<br />
Pattern loop.<br />
<br />
=====SCx=====<br />
Note cut after x ticks.<br />
<br />
=====SDx=====<br />
Note delay for x ticks.<br />
<br />
=====SEx=====<br />
Pattern delay for x rows<br />
<br />
=====SFx=====<br />
Set parameterised MIDI macro.<br />
<br />
====Txx====<br />
Set Tempo.<br />
<br />
====Uxy====<br />
Fine vibrato with speed x, depth y.<br />
<br />
====Vxx====<br />
Set global volume.<br />
* If xx is > 0x80, '''the effect is ignored.'''<br />
<br />
====Wxy====<br />
Global volume slide.<br />
* IT versions < 1.06 had a bug where a slide up would clip to 0 instead of 128.<br />
<br />
====Xxx====<br />
Set panning position. Sets panning to '''(xx + 2) div 4'''<br />
<br />
====Yxy====<br />
Panbrello with speed x, depth y.<br />
<br />
* '''If the panbrello waveform is set to 'Random', then the speed is interpreted as a delay'''.<br />
<br />
====Zxx====<br />
MIDI Macros<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Impulse_Tracker&diff=13805Impulse Tracker2012-01-22T10:07:52Z<p>GreaseMonkey: /* Wxy */ a bug i found in an old version</p>
<hr />
<div>* Extension: it<br />
<br />
==File Format==<br />
''TODO''<br />
<br />
''it would be interesting to find out how the MIDI/timestamp stuff after the pointer list works... the other TODOs I (GM) know about''<br />
<br />
==IT214 sample compression==<br />
<br />
If bit 3 (0x08 compressed samples) is set, the sample is compressed.<br />
<br />
* Compression is split into blocks, where the '''uncompressed size''' is 0x8000 '''bytes''' (0x4000 samples for 16-bit, and 0x8000 otherwise).<br />
* Once a block is decompressed (or at least fails to decompress), the data is then delta decoded.<br />
* The sample conversion flags are applied '''per-block''' rather than for the whole sample. These are probably applied after delta decoding.<br />
* IT215 samples are IT214-compressed samples with the "Delta" flag (not the "Byte Delta" flag) set in the conversion flags.<br />
* Each compressed block starts with a 16-bit length field, and then the bitstream is encoded in little-endian binary (LSB up).<br />
* There is a "bit width" initially set to 9 for 8-bit samples, and 17 for 16-bit samples.<br />
* The "bit width" is changed by special values inside their respective types. If such a special value is not triggered, the values are read as signed values, and unpacked<br />
* There are three types of blocks, which we will call A, B, and C.<br />
** Type A: Bit widths 1 through 6. Special value is 1 in the top bit and 0s for the rest. If such a value is triggered, it then reads 3 (8-bit) or 4 (16-bit) bits for calculating the new bit width (see below).<br />
** Type B: Bit widths 7 through n, where n is 8 for 8-bit samples and 16 for 16-bit. Special values are 0...0100 through 1...1011 for 8-bit and 0...01000 through 1...10111 for 16-bit. If such a value is triggered, subtract 0...0100 (8-bit) or 0...01000 (16-bit) and use that to calculate the new bit width (see below).<br />
** Type C: Bit width n+1. If the top bit is set, the lower 8 bits plus 1 are the new bit width.<br />
* Barring type C, the new width selected is (v+1), except where v+1 >= the previous bit width, in which case the new width is v+1.<br />
* If an invalid bit width is selected (only possible in type C), the decompressor '''terminates and leaves all the remaining values as 0 before delta decoding.'''<br />
* The defacto standard for compressed stereo samples (as set by XMPlay) is to decompress the left channel '''entirely separately''' from the right channel (where the data follows immediately afterwards), rather than decompress them together and separate afterwards.<br />
<br />
''if this is a bit too messy, feel free to tidy it up''<br />
<br />
==Playback notes==<br />
''TODO''<br />
<br />
===Resonant filters===<br />
<br />
The resonant filter (added in 2.14p3) uses the following formula:<br />
<br />
*K[n] = a * S[n] + b * K[n-1] + c * K[n-2]<br />
<br />
where:<br />
<br />
*K[n] is the outputted value at time n<br />
*S[n] is the input value at time n<br />
*a = 1/(1+d+e)<br />
*b = (d+2e) / (1+d+e)<br />
*c = -e / (1+d+e)<br />
<br />
where:<br />
<br />
*d = 2pr+2p-1<br />
*e = r^2<br />
<br />
where:<br />
<br />
*r = 2^((cutoff/24.0)/(2.0*PI*110.0*(2.0^0.25))) (probably divided by the playback frequency)<br />
*p = 10^((-resonance*24.0)/(128.0f*20.0f))<br />
<br />
''TODO: The information is from [http://schismtracker.org/wiki/Resonant%20Filters here] and needs to be confirmed for accuracy (as in, where does the playback frequency come in?).''<br />
<br />
===Effects===<br />
<br />
====Axx====<br />
Set song speed.<br />
<br />
====Bxx====<br />
Jump to Order.<br />
*If this comes after an SBx loop command, '''the effect is done as-is'''.<br />
<br />
====Cxx====<br />
Break to row.<br />
*If this comes after an SBx loop command, '''the effect is ignored'''. ''TODO: look into how this information is relayed''<br />
<br />
====Dxx====<br />
Volume slide.<br />
<br />
====Exx====<br />
Pitch slide down.<br />
<br />
====Fxx====<br />
Pitch slide up.<br />
<br />
====Gxx====<br />
Slide to note.<br />
<br />
====Hxy====<br />
Vibrato with speed x, depth y.<br />
<br />
====Ixy====<br />
Tremor with ontime x and offtime y.<br />
<br />
====Jxy====<br />
Arpeggio.<br />
<br />
====Kxx====<br />
Dual command: H00 & Dxx<br />
<br />
====Lxx====<br />
Dual command: G00 & Dxx<br />
<br />
====Mxx====<br />
Set channel volume.<br />
* If xx is > 0x40, '''the effect is ignored.'''<br />
<br />
====Nxx====<br />
Channel volume slide.<br />
<br />
====Oxx====<br />
Set sample offset.<br />
<br />
====Pxy====<br />
Panning slide.<br />
<br />
====Qxy====<br />
Retrig.<br />
<br />
====Rxy====<br />
Tremolo with speed x, depth y.<br />
<br />
====Sxy - Miscellaneous effects====<br />
<br />
=====S0x=====<br />
Set filter. Not implemented in Impulse Tracker.<br />
<br />
* '''S00 - repeats the last nonzero Sxx effect for the channel.'''<br />
<br />
=====S1x=====<br />
Set glissando control. Not implemented in Impulse Tracker.<br />
<br />
=====S2x=====<br />
Set finetune. Not Implemented in Impulse Tracker.<br />
<br />
=====S3x=====<br />
Set vibrato waveform.<br />
<br />
Values for x:<br />
*0: Sine wave<br />
*1: Ramp down<br />
*2: Square wave<br />
*3: Random wave<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
<br />
=====S4x=====<br />
Set tremolo waveform.<br />
<br />
Uses the same waveform table as S3x. '''If x > 3, the effect is ignored.'''<br />
<br />
=====S5x=====<br />
Set panbrello waveform.<br />
<br />
Uses the same waveform table as S3x.<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
* This effect '''retriggers the panbrello waveform position'''.<br />
<br />
=====S6x=====<br />
Pattern delay for x ticks.<br />
<br />
=====S70=====<br />
Past note cut.<br />
<br />
=====S71=====<br />
Past note off.<br />
<br />
=====S72=====<br />
Past note fade.<br />
<br />
=====S73=====<br />
Set NNA to note cut.<br />
<br />
=====S74=====<br />
Set NNA to continue.<br />
<br />
=====S75=====<br />
Set NNA to note off.<br />
<br />
=====S76=====<br />
Set NNA to note fade.<br />
<br />
=====S77=====<br />
Turn off volume envelope.<br />
<br />
=====S78=====<br />
Turn on volume envelope.<br />
<br />
=====S79=====<br />
Turn off panning envelope.<br />
<br />
=====S7A=====<br />
Turn on panning envelope.<br />
<br />
=====S7B=====<br />
Turn off pitch envelope.<br />
<br />
=====S7C=====<br />
Turn on pitch envelope.<br />
<br />
=====S8x=====<br />
Set panning position.<br />
<br />
=====S91=====<br />
Set surround sound.<br />
<br />
=====SAy=====<br />
Set high value of sample offset yxx00h<br />
<br />
=====SBx=====<br />
Pattern loop.<br />
<br />
=====SCx=====<br />
Note cut after x ticks.<br />
<br />
=====SDx=====<br />
Note delay for x ticks.<br />
<br />
=====SEx=====<br />
Pattern delay for x rows<br />
<br />
=====SFx=====<br />
Set parameterised MIDI macro.<br />
<br />
====Txx====<br />
Set Tempo.<br />
<br />
====Uxy====<br />
Fine vibrato with speed x, depth y.<br />
<br />
====Vxx====<br />
Set global volume.<br />
* If xx is > 0x80, '''the effect is ignored.'''<br />
<br />
====Wxy====<br />
Global volume slide.<br />
* IT versions < 1.06 had a bug where a slide up would clip to 0 instead of 128.<br />
<br />
====Xxx====<br />
Set panning position. Sets panning to '''(xx + 2) div 4'''<br />
<br />
====Yxy====<br />
Panbrello with speed x, depth y.<br />
<br />
* '''If the panbrello waveform is set to 'Random', then the speed is interpreted as a delay'''.<br />
<br />
====Zxx====<br />
MIDI Macros<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Impulse_Tracker&diff=13804Impulse Tracker2012-01-22T10:06:44Z<p>GreaseMonkey: /* Resonant filters */ adding some info</p>
<hr />
<div>* Extension: it<br />
<br />
==File Format==<br />
''TODO''<br />
<br />
''it would be interesting to find out how the MIDI/timestamp stuff after the pointer list works... the other TODOs I (GM) know about''<br />
<br />
==IT214 sample compression==<br />
<br />
If bit 3 (0x08 compressed samples) is set, the sample is compressed.<br />
<br />
* Compression is split into blocks, where the '''uncompressed size''' is 0x8000 '''bytes''' (0x4000 samples for 16-bit, and 0x8000 otherwise).<br />
* Once a block is decompressed (or at least fails to decompress), the data is then delta decoded.<br />
* The sample conversion flags are applied '''per-block''' rather than for the whole sample. These are probably applied after delta decoding.<br />
* IT215 samples are IT214-compressed samples with the "Delta" flag (not the "Byte Delta" flag) set in the conversion flags.<br />
* Each compressed block starts with a 16-bit length field, and then the bitstream is encoded in little-endian binary (LSB up).<br />
* There is a "bit width" initially set to 9 for 8-bit samples, and 17 for 16-bit samples.<br />
* The "bit width" is changed by special values inside their respective types. If such a special value is not triggered, the values are read as signed values, and unpacked<br />
* There are three types of blocks, which we will call A, B, and C.<br />
** Type A: Bit widths 1 through 6. Special value is 1 in the top bit and 0s for the rest. If such a value is triggered, it then reads 3 (8-bit) or 4 (16-bit) bits for calculating the new bit width (see below).<br />
** Type B: Bit widths 7 through n, where n is 8 for 8-bit samples and 16 for 16-bit. Special values are 0...0100 through 1...1011 for 8-bit and 0...01000 through 1...10111 for 16-bit. If such a value is triggered, subtract 0...0100 (8-bit) or 0...01000 (16-bit) and use that to calculate the new bit width (see below).<br />
** Type C: Bit width n+1. If the top bit is set, the lower 8 bits plus 1 are the new bit width.<br />
* Barring type C, the new width selected is (v+1), except where v+1 >= the previous bit width, in which case the new width is v+1.<br />
* If an invalid bit width is selected (only possible in type C), the decompressor '''terminates and leaves all the remaining values as 0 before delta decoding.'''<br />
* The defacto standard for compressed stereo samples (as set by XMPlay) is to decompress the left channel '''entirely separately''' from the right channel (where the data follows immediately afterwards), rather than decompress them together and separate afterwards.<br />
<br />
''if this is a bit too messy, feel free to tidy it up''<br />
<br />
==Playback notes==<br />
''TODO''<br />
<br />
===Resonant filters===<br />
<br />
The resonant filter (added in 2.14p3) uses the following formula:<br />
<br />
*K[n] = a * S[n] + b * K[n-1] + c * K[n-2]<br />
<br />
where:<br />
<br />
*K[n] is the outputted value at time n<br />
*S[n] is the input value at time n<br />
*a = 1/(1+d+e)<br />
*b = (d+2e) / (1+d+e)<br />
*c = -e / (1+d+e)<br />
<br />
where:<br />
<br />
*d = 2pr+2p-1<br />
*e = r^2<br />
<br />
where:<br />
<br />
*r = 2^((cutoff/24.0)/(2.0*PI*110.0*(2.0^0.25))) (probably divided by the playback frequency)<br />
*p = 10^((-resonance*24.0)/(128.0f*20.0f))<br />
<br />
''TODO: The information is from [http://schismtracker.org/wiki/Resonant%20Filters here] and needs to be confirmed for accuracy (as in, where does the playback frequency come in?).''<br />
<br />
===Effects===<br />
<br />
====Axx====<br />
Set song speed.<br />
<br />
====Bxx====<br />
Jump to Order.<br />
*If this comes after an SBx loop command, '''the effect is done as-is'''.<br />
<br />
====Cxx====<br />
Break to row.<br />
*If this comes after an SBx loop command, '''the effect is ignored'''. ''TODO: look into how this information is relayed''<br />
<br />
====Dxx====<br />
Volume slide.<br />
<br />
====Exx====<br />
Pitch slide down.<br />
<br />
====Fxx====<br />
Pitch slide up.<br />
<br />
====Gxx====<br />
Slide to note.<br />
<br />
====Hxy====<br />
Vibrato with speed x, depth y.<br />
<br />
====Ixy====<br />
Tremor with ontime x and offtime y.<br />
<br />
====Jxy====<br />
Arpeggio.<br />
<br />
====Kxx====<br />
Dual command: H00 & Dxx<br />
<br />
====Lxx====<br />
Dual command: G00 & Dxx<br />
<br />
====Mxx====<br />
Set channel volume.<br />
* If xx is > 0x40, '''the effect is ignored.'''<br />
<br />
====Nxx====<br />
Channel volume slide.<br />
<br />
====Oxx====<br />
Set sample offset.<br />
<br />
====Pxy====<br />
Panning slide.<br />
<br />
====Qxy====<br />
Retrig.<br />
<br />
====Rxy====<br />
Tremolo with speed x, depth y.<br />
<br />
====Sxy - Miscellaneous effects====<br />
<br />
=====S0x=====<br />
Set filter. Not implemented in Impulse Tracker.<br />
<br />
* '''S00 - repeats the last nonzero Sxx effect for the channel.'''<br />
<br />
=====S1x=====<br />
Set glissando control. Not implemented in Impulse Tracker.<br />
<br />
=====S2x=====<br />
Set finetune. Not Implemented in Impulse Tracker.<br />
<br />
=====S3x=====<br />
Set vibrato waveform.<br />
<br />
Values for x:<br />
*0: Sine wave<br />
*1: Ramp down<br />
*2: Square wave<br />
*3: Random wave<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
<br />
=====S4x=====<br />
Set tremolo waveform.<br />
<br />
Uses the same waveform table as S3x. '''If x > 3, the effect is ignored.'''<br />
<br />
=====S5x=====<br />
Set panbrello waveform.<br />
<br />
Uses the same waveform table as S3x.<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
* This effect '''retriggers the panbrello waveform position'''.<br />
<br />
=====S6x=====<br />
Pattern delay for x ticks.<br />
<br />
=====S70=====<br />
Past note cut.<br />
<br />
=====S71=====<br />
Past note off.<br />
<br />
=====S72=====<br />
Past note fade.<br />
<br />
=====S73=====<br />
Set NNA to note cut.<br />
<br />
=====S74=====<br />
Set NNA to continue.<br />
<br />
=====S75=====<br />
Set NNA to note off.<br />
<br />
=====S76=====<br />
Set NNA to note fade.<br />
<br />
=====S77=====<br />
Turn off volume envelope.<br />
<br />
=====S78=====<br />
Turn on volume envelope.<br />
<br />
=====S79=====<br />
Turn off panning envelope.<br />
<br />
=====S7A=====<br />
Turn on panning envelope.<br />
<br />
=====S7B=====<br />
Turn off pitch envelope.<br />
<br />
=====S7C=====<br />
Turn on pitch envelope.<br />
<br />
=====S8x=====<br />
Set panning position.<br />
<br />
=====S91=====<br />
Set surround sound.<br />
<br />
=====SAy=====<br />
Set high value of sample offset yxx00h<br />
<br />
=====SBx=====<br />
Pattern loop.<br />
<br />
=====SCx=====<br />
Note cut after x ticks.<br />
<br />
=====SDx=====<br />
Note delay for x ticks.<br />
<br />
=====SEx=====<br />
Pattern delay for x rows<br />
<br />
=====SFx=====<br />
Set parameterised MIDI macro.<br />
<br />
====Txx====<br />
Set Tempo.<br />
<br />
====Uxy====<br />
Fine vibrato with speed x, depth y.<br />
<br />
====Vxx====<br />
Set global volume.<br />
* If xx is > 0x80, '''the effect is ignored.'''<br />
<br />
====Wxy====<br />
Global volume slide.<br />
<br />
====Xxx====<br />
Set panning position. Sets panning to '''(xx + 2) div 4'''<br />
<br />
====Yxy====<br />
Panbrello with speed x, depth y.<br />
<br />
* '''If the panbrello waveform is set to 'Random', then the speed is interpreted as a delay'''.<br />
<br />
====Zxx====<br />
MIDI Macros<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Impulse_Tracker&diff=13803Impulse Tracker2012-01-22T09:37:23Z<p>GreaseMonkey: /* IT214 sample compression */ the explanation might be a bit crap, sorry, but there's something here.</p>
<hr />
<div>* Extension: it<br />
<br />
==File Format==<br />
''TODO''<br />
<br />
''it would be interesting to find out how the MIDI/timestamp stuff after the pointer list works... the other TODOs I (GM) know about''<br />
<br />
==IT214 sample compression==<br />
<br />
If bit 3 (0x08 compressed samples) is set, the sample is compressed.<br />
<br />
* Compression is split into blocks, where the '''uncompressed size''' is 0x8000 '''bytes''' (0x4000 samples for 16-bit, and 0x8000 otherwise).<br />
* Once a block is decompressed (or at least fails to decompress), the data is then delta decoded.<br />
* The sample conversion flags are applied '''per-block''' rather than for the whole sample. These are probably applied after delta decoding.<br />
* IT215 samples are IT214-compressed samples with the "Delta" flag (not the "Byte Delta" flag) set in the conversion flags.<br />
* Each compressed block starts with a 16-bit length field, and then the bitstream is encoded in little-endian binary (LSB up).<br />
* There is a "bit width" initially set to 9 for 8-bit samples, and 17 for 16-bit samples.<br />
* The "bit width" is changed by special values inside their respective types. If such a special value is not triggered, the values are read as signed values, and unpacked<br />
* There are three types of blocks, which we will call A, B, and C.<br />
** Type A: Bit widths 1 through 6. Special value is 1 in the top bit and 0s for the rest. If such a value is triggered, it then reads 3 (8-bit) or 4 (16-bit) bits for calculating the new bit width (see below).<br />
** Type B: Bit widths 7 through n, where n is 8 for 8-bit samples and 16 for 16-bit. Special values are 0...0100 through 1...1011 for 8-bit and 0...01000 through 1...10111 for 16-bit. If such a value is triggered, subtract 0...0100 (8-bit) or 0...01000 (16-bit) and use that to calculate the new bit width (see below).<br />
** Type C: Bit width n+1. If the top bit is set, the lower 8 bits plus 1 are the new bit width.<br />
* Barring type C, the new width selected is (v+1), except where v+1 >= the previous bit width, in which case the new width is v+1.<br />
* If an invalid bit width is selected (only possible in type C), the decompressor '''terminates and leaves all the remaining values as 0 before delta decoding.'''<br />
* The defacto standard for compressed stereo samples (as set by XMPlay) is to decompress the left channel '''entirely separately''' from the right channel (where the data follows immediately afterwards), rather than decompress them together and separate afterwards.<br />
<br />
''if this is a bit too messy, feel free to tidy it up''<br />
<br />
==Playback notes==<br />
''TODO''<br />
<br />
===Resonant filters===<br />
''TODO''<br />
<br />
===Effects===<br />
<br />
====Axx====<br />
Set song speed.<br />
<br />
====Bxx====<br />
Jump to Order.<br />
*If this comes after an SBx loop command, '''the effect is done as-is'''.<br />
<br />
====Cxx====<br />
Break to row.<br />
*If this comes after an SBx loop command, '''the effect is ignored'''. ''TODO: look into how this information is relayed''<br />
<br />
====Dxx====<br />
Volume slide.<br />
<br />
====Exx====<br />
Pitch slide down.<br />
<br />
====Fxx====<br />
Pitch slide up.<br />
<br />
====Gxx====<br />
Slide to note.<br />
<br />
====Hxy====<br />
Vibrato with speed x, depth y.<br />
<br />
====Ixy====<br />
Tremor with ontime x and offtime y.<br />
<br />
====Jxy====<br />
Arpeggio.<br />
<br />
====Kxx====<br />
Dual command: H00 & Dxx<br />
<br />
====Lxx====<br />
Dual command: G00 & Dxx<br />
<br />
====Mxx====<br />
Set channel volume.<br />
* If xx is > 0x40, '''the effect is ignored.'''<br />
<br />
====Nxx====<br />
Channel volume slide.<br />
<br />
====Oxx====<br />
Set sample offset.<br />
<br />
====Pxy====<br />
Panning slide.<br />
<br />
====Qxy====<br />
Retrig.<br />
<br />
====Rxy====<br />
Tremolo with speed x, depth y.<br />
<br />
====Sxy - Miscellaneous effects====<br />
<br />
=====S0x=====<br />
Set filter. Not implemented in Impulse Tracker.<br />
<br />
* '''S00 - repeats the last nonzero Sxx effect for the channel.'''<br />
<br />
=====S1x=====<br />
Set glissando control. Not implemented in Impulse Tracker.<br />
<br />
=====S2x=====<br />
Set finetune. Not Implemented in Impulse Tracker.<br />
<br />
=====S3x=====<br />
Set vibrato waveform.<br />
<br />
Values for x:<br />
*0: Sine wave<br />
*1: Ramp down<br />
*2: Square wave<br />
*3: Random wave<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
<br />
=====S4x=====<br />
Set tremolo waveform.<br />
<br />
Uses the same waveform table as S3x. '''If x > 3, the effect is ignored.'''<br />
<br />
=====S5x=====<br />
Set panbrello waveform.<br />
<br />
Uses the same waveform table as S3x.<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
* This effect '''retriggers the panbrello waveform position'''.<br />
<br />
=====S6x=====<br />
Pattern delay for x ticks.<br />
<br />
=====S70=====<br />
Past note cut.<br />
<br />
=====S71=====<br />
Past note off.<br />
<br />
=====S72=====<br />
Past note fade.<br />
<br />
=====S73=====<br />
Set NNA to note cut.<br />
<br />
=====S74=====<br />
Set NNA to continue.<br />
<br />
=====S75=====<br />
Set NNA to note off.<br />
<br />
=====S76=====<br />
Set NNA to note fade.<br />
<br />
=====S77=====<br />
Turn off volume envelope.<br />
<br />
=====S78=====<br />
Turn on volume envelope.<br />
<br />
=====S79=====<br />
Turn off panning envelope.<br />
<br />
=====S7A=====<br />
Turn on panning envelope.<br />
<br />
=====S7B=====<br />
Turn off pitch envelope.<br />
<br />
=====S7C=====<br />
Turn on pitch envelope.<br />
<br />
=====S8x=====<br />
Set panning position.<br />
<br />
=====S91=====<br />
Set surround sound.<br />
<br />
=====SAy=====<br />
Set high value of sample offset yxx00h<br />
<br />
=====SBx=====<br />
Pattern loop.<br />
<br />
=====SCx=====<br />
Note cut after x ticks.<br />
<br />
=====SDx=====<br />
Note delay for x ticks.<br />
<br />
=====SEx=====<br />
Pattern delay for x rows<br />
<br />
=====SFx=====<br />
Set parameterised MIDI macro.<br />
<br />
====Txx====<br />
Set Tempo.<br />
<br />
====Uxy====<br />
Fine vibrato with speed x, depth y.<br />
<br />
====Vxx====<br />
Set global volume.<br />
* If xx is > 0x80, '''the effect is ignored.'''<br />
<br />
====Wxy====<br />
Global volume slide.<br />
<br />
====Xxx====<br />
Set panning position. Sets panning to '''(xx + 2) div 4'''<br />
<br />
====Yxy====<br />
Panbrello with speed x, depth y.<br />
<br />
* '''If the panbrello waveform is set to 'Random', then the speed is interpreted as a delay'''.<br />
<br />
====Zxx====<br />
MIDI Macros<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Impulse_Tracker&diff=13802Impulse Tracker2012-01-22T09:20:49Z<p>GreaseMonkey: some stuff i learnt</p>
<hr />
<div>* Extension: it<br />
<br />
==File Format==<br />
''TODO''<br />
<br />
''it would be interesting to find out how the MIDI/timestamp stuff after the pointer list works... the other TODOs I (GM) know about''<br />
<br />
==IT214 sample compression==<br />
''TODO''<br />
<br />
==Playback notes==<br />
''TODO''<br />
<br />
===Resonant filters===<br />
''TODO''<br />
<br />
===Effects===<br />
<br />
====Axx====<br />
Set song speed.<br />
<br />
====Bxx====<br />
Jump to Order.<br />
*If this comes after an SBx loop command, '''the effect is done as-is'''.<br />
<br />
====Cxx====<br />
Break to row.<br />
*If this comes after an SBx loop command, '''the effect is ignored'''. ''TODO: look into how this information is relayed''<br />
<br />
====Dxx====<br />
Volume slide.<br />
<br />
====Exx====<br />
Pitch slide down.<br />
<br />
====Fxx====<br />
Pitch slide up.<br />
<br />
====Gxx====<br />
Slide to note.<br />
<br />
====Hxy====<br />
Vibrato with speed x, depth y.<br />
<br />
====Ixy====<br />
Tremor with ontime x and offtime y.<br />
<br />
====Jxy====<br />
Arpeggio.<br />
<br />
====Kxx====<br />
Dual command: H00 & Dxx<br />
<br />
====Lxx====<br />
Dual command: G00 & Dxx<br />
<br />
====Mxx====<br />
Set channel volume.<br />
* If xx is > 0x40, '''the effect is ignored.'''<br />
<br />
====Nxx====<br />
Channel volume slide.<br />
<br />
====Oxx====<br />
Set sample offset.<br />
<br />
====Pxy====<br />
Panning slide.<br />
<br />
====Qxy====<br />
Retrig.<br />
<br />
====Rxy====<br />
Tremolo with speed x, depth y.<br />
<br />
====Sxy - Miscellaneous effects====<br />
<br />
=====S0x=====<br />
Set filter. Not implemented in Impulse Tracker.<br />
<br />
* '''S00 - repeats the last nonzero Sxx effect for the channel.'''<br />
<br />
=====S1x=====<br />
Set glissando control. Not implemented in Impulse Tracker.<br />
<br />
=====S2x=====<br />
Set finetune. Not Implemented in Impulse Tracker.<br />
<br />
=====S3x=====<br />
Set vibrato waveform.<br />
<br />
Values for x:<br />
*0: Sine wave<br />
*1: Ramp down<br />
*2: Square wave<br />
*3: Random wave<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
<br />
=====S4x=====<br />
Set tremolo waveform.<br />
<br />
Uses the same waveform table as S3x. '''If x > 3, the effect is ignored.'''<br />
<br />
=====S5x=====<br />
Set panbrello waveform.<br />
<br />
Uses the same waveform table as S3x.<br />
<br />
* '''If x > 3, the effect is ignored.'''<br />
* This effect '''retriggers the panbrello waveform position'''.<br />
<br />
=====S6x=====<br />
Pattern delay for x ticks.<br />
<br />
=====S70=====<br />
Past note cut.<br />
<br />
=====S71=====<br />
Past note off.<br />
<br />
=====S72=====<br />
Past note fade.<br />
<br />
=====S73=====<br />
Set NNA to note cut.<br />
<br />
=====S74=====<br />
Set NNA to continue.<br />
<br />
=====S75=====<br />
Set NNA to note off.<br />
<br />
=====S76=====<br />
Set NNA to note fade.<br />
<br />
=====S77=====<br />
Turn off volume envelope.<br />
<br />
=====S78=====<br />
Turn on volume envelope.<br />
<br />
=====S79=====<br />
Turn off panning envelope.<br />
<br />
=====S7A=====<br />
Turn on panning envelope.<br />
<br />
=====S7B=====<br />
Turn off pitch envelope.<br />
<br />
=====S7C=====<br />
Turn on pitch envelope.<br />
<br />
=====S8x=====<br />
Set panning position.<br />
<br />
=====S91=====<br />
Set surround sound.<br />
<br />
=====SAy=====<br />
Set high value of sample offset yxx00h<br />
<br />
=====SBx=====<br />
Pattern loop.<br />
<br />
=====SCx=====<br />
Note cut after x ticks.<br />
<br />
=====SDx=====<br />
Note delay for x ticks.<br />
<br />
=====SEx=====<br />
Pattern delay for x rows<br />
<br />
=====SFx=====<br />
Set parameterised MIDI macro.<br />
<br />
====Txx====<br />
Set Tempo.<br />
<br />
====Uxy====<br />
Fine vibrato with speed x, depth y.<br />
<br />
====Vxx====<br />
Set global volume.<br />
* If xx is > 0x80, '''the effect is ignored.'''<br />
<br />
====Wxy====<br />
Global volume slide.<br />
<br />
====Xxx====<br />
Set panning position. Sets panning to '''(xx + 2) div 4'''<br />
<br />
====Yxy====<br />
Panbrello with speed x, depth y.<br />
<br />
* '''If the panbrello waveform is set to 'Random', then the speed is interpreted as a delay'''.<br />
<br />
====Zxx====<br />
MIDI Macros<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Nintendo_Sound_Format&diff=13801Nintendo Sound Format2012-01-20T07:58:00Z<p>GreaseMonkey: here, have some info</p>
<hr />
<div>* Extension: nsf<br />
<br />
NSF files contain music playback programs extracted from [[Nintendo]] Entertainment System (NES) games.<br />
<br />
==Header==<br />
<br />
As given in the official specification:<br />
<br />
offset # of bytes Function<br />
----------------------------<br />
<br />
0000 5 STRING "NESM",01Ah ; denotes an NES sound format file<br />
0005 1 BYTE Version number (currently 01h)<br />
0006 1 BYTE Total songs (1=1 song, 2=2 songs, etc)<br />
0007 1 BYTE Starting song (1= 1st song, 2=2nd song, etc)<br />
0008 2 WORD (lo/hi) load address of data (8000-FFFF)<br />
000a 2 WORD (lo/hi) init address of data (8000-FFFF)<br />
000c 2 WORD (lo/hi) play address of data (8000-FFFF)<br />
000e 32 STRING The name of the song, null terminated<br />
002e 32 STRING The artist, if known, null terminated<br />
004e 32 STRING The Copyright holder, null terminated<br />
006e 2 WORD (lo/hi) speed, in 1/1000000th sec ticks, NTSC (see text)<br />
0070 8 BYTE Bankswitch Init Values (see text, and FDS section)<br />
0078 2 WORD (lo/hi) speed, in 1/1000000th sec ticks, PAL (see text)<br />
007a 1 BYTE PAL/NTSC bits:<br />
bit 0: if clear, this is an NTSC tune<br />
bit 0: if set, this is a PAL tune<br />
bit 1: if set, this is a dual PAL/NTSC tune<br />
bits 2-7: not used. they *must* be 0<br />
007b 1 BYTE Extra Sound Chip Support<br />
bit 0: if set, this song uses VRCVI<br />
bit 1: if set, this song uses VRCVII<br />
bit 2: if set, this song uses FDS Sound<br />
bit 3: if set, this song uses MMC5 audio<br />
bit 4: if set, this song uses Namco 106<br />
bit 5: if set, this song uses Sunsoft FME-07<br />
bits 6,7: future expansion: they *must* be 0<br />
007c 4 ---- 4 extra bytes for expansion (must be 00h)<br />
0080 nnn ---- The music program/data follows<br />
<br />
Note that only the Namco 163 has a sound expansion, not the (very similar) Namco 106 as noted.<br />
<br />
==External links==<br />
*[http://kevtris.org/nes/nsfspec.txt NES Music Format Spec] - official spec by Kevin Horton (kevtris)<br />
<br />
''TODO: this isn't actually a "music pattern format" - it's an executable one.''<br />
<br />
[[Category:Container Formats]]<br />
[[Category:Music Pattern Formats]]<br />
[[Category:Formats missing in FFmpeg]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13656Scream Tracker 3 Module2011-10-05T12:22:13Z<p>GreaseMonkey: /* Sxy */ marked this as "use last nonzero effect" by request of Saga_Musix</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels). While the format itself can technically support 32 channels, only the 25 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
**Tracker version<br />
***0x1xyy == Scream Tracker x.yy<br />
***0x2xyy == Imago Orpheus x.yy<br />
***0x3xyy == Impulse Tracker x.yy<br />
***0x4xyy == Schism Tracker (version numbering scheme is different)<br />
***0x5xyy == OpenMPT<br />
**File format information<br />
***1 == signed samples (horribly, horribly old)<br />
***2 == unsigned samples<br />
***Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and the previous value used when you loaded the song is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and the previous value used when you loaded the song is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - these are unused.<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is '''14317456 Hz''' (documentation '''incorrectly says''' 14317056 Hz, correct value is the expected 8363*1712). When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
Many effects use the '''latest nonzero effect parameter encountered''', as noted a bit further below.<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
Effects marked with a % use '''the latest nonzero effect parameter to show up'''. Effects with a * have their own memory.<br />
<br />
===Axx===<br />
Set speed. If the parameter '''is 0''', the effect is '''ignored'''.<br />
<br />
===Bxx===<br />
Order jump.<br />
<br />
===Cxy===<br />
Jump to row x*10 + y. The value provided is in '''decimal'''. If the row number specified '''is 64 or higher, the effect is ignored'''.<br />
<br />
===Dxy (%)===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is <= 0x1300), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume'''.<br />
<br />
The checking order is not the same as ImpulseTracker.<br />
<br />
Here's a full detailed description of all possible cases (0x00..0xFF) and how both Scream Tracker and Impulse Tracker handle them:<br />
*D0x, 1 <= x <= 0xE: slide down by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*Dx0, 1 <= x <= 0xE: slide up by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*DFx, 1 <= x <= 0xE: slide down by x on tick 0.<br />
*DxF, 1 <= x <= 0xE: slide up by x on tick 0.<br />
*DFF: slide up by 15 on tick 0.<br />
*D0F: slide down by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*DF0: slide up by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*Dxy, 1 <= x <= 0xE, 1 <= y <= 0xE: Scream Tracker treats it as a slide down by y, i.e. equivalent to D0y. Impulse Tracker does nothing.<br />
*D00: Scream Tracker uses the last nonzero effect parameter in the channel. Impulse Tracker uses the last nonzero value used for Dxx, Kxx or Lxx in the channel.<br />
<br />
===Exx (%)===<br />
Slide down.<br />
<br />
===Fxx (%)===<br />
Slide up.<br />
<br />
===Gxx (*)===<br />
Slide to note.<br />
<br />
Peculiarities in the Scream Tracker implementation of this effect:<br />
*If the current note is empty, the destination note is set to the '''last note''' to show up in the channel, '''even if it has occurred without the Gxx effect'''.<br />
*Gxx '''doesn't clear the target note''' when it is reached, so any future Gxx with no note will keep sliding back to this particular note.<br />
<br />
===Hxy (*)===<br />
Vibrato. This effect '''shares memory''' with '''Uxy'''.<br />
<br />
===Ixy (%)===<br />
Tremor. ''TODO: this effect is weird.''<br />
<br />
(Looking through what's released of the ST3 playback source code, tremor is not retriggered if there's a Dxy effect, or something like that, but this needs to be clarified.)<br />
<br />
===Jxy (%)===<br />
Arpeggio. ''TODO: this effect is weird.''<br />
<br />
===Kxy (%)===<br />
H00 + Dxy.<br />
<br />
The volume slide, performed by this effect differs from Dxy in the following ways:<br />
* '''The first tick of this effect is ignored.''' This is due to a no-op in the "first tick" pointer table.<br />
* As a result of the previous point, fine slides do not work. However, '''the "other" effect''' (H00 in case of Kxy; G00 in case of Lxy) ''' is also not performed when a fine volume slide is requested.'''<br />
<br />
===Lxy (%)===<br />
G00 + Dxy.<br />
<br />
The volume slide '''differs from Dxy'''. See '''Kxy''' for details.<br />
<br />
===Oxx (*)===<br />
Set sample offset.<br />
<br />
===Qxy (%)===<br />
Retrigger note every y ticks with volume modifier x.<br />
<br />
Values for x:<br />
*0: 0<br />
*1: -1<br />
*2: -2<br />
*3: -4<br />
*4: -8<br />
*5: -16<br />
*6: *2/3<br />
*7: *1/2<br />
*8: ?<br />
*9: 1<br />
*A: 2<br />
*B: 4<br />
*C: 8<br />
*D: 16<br />
*E: *3/2<br />
*F: *2<br />
<br />
'''6 isn't exactly *2/3.''' It seems to use the following table:<br />
<br />
TwoThirds: array [0..63] of Byte =<br />
( 0, 0, 1, 1, 2, 3, 3, 4, 5, 5, 6, 6, 7, 8, 8, 9,<br />
10, 10, 11, 11, 12, 13, 13, 14, 15, 15, 16, 16, 17, 18, 18, 19,<br />
20, 20, 21, 21, 22, 23, 23, 24, 25, 25, 26, 26, 27, 28, 28, 29,<br />
30, 30, 31, 31, 32, 33, 33, 34, 35, 35, 36, 36, 37, 38, 38, 39);<br />
<br />
This effect changes only the active volume, '''without modifying the stored volume.'''<br />
<br />
===Rxy (%)===<br />
Tremolo. x*4 is speed, y*4 is depth. This effect is screwy, but not as screwy as previously documented.<br />
<br />
*Get xy from the '''latest nonzero effect parameter''' to appear in the channel.<br />
*'''On tick 1''' (the '''second''' tick of the row) set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*'''If the song speed (not tremolo speed, but song speed - ticks per row) is 1, the active volume is also untouched. It is not set to the stored volume!'''<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
===Sxy (%)===<br />
Miscellaneous effects.<br />
<br />
''TODO: check what value xy is taken for Sxy''<br />
<br />
====S0x====<br />
Set filter. Not implemented in Scream Tracker 3.<br />
<br />
====S1x====<br />
Set glissando control.<br />
<br />
====S2x====<br />
Set finetune.<br />
<br />
====S3x====<br />
Set vibrato waveform.<br />
<br />
====S4x====<br />
Set tremolo waveform.<br />
<br />
====S8x====<br />
Set panning position. Scream Tracker 3 supports this only on the Gravis Ultrasound.<br />
<br />
====SAx====<br />
Old stereo control. This appears in PANIC.S3M, but may have been removed since Scream Tracker 3.01 BETA. libmodplug, and in turn SchismTracker, convert these to S8x effects.<br />
<br />
''TODO: work out how SAx converts to S8x effects.''<br />
<br />
====SBx====<br />
Loop pattern.<br />
<br />
Unlike other trackers, '''the loopback info (i.e. the loopback point and counter) is global''' and not per channel.<br />
<br />
====SCx====<br />
Note cut after x ticks.<br />
<br />
*If '''the argument is 0''', the effect '''is ignored'''.<br />
*When the note is cut, the volume is '''not''' set to 0. Instead playback is temporarily '''frozen''' and may be '''resumed by a following Exx, Fxx, Gxx, Hxx, Jxx, Kxx, Lxx or Uxx command'''.<br />
<br />
====SDx====<br />
Note delay for x ticks.<br />
<br />
====SEx====<br />
Pattern delay for x rows.<br />
<br />
====SFx====<br />
FunkRepeat. Not implemented in Scream Tracker 3.<br />
<br />
===Txx===<br />
Set tempo. If the parameter is '''less than 33''', the effect is '''ignored'''.<br />
<br />
===Uxy (*)===<br />
Fine vibrato. This effect '''shares memory''' with '''Hxy'''.<br />
<br />
===Vxx===<br />
Set global volume. This effect has several quirks:<br />
<br />
*Normally, it does not affect events on the same row, where the effect is set. However, '''there are some exceptions to that rule''', read below for details.<br />
*It does not affect past notes, that are still playing, unless '''their volume is changed''', which '''applies the new global volume to that voice''' as well.<br />
*This effect '''is actually processed on tick 1 (that is the second tick)''' of the row. This has several consequences:<br />
**The effect '''doesn't do anything''', if '''the current speed is 1'''.<br />
**The effect '''is applied to notes on the current row, that have a note delay effect''' (SDx with x >= 1). For notes on the same row '''that have a note delay of 1 tick''', the effect is only applied to '''channels, that are processed after''' the channel with the set global volume effect. For notes on the same row that have a '''note delay of 2 ticks or more''', the effect is applied '''regardless of the relative position of the channel''' in the processing order. ''TODO: Document the processing order, since it isn't very obvious (I think it's L1, L2, ..., L8, R1, R2, ..., R8, but I'm not 100% sure).''<br />
**The effect '''is also applied''' on the same row if anything updates the note volume '''on tick 1''' or '''tick 2''' (depends on processing order), like the '''Dxx effect''' (when doing a non-fine slide, of course).<br />
*Vxx with parameter '''values higher than 0x40''' are '''ignored'''.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13399Scream Tracker 3 Module2011-04-03T05:45:56Z<p>GreaseMonkey: /* File Format */ storlek pointed out an inaccuracy.</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels). While the format itself can technically support 32 channels, only the 25 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**0x2xyy == Imago Orpheus x.yy<br />
**0x3xyy == Impulse Tracker x.yy<br />
**0x4xyy == Schism Tracker (version numbering scheme is different)<br />
**0x5xyy == OpenMPT<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and the previous value used when you loaded the song is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and the previous value used when you loaded the song is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - these are unused.<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is '''14317456 Hz''' (documentation '''incorrectly says''' 14317056 Hz, correct value is the expected 8363*1712). When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
Many effects use the '''latest nonzero effect parameter encountered''', as noted a bit further below.<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
Effects marked with a % use '''the latest nonzero effect parameter to show up'''. Effects with a * have their own memory.<br />
<br />
===Axx===<br />
Set speed. If the parameter '''is 0''', the effect is '''ignored'''.<br />
<br />
===Bxx===<br />
Order jump.<br />
<br />
===Cxy===<br />
Jump to row x*10 + y. The value provided is in '''decimal'''. If the row number specified '''is 64 or higher, the effect is ignored'''.<br />
<br />
===Dxy (%)===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is <= 0x1300), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume'''.<br />
<br />
The checking order is not the same as ImpulseTracker.<br />
<br />
Here's a full detailed description of all possible cases (0x00..0xFF) and how both Scream Tracker and Impulse Tracker handle them:<br />
*D0x, 1 <= x <= 0xE: slide down by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*Dx0, 1 <= x <= 0xE: slide up by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*DFx, 1 <= x <= 0xE: slide down by x on tick 0.<br />
*DxF, 1 <= x <= 0xE: slide up by x on tick 0.<br />
*DFF: slide up by 15 on tick 0.<br />
*D0F: slide down by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*DF0: slide up by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*Dxy, 1 <= x <= 0xE, 1 <= y <= 0xE: Scream Tracker treats it as a slide down by y, i.e. equivalent to D0y. Impulse Tracker does nothing.<br />
*D00: Scream Tracker uses the last nonzero effect parameter in the channel. Impulse Tracker uses the last nonzero value used for Dxx, Kxx or Lxx in the channel.<br />
<br />
===Exx (%)===<br />
Slide down.<br />
<br />
===Fxx (%)===<br />
Slide up.<br />
<br />
===Gxx (*)===<br />
Slide to note.<br />
<br />
Peculiarities in the Scream Tracker implementation of this effect:<br />
*If the current note is empty, the destination note is set to the '''last note''' to show up in the channel, '''even if it has occurred without the Gxx effect'''.<br />
*Gxx '''doesn't clear the target note''' when it is reached, so any future Gxx with no note will keep sliding back to this particular note.<br />
<br />
===Hxy (*)===<br />
Vibrato. This effect '''shares memory''' with '''Uxy'''.<br />
<br />
===Ixy (%)===<br />
Tremor. ''TODO: this effect is weird.''<br />
<br />
(Looking through what's released of the ST3 playback source code, tremor is not retriggered if there's a Dxy effect, or something like that, but this needs to be clarified.)<br />
<br />
===Jxy (%)===<br />
Arpeggio. ''TODO: this effect is weird.''<br />
<br />
===Kxy (%)===<br />
H00 + Dxy.<br />
<br />
The volume slide, performed by this effect differs from Dxy in the following ways:<br />
* '''The first tick of this effect is ignored.''' This is due to a no-op in the "first tick" pointer table.<br />
<br />
===Lxy (%)===<br />
G00 + Dxy.<br />
<br />
The volume slide '''differs from Dxy'''. See '''Kxy''' for details.<br />
<br />
===Oxx (*)===<br />
Set sample offset.<br />
<br />
===Qxy (%)===<br />
Retrigger note every y ticks with volume modifier x.<br />
<br />
Values for x:<br />
*0: 0<br />
*1: -1<br />
*2: -2<br />
*3: -4<br />
*4: -8<br />
*5: -16<br />
*6: *2/3<br />
*7: *1/2<br />
*8: ?<br />
*9: 1<br />
*A: 2<br />
*B: 4<br />
*C: 8<br />
*D: 16<br />
*E: *3/2<br />
*F: *2<br />
<br />
'''6 isn't exactly *2/3.''' It seems to use the following table:<br />
<br />
TwoThirds: array [0..63] of Byte =<br />
( 0, 0, 1, 1, 2, 3, 3, 4, 5, 5, 6, 6, 7, 8, 8, 9,<br />
10, 10, 11, 11, 12, 13, 13, 14, 15, 15, 16, 16, 17, 18, 18, 19,<br />
20, 20, 21, 21, 22, 23, 23, 24, 25, 25, 26, 26, 27, 28, 28, 29,<br />
30, 30, 31, 31, 32, 33, 33, 34, 35, 35, 36, 36, 37, 38, 38, 39);<br />
<br />
This effect changes only the active volume, '''without modifying the stored volume.'''<br />
<br />
===Rxy (%)===<br />
Tremolo. x*4 is speed, y*4 is depth. This effect is screwy, but not as screwy as previously documented.<br />
<br />
*Get xy from the '''latest nonzero effect parameter''' to appear in the channel.<br />
*'''On tick 1''' (the '''second''' tick of the row) set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*'''If the song speed (not tremolo speed, but song speed - ticks per row) is 1, the active volume is also untouched. It is not set to the stored volume!'''<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
===Sxy===<br />
Miscellaneous effects.<br />
<br />
''TODO: check what value xy is taken for Sxy''<br />
<br />
====S0x====<br />
Set filter. Not implemented in Scream Tracker 3.<br />
<br />
====S1x====<br />
Set glissando control.<br />
<br />
====S2x====<br />
Set finetune.<br />
<br />
====S3x====<br />
Set vibrato waveform.<br />
<br />
====S4x====<br />
Set tremolo waveform.<br />
<br />
====S8x====<br />
Set panning position. Scream Tracker 3 supports this only on the Gravis Ultrasound.<br />
<br />
====SAx====<br />
Old stereo control. This appears in PANIC.S3M, but may have been removed since Scream Tracker 3.01 BETA. libmodplug, and in turn SchismTracker, convert these to S8x effects.<br />
<br />
''TODO: work out how SAx converts to S8x effects.''<br />
<br />
====SBx====<br />
Loop pattern.<br />
<br />
====SCx====<br />
Note cut after x ticks.<br />
<br />
*If '''the argument is 0''', the effect '''is ignored'''.<br />
*When the note is cut, the volume is '''not''' set to 0. Instead playback is temporarily '''frozen''' and may be '''resumed by a following Exx, Fxx, Gxx, Hxx, Jxx, Kxx, Lxx or Uxx command'''.<br />
<br />
====SDx====<br />
Note delay for x ticks.<br />
<br />
====SEx====<br />
Pattern delay for x rows.<br />
<br />
====SFx====<br />
FunkRepeat. Not implemented in Scream Tracker 3.<br />
<br />
===Txx===<br />
Set tempo. If the parameter is '''less than 33''', the effect is '''ignored'''.<br />
<br />
===Uxy (*)===<br />
Fine vibrato. This effect '''shares memory''' with '''Hxy'''.<br />
<br />
===Vxx===<br />
Set global volume. This effect has several quirks:<br />
<br />
*Normally, it does not affect events on the same row, where the effect is set. However, '''there are some exceptions to that rule''', read below for details.<br />
*It does not affect past notes, that are still playing, unless '''their volume is changed''', which '''applies the new global volume to that voice''' as well.<br />
*This effect '''is actually processed on tick 1 (that is the second tick)''' of the row. This has several consequences:<br />
**The effect '''doesn't do anything''', if '''the current speed is 1'''.<br />
**The effect '''is applied to notes on the current row, that have a note delay effect''' (SDx with x >= 1). For notes on the same row '''that have a note delay of 1 tick''', the effect is only applied to '''channels, that are processed after''' the channel with the set global volume effect. For notes on the same row that have a '''note delay of 2 ticks or more''', the effect is applied '''regardless of the relative position of the channel''' in the processing order. ''TODO: Document the processing order, since it isn't very obvious (I think it's L1, L2, ..., L8, R1, R2, ..., R8, but I'm not 100% sure).''<br />
**The effect '''is also applied''' on the same row if anything updates the note volume '''on tick 1''' or '''tick 2''' (depends on processing order), like the '''Dxx effect''' (when doing a non-fine slide, of course).<br />
*Vxx with parameter '''values higher than 0x40''' are '''ignored'''.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13398Scream Tracker 3 Module2011-04-03T05:34:27Z<p>GreaseMonkey: /* Dxy (%) */ TODOne. Why was that still there?</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels). While the format itself can technically support 32 channels, only the 25 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**0x2xyy == Imago Orpheus x.yy<br />
**0x3xyy == Impulse Tracker x.yy<br />
**0x4xyy == Schism Tracker (version numbering scheme is different)<br />
**0x5xyy == OpenMPT<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is '''14317456 Hz''' (documentation '''incorrectly says''' 14317056 Hz, correct value is the expected 8363*1712). When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
Many effects use the '''latest nonzero effect parameter encountered''', as noted a bit further below.<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
Effects marked with a % use '''the latest nonzero effect parameter to show up'''. Effects with a * have their own memory.<br />
<br />
===Axx===<br />
Set speed. If the parameter '''is 0''', the effect is '''ignored'''.<br />
<br />
===Bxx===<br />
Order jump.<br />
<br />
===Cxy===<br />
Jump to row x*10 + y. The value provided is in '''decimal'''. If the row number specified '''is 64 or higher, the effect is ignored'''.<br />
<br />
===Dxy (%)===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is <= 0x1300), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume'''.<br />
<br />
The checking order is not the same as ImpulseTracker.<br />
<br />
Here's a full detailed description of all possible cases (0x00..0xFF) and how both Scream Tracker and Impulse Tracker handle them:<br />
*D0x, 1 <= x <= 0xE: slide down by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*Dx0, 1 <= x <= 0xE: slide up by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*DFx, 1 <= x <= 0xE: slide down by x on tick 0.<br />
*DxF, 1 <= x <= 0xE: slide up by x on tick 0.<br />
*DFF: slide up by 15 on tick 0.<br />
*D0F: slide down by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*DF0: slide up by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*Dxy, 1 <= x <= 0xE, 1 <= y <= 0xE: Scream Tracker treats it as a slide down by y, i.e. equivalent to D0y. Impulse Tracker does nothing.<br />
*D00: Scream Tracker uses the last nonzero effect parameter in the channel. Impulse Tracker uses the last nonzero value used for Dxx, Kxx or Lxx in the channel.<br />
<br />
===Exx (%)===<br />
Slide down.<br />
<br />
===Fxx (%)===<br />
Slide up.<br />
<br />
===Gxx (*)===<br />
Slide to note.<br />
<br />
Peculiarities in the Scream Tracker implementation of this effect:<br />
*If the current note is empty, the destination note is set to the '''last note''' to show up in the channel, '''even if it has occurred without the Gxx effect'''.<br />
*Gxx '''doesn't clear the target note''' when it is reached, so any future Gxx with no note will keep sliding back to this particular note.<br />
<br />
===Hxy (*)===<br />
Vibrato. This effect '''shares memory''' with '''Uxy'''.<br />
<br />
===Ixy (%)===<br />
Tremor. ''TODO: this effect is weird.''<br />
<br />
(Looking through what's released of the ST3 playback source code, tremor is not retriggered if there's a Dxy effect, or something like that, but this needs to be clarified.)<br />
<br />
===Jxy (%)===<br />
Arpeggio. ''TODO: this effect is weird.''<br />
<br />
===Kxy (%)===<br />
H00 + Dxy.<br />
<br />
The volume slide, performed by this effect differs from Dxy in the following ways:<br />
* '''The first tick of this effect is ignored.''' This is due to a no-op in the "first tick" pointer table.<br />
<br />
===Lxy (%)===<br />
G00 + Dxy.<br />
<br />
The volume slide '''differs from Dxy'''. See '''Kxy''' for details.<br />
<br />
===Oxx (*)===<br />
Set sample offset.<br />
<br />
===Qxy (%)===<br />
Retrigger note every y ticks with volume modifier x.<br />
<br />
Values for x:<br />
*0: 0<br />
*1: -1<br />
*2: -2<br />
*3: -4<br />
*4: -8<br />
*5: -16<br />
*6: *2/3<br />
*7: *1/2<br />
*8: ?<br />
*9: 1<br />
*A: 2<br />
*B: 4<br />
*C: 8<br />
*D: 16<br />
*E: *3/2<br />
*F: *2<br />
<br />
'''6 isn't exactly *2/3.''' It seems to use the following table:<br />
<br />
TwoThirds: array [0..63] of Byte =<br />
( 0, 0, 1, 1, 2, 3, 3, 4, 5, 5, 6, 6, 7, 8, 8, 9,<br />
10, 10, 11, 11, 12, 13, 13, 14, 15, 15, 16, 16, 17, 18, 18, 19,<br />
20, 20, 21, 21, 22, 23, 23, 24, 25, 25, 26, 26, 27, 28, 28, 29,<br />
30, 30, 31, 31, 32, 33, 33, 34, 35, 35, 36, 36, 37, 38, 38, 39);<br />
<br />
This effect changes only the active volume, '''without modifying the stored volume.'''<br />
<br />
===Rxy (%)===<br />
Tremolo. x*4 is speed, y*4 is depth. This effect is screwy, but not as screwy as previously documented.<br />
<br />
*Get xy from the '''latest nonzero effect parameter''' to appear in the channel.<br />
*'''On tick 1''' (the '''second''' tick of the row) set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*'''If the song speed (not tremolo speed, but song speed - ticks per row) is 1, the active volume is also untouched. It is not set to the stored volume!'''<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
===Sxy===<br />
Miscellaneous effects.<br />
<br />
''TODO: check what value xy is taken for Sxy''<br />
<br />
====S0x====<br />
Set filter. Not implemented in Scream Tracker 3.<br />
<br />
====S1x====<br />
Set glissando control.<br />
<br />
====S2x====<br />
Set finetune.<br />
<br />
====S3x====<br />
Set vibrato waveform.<br />
<br />
====S4x====<br />
Set tremolo waveform.<br />
<br />
====S8x====<br />
Set panning position. Scream Tracker 3 supports this only on the Gravis Ultrasound.<br />
<br />
====SAx====<br />
Old stereo control. This appears in PANIC.S3M, but may have been removed since Scream Tracker 3.01 BETA. libmodplug, and in turn SchismTracker, convert these to S8x effects.<br />
<br />
''TODO: work out how SAx converts to S8x effects.''<br />
<br />
====SBx====<br />
Loop pattern.<br />
<br />
====SCx====<br />
Note cut after x ticks.<br />
<br />
*If '''the argument is 0''', the effect '''is ignored'''.<br />
*When the note is cut, the volume is '''not''' set to 0. Instead playback is temporarily '''frozen''' and may be '''resumed by a following Exx, Fxx, Gxx, Hxx, Jxx, Kxx, Lxx or Uxx command'''.<br />
<br />
====SDx====<br />
Note delay for x ticks.<br />
<br />
====SEx====<br />
Pattern delay for x rows.<br />
<br />
====SFx====<br />
FunkRepeat. Not implemented in Scream Tracker 3.<br />
<br />
===Txx===<br />
Set tempo. If the parameter is '''less than 33''', the effect is '''ignored'''.<br />
<br />
===Uxy (*)===<br />
Fine vibrato. This effect '''shares memory''' with '''Hxy'''.<br />
<br />
===Vxx===<br />
Set global volume. This effect has several quirks:<br />
<br />
*Normally, it does not affect events on the same row, where the effect is set. However, '''there are some exceptions to that rule''', read below for details.<br />
*It does not affect past notes, that are still playing, unless '''their volume is changed''', which '''applies the new global volume to that voice''' as well.<br />
*This effect '''is actually processed on tick 1 (that is the second tick)''' of the row. This has several consequences:<br />
**The effect '''doesn't do anything''', if '''the current speed is 1'''.<br />
**The effect '''is applied to notes on the current row, that have a note delay effect''' (SDx with x >= 1). For notes on the same row '''that have a note delay of 1 tick''', the effect is only applied to '''channels, that are processed after''' the channel with the set global volume effect. For notes on the same row that have a '''note delay of 2 ticks or more''', the effect is applied '''regardless of the relative position of the channel''' in the processing order. ''TODO: Document the processing order, since it isn't very obvious (I think it's L1, L2, ..., L8, R1, R2, ..., R8, but I'm not 100% sure).''<br />
**The effect '''is also applied''' on the same row if anything updates the note volume '''on tick 1''' or '''tick 2''' (depends on processing order), like the '''Dxx effect''' (when doing a non-fine slide, of course).<br />
*Vxx with parameter '''values higher than 0x40''' are '''ignored'''.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13384Scream Tracker 3 Module2011-03-29T00:58:48Z<p>GreaseMonkey: /* SAx */ panic.s3m, anyone?</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels). While the format itself can technically support 32 channels, only the 25 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**0x2xyy == Imago Orpheus x.yy<br />
**0x3xyy == Impulse Tracker x.yy<br />
**0x4xyy == Schism Tracker (version numbering scheme is different)<br />
**0x5xyy == OpenMPT<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is '''14317456 Hz''' (documentation '''incorrectly says''' 14317056 Hz, correct value is the expected 8363*1712). When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
Many effects use the '''latest nonzero effect parameter encountered''', as noted a bit further below.<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
Effects marked with a % use '''the latest nonzero effect parameter to show up'''. Effects with a * have their own memory.<br />
<br />
===Axx===<br />
Set speed. If the parameter '''is 0''', the effect is '''ignored'''.<br />
<br />
===Bxx===<br />
Order jump.<br />
<br />
===Cxy===<br />
Jump to row x*10 + y. The value provided is in '''decimal'''. If the row number specified '''is 64 or higher, the effect is ignored'''.<br />
<br />
===Dxy (%)===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is <= 0x1300), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume'''.<br />
<br />
The checking order is not the same as ImpulseTracker.<br />
''TODO: Nail the checking order. D13 for instance slides down 3.''<br />
<br />
Here's a full detailed description of all possible cases (0x00..0xFF) and how both Scream Tracker and Impulse Tracker handle them:<br />
*D0x, 1 <= x <= 0xE: slide down by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*Dx0, 1 <= x <= 0xE: slide up by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*DFx, 1 <= x <= 0xE: slide down by x on tick 0.<br />
*DxF, 1 <= x <= 0xE: slide up by x on tick 0.<br />
*DFF: slide up by 15 on tick 0.<br />
*D0F: slide down by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*DF0: slide up by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*Dxy, 1 <= x <= 0xE, 1 <= y <= 0xE: Scream Tracker treats it as a slide down by y, i.e. equivalent to D0y. Impulse Tracker does nothing.<br />
*D00: Scream Tracker uses the last nonzero effect parameter in the channel. Impulse Tracker uses the last nonzero value used for Dxx, Kxx or Lxx in the channel.<br />
<br />
===Exx (%)===<br />
Slide down.<br />
<br />
===Fxx (%)===<br />
Slide up.<br />
<br />
===Gxx (*)===<br />
Slide to note.<br />
<br />
Peculiarities in the Scream Tracker implementation of this effect:<br />
*If the current note is empty, the destination note is set to the '''last note''' to show up in the channel, '''even if it has occurred without the Gxx effect'''.<br />
*Gxx '''doesn't clear the target note''' when it is reached, so any future Gxx with no note will keep sliding back to this particular note.<br />
<br />
===Hxy (*)===<br />
Vibrato. This effect '''shares memory''' with '''Uxy'''.<br />
<br />
===Ixy (%)===<br />
Tremor. ''TODO: this effect is weird.''<br />
<br />
(Looking through what's released of the ST3 playback source code, tremor is not retriggered if there's a Dxy effect, or something like that, but this needs to be clarified.)<br />
<br />
===Jxy (%)===<br />
Arpeggio. ''TODO: this effect is weird.''<br />
<br />
===Kxy (%)===<br />
H00 + Dxy.<br />
<br />
The volume slide, performed by this effect differs from Dxy in the following ways:<br />
* '''The first tick of this effect is ignored.''' This is due to a no-op in the "first tick" pointer table.<br />
<br />
===Lxy (%)===<br />
G00 + Dxy.<br />
<br />
The volume slide '''differs from Dxy'''. See '''Kxy''' for details.<br />
<br />
===Oxx (*)===<br />
Set sample offset.<br />
<br />
===Qxy (%)===<br />
Retrigger note every y ticks with volume modifier x.<br />
<br />
Values for x:<br />
*0: 0<br />
*1: -1<br />
*2: -2<br />
*3: -4<br />
*4: -8<br />
*5: -16<br />
*6: *2/3<br />
*7: *1/2<br />
*8: ?<br />
*9: 1<br />
*A: 2<br />
*B: 4<br />
*C: 8<br />
*D: 16<br />
*E: *3/2<br />
*F: *2<br />
<br />
'''6 isn't exactly *2/3.''' It seems to use the following table:<br />
<br />
TwoThirds: array [0..63] of Byte =<br />
( 0, 0, 1, 1, 2, 3, 3, 4, 5, 5, 6, 6, 7, 8, 8, 9,<br />
10, 10, 11, 11, 12, 13, 13, 14, 15, 15, 16, 16, 17, 18, 18, 19,<br />
20, 20, 21, 21, 22, 23, 23, 24, 25, 25, 26, 26, 27, 28, 28, 29,<br />
30, 30, 31, 31, 32, 33, 33, 34, 35, 35, 36, 36, 37, 38, 38, 39);<br />
<br />
This effect changes only the active volume, '''without modifying the stored volume.'''<br />
<br />
===Rxy (%)===<br />
Tremolo. x*4 is speed, y*4 is depth. This effect is screwy, but not as screwy as previously documented.<br />
<br />
*Get xy from the '''latest nonzero effect parameter''' to appear in the channel.<br />
*'''On tick 1''' (the '''second''' tick of the row) set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*'''If the song speed (not tremolo speed, but song speed - ticks per row) is 1, the active volume is also untouched. It is not set to the stored volume!'''<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
===Sxy===<br />
Miscellaneous effects.<br />
<br />
''TODO: check what value xy is taken for Sxy''<br />
<br />
====S0x====<br />
Set filter. Not implemented in Scream Tracker 3.<br />
<br />
====S1x====<br />
Set glissando control.<br />
<br />
====S2x====<br />
Set finetune.<br />
<br />
====S3x====<br />
Set vibrato waveform.<br />
<br />
====S4x====<br />
Set tremolo waveform.<br />
<br />
====S8x====<br />
Set panning position. Scream Tracker 3 supports this only on the Gravis Ultrasound.<br />
<br />
====SAx====<br />
Old stereo control. This appears in PANIC.S3M, but may have been removed since Scream Tracker 3.01 BETA. libmodplug, and in turn SchismTracker, convert these to S8x effects.<br />
<br />
''TODO: work out how SAx converts to S8x effects.''<br />
<br />
====SBx====<br />
Loop pattern.<br />
<br />
====SCx====<br />
Note cut after x ticks.<br />
<br />
*If '''the argument is 0''', the effect '''is ignored'''.<br />
*When the note is cut, the volume is '''not''' set to 0. Instead playback is temporarily '''frozen''' and may be '''resumed by a following Exx, Fxx, Gxx, Hxx, Jxx, Kxx, Lxx or Uxx command'''.<br />
<br />
====SDx====<br />
Note delay for x ticks.<br />
<br />
====SEx====<br />
Pattern delay for x rows.<br />
<br />
====SFx====<br />
FunkRepeat. Not implemented in Scream Tracker 3.<br />
<br />
===Txx===<br />
Set tempo. If the parameter is '''less than 33''', the effect is '''ignored'''.<br />
<br />
===Uxy (*)===<br />
Fine vibrato. This effect '''shares memory''' with '''Hxy'''.<br />
<br />
===Vxx===<br />
Set global volume. This effect has several quirks:<br />
<br />
*Normally, it does not affect events on the same row, where the effect is set. However, '''there are some exceptions to that rule''', read below for details.<br />
*It does not affect past notes, that are still playing, unless '''their volume is changed''', which '''applies the new global volume to that voice''' as well.<br />
*This effect '''is actually processed on tick 1 (that is the second tick)''' of the row. This has several consequences:<br />
**The effect '''doesn't do anything''', if '''the current speed is 1'''.<br />
**The effect '''is applied to notes on the current row, that have a note delay effect''' (SDx with x >= 1). For notes on the same row '''that have a note delay of 1 tick''', the effect is only applied to '''channels, that are processed after''' the channel with the set global volume effect. For notes on the same row that have a '''note delay of 2 ticks or more''', the effect is applied '''regardless of the relative position of the channel''' in the processing order. ''TODO: Document the processing order, since it isn't very obvious (I think it's L1, L2, ..., L8, R1, R2, ..., R8, but I'm not 100% sure).''<br />
**The effect '''is also applied''' on the same row if anything updates the note volume '''on tick 1''' or '''tick 2''' (depends on processing order), like the '''Dxx effect''' (when doing a non-fine slide, of course).<br />
*Vxx with parameter '''values higher than 0x40''' are '''ignored'''.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13383Scream Tracker 3 Module2011-03-29T00:44:10Z<p>GreaseMonkey: /* Vxx */ grammar got ran over by a reindeer</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels). While the format itself can technically support 32 channels, only the 25 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**0x2xyy == Imago Orpheus x.yy<br />
**0x3xyy == Impulse Tracker x.yy<br />
**0x4xyy == Schism Tracker (version numbering scheme is different)<br />
**0x5xyy == OpenMPT<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is '''14317456 Hz''' (documentation '''incorrectly says''' 14317056 Hz, correct value is the expected 8363*1712). When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
Many effects use the '''latest nonzero effect parameter encountered''', as noted a bit further below.<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
Effects marked with a % use '''the latest nonzero effect parameter to show up'''. Effects with a * have their own memory.<br />
<br />
===Axx===<br />
Set speed. If the parameter '''is 0''', the effect is '''ignored'''.<br />
<br />
===Bxx===<br />
Order jump.<br />
<br />
===Cxy===<br />
Jump to row x*10 + y. The value provided is in '''decimal'''. If the row number specified '''is 64 or higher, the effect is ignored'''.<br />
<br />
===Dxy (%)===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is <= 0x1300), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume'''.<br />
<br />
The checking order is not the same as ImpulseTracker.<br />
''TODO: Nail the checking order. D13 for instance slides down 3.''<br />
<br />
Here's a full detailed description of all possible cases (0x00..0xFF) and how both Scream Tracker and Impulse Tracker handle them:<br />
*D0x, 1 <= x <= 0xE: slide down by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*Dx0, 1 <= x <= 0xE: slide up by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*DFx, 1 <= x <= 0xE: slide down by x on tick 0.<br />
*DxF, 1 <= x <= 0xE: slide up by x on tick 0.<br />
*DFF: slide up by 15 on tick 0.<br />
*D0F: slide down by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*DF0: slide up by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*Dxy, 1 <= x <= 0xE, 1 <= y <= 0xE: Scream Tracker treats it as a slide down by y, i.e. equivalent to D0y. Impulse Tracker does nothing.<br />
*D00: Scream Tracker uses the last nonzero effect parameter in the channel. Impulse Tracker uses the last nonzero value used for Dxx, Kxx or Lxx in the channel.<br />
<br />
===Exx (%)===<br />
Slide down.<br />
<br />
===Fxx (%)===<br />
Slide up.<br />
<br />
===Gxx (*)===<br />
Slide to note.<br />
<br />
Peculiarities in the Scream Tracker implementation of this effect:<br />
*If the current note is empty, the destination note is set to the '''last note''' to show up in the channel, '''even if it has occurred without the Gxx effect'''.<br />
*Gxx '''doesn't clear the target note''' when it is reached, so any future Gxx with no note will keep sliding back to this particular note.<br />
<br />
===Hxy (*)===<br />
Vibrato. This effect '''shares memory''' with '''Uxy'''.<br />
<br />
===Ixy (%)===<br />
Tremor. ''TODO: this effect is weird.''<br />
<br />
(Looking through what's released of the ST3 playback source code, tremor is not retriggered if there's a Dxy effect, or something like that, but this needs to be clarified.)<br />
<br />
===Jxy (%)===<br />
Arpeggio. ''TODO: this effect is weird.''<br />
<br />
===Kxy (%)===<br />
H00 + Dxy.<br />
<br />
The volume slide, performed by this effect differs from Dxy in the following ways:<br />
* '''The first tick of this effect is ignored.''' This is due to a no-op in the "first tick" pointer table.<br />
<br />
===Lxy (%)===<br />
G00 + Dxy.<br />
<br />
The volume slide '''differs from Dxy'''. See '''Kxy''' for details.<br />
<br />
===Oxx (*)===<br />
Set sample offset.<br />
<br />
===Qxy (%)===<br />
Retrigger note every y ticks with volume modifier x.<br />
<br />
Values for x:<br />
*0: 0<br />
*1: -1<br />
*2: -2<br />
*3: -4<br />
*4: -8<br />
*5: -16<br />
*6: *2/3<br />
*7: *1/2<br />
*8: ?<br />
*9: 1<br />
*A: 2<br />
*B: 4<br />
*C: 8<br />
*D: 16<br />
*E: *3/2<br />
*F: *2<br />
<br />
'''6 isn't exactly *2/3.''' It seems to use the following table:<br />
<br />
TwoThirds: array [0..63] of Byte =<br />
( 0, 0, 1, 1, 2, 3, 3, 4, 5, 5, 6, 6, 7, 8, 8, 9,<br />
10, 10, 11, 11, 12, 13, 13, 14, 15, 15, 16, 16, 17, 18, 18, 19,<br />
20, 20, 21, 21, 22, 23, 23, 24, 25, 25, 26, 26, 27, 28, 28, 29,<br />
30, 30, 31, 31, 32, 33, 33, 34, 35, 35, 36, 36, 37, 38, 38, 39);<br />
<br />
This effect changes only the active volume, '''without modifying the stored volume.'''<br />
<br />
===Rxy (%)===<br />
Tremolo. x*4 is speed, y*4 is depth. This effect is screwy, but not as screwy as previously documented.<br />
<br />
*Get xy from the '''latest nonzero effect parameter''' to appear in the channel.<br />
*'''On tick 1''' (the '''second''' tick of the row) set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*'''If the song speed (not tremolo speed, but song speed - ticks per row) is 1, the active volume is also untouched. It is not set to the stored volume!'''<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
===Sxy===<br />
Miscellaneous effects.<br />
<br />
''TODO: check what value xy is taken for Sxy''<br />
<br />
====S0x====<br />
Set filter. Not implemented in Scream Tracker 3.<br />
<br />
====S1x====<br />
Set glissando control.<br />
<br />
====S2x====<br />
Set finetune.<br />
<br />
====S3x====<br />
Set vibrato waveform.<br />
<br />
====S4x====<br />
Set tremolo waveform.<br />
<br />
====S8x====<br />
Set panning position. Scream Tracker 3 supports this only on the Gravis Ultrasound.<br />
<br />
====SAx====<br />
Old stereo control? Not implemented in Scream Tracker 3.21?<br />
<br />
====SBx====<br />
Loop pattern.<br />
<br />
====SCx====<br />
Note cut after x ticks.<br />
<br />
*If '''the argument is 0''', the effect '''is ignored'''.<br />
*When the note is cut, the volume is '''not''' set to 0. Instead playback is temporarily '''frozen''' and may be '''resumed by a following Exx, Fxx, Gxx, Hxx, Jxx, Kxx, Lxx or Uxx command'''.<br />
<br />
====SDx====<br />
Note delay for x ticks.<br />
<br />
====SEx====<br />
Pattern delay for x rows.<br />
<br />
====SFx====<br />
FunkRepeat. Not implemented in Scream Tracker 3.<br />
<br />
===Txx===<br />
Set tempo. If the parameter is '''less than 33''', the effect is '''ignored'''.<br />
<br />
===Uxy (*)===<br />
Fine vibrato. This effect '''shares memory''' with '''Hxy'''.<br />
<br />
===Vxx===<br />
Set global volume. This effect has several quirks:<br />
<br />
*Normally, it does not affect events on the same row, where the effect is set. However, '''there are some exceptions to that rule''', read below for details.<br />
*It does not affect past notes, that are still playing, unless '''their volume is changed''', which '''applies the new global volume to that voice''' as well.<br />
*This effect '''is actually processed on tick 1 (that is the second tick)''' of the row. This has several consequences:<br />
**The effect '''doesn't do anything''', if '''the current speed is 1'''.<br />
**The effect '''is applied to notes on the current row, that have a note delay effect''' (SDx with x >= 1). For notes on the same row '''that have a note delay of 1 tick''', the effect is only applied to '''channels, that are processed after''' the channel with the set global volume effect. For notes on the same row that have a '''note delay of 2 ticks or more''', the effect is applied '''regardless of the relative position of the channel''' in the processing order. ''TODO: Document the processing order, since it isn't very obvious (I think it's L1, L2, ..., L8, R1, R2, ..., R8, but I'm not 100% sure).''<br />
**The effect '''is also applied''' on the same row if anything updates the note volume '''on tick 1''' or '''tick 2''' (depends on processing order), like the '''Dxx effect''' (when doing a non-fine slide, of course).<br />
*Vxx with parameter '''values higher than 0x40''' are '''ignored'''.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13382Scream Tracker 3 Module2011-03-29T00:39:46Z<p>GreaseMonkey: /* Playback Notes */ documentation typo -- fixing base clock frequency</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels). While the format itself can technically support 32 channels, only the 25 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**0x2xyy == Imago Orpheus x.yy<br />
**0x3xyy == Impulse Tracker x.yy<br />
**0x4xyy == Schism Tracker (version numbering scheme is different)<br />
**0x5xyy == OpenMPT<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is '''14317456 Hz''' (documentation '''incorrectly says''' 14317056 Hz, correct value is the expected 8363*1712). When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
Many effects use the '''latest nonzero effect parameter encountered''', as noted a bit further below.<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
Effects marked with a % use '''the latest nonzero effect parameter to show up'''. Effects with a * have their own memory.<br />
<br />
===Axx===<br />
Set speed. If the parameter '''is 0''', the effect is '''ignored'''.<br />
<br />
===Bxx===<br />
Order jump.<br />
<br />
===Cxy===<br />
Jump to row x*10 + y. The value provided is in '''decimal'''. If the row number specified '''is 64 or higher, the effect is ignored'''.<br />
<br />
===Dxy (%)===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is <= 0x1300), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume'''.<br />
<br />
The checking order is not the same as ImpulseTracker.<br />
''TODO: Nail the checking order. D13 for instance slides down 3.''<br />
<br />
Here's a full detailed description of all possible cases (0x00..0xFF) and how both Scream Tracker and Impulse Tracker handle them:<br />
*D0x, 1 <= x <= 0xE: slide down by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*Dx0, 1 <= x <= 0xE: slide up by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*DFx, 1 <= x <= 0xE: slide down by x on tick 0.<br />
*DxF, 1 <= x <= 0xE: slide up by x on tick 0.<br />
*DFF: slide up by 15 on tick 0.<br />
*D0F: slide down by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*DF0: slide up by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*Dxy, 1 <= x <= 0xE, 1 <= y <= 0xE: Scream Tracker treats it as a slide down by y, i.e. equivalent to D0y. Impulse Tracker does nothing.<br />
*D00: Scream Tracker uses the last nonzero effect parameter in the channel. Impulse Tracker uses the last nonzero value used for Dxx, Kxx or Lxx in the channel.<br />
<br />
===Exx (%)===<br />
Slide down.<br />
<br />
===Fxx (%)===<br />
Slide up.<br />
<br />
===Gxx (*)===<br />
Slide to note.<br />
<br />
Peculiarities in the Scream Tracker implementation of this effect:<br />
*If the current note is empty, the destination note is set to the '''last note''' to show up in the channel, '''even if it has occurred without the Gxx effect'''.<br />
*Gxx '''doesn't clear the target note''' when it is reached, so any future Gxx with no note will keep sliding back to this particular note.<br />
<br />
===Hxy (*)===<br />
Vibrato. This effect '''shares memory''' with '''Uxy'''.<br />
<br />
===Ixy (%)===<br />
Tremor. ''TODO: this effect is weird.''<br />
<br />
(Looking through what's released of the ST3 playback source code, tremor is not retriggered if there's a Dxy effect, or something like that, but this needs to be clarified.)<br />
<br />
===Jxy (%)===<br />
Arpeggio. ''TODO: this effect is weird.''<br />
<br />
===Kxy (%)===<br />
H00 + Dxy.<br />
<br />
The volume slide, performed by this effect differs from Dxy in the following ways:<br />
* '''The first tick of this effect is ignored.''' This is due to a no-op in the "first tick" pointer table.<br />
<br />
===Lxy (%)===<br />
G00 + Dxy.<br />
<br />
The volume slide '''differs from Dxy'''. See '''Kxy''' for details.<br />
<br />
===Oxx (*)===<br />
Set sample offset.<br />
<br />
===Qxy (%)===<br />
Retrigger note every y ticks with volume modifier x.<br />
<br />
Values for x:<br />
*0: 0<br />
*1: -1<br />
*2: -2<br />
*3: -4<br />
*4: -8<br />
*5: -16<br />
*6: *2/3<br />
*7: *1/2<br />
*8: ?<br />
*9: 1<br />
*A: 2<br />
*B: 4<br />
*C: 8<br />
*D: 16<br />
*E: *3/2<br />
*F: *2<br />
<br />
'''6 isn't exactly *2/3.''' It seems to use the following table:<br />
<br />
TwoThirds: array [0..63] of Byte =<br />
( 0, 0, 1, 1, 2, 3, 3, 4, 5, 5, 6, 6, 7, 8, 8, 9,<br />
10, 10, 11, 11, 12, 13, 13, 14, 15, 15, 16, 16, 17, 18, 18, 19,<br />
20, 20, 21, 21, 22, 23, 23, 24, 25, 25, 26, 26, 27, 28, 28, 29,<br />
30, 30, 31, 31, 32, 33, 33, 34, 35, 35, 36, 36, 37, 38, 38, 39);<br />
<br />
This effect changes only the active volume, '''without modifying the stored volume.'''<br />
<br />
===Rxy (%)===<br />
Tremolo. x*4 is speed, y*4 is depth. This effect is screwy, but not as screwy as previously documented.<br />
<br />
*Get xy from the '''latest nonzero effect parameter''' to appear in the channel.<br />
*'''On tick 1''' (the '''second''' tick of the row) set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*'''If the song speed (not tremolo speed, but song speed - ticks per row) is 1, the active volume is also untouched. It is not set to the stored volume!'''<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
===Sxy===<br />
Miscellaneous effects.<br />
<br />
''TODO: check what value xy is taken for Sxy''<br />
<br />
====S0x====<br />
Set filter. Not implemented in Scream Tracker 3.<br />
<br />
====S1x====<br />
Set glissando control.<br />
<br />
====S2x====<br />
Set finetune.<br />
<br />
====S3x====<br />
Set vibrato waveform.<br />
<br />
====S4x====<br />
Set tremolo waveform.<br />
<br />
====S8x====<br />
Set panning position. Scream Tracker 3 supports this only on the Gravis Ultrasound.<br />
<br />
====SAx====<br />
Old stereo control? Not implemented in Scream Tracker 3.21?<br />
<br />
====SBx====<br />
Loop pattern.<br />
<br />
====SCx====<br />
Note cut after x ticks.<br />
<br />
*If '''the argument is 0''', the effect '''is ignored'''.<br />
*When the note is cut, the volume is '''not''' set to 0. Instead playback is temporarily '''frozen''' and may be '''resumed by a following Exx, Fxx, Gxx, Hxx, Jxx, Kxx, Lxx or Uxx command'''.<br />
<br />
====SDx====<br />
Note delay for x ticks.<br />
<br />
====SEx====<br />
Pattern delay for x rows.<br />
<br />
====SFx====<br />
FunkRepeat. Not implemented in Scream Tracker 3.<br />
<br />
===Txx===<br />
Set tempo. If the parameter is '''less than 33''', the effect is '''ignored'''.<br />
<br />
===Uxy (*)===<br />
Fine vibrato. This effect '''shares memory''' with '''Hxy'''.<br />
<br />
===Vxx===<br />
Set global volume. This effect has several quirks:<br />
<br />
*Normally, it does not affect events on the same row, where the effect is set. However, '''there are some exceptions to that rule''', read below for details.<br />
*It does not affect past notes, that are still playing, unless '''their volume is changed''', which '''applies the new global volume to that voice''' as well.<br />
*This effect '''is actually processed on tick 1 (that is the second tick)''' of the row. This has several consequences:<br />
**The effect '''doesn't do anything''', if '''the current speed is 1'''.<br />
**The effect '''is applied to notes on the current row, that have a note delay effect''' (SDx with x >= 1). For notes on the same row '''that have a note delay of 1 tick''', the effect is only applied to '''channels, that are processed after''' the channel with the set global volume effect. For notes on the same row that have a '''note delay of 2 ticks or more''', the effect is applied '''regardless of the relative position of the channel''' in the processing order. ''TODO: Document the processing order, since it isn't very obvious (I think it's L1, L2, ..., L8, R1, R2, ..., R8, but I'm not 100% sure).''<br />
**The effect '''is also applied''' on the same row if anything updates the note volume '''on tick 1''' or '''tick 2''' (depends on processing order), like the '''Dxx effect''' (when doing a non-fine slide, of course).<br />
*Vxx with parameter '''values higher than 0x40''' is '''ignored'''.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13381Scream Tracker 3 Module2011-03-29T00:38:24Z<p>GreaseMonkey: /* Kxy (%) */ rewording: "perform once" -> "first tick"</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels). While the format itself can technically support 32 channels, only the 25 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**0x2xyy == Imago Orpheus x.yy<br />
**0x3xyy == Impulse Tracker x.yy<br />
**0x4xyy == Schism Tracker (version numbering scheme is different)<br />
**0x5xyy == OpenMPT<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is 14317056 Hz. When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
Many effects use the '''latest nonzero effect parameter encountered''', as noted a bit further below.<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
Effects marked with a % use '''the latest nonzero effect parameter to show up'''. Effects with a * have their own memory.<br />
<br />
===Axx===<br />
Set speed. If the parameter '''is 0''', the effect is '''ignored'''.<br />
<br />
===Bxx===<br />
Order jump.<br />
<br />
===Cxy===<br />
Jump to row x*10 + y. The value provided is in '''decimal'''. If the row number specified '''is 64 or higher, the effect is ignored'''.<br />
<br />
===Dxy (%)===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is <= 0x1300), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume'''.<br />
<br />
The checking order is not the same as ImpulseTracker.<br />
''TODO: Nail the checking order. D13 for instance slides down 3.''<br />
<br />
Here's a full detailed description of all possible cases (0x00..0xFF) and how both Scream Tracker and Impulse Tracker handle them:<br />
*D0x, 1 <= x <= 0xE: slide down by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*Dx0, 1 <= x <= 0xE: slide up by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*DFx, 1 <= x <= 0xE: slide down by x on tick 0.<br />
*DxF, 1 <= x <= 0xE: slide up by x on tick 0.<br />
*DFF: slide up by 15 on tick 0.<br />
*D0F: slide down by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*DF0: slide up by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*Dxy, 1 <= x <= 0xE, 1 <= y <= 0xE: Scream Tracker treats it as a slide down by y, i.e. equivalent to D0y. Impulse Tracker does nothing.<br />
*D00: Scream Tracker uses the last nonzero effect parameter in the channel. Impulse Tracker uses the last nonzero value used for Dxx, Kxx or Lxx in the channel.<br />
<br />
===Exx (%)===<br />
Slide down.<br />
<br />
===Fxx (%)===<br />
Slide up.<br />
<br />
===Gxx (*)===<br />
Slide to note.<br />
<br />
Peculiarities in the Scream Tracker implementation of this effect:<br />
*If the current note is empty, the destination note is set to the '''last note''' to show up in the channel, '''even if it has occurred without the Gxx effect'''.<br />
*Gxx '''doesn't clear the target note''' when it is reached, so any future Gxx with no note will keep sliding back to this particular note.<br />
<br />
===Hxy (*)===<br />
Vibrato. This effect '''shares memory''' with '''Uxy'''.<br />
<br />
===Ixy (%)===<br />
Tremor. ''TODO: this effect is weird.''<br />
<br />
(Looking through what's released of the ST3 playback source code, tremor is not retriggered if there's a Dxy effect, or something like that, but this needs to be clarified.)<br />
<br />
===Jxy (%)===<br />
Arpeggio. ''TODO: this effect is weird.''<br />
<br />
===Kxy (%)===<br />
H00 + Dxy.<br />
<br />
The volume slide, performed by this effect differs from Dxy in the following ways:<br />
* '''The first tick of this effect is ignored.''' This is due to a no-op in the "first tick" pointer table.<br />
<br />
===Lxy (%)===<br />
G00 + Dxy.<br />
<br />
The volume slide '''differs from Dxy'''. See '''Kxy''' for details.<br />
<br />
===Oxx (*)===<br />
Set sample offset.<br />
<br />
===Qxy (%)===<br />
Retrigger note every y ticks with volume modifier x.<br />
<br />
Values for x:<br />
*0: 0<br />
*1: -1<br />
*2: -2<br />
*3: -4<br />
*4: -8<br />
*5: -16<br />
*6: *2/3<br />
*7: *1/2<br />
*8: ?<br />
*9: 1<br />
*A: 2<br />
*B: 4<br />
*C: 8<br />
*D: 16<br />
*E: *3/2<br />
*F: *2<br />
<br />
'''6 isn't exactly *2/3.''' It seems to use the following table:<br />
<br />
TwoThirds: array [0..63] of Byte =<br />
( 0, 0, 1, 1, 2, 3, 3, 4, 5, 5, 6, 6, 7, 8, 8, 9,<br />
10, 10, 11, 11, 12, 13, 13, 14, 15, 15, 16, 16, 17, 18, 18, 19,<br />
20, 20, 21, 21, 22, 23, 23, 24, 25, 25, 26, 26, 27, 28, 28, 29,<br />
30, 30, 31, 31, 32, 33, 33, 34, 35, 35, 36, 36, 37, 38, 38, 39);<br />
<br />
This effect changes only the active volume, '''without modifying the stored volume.'''<br />
<br />
===Rxy (%)===<br />
Tremolo. x*4 is speed, y*4 is depth. This effect is screwy, but not as screwy as previously documented.<br />
<br />
*Get xy from the '''latest nonzero effect parameter''' to appear in the channel.<br />
*'''On tick 1''' (the '''second''' tick of the row) set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*'''If the song speed (not tremolo speed, but song speed - ticks per row) is 1, the active volume is also untouched. It is not set to the stored volume!'''<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
===Sxy===<br />
Miscellaneous effects.<br />
<br />
''TODO: check what value xy is taken for Sxy''<br />
<br />
====S0x====<br />
Set filter. Not implemented in Scream Tracker 3.<br />
<br />
====S1x====<br />
Set glissando control.<br />
<br />
====S2x====<br />
Set finetune.<br />
<br />
====S3x====<br />
Set vibrato waveform.<br />
<br />
====S4x====<br />
Set tremolo waveform.<br />
<br />
====S8x====<br />
Set panning position. Scream Tracker 3 supports this only on the Gravis Ultrasound.<br />
<br />
====SAx====<br />
Old stereo control? Not implemented in Scream Tracker 3.21?<br />
<br />
====SBx====<br />
Loop pattern.<br />
<br />
====SCx====<br />
Note cut after x ticks.<br />
<br />
*If '''the argument is 0''', the effect '''is ignored'''.<br />
*When the note is cut, the volume is '''not''' set to 0. Instead playback is temporarily '''frozen''' and may be '''resumed by a following Exx, Fxx, Gxx, Hxx, Jxx, Kxx, Lxx or Uxx command'''.<br />
<br />
====SDx====<br />
Note delay for x ticks.<br />
<br />
====SEx====<br />
Pattern delay for x rows.<br />
<br />
====SFx====<br />
FunkRepeat. Not implemented in Scream Tracker 3.<br />
<br />
===Txx===<br />
Set tempo. If the parameter is '''less than 33''', the effect is '''ignored'''.<br />
<br />
===Uxy (*)===<br />
Fine vibrato. This effect '''shares memory''' with '''Hxy'''.<br />
<br />
===Vxx===<br />
Set global volume. This effect has several quirks:<br />
<br />
*Normally, it does not affect events on the same row, where the effect is set. However, '''there are some exceptions to that rule''', read below for details.<br />
*It does not affect past notes, that are still playing, unless '''their volume is changed''', which '''applies the new global volume to that voice''' as well.<br />
*This effect '''is actually processed on tick 1 (that is the second tick)''' of the row. This has several consequences:<br />
**The effect '''doesn't do anything''', if '''the current speed is 1'''.<br />
**The effect '''is applied to notes on the current row, that have a note delay effect''' (SDx with x >= 1). For notes on the same row '''that have a note delay of 1 tick''', the effect is only applied to '''channels, that are processed after''' the channel with the set global volume effect. For notes on the same row that have a '''note delay of 2 ticks or more''', the effect is applied '''regardless of the relative position of the channel''' in the processing order. ''TODO: Document the processing order, since it isn't very obvious (I think it's L1, L2, ..., L8, R1, R2, ..., R8, but I'm not 100% sure).''<br />
**The effect '''is also applied''' on the same row if anything updates the note volume '''on tick 1''' or '''tick 2''' (depends on processing order), like the '''Dxx effect''' (when doing a non-fine slide, of course).<br />
*Vxx with parameter '''values higher than 0x40''' is '''ignored'''.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13380Scream Tracker 3 Module2011-03-29T00:37:37Z<p>GreaseMonkey: /* Kxy (%) */ simplifying this. source: partial ST3 source release.</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels). While the format itself can technically support 32 channels, only the 25 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**0x2xyy == Imago Orpheus x.yy<br />
**0x3xyy == Impulse Tracker x.yy<br />
**0x4xyy == Schism Tracker (version numbering scheme is different)<br />
**0x5xyy == OpenMPT<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is 14317056 Hz. When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
Many effects use the '''latest nonzero effect parameter encountered''', as noted a bit further below.<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
Effects marked with a % use '''the latest nonzero effect parameter to show up'''. Effects with a * have their own memory.<br />
<br />
===Axx===<br />
Set speed. If the parameter '''is 0''', the effect is '''ignored'''.<br />
<br />
===Bxx===<br />
Order jump.<br />
<br />
===Cxy===<br />
Jump to row x*10 + y. The value provided is in '''decimal'''. If the row number specified '''is 64 or higher, the effect is ignored'''.<br />
<br />
===Dxy (%)===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is <= 0x1300), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume'''.<br />
<br />
The checking order is not the same as ImpulseTracker.<br />
''TODO: Nail the checking order. D13 for instance slides down 3.''<br />
<br />
Here's a full detailed description of all possible cases (0x00..0xFF) and how both Scream Tracker and Impulse Tracker handle them:<br />
*D0x, 1 <= x <= 0xE: slide down by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*Dx0, 1 <= x <= 0xE: slide up by x on all nonzero ticks. Also slide on tick 0, if fast slides are enabled.<br />
*DFx, 1 <= x <= 0xE: slide down by x on tick 0.<br />
*DxF, 1 <= x <= 0xE: slide up by x on tick 0.<br />
*DFF: slide up by 15 on tick 0.<br />
*D0F: slide down by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*DF0: slide up by 15 on all ticks. Not affected at all by the fast slides flag.<br />
*Dxy, 1 <= x <= 0xE, 1 <= y <= 0xE: Scream Tracker treats it as a slide down by y, i.e. equivalent to D0y. Impulse Tracker does nothing.<br />
*D00: Scream Tracker uses the last nonzero effect parameter in the channel. Impulse Tracker uses the last nonzero value used for Dxx, Kxx or Lxx in the channel.<br />
<br />
===Exx (%)===<br />
Slide down.<br />
<br />
===Fxx (%)===<br />
Slide up.<br />
<br />
===Gxx (*)===<br />
Slide to note.<br />
<br />
Peculiarities in the Scream Tracker implementation of this effect:<br />
*If the current note is empty, the destination note is set to the '''last note''' to show up in the channel, '''even if it has occurred without the Gxx effect'''.<br />
*Gxx '''doesn't clear the target note''' when it is reached, so any future Gxx with no note will keep sliding back to this particular note.<br />
<br />
===Hxy (*)===<br />
Vibrato. This effect '''shares memory''' with '''Uxy'''.<br />
<br />
===Ixy (%)===<br />
Tremor. ''TODO: this effect is weird.''<br />
<br />
(Looking through what's released of the ST3 playback source code, tremor is not retriggered if there's a Dxy effect, or something like that, but this needs to be clarified.)<br />
<br />
===Jxy (%)===<br />
Arpeggio. ''TODO: this effect is weird.''<br />
<br />
===Kxy (%)===<br />
H00 + Dxy.<br />
<br />
The volume slide, performed by this effect differs from Dxy in the following ways:<br />
* '''The first tick of this effect is ignored.''' This is due to a no-op in the "perform once" pointer table.<br />
<br />
===Lxy (%)===<br />
G00 + Dxy.<br />
<br />
The volume slide '''differs from Dxy'''. See '''Kxy''' for details.<br />
<br />
===Oxx (*)===<br />
Set sample offset.<br />
<br />
===Qxy (%)===<br />
Retrigger note every y ticks with volume modifier x.<br />
<br />
Values for x:<br />
*0: 0<br />
*1: -1<br />
*2: -2<br />
*3: -4<br />
*4: -8<br />
*5: -16<br />
*6: *2/3<br />
*7: *1/2<br />
*8: ?<br />
*9: 1<br />
*A: 2<br />
*B: 4<br />
*C: 8<br />
*D: 16<br />
*E: *3/2<br />
*F: *2<br />
<br />
'''6 isn't exactly *2/3.''' It seems to use the following table:<br />
<br />
TwoThirds: array [0..63] of Byte =<br />
( 0, 0, 1, 1, 2, 3, 3, 4, 5, 5, 6, 6, 7, 8, 8, 9,<br />
10, 10, 11, 11, 12, 13, 13, 14, 15, 15, 16, 16, 17, 18, 18, 19,<br />
20, 20, 21, 21, 22, 23, 23, 24, 25, 25, 26, 26, 27, 28, 28, 29,<br />
30, 30, 31, 31, 32, 33, 33, 34, 35, 35, 36, 36, 37, 38, 38, 39);<br />
<br />
This effect changes only the active volume, '''without modifying the stored volume.'''<br />
<br />
===Rxy (%)===<br />
Tremolo. x*4 is speed, y*4 is depth. This effect is screwy, but not as screwy as previously documented.<br />
<br />
*Get xy from the '''latest nonzero effect parameter''' to appear in the channel.<br />
*'''On tick 1''' (the '''second''' tick of the row) set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*'''If the song speed (not tremolo speed, but song speed - ticks per row) is 1, the active volume is also untouched. It is not set to the stored volume!'''<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
===Sxy===<br />
Miscellaneous effects.<br />
<br />
''TODO: check what value xy is taken for Sxy''<br />
<br />
====S0x====<br />
Set filter. Not implemented in Scream Tracker 3.<br />
<br />
====S1x====<br />
Set glissando control.<br />
<br />
====S2x====<br />
Set finetune.<br />
<br />
====S3x====<br />
Set vibrato waveform.<br />
<br />
====S4x====<br />
Set tremolo waveform.<br />
<br />
====S8x====<br />
Set panning position. Scream Tracker 3 supports this only on the Gravis Ultrasound.<br />
<br />
====SAx====<br />
Old stereo control? Not implemented in Scream Tracker 3.21?<br />
<br />
====SBx====<br />
Loop pattern.<br />
<br />
====SCx====<br />
Note cut after x ticks.<br />
<br />
*If '''the argument is 0''', the effect '''is ignored'''.<br />
*When the note is cut, the volume is '''not''' set to 0. Instead playback is temporarily '''frozen''' and may be '''resumed by a following Exx, Fxx, Gxx, Hxx, Jxx, Kxx, Lxx or Uxx command'''.<br />
<br />
====SDx====<br />
Note delay for x ticks.<br />
<br />
====SEx====<br />
Pattern delay for x rows.<br />
<br />
====SFx====<br />
FunkRepeat. Not implemented in Scream Tracker 3.<br />
<br />
===Txx===<br />
Set tempo. If the parameter is '''less than 33''', the effect is '''ignored'''.<br />
<br />
===Uxy (*)===<br />
Fine vibrato. This effect '''shares memory''' with '''Hxy'''.<br />
<br />
===Vxx===<br />
Set global volume. This effect has several quirks:<br />
<br />
*Normally, it does not affect events on the same row, where the effect is set. However, '''there are some exceptions to that rule''', read below for details.<br />
*It does not affect past notes, that are still playing, unless '''their volume is changed''', which '''applies the new global volume to that voice''' as well.<br />
*This effect '''is actually processed on tick 1 (that is the second tick)''' of the row. This has several consequences:<br />
**The effect '''doesn't do anything''', if '''the current speed is 1'''.<br />
**The effect '''is applied to notes on the current row, that have a note delay effect''' (SDx with x >= 1). For notes on the same row '''that have a note delay of 1 tick''', the effect is only applied to '''channels, that are processed after''' the channel with the set global volume effect. For notes on the same row that have a '''note delay of 2 ticks or more''', the effect is applied '''regardless of the relative position of the channel''' in the processing order. ''TODO: Document the processing order, since it isn't very obvious (I think it's L1, L2, ..., L8, R1, R2, ..., R8, but I'm not 100% sure).''<br />
**The effect '''is also applied''' on the same row if anything updates the note volume '''on tick 1''' or '''tick 2''' (depends on processing order), like the '''Dxx effect''' (when doing a non-fine slide, of course).<br />
*Vxx with parameter '''values higher than 0x40''' is '''ignored'''.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13147Scream Tracker 3 Module2010-12-06T06:07:59Z<p>GreaseMonkey: ok i found out a bit about the real reason why tremolo is weird</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**0x2xyy == Imago Orpheus x.yy<br />
**0x3xyy == Impulse Tracker x.yy<br />
**0x4xyy == Schism Tracker (version numbering scheme is different)<br />
**0x5xyy == OpenMPT<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is 14317056 Hz. When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
Many effects use the '''latest nonzero effect parameter encountered''', as noted a bit further below.<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
Effects marked with a % use '''the latest nonzero effect parameter to show up'''. Effects with a * have their own memory.<br />
<br />
===Axx===<br />
Set speed.<br />
<br />
===Bxx===<br />
Order jump.<br />
<br />
===Cxx===<br />
Row jump.<br />
<br />
===Dxy (%)===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is <= 0x1300), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume'''.<br />
<br />
The checking order is not the same as ImpulseTracker.<br />
''TODO: Nail the checking order. D13 for instance slides down 3.''<br />
<br />
===Exx (%)===<br />
Slide down.<br />
<br />
===Fxx (%)===<br />
Slide up.<br />
<br />
===Gxx (*)===<br />
Slide to note.<br />
<br />
===Hxy (*)===<br />
Vibrato.<br />
<br />
===Ixy (?)===<br />
Tremor. ''TODO: this effect is weird.''<br />
<br />
(Looking through what's released of the ST3 playback source code, tremor is not retriggered if there's a Dxy effect, or something like that, but this needs to be clarified.)<br />
<br />
===Jxy (%)===<br />
Arpeggio. ''TODO: this effect is weird.''<br />
<br />
===Kxy (%)===<br />
H00 + Dxy.<br />
<br />
===Lxy (%)===<br />
G00 + Dxy.<br />
<br />
===Oxx (*)===<br />
Set sample offset.<br />
<br />
===Qxy (?)===<br />
Retrigger note.<br />
<br />
===Rxy (%)===<br />
Tremolo. x*4 is speed, y*4 is depth. This effect is screwy, but not as screwy as previously documented.<br />
<br />
*Get xy from the '''latest nonzero effect parameter''' to appear in the channel.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
===Sxy===<br />
Miscellaneous effects.<br />
<br />
''TODO: check what value xy is taken for Sxy''<br />
<br />
===Txx===<br />
Set tempo.<br />
<br />
===Uxy (%?)===<br />
Fine vibrato.<br />
<br />
===Vxx===<br />
Global volume. ''TODO: this effect is weird.''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13049Scream Tracker 3 Module2010-10-18T22:40:20Z<p>GreaseMonkey: /* Dxy */ oops</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**0x2xyy == Imago Orpheus x.yy<br />
**0x3xyy == Impulse Tracker x.yy<br />
**0x4xyy == Schism Tracker (version numbering scheme is different)<br />
**0x5xyy == OpenMPT<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is 14317056 Hz. When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
When a '''note''' is selected, the tremolo '''position''' is retriggered if tremolo retriggering is enabled..<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
===Dxy===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is <= 0x1300), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume''', and we '''retrigger tremolo for that channel'''.<br />
<br />
The checking order is as follows:<br />
* Dx0 (slide up)<br />
* D0x (slide down)<br />
* DxF (fine slide up)<br />
* DFx (fine slide down)<br />
<br />
So DFF slides the volume '''up 15 notches each nonzero tick'''.<br />
<br />
===Rxy===<br />
Tremolo. x*4 is speed, y*4 is depth. This is possibly the screwiest effect of the lot. While XMPlay seems to be quite good with IT support these days after Storlek released his abuse tests, it gets several aspects of this S3M effect wrong.<br />
<br />
*If xy is nonzero, load up the speed and the depth into this channel's tremolo speed & depth values.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*When this effect is retriggered, the depth and position are set to 0 '''while the speed remains unaltered'''.<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13048Scream Tracker 3 Module2010-10-18T22:40:03Z<p>GreaseMonkey: /* Dxy */ correcting a contradiction</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**0x2xyy == Imago Orpheus x.yy<br />
**0x3xyy == Impulse Tracker x.yy<br />
**0x4xyy == Schism Tracker (version numbering scheme is different)<br />
**0x5xyy == OpenMPT<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is 14317056 Hz. When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
When a '''note''' is selected, the tremolo '''position''' is retriggered if tremolo retriggering is enabled..<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
===Dxy===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is less than 0x1300), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume''', and we '''retrigger tremolo for that channel'''.<br />
<br />
The checking order is as follows:<br />
* Dx0 (slide up)<br />
* D0x (slide down)<br />
* DxF (fine slide up)<br />
* DFx (fine slide down)<br />
<br />
So DFF slides the volume '''up 15 notches each nonzero tick'''.<br />
<br />
===Rxy===<br />
Tremolo. x*4 is speed, y*4 is depth. This is possibly the screwiest effect of the lot. While XMPlay seems to be quite good with IT support these days after Storlek released his abuse tests, it gets several aspects of this S3M effect wrong.<br />
<br />
*If xy is nonzero, load up the speed and the depth into this channel's tremolo speed & depth values.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*When this effect is retriggered, the depth and position are set to 0 '''while the speed remains unaltered'''.<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13047Scream Tracker 3 Module2010-10-18T22:38:22Z<p>GreaseMonkey: /* File Format */ added some version IDs, thanks to Saga_Musix</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**0x2xyy == Imago Orpheus x.yy<br />
**0x3xyy == Impulse Tracker x.yy<br />
**0x4xyy == Schism Tracker (version numbering scheme is different)<br />
**0x5xyy == OpenMPT<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is 14317056 Hz. When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
When a '''note''' is selected, the tremolo '''position''' is retriggered if tremolo retriggering is enabled..<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
===Dxy===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is less than 0x1320), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume''', and we '''retrigger tremolo for that channel'''.<br />
<br />
The checking order is as follows:<br />
* Dx0 (slide up)<br />
* D0x (slide down)<br />
* DxF (fine slide up)<br />
* DFx (fine slide down)<br />
<br />
So DFF slides the volume '''up 15 notches each nonzero tick'''.<br />
<br />
===Rxy===<br />
Tremolo. x*4 is speed, y*4 is depth. This is possibly the screwiest effect of the lot. While XMPlay seems to be quite good with IT support these days after Storlek released his abuse tests, it gets several aspects of this S3M effect wrong.<br />
<br />
*If xy is nonzero, load up the speed and the depth into this channel's tremolo speed & depth values.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*When this effect is retriggered, the depth and position are set to 0 '''while the speed remains unaltered'''.<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13041Scream Tracker 3 Module2010-10-13T02:50:23Z<p>GreaseMonkey: /* File Format */ oops</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, ''all'' volume slides occur ''every'' tick.<br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**''TODO - look for other version numbers''<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is 14317056 Hz. When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
When a '''note''' is selected, the tremolo '''position''' is retriggered if tremolo retriggering is enabled..<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
===Dxy===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is less than 0x1320), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume''', and we '''retrigger tremolo for that channel'''.<br />
<br />
The checking order is as follows:<br />
* Dx0 (slide up)<br />
* D0x (slide down)<br />
* DxF (fine slide up)<br />
* DFx (fine slide down)<br />
<br />
So DFF slides the volume '''up 15 notches each nonzero tick'''.<br />
<br />
===Rxy===<br />
Tremolo. x*4 is speed, y*4 is depth. This is possibly the screwiest effect of the lot. While XMPlay seems to be quite good with IT support these days after Storlek released his abuse tests, it gets several aspects of this S3M effect wrong.<br />
<br />
*If xy is nonzero, load up the speed and the depth into this channel's tremolo speed & depth values.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*When this effect is retriggered, the depth and position are set to 0 '''while the speed remains unaltered'''.<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13040Scream Tracker 3 Module2010-10-13T02:48:36Z<p>GreaseMonkey: hey, here's some more</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Unless otherwise specified, this information pertains to Scream Tracker v3.21's play routine.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, a "word" is 16 bits, and a "dword" (double word) is 32 bits. Hex values will be denoted with "0x". A parapointer points to pp*16 in the file due to the DOS nature of the format.<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be set to 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***Bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***Bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***Bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***Bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***Bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***Bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***Bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, bits <br />
***Bit 8: Special custom data in file (uses "Special" field)<br />
*Tracker version<br />
**0x1xyy == Scream Tracker x.yy<br />
**''TODO - look for other version numbers''<br />
*File format information<br />
**1 == signed samples (horribly, horribly old)<br />
**2 == unsigned samples<br />
**Anything else is invalid and ST3 will not load the file(?).<br />
*4 byte string: "SCRM"<br />
*6 bytes, denoting the following:<br />
**Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
**Initial speed (ticks per row / TPR) - '''if 0 ''or 255'', it is ignored''' and 6 is used instead. The value of 255 is very unusual as AFF (set speed to 0xFF == 255) still works.<br />
**Initial tempo - if '''less than 33, it is ignored''' and 125 is used instead.<br />
**Mixing volume (range 16 <= x <= 127) which is only used for Sound Blaster. '''It is multiplied by 11/8 when stereo is on.'''<br />
**Ultra-click removal which is only used for Gravis Ultrasound. ST3.21's interface only allows inputting of values 8, 12, or 16. Allegedly this is the number of GUS channels to allocate to guarantee that this value / 2 channels will play w/o clicks.<br />
**Default pan value flag, if equal to 252 then load the default panning values at the end of the header, otherwise don't bother.<br />
*8 reserved bytes, should be set to 0x00, although some trackers write stuff in here.<br />
*1 parapointer: "Special", used to point to "special custom data" which is not used in ST 3.01 or later. ST3.21's TECH.DOC refers to ExtHead which is not mentioned anywhere else. This should be safe to ignore.<br />
*32 bytes indicating channel settings, as follows:<br />
**If bit 8 is set, this channel is enabled.<br />
**The lower 7 bits indicate the channel type:<br />
***0 <= x <= 7: Left PCM channel 1-8 (Lx)<br />
***8 <= x <= 15: Right PCM channel 1-8 (Rx)<br />
***16 <= x <= 24: Adlib/OPL2 #1 melody (Ax)<br />
***25 <= x <= 29: Adlib/OPL2 #1 drums (A_, where _ can be one of {''(TODO: look this up''}) - ''is this used?''<br />
***Immediately after Adlib/OPL2 #1, there's some provision for a second OPL2 chip, although this does not appear to be supported / used.<br />
**'''It is possible to map two pattern channels to the same output channel, which allows for some quirks. This is NOT supported by virtually any player other than ST3 itself.''' pys3m supports it, but is very obscure and quite slow. '''WARNING:''' Despite being less useful than you might expect, there ARE reasons why people would do this!<br />
*Order list: series of bytes indicating pattern indices.<br />
*Instrument parapointer list: series of parapointers pointing to instruments.<br />
*Pattern parapointer list: series of parapointers pointing to patterns.<br />
*OPTIONAL: Panning list: Entries are as follows:<br />
**Bits 6 and 7 are reserved.<br />
**Bit 5(?): If set, use the value specified, otherwise use default (7 for mono, 3(L) / C(R) for stereo).<br />
**Bits 0-3: Specified panning value if default not used.<br />
<br />
''TODO: ST3.21's TECH.DOC should cover instruments.''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is 14317056 Hz. When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
When a '''note''' is selected, the tremolo '''position''' is retriggered if tremolo retriggering is enabled..<br />
<br />
===Multiple channel mapping quirk===<br />
'''It is possible to map two pattern channels to one output channel.''' However, it is rather quirky, but usable.<br />
<br />
Note that '''only the last pattern channel's effects are used'''.<br />
<br />
''TODO: document this quirk in detail.''<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
===Dxy===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is less than 0x1320), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume''', and we '''retrigger tremolo for that channel'''.<br />
<br />
The checking order is as follows:<br />
* Dx0 (slide up)<br />
* D0x (slide down)<br />
* DxF (fine slide up)<br />
* DFx (fine slide down)<br />
<br />
So DFF slides the volume '''up 15 notches each nonzero tick'''.<br />
<br />
===Rxy===<br />
Tremolo. x*4 is speed, y*4 is depth. This is possibly the screwiest effect of the lot. While XMPlay seems to be quite good with IT support these days after Storlek released his abuse tests, it gets several aspects of this S3M effect wrong.<br />
<br />
*If xy is nonzero, load up the speed and the depth into this channel's tremolo speed & depth values.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*When this effect is retriggered, the depth and position are set to 0 '''while the speed remains unaltered'''.<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13039Scream Tracker 3 Module2010-10-13T02:04:34Z<p>GreaseMonkey: more stuff</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with "0x".<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***bit 7: ST3.00 volume slides ('''automatically enabled if tracker version is <= 0x1300''') - if enabled, bits <br />
***bit 8: Special custom data in file (uses "Special" field)<br />
**Tracker version<br />
***0x1xyy == Scream Tracker x.yy<br />
***''TODO - look for other version numbers''<br />
**File format information<br />
***1 == signed samples (horribly, horribly old)<br />
***2 == unsigned samples<br />
***Anything else is invalid and ST3 will not load the file(?).<br />
**4 byte string: "SCRM"<br />
**6 bytes, denoting the following:<br />
***Global volume (range 0 <= x <= 64) which is used in calculating individual channel volumes '''and is nasty.'''<br />
***Initial speed<br />
***Initial tempo<br />
***Mixing volume<br />
***Ultra-click removal<br />
***Default pan value thing<br />
<br />
''WORK IN PROGRESS''<br />
<br />
==Playback Notes==<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is 14317056 Hz. When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
When a '''note''' is selected, the tremolo '''position''' is retriggered if tremolo retriggering is enabled..<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
===Dxy===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is less than 0x1320), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume''', and we '''retrigger tremolo for that channel'''.<br />
<br />
The checking order is as follows:<br />
* Dx0 (slide up)<br />
* D0x (slide down)<br />
* DxF (fine slide up)<br />
* DFx (fine slide down)<br />
<br />
So DFF slides the volume '''up 15 notches each nonzero tick'''.<br />
<br />
===Rxy===<br />
Tremolo. x*4 is speed, y*4 is depth. This is possibly the screwiest effect of the lot. While XMPlay seems to be quite good with IT support these days after Storlek released his abuse tests, it gets several aspects of this S3M effect wrong.<br />
<br />
*If xy is nonzero, load up the speed and the depth into this channel's tremolo speed & depth values.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*When this effect is retriggered, the depth and position are set to 0 '''while the speed remains unaltered'''.<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=13038Scream Tracker 3 Module2010-10-13T01:55:14Z<p>GreaseMonkey: finally documenting the format itself</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
==File Format==<br />
<br />
The format is little-endian (least significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with "0x".<br />
<br />
Note that if some parts of the format are inconsistent, it's usually best to let it slip, as ST3 itself will allegedly for instance load instruments which don't have the "SCRS" / "SCRI" mark.<br />
<br />
*28 bytes: module name, NUL-terminated, NUL-padded.<br />
*Byte: 0x1A.<br />
*Byte: 16 (0x10) to indicate this is a Scream Tracker 3 module.<br />
*2 reserved bytes, should be 0x00.<br />
*6 words, denoting the following:<br />
**Order count<br />
**Instrument count<br />
**Pattern count<br />
**Flags<br />
***bit 0 (pre-3.01 ONLY): ST2 vibrato ''(effect unknown)''.<br />
***bit 1 (pre-3.01 ONLY): ST2 tempo ''(effect unknown)''.<br />
***bit 3 (pre-3.01 ONLY): Amiga slides ''(effect unknown)''.<br />
***bit 4: 0-vol optimisations - turn off looping notes which have a zero volume for more than(?) 2 rows.<br />
***bit 5: Amiga limits (limit periods to confine to 113 <= x <= 856).<br />
***bit 6 (pre-3.01 ONLY): Enable filter / sfx with SB ''(effect unknown)''.<br />
***bit 7: ST3.00 volume slides (automatically enabled if tracker version is <= 0x1300) - if the tick<br />
***bit 8: Special custom data in file (uses "Special" field)<br />
**Tracker version<br />
***0x1xyy == Scream Tracker x.yy<br />
***''TODO - look for other version numbers''<br />
**File format information<br />
***1 == signed samples (horribly, horribly old)<br />
***2 == unsigned samples<br />
***Anything else is invalid and ST3 will not load the file(?).<br />
**4 byte string: "SCRM"<br />
**6 bytes, denoting the following:<br />
<br />
''WORK IN PROGRESS''<br />
<br />
==Playback Notes==<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256, though Hxy and Rxy use x*4 and y*4 as their parameters.<br />
<br />
Base clock is 14317056 Hz. When calculating a note's period, use the following table:<br />
<br />
C C# D D# E F F# G G# A A# A<br />
1712,1616,1524,1440,1356,1280,1208,1140,1076,1016,960,907<br />
<br />
and calculate the period like so:<br />
<br />
period = 8363 * 16 * (note >> octave) / middle_c_frequency_of_instrument<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
When a '''note''' is selected, the tremolo '''position''' is retriggered if tremolo retriggering is enabled..<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
===Dxy===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is less than 0x1320), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume''', and we '''retrigger tremolo for that channel'''.<br />
<br />
The checking order is as follows:<br />
* Dx0 (slide up)<br />
* D0x (slide down)<br />
* DxF (fine slide up)<br />
* DFx (fine slide down)<br />
<br />
So DFF slides the volume '''up 15 notches each nonzero tick'''.<br />
<br />
===Rxy===<br />
Tremolo. x*4 is speed, y*4 is depth. This is possibly the screwiest effect of the lot. While XMPlay seems to be quite good with IT support these days after Storlek released his abuse tests, it gets several aspects of this S3M effect wrong.<br />
<br />
*If xy is nonzero, load up the speed and the depth into this channel's tremolo speed & depth values.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*When this effect is retriggered, the depth and position are set to 0 '''while the speed remains unaltered'''.<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=12197Scream Tracker 3 Module2010-01-31T23:34:31Z<p>GreaseMonkey: adlib vol 64 quirk</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
==File Format==<br />
<br />
''TODO this section - there's a file which comes with ST3.21, "TECH.DOC", which gives you the info. Effects are A=1, B=2, et cetera.''<br />
<br />
==Playback Notes==<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256.<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
However, on '''adlib channels''', if the default volume is 64, it will use 64. Any further operations on the volume will clip it to within the 0-63 range.<br />
<br />
When a '''note''' is selected, the tremolo '''position''' is retriggered if tremolo retriggering is enabled..<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
===Dxy===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is less than 0x1320), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume''', and we '''retrigger tremolo for that channel'''.<br />
<br />
The checking order is as follows:<br />
* Dx0 (slide up)<br />
* D0x (slide down)<br />
* DxF (fine slide up)<br />
* DFx (fine slide down)<br />
<br />
So DFF slides the volume '''up 15 notches each nonzero tick'''.<br />
<br />
===Rxy===<br />
Tremolo. x*4 is speed, y*4 is depth. This is possibly the screwiest effect of the lot. While XMPlay seems to be quite good with IT support these days after Storlek released his abuse tests, it gets several aspects of this S3M effect wrong.<br />
<br />
*If xy is nonzero, load up the speed and the depth into this channel's tremolo speed & depth values.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*When this effect is retriggered, the depth and position are set to 0 '''while the speed remains unaltered'''.<br />
*'''Tremolo will not work if the stored volume is 0 (or 64 - adlib only).'''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=12196Scream Tracker 3 Module2010-01-31T23:11:35Z<p>GreaseMonkey: another clarification</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
==File Format==<br />
<br />
''TODO this section - there's a file which comes with ST3.21, "TECH.DOC", which gives you the info. Effects are A=1, B=2, et cetera.''<br />
<br />
==Playback Notes==<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256.<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
When a '''note''' is selected, the tremolo '''position''' is retriggered if tremolo retriggering is enabled..<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
===Dxy===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is less than 0x1320), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume''', and we '''retrigger tremolo for that channel'''.<br />
<br />
The checking order is as follows:<br />
* Dx0 (slide up)<br />
* D0x (slide down)<br />
* DxF (fine slide up)<br />
* DFx (fine slide down)<br />
<br />
So DFF slides the volume '''up 15 notches each nonzero tick'''.<br />
<br />
===Rxy===<br />
Tremolo. x*4 is speed, y*4 is depth. This is possibly the screwiest effect of the lot. While XMPlay seems to be quite good with IT support these days after Storlek released his abuse tests, it gets several aspects of this S3M effect wrong.<br />
<br />
*If xy is nonzero, load up the speed and the depth into this channel's tremolo speed & depth values.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*When this effect is retriggered, the depth and position are set to 0 '''while the speed remains unaltered'''.<br />
*'''Tremolo will not work if the stored volume is 0.'''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=12195Scream Tracker 3 Module2010-01-31T23:10:21Z<p>GreaseMonkey: /* Rxy */ amp mistake</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
==File Format==<br />
<br />
''TODO this section - there's a file which comes with ST3.21, "TECH.DOC", which gives you the info. Effects are A=1, B=2, et cetera.''<br />
<br />
==Playback Notes==<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256.<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
When a '''note''' is selected, '''tremolo is retriggered'''.<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
===Dxy===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is less than 0x1320), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume''', and we '''retrigger tremolo for that channel'''.<br />
<br />
The checking order is as follows:<br />
* Dx0 (slide up)<br />
* D0x (slide down)<br />
* DxF (fine slide up)<br />
* DFx (fine slide down)<br />
<br />
So DFF slides the volume '''up 15 notches each nonzero tick'''.<br />
<br />
===Rxy===<br />
Tremolo. x*4 is speed, y*4 is depth. This is possibly the screwiest effect of the lot. While XMPlay seems to be quite good with IT support these days after Storlek released his abuse tests, it gets several aspects of this S3M effect wrong.<br />
<br />
*If xy is nonzero, load up the speed and the depth into this channel's tremolo speed & depth values.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / (max_amplitude * 2) (Rxy peaks at 32 in each direction), and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*When this effect is retriggered, the depth and position are set to 0 '''while the speed remains unaltered'''.<br />
*'''Tremolo will not work if the stored volume is 0.'''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Scream_Tracker_3_Module&diff=12194Scream Tracker 3 Module2010-01-31T23:07:21Z<p>GreaseMonkey: basically, how tremolo works.</p>
<hr />
<div>* Extension: s3m<br />
A normally 16-channel module format for MS-DOS on the PC, it can also support OPL2 FM synthesis (9 melodic channels + 5 drums). While the format itself can technically support 32 channels, only the 30 mentioned have any meaning assigned to them, and they are usually not all used at the same time.<br />
<br />
==File Format==<br />
<br />
''TODO this section - there's a file which comes with ST3.21, "TECH.DOC", which gives you the info. Effects are A=1, B=2, et cetera.''<br />
<br />
==Playback Notes==<br />
<br />
Aspects which are easy to get wrong with this format are in '''bold text'''.<br />
<br />
Note w/o sample results in retriggering the note without resetting the volume.<br />
<br />
Sample w/o note results in resetting the volume and ''switching samples'' w/o retriggering the note. If the C4 speeds differ, this could potentially be out of tune as it does not convert the internal period values. If the note is off, it will stay off - it will not retrigger.<br />
<br />
Vibrato and tremolo have a full cycle length of 256.<br />
<br />
''Theoretically'', both the period and the volume have "stored" values and "active" values.<br />
<br />
'''Volumes actually peak at 63''', and not 64. Setting the volume to 64 will actually make it go to 63.<br />
<br />
When a '''note''' is selected, '''tremolo is retriggered'''.<br />
<br />
==Effects==<br />
<br />
''TODO the rest''<br />
<br />
===Dxy===<br />
Volume slide. If one of the values are 0, then we slide on all nonzero ticks. If one of the values are F, then we slide on all zero ticks. That means that '''D0F slides down 15 on all ticks and DF0 slides up 15 on all ticks'''.<br />
<br />
However, if fast slides are enabled (if they are set as a flag or the version is less than 0x1320), then, unless we're doing a fineslide, we slide on all ticks.<br />
<br />
When we do a volume slide, we slide the active volume '''without modifying the stored volume''', and we '''retrigger tremolo for that channel'''.<br />
<br />
The checking order is as follows:<br />
* Dx0 (slide up)<br />
* D0x (slide down)<br />
* DxF (fine slide up)<br />
* DFx (fine slide down)<br />
<br />
So DFF slides the volume '''up 15 notches each nonzero tick'''.<br />
<br />
===Rxy===<br />
Tremolo. x*4 is speed, y*4 is depth. This is possibly the screwiest effect of the lot. While XMPlay seems to be quite good with IT support these days after Storlek released his abuse tests, it gets several aspects of this S3M effect wrong.<br />
<br />
*If xy is nonzero, load up the speed and the depth into this channel's tremolo speed & depth values.<br />
*Set the active volume to '''the stored volume plus''' (depth * value) / max_amplitude, and for each '''nonzero''' tick increase the tremolo position by the speed. '''The stored volume is untouched.'''<br />
*When this effect is retriggered, the depth and position are set to 0 '''while the speed remains unaltered'''.<br />
*'''Tremolo will not work if the stored volume is 0.'''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12168Protracker Module2010-01-22T21:24:09Z<p>GreaseMonkey: /* EFx */ clarification</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was first used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 2 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''2CHN''' - a 2 channel MOD. This is handled by FastTracker.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod so far. This is just a standard MOD, but with a weird tag. ''I ([[User:GreaseMonkey|GreaseMonkey]]) cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
*Pattern data:<br />
**Read 4 bytes for a cell. Read ''channel count'' cells for a row. Read 64 of these rows for a pattern. Read ''pattern count'' of these patterns.<br />
**You read cells as if they were big-endian 32-bit values.<br />
**Cells are in the format $ipppjfxy:<br />
***$ppp is the period value. No, not the note, the period.<br />
***$ij is the sample number.<br />
***$fxy is the effect, $f being the effect type, and $xy being the effect parameter.<br />
*Signed 8-bit mono sample data. Remember those sample lengths? Now is the time to use them.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns. The actual base clock differs. PAL Amigas have a slightly slower clock than NTSC Amigas. This value of 70ns is close to the NTSC clock, but not quite right. Some modules have large samples (known as "megasamples") which require a certain type of Amiga - t_o_t.mod, for instance, requires a PAL Amiga, whereas cd_orbit.mod requires an NTSC Amiga. You can also use 8363*428 for another estimate.<br />
<br />
To get the actual note frequency, divide the Amiga base clock by the period number.<br />
<br />
There is a number of ticks per row, often just referred to as the speed.<br />
<br />
There is a number of "beats per minute"; however, this is a CIA clock speed (it's an Amiga thing). Often just referred to as the tempo. To convert to actual BPM, multiply by 4 and divide by 10. For clarity, we'll refer to it as BPM, even though it's not entirely correct.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
On a real Amiga, when a nonlooped sample is played, the whole sample plays through once, and then doesn't play any further. If you then attempt a slide-to-note (3xx / 5xy), you won't hear anything.<br />
<br />
If a sample is supplied, then the sample is "latched", the channel volume is reset to the sample's default volume, and the starting offset is reset to 0. ProTracker 1.1 (?) will change the sample, too, but other versions do not.<br />
<br />
''(please clarify: which trackers do this?)''<br />
<br />
ImpulseTracker also changes the sample; however, if you're converting MOD to IT yourself and you don't want this, you can put a "note off" with the sample and it will just change the volume (unfortunately, this behaviour does not work correctly with libmodplug or SchismTracker at the moment).<br />
<br />
If a period is supplied, then the note plays from the starting offset of the current latched sample, unless there is a note slide (effect 3xx or 5xy).<br />
<br />
===Effects===<br />
====0xy====<br />
Arpeggio between 0,x,y semitones up, changing every tick, and retriggering every row. Basically, you select by using tick % 3 where % is the modulo operator.<br />
<br />
====1xx====<br />
Slide up. For every nonzero tick, decrement the period by $xx, clamping to 113 (amiga limits).<br />
<br />
====2xx====<br />
Slide down. For every nonzero tick, increment the period by $xx, clamping to 856 (amiga limits).<br />
<br />
====3xx====<br />
Slide to note. For every nonzero tick, move the period $xx closer to the target period.<br />
<br />
If xx is 0, then use previous value for 3xx.<br />
<br />
====4xy====<br />
Vibrato. x is speed, y is depth. You'll need to generate 3 waveforms beforehand, and spew out random numbers for the last choice of waveform. Each waveform other than the last has a full cycle of 64 steps, and the amplitude is somewhere between -y and y after calculating. When precalculating the waveform, an amplitude of 64 should be fine.<br />
<br />
*Waveform 0 is a sine wave. This is the default.<br />
*Waveform 1 is a downwards saw wave.<br />
*Waveform 2 is a square wave, starting from +y.<br />
*Waveform 3 is random. The cycle of this is mostly irrelevant. In saying this, the speed value is irrelevant with this waveform type, too.<br />
<br />
You have a vibrato waveform position. By default, this retriggers for every note (?) you play by being reset to 0. This loops around a cycle of 64 positions.<br />
<br />
''(please clarify: is it per note or per sample, or will either retrigger it?)''<br />
<br />
For each tick, we add y to the output period at the peak amplitude. For a waveform with peak amplitude of 64, for example, we would add (y*waveform[pos]/64). The period is clamped to Amiga limits.<br />
<br />
If xy is 0, then use previous value for 4xy.<br />
<br />
====5xy====<br />
Volume slide + slide to note: Axy and 300 combined.<br />
<br />
====6xy====<br />
Volume slide + vibrato: Axy and 400 combined.<br />
<br />
====7xy====<br />
Tremolo. x is speed, y is depth. Like vibrato, except we modify the output volume. The volume is clamped to 0 <= vol <= 64.<br />
<br />
''(please clarify: is the maximum amplitude ~16, ~32 or ~64?)''<br />
<br />
If xy is 0, then use previous value for 7xy (?).<br />
<br />
''(please clarify: does the memory work for tremolo, or just vibrato?)''<br />
<br />
====8xx====<br />
FastTracker panning extension. $00 is hard left, $FF is hard right.<br />
<br />
''(please clarify: I really don't give a toss about this FastTracker extension, so I'm putting this question out to someone who does. Does this reset after a new note or sample? And probably some other things, too.)''<br />
<br />
====9xx====<br />
Set sample offset to xx * $100. This also sets the sample starting offset. On older versions of ProTracker (PT < 3.15 (?)), the starting offset is doubled.<br />
<br />
''(please clarify: what players perform this quirk?)''<br />
<br />
On most non canonical trackers (those which aren't in the SoundTracker -> ProTracker line, e.g. FastTracker, ScreamTracker 3, ImpulseTracker), this quirk does not occur, and the starting offset is always 0.<br />
<br />
''(please clarify: what happens when you go over the edge?)''<br />
<br />
====Axy====<br />
Volume slide. Happens every nonzero tick. If x is 0, slide down by y. If y is 0, slide up by x. If both are nonzero, do nothing. Clamp to 0 <= vol <= 64.<br />
<br />
Unlike most module formats, this does not have effect memory. If xy is $00, then don't go anywhere.<br />
<br />
====Bxx====<br />
Jump to offset. If you go over the edge, then the module is restarted (?).<br />
<br />
''(please clarify: does it actually restart?)''<br />
<br />
====Cxx====<br />
Set volume. If greater than 64, then... (?)<br />
<br />
''(please clarify: does it clamp the value at 64, or does it ignore the dud volume? My guess is this: it drops the top bit, and does the former. But that's the lazy way.)''<br />
<br />
====Dxy====<br />
Jump to row x*10 + y. '''THE VALUE PROVIDED IS IN DECIMAL!''' This had to be yelled out as it's a common mistake when making a MOD player.<br />
<br />
====E0x====<br />
If x is 1, turn the Amiga filter off. If x is 0, turn it on. This filter is present on the A500, A2000, and A1200.<br />
<br />
For a simple 1-pole low-pass filter, 11500Hz gives a fairly decent estimation.<br />
<br />
====E1x====<br />
Fine slide up. Like 1xx but without effect memory and only on the first tick.<br />
<br />
====E2x====<br />
Fine slide down. Like 2xx but without effect memory and only on the first tick.<br />
<br />
====E3x====<br />
Screw up 3xx.<br />
<br />
''(please clarify: how does this actually work?)''<br />
<br />
====E4x====<br />
Set vibrato waveform. x & 3 (bottom 2 bits) sets the waveform type. If bit 2 is set (x & 4), then don't retrigger the waveform.<br />
<br />
====E5x====<br />
Set finetune value for the current sample.<br />
<br />
''(please clarify: when does this actually kick in?)''<br />
<br />
====E6x====<br />
Loopback.<br />
<br />
If x is 0, then set the loopback point to the current row. The loopback point is reset to -1 for every Bxx or Dxx or pattern transition (?). Looping back with this means that you have to play row 0 twice.<br />
<br />
''(please clarify: is MikMod right?)''<br />
<br />
Otherwise, we check if the loopback counter set. If the loopback counter is set, then decrement it by 1, otherwise set the counter to x.<br />
<br />
After doing this, if the counter is not 0, then we jump back to the loopback point.<br />
<br />
Unlike S3M and IT, the loopback point remains where it is, so an E60/E61/E61 sequence down a column will result in an infinite loop.<br />
<br />
Each channel has its own set of loopback counters.<br />
<br />
====E7x====<br />
Set tremolo waveform, like E4x.<br />
<br />
====E8x====<br />
Another stereo extension. $0 is hard left, $F is hard right.<br />
<br />
''(please clarify: I don't care about this extension, either. It's far from "real Amiga" material. Please see 8xx for the clarifications required.)''<br />
<br />
====E9x====<br />
Retrigger note every x ticks.<br />
<br />
''(please clarify: does this effect retrigger like IT, or is this just a matter of ticks % x ?)''<br />
<br />
====EAx====<br />
Fine volume slide up. For the first tick, increment the volume by x, clamping x to <= 64.<br />
<br />
====EBx====<br />
Fine volume slide down. For the first tick, decrement the volume by x, clamping x to >= 0.<br />
<br />
====ECx====<br />
Note cut. On the xth tick, set the volume to 0.<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EDx====<br />
Note delay. Don't do what's in the cell until the xth tick.<br />
<br />
''(please clarify: is there anything which escapes this check?)''<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EEx====<br />
Row delay. Repeat the row x times, e.g. if x is 3, then do the row 4 times in total.<br />
<br />
====EFx====<br />
Funkrepeat. This is rarely implemented because not everyone knows how to use it and those who do generally think it's "nasty" as it overwrites sample data. Some might say this is incredibly rare; however, it appears to be more common than E3x.<br />
<br />
What this thing actually does is it, for every tick, increases a counter, and once that counter crosses over a certain point, it "inverts" a byte in the current playing(?) sample's loop (a logical NOT), resets the counter to 0, and moves along to the next byte, wrapping around if necessary. It does not affect samples which don't have loops in them.<br />
<br />
''(please clarify: when you hit a lone sample which isn't the current one, does it affect that latched sample or the playing sample?)''<br />
<br />
So, here's a list which can be added to. The bigger this list, the more pressure MOD player authors will get until they finally implement this under-implemented effect.<br />
<br />
=====List of MODs which use EFx=====<br />
*emax-doz.mod<br />
*emax-seq.mod<br />
<br />
In most cases, a MOD which uses EFx is a chiptune.<br />
<br />
In most cases, a MOD which uses EFx ''needs'' it (for epicness purposes mostly).<br />
<br />
Firstly, you'll want this table. This tells you how much to increment the internal counter by, and is in the ProTracker v1.2 source code.<br />
<br />
0,5,6,7,8,10,11,13,16,19,22,26,32,43,64,128<br />
<br />
This roughly correlates to this number of ticks:<br />
<br />
0 1 2 3 4 5 6 7 8 9 A B C D E F - x<br />
0, 5, 6, 7, 8,10,11,13,16,19,22,26,32,43,64,128 - counter<br />
inf,26,22,19,16,13,12,10, 8, 7, 6, 5, 4, 3, 2, 1 - ticks<br />
<br />
If x is 0, then reset that channel's funkrepeat counter and funkrepeat position to 0.<br />
Otherwise, set that channel's funkrepeat speed to funkrepeat_table[x].<br />
<br />
If a channel is not funkrepeating, then you don't need to do what follows for that channel.<br />
<br />
For every tick, increment the channel's funkrepeat counter by its funkrepeat speed. If the funkrepeat counter reaches 128, then ''reset the counter to 0'', and then:<br />
<br />
sampledata[current_sample][loop_begin_in_bytes + funkrepeat_pos] ^= 0xFF;<br />
funkrepeat_pos = (funkrepeat_pos + 1) % loop_length_in_bytes;<br />
<br />
^ is the XOR operator in C. There's also ~ for a binary NOT, but ~= probably isn't valid C.<br />
<br />
Every time you reach a new sample (?) value, reset that channel's funkrepeat position to 0, and start modifying the new sample (?).<br />
<br />
''(please clarify: does the funkrepeat sample position retrigger on sample, note, either, or both?)''<br />
<br />
<br />
''(please clarify: there's probably a lot of mistakes in this.)''<br />
<br />
====Fxx====<br />
Set TPR or BPM. If xx is less than $20 (32) or this is an old 15-sample module (?), set TPR to xx, otherwise set BPM to xx.<br />
<br />
''(please clarify: Where is the dividing line between raster timing and CIA timing - that is, when was BPM introduced?)''<br />
<br />
''However,'' if xx is 0, then ignore this effect.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want at least ((base clock * 10) / (smallest period value * 4 * 32)) bytes. To unroll a loopless sample, just pad this number of bytes. To unroll a looped sample, append the loop to the end, then unroll this number of bytes from the loop.<br />
<br />
Once you've done that, you only need to check if you've exceeded (length + loop length) words (or bytes if you've converted it) for a looped sample, or length words for an unlooped sample. For an unlooped sample, you just refuse to mix if the offset is past this point. For a looped sample, you set the offset to this:<br />
<br />
offset = length + (offset - length) % looplength;<br />
<br />
where % is the modulo operator. Most forms of BASIC do not have a modulo operator, so you'll probably have to do this instead:<br />
<br />
tmp = offset - length;<br />
offset = length + tmp - (int(tmp / looplength) * looplength);<br />
<br />
This makes funkrepeat trickier to implement, but it has been proven possible.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12167Protracker Module2010-01-22T21:22:52Z<p>GreaseMonkey: /* EFx */ actually explained what this does.</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was first used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 2 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''2CHN''' - a 2 channel MOD. This is handled by FastTracker.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod so far. This is just a standard MOD, but with a weird tag. ''I ([[User:GreaseMonkey|GreaseMonkey]]) cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
*Pattern data:<br />
**Read 4 bytes for a cell. Read ''channel count'' cells for a row. Read 64 of these rows for a pattern. Read ''pattern count'' of these patterns.<br />
**You read cells as if they were big-endian 32-bit values.<br />
**Cells are in the format $ipppjfxy:<br />
***$ppp is the period value. No, not the note, the period.<br />
***$ij is the sample number.<br />
***$fxy is the effect, $f being the effect type, and $xy being the effect parameter.<br />
*Signed 8-bit mono sample data. Remember those sample lengths? Now is the time to use them.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns. The actual base clock differs. PAL Amigas have a slightly slower clock than NTSC Amigas. This value of 70ns is close to the NTSC clock, but not quite right. Some modules have large samples (known as "megasamples") which require a certain type of Amiga - t_o_t.mod, for instance, requires a PAL Amiga, whereas cd_orbit.mod requires an NTSC Amiga. You can also use 8363*428 for another estimate.<br />
<br />
To get the actual note frequency, divide the Amiga base clock by the period number.<br />
<br />
There is a number of ticks per row, often just referred to as the speed.<br />
<br />
There is a number of "beats per minute"; however, this is a CIA clock speed (it's an Amiga thing). Often just referred to as the tempo. To convert to actual BPM, multiply by 4 and divide by 10. For clarity, we'll refer to it as BPM, even though it's not entirely correct.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
On a real Amiga, when a nonlooped sample is played, the whole sample plays through once, and then doesn't play any further. If you then attempt a slide-to-note (3xx / 5xy), you won't hear anything.<br />
<br />
If a sample is supplied, then the sample is "latched", the channel volume is reset to the sample's default volume, and the starting offset is reset to 0. ProTracker 1.1 (?) will change the sample, too, but other versions do not.<br />
<br />
''(please clarify: which trackers do this?)''<br />
<br />
ImpulseTracker also changes the sample; however, if you're converting MOD to IT yourself and you don't want this, you can put a "note off" with the sample and it will just change the volume (unfortunately, this behaviour does not work correctly with libmodplug or SchismTracker at the moment).<br />
<br />
If a period is supplied, then the note plays from the starting offset of the current latched sample, unless there is a note slide (effect 3xx or 5xy).<br />
<br />
===Effects===<br />
====0xy====<br />
Arpeggio between 0,x,y semitones up, changing every tick, and retriggering every row. Basically, you select by using tick % 3 where % is the modulo operator.<br />
<br />
====1xx====<br />
Slide up. For every nonzero tick, decrement the period by $xx, clamping to 113 (amiga limits).<br />
<br />
====2xx====<br />
Slide down. For every nonzero tick, increment the period by $xx, clamping to 856 (amiga limits).<br />
<br />
====3xx====<br />
Slide to note. For every nonzero tick, move the period $xx closer to the target period.<br />
<br />
If xx is 0, then use previous value for 3xx.<br />
<br />
====4xy====<br />
Vibrato. x is speed, y is depth. You'll need to generate 3 waveforms beforehand, and spew out random numbers for the last choice of waveform. Each waveform other than the last has a full cycle of 64 steps, and the amplitude is somewhere between -y and y after calculating. When precalculating the waveform, an amplitude of 64 should be fine.<br />
<br />
*Waveform 0 is a sine wave. This is the default.<br />
*Waveform 1 is a downwards saw wave.<br />
*Waveform 2 is a square wave, starting from +y.<br />
*Waveform 3 is random. The cycle of this is mostly irrelevant. In saying this, the speed value is irrelevant with this waveform type, too.<br />
<br />
You have a vibrato waveform position. By default, this retriggers for every note (?) you play by being reset to 0. This loops around a cycle of 64 positions.<br />
<br />
''(please clarify: is it per note or per sample, or will either retrigger it?)''<br />
<br />
For each tick, we add y to the output period at the peak amplitude. For a waveform with peak amplitude of 64, for example, we would add (y*waveform[pos]/64). The period is clamped to Amiga limits.<br />
<br />
If xy is 0, then use previous value for 4xy.<br />
<br />
====5xy====<br />
Volume slide + slide to note: Axy and 300 combined.<br />
<br />
====6xy====<br />
Volume slide + vibrato: Axy and 400 combined.<br />
<br />
====7xy====<br />
Tremolo. x is speed, y is depth. Like vibrato, except we modify the output volume. The volume is clamped to 0 <= vol <= 64.<br />
<br />
''(please clarify: is the maximum amplitude ~16, ~32 or ~64?)''<br />
<br />
If xy is 0, then use previous value for 7xy (?).<br />
<br />
''(please clarify: does the memory work for tremolo, or just vibrato?)''<br />
<br />
====8xx====<br />
FastTracker panning extension. $00 is hard left, $FF is hard right.<br />
<br />
''(please clarify: I really don't give a toss about this FastTracker extension, so I'm putting this question out to someone who does. Does this reset after a new note or sample? And probably some other things, too.)''<br />
<br />
====9xx====<br />
Set sample offset to xx * $100. This also sets the sample starting offset. On older versions of ProTracker (PT < 3.15 (?)), the starting offset is doubled.<br />
<br />
''(please clarify: what players perform this quirk?)''<br />
<br />
On most non canonical trackers (those which aren't in the SoundTracker -> ProTracker line, e.g. FastTracker, ScreamTracker 3, ImpulseTracker), this quirk does not occur, and the starting offset is always 0.<br />
<br />
''(please clarify: what happens when you go over the edge?)''<br />
<br />
====Axy====<br />
Volume slide. Happens every nonzero tick. If x is 0, slide down by y. If y is 0, slide up by x. If both are nonzero, do nothing. Clamp to 0 <= vol <= 64.<br />
<br />
Unlike most module formats, this does not have effect memory. If xy is $00, then don't go anywhere.<br />
<br />
====Bxx====<br />
Jump to offset. If you go over the edge, then the module is restarted (?).<br />
<br />
''(please clarify: does it actually restart?)''<br />
<br />
====Cxx====<br />
Set volume. If greater than 64, then... (?)<br />
<br />
''(please clarify: does it clamp the value at 64, or does it ignore the dud volume? My guess is this: it drops the top bit, and does the former. But that's the lazy way.)''<br />
<br />
====Dxy====<br />
Jump to row x*10 + y. '''THE VALUE PROVIDED IS IN DECIMAL!''' This had to be yelled out as it's a common mistake when making a MOD player.<br />
<br />
====E0x====<br />
If x is 1, turn the Amiga filter off. If x is 0, turn it on. This filter is present on the A500, A2000, and A1200.<br />
<br />
For a simple 1-pole low-pass filter, 11500Hz gives a fairly decent estimation.<br />
<br />
====E1x====<br />
Fine slide up. Like 1xx but without effect memory and only on the first tick.<br />
<br />
====E2x====<br />
Fine slide down. Like 2xx but without effect memory and only on the first tick.<br />
<br />
====E3x====<br />
Screw up 3xx.<br />
<br />
''(please clarify: how does this actually work?)''<br />
<br />
====E4x====<br />
Set vibrato waveform. x & 3 (bottom 2 bits) sets the waveform type. If bit 2 is set (x & 4), then don't retrigger the waveform.<br />
<br />
====E5x====<br />
Set finetune value for the current sample.<br />
<br />
''(please clarify: when does this actually kick in?)''<br />
<br />
====E6x====<br />
Loopback.<br />
<br />
If x is 0, then set the loopback point to the current row. The loopback point is reset to -1 for every Bxx or Dxx or pattern transition (?). Looping back with this means that you have to play row 0 twice.<br />
<br />
''(please clarify: is MikMod right?)''<br />
<br />
Otherwise, we check if the loopback counter set. If the loopback counter is set, then decrement it by 1, otherwise set the counter to x.<br />
<br />
After doing this, if the counter is not 0, then we jump back to the loopback point.<br />
<br />
Unlike S3M and IT, the loopback point remains where it is, so an E60/E61/E61 sequence down a column will result in an infinite loop.<br />
<br />
Each channel has its own set of loopback counters.<br />
<br />
====E7x====<br />
Set tremolo waveform, like E4x.<br />
<br />
====E8x====<br />
Another stereo extension. $0 is hard left, $F is hard right.<br />
<br />
''(please clarify: I don't care about this extension, either. It's far from "real Amiga" material. Please see 8xx for the clarifications required.)''<br />
<br />
====E9x====<br />
Retrigger note every x ticks.<br />
<br />
''(please clarify: does this effect retrigger like IT, or is this just a matter of ticks % x ?)''<br />
<br />
====EAx====<br />
Fine volume slide up. For the first tick, increment the volume by x, clamping x to <= 64.<br />
<br />
====EBx====<br />
Fine volume slide down. For the first tick, decrement the volume by x, clamping x to >= 0.<br />
<br />
====ECx====<br />
Note cut. On the xth tick, set the volume to 0.<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EDx====<br />
Note delay. Don't do what's in the cell until the xth tick.<br />
<br />
''(please clarify: is there anything which escapes this check?)''<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EEx====<br />
Row delay. Repeat the row x times, e.g. if x is 3, then do the row 4 times in total.<br />
<br />
====EFx====<br />
Funkrepeat. This is rarely implemented because not everyone knows how to use it and those who do generally think it's "nasty" as it overwrites sample data. Some might say this is incredibly rare; however, it appears to be more common than E3x.<br />
<br />
What this thing actually does is it, for every tick, increases a counter, and once that counter crosses over a certain point, it "inverts" a byte in a sample's loop (a logical NOT), resets the counter to 0, and moves along to the next byte, wrapping around if necessary. It does not affect samples which don't have loops in them.<br />
<br />
So, here's a list which can be added to. The bigger this list, the more pressure MOD player authors will get until they finally implement this under-implemented effect.<br />
<br />
=====List of MODs which use EFx=====<br />
*emax-doz.mod<br />
*emax-seq.mod<br />
<br />
In most cases, a MOD which uses EFx is a chiptune.<br />
<br />
In most cases, a MOD which uses EFx ''needs'' it (for epicness purposes mostly).<br />
<br />
Firstly, you'll want this table. This tells you how much to increment the internal counter by, and is in the ProTracker v1.2 source code.<br />
<br />
0,5,6,7,8,10,11,13,16,19,22,26,32,43,64,128<br />
<br />
This roughly correlates to this number of ticks:<br />
<br />
0 1 2 3 4 5 6 7 8 9 A B C D E F - x<br />
0, 5, 6, 7, 8,10,11,13,16,19,22,26,32,43,64,128 - counter<br />
inf,26,22,19,16,13,12,10, 8, 7, 6, 5, 4, 3, 2, 1 - ticks<br />
<br />
If x is 0, then reset that channel's funkrepeat counter and funkrepeat position to 0.<br />
Otherwise, set that channel's funkrepeat speed to funkrepeat_table[x].<br />
<br />
If a channel is not funkrepeating, then you don't need to do what follows for that channel.<br />
<br />
For every tick, increment the channel's funkrepeat counter by its funkrepeat speed. If the funkrepeat counter reaches 128, then ''reset the counter to 0'', and then:<br />
<br />
sampledata[current_sample][loop_begin_in_bytes + funkrepeat_pos] ^= 0xFF;<br />
funkrepeat_pos = (funkrepeat_pos + 1) % loop_length_in_bytes;<br />
<br />
^ is the XOR operator in C. There's also ~ for a binary NOT, but ~= probably isn't valid C.<br />
<br />
Every time you reach a new sample (?) value, reset that channel's funkrepeat position to 0, and start modifying the new sample (?).<br />
<br />
''(please clarify: does the funkrepeat sample position retrigger on sample, note, either, or both?)''<br />
<br />
''(please clarify: when you hit a lone sample which isn't the current one, does it affect that latched sample or the playing sample?)''<br />
<br />
''(please clarify: there's probably a lot of mistakes in this.)''<br />
<br />
====Fxx====<br />
Set TPR or BPM. If xx is less than $20 (32) or this is an old 15-sample module (?), set TPR to xx, otherwise set BPM to xx.<br />
<br />
''(please clarify: Where is the dividing line between raster timing and CIA timing - that is, when was BPM introduced?)''<br />
<br />
''However,'' if xx is 0, then ignore this effect.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want at least ((base clock * 10) / (smallest period value * 4 * 32)) bytes. To unroll a loopless sample, just pad this number of bytes. To unroll a looped sample, append the loop to the end, then unroll this number of bytes from the loop.<br />
<br />
Once you've done that, you only need to check if you've exceeded (length + loop length) words (or bytes if you've converted it) for a looped sample, or length words for an unlooped sample. For an unlooped sample, you just refuse to mix if the offset is past this point. For a looped sample, you set the offset to this:<br />
<br />
offset = length + (offset - length) % looplength;<br />
<br />
where % is the modulo operator. Most forms of BASIC do not have a modulo operator, so you'll probably have to do this instead:<br />
<br />
tmp = offset - length;<br />
offset = length + tmp - (int(tmp / looplength) * looplength);<br />
<br />
This makes funkrepeat trickier to implement, but it has been proven possible.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12166Protracker Module2010-01-21T09:28:41Z<p>GreaseMonkey: /* E6x */ clarified a point: they're local values.</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was first used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 2 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''2CHN''' - a 2 channel MOD. This is handled by FastTracker.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod so far. This is just a standard MOD, but with a weird tag. ''I ([[User:GreaseMonkey|GreaseMonkey]]) cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
*Pattern data:<br />
**Read 4 bytes for a cell. Read ''channel count'' cells for a row. Read 64 of these rows for a pattern. Read ''pattern count'' of these patterns.<br />
**You read cells as if they were big-endian 32-bit values.<br />
**Cells are in the format $ipppjfxy:<br />
***$ppp is the period value. No, not the note, the period.<br />
***$ij is the sample number.<br />
***$fxy is the effect, $f being the effect type, and $xy being the effect parameter.<br />
*Signed 8-bit mono sample data. Remember those sample lengths? Now is the time to use them.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns. The actual base clock differs. PAL Amigas have a slightly slower clock than NTSC Amigas. This value of 70ns is close to the NTSC clock, but not quite right. Some modules have large samples (known as "megasamples") which require a certain type of Amiga - t_o_t.mod, for instance, requires a PAL Amiga, whereas cd_orbit.mod requires an NTSC Amiga. You can also use 8363*428 for another estimate.<br />
<br />
To get the actual note frequency, divide the Amiga base clock by the period number.<br />
<br />
There is a number of ticks per row, often just referred to as the speed.<br />
<br />
There is a number of "beats per minute"; however, this is a CIA clock speed (it's an Amiga thing). Often just referred to as the tempo. To convert to actual BPM, multiply by 4 and divide by 10. For clarity, we'll refer to it as BPM, even though it's not entirely correct.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
On a real Amiga, when a nonlooped sample is played, the whole sample plays through once, and then doesn't play any further. If you then attempt a slide-to-note (3xx / 5xy), you won't hear anything.<br />
<br />
If a sample is supplied, then the sample is "latched", the channel volume is reset to the sample's default volume, and the starting offset is reset to 0. ProTracker 1.1 (?) will change the sample, too, but other versions do not.<br />
<br />
''(please clarify: which trackers do this?)''<br />
<br />
ImpulseTracker also changes the sample; however, if you're converting MOD to IT yourself and you don't want this, you can put a "note off" with the sample and it will just change the volume (unfortunately, this behaviour does not work correctly with libmodplug or SchismTracker at the moment).<br />
<br />
If a period is supplied, then the note plays from the starting offset of the current latched sample, unless there is a note slide (effect 3xx or 5xy).<br />
<br />
===Effects===<br />
====0xy====<br />
Arpeggio between 0,x,y semitones up, changing every tick, and retriggering every row. Basically, you select by using tick % 3 where % is the modulo operator.<br />
<br />
====1xx====<br />
Slide up. For every nonzero tick, decrement the period by $xx, clamping to 113 (amiga limits).<br />
<br />
====2xx====<br />
Slide down. For every nonzero tick, increment the period by $xx, clamping to 856 (amiga limits).<br />
<br />
====3xx====<br />
Slide to note. For every nonzero tick, move the period $xx closer to the target period.<br />
<br />
If xx is 0, then use previous value for 3xx.<br />
<br />
====4xy====<br />
Vibrato. x is speed, y is depth. You'll need to generate 3 waveforms beforehand, and spew out random numbers for the last choice of waveform. Each waveform other than the last has a full cycle of 64 steps, and the amplitude is somewhere between -y and y after calculating. When precalculating the waveform, an amplitude of 64 should be fine.<br />
<br />
*Waveform 0 is a sine wave. This is the default.<br />
*Waveform 1 is a downwards saw wave.<br />
*Waveform 2 is a square wave, starting from +y.<br />
*Waveform 3 is random. The cycle of this is mostly irrelevant. In saying this, the speed value is irrelevant with this waveform type, too.<br />
<br />
You have a vibrato waveform position. By default, this retriggers for every note (?) you play by being reset to 0. This loops around a cycle of 64 positions.<br />
<br />
''(please clarify: is it per note or per sample, or will either retrigger it?)''<br />
<br />
For each tick, we add y to the output period at the peak amplitude. For a waveform with peak amplitude of 64, for example, we would add (y*waveform[pos]/64). The period is clamped to Amiga limits.<br />
<br />
If xy is 0, then use previous value for 4xy.<br />
<br />
====5xy====<br />
Volume slide + slide to note: Axy and 300 combined.<br />
<br />
====6xy====<br />
Volume slide + vibrato: Axy and 400 combined.<br />
<br />
====7xy====<br />
Tremolo. x is speed, y is depth. Like vibrato, except we modify the output volume. The volume is clamped to 0 <= vol <= 64.<br />
<br />
''(please clarify: is the maximum amplitude ~16, ~32 or ~64?)''<br />
<br />
If xy is 0, then use previous value for 7xy (?).<br />
<br />
''(please clarify: does the memory work for tremolo, or just vibrato?)''<br />
<br />
====8xx====<br />
FastTracker panning extension. $00 is hard left, $FF is hard right.<br />
<br />
''(please clarify: I really don't give a toss about this FastTracker extension, so I'm putting this question out to someone who does. Does this reset after a new note or sample? And probably some other things, too.)''<br />
<br />
====9xx====<br />
Set sample offset to xx * $100. This also sets the sample starting offset. On older versions of ProTracker (PT < 3.15 (?)), the starting offset is doubled.<br />
<br />
''(please clarify: what players perform this quirk?)''<br />
<br />
On most non canonical trackers (those which aren't in the SoundTracker -> ProTracker line, e.g. FastTracker, ScreamTracker 3, ImpulseTracker), this quirk does not occur, and the starting offset is always 0.<br />
<br />
''(please clarify: what happens when you go over the edge?)''<br />
<br />
====Axy====<br />
Volume slide. Happens every nonzero tick. If x is 0, slide down by y. If y is 0, slide up by x. If both are nonzero, do nothing. Clamp to 0 <= vol <= 64.<br />
<br />
Unlike most module formats, this does not have effect memory. If xy is $00, then don't go anywhere.<br />
<br />
====Bxx====<br />
Jump to offset. If you go over the edge, then the module is restarted (?).<br />
<br />
''(please clarify: does it actually restart?)''<br />
<br />
====Cxx====<br />
Set volume. If greater than 64, then... (?)<br />
<br />
''(please clarify: does it clamp the value at 64, or does it ignore the dud volume? My guess is this: it drops the top bit, and does the former. But that's the lazy way.)''<br />
<br />
====Dxy====<br />
Jump to row x*10 + y. '''THE VALUE PROVIDED IS IN DECIMAL!''' This had to be yelled out as it's a common mistake when making a MOD player.<br />
<br />
====E0x====<br />
If x is 1, turn the Amiga filter off. If x is 0, turn it on. This filter is present on the A500, A2000, and A1200.<br />
<br />
For a simple 1-pole low-pass filter, 11500Hz gives a fairly decent estimation.<br />
<br />
====E1x====<br />
Fine slide up. Like 1xx but without effect memory and only on the first tick.<br />
<br />
====E2x====<br />
Fine slide down. Like 2xx but without effect memory and only on the first tick.<br />
<br />
====E3x====<br />
Screw up 3xx.<br />
<br />
''(please clarify: how does this actually work?)''<br />
<br />
====E4x====<br />
Set vibrato waveform. x & 3 (bottom 2 bits) sets the waveform type. If bit 2 is set (x & 4), then don't retrigger the waveform.<br />
<br />
====E5x====<br />
Set finetune value for the current sample.<br />
<br />
''(please clarify: when does this actually kick in?)''<br />
<br />
====E6x====<br />
Loopback.<br />
<br />
If x is 0, then set the loopback point to the current row. The loopback point is reset to -1 for every Bxx or Dxx or pattern transition (?). Looping back with this means that you have to play row 0 twice.<br />
<br />
''(please clarify: is MikMod right?)''<br />
<br />
Otherwise, we check if the loopback counter set. If the loopback counter is set, then decrement it by 1, otherwise set the counter to x.<br />
<br />
After doing this, if the counter is not 0, then we jump back to the loopback point.<br />
<br />
Unlike S3M and IT, the loopback point remains where it is, so an E60/E61/E61 sequence down a column will result in an infinite loop.<br />
<br />
Each channel has its own set of loopback counters.<br />
<br />
====E7x====<br />
Set tremolo waveform, like E4x.<br />
<br />
====E8x====<br />
Another stereo extension. $0 is hard left, $F is hard right.<br />
<br />
''(please clarify: I don't care about this extension, either. It's far from "real Amiga" material. Please see 8xx for the clarifications required.)''<br />
<br />
====E9x====<br />
Retrigger note every x ticks.<br />
<br />
''(please clarify: does this effect retrigger like IT, or is this just a matter of ticks % x ?)''<br />
<br />
====EAx====<br />
Fine volume slide up. For the first tick, increment the volume by x, clamping x to <= 64.<br />
<br />
====EBx====<br />
Fine volume slide down. For the first tick, decrement the volume by x, clamping x to >= 0.<br />
<br />
====ECx====<br />
Note cut. On the xth tick, set the volume to 0.<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EDx====<br />
Note delay. Don't do what's in the cell until the xth tick.<br />
<br />
''(please clarify: is there anything which escapes this check?)''<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EEx====<br />
Row delay. Repeat the row x times, e.g. if x is 3, then do the row 4 times in total.<br />
<br />
====EFx====<br />
Funkrepeat. This is rarely implemented because not everyone knows how to use it and those who do generally think it's "nasty" as it overwrites sample data. Some might say this is incredibly rare; however, it appears to be more common than E3x.<br />
<br />
So, here's a list which can be added to. The bigger this list, the more pressure MOD player authors will get until they finally implement this under-implemented effect.<br />
<br />
=====List of MODs which use EFx=====<br />
*emax-doz.mod<br />
*emax-seq.mod<br />
<br />
In most cases, a MOD which uses EFx is a chiptune.<br />
<br />
In most cases, a MOD which uses EFx ''needs'' it (for epicness purposes mostly).<br />
<br />
Firstly, you'll want this table. This tells you how much to increment the internal counter by, and is in the ProTracker v1.2 source code.<br />
<br />
0,5,6,7,8,10,11,13,16,19,22,26,32,43,64,128<br />
<br />
If x is 0, then reset that channel's funkrepeat counter and funkrepeat position to 0.<br />
Otherwise, set that channel's funkrepeat speed to funkrepeat_table[x].<br />
<br />
If a channel is not funkrepeating, then you don't need to do what follows for that channel.<br />
<br />
For every tick, increment the channel's funkrepeat counter by its funkrepeat speed. If the funkrepeat counter reaches 128, then ''reset the counter to 0'', and then:<br />
<br />
sampledata[current_sample][loop_begin_in_bytes + funkrepeat_pos] ^= 0xFF;<br />
funkrepeat_pos = (funkrepeat_pos + 1) % loop_length_in_bytes;<br />
<br />
^ is the XOR operator in C. There's also ~ for a binary NOT, but ~= probably isn't valid C.<br />
<br />
Every time you reach a new sample (?) value, reset that channel's funkrepeat position to 0, and start modifying the new sample (?).<br />
<br />
''(please clarify: does the funkrepeat sample position retrigger on sample, note, either, or both?)''<br />
<br />
''(please clarify: when you hit a lone sample which isn't the current one, does it affect that latched sample or the playing sample?)''<br />
<br />
''(please clarify: there's probably a lot of mistakes in this.)''<br />
<br />
====Fxx====<br />
Set TPR or BPM. If xx is less than $20 (32) or this is an old 15-sample module (?), set TPR to xx, otherwise set BPM to xx.<br />
<br />
''(please clarify: Where is the dividing line between raster timing and CIA timing - that is, when was BPM introduced?)''<br />
<br />
''However,'' if xx is 0, then ignore this effect.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want at least ((base clock * 10) / (smallest period value * 4 * 32)) bytes. To unroll a loopless sample, just pad this number of bytes. To unroll a looped sample, append the loop to the end, then unroll this number of bytes from the loop.<br />
<br />
Once you've done that, you only need to check if you've exceeded (length + loop length) words (or bytes if you've converted it) for a looped sample, or length words for an unlooped sample. For an unlooped sample, you just refuse to mix if the offset is past this point. For a looped sample, you set the offset to this:<br />
<br />
offset = length + (offset - length) % looplength;<br />
<br />
where % is the modulo operator. Most forms of BASIC do not have a modulo operator, so you'll probably have to do this instead:<br />
<br />
tmp = offset - length;<br />
offset = length + tmp - (int(tmp / looplength) * looplength);<br />
<br />
This makes funkrepeat trickier to implement, but it has been proven possible.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12165Protracker Module2010-01-21T09:19:45Z<p>GreaseMonkey: /* Playback notes */ clarifying</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was first used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 2 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''2CHN''' - a 2 channel MOD. This is handled by FastTracker.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod so far. This is just a standard MOD, but with a weird tag. ''I ([[User:GreaseMonkey|GreaseMonkey]]) cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
*Pattern data:<br />
**Read 4 bytes for a cell. Read ''channel count'' cells for a row. Read 64 of these rows for a pattern. Read ''pattern count'' of these patterns.<br />
**You read cells as if they were big-endian 32-bit values.<br />
**Cells are in the format $ipppjfxy:<br />
***$ppp is the period value. No, not the note, the period.<br />
***$ij is the sample number.<br />
***$fxy is the effect, $f being the effect type, and $xy being the effect parameter.<br />
*Signed 8-bit mono sample data. Remember those sample lengths? Now is the time to use them.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns. The actual base clock differs. PAL Amigas have a slightly slower clock than NTSC Amigas. This value of 70ns is close to the NTSC clock, but not quite right. Some modules have large samples (known as "megasamples") which require a certain type of Amiga - t_o_t.mod, for instance, requires a PAL Amiga, whereas cd_orbit.mod requires an NTSC Amiga. You can also use 8363*428 for another estimate.<br />
<br />
To get the actual note frequency, divide the Amiga base clock by the period number.<br />
<br />
There is a number of ticks per row, often just referred to as the speed.<br />
<br />
There is a number of "beats per minute"; however, this is a CIA clock speed (it's an Amiga thing). Often just referred to as the tempo. To convert to actual BPM, multiply by 4 and divide by 10. For clarity, we'll refer to it as BPM, even though it's not entirely correct.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
On a real Amiga, when a nonlooped sample is played, the whole sample plays through once, and then doesn't play any further. If you then attempt a slide-to-note (3xx / 5xy), you won't hear anything.<br />
<br />
If a sample is supplied, then the sample is "latched", the channel volume is reset to the sample's default volume, and the starting offset is reset to 0. ProTracker 1.1 (?) will change the sample, too, but other versions do not.<br />
<br />
''(please clarify: which trackers do this?)''<br />
<br />
ImpulseTracker also changes the sample; however, if you're converting MOD to IT yourself and you don't want this, you can put a "note off" with the sample and it will just change the volume (unfortunately, this behaviour does not work correctly with libmodplug or SchismTracker at the moment).<br />
<br />
If a period is supplied, then the note plays from the starting offset of the current latched sample, unless there is a note slide (effect 3xx or 5xy).<br />
<br />
===Effects===<br />
====0xy====<br />
Arpeggio between 0,x,y semitones up, changing every tick, and retriggering every row. Basically, you select by using tick % 3 where % is the modulo operator.<br />
<br />
====1xx====<br />
Slide up. For every nonzero tick, decrement the period by $xx, clamping to 113 (amiga limits).<br />
<br />
====2xx====<br />
Slide down. For every nonzero tick, increment the period by $xx, clamping to 856 (amiga limits).<br />
<br />
====3xx====<br />
Slide to note. For every nonzero tick, move the period $xx closer to the target period.<br />
<br />
If xx is 0, then use previous value for 3xx.<br />
<br />
====4xy====<br />
Vibrato. x is speed, y is depth. You'll need to generate 3 waveforms beforehand, and spew out random numbers for the last choice of waveform. Each waveform other than the last has a full cycle of 64 steps, and the amplitude is somewhere between -y and y after calculating. When precalculating the waveform, an amplitude of 64 should be fine.<br />
<br />
*Waveform 0 is a sine wave. This is the default.<br />
*Waveform 1 is a downwards saw wave.<br />
*Waveform 2 is a square wave, starting from +y.<br />
*Waveform 3 is random. The cycle of this is mostly irrelevant. In saying this, the speed value is irrelevant with this waveform type, too.<br />
<br />
You have a vibrato waveform position. By default, this retriggers for every note (?) you play by being reset to 0. This loops around a cycle of 64 positions.<br />
<br />
''(please clarify: is it per note or per sample, or will either retrigger it?)''<br />
<br />
For each tick, we add y to the output period at the peak amplitude. For a waveform with peak amplitude of 64, for example, we would add (y*waveform[pos]/64). The period is clamped to Amiga limits.<br />
<br />
If xy is 0, then use previous value for 4xy.<br />
<br />
====5xy====<br />
Volume slide + slide to note: Axy and 300 combined.<br />
<br />
====6xy====<br />
Volume slide + vibrato: Axy and 400 combined.<br />
<br />
====7xy====<br />
Tremolo. x is speed, y is depth. Like vibrato, except we modify the output volume. The volume is clamped to 0 <= vol <= 64.<br />
<br />
''(please clarify: is the maximum amplitude ~16, ~32 or ~64?)''<br />
<br />
If xy is 0, then use previous value for 7xy (?).<br />
<br />
''(please clarify: does the memory work for tremolo, or just vibrato?)''<br />
<br />
====8xx====<br />
FastTracker panning extension. $00 is hard left, $FF is hard right.<br />
<br />
''(please clarify: I really don't give a toss about this FastTracker extension, so I'm putting this question out to someone who does. Does this reset after a new note or sample? And probably some other things, too.)''<br />
<br />
====9xx====<br />
Set sample offset to xx * $100. This also sets the sample starting offset. On older versions of ProTracker (PT < 3.15 (?)), the starting offset is doubled.<br />
<br />
''(please clarify: what players perform this quirk?)''<br />
<br />
On most non canonical trackers (those which aren't in the SoundTracker -> ProTracker line, e.g. FastTracker, ScreamTracker 3, ImpulseTracker), this quirk does not occur, and the starting offset is always 0.<br />
<br />
''(please clarify: what happens when you go over the edge?)''<br />
<br />
====Axy====<br />
Volume slide. Happens every nonzero tick. If x is 0, slide down by y. If y is 0, slide up by x. If both are nonzero, do nothing. Clamp to 0 <= vol <= 64.<br />
<br />
Unlike most module formats, this does not have effect memory. If xy is $00, then don't go anywhere.<br />
<br />
====Bxx====<br />
Jump to offset. If you go over the edge, then the module is restarted (?).<br />
<br />
''(please clarify: does it actually restart?)''<br />
<br />
====Cxx====<br />
Set volume. If greater than 64, then... (?)<br />
<br />
''(please clarify: does it clamp the value at 64, or does it ignore the dud volume? My guess is this: it drops the top bit, and does the former. But that's the lazy way.)''<br />
<br />
====Dxy====<br />
Jump to row x*10 + y. '''THE VALUE PROVIDED IS IN DECIMAL!''' This had to be yelled out as it's a common mistake when making a MOD player.<br />
<br />
====E0x====<br />
If x is 1, turn the Amiga filter off. If x is 0, turn it on. This filter is present on the A500, A2000, and A1200.<br />
<br />
For a simple 1-pole low-pass filter, 11500Hz gives a fairly decent estimation.<br />
<br />
====E1x====<br />
Fine slide up. Like 1xx but without effect memory and only on the first tick.<br />
<br />
====E2x====<br />
Fine slide down. Like 2xx but without effect memory and only on the first tick.<br />
<br />
====E3x====<br />
Screw up 3xx.<br />
<br />
''(please clarify: how does this actually work?)''<br />
<br />
====E4x====<br />
Set vibrato waveform. x & 3 (bottom 2 bits) sets the waveform type. If bit 2 is set (x & 4), then don't retrigger the waveform.<br />
<br />
====E5x====<br />
Set finetune value for the current sample.<br />
<br />
''(please clarify: when does this actually kick in?)''<br />
<br />
====E6x====<br />
Loopback.<br />
<br />
If x is 0, then set the loopback point to the current row. The loopback point is reset to -1 for every Bxx or Dxx or pattern transition (?). Looping back with this means that you have to play row 0 twice.<br />
<br />
''(please clarify: is MikMod right?)''<br />
<br />
Otherwise, we check if the loopback counter set. If the loopback counter is set, then decrement it by 1, otherwise set the counter to x.<br />
<br />
After doing this, if the counter is not 0, then we jump back to the loopback point.<br />
<br />
Unlike S3M and IT, the loopback point remains where it is, so an E60/E61/E61 sequence down a column will result in an infinite loop.<br />
<br />
''(please clarify: is this per-channel or global?)''<br />
<br />
====E7x====<br />
Set tremolo waveform, like E4x.<br />
<br />
====E8x====<br />
Another stereo extension. $0 is hard left, $F is hard right.<br />
<br />
''(please clarify: I don't care about this extension, either. It's far from "real Amiga" material. Please see 8xx for the clarifications required.)''<br />
<br />
====E9x====<br />
Retrigger note every x ticks.<br />
<br />
''(please clarify: does this effect retrigger like IT, or is this just a matter of ticks % x ?)''<br />
<br />
====EAx====<br />
Fine volume slide up. For the first tick, increment the volume by x, clamping x to <= 64.<br />
<br />
====EBx====<br />
Fine volume slide down. For the first tick, decrement the volume by x, clamping x to >= 0.<br />
<br />
====ECx====<br />
Note cut. On the xth tick, set the volume to 0.<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EDx====<br />
Note delay. Don't do what's in the cell until the xth tick.<br />
<br />
''(please clarify: is there anything which escapes this check?)''<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EEx====<br />
Row delay. Repeat the row x times, e.g. if x is 3, then do the row 4 times in total.<br />
<br />
====EFx====<br />
Funkrepeat. This is rarely implemented because not everyone knows how to use it and those who do generally think it's "nasty" as it overwrites sample data. Some might say this is incredibly rare; however, it appears to be more common than E3x.<br />
<br />
So, here's a list which can be added to. The bigger this list, the more pressure MOD player authors will get until they finally implement this under-implemented effect.<br />
<br />
=====List of MODs which use EFx=====<br />
*emax-doz.mod<br />
*emax-seq.mod<br />
<br />
In most cases, a MOD which uses EFx is a chiptune.<br />
<br />
In most cases, a MOD which uses EFx ''needs'' it (for epicness purposes mostly).<br />
<br />
Firstly, you'll want this table. This tells you how much to increment the internal counter by, and is in the ProTracker v1.2 source code.<br />
<br />
0,5,6,7,8,10,11,13,16,19,22,26,32,43,64,128<br />
<br />
If x is 0, then reset that channel's funkrepeat counter and funkrepeat position to 0.<br />
Otherwise, set that channel's funkrepeat speed to funkrepeat_table[x].<br />
<br />
If a channel is not funkrepeating, then you don't need to do what follows for that channel.<br />
<br />
For every tick, increment the channel's funkrepeat counter by its funkrepeat speed. If the funkrepeat counter reaches 128, then ''reset the counter to 0'', and then:<br />
<br />
sampledata[current_sample][loop_begin_in_bytes + funkrepeat_pos] ^= 0xFF;<br />
funkrepeat_pos = (funkrepeat_pos + 1) % loop_length_in_bytes;<br />
<br />
^ is the XOR operator in C. There's also ~ for a binary NOT, but ~= probably isn't valid C.<br />
<br />
Every time you reach a new sample (?) value, reset that channel's funkrepeat position to 0, and start modifying the new sample (?).<br />
<br />
''(please clarify: does the funkrepeat sample position retrigger on sample, note, either, or both?)''<br />
<br />
''(please clarify: when you hit a lone sample which isn't the current one, does it affect that latched sample or the playing sample?)''<br />
<br />
''(please clarify: there's probably a lot of mistakes in this.)''<br />
<br />
====Fxx====<br />
Set TPR or BPM. If xx is less than $20 (32) or this is an old 15-sample module (?), set TPR to xx, otherwise set BPM to xx.<br />
<br />
''(please clarify: Where is the dividing line between raster timing and CIA timing - that is, when was BPM introduced?)''<br />
<br />
''However,'' if xx is 0, then ignore this effect.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want at least ((base clock * 10) / (smallest period value * 4 * 32)) bytes. To unroll a loopless sample, just pad this number of bytes. To unroll a looped sample, append the loop to the end, then unroll this number of bytes from the loop.<br />
<br />
Once you've done that, you only need to check if you've exceeded (length + loop length) words (or bytes if you've converted it) for a looped sample, or length words for an unlooped sample. For an unlooped sample, you just refuse to mix if the offset is past this point. For a looped sample, you set the offset to this:<br />
<br />
offset = length + (offset - length) % looplength;<br />
<br />
where % is the modulo operator. Most forms of BASIC do not have a modulo operator, so you'll probably have to do this instead:<br />
<br />
tmp = offset - length;<br />
offset = length + tmp - (int(tmp / looplength) * looplength);<br />
<br />
This makes funkrepeat trickier to implement, but it has been proven possible.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12164Protracker Module2010-01-21T09:17:19Z<p>GreaseMonkey: /* Playback notes */ wait this was wrong</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was first used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 2 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''2CHN''' - a 2 channel MOD. This is handled by FastTracker.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod so far. This is just a standard MOD, but with a weird tag. ''I ([[User:GreaseMonkey|GreaseMonkey]]) cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
*Pattern data:<br />
**Read 4 bytes for a cell. Read ''channel count'' cells for a row. Read 64 of these rows for a pattern. Read ''pattern count'' of these patterns.<br />
**You read cells as if they were big-endian 32-bit values.<br />
**Cells are in the format $ipppjfxy:<br />
***$ppp is the period value. No, not the note, the period.<br />
***$ij is the sample number.<br />
***$fxy is the effect, $f being the effect type, and $xy being the effect parameter.<br />
*Signed 8-bit mono sample data. Remember those sample lengths? Now is the time to use them.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns. The actual base clock differs. PAL Amigas have a slightly slower clock than NTSC Amigas. This value of 70ns is close to the NTSC clock, but not quite right. Some modules have large samples (known as "megasamples") which require a certain type of Amiga - t_o_t.mod, for instance, requires a PAL Amiga, whereas cd_orbit.mod requires an NTSC Amiga. You can also use 8363*428 for another estimate.<br />
<br />
To get the actual note frequency, divide the Amiga base clock by the period number.<br />
<br />
There is a number of ticks per row, often just referred to as the speed.<br />
<br />
There is a number of "beats per minute"; however, this is a CIA clock speed (it's an Amiga thing). Often just referred to as the tempo. To convert to actual BPM, multiply by 4 and divide by 10. For clarity, we'll refer to it as BPM, even though it's not entirely correct.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
On a real Amiga, when a nonlooped sample is played, the whole sample plays through once, and then doesn't play any further. If you then attempt a note slide, you won't hear anything.<br />
<br />
If a sample is supplied, then the sample is "latched", the channel volume is reset to the sample's default volume, and the starting offset is reset to 0. ProTracker 1.1 (?) will change the sample, too, but other versions do not.<br />
<br />
''(please clarify: which trackers do this?)''<br />
<br />
ImpulseTracker also changes the sample; however, if you're converting MOD to IT yourself and you don't want this, you can put a "note off" with the sample and it will just change the volume (unfortunately, this behaviour does not work correctly with libmodplug or SchismTracker at the moment).<br />
<br />
If a period is supplied, then the note plays from the starting offset of the current latched sample, unless there is a note slide (effect 3xx or 5xy).<br />
<br />
===Effects===<br />
====0xy====<br />
Arpeggio between 0,x,y semitones up, changing every tick, and retriggering every row. Basically, you select by using tick % 3 where % is the modulo operator.<br />
<br />
====1xx====<br />
Slide up. For every nonzero tick, decrement the period by $xx, clamping to 113 (amiga limits).<br />
<br />
====2xx====<br />
Slide down. For every nonzero tick, increment the period by $xx, clamping to 856 (amiga limits).<br />
<br />
====3xx====<br />
Slide to note. For every nonzero tick, move the period $xx closer to the target period.<br />
<br />
If xx is 0, then use previous value for 3xx.<br />
<br />
====4xy====<br />
Vibrato. x is speed, y is depth. You'll need to generate 3 waveforms beforehand, and spew out random numbers for the last choice of waveform. Each waveform other than the last has a full cycle of 64 steps, and the amplitude is somewhere between -y and y after calculating. When precalculating the waveform, an amplitude of 64 should be fine.<br />
<br />
*Waveform 0 is a sine wave. This is the default.<br />
*Waveform 1 is a downwards saw wave.<br />
*Waveform 2 is a square wave, starting from +y.<br />
*Waveform 3 is random. The cycle of this is mostly irrelevant. In saying this, the speed value is irrelevant with this waveform type, too.<br />
<br />
You have a vibrato waveform position. By default, this retriggers for every note (?) you play by being reset to 0. This loops around a cycle of 64 positions.<br />
<br />
''(please clarify: is it per note or per sample, or will either retrigger it?)''<br />
<br />
For each tick, we add y to the output period at the peak amplitude. For a waveform with peak amplitude of 64, for example, we would add (y*waveform[pos]/64). The period is clamped to Amiga limits.<br />
<br />
If xy is 0, then use previous value for 4xy.<br />
<br />
====5xy====<br />
Volume slide + slide to note: Axy and 300 combined.<br />
<br />
====6xy====<br />
Volume slide + vibrato: Axy and 400 combined.<br />
<br />
====7xy====<br />
Tremolo. x is speed, y is depth. Like vibrato, except we modify the output volume. The volume is clamped to 0 <= vol <= 64.<br />
<br />
''(please clarify: is the maximum amplitude ~16, ~32 or ~64?)''<br />
<br />
If xy is 0, then use previous value for 7xy (?).<br />
<br />
''(please clarify: does the memory work for tremolo, or just vibrato?)''<br />
<br />
====8xx====<br />
FastTracker panning extension. $00 is hard left, $FF is hard right.<br />
<br />
''(please clarify: I really don't give a toss about this FastTracker extension, so I'm putting this question out to someone who does. Does this reset after a new note or sample? And probably some other things, too.)''<br />
<br />
====9xx====<br />
Set sample offset to xx * $100. This also sets the sample starting offset. On older versions of ProTracker (PT < 3.15 (?)), the starting offset is doubled.<br />
<br />
''(please clarify: what players perform this quirk?)''<br />
<br />
On most non canonical trackers (those which aren't in the SoundTracker -> ProTracker line, e.g. FastTracker, ScreamTracker 3, ImpulseTracker), this quirk does not occur, and the starting offset is always 0.<br />
<br />
''(please clarify: what happens when you go over the edge?)''<br />
<br />
====Axy====<br />
Volume slide. Happens every nonzero tick. If x is 0, slide down by y. If y is 0, slide up by x. If both are nonzero, do nothing. Clamp to 0 <= vol <= 64.<br />
<br />
Unlike most module formats, this does not have effect memory. If xy is $00, then don't go anywhere.<br />
<br />
====Bxx====<br />
Jump to offset. If you go over the edge, then the module is restarted (?).<br />
<br />
''(please clarify: does it actually restart?)''<br />
<br />
====Cxx====<br />
Set volume. If greater than 64, then... (?)<br />
<br />
''(please clarify: does it clamp the value at 64, or does it ignore the dud volume? My guess is this: it drops the top bit, and does the former. But that's the lazy way.)''<br />
<br />
====Dxy====<br />
Jump to row x*10 + y. '''THE VALUE PROVIDED IS IN DECIMAL!''' This had to be yelled out as it's a common mistake when making a MOD player.<br />
<br />
====E0x====<br />
If x is 1, turn the Amiga filter off. If x is 0, turn it on. This filter is present on the A500, A2000, and A1200.<br />
<br />
For a simple 1-pole low-pass filter, 11500Hz gives a fairly decent estimation.<br />
<br />
====E1x====<br />
Fine slide up. Like 1xx but without effect memory and only on the first tick.<br />
<br />
====E2x====<br />
Fine slide down. Like 2xx but without effect memory and only on the first tick.<br />
<br />
====E3x====<br />
Screw up 3xx.<br />
<br />
''(please clarify: how does this actually work?)''<br />
<br />
====E4x====<br />
Set vibrato waveform. x & 3 (bottom 2 bits) sets the waveform type. If bit 2 is set (x & 4), then don't retrigger the waveform.<br />
<br />
====E5x====<br />
Set finetune value for the current sample.<br />
<br />
''(please clarify: when does this actually kick in?)''<br />
<br />
====E6x====<br />
Loopback.<br />
<br />
If x is 0, then set the loopback point to the current row. The loopback point is reset to -1 for every Bxx or Dxx or pattern transition (?). Looping back with this means that you have to play row 0 twice.<br />
<br />
''(please clarify: is MikMod right?)''<br />
<br />
Otherwise, we check if the loopback counter set. If the loopback counter is set, then decrement it by 1, otherwise set the counter to x.<br />
<br />
After doing this, if the counter is not 0, then we jump back to the loopback point.<br />
<br />
Unlike S3M and IT, the loopback point remains where it is, so an E60/E61/E61 sequence down a column will result in an infinite loop.<br />
<br />
''(please clarify: is this per-channel or global?)''<br />
<br />
====E7x====<br />
Set tremolo waveform, like E4x.<br />
<br />
====E8x====<br />
Another stereo extension. $0 is hard left, $F is hard right.<br />
<br />
''(please clarify: I don't care about this extension, either. It's far from "real Amiga" material. Please see 8xx for the clarifications required.)''<br />
<br />
====E9x====<br />
Retrigger note every x ticks.<br />
<br />
''(please clarify: does this effect retrigger like IT, or is this just a matter of ticks % x ?)''<br />
<br />
====EAx====<br />
Fine volume slide up. For the first tick, increment the volume by x, clamping x to <= 64.<br />
<br />
====EBx====<br />
Fine volume slide down. For the first tick, decrement the volume by x, clamping x to >= 0.<br />
<br />
====ECx====<br />
Note cut. On the xth tick, set the volume to 0.<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EDx====<br />
Note delay. Don't do what's in the cell until the xth tick.<br />
<br />
''(please clarify: is there anything which escapes this check?)''<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EEx====<br />
Row delay. Repeat the row x times, e.g. if x is 3, then do the row 4 times in total.<br />
<br />
====EFx====<br />
Funkrepeat. This is rarely implemented because not everyone knows how to use it and those who do generally think it's "nasty" as it overwrites sample data. Some might say this is incredibly rare; however, it appears to be more common than E3x.<br />
<br />
So, here's a list which can be added to. The bigger this list, the more pressure MOD player authors will get until they finally implement this under-implemented effect.<br />
<br />
=====List of MODs which use EFx=====<br />
*emax-doz.mod<br />
*emax-seq.mod<br />
<br />
In most cases, a MOD which uses EFx is a chiptune.<br />
<br />
In most cases, a MOD which uses EFx ''needs'' it (for epicness purposes mostly).<br />
<br />
Firstly, you'll want this table. This tells you how much to increment the internal counter by, and is in the ProTracker v1.2 source code.<br />
<br />
0,5,6,7,8,10,11,13,16,19,22,26,32,43,64,128<br />
<br />
If x is 0, then reset that channel's funkrepeat counter and funkrepeat position to 0.<br />
Otherwise, set that channel's funkrepeat speed to funkrepeat_table[x].<br />
<br />
If a channel is not funkrepeating, then you don't need to do what follows for that channel.<br />
<br />
For every tick, increment the channel's funkrepeat counter by its funkrepeat speed. If the funkrepeat counter reaches 128, then ''reset the counter to 0'', and then:<br />
<br />
sampledata[current_sample][loop_begin_in_bytes + funkrepeat_pos] ^= 0xFF;<br />
funkrepeat_pos = (funkrepeat_pos + 1) % loop_length_in_bytes;<br />
<br />
^ is the XOR operator in C. There's also ~ for a binary NOT, but ~= probably isn't valid C.<br />
<br />
Every time you reach a new sample (?) value, reset that channel's funkrepeat position to 0, and start modifying the new sample (?).<br />
<br />
''(please clarify: does the funkrepeat sample position retrigger on sample, note, either, or both?)''<br />
<br />
''(please clarify: when you hit a lone sample which isn't the current one, does it affect that latched sample or the playing sample?)''<br />
<br />
''(please clarify: there's probably a lot of mistakes in this.)''<br />
<br />
====Fxx====<br />
Set TPR or BPM. If xx is less than $20 (32) or this is an old 15-sample module (?), set TPR to xx, otherwise set BPM to xx.<br />
<br />
''(please clarify: Where is the dividing line between raster timing and CIA timing - that is, when was BPM introduced?)''<br />
<br />
''However,'' if xx is 0, then ignore this effect.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want at least ((base clock * 10) / (smallest period value * 4 * 32)) bytes. To unroll a loopless sample, just pad this number of bytes. To unroll a looped sample, append the loop to the end, then unroll this number of bytes from the loop.<br />
<br />
Once you've done that, you only need to check if you've exceeded (length + loop length) words (or bytes if you've converted it) for a looped sample, or length words for an unlooped sample. For an unlooped sample, you just refuse to mix if the offset is past this point. For a looped sample, you set the offset to this:<br />
<br />
offset = length + (offset - length) % looplength;<br />
<br />
where % is the modulo operator. Most forms of BASIC do not have a modulo operator, so you'll probably have to do this instead:<br />
<br />
tmp = offset - length;<br />
offset = length + tmp - (int(tmp / looplength) * looplength);<br />
<br />
This makes funkrepeat trickier to implement, but it has been proven possible.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12163Protracker Module2010-01-21T09:09:09Z<p>GreaseMonkey: some amiga thing</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was first used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 2 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''2CHN''' - a 2 channel MOD. This is handled by FastTracker.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod so far. This is just a standard MOD, but with a weird tag. ''I ([[User:GreaseMonkey|GreaseMonkey]]) cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
*Pattern data:<br />
**Read 4 bytes for a cell. Read ''channel count'' cells for a row. Read 64 of these rows for a pattern. Read ''pattern count'' of these patterns.<br />
**You read cells as if they were big-endian 32-bit values.<br />
**Cells are in the format $ipppjfxy:<br />
***$ppp is the period value. No, not the note, the period.<br />
***$ij is the sample number.<br />
***$fxy is the effect, $f being the effect type, and $xy being the effect parameter.<br />
*Signed 8-bit mono sample data. Remember those sample lengths? Now is the time to use them.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns. The actual base clock differs. PAL Amigas have a slightly slower clock than NTSC Amigas. This value of 70ns is close to the NTSC clock, but not quite right. Some modules have large samples (known as "megasamples") which require a certain type of Amiga - t_o_t.mod, for instance, requires a PAL Amiga, whereas cd_orbit.mod requires an NTSC Amiga. You can also use 8363*428 for another estimate.<br />
<br />
To get the actual note frequency, divide the Amiga base clock by the period number.<br />
<br />
There is a number of ticks per row, often just referred to as the speed.<br />
<br />
There is a number of "beats per minute"; however, this is a CIA clock speed (it's an Amiga thing). Often just referred to as the tempo. To convert to actual BPM, multiply by 4 and divide by 10. For clarity, we'll refer to it as BPM, even though it's not entirely correct.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
On a real Amiga, when a nonlooped sample is played, the whole sample plays through once, and then doesn't play any further. If you then do a sample without a note, you won't hear anything.<br />
<br />
If a sample is supplied, then the sample is "latched", the channel volume is reset to the sample's default volume, and the starting offset is reset to 0. ProTracker 1.1 (?) will change the sample, too, but other versions do not.<br />
<br />
''(please clarify: which trackers do this?)''<br />
<br />
ImpulseTracker also changes the sample; however, if you're converting MOD to IT yourself and you don't want this, you can put a "note off" with the sample and it will just change the volume (unfortunately, this behaviour does not work correctly with libmodplug or SchismTracker at the moment).<br />
<br />
If a period is supplied, then the note plays from the starting offset of the current latched sample, unless there is a note slide (effect 3xx or 5xy).<br />
<br />
===Effects===<br />
====0xy====<br />
Arpeggio between 0,x,y semitones up, changing every tick, and retriggering every row. Basically, you select by using tick % 3 where % is the modulo operator.<br />
<br />
====1xx====<br />
Slide up. For every nonzero tick, decrement the period by $xx, clamping to 113 (amiga limits).<br />
<br />
====2xx====<br />
Slide down. For every nonzero tick, increment the period by $xx, clamping to 856 (amiga limits).<br />
<br />
====3xx====<br />
Slide to note. For every nonzero tick, move the period $xx closer to the target period.<br />
<br />
If xx is 0, then use previous value for 3xx.<br />
<br />
====4xy====<br />
Vibrato. x is speed, y is depth. You'll need to generate 3 waveforms beforehand, and spew out random numbers for the last choice of waveform. Each waveform other than the last has a full cycle of 64 steps, and the amplitude is somewhere between -y and y after calculating. When precalculating the waveform, an amplitude of 64 should be fine.<br />
<br />
*Waveform 0 is a sine wave. This is the default.<br />
*Waveform 1 is a downwards saw wave.<br />
*Waveform 2 is a square wave, starting from +y.<br />
*Waveform 3 is random. The cycle of this is mostly irrelevant. In saying this, the speed value is irrelevant with this waveform type, too.<br />
<br />
You have a vibrato waveform position. By default, this retriggers for every note (?) you play by being reset to 0. This loops around a cycle of 64 positions.<br />
<br />
''(please clarify: is it per note or per sample, or will either retrigger it?)''<br />
<br />
For each tick, we add y to the output period at the peak amplitude. For a waveform with peak amplitude of 64, for example, we would add (y*waveform[pos]/64). The period is clamped to Amiga limits.<br />
<br />
If xy is 0, then use previous value for 4xy.<br />
<br />
====5xy====<br />
Volume slide + slide to note: Axy and 300 combined.<br />
<br />
====6xy====<br />
Volume slide + vibrato: Axy and 400 combined.<br />
<br />
====7xy====<br />
Tremolo. x is speed, y is depth. Like vibrato, except we modify the output volume. The volume is clamped to 0 <= vol <= 64.<br />
<br />
''(please clarify: is the maximum amplitude ~16, ~32 or ~64?)''<br />
<br />
If xy is 0, then use previous value for 7xy (?).<br />
<br />
''(please clarify: does the memory work for tremolo, or just vibrato?)''<br />
<br />
====8xx====<br />
FastTracker panning extension. $00 is hard left, $FF is hard right.<br />
<br />
''(please clarify: I really don't give a toss about this FastTracker extension, so I'm putting this question out to someone who does. Does this reset after a new note or sample? And probably some other things, too.)''<br />
<br />
====9xx====<br />
Set sample offset to xx * $100. This also sets the sample starting offset. On older versions of ProTracker (PT < 3.15 (?)), the starting offset is doubled.<br />
<br />
''(please clarify: what players perform this quirk?)''<br />
<br />
On most non canonical trackers (those which aren't in the SoundTracker -> ProTracker line, e.g. FastTracker, ScreamTracker 3, ImpulseTracker), this quirk does not occur, and the starting offset is always 0.<br />
<br />
''(please clarify: what happens when you go over the edge?)''<br />
<br />
====Axy====<br />
Volume slide. Happens every nonzero tick. If x is 0, slide down by y. If y is 0, slide up by x. If both are nonzero, do nothing. Clamp to 0 <= vol <= 64.<br />
<br />
Unlike most module formats, this does not have effect memory. If xy is $00, then don't go anywhere.<br />
<br />
====Bxx====<br />
Jump to offset. If you go over the edge, then the module is restarted (?).<br />
<br />
''(please clarify: does it actually restart?)''<br />
<br />
====Cxx====<br />
Set volume. If greater than 64, then... (?)<br />
<br />
''(please clarify: does it clamp the value at 64, or does it ignore the dud volume? My guess is this: it drops the top bit, and does the former. But that's the lazy way.)''<br />
<br />
====Dxy====<br />
Jump to row x*10 + y. '''THE VALUE PROVIDED IS IN DECIMAL!''' This had to be yelled out as it's a common mistake when making a MOD player.<br />
<br />
====E0x====<br />
If x is 1, turn the Amiga filter off. If x is 0, turn it on. This filter is present on the A500, A2000, and A1200.<br />
<br />
For a simple 1-pole low-pass filter, 11500Hz gives a fairly decent estimation.<br />
<br />
====E1x====<br />
Fine slide up. Like 1xx but without effect memory and only on the first tick.<br />
<br />
====E2x====<br />
Fine slide down. Like 2xx but without effect memory and only on the first tick.<br />
<br />
====E3x====<br />
Screw up 3xx.<br />
<br />
''(please clarify: how does this actually work?)''<br />
<br />
====E4x====<br />
Set vibrato waveform. x & 3 (bottom 2 bits) sets the waveform type. If bit 2 is set (x & 4), then don't retrigger the waveform.<br />
<br />
====E5x====<br />
Set finetune value for the current sample.<br />
<br />
''(please clarify: when does this actually kick in?)''<br />
<br />
====E6x====<br />
Loopback.<br />
<br />
If x is 0, then set the loopback point to the current row. The loopback point is reset to -1 for every Bxx or Dxx or pattern transition (?). Looping back with this means that you have to play row 0 twice.<br />
<br />
''(please clarify: is MikMod right?)''<br />
<br />
Otherwise, we check if the loopback counter set. If the loopback counter is set, then decrement it by 1, otherwise set the counter to x.<br />
<br />
After doing this, if the counter is not 0, then we jump back to the loopback point.<br />
<br />
Unlike S3M and IT, the loopback point remains where it is, so an E60/E61/E61 sequence down a column will result in an infinite loop.<br />
<br />
''(please clarify: is this per-channel or global?)''<br />
<br />
====E7x====<br />
Set tremolo waveform, like E4x.<br />
<br />
====E8x====<br />
Another stereo extension. $0 is hard left, $F is hard right.<br />
<br />
''(please clarify: I don't care about this extension, either. It's far from "real Amiga" material. Please see 8xx for the clarifications required.)''<br />
<br />
====E9x====<br />
Retrigger note every x ticks.<br />
<br />
''(please clarify: does this effect retrigger like IT, or is this just a matter of ticks % x ?)''<br />
<br />
====EAx====<br />
Fine volume slide up. For the first tick, increment the volume by x, clamping x to <= 64.<br />
<br />
====EBx====<br />
Fine volume slide down. For the first tick, decrement the volume by x, clamping x to >= 0.<br />
<br />
====ECx====<br />
Note cut. On the xth tick, set the volume to 0.<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EDx====<br />
Note delay. Don't do what's in the cell until the xth tick.<br />
<br />
''(please clarify: is there anything which escapes this check?)''<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EEx====<br />
Row delay. Repeat the row x times, e.g. if x is 3, then do the row 4 times in total.<br />
<br />
====EFx====<br />
Funkrepeat. This is rarely implemented because not everyone knows how to use it and those who do generally think it's "nasty" as it overwrites sample data. Some might say this is incredibly rare; however, it appears to be more common than E3x.<br />
<br />
So, here's a list which can be added to. The bigger this list, the more pressure MOD player authors will get until they finally implement this under-implemented effect.<br />
<br />
=====List of MODs which use EFx=====<br />
*emax-doz.mod<br />
*emax-seq.mod<br />
<br />
In most cases, a MOD which uses EFx is a chiptune.<br />
<br />
In most cases, a MOD which uses EFx ''needs'' it (for epicness purposes mostly).<br />
<br />
Firstly, you'll want this table. This tells you how much to increment the internal counter by, and is in the ProTracker v1.2 source code.<br />
<br />
0,5,6,7,8,10,11,13,16,19,22,26,32,43,64,128<br />
<br />
If x is 0, then reset that channel's funkrepeat counter and funkrepeat position to 0.<br />
Otherwise, set that channel's funkrepeat speed to funkrepeat_table[x].<br />
<br />
If a channel is not funkrepeating, then you don't need to do what follows for that channel.<br />
<br />
For every tick, increment the channel's funkrepeat counter by its funkrepeat speed. If the funkrepeat counter reaches 128, then ''reset the counter to 0'', and then:<br />
<br />
sampledata[current_sample][loop_begin_in_bytes + funkrepeat_pos] ^= 0xFF;<br />
funkrepeat_pos = (funkrepeat_pos + 1) % loop_length_in_bytes;<br />
<br />
^ is the XOR operator in C. There's also ~ for a binary NOT, but ~= probably isn't valid C.<br />
<br />
Every time you reach a new sample (?) value, reset that channel's funkrepeat position to 0, and start modifying the new sample (?).<br />
<br />
''(please clarify: does the funkrepeat sample position retrigger on sample, note, either, or both?)''<br />
<br />
''(please clarify: when you hit a lone sample which isn't the current one, does it affect that latched sample or the playing sample?)''<br />
<br />
''(please clarify: there's probably a lot of mistakes in this.)''<br />
<br />
====Fxx====<br />
Set TPR or BPM. If xx is less than $20 (32) or this is an old 15-sample module (?), set TPR to xx, otherwise set BPM to xx.<br />
<br />
''(please clarify: Where is the dividing line between raster timing and CIA timing - that is, when was BPM introduced?)''<br />
<br />
''However,'' if xx is 0, then ignore this effect.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want at least ((base clock * 10) / (smallest period value * 4 * 32)) bytes. To unroll a loopless sample, just pad this number of bytes. To unroll a looped sample, append the loop to the end, then unroll this number of bytes from the loop.<br />
<br />
Once you've done that, you only need to check if you've exceeded (length + loop length) words (or bytes if you've converted it) for a looped sample, or length words for an unlooped sample. For an unlooped sample, you just refuse to mix if the offset is past this point. For a looped sample, you set the offset to this:<br />
<br />
offset = length + (offset - length) % looplength;<br />
<br />
where % is the modulo operator. Most forms of BASIC do not have a modulo operator, so you'll probably have to do this instead:<br />
<br />
tmp = offset - length;<br />
offset = length + tmp - (int(tmp / looplength) * looplength);<br />
<br />
This makes funkrepeat trickier to implement, but it has been proven possible.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12162Protracker Module2010-01-21T08:50:54Z<p>GreaseMonkey: ft2 handles 2CHN mods. forgot about that.</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was first used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 2 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''2CHN''' - a 2 channel MOD. This is handled by FastTracker.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod so far. This is just a standard MOD, but with a weird tag. ''I ([[User:GreaseMonkey|GreaseMonkey]]) cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
*Pattern data:<br />
**Read 4 bytes for a cell. Read ''channel count'' cells for a row. Read 64 of these rows for a pattern. Read ''pattern count'' of these patterns.<br />
**You read cells as if they were big-endian 32-bit values.<br />
**Cells are in the format $ipppjfxy:<br />
***$ppp is the period value. No, not the note, the period.<br />
***$ij is the sample number.<br />
***$fxy is the effect, $f being the effect type, and $xy being the effect parameter.<br />
*Signed 8-bit mono sample data. Remember those sample lengths? Now is the time to use them.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns. The actual base clock differs. PAL Amigas have a slightly slower clock than NTSC Amigas. This value of 70ns is close to the NTSC clock, but not quite right. Some modules have large samples (known as "megasamples") which require a certain type of Amiga - t_o_t.mod, for instance, requires a PAL Amiga, whereas cd_orbit.mod requires an NTSC Amiga. You can also use 8363*428 for another estimate.<br />
<br />
To get the actual note frequency, divide the Amiga base clock by the period number.<br />
<br />
There is a number of ticks per row, often just referred to as the speed.<br />
<br />
There is a number of "beats per minute"; however, this is a CIA clock speed (it's an Amiga thing). Often just referred to as the tempo. To convert to actual BPM, multiply by 4 and divide by 10. For clarity, we'll refer to it as BPM, even though it's not entirely correct.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
If a sample is supplied, then the sample is "latched", the channel volume is reset to the sample's default volume, and the starting offset is reset to 0. ProTracker 1.1 (?) will change the sample, too, but other versions do not.<br />
<br />
''(please clarify: which trackers do this?)''<br />
<br />
ImpulseTracker also changes the sample; however, if you're converting MOD to IT yourself and you don't want this, you can put a "note off" with the sample and it will just change the volume (unfortunately, this behaviour does not work correctly with libmodplug or SchismTracker at the moment).<br />
<br />
If a period is supplied, then the note plays from the starting offset of the current latched sample, unless there is a note slide (effect 3xx or 5xy).<br />
<br />
===Effects===<br />
====0xy====<br />
Arpeggio between 0,x,y semitones up, changing every tick, and retriggering every row. Basically, you select by using tick % 3 where % is the modulo operator.<br />
<br />
====1xx====<br />
Slide up. For every nonzero tick, decrement the period by $xx, clamping to 113 (amiga limits).<br />
<br />
====2xx====<br />
Slide down. For every nonzero tick, increment the period by $xx, clamping to 856 (amiga limits).<br />
<br />
====3xx====<br />
Slide to note. For every nonzero tick, move the period $xx closer to the target period.<br />
<br />
If xx is 0, then use previous value for 3xx.<br />
<br />
====4xy====<br />
Vibrato. x is speed, y is depth. You'll need to generate 3 waveforms beforehand, and spew out random numbers for the last choice of waveform. Each waveform other than the last has a full cycle of 64 steps, and the amplitude is somewhere between -y and y after calculating. When precalculating the waveform, an amplitude of 64 should be fine.<br />
<br />
*Waveform 0 is a sine wave. This is the default.<br />
*Waveform 1 is a downwards saw wave.<br />
*Waveform 2 is a square wave, starting from +y.<br />
*Waveform 3 is random. The cycle of this is mostly irrelevant. In saying this, the speed value is irrelevant with this waveform type, too.<br />
<br />
You have a vibrato waveform position. By default, this retriggers for every note (?) you play by being reset to 0. This loops around a cycle of 64 positions.<br />
<br />
''(please clarify: is it per note or per sample, or will either retrigger it?)''<br />
<br />
For each tick, we add y to the output period at the peak amplitude. For a waveform with peak amplitude of 64, for example, we would add (y*waveform[pos]/64). The period is clamped to Amiga limits.<br />
<br />
If xy is 0, then use previous value for 4xy.<br />
<br />
====5xy====<br />
Volume slide + slide to note: Axy and 300 combined.<br />
<br />
====6xy====<br />
Volume slide + vibrato: Axy and 400 combined.<br />
<br />
====7xy====<br />
Tremolo. x is speed, y is depth. Like vibrato, except we modify the output volume. The volume is clamped to 0 <= vol <= 64.<br />
<br />
''(please clarify: is the maximum amplitude ~16, ~32 or ~64?)''<br />
<br />
If xy is 0, then use previous value for 7xy (?).<br />
<br />
''(please clarify: does the memory work for tremolo, or just vibrato?)''<br />
<br />
====8xx====<br />
FastTracker panning extension. $00 is hard left, $FF is hard right.<br />
<br />
''(please clarify: I really don't give a toss about this FastTracker extension, so I'm putting this question out to someone who does. Does this reset after a new note or sample? And probably some other things, too.)''<br />
<br />
====9xx====<br />
Set sample offset to xx * $100. This also sets the sample starting offset. On older versions of ProTracker (PT < 3.15 (?)), the starting offset is doubled.<br />
<br />
''(please clarify: what players perform this quirk?)''<br />
<br />
On most non canonical trackers (those which aren't in the SoundTracker -> ProTracker line, e.g. FastTracker, ScreamTracker 3, ImpulseTracker), this quirk does not occur, and the starting offset is always 0.<br />
<br />
''(please clarify: what happens when you go over the edge?)''<br />
<br />
====Axy====<br />
Volume slide. Happens every nonzero tick. If x is 0, slide down by y. If y is 0, slide up by x. If both are nonzero, do nothing. Clamp to 0 <= vol <= 64.<br />
<br />
Unlike most module formats, this does not have effect memory. If xy is $00, then don't go anywhere.<br />
<br />
====Bxx====<br />
Jump to offset. If you go over the edge, then the module is restarted (?).<br />
<br />
''(please clarify: does it actually restart?)''<br />
<br />
====Cxx====<br />
Set volume. If greater than 64, then... (?)<br />
<br />
''(please clarify: does it clamp the value at 64, or does it ignore the dud volume? My guess is this: it drops the top bit, and does the former. But that's the lazy way.)''<br />
<br />
====Dxy====<br />
Jump to row x*10 + y. '''THE VALUE PROVIDED IS IN DECIMAL!''' This had to be yelled out as it's a common mistake when making a MOD player.<br />
<br />
====E0x====<br />
If x is 1, turn the Amiga filter off. If x is 0, turn it on. This filter is present on the A500, A2000, and A1200.<br />
<br />
For a simple 1-pole low-pass filter, 11500Hz gives a fairly decent estimation.<br />
<br />
====E1x====<br />
Fine slide up. Like 1xx but without effect memory and only on the first tick.<br />
<br />
====E2x====<br />
Fine slide down. Like 2xx but without effect memory and only on the first tick.<br />
<br />
====E3x====<br />
Screw up 3xx.<br />
<br />
''(please clarify: how does this actually work?)''<br />
<br />
====E4x====<br />
Set vibrato waveform. x & 3 (bottom 2 bits) sets the waveform type. If bit 2 is set (x & 4), then don't retrigger the waveform.<br />
<br />
====E5x====<br />
Set finetune value for the current sample.<br />
<br />
''(please clarify: when does this actually kick in?)''<br />
<br />
====E6x====<br />
Loopback.<br />
<br />
If x is 0, then set the loopback point to the current row. The loopback point is reset to -1 for every Bxx or Dxx or pattern transition (?). Looping back with this means that you have to play row 0 twice.<br />
<br />
''(please clarify: is MikMod right?)''<br />
<br />
Otherwise, we check if the loopback counter set. If the loopback counter is set, then decrement it by 1, otherwise set the counter to x.<br />
<br />
After doing this, if the counter is not 0, then we jump back to the loopback point.<br />
<br />
Unlike S3M and IT, the loopback point remains where it is, so an E60/E61/E61 sequence down a column will result in an infinite loop.<br />
<br />
''(please clarify: is this per-channel or global?)''<br />
<br />
====E7x====<br />
Set tremolo waveform, like E4x.<br />
<br />
====E8x====<br />
Another stereo extension. $0 is hard left, $F is hard right.<br />
<br />
''(please clarify: I don't care about this extension, either. It's far from "real Amiga" material. Please see 8xx for the clarifications required.)''<br />
<br />
====E9x====<br />
Retrigger note every x ticks.<br />
<br />
''(please clarify: does this effect retrigger like IT, or is this just a matter of ticks % x ?)''<br />
<br />
====EAx====<br />
Fine volume slide up. For the first tick, increment the volume by x, clamping x to <= 64.<br />
<br />
====EBx====<br />
Fine volume slide down. For the first tick, decrement the volume by x, clamping x to >= 0.<br />
<br />
====ECx====<br />
Note cut. On the xth tick, set the volume to 0.<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EDx====<br />
Note delay. Don't do what's in the cell until the xth tick.<br />
<br />
''(please clarify: is there anything which escapes this check?)''<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EEx====<br />
Row delay. Repeat the row x times, e.g. if x is 3, then do the row 4 times in total.<br />
<br />
====EFx====<br />
Funkrepeat. This is rarely implemented because not everyone knows how to use it and those who do generally think it's "nasty" as it overwrites sample data. Some might say this is incredibly rare; however, it appears to be more common than E3x.<br />
<br />
So, here's a list which can be added to. The bigger this list, the more pressure MOD player authors will get until they finally implement this under-implemented effect.<br />
<br />
=====List of MODs which use EFx=====<br />
*emax-doz.mod<br />
*emax-seq.mod<br />
<br />
In most cases, a MOD which uses EFx is a chiptune.<br />
<br />
In most cases, a MOD which uses EFx ''needs'' it (for epicness purposes mostly).<br />
<br />
Firstly, you'll want this table. This tells you how much to increment the internal counter by, and is in the ProTracker v1.2 source code.<br />
<br />
0,5,6,7,8,10,11,13,16,19,22,26,32,43,64,128<br />
<br />
If x is 0, then reset that channel's funkrepeat counter and funkrepeat position to 0.<br />
Otherwise, set that channel's funkrepeat speed to funkrepeat_table[x].<br />
<br />
If a channel is not funkrepeating, then you don't need to do what follows for that channel.<br />
<br />
For every tick, increment the channel's funkrepeat counter by its funkrepeat speed. If the funkrepeat counter reaches 128, then ''reset the counter to 0'', and then:<br />
<br />
sampledata[current_sample][loop_begin_in_bytes + funkrepeat_pos] ^= 0xFF;<br />
funkrepeat_pos = (funkrepeat_pos + 1) % loop_length_in_bytes;<br />
<br />
^ is the XOR operator in C. There's also ~ for a binary NOT, but ~= probably isn't valid C.<br />
<br />
Every time you reach a new sample (?) value, reset that channel's funkrepeat position to 0, and start modifying the new sample (?).<br />
<br />
''(please clarify: does the funkrepeat sample position retrigger on sample, note, either, or both?)''<br />
<br />
''(please clarify: when you hit a lone sample which isn't the current one, does it affect that latched sample or the playing sample?)''<br />
<br />
''(please clarify: there's probably a lot of mistakes in this.)''<br />
<br />
====Fxx====<br />
Set TPR or BPM. If xx is less than $20 (32) or this is an old 15-sample module (?), set TPR to xx, otherwise set BPM to xx.<br />
<br />
''(please clarify: Where is the dividing line between raster timing and CIA timing - that is, when was BPM introduced?)''<br />
<br />
''However,'' if xx is 0, then ignore this effect.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want at least ((base clock * 10) / (smallest period value * 4 * 32)) bytes. To unroll a loopless sample, just pad this number of bytes. To unroll a looped sample, append the loop to the end, then unroll this number of bytes from the loop.<br />
<br />
Once you've done that, you only need to check if you've exceeded (length + loop length) words (or bytes if you've converted it) for a looped sample, or length words for an unlooped sample. For an unlooped sample, you just refuse to mix if the offset is past this point. For a looped sample, you set the offset to this:<br />
<br />
offset = length + (offset - length) % looplength;<br />
<br />
where % is the modulo operator. Most forms of BASIC do not have a modulo operator, so you'll probably have to do this instead:<br />
<br />
tmp = offset - length;<br />
offset = length + tmp - (int(tmp / looplength) * looplength);<br />
<br />
This makes funkrepeat trickier to implement, but it has been proven possible.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12161Protracker Module2010-01-21T08:08:10Z<p>GreaseMonkey: /* Playback notes */ forgot to mention what periods were for</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was first used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 4 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod so far. This is just a standard MOD, but with a weird tag. ''I ([[User:GreaseMonkey|GreaseMonkey]]) cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
*Pattern data:<br />
**Read 4 bytes for a cell. Read ''channel count'' cells for a row. Read 64 of these rows for a pattern. Read ''pattern count'' of these patterns.<br />
**You read cells as if they were big-endian 32-bit values.<br />
**Cells are in the format $ipppjfxy:<br />
***$ppp is the period value. No, not the note, the period.<br />
***$ij is the sample number.<br />
***$fxy is the effect, $f being the effect type, and $xy being the effect parameter.<br />
*Signed 8-bit mono sample data. Remember those sample lengths? Now is the time to use them.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns. The actual base clock differs. PAL Amigas have a slightly slower clock than NTSC Amigas. This value of 70ns is close to the NTSC clock, but not quite right. Some modules have large samples (known as "megasamples") which require a certain type of Amiga - t_o_t.mod, for instance, requires a PAL Amiga, whereas cd_orbit.mod requires an NTSC Amiga. You can also use 8363*428 for another estimate.<br />
<br />
To get the actual note frequency, divide the Amiga base clock by the period number.<br />
<br />
There is a number of ticks per row, often just referred to as the speed.<br />
<br />
There is a number of "beats per minute"; however, this is a CIA clock speed (it's an Amiga thing). Often just referred to as the tempo. To convert to actual BPM, multiply by 4 and divide by 10. For clarity, we'll refer to it as BPM, even though it's not entirely correct.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
If a sample is supplied, then the sample is "latched", the channel volume is reset to the sample's default volume, and the starting offset is reset to 0. ProTracker 1.1 (?) will change the sample, too, but other versions do not.<br />
<br />
''(please clarify: which trackers do this?)''<br />
<br />
ImpulseTracker also changes the sample; however, if you're converting MOD to IT yourself and you don't want this, you can put a "note off" with the sample and it will just change the volume (unfortunately, this behaviour does not work correctly with libmodplug or SchismTracker at the moment).<br />
<br />
If a period is supplied, then the note plays from the starting offset of the current latched sample, unless there is a note slide (effect 3xx or 5xy).<br />
<br />
===Effects===<br />
====0xy====<br />
Arpeggio between 0,x,y semitones up, changing every tick, and retriggering every row. Basically, you select by using tick % 3 where % is the modulo operator.<br />
<br />
====1xx====<br />
Slide up. For every nonzero tick, decrement the period by $xx, clamping to 113 (amiga limits).<br />
<br />
====2xx====<br />
Slide down. For every nonzero tick, increment the period by $xx, clamping to 856 (amiga limits).<br />
<br />
====3xx====<br />
Slide to note. For every nonzero tick, move the period $xx closer to the target period.<br />
<br />
If xx is 0, then use previous value for 3xx.<br />
<br />
====4xy====<br />
Vibrato. x is speed, y is depth. You'll need to generate 3 waveforms beforehand, and spew out random numbers for the last choice of waveform. Each waveform other than the last has a full cycle of 64 steps, and the amplitude is somewhere between -y and y after calculating. When precalculating the waveform, an amplitude of 64 should be fine.<br />
<br />
*Waveform 0 is a sine wave. This is the default.<br />
*Waveform 1 is a downwards saw wave.<br />
*Waveform 2 is a square wave, starting from +y.<br />
*Waveform 3 is random. The cycle of this is mostly irrelevant. In saying this, the speed value is irrelevant with this waveform type, too.<br />
<br />
You have a vibrato waveform position. By default, this retriggers for every note (?) you play by being reset to 0. This loops around a cycle of 64 positions.<br />
<br />
''(please clarify: is it per note or per sample, or will either retrigger it?)''<br />
<br />
For each tick, we add y to the output period at the peak amplitude. For a waveform with peak amplitude of 64, for example, we would add (y*waveform[pos]/64). The period is clamped to Amiga limits.<br />
<br />
If xy is 0, then use previous value for 4xy.<br />
<br />
====5xy====<br />
Volume slide + slide to note: Axy and 300 combined.<br />
<br />
====6xy====<br />
Volume slide + vibrato: Axy and 400 combined.<br />
<br />
====7xy====<br />
Tremolo. x is speed, y is depth. Like vibrato, except we modify the output volume. The volume is clamped to 0 <= vol <= 64.<br />
<br />
''(please clarify: is the maximum amplitude ~16, ~32 or ~64?)''<br />
<br />
If xy is 0, then use previous value for 7xy (?).<br />
<br />
''(please clarify: does the memory work for tremolo, or just vibrato?)''<br />
<br />
====8xx====<br />
FastTracker panning extension. $00 is hard left, $FF is hard right.<br />
<br />
''(please clarify: I really don't give a toss about this FastTracker extension, so I'm putting this question out to someone who does. Does this reset after a new note or sample? And probably some other things, too.)''<br />
<br />
====9xx====<br />
Set sample offset to xx * $100. This also sets the sample starting offset. On older versions of ProTracker (PT < 3.15 (?)), the starting offset is doubled.<br />
<br />
''(please clarify: what players perform this quirk?)''<br />
<br />
On most non canonical trackers (those which aren't in the SoundTracker -> ProTracker line, e.g. FastTracker, ScreamTracker 3, ImpulseTracker), this quirk does not occur, and the starting offset is always 0.<br />
<br />
''(please clarify: what happens when you go over the edge?)''<br />
<br />
====Axy====<br />
Volume slide. Happens every nonzero tick. If x is 0, slide down by y. If y is 0, slide up by x. If both are nonzero, do nothing. Clamp to 0 <= vol <= 64.<br />
<br />
Unlike most module formats, this does not have effect memory. If xy is $00, then don't go anywhere.<br />
<br />
====Bxx====<br />
Jump to offset. If you go over the edge, then the module is restarted (?).<br />
<br />
''(please clarify: does it actually restart?)''<br />
<br />
====Cxx====<br />
Set volume. If greater than 64, then... (?)<br />
<br />
''(please clarify: does it clamp the value at 64, or does it ignore the dud volume? My guess is this: it drops the top bit, and does the former. But that's the lazy way.)''<br />
<br />
====Dxy====<br />
Jump to row x*10 + y. '''THE VALUE PROVIDED IS IN DECIMAL!''' This had to be yelled out as it's a common mistake when making a MOD player.<br />
<br />
====E0x====<br />
If x is 1, turn the Amiga filter off. If x is 0, turn it on. This filter is present on the A500, A2000, and A1200.<br />
<br />
For a simple 1-pole low-pass filter, 11500Hz gives a fairly decent estimation.<br />
<br />
====E1x====<br />
Fine slide up. Like 1xx but without effect memory and only on the first tick.<br />
<br />
====E2x====<br />
Fine slide down. Like 2xx but without effect memory and only on the first tick.<br />
<br />
====E3x====<br />
Screw up 3xx.<br />
<br />
''(please clarify: how does this actually work?)''<br />
<br />
====E4x====<br />
Set vibrato waveform. x & 3 (bottom 2 bits) sets the waveform type. If bit 2 is set (x & 4), then don't retrigger the waveform.<br />
<br />
====E5x====<br />
Set finetune value for the current sample.<br />
<br />
''(please clarify: when does this actually kick in?)''<br />
<br />
====E6x====<br />
Loopback.<br />
<br />
If x is 0, then set the loopback point to the current row. The loopback point is reset to -1 for every Bxx or Dxx or pattern transition (?). Looping back with this means that you have to play row 0 twice.<br />
<br />
''(please clarify: is MikMod right?)''<br />
<br />
Otherwise, we check if the loopback counter set. If the loopback counter is set, then decrement it by 1, otherwise set the counter to x.<br />
<br />
After doing this, if the counter is not 0, then we jump back to the loopback point.<br />
<br />
Unlike S3M and IT, the loopback point remains where it is, so an E60/E61/E61 sequence down a column will result in an infinite loop.<br />
<br />
''(please clarify: is this per-channel or global?)''<br />
<br />
====E7x====<br />
Set tremolo waveform, like E4x.<br />
<br />
====E8x====<br />
Another stereo extension. $0 is hard left, $F is hard right.<br />
<br />
''(please clarify: I don't care about this extension, either. It's far from "real Amiga" material. Please see 8xx for the clarifications required.)''<br />
<br />
====E9x====<br />
Retrigger note every x ticks.<br />
<br />
''(please clarify: does this effect retrigger like IT, or is this just a matter of ticks % x ?)''<br />
<br />
====EAx====<br />
Fine volume slide up. For the first tick, increment the volume by x, clamping x to <= 64.<br />
<br />
====EBx====<br />
Fine volume slide down. For the first tick, decrement the volume by x, clamping x to >= 0.<br />
<br />
====ECx====<br />
Note cut. On the xth tick, set the volume to 0.<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EDx====<br />
Note delay. Don't do what's in the cell until the xth tick.<br />
<br />
''(please clarify: is there anything which escapes this check?)''<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EEx====<br />
Row delay. Repeat the row x times, e.g. if x is 3, then do the row 4 times in total.<br />
<br />
====EFx====<br />
Funkrepeat. This is rarely implemented because not everyone knows how to use it and those who do generally think it's "nasty" as it overwrites sample data. Some might say this is incredibly rare; however, it appears to be more common than E3x.<br />
<br />
So, here's a list which can be added to. The bigger this list, the more pressure MOD player authors will get until they finally implement this under-implemented effect.<br />
<br />
=====List of MODs which use EFx=====<br />
*emax-doz.mod<br />
*emax-seq.mod<br />
<br />
In most cases, a MOD which uses EFx is a chiptune.<br />
<br />
In most cases, a MOD which uses EFx ''needs'' it (for epicness purposes mostly).<br />
<br />
Firstly, you'll want this table. This tells you how much to increment the internal counter by, and is in the ProTracker v1.2 source code.<br />
<br />
0,5,6,7,8,10,11,13,16,19,22,26,32,43,64,128<br />
<br />
If x is 0, then reset that channel's funkrepeat counter and funkrepeat position to 0.<br />
Otherwise, set that channel's funkrepeat speed to funkrepeat_table[x].<br />
<br />
If a channel is not funkrepeating, then you don't need to do what follows for that channel.<br />
<br />
For every tick, increment the channel's funkrepeat counter by its funkrepeat speed. If the funkrepeat counter reaches 128, then ''reset the counter to 0'', and then:<br />
<br />
sampledata[current_sample][loop_begin_in_bytes + funkrepeat_pos] ^= 0xFF;<br />
funkrepeat_pos = (funkrepeat_pos + 1) % loop_length_in_bytes;<br />
<br />
^ is the XOR operator in C. There's also ~ for a binary NOT, but ~= probably isn't valid C.<br />
<br />
Every time you reach a new sample (?) value, reset that channel's funkrepeat position to 0, and start modifying the new sample (?).<br />
<br />
''(please clarify: does the funkrepeat sample position retrigger on sample, note, either, or both?)''<br />
<br />
''(please clarify: when you hit a lone sample which isn't the current one, does it affect that latched sample or the playing sample?)''<br />
<br />
''(please clarify: there's probably a lot of mistakes in this.)''<br />
<br />
====Fxx====<br />
Set TPR or BPM. If xx is less than $20 (32) or this is an old 15-sample module (?), set TPR to xx, otherwise set BPM to xx.<br />
<br />
''(please clarify: Where is the dividing line between raster timing and CIA timing - that is, when was BPM introduced?)''<br />
<br />
''However,'' if xx is 0, then ignore this effect.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want at least ((base clock * 10) / (smallest period value * 4 * 32)) bytes. To unroll a loopless sample, just pad this number of bytes. To unroll a looped sample, append the loop to the end, then unroll this number of bytes from the loop.<br />
<br />
Once you've done that, you only need to check if you've exceeded (length + loop length) words (or bytes if you've converted it) for a looped sample, or length words for an unlooped sample. For an unlooped sample, you just refuse to mix if the offset is past this point. For a looped sample, you set the offset to this:<br />
<br />
offset = length + (offset - length) % looplength;<br />
<br />
where % is the modulo operator. Most forms of BASIC do not have a modulo operator, so you'll probably have to do this instead:<br />
<br />
tmp = offset - length;<br />
offset = length + tmp - (int(tmp / looplength) * looplength);<br />
<br />
This makes funkrepeat trickier to implement, but it has been proven possible.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12160Protracker Module2010-01-21T08:05:52Z<p>GreaseMonkey: /* 0xy */ "steps" was a bit vague</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was first used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 4 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod so far. This is just a standard MOD, but with a weird tag. ''I ([[User:GreaseMonkey|GreaseMonkey]]) cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
*Pattern data:<br />
**Read 4 bytes for a cell. Read ''channel count'' cells for a row. Read 64 of these rows for a pattern. Read ''pattern count'' of these patterns.<br />
**You read cells as if they were big-endian 32-bit values.<br />
**Cells are in the format $ipppjfxy:<br />
***$ppp is the period value. No, not the note, the period.<br />
***$ij is the sample number.<br />
***$fxy is the effect, $f being the effect type, and $xy being the effect parameter.<br />
*Signed 8-bit mono sample data. Remember those sample lengths? Now is the time to use them.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns. The actual base clock differs. PAL Amigas have a slightly slower clock than NTSC Amigas. This value of 70ns is close to the NTSC clock, but not quite right. Some modules have large samples (known as "megasamples") which require a certain type of Amiga - t_o_t.mod, for instance, requires a PAL Amiga, whereas cd_orbit.mod requires an NTSC Amiga (not sure if this <br />
<br />
There is a number of ticks per row, often just referred to as the speed.<br />
<br />
There is a number of "beats per minute"; however, this is a CIA clock speed (it's an Amiga thing). Often just referred to as the tempo. To convert to actual BPM, multiply by 4 and divide by 10. For clarity, we'll refer to it as BPM, even though it's not entirely correct.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
If a sample is supplied, then the sample is "latched", the channel volume is reset to the sample's default volume, and the starting offset is reset to 0. ProTracker 1.1 (?) will change the sample, too, but other versions do not.<br />
<br />
''(please clarify: which trackers do this?)''<br />
<br />
ImpulseTracker also changes the sample; however, if you're converting MOD to IT yourself and you don't want this, you can put a "note off" with the sample and it will just change the volume (unfortunately, this behaviour does not work correctly with libmodplug or SchismTracker at the moment).<br />
<br />
If a period is supplied, then the note plays from the starting offset of the current latched sample, unless there is a note slide (effect 3xx or 5xy).<br />
<br />
===Effects===<br />
====0xy====<br />
Arpeggio between 0,x,y semitones up, changing every tick, and retriggering every row. Basically, you select by using tick % 3 where % is the modulo operator.<br />
<br />
====1xx====<br />
Slide up. For every nonzero tick, decrement the period by $xx, clamping to 113 (amiga limits).<br />
<br />
====2xx====<br />
Slide down. For every nonzero tick, increment the period by $xx, clamping to 856 (amiga limits).<br />
<br />
====3xx====<br />
Slide to note. For every nonzero tick, move the period $xx closer to the target period.<br />
<br />
If xx is 0, then use previous value for 3xx.<br />
<br />
====4xy====<br />
Vibrato. x is speed, y is depth. You'll need to generate 3 waveforms beforehand, and spew out random numbers for the last choice of waveform. Each waveform other than the last has a full cycle of 64 steps, and the amplitude is somewhere between -y and y after calculating. When precalculating the waveform, an amplitude of 64 should be fine.<br />
<br />
*Waveform 0 is a sine wave. This is the default.<br />
*Waveform 1 is a downwards saw wave.<br />
*Waveform 2 is a square wave, starting from +y.<br />
*Waveform 3 is random. The cycle of this is mostly irrelevant. In saying this, the speed value is irrelevant with this waveform type, too.<br />
<br />
You have a vibrato waveform position. By default, this retriggers for every note (?) you play by being reset to 0. This loops around a cycle of 64 positions.<br />
<br />
''(please clarify: is it per note or per sample, or will either retrigger it?)''<br />
<br />
For each tick, we add y to the output period at the peak amplitude. For a waveform with peak amplitude of 64, for example, we would add (y*waveform[pos]/64). The period is clamped to Amiga limits.<br />
<br />
If xy is 0, then use previous value for 4xy.<br />
<br />
====5xy====<br />
Volume slide + slide to note: Axy and 300 combined.<br />
<br />
====6xy====<br />
Volume slide + vibrato: Axy and 400 combined.<br />
<br />
====7xy====<br />
Tremolo. x is speed, y is depth. Like vibrato, except we modify the output volume. The volume is clamped to 0 <= vol <= 64.<br />
<br />
''(please clarify: is the maximum amplitude ~16, ~32 or ~64?)''<br />
<br />
If xy is 0, then use previous value for 7xy (?).<br />
<br />
''(please clarify: does the memory work for tremolo, or just vibrato?)''<br />
<br />
====8xx====<br />
FastTracker panning extension. $00 is hard left, $FF is hard right.<br />
<br />
''(please clarify: I really don't give a toss about this FastTracker extension, so I'm putting this question out to someone who does. Does this reset after a new note or sample? And probably some other things, too.)''<br />
<br />
====9xx====<br />
Set sample offset to xx * $100. This also sets the sample starting offset. On older versions of ProTracker (PT < 3.15 (?)), the starting offset is doubled.<br />
<br />
''(please clarify: what players perform this quirk?)''<br />
<br />
On most non canonical trackers (those which aren't in the SoundTracker -> ProTracker line, e.g. FastTracker, ScreamTracker 3, ImpulseTracker), this quirk does not occur, and the starting offset is always 0.<br />
<br />
''(please clarify: what happens when you go over the edge?)''<br />
<br />
====Axy====<br />
Volume slide. Happens every nonzero tick. If x is 0, slide down by y. If y is 0, slide up by x. If both are nonzero, do nothing. Clamp to 0 <= vol <= 64.<br />
<br />
Unlike most module formats, this does not have effect memory. If xy is $00, then don't go anywhere.<br />
<br />
====Bxx====<br />
Jump to offset. If you go over the edge, then the module is restarted (?).<br />
<br />
''(please clarify: does it actually restart?)''<br />
<br />
====Cxx====<br />
Set volume. If greater than 64, then... (?)<br />
<br />
''(please clarify: does it clamp the value at 64, or does it ignore the dud volume? My guess is this: it drops the top bit, and does the former. But that's the lazy way.)''<br />
<br />
====Dxy====<br />
Jump to row x*10 + y. '''THE VALUE PROVIDED IS IN DECIMAL!''' This had to be yelled out as it's a common mistake when making a MOD player.<br />
<br />
====E0x====<br />
If x is 1, turn the Amiga filter off. If x is 0, turn it on. This filter is present on the A500, A2000, and A1200.<br />
<br />
For a simple 1-pole low-pass filter, 11500Hz gives a fairly decent estimation.<br />
<br />
====E1x====<br />
Fine slide up. Like 1xx but without effect memory and only on the first tick.<br />
<br />
====E2x====<br />
Fine slide down. Like 2xx but without effect memory and only on the first tick.<br />
<br />
====E3x====<br />
Screw up 3xx.<br />
<br />
''(please clarify: how does this actually work?)''<br />
<br />
====E4x====<br />
Set vibrato waveform. x & 3 (bottom 2 bits) sets the waveform type. If bit 2 is set (x & 4), then don't retrigger the waveform.<br />
<br />
====E5x====<br />
Set finetune value for the current sample.<br />
<br />
''(please clarify: when does this actually kick in?)''<br />
<br />
====E6x====<br />
Loopback.<br />
<br />
If x is 0, then set the loopback point to the current row. The loopback point is reset to -1 for every Bxx or Dxx or pattern transition (?). Looping back with this means that you have to play row 0 twice.<br />
<br />
''(please clarify: is MikMod right?)''<br />
<br />
Otherwise, we check if the loopback counter set. If the loopback counter is set, then decrement it by 1, otherwise set the counter to x.<br />
<br />
After doing this, if the counter is not 0, then we jump back to the loopback point.<br />
<br />
Unlike S3M and IT, the loopback point remains where it is, so an E60/E61/E61 sequence down a column will result in an infinite loop.<br />
<br />
''(please clarify: is this per-channel or global?)''<br />
<br />
====E7x====<br />
Set tremolo waveform, like E4x.<br />
<br />
====E8x====<br />
Another stereo extension. $0 is hard left, $F is hard right.<br />
<br />
''(please clarify: I don't care about this extension, either. It's far from "real Amiga" material. Please see 8xx for the clarifications required.)''<br />
<br />
====E9x====<br />
Retrigger note every x ticks.<br />
<br />
''(please clarify: does this effect retrigger like IT, or is this just a matter of ticks % x ?)''<br />
<br />
====EAx====<br />
Fine volume slide up. For the first tick, increment the volume by x, clamping x to <= 64.<br />
<br />
====EBx====<br />
Fine volume slide down. For the first tick, decrement the volume by x, clamping x to >= 0.<br />
<br />
====ECx====<br />
Note cut. On the xth tick, set the volume to 0.<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EDx====<br />
Note delay. Don't do what's in the cell until the xth tick.<br />
<br />
''(please clarify: is there anything which escapes this check?)''<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EEx====<br />
Row delay. Repeat the row x times, e.g. if x is 3, then do the row 4 times in total.<br />
<br />
====EFx====<br />
Funkrepeat. This is rarely implemented because not everyone knows how to use it and those who do generally think it's "nasty" as it overwrites sample data. Some might say this is incredibly rare; however, it appears to be more common than E3x.<br />
<br />
So, here's a list which can be added to. The bigger this list, the more pressure MOD player authors will get until they finally implement this under-implemented effect.<br />
<br />
=====List of MODs which use EFx=====<br />
*emax-doz.mod<br />
*emax-seq.mod<br />
<br />
In most cases, a MOD which uses EFx is a chiptune.<br />
<br />
In most cases, a MOD which uses EFx ''needs'' it (for epicness purposes mostly).<br />
<br />
Firstly, you'll want this table. This tells you how much to increment the internal counter by, and is in the ProTracker v1.2 source code.<br />
<br />
0,5,6,7,8,10,11,13,16,19,22,26,32,43,64,128<br />
<br />
If x is 0, then reset that channel's funkrepeat counter and funkrepeat position to 0.<br />
Otherwise, set that channel's funkrepeat speed to funkrepeat_table[x].<br />
<br />
If a channel is not funkrepeating, then you don't need to do what follows for that channel.<br />
<br />
For every tick, increment the channel's funkrepeat counter by its funkrepeat speed. If the funkrepeat counter reaches 128, then ''reset the counter to 0'', and then:<br />
<br />
sampledata[current_sample][loop_begin_in_bytes + funkrepeat_pos] ^= 0xFF;<br />
funkrepeat_pos = (funkrepeat_pos + 1) % loop_length_in_bytes;<br />
<br />
^ is the XOR operator in C. There's also ~ for a binary NOT, but ~= probably isn't valid C.<br />
<br />
Every time you reach a new sample (?) value, reset that channel's funkrepeat position to 0, and start modifying the new sample (?).<br />
<br />
''(please clarify: does the funkrepeat sample position retrigger on sample, note, either, or both?)''<br />
<br />
''(please clarify: when you hit a lone sample which isn't the current one, does it affect that latched sample or the playing sample?)''<br />
<br />
''(please clarify: there's probably a lot of mistakes in this.)''<br />
<br />
====Fxx====<br />
Set TPR or BPM. If xx is less than $20 (32) or this is an old 15-sample module (?), set TPR to xx, otherwise set BPM to xx.<br />
<br />
''(please clarify: Where is the dividing line between raster timing and CIA timing - that is, when was BPM introduced?)''<br />
<br />
''However,'' if xx is 0, then ignore this effect.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want at least ((base clock * 10) / (smallest period value * 4 * 32)) bytes. To unroll a loopless sample, just pad this number of bytes. To unroll a looped sample, append the loop to the end, then unroll this number of bytes from the loop.<br />
<br />
Once you've done that, you only need to check if you've exceeded (length + loop length) words (or bytes if you've converted it) for a looped sample, or length words for an unlooped sample. For an unlooped sample, you just refuse to mix if the offset is past this point. For a looped sample, you set the offset to this:<br />
<br />
offset = length + (offset - length) % looplength;<br />
<br />
where % is the modulo operator. Most forms of BASIC do not have a modulo operator, so you'll probably have to do this instead:<br />
<br />
tmp = offset - length;<br />
offset = length + tmp - (int(tmp / looplength) * looplength);<br />
<br />
This makes funkrepeat trickier to implement, but it has been proven possible.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12159Protracker Module2010-01-21T07:34:46Z<p>GreaseMonkey: I think this is all I can do for now.</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was first used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 4 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod so far. This is just a standard MOD, but with a weird tag. ''I ([[User:GreaseMonkey|GreaseMonkey]]) cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
*Pattern data:<br />
**Read 4 bytes for a cell. Read ''channel count'' cells for a row. Read 64 of these rows for a pattern. Read ''pattern count'' of these patterns.<br />
**You read cells as if they were big-endian 32-bit values.<br />
**Cells are in the format $ipppjfxy:<br />
***$ppp is the period value. No, not the note, the period.<br />
***$ij is the sample number.<br />
***$fxy is the effect, $f being the effect type, and $xy being the effect parameter.<br />
*Signed 8-bit mono sample data. Remember those sample lengths? Now is the time to use them.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns. The actual base clock differs. PAL Amigas have a slightly slower clock than NTSC Amigas. This value of 70ns is close to the NTSC clock, but not quite right. Some modules have large samples (known as "megasamples") which require a certain type of Amiga - t_o_t.mod, for instance, requires a PAL Amiga, whereas cd_orbit.mod requires an NTSC Amiga (not sure if this <br />
<br />
There is a number of ticks per row, often just referred to as the speed.<br />
<br />
There is a number of "beats per minute"; however, this is a CIA clock speed (it's an Amiga thing). Often just referred to as the tempo. To convert to actual BPM, multiply by 4 and divide by 10. For clarity, we'll refer to it as BPM, even though it's not entirely correct.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
If a sample is supplied, then the sample is "latched", the channel volume is reset to the sample's default volume, and the starting offset is reset to 0. ProTracker 1.1 (?) will change the sample, too, but other versions do not.<br />
<br />
''(please clarify: which trackers do this?)''<br />
<br />
ImpulseTracker also changes the sample; however, if you're converting MOD to IT yourself and you don't want this, you can put a "note off" with the sample and it will just change the volume (unfortunately, this behaviour does not work correctly with libmodplug or SchismTracker at the moment).<br />
<br />
If a period is supplied, then the note plays from the starting offset of the current latched sample, unless there is a note slide (effect 3xx or 5xy).<br />
<br />
===Effects===<br />
====0xy====<br />
Arpeggio between 0,x,y steps up, changing every tick, and retriggering every row. Basically, you select by using tick % 3 where % is the modulo operator.<br />
<br />
====1xx====<br />
Slide up. For every nonzero tick, decrement the period by $xx, clamping to 113 (amiga limits).<br />
<br />
====2xx====<br />
Slide down. For every nonzero tick, increment the period by $xx, clamping to 856 (amiga limits).<br />
<br />
====3xx====<br />
Slide to note. For every nonzero tick, move the period $xx closer to the target period.<br />
<br />
If xx is 0, then use previous value for 3xx.<br />
<br />
====4xy====<br />
Vibrato. x is speed, y is depth. You'll need to generate 3 waveforms beforehand, and spew out random numbers for the last choice of waveform. Each waveform other than the last has a full cycle of 64 steps, and the amplitude is somewhere between -y and y after calculating. When precalculating the waveform, an amplitude of 64 should be fine.<br />
<br />
*Waveform 0 is a sine wave. This is the default.<br />
*Waveform 1 is a downwards saw wave.<br />
*Waveform 2 is a square wave, starting from +y.<br />
*Waveform 3 is random. The cycle of this is mostly irrelevant. In saying this, the speed value is irrelevant with this waveform type, too.<br />
<br />
You have a vibrato waveform position. By default, this retriggers for every note (?) you play by being reset to 0. This loops around a cycle of 64 positions.<br />
<br />
''(please clarify: is it per note or per sample, or will either retrigger it?)''<br />
<br />
For each tick, we add y to the output period at the peak amplitude. For a waveform with peak amplitude of 64, for example, we would add (y*waveform[pos]/64). The period is clamped to Amiga limits.<br />
<br />
If xy is 0, then use previous value for 4xy.<br />
<br />
====5xy====<br />
Volume slide + slide to note: Axy and 300 combined.<br />
<br />
====6xy====<br />
Volume slide + vibrato: Axy and 400 combined.<br />
<br />
====7xy====<br />
Tremolo. x is speed, y is depth. Like vibrato, except we modify the output volume. The volume is clamped to 0 <= vol <= 64.<br />
<br />
''(please clarify: is the maximum amplitude ~16, ~32 or ~64?)''<br />
<br />
If xy is 0, then use previous value for 7xy (?).<br />
<br />
''(please clarify: does the memory work for tremolo, or just vibrato?)''<br />
<br />
====8xx====<br />
FastTracker panning extension. $00 is hard left, $FF is hard right.<br />
<br />
''(please clarify: I really don't give a toss about this FastTracker extension, so I'm putting this question out to someone who does. Does this reset after a new note or sample? And probably some other things, too.)''<br />
<br />
====9xx====<br />
Set sample offset to xx * $100. This also sets the sample starting offset. On older versions of ProTracker (PT < 3.15 (?)), the starting offset is doubled.<br />
<br />
''(please clarify: what players perform this quirk?)''<br />
<br />
On most non canonical trackers (those which aren't in the SoundTracker -> ProTracker line, e.g. FastTracker, ScreamTracker 3, ImpulseTracker), this quirk does not occur, and the starting offset is always 0.<br />
<br />
''(please clarify: what happens when you go over the edge?)''<br />
<br />
====Axy====<br />
Volume slide. Happens every nonzero tick. If x is 0, slide down by y. If y is 0, slide up by x. If both are nonzero, do nothing. Clamp to 0 <= vol <= 64.<br />
<br />
Unlike most module formats, this does not have effect memory. If xy is $00, then don't go anywhere.<br />
<br />
====Bxx====<br />
Jump to offset. If you go over the edge, then the module is restarted (?).<br />
<br />
''(please clarify: does it actually restart?)''<br />
<br />
====Cxx====<br />
Set volume. If greater than 64, then... (?)<br />
<br />
''(please clarify: does it clamp the value at 64, or does it ignore the dud volume? My guess is this: it drops the top bit, and does the former. But that's the lazy way.)''<br />
<br />
====Dxy====<br />
Jump to row x*10 + y. '''THE VALUE PROVIDED IS IN DECIMAL!''' This had to be yelled out as it's a common mistake when making a MOD player.<br />
<br />
====E0x====<br />
If x is 1, turn the Amiga filter off. If x is 0, turn it on. This filter is present on the A500, A2000, and A1200.<br />
<br />
For a simple 1-pole low-pass filter, 11500Hz gives a fairly decent estimation.<br />
<br />
====E1x====<br />
Fine slide up. Like 1xx but without effect memory and only on the first tick.<br />
<br />
====E2x====<br />
Fine slide down. Like 2xx but without effect memory and only on the first tick.<br />
<br />
====E3x====<br />
Screw up 3xx.<br />
<br />
''(please clarify: how does this actually work?)''<br />
<br />
====E4x====<br />
Set vibrato waveform. x & 3 (bottom 2 bits) sets the waveform type. If bit 2 is set (x & 4), then don't retrigger the waveform.<br />
<br />
====E5x====<br />
Set finetune value for the current sample.<br />
<br />
''(please clarify: when does this actually kick in?)''<br />
<br />
====E6x====<br />
Loopback.<br />
<br />
If x is 0, then set the loopback point to the current row. The loopback point is reset to -1 for every Bxx or Dxx or pattern transition (?). Looping back with this means that you have to play row 0 twice.<br />
<br />
''(please clarify: is MikMod right?)''<br />
<br />
Otherwise, we check if the loopback counter set. If the loopback counter is set, then decrement it by 1, otherwise set the counter to x.<br />
<br />
After doing this, if the counter is not 0, then we jump back to the loopback point.<br />
<br />
Unlike S3M and IT, the loopback point remains where it is, so an E60/E61/E61 sequence down a column will result in an infinite loop.<br />
<br />
''(please clarify: is this per-channel or global?)''<br />
<br />
====E7x====<br />
Set tremolo waveform, like E4x.<br />
<br />
====E8x====<br />
Another stereo extension. $0 is hard left, $F is hard right.<br />
<br />
''(please clarify: I don't care about this extension, either. It's far from "real Amiga" material. Please see 8xx for the clarifications required.)''<br />
<br />
====E9x====<br />
Retrigger note every x ticks.<br />
<br />
''(please clarify: does this effect retrigger like IT, or is this just a matter of ticks % x ?)''<br />
<br />
====EAx====<br />
Fine volume slide up. For the first tick, increment the volume by x, clamping x to <= 64.<br />
<br />
====EBx====<br />
Fine volume slide down. For the first tick, decrement the volume by x, clamping x to >= 0.<br />
<br />
====ECx====<br />
Note cut. On the xth tick, set the volume to 0.<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EDx====<br />
Note delay. Don't do what's in the cell until the xth tick.<br />
<br />
''(please clarify: is there anything which escapes this check?)''<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EEx====<br />
Row delay. Repeat the row x times, e.g. if x is 3, then do the row 4 times in total.<br />
<br />
====EFx====<br />
Funkrepeat. This is rarely implemented because not everyone knows how to use it and those who do generally think it's "nasty" as it overwrites sample data. Some might say this is incredibly rare; however, it appears to be more common than E3x.<br />
<br />
So, here's a list which can be added to. The bigger this list, the more pressure MOD player authors will get until they finally implement this under-implemented effect.<br />
<br />
=====List of MODs which use EFx=====<br />
*emax-doz.mod<br />
*emax-seq.mod<br />
<br />
In most cases, a MOD which uses EFx is a chiptune.<br />
<br />
In most cases, a MOD which uses EFx ''needs'' it (for epicness purposes mostly).<br />
<br />
Firstly, you'll want this table. This tells you how much to increment the internal counter by, and is in the ProTracker v1.2 source code.<br />
<br />
0,5,6,7,8,10,11,13,16,19,22,26,32,43,64,128<br />
<br />
If x is 0, then reset that channel's funkrepeat counter and funkrepeat position to 0.<br />
Otherwise, set that channel's funkrepeat speed to funkrepeat_table[x].<br />
<br />
If a channel is not funkrepeating, then you don't need to do what follows for that channel.<br />
<br />
For every tick, increment the channel's funkrepeat counter by its funkrepeat speed. If the funkrepeat counter reaches 128, then ''reset the counter to 0'', and then:<br />
<br />
sampledata[current_sample][loop_begin_in_bytes + funkrepeat_pos] ^= 0xFF;<br />
funkrepeat_pos = (funkrepeat_pos + 1) % loop_length_in_bytes;<br />
<br />
^ is the XOR operator in C. There's also ~ for a binary NOT, but ~= probably isn't valid C.<br />
<br />
Every time you reach a new sample (?) value, reset that channel's funkrepeat position to 0, and start modifying the new sample (?).<br />
<br />
''(please clarify: does the funkrepeat sample position retrigger on sample, note, either, or both?)''<br />
<br />
''(please clarify: when you hit a lone sample which isn't the current one, does it affect that latched sample or the playing sample?)''<br />
<br />
''(please clarify: there's probably a lot of mistakes in this.)''<br />
<br />
====Fxx====<br />
Set TPR or BPM. If xx is less than $20 (32) or this is an old 15-sample module (?), set TPR to xx, otherwise set BPM to xx.<br />
<br />
''(please clarify: Where is the dividing line between raster timing and CIA timing - that is, when was BPM introduced?)''<br />
<br />
''However,'' if xx is 0, then ignore this effect.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want at least ((base clock * 10) / (smallest period value * 4 * 32)) bytes. To unroll a loopless sample, just pad this number of bytes. To unroll a looped sample, append the loop to the end, then unroll this number of bytes from the loop.<br />
<br />
Once you've done that, you only need to check if you've exceeded (length + loop length) words (or bytes if you've converted it) for a looped sample, or length words for an unlooped sample. For an unlooped sample, you just refuse to mix if the offset is past this point. For a looped sample, you set the offset to this:<br />
<br />
offset = length + (offset - length) % looplength;<br />
<br />
where % is the modulo operator. Most forms of BASIC do not have a modulo operator, so you'll probably have to do this instead:<br />
<br />
tmp = offset - length;<br />
offset = length + tmp - (int(tmp / looplength) * looplength);<br />
<br />
This makes funkrepeat trickier to implement, but it has been proven possible.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12158Protracker Module2010-01-21T07:21:40Z<p>GreaseMonkey: Nearly there.</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 4 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod so far. This is just a standard MOD, but with a weird tag. ''I ([[User:GreaseMonkey|GreaseMonkey]]) cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
*Pattern data:<br />
**Read 4 bytes for a cell. Read ''channel count'' cells for a row. Read 64 of these rows for a pattern. Read ''pattern count'' of these patterns.<br />
**You read cells as if they were big-endian 32-bit values.<br />
**Cells are in the format $ipppjfxy:<br />
***$ppp is the period value. No, not the note, the period.<br />
***$ij is the sample number.<br />
***$fxy is the effect, $f being the effect type, and $xy being the effect parameter.<br />
*Signed 8-bit mono sample data. Remember those sample lengths? Now is the time to use them.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns. The actual base clock differs. PAL Amigas have a slightly slower clock than NTSC Amigas. This value of 70ns is close to the NTSC clock, but not quite right. Some modules have large samples (known as "megasamples") which require a certain type of Amiga - t_o_t.mod, for instance, requires a PAL Amiga, whereas cd_orbit.mod requires an NTSC Amiga (not sure if this <br />
<br />
There is a number of ticks per row, often just referred to as the speed.<br />
<br />
There is a number of "beats per minute"; however, this is a CIA clock speed (it's an Amiga thing). Often just referred to as the tempo. To convert to actual BPM, multiply by 4 and divide by 10. For clarity, we'll refer to it as BPM, even though it's not entirely correct.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
===Effects===<br />
<br />
====0xy====<br />
Arpeggio between 0,x,y steps up, changing every tick, and retriggering every row. Basically, you select by using tick % 3 where % is the modulo operator.<br />
<br />
====1xx====<br />
Slide up. For every nonzero tick, decrement the period by $xx, clamping to 113 (amiga limits).<br />
<br />
====2xx====<br />
Slide down. For every nonzero tick, increment the period by $xx, clamping to 856 (amiga limits).<br />
<br />
====3xx====<br />
Slide to note. For every nonzero tick, move the period $xx closer to the target period.<br />
<br />
If xx is 0, then use previous value for 3xx.<br />
<br />
====4xy====<br />
Vibrato. x is speed, y is depth. You'll need to generate 3 waveforms beforehand, and spew out random numbers for the last choice of waveform. Each waveform other than the last has a full cycle of 64 steps, and the amplitude is somewhere between -y and y after calculating. When precalculating the waveform, an amplitude of 64 should be fine.<br />
<br />
*Waveform 0 is a sine wave. This is the default.<br />
*Waveform 1 is a downwards saw wave.<br />
*Waveform 2 is a square wave, starting from +y.<br />
*Waveform 3 is random. The cycle of this is mostly irrelevant. In saying this, the speed value is irrelevant with this waveform type, too.<br />
<br />
You have a vibrato waveform position. By default, this retriggers for every note (?) you play by being reset to 0. This loops around a cycle of 64 positions.<br />
<br />
''(please clarify: is it per note or per sample, or will either retrigger it?)''<br />
<br />
For each tick, we add y to the output period at the peak amplitude. For a waveform with peak amplitude of 64, for example, we would add (y*waveform[pos]/64). The period is clamped to Amiga limits.<br />
<br />
If xy is 0, then use previous value for 4xy.<br />
<br />
====5xy====<br />
Volume slide + slide to note: Axy and 300 combined.<br />
<br />
====6xy====<br />
Volume slide + vibrato: Axy and 400 combined.<br />
<br />
====7xy====<br />
Tremolo. x is speed, y is depth. Like vibrato, except we modify the output volume. The volume is clamped to 0 <= vol <= 64.<br />
<br />
''(please clarify: is the maximum amplitude ~16, ~32 or ~64?)''<br />
<br />
If xy is 0, then use previous value for 7xy (?).<br />
<br />
''(please clarify: does the memory work for tremolo, or just vibrato?)''<br />
<br />
====8xx====<br />
FastTracker panning extension. $00 is hard left, $FF is hard right.<br />
<br />
''(please clarify: I really don't give a toss about this FastTracker extension, so I'm putting this question out to someone who does. Does this reset after a new note or sample? And probably some other things, too.)''<br />
<br />
====9xx====<br />
Set sample offset to xx * $100.<br />
<br />
''(please clarify: what happens when you go over the edge?)''<br />
<br />
''TODO: note w/o instrument retrigger quirk + PT1/2 offset doubling bug''<br />
<br />
====Axy====<br />
Volume slide. Happens every nonzero tick. If x is 0, slide down by y. If y is 0, slide up by x. If both are nonzero, do nothing. Clamp to 0 <= vol <= 64.<br />
<br />
Unlike most module formats, this does not have effect memory. If xy is $00, then don't go anywhere.<br />
<br />
====Bxx====<br />
Jump to offset. If you go over the edge, then the module is restarted (?).<br />
<br />
''(please clarify: does it actually restart?)''<br />
<br />
====Cxx====<br />
Set volume. If greater than 64, then... (?)<br />
<br />
''(please clarify: does it clamp the value at 64, or does it ignore the dud volume? My guess is this: it drops the top bit, and does the former. But that's the lazy way.)''<br />
<br />
====Dxy====<br />
Jump to row x*10 + y. '''THE VALUE PROVIDED IS IN DECIMAL!''' This had to be yelled out as it's a common mistake when making a MOD player.<br />
<br />
====E0x====<br />
If x is 1, turn the Amiga filter off. If x is 0, turn it on. This filter is present on the A500, A2000, and A1200.<br />
<br />
For a simple 1-pole low-pass filter, 11500Hz gives a fairly decent estimation.<br />
<br />
====E1x====<br />
Fine slide up. Like 1xx but without effect memory and only on the first tick.<br />
<br />
====E2x====<br />
Fine slide down. Like 2xx but without effect memory and only on the first tick.<br />
<br />
====E3x====<br />
Screw up 3xx.<br />
<br />
''(please clarify: how does this actually work?)''<br />
<br />
====E4x====<br />
Set vibrato waveform. x & 3 (bottom 2 bits) sets the waveform type. If bit 2 is set (x & 4), then don't retrigger the waveform.<br />
<br />
====E5x====<br />
Set finetune value for the current sample.<br />
<br />
''(please clarify: when does this actually kick in?)''<br />
<br />
====E6x====<br />
Loopback.<br />
<br />
If x is 0, then set the loopback point to the current row. The loopback point is reset to -1 for every Bxx or Dxx or pattern transition (?). Looping back with this means that you have to play row 0 twice.<br />
<br />
''(please clarify: is MikMod right?)''<br />
<br />
Otherwise, we check if the loopback counter set. If the loopback counter is set, then decrement it by 1, otherwise set the counter to x.<br />
<br />
After doing this, if the counter is not 0, then we jump back to the loopback point.<br />
<br />
Unlike S3M and IT, the loopback point remains where it is, so an E60/E61/E61 sequence down a column will result in an infinite loop.<br />
<br />
''(please clarify: is this per-channel or global?)''<br />
<br />
====E7x====<br />
Set tremolo waveform, like E4x.<br />
<br />
====E8x====<br />
Another stereo extension. $0 is hard left, $F is hard right.<br />
<br />
''(please clarify: I don't care about this extension, either. It's far from "real Amiga" material. Please see 8xx for the clarifications required.)''<br />
<br />
====E9x====<br />
Retrigger note every x ticks.<br />
<br />
''(please clarify: does this effect retrigger like IT, or is this just a matter of ticks % x ?)''<br />
<br />
====EAx====<br />
Fine volume slide up. For the first tick, increment the volume by x, clamping x to <= 64.<br />
<br />
====EBx====<br />
Fine volume slide down. For the first tick, decrement the volume by x, clamping x to >= 0.<br />
<br />
====ECx====<br />
Note cut. On the xth tick, set the volume to 0.<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EDx====<br />
Note delay. Don't do what's in the cell until the xth tick.<br />
<br />
''(please clarify: is there anything which escapes this check?)''<br />
<br />
''(please clarify: what happens when x >= TPR?)''<br />
<br />
''(please clarify: what happens when x == 0?)''<br />
<br />
====EEx====<br />
Row delay. Repeat the row x times, e.g. if x is 3, then do the row 4 times in total.<br />
<br />
====EFx====<br />
Funkrepeat. This is rarely implemented because not everyone knows how to use it and those who do generally think it's "nasty" as it overwrites sample data. Some might say this is incredibly rare; however, it appears to be more common than E3x.<br />
<br />
So, here's a list which can be added to. The bigger this list, the more pressure MOD player authors will get until they finally implement this under-implemented effect.<br />
<br />
=====List of MODs which use EFx=====<br />
*emax-doz.mod<br />
*emax-seq.mod<br />
<br />
In most cases, a MOD which uses EFx is a chiptune.<br />
<br />
In most cases, a MOD which uses EFx ''needs'' it (for epicness purposes mostly).<br />
<br />
Firstly, you'll want this table. This tells you how much to increment the internal counter by, and is in the ProTracker v1.2 source code.<br />
<br />
0,5,6,7,8,10,11,13,16,19,22,26,32,43,64,128<br />
<br />
If x is 0, then reset that channel's funkrepeat counter and funkrepeat position to 0.<br />
Otherwise, set that channel's funkrepeat speed to funkrepeat_table[x].<br />
<br />
If a channel is not funkrepeating, then you don't need to do what follows for that channel.<br />
<br />
For every tick, increment the channel's funkrepeat counter by its funkrepeat speed. If the funkrepeat counter reaches 128, then ''reset the counter to 0'', and then:<br />
<br />
sampledata[current_sample][loop_begin_in_bytes + funkrepeat_pos] ^= 0xFF;<br />
funkrepeat_pos = (funkrepeat_pos + 1) % loop_length_in_bytes;<br />
<br />
^ is the XOR operator in C. There's also ~ for a binary NOT, but ~= probably isn't valid C.<br />
<br />
Every time you reach a new sample (?) value, reset that channel's funkrepeat position to 0, and start modifying the new sample (?).<br />
<br />
''(please clarify: does the funkrepeat sample position retrigger on sample, note, either, or both?)''<br />
<br />
''(please clarify: when you hit a lone sample which isn't the current one, does it affect that latched sample or the playing sample?)''<br />
<br />
''(please clarify: there's probably a lot of mistakes in this.)''<br />
<br />
====Fxx====<br />
Set TPR or BPM. If xx is less than $20 (32) or this is an old 15-sample module (?), set TPR to xx, otherwise set BPM to xx.<br />
<br />
''(please clarify: Where is the dividing line between raster timing and CIA timing - that is, when was BPM introduced?)''<br />
<br />
''However,'' if xx is 0, then ignore this effect.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want at least ((base clock * 10) / (smallest period value * 4 * 32)) bytes. To unroll a loopless sample, just pad this number of bytes. To unroll a looped sample, append the loop to the end, then unroll this number of bytes from the loop.<br />
<br />
Once you've done that, you only need to check if you've exceeded (length + loop length) words (or bytes if you've converted it) for a looped sample, or length words for an unlooped sample. For an unlooped sample, you just refuse to mix if the offset is past this point. For a looped sample, you set the offset to this:<br />
<br />
offset = length + (offset - length) % looplength;<br />
<br />
where % is the modulo operator. Most forms of BASIC do not have a modulo operator, so you'll probably have to do this instead:<br />
<br />
tmp = offset - length;<br />
offset = length + tmp - (int(tmp / looplength) * looplength);<br />
<br />
This makes funkrepeat trickier to implement, but it has been proven possible.<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=Protracker_Module&diff=12157Protracker Module2010-01-21T05:41:25Z<p>GreaseMonkey: still working on this thing, i need some food</p>
<hr />
<div>* Extension: mod<br />
Originally a 15-sample format, it was used in Ultimate SoundTracker for the Amiga. Since then, it has been used in NoiseTracker and ProTracker, which both use the 31-sample "M.K." version, as well as many other programs on many other platforms; for example, FastTracker 2 for MS-DOS on the PC, which can handle even numbers of channels from 4 to 32.<br />
<br />
==File Format==<br />
The format is big-endian (most significant byte first). A "byte" is 8 bits, and a "word" is 16 bits. Hex values will be denoted with a $ sign.<br />
<br />
Amiga limits for periods are 113 <= x <= 856. The lower the period, the higher the pitch.<br />
<br />
*20 bytes: Module name, padded with NULs.<br />
*31 samples (or 15 if we're dealing with a SoundTracker file):<br />
**22 bytes: Sample name, padded with NULs.<br />
**Word: Length of sample in words - multiply by 2 to get length in bytes.<br />
**Byte: Finetune value ranging from $00 to $0F as a signed nybble. $01 is 1/8 of a semitone up, $0F is 1/8 of a semitone down, $08 is 8/8 of a semitone down (that is, a whole semitone). Periods should be clamped to within Amiga limits.<br />
**Byte: Default volume of sample ranging from 0 to 64 ($00 to $40).<br />
**Word: Loop start in words.<br />
**Word: Loop length in words. If set to 1, don't loop. Allegedly, a value of 0 will crash an Amiga.<br />
*Byte: Order list length.<br />
*Byte: Traditionally $78 in SoundTracker. Was used in NoiseTracker as a restart point. ProTracker uses $7F. FastTracker uses it as a restart point, whereas ScreamTracker 3 uses $7F like ProTracker. You can use this to roughly detect which tracker made a MOD, and detection gets more accurate for more obscure MOD types.<br />
*128 bytes: Order list. Only the first ''order list length'' orders are actually used when playing; however, we scan the WHOLE order list to find out what the highest-indexed pattern is, and that's how many patterns we load.<br />
*4 bytes (31-sample version only): Sample tag. If this contains any non-ASCII ($20 to $7E (32 to 126) inclusive) characters, then we probably loaded a 15-sample MOD. The best way to detect this is to seek to this position (it's $438 / 1080) and check before you actually load any data (may not work for streams where you can't seek). Otherwise, it's probably a 31-sample MOD. Values include:<br />
**'''M.K.''' - standard 4-channel, 64-pattern-max MOD.<br />
**'''M!K!''' - ProTracker will write this if there's more than 64 patterns,<br />
**'''6CHN''', '''8CHN''' - 6-channel and 8-channel MODs, respectively. These are common extensions, and many trackers will write these. Basically, you read like a 4 channel mod, but with 6 or 8 channels per row.<br />
**'''CD81''', '''OKTA''', '''OCTA''' - other 8-channel MOD tags. First two are probably Oktalyzer for the Atari ST, the third is possibly OctaMED.<br />
**'''xxCH''' - a 10+ channel MOD, xx being a decimal number. FastTracker will deal with these as long as x is an even number no greater than 32.<br />
**'''xxCN''' - another 10+ channel MOD, xx being a decimal number. Allegedly TakeTracker writes these.<br />
**'''TDZ1''', '''TDZ2''', '''TDZ3''' - allegedly this is a TakeTracker extension for 1, 2, and 3 channels respectively.<br />
**'''5CHN''', '''7CHN''', '''9CHN''' - allegedly this is a TakeTracker extension for 5, 7, and 8 channels respectively.<br />
**'''FLT4''' - StarTrekker 4-channel MOD.<br />
**'''FLT8''' - StarTrekker 8-channel MOD. Load patterns in like a normal 4-channel MOD, and then play two patterns at the same time (e.g. if 8 appears on the order list, play patterns 8 and 9). You'd probably be best to merge the patterns together if you want to be consistent.<br />
**'''M&K!''' - only sighted on echobea3.mod. This is just a standard MOD, but with a weird tag. ''[[User:GreaseMonkey|I]] cannot find the tracker it's referring to ("fleg's module train-er"), so it was probably only used once or something, and never released.''<br />
<br />
''under construction''<br />
<br />
*Signed 8-bit mono sample data.<br />
<br />
==Playback notes==<br />
<br />
Amiga base clock is ''roughly'' 70ns, yielding an audio base clock of 280ns.<br />
<br />
When a looped sample is played, the whole sample plays through once, and then, if it has a loop, the loop is repeated.<br />
<br />
==Optimisation tips==<br />
<br />
'''Try unrolling your sample loops.''' 2500 bytes of padding should be fine if you're operating within Amiga limits; otherwise, you'll want (largest ''frequency''<br />
<br />
''under construction''<br />
<br />
[[Category: Music Pattern Formats]]</div>GreaseMonkeyhttps://wiki.multimedia.cx/index.php?title=User:GreaseMonkey&diff=12156User:GreaseMonkey2010-01-21T05:40:35Z<p>GreaseMonkey: </p>
<hr />
<div>Hi. I'm Ben AKA GreaseMonkey. I do a lot of tracker module stuff and have made players for the big 4 (MOD/S3M/XM/IT), although my attempt at an XM player was a mess. I usually use SchismTracker and can every now and then be caught on IRC telling Storlek what he's done wrong and that he needs to fix it or else.</div>GreaseMonkey