etc
/
furnace
mirror of https://github.com/tildearrow/furnace.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Lots of little cleanup. 

Trying for more consistency and clarity, especially for quick reference.
This commit is contained in:
Electric Keet 2023-06-25 00:05:30 -07:00
parent 7ec6040674
commit 81ab2acb2c
51 changed files with 894 additions and 887 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/2-interface/basic-mode.md
View File

@ -1,6 +1,6 @@
# basic mode
Furnace comes with a "basic mode" that can be toggled through the "settings" menu. it disables certain features in Furnace that may look intimidating or confusing for newcomers. if you find that a certain feature of furnace is missing, see if this setting is enabled or not.
Furnace comes with a "basic mode" that can be toggled through the "settings" menu. it disables certain features in Furnace that may look intimidating or confusing for newcomers. if you find that a certain feature of Furnace is missing, see if this setting is enabled or not.
among the features that cannot be accessed in this mode are:
* file menu:

44
doc/3-pattern/effects.md
View File

@ -12,12 +12,12 @@ However, effects are continuous, which means you only need to type it once and t
- `F8xx`: **Single tick volume slide up.**
- `F9xx`: **Single tick volume slide down.**
- `F3xx`: **Fine volume slide up.** 64× slower than `0Axy`.
- `F4xx`: **Fine volume slide down.** 64x slower than `0Axy`.
- `F4xx`: **Fine volume slide down.** 64× slower than `0Axy`.
- `FAxy`: **Fast volume slide.** 4× faster than `0Axy`.
- If `x` is 0 then this is a slide down.
- If `y` is 0 then this is a slide up.
- `07xy`: **Tremolo.** Changes volume to be "wavy" with a sine LFO. `x` is the speed, while `y` is the depth.
- `07xy`: **Tremolo.** changes volume to be "wavy" with a sine LFO. `x` is the speed, while `y` is the depth.
- Maximum tremolo depth is -60 volume steps.
## pitch
@ -28,15 +28,15 @@ However, effects are continuous, which means you only need to type it once and t
- `F1xx`: **Single tick pitch slide up.**
- `F2xx`: **Single tick pitch slide down.**
- `03xx`: **Portamento.** Slides the current note's pitch to the specified note.
- `03xx`: **Portamento.** slides the current note's pitch to the specified note.
- A note _must_ be present for this effect to work.
- `E1xy`: **Note slide up.** `x` is the speed, while `y` is how many semitones to slide up.
- `E2xy`: **Note slide down.** `x` is the speed, while `y` is how many semitones to slide down.
- `EAxx`: **Toggle legato.** While on, notes instantly change the pitch of the currrently playing sound instead of starting it over.
- `00xy`: **Arpeggio.** After using this effect the channel will rapidly switch between semitone values of `note`, `note + x` and `note + y`.
- `E0xx`: **Set arpeggio speed.** This sets the number of ticks between arpeggio values.
- `EAxx`: **Toggle legato.** while on, notes instantly change the pitch of the currrently playing sound instead of starting it over.
- `00xy`: **Arpeggio.** after using this effect the channel will rapidly switch between semitone values of `note`, `note + x` and `note + y`.
- `E0xx`: **Set arpeggio speed.** this sets the number of ticks between arpeggio values.
- `04xy`: **Vibrato.** Changes pitch to be "wavy" with a sine LFO. `x` is the speed, while `y` is the depth.
- `04xy`: **Vibrato.** changes pitch to be "wavy" with a sine LFO. `x` is the speed, while `y` is the depth.
- Maximum vibrato depth is ±1 semitone.
- `E3xx`: **Set vibrato direction.** `xx` may be one of the following:
- `00`: Up and down.
@ -48,10 +48,10 @@ However, effects are continuous, which means you only need to type it once and t
Not all chips support these effects.
- `08xy`: **Set panning.** Changes stereo volumes independently. `x` is the left channel and `y` is the right one.
- `88xy`: **Set rear panning.** Changes rear channel volumes independently. `x` is the rear left channel and `y` is the rear right one.
- `08xy`: **Set panning.** changes stereo volumes independently. `x` is the left channel and `y` is the right one.
- `88xy`: **Set rear panning.** changes rear channel volumes independently. `x` is the rear left channel and `y` is the rear right one.
- `80xx`: **Set panning (linear).** This effect behaves more like other trackers:
- `80xx`: **Set panning (linear).** this effect behaves more like other trackers:
- `00` is left.
- `80` is center.
- `FF` is right.
@ -62,33 +62,33 @@ Not all chips support these effects.
## time
- `09xx`: **Set speed/groove.** If no grooves are defined, this sets speed. If alternating speeds are active, this sets the first speed.
- `0Fxx`: **Set speed 2.** During alternating speeds or a groove, this sets the second speed.
- `09xx`: **Set speed/groove.** if no grooves are defined, this sets speed. If alternating speeds are active, this sets the first speed.
- `0Fxx`: **Set speed 2.** during alternating speeds or a groove, this sets the second speed.
- `Cxxx`: **Set tick rate.** Changes tick rate to `xxx` Hz (ticks per second).
- `Cxxx`: **Set tick rate.** changes tick rate to `xxx` Hz (ticks per second).
- `xxx` may be from `000` to `3ff`.
- `F0xx`: **Set BPM.** Changes tick rate according to beats per minute.
- `F0xx`: **Set BPM.** changes tick rate according to beats per minute.
- `0Bxx`: **Jump to order.** This can be used to loop a song.
- `0Dxx`: **Jump to next pattern.** This can be used to shorten the current order.
- `FFxx`: **Stop song.** Stops playback and ends the song.
- `0Bxx`: **Jump to order.** this can be used to loop a song.
- `0Dxx`: **Jump to next pattern.** this can be used to shorten the current order.
- `FFxx`: **Stop song.** stops playback and ends the song.
## note
- `0Cxx`: **Retrigger.** Repeats current note every `xx` ticks.
- `0Cxx`: **Retrigger.** repeats current note every `xx` ticks.
- This effect is not continuous; it must be entered on every row.
- `ECxx`: **Note cut.** Ends current note after `xx` ticks. For FM instruments, it's equivalent to a "key off".
- `EDxx`: **Note delay.** Delays note by `x` ticks.
- `ECxx`: **Note cut.** ends current note after `xx` ticks. For FM instruments, it's equivalent to a "key off".
- `EDxx`: **Note delay.** delays note by `x` ticks.
## other
- `9xxx`: **Set sample position.** Jumps current sample to position `xxx \* 0x100`.
- `9xxx`: **Set sample position.** jumps current sample to position `xxx \* 0x100`.
- Not all chips support this effect.
- `EBxx`: **Set sample bank.**
- Does not apply on Amiga.
- `EExx`: **Send external command.**
- This effect is currently incomplete.
- `F5xx`: **Disable macro.** See macro table at the end of this document for possible values.
- `F5xx`: **Disable macro.** see macro table at the end of this document for possible values.
- `F6xx`: **Enable macro.**
Additionally, [each chip has its own effects](../7-systems/README.md).

6
doc/4-instrument/README.md
View File

@ -52,9 +52,9 @@ Each macro has two buttons on the left.
Every macro can be defined though one of three methods, selectable with the leftmost button under the macro type label:
- ![](macro-button-seq.png) **Sequence:** Displayed as a bar graph, this is a sequence of numeric values.
- ![](macro-button-ADSR.png) **ADSR:** This is a traditional ADSR envelope, defined by the rate of increase and decrease of value over time.
- ![](macro-button-LFO.png) **LFO:** The Low Frequency Oscillator generates a repeating wave of values.
- ![](macro-button-seq.png) **Sequence:** displayed as a bar graph, this is a sequence of numeric values.
- ![](macro-button-ADSR.png) **ADSR:** this is a traditional ADSR envelope, defined by the rate of increase and decrease of value over time.
- ![](macro-button-LFO.png) **LFO:** the Low Frequency Oscillator generates a repeating wave of values.
Some macros are "bitmap" style. They represent a number of "bits" that can be toggled individually, and the values listed represent the sum of which bits are turned on.

2
doc/5-wave/README.md
View File

@ -11,7 +11,7 @@ Furnace's wavetable editor features multiple ways of creating desired waveform s
- **Exponent**: Powers the waveform in the mathematical sense of the word (^2, ^3 and so on)
- **XOR Point**: Determines the point where the waveform gets negated.
- _TODO:_ amplitude/phase part
- **FM** For creating the waveform with frequency modulation synthesis principles: One can set carrier/modulation levels, frquency multiplier, connection between operators and FM waveforms of these operators.
- **FM** for creating the waveform with frequency modulation synthesis principles: One can set carrier/modulation levels, frquency multiplier, connection between operators and FM waveforms of these operators.
- **WaveTools**: Allows user to fine-tune the waveform: scale said waveform in both X and Y axes, smoothen, amplify, normalize, convert to signed/unisgned, invert or even randomize the wavetable.
## wavetable synthesizer

8
doc/7-systems/amiga.md
View File

@ -6,10 +6,10 @@ in this very computer music trackers were born...
# effects
- **`10xx`**: toggle low-pass filter. `0` turns it off and `1` turns it on.
- **`11xx`**: toggle amplitude modulation with the next channel.
- `10xx`: **toggle low-pass filter.** `0` turns it off and `1` turns it on.
- `11xx`: **toggle amplitude modulation with the next channel.**
- does not work on the last channel.
- **`12xx`**: toggle period (frequency) modulation with the next channel.
- `12xx`: **toggle period (frequency) modulation with the next channel.**
- does not work on the last channel.
- **`13xx`**: change wave.
- `13xx`: **change wave.**
- only works when "Mode" is set to "Wavetable" in the instrument.

58
doc/7-systems/ay8910.md
View File

@ -8,39 +8,39 @@ the AY-3-8914 variant was used in Intellivision, which is pretty much an AY with
# effects
- **`20xx`**: set channel mode. `xx` may be one of the following:
- `00`: square
- `01`: noise
- `02`: square and noise
- `03`: envelope
- `04`: envelope and square
- `05`: envelope and noise
- `06`: envelope and square and noise
- `07`: nothing
- **`21xx`**: set noise frequency. `xx` is a value between 00 and 1F.
- **`22xy`**: set envelope mode.
- `x` sets the envelope shape, which may be one of the following:
- `0: \___` decay
- `4: /___` attack once
- `8: \\\\` saw
- `9: \___` decay
- `A: \/\/` inverse obelisco
- `B: \¯¯¯` decay once
- `C: ////` inverse saw
- `D: /¯¯¯` attack
- `E: /\/\` obelisco
- `F: /___` attack once
- `20xx`: **set channel mode.**
- `0`: square
- `1`: noise
- `2`: square and noise
- `3`: envelope
- `4`: envelope and square
- `5`: envelope and noise
- `6`: envelope and square and noise
- `7`: nothing
- `21xx`: **set noise frequency.** range is `0` to `1F`.
- `22xy`: **set envelope mode.**
- `x` sets the envelope shape:
- `0`: `\___` decay
- `4`: `/___` attack once
- `8`: `\\\\` saw
- `9`: `\___` decay
- `A`: `\/\/` inverse obelisco
- `B`: `\¯¯¯` decay once
- `C`: `////` inverse saw
- `D`: `/¯¯¯` attack
- `E`: `/\/\` obelisco
- `F`: `/___` attack once
- if `y` is 1 then the envelope will affect this channel.
- **`23xx`**: set envelope period low byte.
- **`24xx`**: set envelope period high byte.
- **`25xx`**: slide envelope period up.
- **`26xx`**: slide envelope period down.
- **`29xy`**: enable auto-envelope mode.
- `23xx`: **set envelope period low byte.**
- `24xx`: **set envelope period high byte.**
- `25xx`: **slide envelope period up.**
- `26xx`: **slide envelope period down.**
- `29xy`: **enable auto-envelope mode.**
- in this mode the envelope period is set to the channel's notes, multiplied by a fraction.
- `x` is the numerator.
- `y` is the denominator.
- if `x` or `y` are 0 this will disable auto-envelope mode.
- **`2Exx`**: write to I/O port A.
- `2Exx`: **write to I/O port A.**
- this changes the port's mode to "write". make sure you have connected something to it.
- **`2Fxx`**: write to I/O port B.
- `2Fxx`: **write to I/O port B.**
- this changes the port's mode to "write". make sure you have connected something to it.

78
doc/7-systems/ay8930.md
View File

@ -3,52 +3,52 @@
a backwards-compatible successor to the AY-3-8910, with increased volume resolution, duty cycle control, three envelopes and highly configurable noise generator.
sadly, this soundchip has only ever observed minimal success, and has remained rather obscure since.
it is best known for being used in the Covox Sound Master, which didn't sell well either. It also observed very minimal success in Merit's CRT-250 machines, but only as a replacement for the AY-3-8910.
it is best known for being used in the Covox Sound Master, which didn't sell well either. it also observed very minimal success in Merit's CRT-250 machines, but only as a replacement for the AY-3-8910.
emulation of this chip in Furnace is now complete thanks to community efforts and hardware testing, which an MSX board called Darky has permitted.
# effects
- **`12xx`**: set channel duty cycle. `xx` is a value between 00 and 08.
- `00`: 3.125%
- `01`: 6.25%
- `02`: 12.5%
- `03`: 25%
- `04`: 50%
- `05`: 75%
- `06`: 87.5%
- `07`: 93.75%
- `08`: 96.875%
- **`20xx`**: set channel mode. `xx` may be one of the following:
- `00`: square
- `01`: noise
- `02`: square and noise
- `03`: envelope
- `04`: envelope and square
- `05`: envelope and noise
- `06`: envelope and square and noise
- `07`: nothing
- **`21xx`**: set noise frequency. `xx` is a value between 00 and FF.
- **`22xy`**: set envelope mode.
- `12xx`: **set channel duty cycle.**
- `0`: 3.125%
- `1`: 6.25%
- `2`: 12.5%
- `3`: 25%
- `4`: 50%
- `5`: 75%
- `6`: 87.5%
- `7`: 93.75%
- `8`: 96.875%
- `20xx`: **set channel mode.** `xx` may be one of the following:
- `0`: square
- `1`: noise
- `2`: square and noise
- `3`: envelope
- `4`: envelope and square
- `5`: envelope and noise
- `6`: envelope and square and noise
- `7`: nothing
- `21xx`: **set noise frequency.** `xx` is a value between `00` and `FF`.
- `22xy`: **set envelope mode.**
- `x` sets the envelope shape, which may be one of the following:
- `0: \___` decay
- `4: /___` attack once
- `8: \\\\` saw
- `9: \___` decay
- `A: \/\/` inverse obelisco
- `B: \¯¯¯` decay once
- `C: ////` inverse saw
- `D: /¯¯¯` attack
- `E: /\/\` obelisco
- `F: /___` attack once
- `0`: `\___` decay
- `4`: `/___` attack once
- `8`: `\\\\` saw
- `9`: `\___` decay
- `A`: `\/\/` inverse obelisco
- `B`: `\¯¯¯` decay once
- `C`: `////` inverse saw
- `D`: `/¯¯¯` attack
- `E`: `/\/\` obelisco
- `F`: `/___` attack once
- if `y` is 1 then the envelope will affect this channel.
- **`23xx`**: set envelope period low byte.
- **`24xx`**: set envelope period high byte.
- **`25xx`**: slide envelope period up.
- **`26xx`**: slide envelope period down.
- **`27xx`**: set noise AND mask.
- **`28xx`**: set noise OR mask.
- **`29xy`**: enable auto-envelope mode.
- `23xx`: **set envelope period low byte.**
- `24xx`: **set envelope period high byte.**
- `25xx`: **slide envelope period up.**
- `26xx`: **slide envelope period down.**
- `27xx`: **set noise AND mask.**
- `28xx`: **set noise OR mask.**
- `29xy`: **enable auto-envelope mode.**
- in this mode the envelope period is set to the channel's notes, multiplied by a fraction.
- `x` is the numerator.
- `y` is the denominator.

4
doc/7-systems/bubblesystem.md
View File

@ -6,8 +6,8 @@ however, the K005289 is just part of the logic used for pitch and wavetable ROM
waveform select and volume control are tied with single AY-3-8910 IO for both channels.
another AY-3-8910 IO is used for reading sound hardware status.
Furnace emulates this configuration as a "chip" with 32x16 wavetables.
Furnace emulates this configuration as a "chip" with 32×16 wavetables.
# effects
- **`10xx`**: change wave.
- `10xx`: **change wave.**

42
doc/7-systems/c64.md
View File

@ -8,7 +8,7 @@ two versions of aforementioned chip exist - 6581 (original chip) and 8580 (impro
# effects
- **`10xx`**: change wave. the following values are accepted:
- `10xx`: **change wave.** the following values are accepted:
- `00`: nothing
- `01`: triangle
- `02`: saw
@ -18,14 +18,14 @@ two versions of aforementioned chip exist - 6581 (original chip) and 8580 (impro
- `06`: pulse and saw
- `07`: pulse and triangle and saw
- `08`: noise
- **`11xx`**: set coarse cutoff. `xx` may be a value between 00 to 64.
- **this effect only exists for compatibility reasons, and its use is discouraged.**
- `11xx`: **set coarse cutoff.** `xx` may be a value between `00` and `64`.
- _this effect only exists for compatibility reasons, and its use is discouraged._
- use effect `4xxx` instead.
- **`12xx`**: set coarse duty cycle. `xx` may be a value between 00 to 64.
- **this effect only exists for compatibility reasons, and its use is discouraged.**
- `12xx`: **set coarse duty cycle.** `xx` may be a value between `00` and `64`.
- _this effect only exists for compatibility reasons, and its use is discouraged._
- use effect `3xxx` instead.
- **`13xx`**: set resonance. `xx` may be a value between 00 and 0F.
- **`14xx`**: set filter mode. the following values are accepted:
- `13xx`: **set resonance.** `xx` may be a value between `00` and `0F`.
- `14xx`: **set filter mode.** the following values are accepted:
- `00`: filter off
- `01`: low pass
- `02`: band pass
@ -34,26 +34,26 @@ two versions of aforementioned chip exist - 6581 (original chip) and 8580 (impro
- `05`: band reject/stop/notch
- `06`: high+band pass
- `07`: all pass
- **`15xx`**: set envelope reset time.
- `15xx`: **set envelope reset time.**
- this is the amount of ticks the channel turns off before a note occurs in order to reset the envelope safely.
- if `xx` is 0 or higher than the song speed, the envelope will not reset.
- **`1Axx`**: disable envelope reset for this channel.
- **`1Bxy`**: reset cutoff:
- `1Axx`: **disable envelope reset for this channel.**
- `1Bxy`: **reset cutoff**:
- if `x` is not 0: on new note
- if `y` is not 0: now
- this effect is not necessary if the instrument's cutoff macro is absolute.
- **`1Cxy`**: reset duty cycle:
- `1Cxy`: **reset duty cycle**:
- if `x` is not 0: on new note
- if `y` is not 0: now
- this effect is not necessary if the instrument's duty macro is absolute.
- **`1Exy`**: change additional parameters.
- `1Exy`: **change additional parameters.**
- `x` may be one of the following:
- `0`: attack (`y` from 0 to F)
- `1`: decay (`y` from 0 to F)
- `2`: sustain (`y` from 0 to F)
- `3`: release (`y` from 0 to F)
- `4`: ring modulation (`y` is 0 or 1)
- `5`: oscillator sync (`y` is 0 or 1)
- `6`: disable channel 3 (`y` is 0 or 1)
- **`3xxx`**: set duty cycle. `xxx` range is 000-FFF
- **`4xxx`**: set cutoff. `xxx` range is 000-7FF.
- `0`: attack (`y` from `0` to `F`)
- `1`: decay (`y` from `0` to `F`)
- `2`: sustain (`y` from `0` to `F`)
- `3`: release (`y` from `0` to `F`)
- `4`: ring modulation (`y` is `0` or `1`)
- `5`: oscillator sync (`y` is `0` or `1`)
- `6`: disable channel 3 (`y` is `0` or `1`)
- `3xxx`: **set duty cycle.** `xxx` range is `000` to `FFF`.
- `4xxx`: **set cutoff.** `xxx` range is `000` to `7FF`.

68
doc/7-systems/es5506.md
View File

@ -1,41 +1,41 @@
# Ensoniq ES5506 (OTTO)
Sample-based synthesis chip used in a bunch of Taito arcade machines and PC sound cards like Soundscape Elite. A variant of it was the heart of the well-known Gravis Ultrasound.
sample-based synthesis chip used in a bunch of Taito arcade machines and PC sound cards like Soundscape Elite. a variant of it was the heart of the well-known Gravis Ultrasound.
it supports a whooping 32 channels of 16-bit PCM and:
it supports a whopping 32 channels of 16-bit PCM and:
- Real time digital filters
- Frequency interpolation
- Loop start and stop positions for each voice (bidirectional and reverse looping)
- Internal volume multiplication and stereo panning
- Hardware support for envelopes
- real time digital filters
- frequency interpolation
- loop start and stop positions for each voice (bidirectional and reverse looping)
- internal volume multiplication and stereo panning
- hardware support for envelopes
# effects
- **`10xx`**: set waveform.
- **`11xx`**: set filter mode (0-3)
- **`120x`**: set pause (bit 0). Pauses the sample until the bit is unset, where it will then resume where it left off.
- **`14xx`**: set filter coefficient K1 low byte.
- **`15xx`**: set filter coefficient K1 high byte.
- **`16xx`**: set filter coefficient K2 low byte.
- **`17xx`**: set filter coefficient K2 high byte.
- **`18xx`**: set filter coefficient K1 slide up.
- **`19xx`**: set filter coefficient K1 slide down.
- **`1Axx`**: set filter coefficient K2 slide up.
- **`1Bxx`**: set filter coefficient K2 slide down.
- **`20xx`**: set envelope count.
- **`22xx`**: set envelope left volume ramp.
- **`23xx`**: set envelope right volume ramp.
- **`24xx`**: set envelope filter coefficient K1 ramp.
- **`25xx`**: set envelope filter coefficient K1 ramp (slower).
- **`26xx`**: set envelope filter coefficient K2 ramp.
- **`27xx`**: set envelope filter coefficient K2 ramp (slower).
- **`3xxx`**: set coarse filter coefficient K1.
- **`4xxx`**: set coarse filter coefficient K2.
- **`81xx`**: set panning (left channel).
- **`82xx`**: set panning (right channel).
- **`88xx`**: set panning (rear channels).
- **`89xx`**: set panning (rear left channel).
- **`8Axx`**: set panning (rear right channel).
- **`9xxx`**: set sample offset (x256).
- **`DFxx`**: set sample playback direction.
- `10xx`: **set waveform.**
- `11xx`: **set filter mode.** values are `0` through `3`.
- `120x`: **set pause (bit 0).** pauses the sample until the bit is unset; it will then resume where it left off.
- `14xx`: **set filter coefficient K1 low byte.**
- `15xx`: **set filter coefficient K1 high byte.**
- `16xx`: **set filter coefficient K2 low byte.**
- `17xx`: **set filter coefficient K2 high byte.**
- `18xx`: **set filter coefficient K1 slide up.**
- `19xx`: **set filter coefficient K1 slide down.**
- `1Axx`: **set filter coefficient K2 slide up.**
- `1Bxx`: **set filter coefficient K2 slide down.**
- `20xx`: **set envelope count.**
- `22xx`: **set envelope left volume ramp.**
- `23xx`: **set envelope right volume ramp.**
- `24xx`: **set envelope filter coefficient K1 ramp.**
- `25xx`: **set envelope filter coefficient K1 ramp (slower).**
- `26xx`: **set envelope filter coefficient K2 ramp.**
- `27xx`: **set envelope filter coefficient K2 ramp (slower).**
- `3xxx`: **set coarse filter coefficient K1.**
- `4xxx`: **set coarse filter coefficient K2.**
- `81xx`: **set panning (left channel).**
- `82xx`: **set panning (right channel).**
- `88xx`: **set panning (rear channels).**
- `89xx`: **set panning (rear left channel).**
- `8Axx`: **set panning (rear right channel).**
- `9xxx`: **set sample offset.** resets sample position to `xxx * 0x100`.
- `DFxx`: **set sample playback direction.**

16
doc/7-systems/fds.md
View File

@ -1,20 +1,20 @@
# Famicom Disk System
the Famicom Disk System is an expansion device for the Famicom (known as NES outside Japan), a popular console from the '80's.
the Famicom Disk System is an expansion device for the Famicom (known as NES outside Japan), a popular console from the '80s.
as it name implies, it allowed people to play games on specialized floppy disks that could be rewritten on vending machines, therefore reducing the cost of ownership and manufacturing.
it also offers an additional 6-bit, 64-byte wavetable sound channel with (somewhat limited) FM capabilities, which is what Furnace supports.
# effects
- **`10xx`**: change wave.
- **`11xx`**: set modulation depth.
- **`12xy`**: set modulation speed high byte and toggle on/off.
- `x` is the toggle. a value of 1 turns on the modulator.
- `10xx`: **change wave.**
- `11xx`: **set modulation depth.**
- `12xy`: **set modulation speed high byte and toggle on/off.**
- `x` is the toggle. a value of `1` turns on the modulator.
- `y` is the speed.
- **`13xx`**: set modulation speed low byte.
- **`14xx`**: set modulator position.
- **`15xx`**: set modulator wave.
- `13xx`: **set modulation speed low byte.**
- `14xx`: **set modulator position.**
- `15xx`: **set modulator wave.**
- `xx` points to a wavetable. it should (preferably) have a height of 7 with the values mapping to:
- 0: +0
- 1: +1

20
doc/7-systems/game-boy.md
View File

@ -6,13 +6,17 @@ with stereo sound, two pulse channels, a wave channel and a noise one it packed
# effects
- **`10xx`**: change wave.
- **`11xx`**: set noise length. `xx` may be one of:
- 0: long
- 1: short
- **`12xx`**: set duty cycle (from 0 to 3).
- **`13xy`**: setup sweep (pulse channels only).
- `10xx`: **change wave.**
- `11xx`: **set noise length.**
- `0`: long
- `1`: short
- `12xx`: **set duty cycle.**
- `0`: 12.5%
- `1`: 25%
- `2`: 50%
- `3`: 75%
- `13xy`: **setup sweep.** pulse channels only.
- `x` is the time.
- `y` is the shift.
- set to 0 to disable it.
- **`14xx`**: set sweep direction. 0 is up and 1 is down.
- set to `0` to disable it.
- `14xx`: **set sweep direction.** `0` is up and `1` is down.

42
doc/7-systems/genesis.md
View File

@ -6,32 +6,32 @@ this console is powered by two sound chips: the [Yamaha YM2612](ym2612.md) and [
# effects
- **`10xy`**: set LFO parameters.
- `10xy`: **set LFO parameters.**
- `x` toggles the LFO.
- `y` sets its speed.
- **`11xx`**: set feedback of channel.
- **`12xx`**: set operator 1 level.
- **`13xx`**: set operator 2 level.
- **`14xx`**: set operator 3 level.
- **`15xx`**: set operator 4 level.
- **`16xy`**: set multiplier of operator.
- `11xx`: **set feedback of channel.**
- `12xx`: **set operator 1 level.**
- `13xx`: **set operator 2 level.**
- `14xx`: **set operator 3 level.**
- `15xx`: **set operator 4 level.**
- `16xy`: **set multiplier of operator.**
- `x` is the operator (1-4).
- `y` is the multiplier.
- **`17xx`**: enable PCM channel.
- `17xx`: **enable PCM channel.**
- this only works on channel 6.
- **this effect is there for compatibility reasons** - it is otherwise recommended to use Sample type instruments (which automatically enable PCM mode when used).
- **`18xx`**: toggle extended channel 3 mode.
- 0 disables it and 1 enables it.
- _this effect is here for compatibility reasons!_ it is otherwise recommended to use Sample type instruments (which automatically enable PCM mode when used).
- `18xx`: **toggle extended channel 3 mode.**
- `0` disables it and `1` enables it.
- only in extended channel 3 chip.
- **`19xx`**: set attack of all operators.
- **`1Axx`**: set attack of operator 1.
- **`1Bxx`**: set attack of operator 2.
- **`1Cxx`**: set attack of operator 3.
- **`1Dxx`**: set attack of operator 4.
- **`20xy`**: set PSG noise mode.
- `19xx`: **set attack of all operators.**
- `1Axx`: **set attack of operator 1.**
- `1Bxx`: **set attack of operator 2.**
- `1Cxx`: **set attack of operator 3.**
- `1Dxx`: **set attack of operator 4.**
- `20xy`: **set PSG noise mode.**
- `x` controls whether to inherit frequency from PSG channel 3.
- 0: use one of 3 preset frequencies (C: A-2; C#: A-3; D: A-4).
- 1: use frequency of PSG channel 3.
- `0`: use one of 3 preset frequencies (C: A-2; C#: A-3; D: A-4).
- `1`: use frequency of PSG channel 3.
- `y` controls whether to select noise or thin pulse.
- 0: thin pulse.
- 1: noise.
- `0`: thin pulse.
- `1`: noise.

6
doc/7-systems/k007232.md
View File

@ -2,10 +2,10 @@
a 2-channel PCM sound chip from Konami which was used in some of their 1986-1990 arcade boards.
Its sample format is unique; the topmost bit is the end marker, and the low 7 bits are used for generating sound (unsigned format).
its sample format is unique; the topmost bit is the end marker, and the low 7 bits are used for generating sound (unsigned format).
It has 7 bit digital output per each channel and no volume register on chip, so it needs external logic to control channel volume.
it has 7 bit digital output per each channel and no volume register on chip, so it needs external logic to control channel volume.
# effects
- Nothing for now
- nothing for now.

3
doc/7-systems/lynx.md
View File

@ -15,6 +15,5 @@ the Atari Lynx has a 6502-based CPU with a sound part (this chip is known as MIK
# effects
- **`3xxx`**: Load LFSR (0 to FFF).
- this is a bitmask.
- `3xxx`: **load LFSR.** this is a bitmask with values ranging from `000` to `FFF`.
- for it to work, duty macro in instrument editor must be set to some value. without it LFSR will not be fed with any bits.

4
doc/7-systems/mmc5.md
View File

@ -8,5 +8,5 @@ additionally, it offers an 8-bit DAC which can be used to play samples. only one
# effects
- **`12xx`**: set duty cycle or noise mode of channel.
- may be 0-3 for the pulse channels.
- `12xx`: **set duty cycle or noise mode of channel.**
- may be `0` through `3` for the pulse channels.

8
doc/7-systems/msm5232.md
View File

@ -16,11 +16,11 @@ Furnace implements this chip in a way that allows the following features:
# effects
- **`10xy`**: set group control.
- `10xy`: **set group control.**
- `x` sets sustain mode.
- `y` is a 4-bit mask which toggles overtones.
- **`11xx`**: set noise mode.
- **`12xx`**: set group attack (0 to 5).
- `11xx`: **set noise mode.**
- `12xx`: **set group attack.** range is `0` to `5`.
- only in internal (capacitor-based) envelope mode.
- **`13xx`**: set group decay (0 to 11).
- `13xx`: **set group decay.** range is `0` to `11`.
- only in internal (capacitor-based) envelope mode.

4
doc/7-systems/msm6295.md
View File

@ -1,7 +1,7 @@
# OKI MSM6295
an upgrade from 6258 - it provides 4 ADPCM channels, at max 32 KHz (still no variable pitch though). between late 80s and late 90s, it was one of the most common, if not THE most common soundchip used in arcade machines (Capcom, Toaplan, Kaneko, Atari, Tecmo, the list can go on and on...)
an upgrade from 6258 - it provides 4 ADPCM channels, at max 32 KHz (still no variable pitch though). between late '80s and late '90s, it was one of the most common, if not _the_ most common soundchip used in arcade machines (Capcom, Toaplan, Kaneko, Atari, Tecmo, the list can go on and on...)
# effects
- **`20xx`**: set chip output rate.
- `20xx`: **set chip output rate.**

37
doc/7-systems/n163.md
View File

@ -13,20 +13,29 @@ Furnace supports loading waveforms into RAM and waveform playback simultaneously
you must load waveform to RAM first for playback, as its load behavior auto-updates when every waveform changes.
both waveform playback and load command work independently per each channel columns.
(Global) commands don't care about the channel columns for work commands and its load behavior is independent with per-channel column load commands.
global commands don't care about the channel columns for work commands and its load behavior is independent with per-channel column load commands.
# effects
- **`10xx`**: set waveform for playback.
- **`11xx`**: set waveform position in RAM for playback (single nibble unit).
- **`12xx`**: set waveform length in RAM for playback (04 to FC, 4 nibble unit).
- **`130x`**: set playback waveform update behavior (0: off, bit 0: update now, bit 1: update when every waveform is changed).
- **`14xx`**: set waveform for load to RAM.
- **`15xx`**: set waveform position for load to RAM (single nibble unit).
- **`16xx`**: set waveform length for load to RAM (04 to FC, 4 nibble unit).
- **`170x`**: set waveform load behavior (0: off, bit 0: load now, bit 1: load when every waveform is changed).
- **`180x`**: set channel limit (0 to 7, x + 1).
- **`20xx`**: (Global) set waveform for load to RAM.
- **`21xx`**: (Global) set waveform position for load to RAM (single nibble unit).
- **`22xx`**: (Global) set waveform length for load to RAM (04 to FC, 4 nibble unit).
- **`230x`**: (Global) set waveform load behavior (0: off, bit 0: load now, bit 1: load when every waveform is changed).
- `10xx`: **set waveform for playback.**
- `11xx`: **set waveform position in RAM for playback.** single nibble unit.
- `12xx`: **set waveform length in RAM for playback.** `04` to `FC`, 4 nibble unit.
- `130x`: **set playback waveform update behavior.**
- `0`: off.
- bit 0: update now.
- bit 1: update when every waveform is changed.
- `14xx`: **set waveform for load to RAM.**
- `15xx`: **set waveform position for load to RAM.** single nibble unit.
- `16xx`: **set waveform length for load to RAM.** `04` to `FC`, 4 nibble unit.
- `170x`: **set waveform load behavior.**
- `0`: off.
- bit 0: load now.
- bit 1: load when every waveform is changed.
- `180x`: **set channel limit.** range is `0` to `7`; 1 is added to get results of 1 through 8.
- `20xx`: **globally set waveform for load to RAM.**
- `21xx`: **globally set waveform position for load to RAM.** single nibble unit.
- `22xx`: **globally set waveform length for load to RAM.** `04` to `FC`, 4 nibble unit.
- `230x`: **globally set waveform load behavior.**
- `0`: off.
- bit 0: load now.
- bit 1: load when every waveform is changed.

4
doc/7-systems/namco.md
View File

@ -6,5 +6,5 @@ everything starts with Namco WSG, which is a simple 3-channel wavetable with no
# effects
- **`10xx`**: change waveform.
- **`11xx`**: toggle noise mode (WARNING: only on C30).
- `10xx`: **change waveform.**
- `11xx`: **toggle noise mode.** _warning:_ only on C30.

43
doc/7-systems/nes.md
View File

@ -6,30 +6,29 @@ also known as Famicom. it is a five-channel sound generator: first two channels
# effects
- **`11xx`**: write to delta modulation counter.
- this may be used to attenuate the triangle and noise channels.
- `11xx`: **write to delta modulation counter.** this may be used to attenuate the triangle and noise channels.
- will not work if a sample is playing.
- **`12xx`**: set duty cycle or noise mode of channel.
- may be 0-3 for the pulse channels and 0-1 for the noise channel.
- **`13xy`**: setup sweep up.
- `12xx`: **set duty cycle or noise mode of channel.**
- may be `0` to `3` for the pulse channels and `0` or `1` for the noise channel.
- `13xy`: **setup sweep up.**
- `x` is the time.
- `y` is the shift.
- set to 0 to disable it.
- **`14xy`**: setup sweep down.
- set to `0` to disable it.
- `14xy`: **setup sweep down.**
- `x` is the time.
- `y` is the shift.
- set to 0 to disable it.
- **`15xx`**: set envelope mode.
- `0`: envelope + length counter (volume represents envelope duration).
- `1`: length counter (volume represents output volume).
- `2`: looping envelope (volume represents envelope duration).
- `3`: constant volume (default; volume represents output volume).
- pulse and noise channels only.
- set to `0` to disable it.
- `15xx`: **set envelope mode.**
- `0`: envelope + length counter. volume represents envelope duration.
- `1`: length counter. volume represents output volume.
- `2`: looping envelope. volume represents envelope duration.
- `3`: constant volume. default value. volume represents output volume.
- Pulse and noise channels only.
- you may need to apply a phase reset (using the macro) to make the envelope effective.
- **`16xx`**: set length counter.
- `16xx`: **set length counter.**
- see table below for possible values.
- this will trigger phase reset.
- **`17xx`**: set frame counter mode.
- `17xx`: **set frame counter mode.**
- `0`: 4-step.
- NTSC: 120Hz sweeps and lengths; 240Hz envelope.
- PAL: 100Hz sweeps and lengths; 200Hz envelope.
@ -38,21 +37,21 @@ also known as Famicom. it is a five-channel sound generator: first two channels
- NTSC: 96Hz sweeps and lengths; 192Hz envelope.
- PAL: 80Hz sweeps and lengths; 160Hz envelope.
- Dendy: 95.1Hz sweeps and lengths; 190.2Hz envelope.
- **`18xx`**: set PCM channel mode.
- `18xx`: **set PCM channel mode.**
- `00`: PCM (software).
- `01`: DPCM (hardware).
- when in DPCM mode, samples will sound muffled (due to its nature), availables pitches are limited and loop point is ignored.
- **`19xx`**: set triangle linear counter.
- when in DPCM mode, samples will sound muffled (due to its nature), availables pitches are limited, and loop point is ignored.
- `19xx`: **set triangle linear counter.**
- `00` to `7F` set the counter.
- `80` and higher halt it.
- **`20xx`**: set DPCM frequency.
- `20xx`: **set DPCM frequency.**
- only works in DPCM mode.
- see table below for possible values.
# DPCM frequency table
val | NTSC | PAL
----|-----------|-----------
----|----------:|----------:
00 | 4181.7Hz | 4177.4Hz
01 | 4709.9Hz | 4696.6Hz
02 | 5264.0Hz | 5261.4Hz
@ -73,7 +72,7 @@ val | NTSC | PAL
# length counter table
val | raw | NTSC | PAL | Dendy | NTSC 5-step | PAL 5-step | Dendy 5-step
----|-----|-------|-------|-------|-------------|------------|--------------
----|----:|------:|------:|------:|------------:|-----------:|-------------:
00 | 10 | 83ms | 100ms | 84ms | 104ms | 125ms | 105ms
01 | 254 | 2.1s | 2.5s | 2.1s | 2.6s | 3.2s | 2.7s
02 | 20 | 166ms | 200ms | 168ms | 208ms | 250ms | 210ms

82
doc/7-systems/opl.md
View File

@ -16,65 +16,65 @@ afterwards everyone moved to Windows and software mixed PCM streaming...
# effects
- 10xx: set AM depth. the following values are accepted:
- 0: 1dB (shallow)
- 1: 4.8dB (deep)
- `10xx`: **set AM depth.** the following values are accepted:
- `0`: 1dB (shallow)
- `1`: 4.8dB (deep)
- this effect applies to all channels.
- **`11xx`**: set feedback of channel.
- **`12xx`**: set operator 1 level.
- **`13xx`**: set operator 2 level.
- **`14xx`**: set operator 3 level.
- `11xx`: **set feedback of channel.**
- `12xx`: **set operator 1 level.**
- `13xx`: **set operator 2 level.**
- `14xx`: **set operator 3 level.**
- only in 4-op mode (OPL3).
- **`15xx`**: set operator 4 level.
- `15xx`: **set operator 4 level.**
- only in 4-op mode (OPL3).
- **`16xy`**: set multiplier of operator.
- `16xy`: **sSet multiplier of operator.**
- `x` is the operator (1-4; last 2 operators only in 4-op mode).
- `y` is the multiplier.
- 17xx: set vibrato depth. the following values are accepted:
- 0: normal
- 1: double
- `17xx`: **set vibrato depth.**
- `0`: normal
- `1`: double
- this effect applies to all channels.
- **`18xx`**: toggle drums mode.
- 0 disables it and 1 enables it.
- `18xx`: **toggle drums mode.**
- `0` disables it and `1` enables it.
- only in drums chip.
- **`19xx`**: set attack of all operators.
- **`1Axx`**: set attack of operator 1.
- **`1Bxx`**: set attack of operator 2.
- **`1Cxx`**: set attack of operator 3.
- `19xx`: **set attack of all operators.**
- `1Axx`: **set attack of operator 1.**
- `1Bxx`: **set attack of operator 2.**
- `1Cxx`: **set attack of operator 3.**
- only in 4-op mode (OPL3).
- **`1Dxx`**: set attack of operator 4.
- `1Dxx`: **set attack of operator 4.**
- only in 4-op mode (OPL3).
- **`2Axy`**: set waveform of operator.
- `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators".
- `2Axy`: **set waveform of operator.**
- `x` is the operator from 1 to 4; the last 2 operators only work in 4-op mode. a value of `0` means "all operators".
- `y` is the value.
- only in OPL2 or higher.
- **`30xx`**: enable envelope hard reset.
- `30xx`: **enable envelope hard reset.**
- this works by inserting a quick release and tiny delay before a new note.
- **`50xy`**: set AM of operator.
- `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators".
- `50xy`: **set AM of operator.**
- `x` is the operator from 1 to 4; the last 2 operators only work in 4-op mode. a value of `0` means "all operators".
- `y` determines whether AM is on.
- **`51xy`**: set SL of operator.
- `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators".
- `51xy`: **set SL of operator.**
- `x` is the operator from 1 to 4; the last 2 operators only work in 4-op mode. a value of `0` means "all operators".
- `y` is the value.
- **`52xy`**: set RR of operator.
- `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators".
- `52xy`: **set RR of operator.**
- `x` is the operator from 1 to 4; the last 2 operators only work in 4-op mode. a value of `0` means "all operators".
- `y` is the value.
- **`53xy`**: set VIB of operator.
- `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators".
- `53xy`: **set VIB of operator.**
- `x` is the operator from 1 to 4; the last 2 operators only work in 4-op mode. a value of `0` means "all operators".
- `y` determines whether VIB is on.
- **`54xy`**: set KSL of operator.
- `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators".
- `54xy`: **set KSL of operator.**
- `x` is the operator from 1 to 4; the last 2 operators only work in 4-op mode. a value of `0` means "all operators".
- `y` is the value.
- **`55xy`**: set SUS of operator.
- `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators".
- `55xy`: **set SUS of operator.**
- `x` is the operator from 1 to 4; the last 2 operators only work in 4-op mode. a value of `0` means "all operators".
- `y` determines whether SUS is on.
- **`56xx`**: set DR of all operators.
- **`57xx`**: set DR of operator 1.
- **`58xx`**: set DR of operator 2.
- **`59xx`**: set DR of operator 3.
- `56xx`: **set DR of all operators.**
- `57xx`: **set DR of operator 1.**
- `58xx`: **set DR of operator 2.**
- `59xx`: **set DR of operator 3.**
- only in 4-op mode (OPL3).
- **`5Axx`**: set DR of operator 4.
- `5Axx`: **set DR of operator 4.**
- only in 4-op mode (OPL3).
- **`5Bxy`**: set KSR of operator.
- `x` is the operator (1-4; last 2 operators only in 4-op mode). a value of 0 means "all operators".
- `5Bxy`: **set KSR of operator.**
- `x` is the operator from 1 to 4; the last 2 operators only work in 4-op mode. a value of `0` means "all operators".
- `y` determines whether KSR is on.

70
doc/7-systems/opll.md
View File

@ -12,56 +12,56 @@ OPLL also spawned a few derivative chips, the best known of these is:
the YM2413 is equipped with the following features:
- 9 channels of 2 operator FM synthesis
- A drum/percussion mode, replacing the last 3 voices with 5 rhythm channels, with drum mode tones hard-defined in the chip itself, like FM instruments. Only pitch might be altered.
- a drum/percussion mode, replacing the last 3 voices with 5 rhythm channels, with drum mode tones hard-defined in the chip itself, like FM instruments. only pitch might be altered.
- Drum mode works like following: FM channel 7 is for Kick Drum, which is a normal FM channel but routed through mxier twice for 2x volume, like all drum sounds. FM channel 8 splits to Snare Drum and Hi-Hat. Snare Drum is the carrier and it works with a special 1 bit noise generator combined with a square wave, all possible by overriding phase-generator with some different synthesis method. Hi-Hat is the modulator and it works with the noise generator and also the special synthesis. CH9 splits to Top-Cymbal and Tom-Tom, Top-Cymbal is the carrier and only has the special synthesis, while Tom-Tom is basically a 1op wave.
- Special syntheis mentioned already is: 5 square waves are gathered from 4x, 64x and 128x the pitch of channel 8 and 16x and 64x the pitch of channel 9 and they go through a process where 2 HH bits OR'd together, then 1 HH and 1 TC bit OR'd, then the two TC bits OR'd together, and those 3 results get XOR'd.
- drum mode works like following: FM channel 7 is for Kick Drum, which is a normal FM channel but routed through mixer twice for 2× volume, like all drum sounds. FM channel 8 splits to Snare, Drum, and Hi-Hat. Snare Drum is the carrier and it works with a special 1 bit noise generator combined with a square wave, all possible by overriding phase-generator with some different synthesis method. Hi-Hat is the modulator and it works with the noise generator and also the special synthesis. CH9 splits to Top-Cymbal and Tom-Tom, Top-Cymbal is the carrier and only has the special synthesis, while Tom-Tom is basically a 1op wave.
- special synthesis mentioned already is: 5 square waves are gathered from 4×, 64× and 128× the pitch of channel 8 and 16× and 64× the pitch of channel 9 and they go through a process where 2 HH bits OR'd together, then 1 HH and 1 TC bit OR'd, then the two TC bits OR'd together, and those 3 results get XOR'd.
- 1 user-definable patch (this patch can be changed throughout the course of the song)
- 15 pre-defined patches which can all be used at the same time
- Support for ADSR on both the modulator and the carrier
- Sine and half-sine based FM synthesis
- support for ADSR on both the modulator and the carrier
- sine and half-sine based FM synthesis
- 9 octave note control
- 4096 different frequencies for channels
- 16 unique volume levels (NOTE: Volume 0 is NOT silent.)
- Modulator and carrier key scaling
- Built-in hardware vibrato support
- 16 unique volume levels (NOTE: volume 0 is NOT silent.)
- modulator and carrier key scaling
- built-in hardware vibrato support
# effects
- **`11xx`**: set feedback of channel.
- **`12xx`**: set operator 1 level.
- **`13xx`**: set operator 2 level.
- **`16xy`**: set multiplier of operator.
- `x` is the operator (1 or 2).
- `11xx`: **set feedback of channel.**
- `12xx`: **set operator 1 level.**
- `13xx`: **set operator 2 level.**
- `16xy`: **set multiplier of operator.**
- `x` is the operator, either 1 or 2.
- `y` is the multiplier.
- **`18xx`**: toggle drums mode.
- 0 disables it and 1 enables it.
- `18xx`: **toggle drums mode.**
- `0` disables it and `1` enables it.
- only in drums chip.
- **`19xx`**: set attack of all operators.
- **`1Axx`**: set attack of operator 1.
- **`1Bxx`**: set attack of operator 2.
- **`50xy`**: set AM of operator.
- `x` is the operator (1-2). a value of 0 means "all operators".
- `19xx`: **set attack of all operators.**
- `1Axx`: **set attack of operator 1.**
- `1Bxx`: **set attack of operator 2.**
- `50xy`: **set AM of operator.**
- `x` is the operator, either 1 or 2. a value of `0` means "all operators".
- `y` determines whether AM is on.
- **`51xy`**: set SL of operator.
- `x` is the operator (1-2). a value of 0 means "all operators".
- `51xy`: **set SL of operator.**
- `x` is the operator, either 1 or 2. a value of `0` means "all operators".
- `y` is the value.
- **`52xy`**: set RR of operator.
- `x` is the operator (1-2). a value of 0 means "all operators".
- `52xy`: **set RR of operator.**
- `x` is the operator, either 1 or 2. a value of `0` means "all operators".
- `y` is the value.
- **`53xy`**: set VIB of operator.
- `x` is the operator (1-2). a value of 0 means "all operators".
- `53xy`: **set VIB of operator.**
- `x` is the operator, either 1 or 2. a value of `0` means "all operators".
- `y` determines whether VIB is on.
- **`54xy`**: set KSL of operator.
- `x` is the operator (1-2). a value of 0 means "all operators".
- `54xy`: **set KSL of operator.**
- `x` is the operator, either 1 or 2. a value of `0` means "all operators".
- `y` is the value.
- **`55xy`**: set EGT of operator.
- `x` is the operator (1-2). a value of 0 means "all operators".
- `55xy`: **set EGT of operator.**
- `x` is the operator, either 1 or 2. a value of `0` means "all operators".
- `y` determines whether EGT is on.
- **`56xx`**: set DR of all operators.
- **`57xx`**: set DR of operator 1.
- **`58xx`**: set DR of operator 2.
- **`5Bxy`**: set KSR of operator.
- `x` is the operator (1-2). a value of 0 means "all operators".
- `56xx`: **set DR of all operators.**
- `57xx`: **set DR of operator 1.**
- `58xx`: **set DR of operator 2.**
- `5Bxy`: **set KSR of operator.**
- `x` is the operator, either 1 or 2. a value of `0` means "all operators".
- `y` determines whether KSR is on.

126
doc/7-systems/opz.md
View File

@ -25,91 +25,91 @@ no plans have been made for TX81Z MIDI passthrough, because:
# effects
- **`10xx`**: set noise frequency of channel 8 operator 4. 00 disables noise while 01 to 20 enables it.
- **`11xx`**: set feedback of channel.
- **`12xx`**: set operator 1 level.
- **`13xx`**: set operator 2 level.
- **`14xx`**: set operator 3 level.
- **`15xx`**: set operator 4 level.
- **`16xy`**: set multiplier of operator.
- `10xx`: **set noise frequency of channel 8 operator 4.** `00` disables noise while `01` to `20` enable it.
- `11xx`: **set feedback of channel.**
- `12xx`: **set operator 1 level.**
- `13xx`: **set operator 2 level.**
- `14xx`: **set operator 3 level.**
- `15xx`: **set operator 4 level.**
- `16xy`: **set multiplier of operator.**
- `x` is the operator (1-4).
- `y` is the multiplier.
- **`17xx`**: set LFO speed.
- **`18xx`**: set LFO waveform. `xx` may be one of the following:
- `17xx`: **set LFO speed.**
- `18xx`: **set LFO waveform.** `xx` may be one of the following:
- `00`: saw
- `01`: square
- `02`: triangle
- `03`: noise
- **`19xx`**: set attack of all operators.
- **`1Axx`**: set attack of operator 1.
- **`1Bxx`**: set attack of operator 2.
- **`1Cxx`**: set attack of operator 3.
- **`1Dxx`**: set attack of operator 4.
- **`1Exx`**: set LFO AM depth.
- **`1Fxx`**: set LFO PM depth.
- **`24xx`**: set LFO 2 speed.
- **`25xx`**: set LFO 2 waveform. `xx` may be one of the following:
- `19xx`: **set attack of all operators.**
- `1Axx`: **set attack of operator 1.**
- `1Bxx`: **set attack of operator 2.**
- `1Cxx`: **set attack of operator 3.**
- `1Dxx`: **set attack of operator 4.**
- `1Exx`: **set LFO AM depth.**
- `1Fxx`: **set LFO PM depth.**
- `24xx`: **set LFO 2 speed.**
- `25xx`: **set LFO 2 waveform.** `xx` may be one of the following:
- `00`: saw
- `01`: square
- `02`: triangle
- `03`: noise
- **`26xx`**: set LFO 2 AM depth.
- **`27xx`**: set LFO 2 PM depth.
- **`28xy`**: set reverb of operator.
- `x` is the operator (1-4). a value of 0 means "all operators".
- `26xx`: **set LFO 2 AM depth.**
- `27xx`: **set LFO 2 PM depth.**
- `28xy`: **set reverb of operator.**
- `x` is the operator (1-4). a value of `0` means "all operators".
- `y` is the value.
- **`2Axy`**: set waveform of operator.
- `x` is the operator (1-4). a value of 0 means "all operators".
- `2Axy`: **set waveform of operator.**
- `x` is the operator (1-4). a value of `0` means "all operators".
- `y` is the value.
- **`2Bxy`**: set EG shift of operator.
- `x` is the operator (1-4). a value of 0 means "all operators".
- `2Bxy`: **set EG shift of operator.**
- `x` is the operator (1-4). a value of `0` means "all operators".
- `y` is the value.
- **`2Cxy`**: set fine multiplier of operator.
- `x` is the operator (1-4). a value of 0 means "all operators".
- `2Cxy`: **set fine multiplier of operator.**
- `x` is the operator (1-4). a value of `0` means "all operators".
- `y` is the value.
- **`2Fxx`**: enable envelope hard reset.
- `2Fxx`: **enable envelope hard reset.**
- this works by inserting a quick release and tiny delay before a new note.
- **`3xyy`**: set fixed frequency of operator 1/2.
- `x` is the block (0-7 for operator 1; 8-F for operator 2).
- `3xyy`: **set fixed frequency of operator 1/2.**
- `x` is the block (`0-7` for operator 1; `8-F` for operator 2).
- `y` is the frequency. fixed frequency mode will be disabled if this is less than 8.
- the actual frequency is: `y*(2^x)`.
- **`4xyy`**: set fixed frequency of operator 3/4.
- `x` is the block (0-7 for operator 3; 8-F for operator 4).
- `4xyy`: **set fixed frequency of operator 3/4.**
- `x` is the block (`0-7` for operator 3; `8-F` for operator 4).
- `y` is the frequency. fixed frequency mode will be disabled if this is less than 8.
- the actual frequency is: `y*(2^x)`.
- **`50xy`**: set AM of operator.
- `x` is the operator (1-4). a value of 0 means "all operators".
- `50xy`: **set AM of operator.**
- `x` is the operator (1-4). a value of `0` means "all operators".
- `y` determines whether AM is on.
- **`51xy`**: set SL of operator.
- `x` is the operator (1-4). a value of 0 means "all operators".
- `51xy`: **set SL of operator.**
- `x` is the operator (1-4). a value of `0` means "all operators".
- `y` is the value.
- **`52xy`**: set RR of operator.
- `x` is the operator (1-4). a value of 0 means "all operators".
- `52xy`: **set RR of operator.**
- `x` is the operator (1-4). a value of `0` means "all operators".
- `y` is the value.
- **`53xy`**: set DT of operator.
- `x` is the operator (1-4). a value of 0 means "all operators".
- `53xy`: **set DT of operator.**
- `x` is the operator (1-4). a value of `0` means "all operators".
- `y` is the value:
- 0: +0
- 1: +1
- 2: +2
- 3: +3
- 4: -0
- 5: -3
- 6: -2
- 7: -1
- **`54xy`**: set RS of operator.
- `x` is the operator (1-4). a value of 0 means "all operators".
- `0`: +0
- `1`: +1
- `2`: +2
- `3`: +3
- `4`: -0
- `5`: -3
- `6`: -2
- `7`: -1
- `54xy`: **set RS of operator.**
- `x` is the operator (1-4). a value of `0` means "all operators".
- `y` is the value.
- **`55xy`**: set DT2 of operator.
- `x` is the operator (1-4). a value of 0 means "all operators".
- `55xy`: **set DT2 of operator.**
- `x` is the operator (1-4). a value of `0` means "all operators".
- `y` is the value.
- **`56xx`**: set DR of all operators.
- **`57xx`**: set DR of operator 1.
- **`58xx`**: set DR of operator 2.
- **`59xx`**: set DR of operator 3.
- **`5Axx`**: set DR of operator 4.
- **`5Bxx`**: set D2R/SR of all operators.
- **`5Cxx`**: set D2R/SR of operator 1.
- **`5Dxx`**: set D2R/SR of operator 2.
- **`5Exx`**: set D2R/SR of operator 3.
- **`5Fxx`**: set D2R/SR of operator 4.
- `56xx`: **set DR of all operators.**
- `57xx`: **set DR of operator 1.**
- `58xx`: **set DR of operator 2.**
- `59xx`: **set DR of operator 3.**
- `5Axx`: **set DR of operator 4.**
- `5Bxx`: **set D2R/SR of all operators.**
- `5Cxx`: **set D2R/SR of operator 1.**
- `5Dxx`: **set D2R/SR of operator 2.**
- `5Exx`: **set D2R/SR of operator 3.**
- `5Fxx`: **set D2R/SR of operator 4.**

16
doc/7-systems/pce.md
View File

@ -1,22 +1,22 @@
# PC Engine/TurboGrafx-16
a console from NEC that, depending on a region:
attempted to enter the fierce battle between Nintendo and Sega, but because its capabilities are a mix of third and fourth generation, it failed to last long. (US and Europe)
was Nintendo's most fearsome rival, completely defeating Sega Mega Drive and defending itself against Super Famicom (Japan)
- attempted to enter the fierce battle between Nintendo and Sega, but because its capabilities are a mix of third and fourth generation, it failed to last long. (US and Europe)
- was Nintendo's most fearsome rival, completely defeating Sega Mega Drive and defending itself against Super Famicom (Japan)
it has 6 wavetable channels and the last two ones also double as noise channels.
furthermore, it has some PCM and LFO!
# effects
- **`10xx`**: change wave.
- **`11xx`**: toggle noise mode. only available in the last two channels.
- **`12xx`**: setup LFO. the following values are accepted:
- `10xx`: **change wave.**
- `11xx`: **toggle noise mode.** only available in the last two channels.
- `12xx`: **setup LFO.** the following values are accepted:
- `00`: LFO disabled.
- `01`: LFO enabled, shift 0.
- `02`: LFO enabled, shift 4.
- `03`: LFO enabled, shift 8.
- when LFO is enabled, channel 2 is muted and its output is passed to channel 1's frequency.
- **`13xx`**: set LFO speed.
- **`17xx`**: toggle PCM mode.
- **this effect is there for compatibility reasons** - it is otherwise recommended to use Sample type instruments (which automatically enable PCM mode when used).
- `13xx`: **set LFO speed.**
- `17xx`: **toggle PCM mode.**
- _this effect is here for compatibility reasons;_ it is otherwise recommended to use Sample type instruments (which automatically enable PCM mode when used).

2
doc/7-systems/pcspkr.md
View File

@ -1,6 +1,6 @@
# PC Speaker
40 years of one square beep - and still going! Single channel, no volume control...
40 years of one square beep – and still going! Single channel, no volume control...
# real output

4
doc/7-systems/pet.md
View File

@ -2,10 +2,10 @@
a computer from 1977 which was leader on US schools back then. subsequently the Apple II took its throne.
maybe no better than a computer terminal, but somebody discovered a way to update the screen at turbo rate - and eventually its sound "chip" (it was nothing more than an 8-bit shift register) was abused as well.
maybe no better than a computer terminal, but somebody discovered a way to update the screen at turbo rate – and eventually its sound "chip" (it was nothing more than an 8-bit shift register) was abused as well.
some of these didn't even have sound...
# effects
- **`10xx`**: set waveform. `xx` is a bitmask.
- `10xx`: **set waveform.** `xx` is a bitmask.

6
doc/7-systems/pokey.md
View File

@ -4,7 +4,7 @@ a sound and input chip developed by Atari for their 8-bit computers (Atari 400,
# effects
- **`10xx`**: set waveform.
- **`10xx`**: set waveform.**
- 0: harsh noise (poly5+17)
- 1: square buzz (poly5)
- 2: weird noise (poly4+5)
@ -13,7 +13,7 @@ a sound and input chip developed by Atari for their 8-bit computers (Atari 400,
- 5: square
- 6: bass (poly4)
- 7: buzz (poly4)
- **`11xx`**: set AUDCTL. `xx` is a bitmask.
- **`11xx`**: set AUDCTL.** `xx` is a bitmask.
- bit 7: 9-bit poly mode. shortens noise.
- bit 6: high channel 1 clock (~1.79MHz on NTSC).
- overrides 15KHz mode.
@ -32,6 +32,6 @@ a sound and input chip developed by Atari for their 8-bit computers (Atari 400,
- filtered output on channel 2 (I suggest you to set channel 4 volume to 0).
- use for PWM effects (not automatic!).
- bit 0: 15KHz mode.
- **`12xx`**: toggle two-tone mode.
- **`12xx`**: toggle two-tone mode.**
- when enabled, channel 2 modulates channel 1. I don't know how, but it does.
- only on ASAP core.

8
doc/7-systems/qsound.md
View File

@ -12,8 +12,8 @@ there are also 3 ADPCM channels. ADPCM samples are fixed to 8012 Hz.
# effects
- **`10xx`**: set echo feedback level.
- `10xx`: **set echo feedback level.**
- this effect will apply to all channels.
- **`11xx`**: set echo level.
- **`12xx`**: toggle QSound algorithm (on by default).
- **`3xxx`**: set the length of the echo delay buffer.
- `11xx`: **set echo level.**
- `12xx`: **toggle QSound algorithm.** on by default.
- `3xxx`: **set echo delay buffer length.**

2
doc/7-systems/ricoh.md
View File

@ -1,6 +1,6 @@
# Ricoh RF5C68
YM2612's sidekick - poor man's SNES DSP. 8-channel PCM sample-based synthesizer used in Sega CD, Fujitsu FM Towns and some of Sega's arcade machines. supports up to 64KB of external PCM data.
YM2612's sidekick – poor man's SNES DSP. 8-channel PCM sample-based synthesizer used in Sega CD, Fujitsu FM Towns and some of Sega's arcade machines. supports up to 64KB of external PCM data.
# effects

8
doc/7-systems/saa1099.md
View File

@ -1,18 +1,18 @@
# Philips SAA1099
this was used by the Game Blaster and SAM Coupé. it's pretty similar to the AY-3-8910, but has stereo sound, twice the channels and two envelopes, both of which are highly flexible. The envelopes work like this:
this was used by the Game Blaster and SAM Coupé. it's pretty similar to the AY-3-8910, but has stereo sound, twice the channels and two envelopes, both of which are highly flexible. the envelopes work like this:
- an instrument with envelope settings is placed on channel 2 or channel 5
- an instrument that is used as an "envelope output" is placed on channel 3 or channel 6 (you may want to disable wave output on the output channel)
# effects
- **`10xy`**: set channel mode.
- `10xy`: **set channel mode.**
- `x` toggles noise.
- `y` toggles square.
- this effect affects either the first 3 or last 3 channels, depending on where it is placed.
- **`11xx`**: set noise frequency.
- `11xx`: **set noise frequency.**
- this effect affects either the first 3 or last 3 channels, depending on where it is placed.
- **`12xx`**: setup envelope. this is a bitmask.
- `12xx`: **setup envelope.** this is a bitmask.
- bit 7 toggles the envelope.
- bit 5 toggles whether to use a fixed frequency or lock to the frequency of channel 2 or 5.
- bit 4 sets the envelope resolution.

2
doc/7-systems/scc.md
View File

@ -8,4 +8,4 @@ the SCC+ fixes this issue though (while being compatible with SCC games).
# effects
- **`10xx`**: change wave.
- `10xx`: **change wave.**

4
doc/7-systems/segapcm.md
View File

@ -12,6 +12,6 @@ Furnace also has a five channel version of this chip, but it only exists for Def
# effects
- **`20xx`**: set PCM frequency.
- `20xx`: **set PCM frequency.**
- `xx` is a 256th fraction of 31250Hz.
- this effect exists for mostly DefleMask compatibility - it is otherwise recommended to use Sample type instruments.
- this effect exists mostly for DefleMask compatibility; it is otherwise recommended to use Sample type instruments.

20
doc/7-systems/sm8521.md
View File

@ -1,23 +1,23 @@
# Sharp SM8521
The SM8521 is the CPU and sound chip of the Game.com, a handheld console released in 1997 as a competitor to the infamous Nintendo Virtual Boy.
the SM8521 is the CPU and sound chip of the Game.com, a handheld console released in 1997 as a competitor to the infamous Nintendo Virtual Boy.
Ultimately, most of the games for the Game.com ended up being failures in the eyes of reviewers, thus giving the Game.com a pretty bad reputation. This was one of the reasons that the Game.com only ended up selling at least 300,000 units. For these reasons and more, the Game.com ended up being discontinued in 2000.
ultimately, most of the games for the Game.com ended up being failures in the eyes of reviewers, thus giving the Game.com a pretty bad reputation. this was one of the reasons that the Game.com only ended up selling at least 300,000 units. for these reasons and more, the Game.com ended up being discontinued in 2000.
However, for its time, it was a pretty competitively priced system. The Gameboy Color was to be released in a year for $79.95, while the Game.com was released for $69.99, and its later model, the Pocket Pro, was released in mid-1999 for $29.99 due to the Game.com's apparent significant decrease in value.
however, for its time, it was a pretty competitively priced system. the Gameboy Color was to be released in a year for $79.95, while the Game.com was released for $69.99, and its later model, the Pocket Pro, was released in mid-1999 for $29.99 due to the Game.com's apparent significant decrease in value.
In fact, most games never used the wavetable/noise mode of the chip. Sonic Jam, for example, uses a sine wave with a software-controlled volume envelope on the DAC channel (see below for more information on the DAC channel).
in fact, most games never used the wavetable/noise mode of the chip. sonic Jam, for example, uses a sine wave with a software-controlled volume envelope on the DAC channel (see below for more information on the DAC channel).
The sound-related features and quirks of the SM8521 are as follows:
the sound-related features and quirks of the SM8521 are as follows:
- 2 4-bit wavetable channels
- a noise channel (which can go up to a very high pitch, creating an almost periodic noise sound)
- 5-bit volume
- A low bit-depth output (which means it distorts a lot).
- It phase resets when you switch waves
- a low bit-depth output (which means it distorts a lot).
- it phase resets when you switch waves
- 12-bit pitch with a wide frequency range
- A software-controlled D/A register that (potentially) requires all other registers to be stopped to play. Due to this, it is currently, it is not implemented in Furnace as of version 0.6pre4.
- a software-controlled D/A register that (potentially) requires all other registers to be stopped to play. due to this, it is currently, it is not implemented in Furnace as of version 0.6pre4.
## effect commands
- **`10xx`**: Set waveform
- `xx` is a value between 0 and 255, that sets the waveform of the channel you place it on.
- `10xx`: **set waveform.**
- `xx` is a value between 0 and 255 that sets the waveform of the channel you place it on.

16
doc/7-systems/sms.md
View File

@ -1,17 +1,15 @@
# TI SN76489 (e.g. Sega Master System)
# TI SN76489 (e.g. sega Master System)
a relatively simple sound chip made by Texas Instruments. a derivative of it is used in Sega's Master System, the predecessor to Genesis.
the original iteration of the SN76489 used in the TI-99/4A computers was clocked at 447 KHz, being able to play as low as 13.670 Hz (A -1). consequently, pitch accuracy for higher notes is compromised.
on the other hand, the chip was clocked at a much higher speed on Master System and Genesis, which makes it rather poor in the bass range.
the original iteration of the SN76489 used in the TI-99/4A computer, the SN94624, could only produce tones as low as 100Hz, and was clocked at 447 KHz. all later versions (such as the one in the Master System and Genesis) had a clock divider but ran on a faster clock... except for the SN76494, which can play notes as low as 13.670 Hz (A -1). consequently, its pitch accuracy for higher notes is compromised.
# effects
- **`20xy`**: set noise mode.
- `20xy`: **set noise mode.**
- `x` controls whether to inherit frequency from channel 3.
- 0: use one of 3 preset frequencies (C: A-2; C#: A-3; D: A-4).
- 1: use frequency of channel 3.
- `0`: use one of 3 preset frequencies (C: A-2; C#: A-3; D: A-4).
- `1`: use frequency of channel 3.
- `y` controls whether to select noise or thin pulse.
- 0: thin pulse.
- 1: noise.
- `0`: thin pulse.
- `1`: noise.

74
doc/7-systems/snes.md
View File

@ -22,60 +22,58 @@ Furnace also allows the SNES to use wavetables (and the wavetable synthesizer) i
# effects
- **`10xx`**: set waveform.
- **`11xx`**: toggle noise mode.
- **`12xx`**: toggle echo on this channel.
- **`13xx`**: toggle pitch modulation.
- **`14xy`**: toggle inverting the left or right channels (x: left, y: right).
- **`15xx`**: set envelope mode.
- `10xx`: **set waveform.**
- `11xx`: **toggle noise mode.**
- `12xx`: **toggle echo on this channel.**
- `13xx`: **toggle pitch modulation.**
- `14xy`: **toggle inverting the left or right channels.** (x: left, y: right).
- `15xx`: **set envelope mode.**
- 0: ADSR.
- 1: gain (direct).
- 2: linear decrement.
- 3: exponential decrement.
- 4: linear increment.
- 5: bent line (inverse log) increment.
- **`16xx`**: set gain (00 to 7F if direct, 00 to 1F otherwise).
- **`18xx`**: enable echo buffer.
- **`19xx`**: set echo delay
- goes from 0 to F.
- **`1Axx`**: set left echo channel volume.
- `16xx`: **set gain.** `00` to `7F` if direct, `00` to `1F` otherwise.
- `18xx`: **enable echo buffer.**
- `19xx`: **set echo delay.** range is `0` to `F`.
- `1Axx`: **set left echo channel volume.**
- this is a signed number.
- 00 to 7F for 0 to 127.
- 80 to FF for -128 to -1.
- `00` to `7F` for 0 to 127.
- `80` to `FF` for -128 to -1.
- setting this to -128 is not recommended as it may cause echo output to overflow and therefore click.
- **`1Bxx`**: set right echo channel volume.
- `1Bxx`: **set right echo channel volume.**
- this is a signed number.
- 00 to 7F for 0 to 127.
- 80 to FF for -128 to -1.
- `00` to `7F` for 0 to 127.
- `80` to `FF` for -128 to -1.
- setting this to -128 is not recommended as it may cause echo output to overflow and therefore click.
- **`1Cxx`**: set echo feedback.
- `1Cxx`: **set echo feedback.**
- this is a signed number.
- 00 to 7F for 0 to 127.
- 80 to FF for -128 to -1.
- `00` to `7F` for 0 to 127.
- `80` to `FF` for -128 to -1.
- setting this to -128 is not recommended as it may cause echo output to overflow and therefore click.
- **`1Dxx`**: set noise generator frequency (00 to 1F).
- **`1Exx`**: set left dry/global volume.
- `1Dxx`: **set noise generator frequency.** range is `00` to `1F`.
- `1Exx`: **set left dry / global volume.**
- this does not affect echo.
- **`1Fxx`**: set right dry/global volume.
- `1Fxx`: **set right dry / global volume.**
- this does not affect echo.
- **`20xx`**: set attack (0 to F).
- `20xx`: **set attack.** range is `0` to `F`.
- only in ADSR envelope mode.
- **`21xx`**: set decay (0 to 7).
- `21xx`: **set decay.** range is `0` to `7`.
- only in ADSR envelope mode.
- **`22xx`**: set sustain (0 to 7).
- `22xx`: **set sustain.** range is `0` to `7`.
- only in ADSR envelope mode.
- **`23xx`**: set release (00 to 1F).
- `23xx`: **set release.** range is `00` to `1F`.
- only in ADSR envelope mode.
- **`30xx`**: set echo filter coefficient 0.
- **`31xx`**: set echo filter coefficient 1.
- **`32xx`**: set echo filter coefficient 2.
- **`33xx`**: set echo filter coefficient 3.
- **`34xx`**: set echo filter coefficient 4.
- **`35xx`**: set echo filter coefficient 5.
- **`36xx`**: set echo filter coefficient 6.
- **`37xx`**: set echo filter coefficient 7.
- `30xx`: **set echo filter coefficient 0.**
- `31xx`: **set echo filter coefficient 1.**
- `32xx`: **set echo filter coefficient 2.**
- `33xx`: **set echo filter coefficient 3.**
- `34xx`: **set echo filter coefficient 4.**
- `35xx`: **set echo filter coefficient 5.**
- `36xx`: **set echo filter coefficient 6.**
- `37xx`: **set echo filter coefficient 7.**
- all of these are signed numbers.
- 00 to 7F for 0 to 127.
- 80 to FF for -128 to -1.
- make sure the sum of these is between -128 or 127.
- failure to comply may result in overflow and therefore clicking.
- `00` to `7F` for 0 to 127.
- `80` to `FF` for -128 to -1.
- _Note:_ Be sure the sum of all coefficients is between -128 and 127. sums outside that may result in overflow and therefore clicking.

56
doc/7-systems/soundunit.md
View File

@ -14,43 +14,43 @@ it has the following capabilities:
# effects
- **`10xx`**: set waveform
- 0: pulse wave
- 1: sawtooth
- 2: sine wave
- 3: triangle wave
- 4: noise
- 5: periodic noise
- 6: XOR sine
- 7: XOR triangle
- **`12xx`**: set pulse width (0 to 7F)
- **`13xx`**: set resonance of filter (0 to FF)
- despite what the internal effects list says (0 to F), you can use a resonance value from 0 to FF (255)
- **`14xx`**: set filter mode and ringmod
- `10xx`: **set waveform.**
- `0`: pulse wave
- `1`: sawtooth
- `2`: sine wave
- `3`: triangle wave
- `4`: noise
- `5`: periodic noise
- `6`: XOR sine
- `7`: XOR triangle
- `12xx`: **set pulse width.** range is `0` to `7F`.
- `13xx`: **set resonance of filter.** range is `0` to `FF`.
- despite what the internal effects list says (`0` to `F`), you can use a resonance value from `0` to `FF` (255).
- `14xx`: **set filter mode and ringmod.**
- bit 0: ring mod
- bit 1: low pass
- bit 2: high pass
- bit 3: band pass
- **`15xx`**: set frequency sweep period low byte
- **`16xx`**: set frequency sweep period high byte
- **`17xx`**: set volume sweep period low byte
- **`18xx`**: set volume sweep period high byte
- **`19xx`**: set cutoff sweep period low byte
- **`1Axx`**: set cutoff sweep period high byte
- **`1Bxx`**: set frequency sweep boundary
- **`1Cxx`**: set volume sweep boundary
- **`1Dxx`**: set cutoff sweep boundary
- **`1Exx`**: set phase reset period low byte
- **`1Fxx`**: set phase reset period high byte
- **`20xx`**: toggle frequency sweep
- `15xx`: **set frequency sweep period low byte.**
- `16xx`: **set frequency sweep period high byte.**
- `17xx`: **set volume sweep period low byte.**
- `18xx`: **set volume sweep period high byte.**
- `19xx`: **set cutoff sweep period low byte.**
- `1Axx`: **set cutoff sweep period high byte.**
- `1Bxx`: **set frequency sweep boundary.**
- `1Cxx`: **set volume sweep boundary.**
- `1Dxx`: **set cutoff sweep boundary.**
- `1Exx`: **set phase reset period low byte.**
- `1Fxx`: **set phase reset period high byte.**
- `20xx`: **toggle frequency sweep.**
- bit 0-6: speed
- bit 7: up direction
- **`21xx`**: toggle volume sweep
- `21xx`: **toggle volume sweep.**
- bit 0-4: speed
- bit 5: up direction
- bit 6: loop
- bit 7: alternate
- **`22xx`**: toggle cutoff sweep
- `22xx`: **toggle cutoff sweep.**
- bit 0-6: speed
- bit 7: up direction
- **`4xxx`**: set cutoff (0 to FFF)
- `4xxx`: **set cutoff.** range is `0` to `FFF`.

6
doc/7-systems/t6w28.md
View File

@ -6,6 +6,6 @@ this chip was used in Neo Geo Pocket.
# effects
- **`20xx`**: set noise mode.
- 0: thin pulse.
- 1: noise.
- `20xx`: **set noise mode.**
- `0`: thin pulse.
- `1`: noise.

34
doc/7-systems/tia.md
View File

@ -9,20 +9,20 @@ Furnace isn't complete without this one...
# effects
- **`10xx`**: select shape. `xx` may be one of:
- 0: nothing
- 1: buzzy
- 2: low buzzy
- 3: flangy
- 4: square
- 5: square
- 6: pure buzzy
- 7: reedy
- 8: noise
- 9: reedy
- 10: pure buzzy
- 11: nothing
- 12: low square
- 13: low square
- 14: low pure buzzy
- 15: low reedy
- `10xx`: **select shape.**
- `0`: nothing
- `1`: buzzy
- `2`: low buzzy
- `3`: flangy
- `4`: square
- `5`: square
- `6`: pure buzzy
- `7`: reedy
- `8`: noise
- `9`: reedy
- `A`: pure buzzy
- `B`: nothing
- `C`: low square
- `D`: low square
- `E`: low pure buzzy
- `F`: low reedy

12
doc/7-systems/vera.md
View File

@ -7,9 +7,9 @@ currently Furnace does not support the PCM channel's stereo mode, though (except
# effects
- **`20xx`**: set waveform. the following values are accepted:
- 0: pulse
- 1: saw
- 2: triangle
- 3: noise
- **`22xx`**: set duty cycle. `xx` may go from 0 to 3F.
- `20xx`: **set waveform.**
- `0`: pulse
- `1`: saw
- `2`: triangle
- `3`: noise
- `22xx`: **set duty cycle.** range is `0` to `3F`.

2
doc/7-systems/vic20.md
View File

@ -15,4 +15,4 @@ these channels are not referred as "square" wave channels since a technique to p
## effect commands
- **`10xx`**: Switch waveform (`xx` from `00` to `0F`)
- `10xx`: **switch waveform.** range is `00` to `0F`.

34
doc/7-systems/virtual-boy.md
View File

@ -10,34 +10,34 @@ additionally, channel 5 offers a modulation/sweep unit. the former is similar to
# effects
- **`10xx`**: set waveform.
- **`11xx`**: set noise length (0 to 7).
- `10xx`: **set waveform.**
- `11xx`: **set noise length.** range is `0` to `7`.
- only in the noise channel.
- **`12xy`**: setup envelope.
- `12xy`: **setup envelope.**
- `x` determines whether envelope is enabled or not.
- 0: disabled
- 1: enabled
- 3: enabled and loop
- yeah, the value 2 isn't useful.
- `0`: disabled
- `1`: enabled
- `3`: enabled and loop
- yeah, the value `2` isn't useful.
- `y` sets the speed and direction.
- 0-7: down
- 8-F: up
- **`13xy`**: setup sweep.
- `0-7`: down
- `8-F`: up
- `13xy`: **setup sweep.**
- `x` sets the speed.
- 0 and 8 are "speed 0" - sweep is ineffective.
- `y` sets the shift (0 to 7).
- 8 and higher will mute the channel.
- `0` and `8` are "speed 0" - sweep is ineffective.
- `y` sets the shift (`0` to `7`).
- `8` and higher will mute the channel.
- only in channel 5.
- **`14xy`**: setup modulation.
- `14xy`: **setup modulation.**
- `x` determines whether it's enabled or not.
- 0: disabled
- 1: enabled
- 3: enabled and loop
- 2 isn't useful here either.
- `y` sets the speed.
- 0 and 8 are "speed 0" - modulation is ineffective.
- `0` and `8` are "speed 0" - modulation is ineffective.
- no, you can't really do Yamaha FM using this.
- only in channel 5.
- **`15xx`**: set modulation wave.
- `xx` points to a wavetable. it should have a height of 255.
- `15xx`: **set modulation wave.**
- `xx` points to a wavetable. range is `0` to `FF`.
- this is an alternative to setting the modulation wave through the instrument.

4
doc/7-systems/vrc6.md
View File

@ -14,5 +14,5 @@ Furnace supports this routine for PCM playback, but it consumes a lot of CPU tim
these effects only are effective in the pulse channels.
- **`12xx`**: set duty cycle (0 to 7).
- **`17xx`**: toggle PCM mode.
- `12xx`: **set duty cycle.** range is `0` to `7`.
- `17xx`: **toggle PCM mode.**

10
doc/7-systems/wonderswan.md
View File

@ -10,12 +10,12 @@ it has 4 wavetable channels. some of them have additional capabilities:
# effects
- **`10xx`**: change wave.
- **`11xx`**: setup noise mode (channel 4 only).
- `10xx`: **change wave**.
- `11xx`: **setup noise mode.** channel 4 only.
- 0: disable.
- 1-8: enable and set tap preset.
- **`12xx`**: setup sweep period (channel 3 only).
- `12xx`: **setup sweep period.** channel 3 only.
- 0: disable.
- 1-32: enable and set period.
- **`13xx`**: setup sweep amount (channel 3 only).
- **`17xx`**: toggle PCM mode (channel 2 only).
- `13xx`: **setup sweep amount.** channel 3 only.
- `17xx`: **toggle PCM mode.** channel 2 only.

50
doc/7-systems/x1-010.md
View File

@ -1,47 +1,47 @@
# Seta/Allumer X1-010
A sound chip designed by Seta, mainly used in their own arcade hardware from the late 80s to the early 2000s.
It has 2 output channels, but there is no known hardware taking advantage of stereo sound capabilities.
Later hardware paired this with external bankswitching logic, but this isn't emulated yet.
a sound chip designed by Seta, mainly used in their own arcade hardware from the late 80s to the early 2000s.
it has 2 output channels, but there is no known hardware taking advantage of stereo sound capabilities.
later hardware paired this with external bankswitching logic, but this isn't emulated yet.
Allumer rebadged it for their own arcade hardware.
It has 16 channels, which can all be switched between PCM sample or wavetable playback mode.
Wavetable playback needs to paired with envelope, similar to AY PSG, but shapes are stored in RAM and as such are user-definable.
it has 16 channels, which can all be switched between PCM sample or wavetable playback mode.
wavetable playback needs to paired with envelope, similar to AY PSG, but shapes are stored in RAM and as such are user-definable.
In Furnace, this chip can be configured for original arcade mono output or stereo output - it simulates early 'incorrect' emulation on some mono hardware, but it is also based on the assumption that each channel is connected to each output.
in Furnace, this chip can be configured for original arcade mono output or stereo output – it simulates early 'incorrect' emulation on some mono hardware, but it is also based on the assumption that each channel is connected to each output.
# Waveform types
# waveform types
This chip supports 2 types of waveforms, needs to be paired to external 8 KB RAM to access these features:
this chip supports 2 types of waveforms, needs to be paired to external 8 KB RAM to access these features:
One is a signed 8 bit mono waveform, operated like other wavetable based sound systems.
These are stored at the lower half of RAM at common case.
one is a signed 8 bit mono waveform, operated like other wavetable based sound systems.
these are stored at the lower half of RAM at common case.
The other one ("Envelope") is a 4 bit stereo waveform, multiplied with the above and calculates final output, each nibble is used for each output channel.
These are stored at the upper half of RAM at common case.
the other one ("Envelope") is a 4 bit stereo waveform, multiplied with the above and calculates final output, each nibble is used for each output channel.
these are stored at the upper half of RAM at common case.
Both waveforms are 128 bytes (fixed size), freely allocated at each half of RAM except the channel register area: each half can store total 32/31 waveforms at once.
In furnace, you can enable the envelope shape split mode. When it is set, its waveform will be split to the left and right halves for each output. Each max size is 128 bytes, total 256 bytes.
both waveforms are 128 bytes (fixed size), freely allocated at each half of RAM except the channel register area: each half can store total 32/31 waveforms at once.
in Furnace, you can enable the envelope shape split mode. when it is set, its waveform will be split to the left and right halves for each output. each max size is 128 bytes, total 256 bytes.
# effects
- **`10xx`**: change wave.
- **`11xx`**: change envelope shape (also wavetable).
- **`17xx`**: toggle PCM mode.
- **`20xx`**: set PCM frequency (1 to FF).
- **`22xx`**: set envelope mode.
- `10xx`: **change wave.**
- `11xx`: **change envelope shape.** also wavetable.
- `17xx`: **toggle PCM mode.**
- `20xx`: **set PCM frequency.** range is `1` to `FF`.
- PCM frequency formula: `step * (clock / 8192)`.
- range is 1.95KHz to 498KHz if the chip clock is 16MHz.
- `22xx`: **set envelope mode.**
- bit 0 sets whether envelope will affect this channel.
- bit 1 toggles the envelope one-shot mode. when it is set, channel is halted after envelope cycle is finished.
- bit 2 toggles the envelope shape split mode. when it is set, envelope shape will be split to left half and right half.
- bit 3/5 sets whether the right/left shape will mirror the original one.
- bit 4/6 sets whether the right/left output will mirror the original one.
- **`23xx`**: set envelope period.
- **`25xx`**: slide envelope period up.
- **`26xx`**: slide envelope period down.
- **`29xy`**: enable auto-envelope mode.
- `23xx`: **set envelope period.**
- `25xx`: **slide envelope period up.**
- `26xx`: **slide envelope period down.**
- `29xy`: **enable auto-envelope mode.**
- in this mode the envelope period is set to the channel's notes, multiplied by a fraction.
- `x` is the numerator.
- `y` is the denominator.
- if `x` or `y` are 0 this will disable auto-envelope mode.
* PCM frequency: 255 step, formula: `step * (Chip clock / 8192)`; 1.95KHz to 498KHz if Chip clock is 16MHz.

84
doc/7-systems/ym2151.md
View File

@ -1,6 +1,6 @@
# Yamaha YM2151
the sound chip powering several arcade boards, the Sharp X1/X68000 and the Commander X16. Eight 4-op FM channels, with overpowered LFO and almost unused noise generator.
the sound chip powering several arcade boards, the Sharp X1/X68000 and the Commander X16. eight 4-op FM channels, with overpowered LFO and almost unused noise generator.
it also was present on several pinball machines and synthesizers of the era, and later surpassed by the YM2414 (OPZ) present in the world-famous TX81Z.
@ -8,63 +8,63 @@ in most arcade boards the chip was used in combination with a PCM chip, like [Se
# effects
- **`10xx`**: set noise frequency of channel 8 operator 4. 00 disables noise while 01 to 20 enables it.
- **`11xx`**: set feedback of channel.
- **`12xx`**: set operator 1 level.
- **`13xx`**: set operator 2 level.
- **`14xx`**: set operator 3 level.
- **`15xx`**: set operator 4 level.
- **`16xy`**: set multiplier of operator.
- `10xx`: **set noise frequency of channel 8 operator 4.** `00` disables noise while `01` to `20` enables it.
- `11xx`: **set feedback of channel.**
- `12xx`: **set operator 1 level.**
- `13xx`: **set operator 2 level.**
- `14xx`: **set operator 3 level.**
- `15xx`: **set operator 4 level.**
- `16xy`: **set multiplier of operator.**
- `x` is the operator (1-4).
- `y` is the multiplier.
- **`17xx`**: set LFO speed.
- **`18xx`**: set LFO waveform. `xx` may be one of the following:
- `17xx`: **set LFO speed.**
- `18xx`: **set LFO waveform.**
- `00`: saw
- `01`: square
- `02`: triangle
- `03`: noise
- **`19xx`**: set attack of all operators.
- **`1Axx`**: set attack of operator 1.
- **`1Bxx`**: set attack of operator 2.
- **`1Cxx`**: set attack of operator 3.
- **`1Dxx`**: set attack of operator 4.
- **`1Exx`**: set LFO AM depth.
- **`1Fxx`**: set LFO PM depth.
- **`30xx`**: enable envelope hard reset.
- `19xx`: **set attack of all operators.**
- `1Axx`: **set attack of operator 1.**
- `1Bxx`: **set attack of operator 2.**
- `1Cxx`: **set attack of operator 3.**
- `1Dxx`: **set attack of operator 4.**
- `1Exx`: **set LFO AM depth.**
- `1Fxx`: **set LFO PM depth.**
- `30xx`: **enable envelope hard reset.**
- this works by inserting a quick release and tiny delay before a new note.
- **`50xy`**: set AM of operator.
- `50xy`: **set AM of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` determines whether AM is on.
- **`51xy`**: set SL of operator.
- `51xy`: **set SL of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`52xy`**: set RR of operator.
- `52xy`: **set RR of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`53xy`**: set DT of operator.
- `53xy`: **set DT of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value:
- 0: +0
- 1: +1
- 2: +2
- 3: +3
- 4: -0
- 5: -3
- 6: -2
- 7: -1
- **`54xy`**: set RS of operator.
- `0`: +0
- `1`: +1
- `2`: +2
- `3`: +3
- `4`: -0
- `5`: -3
- `6`: -2
- `7`: -1
- `54xy`: **set RS of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`55xy`**: set DT2 of operator.
- `55xy`: **set DT2 of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`56xx`**: set DR of all operators.
- **`57xx`**: set DR of operator 1.
- **`58xx`**: set DR of operator 2.
- **`59xx`**: set DR of operator 3.
- **`5Axx`**: set DR of operator 4.
- **`5Bxx`**: set D2R/SR of all operators.
- **`5Cxx`**: set D2R/SR of operator 1.
- **`5Dxx`**: set D2R/SR of operator 2.
- **`5Exx`**: set D2R/SR of operator 3.
- **`5Fxx`**: set D2R/SR of operator 4.
- `56xx`: **set DR of all operators.**
- `57xx`: **set DR of operator 1.**
- `58xx`: **set DR of operator 2.**
- `59xx`: **set DR of operator 3.**
- `5Axx`: **set DR of operator 4.**
- `5Bxx`: **set D2R/SR of all operators.**
- `5Cxx`: **set D2R/SR of operator 1.**
- `5Dxx`: **set D2R/SR of operator 2.**
- `5Exx`: **set D2R/SR of operator 3.**
- `5Fxx`: **set D2R/SR of operator 4.**

130
doc/7-systems/ym2203.md
View File

@ -11,91 +11,91 @@ several variants of this chip were released as well, with more features.
# effects
- **`11xx`**: set feedback of channel.
- **`12xx`**: set operator 1 level.
- **`13xx`**: set operator 2 level.
- **`14xx`**: set operator 3 level.
- **`15xx`**: set operator 4 level.
- **`16xy`**: set multiplier of operator.
- `x` is the operator (1-4).
- `11xx`: **set feedback of channel.**
- `12xx`: **set operator 1 level.**
- `13xx`: **set operator 2 level.**
- `14xx`: **set operator 3 level.**
- `15xx`: **set operator 4 level.**
- `16xy`: **set multiplier of operator.**
- `x` is the operator from 1 to 4.
- `y` is the multiplier.
- **`18xx`**: toggle extended channel 3 mode.
- 0 disables it and 1 enables it.
- `18xx`: **toggle extended channel 3 mode.**
- `0` disables it and `1` enables it.
- only in extended channel 3 chip.
- **`19xx`**: set attack of all operators.
- **`1Axx`**: set attack of operator 1.
- **`1Bxx`**: set attack of operator 2.
- **`1Cxx`**: set attack of operator 3.
- **`1Dxx`**: set attack of operator 4.
- **`20xx`**: set SSG channel mode. `xx` may be one of the following:
- `00`: square
- `01`: noise
- `02`: square and noise
- `03`: nothing (apparently)
- `04`: envelope and square
- `05`: envelope and noise
- `06`: envelope and square and noise
- `07`: nothing
- **`21xx`**: set noise frequency. `xx` is a value between 00 and 1F.
- **`22xy`**: set envelope mode.
- `19xx`: **set attack of all operators.**
- `1Axx`: **set attack of operator 1.**
- `1Bxx`: **set attack of operator 2.**
- `1Cxx`: **set attack of operator 3.**
- `1Dxx`: **set attack of operator 4.**
- `20xx`: **set SSG channel mode.** `xx` may be one of the following:
- `0`: square
- `1`: noise
- `2`: square and noise
- `3`: nothing (apparently)
- `4`: envelope and square
- `5`: envelope and noise
- `6`: envelope and square and noise
- `7`: nothing
- `21xx`: **set noise frequency.** `xx` is a value between 00 and 1F.
- `22xy`: **set envelope mode.**
- `x` sets the envelope shape, which may be one of the following:
- `0: \___` decay
- `4: /___` attack once
- `8: \\\\` saw
- `9: \___` decay
- `A: \/\/` inverse obelisco
- `B: \¯¯¯` decay once
- `C: ////` inverse saw
- `D: /¯¯¯` attack
- `E: /\/\` obelisco
- `F: /___` attack once
- `0`: `\___` decay
- `4`: `/___` attack once
- `8`: `\\\\` saw
- `9`: `\___` decay
- `A`: `\/\/` inverse obelisco
- `B`: `\¯¯¯` decay once
- `C`: `////` inverse saw
- `D`: `/¯¯¯` attack
- `E`: `/\/\` obelisco
- `F`: `/___` attack once
- if `y` is 1 then the envelope will affect this channel.
- **`23xx`**: set envelope period low byte.
- **`24xx`**: set envelope period high byte.
- **`25xx`**: slide envelope period up.
- **`26xx`**: slide envelope period down.
- **`29xy`**: enable SSG auto-envelope mode.
- `23xx`: **set envelope period low byte.**
- `24xx`: **set envelope period high byte.**
- `25xx`: **slide envelope period up.**
- `26xx`: **slide envelope period down.**
- `29xy`: **enable SSG auto-envelope mode.**
- in this mode the envelope period is set to the channel's notes, multiplied by a fraction.
- `x` is the numerator.
- `y` is the denominator.
- if `x` or `y` are 0 this will disable auto-envelope mode.
- **`30xx`**: enable envelope hard reset.
- `30xx`: **enable envelope hard reset.**
- this works by inserting a quick release and tiny delay before a new note.
- **`50xy`**: set AM of operator.
- `50xy`: **set AM of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` determines whether AM is on.
- **`51xy`**: set SL of operator.
- `51xy`: **set SL of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`52xy`**: set RR of operator.
- `52xy`: **set RR of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`53xy`**: set DT of operator.
- `53xy`: **set DT of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value:
- 0: +0
- 1: +1
- 2: +2
- 3: +3
- 4: -0
- 5: -3
- 6: -2
- 7: -1
- **`54xy`**: set RS of operator.
- `0`: +0
- `1`: +1
- `2`: +2
- `3`: +3
- `4`: -0
- `5`: -3
- `6`: -2
- `7`: -1
- `54xy`: **set RS of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`55xy`**: set SSG-EG of operator.
- `55xy`: **set SSG-EG of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value (0-8).
- values between 0 and 7 set SSG-EG.
- value 8 disables it.
- **`56xx`**: set DR of all operators.
- **`57xx`**: set DR of operator 1.
- **`58xx`**: set DR of operator 2.
- **`59xx`**: set DR of operator 3.
- **`5Axx`**: set DR of operator 4.
- **`5Bxx`**: set D2R/SR of all operators.
- **`5Cxx`**: set D2R/SR of operator 1.
- **`5Dxx`**: set D2R/SR of operator 2.
- **`5Exx`**: set D2R/SR of operator 3.
- **`5Fxx`**: set D2R/SR of operator 4.
- `56xx`: **set DR of all operators.**
- `57xx`: **set DR of operator 1.**
- `58xx`: **set DR of operator 2.**
- `59xx`: **set DR of operator 3.**
- `5Axx`: **set DR of operator 4.**
- `5Bxx`: **set D2R/SR of all operators.**
- `5Cxx`: **set D2R/SR of operator 1.**
- `5Dxx`: **set D2R/SR of operator 2.**
- `5Exx`: **set D2R/SR of operator 3.**
- `5Fxx`: **set D2R/SR of operator 4.**

114
doc/7-systems/ym2608.md
View File

@ -8,26 +8,26 @@ the YM2610 (OPNB) and YM2610B chips are very similar to this one, but the built-
# effects
- **`10xy`**: set LFO parameters.
- `10xy`: **set LFO parameters.**
- `x` toggles the LFO.
- `y` sets its speed.
- **`11xx`**: set feedback of channel.
- **`12xx`**: set operator 1 level.
- **`13xx`**: set operator 2 level.
- **`14xx`**: set operator 3 level.
- **`15xx`**: set operator 4 level.
- **`16xy`**: set multiplier of operator.
- `11xx`: **set feedback of channel.**
- `12xx`: **set operator 1 level.**
- `13xx`: **set operator 2 level.**
- `14xx`: **set operator 3 level.**
- `15xx`: **set operator 4 level.**
- `16xy`: **set multiplier of operator.**
- `x` is the operator (1-4).
- `y` is the multiplier.
- **`18xx`**: toggle extended channel 3 mode.
- 0 disables it and 1 enables it.
- `18xx`: **toggle extended channel 3 mode.**
- `0` disables it and `1` enables it.
- only in extended channel 3 chip.
- **`19xx`**: set attack of all operators.
- **`1Axx`**: set attack of operator 1.
- **`1Bxx`**: set attack of operator 2.
- **`1Cxx`**: set attack of operator 3.
- **`1Dxx`**: set attack of operator 4.
- **`20xx`**: set SSG channel mode. `xx` may be one of the following:
- `19xx`: **set attack of all operators.**
- `1Axx`: **set attack of operator 1.**
- `1Bxx`: **set attack of operator 2.**
- `1Cxx`: **set attack of operator 3.**
- `1Dxx`: **set attack of operator 4.**
- `20xx`: **set SSG channel mode.**
- `00`: square
- `01`: noise
- `02`: square and noise
@ -36,66 +36,66 @@ the YM2610 (OPNB) and YM2610B chips are very similar to this one, but the built-
- `05`: envelope and noise
- `06`: envelope and square and noise
- `07`: nothing
- **`21xx`**: set noise frequency. `xx` is a value between 00 and 1F.
- **`22xy`**: set envelope mode.
- `21xx`: **set noise frequency.** range is `0` to `1F`.
- `22xy`: **set envelope mode.**
- `x` sets the envelope shape, which may be one of the following:
- `0: \___` decay
- `4: /___` attack once
- `8: \\\\` saw
- `9: \___` decay
- `A: \/\/` inverse obelisco
- `B: \¯¯¯` decay once
- `C: ////` inverse saw
- `D: /¯¯¯` attack
- `E: /\/\` obelisco
- `F: /___` attack once
- `0`: `\___` decay
- `4`: `/___` attack once
- `8`: `\\\\` saw
- `9`: `\___` decay
- `A`: `\/\/` inverse obelisco
- `B`: `\¯¯¯` decay once
- `C`: `////` inverse saw
- `D`: `/¯¯¯` attack
- `E`: `/\/\` obelisco
- `F`: `/___` attack once
- if `y` is 1 then the envelope will affect this channel.
- **`23xx`**: set envelope period low byte.
- **`24xx`**: set envelope period high byte.
- **`25xx`**: slide envelope period up.
- **`26xx`**: slide envelope period down.
- **`29xy`**: enable SSG auto-envelope mode.
- `23xx`: **set envelope period low byte.**
- `24xx`: **set envelope period high byte.**
- `25xx`: **slide envelope period up.**
- `26xx`: **slide envelope period down.**
- `29xy`: **enable SSG auto-envelope mode.**
- in this mode the envelope period is set to the channel's notes, multiplied by a fraction.
- `x` is the numerator.
- `y` is the denominator.
- if `x` or `y` are 0 this will disable auto-envelope mode.
- **`30xx`**: enable envelope hard reset.
- `30xx`: **enable envelope hard reset.**
- this works by inserting a quick release and tiny delay before a new note.
- **`50xy`**: set AM of operator.
- `50xy`: **set AM of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` determines whether AM is on.
- **`51xy`**: set SL of operator.
- `51xy`: **set SL of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`52xy`**: set RR of operator.
- `52xy`: **set RR of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`53xy`**: set DT of operator.
- `53xy`: **set DT of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value:
- 0: +0
- 1: +1
- 2: +2
- 3: +3
- 4: -0
- 5: -3
- 6: -2
- 7: -1
- **`54xy`**: set RS of operator.
- `0`: +0
- `1`: +1
- `2`: +2
- `3`: +3
- `4`: -0
- `5`: -3
- `6`: -2
- `7`: -1
- `54xy`: **set RS of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`55xy`**: set SSG-EG of operator.
- `55xy`: **set SSG-EG of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value (0-8).
- values between 0 and 7 set SSG-EG.
- value 8 disables it.
- **`56xx`**: set DR of all operators.
- **`57xx`**: set DR of operator 1.
- **`58xx`**: set DR of operator 2.
- **`59xx`**: set DR of operator 3.
- **`5Axx`**: set DR of operator 4.
- **`5Bxx`**: set D2R/SR of all operators.
- **`5Cxx`**: set D2R/SR of operator 1.
- **`5Dxx`**: set D2R/SR of operator 2.
- **`5Exx`**: set D2R/SR of operator 3.
- **`5Fxx`**: set D2R/SR of operator 4.
- `56xx`: **set DR of all operators.**
- `57xx`: **set DR of operator 1.**
- `58xx`: **set DR of operator 2.**
- `59xx`: **set DR of operator 3.**
- `5Axx`: **set DR of operator 4.**
- `5Bxx`: **set D2R/SR of all operators.**
- `5Cxx`: **set D2R/SR of operator 1.**
- `5Dxx`: **set D2R/SR of operator 2.**
- `5Exx`: **set D2R/SR of operator 3.**
- `5Fxx`: **set D2R/SR of operator 4.**

114
doc/7-systems/ym2610.md
View File

@ -6,69 +6,69 @@ its soundchip is a 4-in-1: 4ch 4-op FM, YM2149 (AY-3-8910 clone) and 2 different
# effects
- **`10xy`**: set LFO parameters.
- `10xy`: **set LFO parameters.**
- `x` toggles the LFO.
- `y` sets its speed.
- **`11xx`**: set feedback of channel.
- **`12xx`**: set operator 1 level.
- **`13xx`**: set operator 2 level.
- **`14xx`**: set operator 3 level.
- **`15xx`**: set operator 4 level.
- **`16xy`**: set multiplier of operator.
- `11xx`: **set feedback of channel.**
- `12xx`: **set operator 1 level.**
- `13xx`: **set operator 2 level.**
- `14xx`: **set operator 3 level.**
- `15xx`: **set operator 4 level.**
- `16xy`: **set multiplier of operator.**
- `x` is the operator (1-4).
- `y` is the multiplier.
- **`18xx`**: toggle extended channel 2 mode.
- `18xx`: **toggle extended channel 2 mode.**
- 0 disables it and 1 enables it.
- only in extended channel 2 chip.
- **`19xx`**: set attack of all operators.
- **`1Axx`**: set attack of operator 1.
- **`1Bxx`**: set attack of operator 2.
- **`1Cxx`**: set attack of operator 3.
- **`1Dxx`**: set attack of operator 4.
- **`20xx`**: set SSG channel mode. `xx` may be one of the following:
- `00`: square
- `01`: noise
- `02`: square and noise
- `03`: nothing (apparently)
- `04`: envelope and square
- `05`: envelope and noise
- `06`: envelope and square and noise
- `07`: nothing
- **`21xx`**: set noise frequency. `xx` is a value between 00 and 1F.
- **`22xy`**: set envelope mode.
- `x` sets the envelope shape, which may be one of the following:
- `0: \___` decay
- `4: /___` attack once
- `8: \\\\` saw
- `9: \___` decay
- `A: \/\/` inverse obelisco
- `B: \¯¯¯` decay once
- `C: ////` inverse saw
- `D: /¯¯¯` attack
- `E: /\/\` obelisco
- `F: /___` attack once
- `19xx`: **set attack of all operators.**
- `1Axx`: **set attack of operator 1.**
- `1Bxx`: **set attack of operator 2.**
- `1Cxx`: **set attack of operator 3.**
- `1Dxx`: **set attack of operator 4.**
- `20xx`: **set SSG channel mode.**
- `0`: square
- `1`: noise
- `2`: square and noise
- `3`: nothing (apparently)
- `4`: envelope and square
- `5`: envelope and noise
- `6`: envelope and square and noise
- `7`: nothing
- `21xx`: **set noise frequency.** range is `00` to `1F`.
- `22xy`: **set envelope mode.**
- `x` sets the envelope shape:
- `0`: `\___` decay
- `4`: `/___` attack once
- `8`: `\\\\` saw
- `9`: `\___` decay
- `A`: `\/\/` inverse obelisco
- `B`: `\¯¯¯` decay once
- `C`: `////` inverse saw
- `D`: `/¯¯¯` attack
- `E`: `/\/\` obelisco
- `F`: `/___` attack once
- if `y` is 1 then the envelope will affect this channel.
- **`23xx`**: set envelope period low byte.
- **`24xx`**: set envelope period high byte.
- **`25xx`**: slide envelope period up.
- **`26xx`**: slide envelope period down.
- **`29xy`**: enable SSG auto-envelope mode.
- `23xx`: **set envelope period low byte.**
- `24xx`: **set envelope period high byte.**
- `25xx`: **slide envelope period up.**
- `26xx`: **slide envelope period down.**
- `29xy`: **enable SSG auto-envelope mode.**
- in this mode the envelope period is set to the channel's notes, multiplied by a fraction.
- `x` is the numerator.
- `y` is the denominator.
- if `x` or `y` are 0 this will disable auto-envelope mode.
- **`30xx`**: enable envelope hard reset.
- `30xx`: **enable envelope hard reset.**
- this works by inserting a quick release and tiny delay before a new note.
- **`50xy`**: set AM of operator.
- `50xy`: **set AM of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` determines whether AM is on.
- **`51xy`**: set SL of operator.
- `51xy`: **set SL of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`52xy`**: set RR of operator.
- `52xy`: **set RR of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`53xy`**: set DT of operator.
- `53xy`: **set DT of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value:
- 0: +0
@ -79,21 +79,21 @@ its soundchip is a 4-in-1: 4ch 4-op FM, YM2149 (AY-3-8910 clone) and 2 different
- 5: -3
- 6: -2
- 7: -1
- **`54xy`**: set RS of operator.
- `54xy`: **set RS of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`55xy`**: set SSG-EG of operator.
- `55xy`: **set SSG-EG of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value (0-8).
- values between 0 and 7 set SSG-EG.
- value 8 disables it.
- **`56xx`**: set DR of all operators.
- **`57xx`**: set DR of operator 1.
- **`58xx`**: set DR of operator 2.
- **`59xx`**: set DR of operator 3.
- **`5Axx`**: set DR of operator 4.
- **`5Bxx`**: set D2R/SR of all operators.
- **`5Cxx`**: set D2R/SR of operator 1.
- **`5Dxx`**: set D2R/SR of operator 2.
- **`5Exx`**: set D2R/SR of operator 3.
- **`5Fxx`**: set D2R/SR of operator 4.
- `56xx`: **set DR of all operators.**
- `57xx`: **set DR of operator 1.**
- `58xx`: **set DR of operator 2.**
- `59xx`: **set DR of operator 3.**
- `5Axx`: **set DR of operator 4.**
- `5Bxx`: **set D2R/SR of all operators.**
- `5Cxx`: **set D2R/SR of operator 1.**
- `5Dxx`: **set D2R/SR of operator 2.**
- `5Exx`: **set D2R/SR of operator 3.**
- `5Fxx`: **set D2R/SR of operator 4.**

112
doc/7-systems/ym2610b.md
View File

@ -5,26 +5,26 @@ it is backward compatible with the original chip.
# effects
- **`10xy`**: set LFO parameters.
- `10xy`: **set LFO parameters.**
- `x` toggles the LFO.
- `y` sets its speed.
- **`11xx`**: set feedback of channel.
- **`12xx`**: set operator 1 level.
- **`13xx`**: set operator 2 level.
- **`14xx`**: set operator 3 level.
- **`15xx`**: set operator 4 level.
- **`16xy`**: set multiplier of operator.
- `11xx`: **set feedback of channel.**
- `12xx`: **set operator 1 level.**
- `13xx`: **set operator 2 level.**
- `14xx`: **set operator 3 level.**
- `15xx`: **set operator 4 level.**
- `16xy`: **set multiplier of operator.**
- `x` is the operator (1-4).
- `y` is the multiplier.
- **`18xx`**: toggle extended channel 3 mode.
- `18xx`: **toggle extended channel 3 mode.**
- 0 disables it and 1 enables it.
- only in extended channel 3 chip.
- **`19xx`**: set attack of all operators.
- **`1Axx`**: set attack of operator 1.
- **`1Bxx`**: set attack of operator 2.
- **`1Cxx`**: set attack of operator 3.
- **`1Dxx`**: set attack of operator 4.
- **`20xx`**: set SSG channel mode. `xx` may be one of the following:
- `19xx`: **set attack of all operators.**
- `1Axx`: **set attack of operator 1.**
- `1Bxx`: **set attack of operator 2.**
- `1Cxx`: **set attack of operator 3.**
- `1Dxx`: **set attack of operator 4.**
- `20xx`: **set SSG channel mode.**
- `00`: square
- `01`: noise
- `02`: square and noise
@ -33,66 +33,66 @@ it is backward compatible with the original chip.
- `05`: envelope and noise
- `06`: envelope and square and noise
- `07`: nothing
- **`21xx`**: set noise frequency. `xx` is a value between 00 and 1F.
- **`22xy`**: set envelope mode.
- `21xx`: **set noise frequency.** range is `00` to `1F`.
- `22xy`: **set envelope mode.**
- `x` sets the envelope shape, which may be one of the following:
- `0: \___` decay
- `4: /___` attack once
- `8: \\\\` saw
- `9: \___` decay
- `A: \/\/` inverse obelisco
- `B: \¯¯¯` decay once
- `C: ////` inverse saw
- `D: /¯¯¯` attack
- `E: /\/\` obelisco
- `F: /___` attack once
- `0`:` \___` decay
- `4`:` /___` attack once
- `8`:` \\\\` saw
- `9`:` \___` decay
- `A`:` \/\/` inverse obelisco
- `B`:` \¯¯¯` decay once
- `C`:` ////` inverse saw
- `D`:` /¯¯¯` attack
- `E`:` /\/\` obelisco
- `F`:` /___` attack once
- if `y` is 1 then the envelope will affect this channel.
- **`23xx`**: set envelope period low byte.
- **`24xx`**: set envelope period high byte.
- **`25xx`**: slide envelope period up.
- **`26xx`**: slide envelope period down.
- **`29xy`**: enable SSG auto-envelope mode.
- `23xx`: **set envelope period low byte.**
- `24xx`: **set envelope period high byte.**
- `25xx`: **slide envelope period up.**
- `26xx`: **slide envelope period down.**
- `29xy`: **enable SSG auto-envelope mode.**
- in this mode the envelope period is set to the channel's notes, multiplied by a fraction.
- `x` is the numerator.
- `y` is the denominator.
- if `x` or `y` are 0 this will disable auto-envelope mode.
- **`30xx`**: enable envelope hard reset.
- `30xx`: **enable envelope hard reset.**
- this works by inserting a quick release and tiny delay before a new note.
- **`50xy`**: set AM of operator.
- `50xy`: **set AM of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` determines whether AM is on.
- **`51xy`**: set SL of operator.
- `51xy`: **set SL of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`52xy`**: set RR of operator.
- `52xy`: **set RR of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`53xy`**: set DT of operator.
- `53xy`: **set DT of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value:
- 0: +0
- 1: +1
- 2: +2
- 3: +3
- 4: -0
- 5: -3
- 6: -2
- 7: -1
- **`54xy`**: set RS of operator.
- `0`: +0
- `1`: +1
- `2`: +2
- `3`: +3
- `4`: -0
- `5`: -3
- `6`: -2
- `7`: -1
- `54xy`: **set RS of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`55xy`**: set SSG-EG of operator.
- `55xy`: **set SSG-EG of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value (0-8).
- values between 0 and 7 set SSG-EG.
- value 8 disables it.
- **`56xx`**: set DR of all operators.
- **`57xx`**: set DR of operator 1.
- **`58xx`**: set DR of operator 2.
- **`59xx`**: set DR of operator 3.
- **`5Axx`**: set DR of operator 4.
- **`5Bxx`**: set D2R/SR of all operators.
- **`5Cxx`**: set D2R/SR of operator 1.
- **`5Dxx`**: set D2R/SR of operator 2.
- **`5Exx`**: set D2R/SR of operator 3.
- **`5Fxx`**: set D2R/SR of operator 4.
- `56xx`: **set DR of all operators.**
- `57xx`: **set DR of operator 1.**
- `58xx`: **set DR of operator 2.**
- `59xx`: **set DR of operator 3.**
- `5Axx`: **set DR of operator 4.**
- `5Bxx`: **set D2R/SR of all operators.**
- `5Cxx`: **set D2R/SR of operator 1.**
- `5Dxx`: **set D2R/SR of operator 2.**
- `5Exx`: **set D2R/SR of operator 3.**
- `5Fxx`: **set D2R/SR of operator 4.**

80
doc/7-systems/ym2612.md
View File

@ -1,67 +1,67 @@
# Yamaha YM2612
one of two chips that powered the Sega Genesis. It is a six-channel, four-operator FM synthesizer. Channel #6 can be turned into 8-bit PCM player, that via software mixing, thanks to Z80 sound CPU, can play more than one channel of straight-shot samples at once. As of Furnace 0.6pre5, Furnace offers DualPCM, which allows 2 channels of software-mixed 8-bit PCM samples at 13750 Hz.
one of two chips that powered the Sega Genesis. it is a six-channel, four-operator FM synthesizer. channel #6 can be turned into 8-bit PCM player, that via software mixing, thanks to Z80 sound CPU, can play more than one channel of straight-shot samples at once. as of Furnace 0.6pre5, Furnace offers DualPCM, which allows 2 channels of software-mixed 8-bit PCM samples at 13750 Hz.
# effects
- **`10xy`**: set LFO parameters.
- `10xy`: **set LFO parameters.**
- `x` toggles the LFO.
- `y` sets its speed.
- **`11xx`**: set feedback of channel.
- **`12xx`**: set operator 1 level.
- **`13xx`**: set operator 2 level.
- **`14xx`**: set operator 3 level.
- **`15xx`**: set operator 4 level.
- **`16xy`**: set multiplier of operator.
- `11xx`: **set feedback of channel.**
- `12xx`: **set operator 1 level.**
- `13xx`: **set operator 2 level.**
- `14xx`: **set operator 3 level.**
- `15xx`: **set operator 4 level.**
- `16xy`: **set multiplier of operator.**
- `x` is the operator (1-4).
- `y` is the multiplier.
- **`17xx`**: enable PCM channel.
- `17xx`: **enable PCM channel.**
- this only works on channel 6.
- **`18xx`**: toggle extended channel 3 mode.
- `18xx`: **toggle extended channel 3 mode.**
- 0 disables it and 1 enables it.
- only in extended channel 3 chip.
- **`19xx`**: set attack of all operators.
- **`1Axx`**: set attack of operator 1.
- **`1Bxx`**: set attack of operator 2.
- **`1Cxx`**: set attack of operator 3.
- **`1Dxx`**: set attack of operator 4.
- **`30xx`**: enable envelope hard reset.
- `19xx`: **set attack of all operators.**
- `1Axx`: **set attack of operator 1.**
- `1Bxx`: **set attack of operator 2.**
- `1Cxx`: **set attack of operator 3.**
- `1Dxx`: **set attack of operator 4.**
- `30xx`: **enable envelope hard reset.**
- this works by inserting a quick release and tiny delay before a new note.
- **`50xy`**: set AM of operator.
- `50xy`: **set AM of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` determines whether AM is on.
- **`51xy`**: set SL of operator.
- `51xy`: **set SL of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`52xy`**: set RR of operator.
- `52xy`: **set RR of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`53xy`**: set DT of operator.
- `53xy`: **set DT of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value:
- 0: -3
- 1: -2
- 2: -1
- 3: 0
- 4: 1
- 5: 2
- 6: 3
- 7: -0
- **`54xy`**: set RS of operator.
- `0`: -3
- `1`: -2
- `2`: -1
- `3`: 0
- `4`: 1
- `5`: 2
- `6`: 3
- `7`: -0
- `54xy`: **set RS of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value.
- **`55xy`**: set SSG-EG of operator.
- `55xy`: **set SSG-EG of operator.**
- `x` is the operator (1-4). a value of 0 means "all operators".
- `y` is the value (0-8).
- values between 0 and 7 set SSG-EG.
- value 8 disables it.
- **`56xx`**: set DR of all operators.
- **`57xx`**: set DR of operator 1.
- **`58xx`**: set DR of operator 2.
- **`59xx`**: set DR of operator 3.
- **`5Axx`**: set DR of operator 4.
- **`5Bxx`**: set D2R/SR of all operators.
- **`5Cxx`**: set D2R/SR of operator 1.
- **`5Dxx`**: set D2R/SR of operator 2.
- **`5Exx`**: set D2R/SR of operator 3.
- **`5Fxx`**: set D2R/SR of operator 4.
- `56xx`: **set DR of all operators.**
- `57xx`: **set DR of operator 1.**
- `58xx`: **set DR of operator 2.**
- `59xx`: **set DR of operator 3.**
- `5Axx`: **set DR of operator 4.**
- `5Bxx`: **set D2R/SR of all operators.**
- `5Cxx`: **set D2R/SR of operator 1.**
- `5Dxx`: **set D2R/SR of operator 2.**
- `5Exx`: **set D2R/SR of operator 3.**
- `5Fxx`: **set D2R/SR of operator 4.**