furnace/papers/doc/4-instrument/README.md

# instrument list

![instrument list](list.png)

click on an instrument to select it.

double-click to open the instrument editor.

# instrument editor

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:

- [FM synthesis](fm.md) - for use with YM2612, YM2151 and FM block portion of YM2610.
- [Standard](standard.md) - for use with NES and Sega Master System's PSG sound source and its derivatives. 
- [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.
- [WonderSwan](wonderswan.md) - for use with WonderSwan's wavetable synthesizer.
- [AY8930](8930.md) - for use with Microchip AY8930 E-PSG sound source.
- [Commodore 64](c64.md) - for use with Commodore 64 SID.
- [SAA1099](saa.md) - for use with Philips SAA1099 PSG sound source.
- [TIA](tia.md) - for use with Atari 2600 system.
- [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.

# macros

one common feature to instruments is macros (also known as sequences).

these run on every tick and are useful for controlling parameters automatically.

![macro view](macro.png)

to change the loop portion/point, click on the bar under the macro.
right click on it to disable macro loop.

to change the release point, shift-click the bar under the macro.
shift-right click on it to remove the release point.
update instrument doc 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.`

update documentation 2022-01-16 06:10:43 +00:00			`# instrument editor`

update instrument doc 2022-02-09 07:55:53 +00:00			`every instrument can be renamed and have its type changed.`

Allow Left waveform can be invertable, Improvement documents 2022-03-08 15:50:10 +00:00			`depending on the instrument type, there are currently 13 different types of an instrument editor:`
Update README.md 2022-02-04 21:06:42 +00:00
			`- [FM synthesis](fm.md) - for use with YM2612, YM2151 and FM block portion of YM2610.`
update instrument doc 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.`
Update README.md 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.`
Add WonderSwan support 2022-03-06 16:13:47 +00:00			`- [WonderSwan](wonderswan.md) - for use with WonderSwan's wavetable synthesizer.`
Update README.md 2022-02-04 21:06:42 +00:00			`- [AY8930](8930.md) - for use with Microchip AY8930 E-PSG sound source.`
update instrument doc 2022-02-09 07:55:53 +00:00			`- [Commodore 64](c64.md) - for use with Commodore 64 SID.`
Update README.md 2022-02-04 21:06:42 +00:00			`- [SAA1099](saa.md) - for use with Philips SAA1099 PSG sound source.`
update instrument doc 2022-02-09 07:55:53 +00:00			`- [TIA](tia.md) - for use with Atari 2600 system.`
Update README.md 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.`
Add Seta/Allumer X1-010 Support its 16 channel wavetable/PCM chip, with (optional) stereo support. Its also has envelope, this feature has similar as AY PSG's one but its shape is also stored at RAM, and each nibble in envelope data is for each output: so i decided to added some feature for more stereo-ish envelope. Split: Envelope shape will be splitted to Left and Right half for each output. HInv, Vinv: Envelope shape will be Horizontally/Vertically mirrored the left one. Max sample length is sample bank size of Seta 2 arcade hardware (currently not emulated yet, nor it doesn't support on VGM). Chip id is temporary, it can be changed with to suggestions. 2022-03-06 17:31:03 +00:00			`- [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.`
Merge branch 'x1_010' of https://github.com/cam900/furnace into cam900-x1_010 2022-03-10 23:24:52 +00:00			`- [Atari Lynx](lynx.md) - for use with Atari Lynx handheld console.`
			`- [VERA](vera.md) - for use with Commander X16 VERA.`
Add Seta/Allumer X1-010 Support its 16 channel wavetable/PCM chip, with (optional) stereo support. Its also has envelope, this feature has similar as AY PSG's one but its shape is also stored at RAM, and each nibble in envelope data is for each output: so i decided to added some feature for more stereo-ish envelope. Split: Envelope shape will be splitted to Left and Right half for each output. HInv, Vinv: Envelope shape will be Horizontally/Vertically mirrored the left one. Max sample length is sample bank size of Seta 2 arcade hardware (currently not emulated yet, nor it doesn't support on VGM). Chip id is temporary, it can be changed with to suggestions. 2022-03-06 17:31:03 +00:00			`- [Seta/Allumer X1-010](x1_010.md) - for use with Wavetable portion in Seta/Allumer X1-010.`
update instrument doc 2022-02-09 07:55:53 +00:00
			`# macros`

			`one common feature to instruments is macros (also known as sequences).`

			`these run on every tick and are useful for controlling parameters automatically.`

			`![macro view](macro.png)`

			`to change the loop portion/point, click on the bar under the macro.`
			`right click on it to disable macro loop.`

			`to change the release point, shift-click the bar under the macro.`
			`shift-right click on it to remove the release point.`