furnace/doc/4-instrument/README.md

100 lines
5.5 KiB
Markdown
Raw Normal View History

2022-02-09 07:55:53 +00:00
# instrument list
![instrument list](list.png)
click on an instrument to select it.
double-click to open the instrument editor.
2022-01-16 06:10:43 +00:00
# instrument editor
2022-02-09 07:55:53 +00:00
every instrument can be renamed and have its type changed.
depending on the instrument type, there are currently 13 different types of an instrument editor:
2022-02-04 21:06:42 +00:00
- [FM synthesis](fm.md) - for use with YM2612, YM2151 and FM block portion of YM2610.
2022-02-09 07:55:53 +00:00
- [Standard](standard.md) - for use with NES and Sega Master System's PSG sound source and its derivatives.
2022-02-04 21:06:42 +00:00
- [Game Boy](game-boy.md) - for use with Game Boy APU.
- [PC Engine / TurboGrafx-16](pce.md) - for use with PC Engine's wavetable synthesizer.
2022-03-06 16:13:47 +00:00
- [WonderSwan](wonderswan.md) - for use with WonderSwan's wavetable synthesizer.
2022-02-04 21:06:42 +00:00
- [AY8930](8930.md) - for use with Microchip AY8930 E-PSG sound source.
2022-02-09 07:55:53 +00:00
- [Commodore 64](c64.md) - for use with Commodore 64 SID.
2022-02-04 21:06:42 +00:00
- [SAA1099](saa.md) - for use with Philips SAA1099 PSG sound source.
2022-10-16 05:53:05 +00:00
- [TIA](tia.md) - for use with Atari 2600 chip.
2022-02-04 21:06:42 +00:00
- [AY-3-8910](ay8910.md) - for use with AY-3-8910 PSG sound source and SSG portion in YM2610.
- [Amiga / sample](amiga.md) for controlling Amiga and other sample based synthsizers like YM2612's Channel 6 PCM mode, NES channel 5, Sega PCM, X1-010 and PC Engine's sample playback mode.
- [Atari Lynx](lynx.md) - for use with Atari Lynx handheld console.
- [VERA](vera.md) - for use with Commander X16 VERA.
- [Seta/Allumer X1-010](x1_010.md) - for use with Wavetable portion in Seta/Allumer X1-010.
- [Konami SCC / Bubble System WSG](scc.md) - for use with Konami SCC and Wavetable portion in Bubble System's sound hardware.
2022-03-22 16:48:45 +00:00
- [Namco 163](n163.md) - for use with Namco 163.
- [Konami VRC6](vrc6.md) - for use with VRC6's PSG sound source.
2022-02-09 07:55:53 +00:00
2023-06-11 06:00:11 +00:00
2022-02-09 07:55:53 +00:00
# macros
2023-06-11 06:14:45 +00:00
Macros are incredibly versatile tools for automating instrument parameters.
2023-06-11 06:00:11 +00:00
After creating an instrument, open the Instrument Editor and select the "Macros" tab. There may be multiple macro tabs to control individual FM operators and such.
![macro view](macroview.png)
The very first numeric entry sets the visible width of the bars in sequence-type macros. The scrollbar affects the view of all macros at once. There's a matching scrollbar at the bottom underneath all the macros.
Each macro has two buttons on the left.
- Macro type (explained below).
- Timing editor, which pops up a small dialog:
- Step Length (ticks): Determines how many ticks pass before each change of value.
- Delay: Delays the start of the macro until this many ticks have passed.
## macro types
2023-06-11 06:14:45 +00:00
Every macro can be defined though one of three methods, selectable with the leftmost button under the macro type label:
2023-06-11 06:00:11 +00:00
- ![](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.
2023-06-11 06:00:11 +00:00
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.
### sequence
![sequence macro editor](macro-seq.png)
The number between the macro type label and the macro type button is the macro length in steps. The `-` and `+` buttons change the length of the macro. Start out by adding at least a few steps.
The values of the macro can be drawn in the "bar graph box". Just beneath the box is shorter bar graph.
2023-06-11 06:14:45 +00:00
- Click to set the start point of a loop; the end point is the last value or release point. Right-click to remove the loop.
- Shift-click to set the release point. When played, the macro will hold here until the note is released. Right-click to remove the release point.
2023-06-11 06:00:11 +00:00
Finally, the sequence of values can be directly edited in the text box at the bottom.
- The loop start is entered as a `|`.
- The release point is entered as a `/`.
- In arpeggio macros, a value starting with a `@` is an absolute note (instead of a relative shift). No matter the note played, `@` values will be played at that exact note. This is especially useful for noise instruments with preset periods.
### ADSR
![ADSR macro editor](macro-ADSR.png)
- **Bottom** and **Top** determine the range of outputs generated by the macro. (Bottom can be larger than Top to invert the envelope!) All outputs will be between these two values.
- Attack, Decay, Sustain, SusDecay, and Release accept inputs between 0 to 255. These are scaled to the distance between Bottom and Top.
- **Attack** is how much the value moves toward Top with each tick.
- **Hold** sets how many ticks to stay at Top before Decay.
- **Decay** is how much the value moves to the Sustain level.
- **Sustain** is how far from Bottom the value stays while the note is held.
- **SusTime** is how many ticks to stay at Sustain until SusDecay.
- **SusDecay** is how much the value moves toward Bottom with each tick while the note is held.
- **Release** is how much the value moves toward Bottom with each tick after the note is released.
2023-06-11 06:14:45 +00:00
![macro ADSR chart](macro-ADSRchart.png)
2022-02-09 07:55:53 +00:00
2023-06-11 06:00:11 +00:00
### LFO
2022-02-09 07:55:53 +00:00
2023-06-11 06:00:11 +00:00
![LFO macro editor](macro-LFO.png)
2022-02-09 07:55:53 +00:00
2023-06-11 06:00:11 +00:00
- **Bottom** and **Top** determine the range of values generated by the macro. (Bottom can be larger than Top to invert the waveform!)
- **Speed** is how quickly the values change the frequency of the oscillator.
- **Phase** is which part of the waveform the macro will start at, measured in 1/1024 increments.
- **Shape** is the waveform used. Triangle is the default, and Saw and Square are exactly as they say.