Merge branch 'master' of https://github.com/tildearrow/furnace into x1_010_bank

This commit is contained in:
cam900 2023-07-18 20:17:28 +09:00
commit 1873a2a708
272 changed files with 6234 additions and 1974 deletions

2
.gitignore vendored
View File

@ -15,6 +15,8 @@ test/songs/
test/delta/
test/result/
test/assert_delta
android/local.properties
android/.idea/
android/.gradle/
android/app/build/
android/app/.cxx/

View File

@ -455,6 +455,8 @@ src/engine/platform/sound/c64_fp/WaveformCalculator.cpp
src/engine/platform/sound/c64_fp/WaveformGenerator.cpp
src/engine/platform/sound/c64_fp/resample/SincResampler.cpp
src/engine/platform/sound/c64_d/dsid.c
src/engine/platform/sound/tia/AudioChannel.cpp
src/engine/platform/sound/tia/Audio.cpp
@ -586,6 +588,7 @@ src/engine/platform/k007232.cpp
src/engine/platform/ga20.cpp
src/engine/platform/sm8521.cpp
src/engine/platform/pv1000.cpp
src/engine/platform/k053260.cpp
src/engine/platform/pcmdac.cpp
src/engine/platform/dummy.cpp
@ -803,7 +806,6 @@ if (BUILD_GUI)
list(APPEND USED_SOURCES ${GUI_SOURCES})
list(APPEND DEPENDENCIES_INCLUDE_DIRS
extern/imgui_patched
extern/imgui_conf
extern/imgui_patched/backends
extern/IconFontCppHeaders
extern/igfd
@ -860,7 +862,7 @@ endif()
string(REPLACE ";" " " WARNING_FLAGS_STRING "${WARNING_FLAGS}")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${WARNING_FLAGS_STRING}")
if (WARNINGS_ARE_ERRORS)
message(WARNING
message(STATUS
"Treating all warnings in furnace's C++ code as errors! "
"Please report any errors you encounter on the bug tracker."
)
@ -875,7 +877,7 @@ else()
endif()
target_include_directories(furnace SYSTEM PRIVATE ${DEPENDENCIES_INCLUDE_DIRS})
target_compile_definitions(furnace PRIVATE ${DEPENDENCIES_DEFINES} IMGUI_USER_CONFIG="imconfig_fur.h")
target_compile_definitions(furnace PRIVATE ${DEPENDENCIES_DEFINES})
target_compile_options(furnace PRIVATE ${DEPENDENCIES_COMPILE_OPTIONS})
target_link_libraries(furnace PRIVATE ${DEPENDENCIES_LIBRARIES})
if (PKG_CONFIG_FOUND AND (SYSTEM_FMT OR SYSTEM_LIBSNDFILE OR SYSTEM_ZLIB OR SYSTEM_SDL2 OR SYSTEM_RTMIDI OR WITH_JACK))

View File

@ -81,6 +81,10 @@ additional guidelines:
- on a switch block, **always** put `default` last and not in any other position.
- I have fear of some C/C++ compilers ignoring the rest of cases upon hitting default.
## Do NOT Force-Push after submitting Pull Request
if you do so, your pull request will be closed.
## Demo Songs
just put your demo song in `demos/`! be noted there are some guidelines:

View File

@ -9,7 +9,9 @@ the biggest multi-system chiptune tracker ever made!
---
## downloads
check out the [Releases](https://github.com/tildearrow/furnace/releases) page. available for Windows, macOS and Linux (AppImage).
check out the [Releases](https://github.com/tildearrow/furnace/releases) page. available for Windows, macOS and Linux.
for other operating systems, you may [build the source](#developer-info).
[see here](https://nightly.link/tildearrow/furnace/workflows/build/master) for the latest unstable build.
@ -79,6 +81,7 @@ check out the [Releases](https://github.com/tildearrow/furnace/releases) page. a
- modern/fantasy:
- Commander X16 VERA
- tildearrow Sound Unit
- Generic PCM DAC
- mix and match sound chips!
- over 200 ready to use presets from computers, game consoles and arcade boards...
- ...or create your own - up to 32 of them or a total of 128 channels!
@ -90,6 +93,7 @@ check out the [Releases](https://github.com/tildearrow/furnace/releases) page. a
- clean-room design (guesswork and ABX tests only, no decompilation involved)
- some bug/quirk implementation for increased playback accuracy through compatibility flags
- VGM export
- ZSM export for Commander X16
- modular layout that you may adapt to your needs
- audio file export - entire song, per chip or per channel
- quality emulation cores (Nuked, MAME, SameBoy, Mednafen PCE, NSFplay, puNES, reSID, Stella, SAASound, vgsound_emu and ymfm)
@ -120,11 +124,11 @@ check out the [Releases](https://github.com/tildearrow/furnace/releases) page. a
# quick references
- **discussion**: see the [Discussions](https://github.com/tildearrow/furnace/discussions) section, the [official Revolt](https://rvlt.gg/GRPS6tmc) or the [official Discord server](https://discord.gg/EfrwT2wq7z).
- **help**: check out the [documentation](doc/README.md). it's incomplete though.
- **help**: check out the [documentation](doc/README.md). it's about 80% complete.
## packages
[![Packaging status](https://repology.org/badge/tiny-repos/furnace.svg)](https://repology.org/project/furnace/versions)
[![Packaging status](https://repology.org/badge/vertical-allrepos/furnace.svg)](https://repology.org/project/furnace/versions)
some people have provided packages for Unix/Unix-like distributions. here's a list.
@ -156,6 +160,7 @@ otherwise, you may also need the following:
- libx11
- libasound
- libGL
- any other libraries which may be used by SDL
some Linux distributions (e.g. Ubuntu or openSUSE) will require you to install the `-dev` versions of these.
@ -255,6 +260,17 @@ Available options:
| `WITH_INSTRUMENTS` | `ON` | Install demo instruments on `make install` |
| `WITH_WAVETABLES` | `ON` | Install wavetables on `make install` |
## CMake Error
if it says something about a missing subdirectory in `extern`, then either:
1. you didn't set up submodules, or
2. you downloaded the source as a .zip or .tar.gz. don't do this.
if 1, you may run `git submodule update --init --recursive`. this will initialize submodules.
if 2, clone this repo.
## console usage
(note: if on Windows, type `furnace.exe` instead, or `Debug\furnace.exe` on MSVC)
@ -289,7 +305,7 @@ this is due to Apple's application signing policy. a workaround is to right clic
> it says "Furnace" is damaged and can't be opened!
**as of Monterey, this workaround no longer works (especially on ARM).** yeah, Apple has decided to be strict on the matter.
if you happen to be on that version, use this workaround instead (on a Terminal):
if you happen to be on that version (or later), use this workaround instead (on a Terminal):
```
xattr -d com.apple.quarantine /path/to/Furnace.app
@ -301,7 +317,7 @@ you may need to log out and/or reboot after doing this.
> where's the manual?
see [doc/](doc/README.md). it's kind of incomplete though.
it is in [doc/](doc/README.md).
> is there a tutorial?

View File

@ -1,4 +1,4 @@
# to-do for 0.6pre6
# to-do for 0.6pre7
- tutorial?
- ease-of-use improvements... ideas:

View File

@ -15,8 +15,8 @@ android {
}
minSdkVersion 21
targetSdkVersion 26
versionCode 158
versionName "0.6pre5"
versionCode 162
versionName "0.6pre7"
externalNativeBuild {
cmake {
arguments "-DANDROID_APP_PLATFORM=android-21", "-DANDROID_STL=c++_static", "-DWARNINGS_ARE_ERRORS=ON"

View File

@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="org.tildearrow.furnace"
android:versionCode="158"
android:versionName="0.6pre5"
android:versionCode="162"
android:versionName="0.6pre7"
android:installLocation="auto">
<!-- OpenGL ES 2.0 -->

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
demos/gameboy/finger.fur Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
demos/sms/FlowOfSN7.fur Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
demos/x16/keygen19.fur Normal file

Binary file not shown.

View File

@ -12,7 +12,7 @@ Furnace uses hexadecimal (abbreviated as "hex") numbers frequently. see [this gu
## interface
Furnace uses a music tracker interface. think of a table with music notes written on it. then that table scrolls up and plays the notes.
Furnace uses a music tracker interface. think of a table with music notes written on it. then that table scrolls up and plays the notes. even experienced tracker musicians might benefit from a quick review of [tracker concepts and terms](concepts.md) before using Furnace.
due to its nature of being feature-packed, it may be technical and somewhat difficult to get around. therefore we added a basic mode, which hides several advanced features.

36
doc/1-intro/concepts.md Normal file
View File

@ -0,0 +1,36 @@
# concepts and terms
- A **module** is a file for a tracker that contains at least one **song**.
- Each Furnace module involves at least one **[chip](../7-systems/README.md)**, an emulation of a specific audio processor.
## tracking
The **[pattern view](../3-pattern/README.md)** is like a spreadsheet that displays the following:
- Each labeled column represents a **channel** of sound provided by the chips in use.
- Each **note** starts a sound playing. Within a channel, only one note can play at a time.
- Each note is assigned an **[instrument](../4-instrument/README.md)** which describes what it will sound like.
- An **effect** is a command that changes some aspect of playback. It can alter note pitch, volume, timing, and more.
- An instrument **macro** is an automated sequence of effects that applies to every note of that instrument.
## structure
The **order list** is a smaller spreadsheet showing the overall song structure.
- A song is made up of a list of **orders**.
- An **order** is a set of numbered **patterns** used for each channel.
- Each channel has its own unique list of patterns.
- Each pattern contains note and effect data for that channel only.
- Patterns may be used multiple times in the order list. Changing a pattern's data in one order will affect the same pattern used in other orders.
## time
- Each pattern is made of the same number of **rows** as seen in the tracker view.
- During playback, Each row lasts a number of **ticks** determined by its **speed** value.
- A tick is the smallest measure of time to which all note, effect, and macro times are quantized.
## sound
Different chips have different capabilities. Even within the same chip, each channel may have its own ways of making sound.
- Some channels use one or more waveform **generators** (sine, square, noise...) to build up a sound.
- Of special note are **[FM (frequency modulation)](../4-instrument/fm.md)** channels, which use a number of generators called **operators** that can interact to make very complex sounds.
- Some channels use **[samples](../6-sample/README.md)** - recordings of sounds, often with defined loop points to allow a note to sustain.
- Some channels use **[wavetables](../5-wave/README.md)**, which are like very short samples of fixed length that automatically loop.

View File

@ -95,3 +95,24 @@ now for decimal number `69420`:
= 10F2C
```
# hex-decimal table
hex | `0` | `1` | `2` | `3` | `4` | `5` | `6` | `7` | `8` | `9` | `A` | `B` | `C` | `D` | `E` | `F`
-----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:
`00` | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15
`10` | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31
`20` | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47
`30` | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63
`40` | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79
`50` | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95
`60` | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111
`70` | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127
`80` | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143
`90` | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159
`A0` | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175
`B0` | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191
`C0` | 192 | 193 | 194 | 195 | 196 | 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207
`D0` | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223
`E0` | 224 | 225 | 226 | 227 | 228 | 229 | 230 | 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 239
`F0` | 240 | 241 | 242 | 243 | 244 | 245 | 246 | 247 | 248 | 249 | 250 | 251 | 252 | 253 | 254 | 255

View File

@ -9,6 +9,7 @@ the default layout of Furnace is depicted below.
primary topics:
- [menu bar](menu-bar.md)
- [order list](order-list.md)
- [play/edit controls](play-edit-controls.md)
- [instrument/wavetable/sample list](asset-list.md)
- [song information](song-info.md)
@ -36,6 +37,7 @@ advanced topics:
other topics:
- [settings](../2-interface/settings.md)
- [UI components](components.md)
- [global keyboard shortcuts](keyboard.md)
- [basic mode](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:

View File

@ -1,6 +1,6 @@
# menu bar
the menu bar allows you to select five menus: file, edit, settings, window and help.
the menu bar allows you to select from five menus: file, edit, settings, window and help.
# file
@ -8,6 +8,7 @@ the menu bar allows you to select five menus: file, edit, settings, window and h
- **open...**: opens the file picker, allowing you to select a song to open.
- **open recent**: contains a list of the songs you've opened before.
- **clear history**: this option erases the file history.
- **save**: saves the current song.
- opens the file picker if this is a new song, or a backup.
- **save as...**: opens the file picker, allowing you to save the song under a different name.
@ -29,12 +30,14 @@ the menu bar allows you to select five menus: file, edit, settings, window and h
- Arcade (YM2151 + SegaPCM 5-channel compatibility)
- Neo Geo CD (DefleMask 1.0+)
- only use this option if you really need it. there are features which DefleMask does not support, like some effects and FM macros, so these will be lost.
- **export audio...**: export your song to a .wav file. see next section for more details.
- **export VGM...**: export your song to a .vgm file. see next section for more details.
- **export ZSM...**: export your song to a .zsm file. see next section for more details.
- only available when there's a YM2151 and/or VERA.
- **export command stream...**: export song data to a command stream file. see next section for more details.
- this option is for developers.
- **add chip...**: add a chip to the current song.
- **configure chip...**: set a chip's parameters.
- for a list of parameters, see [7-systems](../7-systems/README.md).
@ -42,6 +45,7 @@ the menu bar allows you to select five menus: file, edit, settings, window and h
- **Preserve channel positions**: enable this option to make sure Furnace does not auto-arrange/delete channels to compensate for differing channel counts. this can be useful for doing ports, e.g. from Genesis to PC-98.
- **remove chip...**: remove a chip.
- **Preserve channel positions**: same thing as above.
- **restore backup**: restore a previously saved backup.
- Furnace keeps up to 5 backups of a song.
- the backup directory is located in:
@ -49,6 +53,7 @@ the menu bar allows you to select five menus: file, edit, settings, window and h
- macOS: `~/Library/Application Support/Furnace/backups`
- Linux/other: `~/.config/furnace/backups`
- this directory grows in size as you use Furnace. remember to delete old backups periodically to save space.
- **exit**: I think you know what this does.
## export audio
@ -131,6 +136,7 @@ it's not really useful, unless you're a developer and want to use a command stre
- **undo**: reverts the last action.
- **redo**: repeats what you undid previously.
- **cut**: moves the current selection in the pattern view to clipboard.
- **copy**: copies the current selection in the pattern view to clipboard.
- **paste**: inserts the clipboard's contents in the cursor position.
@ -147,11 +153,16 @@ it's not really useful, unless you're a developer and want to use a command stre
- if the selection is tall, it will select the entire column.
- if a column is already selected, it will select the entire channel.
- if a channel is already selected, it will select the entire pattern.
- **operation mask**: this is an advanced feature. see [this page](../3-pattern/opmask.md) for more information.
- **input latch**: this is an advanced feature. see [this page](../3-pattern/inputlatch.md) for more information.
- **operation mask**: toggles which columns will be affected by the listed operations. [more information here.](../8-advanced/opmask.md)
- **input latch**: determines which data are placed along with a note. [more information here.](../8-advanced/inputlatch.md)
- **note/octave up/down**: transposes notes in the current selection.
- **values up/down**: changes values in the current selection by ±1 or ±16.
- **transpose**: transpose notes or change values by a specific amount.
- **interpolate**: fills in gaps in the selection by interpolation between values.
- **change instrument**: changes the instrument number in a selection.
- **gradient/fade**: replace the selection with a "gradient" that goes from the beginning of the selection to the end.
@ -163,17 +174,22 @@ it's not really useful, unless you're a developer and want to use a command stre
- **randomize**: replaces the selection with random values.
- does not affect the note column.
- **invert values**: `00` becomes `FF`, `01` becomes `FE`, `02` becomes `FD` and so on.
- **flip selection**: flips the selection so it is backwards.
- **collapse/expand amount**: allows you to specify how much to collapse/expand in the next options.
- **collapse/expand amount**: allows you to specify how much to collapse/expand in the next two menu items.
- **collapse**: shrinks the selected contents.
- **expand**: expands the selected contents.
- **collapse pattern**: same as collapse, but affects the entire pattern.
- **expand pattern**: same as expand, but affects the entire pattern.
- **collapse song**: same as collapse, but affects the entire song.
- it also changes speeds and pattern length to compensate.
- **expand song**: same as expand, but affects the entire song.
- it also changes speeds and pattern length to compensate.
- **find/replace**: opens the Find/Replace window. see [this page](../3-pattern/find-replace.md) for more information.
- **find/replace**: shows [the Find/Replace window](../8-advanced/find-replace.md).
- **clear**: allows you to mass-delete things like songs, instruments and the like.
# settings
@ -183,44 +199,52 @@ it's not really useful, unless you're a developer and want to use a command stre
- **basic mode**: toggles [Basic Mode](basic-mode.md).
- **visualizer**: toggles pattern view particle effects when the song plays.
- **reset layout**: resets the workspace to its defaults.
- **settings...**: opens the Settings window.
- **settings...**: shows the Settings window. these are detailed in [settings.md].
# window
- **song information**: shows/hides the Song Information window.
- **subsongs**: shows/hides the Subsongs window.
- **speed**: shows/hides the Speed window.
- **instruments**: shows/hides the instrument list.
- **wavetables**: shows/hides the wavetable list.
- **samples**: shows/hides the sample list.
- **orders**: shows/hides the Orders window.
- **pattern**: shows/hides the pattern view.
- **mixer**: shows/hides the Mixer window.
- **grooves**: shows/hides the Grooves window.
- **channels**: shows/hides the Channels window.
- **pattern manager**: shows/hides the Pattern Manager window.
- **chip manager**: shows/hides the Chip Manager window.
- **compatibility flags**: shows/hides the Compatibility Flags window.
- **song comments**: shows/hides the Song Comments window.
- **instrument editor**: shows/hides the Instrument Editor.
- **wavetable editor**: shows/hides the Wavetable Editor.
- **sample editor**: shows/hides the Sample Editor.
- **play/edit controls**: shows/hides the Play/Edit Controls.
- **piano/input pad**: shows/hides the Piano/Input Pad window.
- **oscilloscope (master)**: shows/hides the oscilloscope.
- **oscilloscope (per-channel)**: shows/hides the per-channel oscilloscope.
- **volume meter**: shows/hides the volume meter.
- **clock**: shows/hides the clock.
- **register view**: shows/hides the Register View window.
- **log viewer**: shows/hides the log Viewer.
- **statistics**: shows/hides the Statistics window.
all these menu items show or hide their associated windows.
- [song information](song-info.md)
- [subsongs](song-info.md)
- [speed](song-info.md)
- [instruments](../4-instrument/README.md)
- [wavetables](../5-wave/README.md)
- [samples](../6-sample/README.md)
- [orders](order-list.md)
- [pattern](../3-pattern/README.md)
- [mixer](mixer.md)
- [grooves](grooves.md)
- [channels](channels.md)
- [pattern manager](pat-manager.md)
- [chip manager](chip-manager.md)
- [compatibility flags](compat-flags.md)
- [song comments](comments.md)
- [piano](piano.md)
- [oscilloscope](osc.md)
- [oscilloscopes (per-channel)](chanosc.md)
- [clock](clock.md)
- [register view](regview.md)
- [log viewer](log-viewer.md)
- [stats](stats.md)
# help
- **effect list**: displays the effect list.
- **debug menu**: this menu contains various debug utilities.
- unless you are working with the Furnace codebase, it's not useful.
- **inspector**: this options opens the Dear ImGui Metrics/Debugger window.
- **inspector**: this option shows the Dear ImGui Metrics/Debugger window.
- unless you are working with the Furnace codebase, it's not useful.
- **panic**: this resets all chips while the song is playing, effectively silencing everything.
- **about...**: displays the About screen.
at the end of the menu bar, more information may be shown:
- during editing, information about the data under the cursor will be shown here:
- note or note modifier.
- instrument number and name.
- volume in decimal, hex, and percentage.
- effect type and description.
- during playback, the current values of the following will be listed:\
speed/groove @ tick rate (BPM) | order | row | elapsed time.
- if any changes or edits have been made but not yet saved, "modified" will appear.

View File

@ -0,0 +1,29 @@
# order list
the order list is a playlist for patterns.
![order list](order-list.png)
along the top are the available channels. their abbreviations can be set in the [channels window](../8-advanced/channels.md). the highlighted channel follows the channel the pattern view cursor is in.
along the left are the order numbers. these are referenced with the `0Bxx` command. the highlighted row follows the order the pattern view cursor is in.
each entry in the table is the pattern that will play during that order. these can be changed according to the order edit mode.
hovering over a pattern number will pop up a tooltip showing the name of that pattern, if it has one.
The buttons are as follows:
- **Add new order**.
- **Remove order**.
- **Duplicate order**: adds a new order with patterns matching the selected one directly below it. right-click to "deep clone"; this copies all patterns involved to new ones.
- **Move order up**: swaps the selected order with the one above it.
- **Move order down**: swaps the selected order with the one below it.
- **Duplicate order at end of song**: same as "Duplicate order" except the new order is added at the bottom of the list.
- **Order change mode**: selects how much of the order will change with an edit. only applies if "Order edit mode" is set to "Click to change".
- **one**: only current channel's pattern will change.
- **entire row**: all patterns in the order will change.
- **Order edit mode**: selects the method of changing orders.
- **Click to change**: a click will add one to the pattern number. a right-click will subtract one.
- **Select and type (don't scroll)**: select a pattern and type.
- **Select and type (scroll horizontally)**: as above, but after entering two digits, the cursor moves to the next channel.
- **Select and type (scroll vertically)**: as above, but after entering two digits, the cursor moves to the next order.

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

387
doc/2-interface/settings.md Normal file
View File

@ -0,0 +1,387 @@
# settings
settings are saved when clicking the **OK** button at the bottom of the dialog.
# General
- **Workspace layout**
- **Import**: reads a .ini layout file.
- **Export**: writes current layout to a .ini file.
- **Reset**: resets layout to default.
- **Initial system**: the system of chips loaded on starting Furnace.
- **Current system**: sets current chips as default.
- **Randomize**: set default to a random system.
- this will not choose a random system at each start.
- **Reset to defaults**: sets default to "Sega Genesis/Mega Drive".
- **Name**: name for the default system. may be set to any text.
- system configuration: same as in the [chip manager](../8-advanced/chip-manager.md) and [mixer](../8-advanced/mixer.md).
- **Play intro on start-up:**
- **No**: skips intro entirely.
- **Short**: shows silent title screen briefly.
- **Full (short when loading song)**: shows animated musical intro unless started with a song (command line, double-clicking a .fur file, etc.)
- **Full (always)**: always shows animated musical intro.
- **When creating new song**:
- **Display system preset selector**
- **Start with initial system**
- **Double-click time (seconds)**: maximum time between mouse clicks to recognize them as a double-click.
- **Toggle channel solo on:** select which interactions with a channel header will toggle solo for that channel.
- **Push value when overwriting instead of clearing it**: in the order list and pattern editors, typing into an already-filled value will shift digits instead of starting fresh.
- if off: moving the cursor onto the value `A5` and typing a "B" results in `0B`.
- if on: with the cursor on the value `A5` and typing a "B" results in `5B`.
- **Move cursor up on backspace-delete**
- **Move cursor by edit step on delete**
- **Change current instrument when changing instrument column (absorb)**
- **Delete effect value when deleting effect**
- **Change order when scrolling outside of pattern bounds**:
- if off, the pattern edit cursor will stay locked within the current order.
- if on, moving the cursor past the edge of the previous or next order will move to that order.
- **Move cursor by edit step on insert (push)**
- **Move cursor to end of clipboard content when pasting**
- **Don't scroll when moving cursor**
- **Double click selects entire column**
- **Allow docking editors**
- **Don't raise pattern editor on click**
- **Focus pattern editor when selecting instrument**
- **Restart song when changing chip properties**
- **Use system file picker**: use native OS file dialog instead of Furnace's.
- **Only allow window movement when clicking on title bar**
- **Enable event delay**
- may cause issues with high-polling-rate mice when previewing notes.
- **Power-saving mode**
- saves power by lowering the frame rate to 2fps when idle.
- may cause issues under Mesa drivers!
- **Disable threaded input (restart after changing!)**
- threaded input processes key presses for note preview on a separate thread (on supported platforms), which reduces latency.
- however, crashes have been reported when threaded input is on. enable this option if that is the case.
- **Remember window position**
- remembers the window's last position on start-up.
- **New instruments are blank**
- **Save unused patterns**
- **Compress when saving**
- use zlib to compress saved songs.
- **Cursor follows current order when moving it**
- applies when playback is stopped.
- **Audio export loop/fade out time:**
- **Set to these values on start-up:**
- **Loops**: number of additional times to play through `0Bxx` song loop.
- **Fade out (seconds)**: length of fade out after final loop.
- **Remember last values**
- **Note preview behavior:**
- **Never**
- **When cursor is in Note column**
- **When cursor is in Note column or not in edit mode**
- **Always**
- **Wrap pattern cursor horizontally:**
- **No**
- **Yes**
- **Yes, and move to next/prev row**
- **Wrap pattern cursor vertically:**
- **No**
- **Yes**
- **Yes, and move to next/prev pattern**
- **Cursor movement keys behavior:**
- **Move by one**
- **Move by Edit Step**
- **Effect input cursor behavior:**
- **Move down**
- **Move to effect value (otherwise move down)**
- **Move to effect value/next effect and wrap around**
- **Allow dragging selection:**
- **No**
- **Yes**
- **Yes (while holding Ctrl only)**
# Audio/MIDI
- **Backend**: select SDL or JACK for audio output.
- only appears on Linux, or MacOS compiled with JACK support
- **Device**: audio device for playback.
- **Sample rate**
- **Outputs**: select number of audio outputs created, up to 16.
- only appears when Backend is JACK.
- **Channels**: number of output channels to use.
- **Buffer size**: size of buffer in both samples and milliseconds.
- **Quality**: selects quality of resampling. low quality reduces CPU load.
- **Metronome volume**
- **Low-latency mode (experimental!)**: reduces latency by running the engine faster than the tick rate. useful for live playback/jam mode.
- _warning:_ experimental! may produce glitches. only enable if your buffer size is small (10ms or less).
- **Force mono audio**
- **Software clipping**: clips output to nominal range (-1.0 to 1.0) before passing it to the audio device.
- this avoids activating Windows' built-in limiter.
- **want:** displays requested audio configuration.
- **got:** displays actual audio configuration returned by audio backend.
- **MIDI input**
- **MIDI output**
- **MIDI input settings**
- **Note input**
- **Velocity input**
- **Map MIDI channels to direct channels**
- **Map Yamaha FM voice data to instruments**
- **Program change is instrument selection**
- **Value input style**:
- **Disabled/custom**
- **Two octaves (0 is C-4, F is D#5)**
- **Raw (note number is value)**
- **Two octaves alternate (lower keys are 0-9, upper keys are A-F)**
- **Use dual control change (one for each nibble)**
- **CC of upper nibble**
- **CC of lower nibble**
- **Use 14-bit control change**
- **MSB CC**
- **LSB CC**
- **Use single control change**
- **Control**
- **Per-column control change**
- **Instrument**\
**Volume**\
**Effect `x` type**\
**Effect `x` value**
- **Disabled/custom**
- **Use dual control change (one for each nibble)**
- **CC of upper nibble**
- **CC of lower nibble**
- **Use 14-bit control change**
- **MSB CC**
- **LSB CC**
- **Use single control change (imprecise)**
- **Control**
- **Volume curve**
- **Actions:**
- **`+`** button: adds a new action.
- window-with-arrow button: new action with learning! press a button or move a slider/knob/something on your device.
- each action has the following:
- **Type**
- **Channel**
- **Note/Control**
- **Velocity/Value**
- **Action**
- **Learn**
- **Remove**
- **MIDI output settings**
- **Output mode:**
- **Off (use for TX81Z)**
- **Melodic**
- **Send Program Change**
- **Send MIDI clock**
- **Send MIDI timecode**
- **Timecode frame rate:**
- **Closest to Tick Rate**
- **Film (24fps)**
- **PAL (25fps)**
- **NTSC drop (29.97fps)**
- **NTSC non-drop (30fps)**
# Emulation
- **Arcade/YM2151 core**
- **ymfm**
- **Nuked-OPM**
- **Genesis/YM2612 core**
- **Nuked-OPN2**
- **ymfm**
- **SN76489 core**
- **MAME**
- **Nuked-PSG Mod**
- **NES core**
- **puNES**
- **NSFplay**
- **FDS core**
- **puNES**
- **NSFplay**
- **SID core**
- **reSID**
- **reSIDfp**
- **POKEY core**
- **Atari800 (mzpokeysnd)**
- **ASAP (C++ port)**
- **OPN/OPNA/OPNB cores**
- **ymfm only**
- **Nuked-OPN2 (FM) + ymfm (SSG/ADPCM)**
- **PC Speaker strategy:**
- **evdev SND_TONE**
- **KIOCSOUND on /dev/tty1**
- **/dev/port**
- **KIOCSOUND on standard output**
- **outb()**
- **Sample ROMs:**
- **OPL4 YRW801 path**
- **MultiPCM TG100 path**
- **MultiPCM MU5 path**
# Appearance
- **Render driver**
- **Automatic UI scaling factor**: automatically match the OS's UI scaling.
- **UI scaling factor**: only if "Automatic UI scaling factor" is off.
- **Main font**: if "Custom...", a file path selector will appear beneath.
- **Size**
- **Pattern font**: if "Custom...", a file path selector will appear beneath.
- **Size**
- **Icon size**
- **Display Japanese characters**\
**Display Chinese (Simplified) characters**\
**Display Chinese (Traditional) characters**\
**Display Korean characters**
- only toggle these options if you have enough graphics memory.
- these are a temporary solution until dynamic font atlas is implemented in Dear ImGui.
- **Number of recent files**
- **Pattern view labels:**
- **Note off (3-char)**: default is `OFF`
- **Note release (3-char)**: default is `===`.
- **Macro release (3-char)**: default is `REL`.
- **Empty field (3-char)**: default is `...`.
- **Empty field (2-char)**: default is `..`.
- **Orders row number format:**
- **Decimal**
- **Hexadecimal**
- **Pattern row number format:**
- **Decimal**
- **Hexadecimal**
- **FM parameter names:**
- **Friendly**
- **Technical**
- **Technical (alternate)**
- **Title bar:**
- **Furnace**
- **Song Name - Furnace**
- **file_name.fur - Furnace**
- **/path/to/file.fur - Furnace**
- **Display system name on title bar**
- **Display chip names instead of "multi-system" in title bar**
- **Status bar:**
- **Cursor details**
- **File path**
- **Cursor details or file path**
- **Nothing**
- **Play/edit controls layout:**
- **Classic**
- **Compact**
- **Compact (vertical)**
- **Split**
- **Position of buttons in Orders:**
- **Top**
- **Left**
- **Right**
- **FM parameter editor layout:**
- **Modern**
- **Compact (2x2, classic)**
- **Compact (1x4)**
- **Compact (4x1)**
- **Alternate (2x2)**
- **Alternate (1x4)**
- **Alternate (4x1)**
- **Position of Sustain in FM editor:**
- **Between Decay and Sustain Rate**
- **After Release Rate**
- **Macro editor layout:**
- **Unified**
- **Mobile**
- **Grid**
- **Single (with list)**
- **Single (combo box)**
- **Namco 163 chip name**
- **Channel colors:**
- **Single**
- **Channel type**
- **Instrument type**
- **Channel name colors:**
- **Single**
- **Channel type**
- **Instrument type**
- **Channel style:**
- **Classic**
- **Line**
- **Round**
- **Split button**
- **Square border**
- **Round border**
- **Channel volume bar:**
- **None**
- **Simple**
- **Stereo**
- **Real**
- **Real (stereo)**
- **Channel feedback style:**
- **Off**
- **Note**
- **Volume**
- **Active**
- **Channel font:**
- **Regular**
- **Monospace**
- **Center channel name**
- **Colorize instrument editor using instrument type**
- **Use separate colors for carriers/modulators in FM editor**
- **Unified instrument/wavetable/sample list**
- **Horizontal instrument list**
- **Use standard OPL waveform names**
- **Overflow pattern highlights**
- **Display previous/next pattern**
- **Use German notation**: display `B` notes as `H`, and `A#` notes as `B`.
- **Single-digit effects for 00-0F**
- **Center pattern view**: centers pattern horizontally in view.
- **Unsigned FM detune values**
- **Highlight channel at cursor in Orders**
- **About screen party time**
- _warning:_ may cause epileptic seizures.
- **Use compact wave editor**
- **Use classic macro editor vertical slider**
- **Rounded window corners**
- **Rounded buttons**
- **Rounded menu corners**
- **Borders around widgets**
- **Disable fade-in during start-up**
- **Oscilloscope settings:**
- **Rounded corners**
- **Fill entire window**
- **Waveform goes out of bounds**
- **Border**
- **Pattern view spacing after:**
- **Note**
- **Instrument**
- **Volume**
- **Effect**
- **Effect value**
- **Color scheme**
- **Import**
- **Export**
- **Reset defaults**
- **General**
- **Color scheme type:**
- **Dark**
- **Light**
- **Frame shading**
- several more categories...
# Keyboard
- **Import**
- **Export**
- **Reset defaults**
- several categories of keybinds...
- click on a keybind then enter a key or key combination to change it
- right-click to clear the keybind

View File

@ -11,7 +11,7 @@ All of this metadata will be included in a VGM export. This isn't the case for a
# subsongs
This window allows one to create **subsongs** multiple individual songs within a single file. Each song has its own order list and patterns, but all songs within a file share the same chips, samples, and so forth.
This window allows one to create **subsongs** - multiple individual songs within a single file. Each song has its own order list and patterns, but all songs within a file share the same chips, samples, and so forth.
- The drop-down box selects the current subsong.
- The **`+`** button adds a new subsong.

View File

@ -1,78 +1,99 @@
# effect list
most of the effect numbers are from ProTracker/FastTracker 2.
however, effects are continuous, which means you only need to type it once and then stop it with an effect value of `00`.
most of the effect numbers are from ProTracker / FastTracker 2.
- **`00xy`**: arpeggio. after using this effect the channel will rapidly switch between `note`, `note+x` and `note+y`.
- **`01xx`**: slide up.
- **`02xx`**: slide down.
- **`03xx`**: note portamento.
- a note must be present for this effect to work.
- **`04xy`**: vibrato. `x` is the speed, while `y` is the depth.
- maximum vibrato depth is ±1 semitone.
- **`07xy`**: tremolo. `x` is the speed, while `y` is the depth.
- maximum tremolo depth is -60 volume steps.
- **`08xy`**: set panning. `x` is the left channel and `y` is the right one.
- not all chips support this effect.
- **`80xx`**: set panning (linear). this effect behaves more like other trackers:
however, effects are continuous, which means you only need to type it once and then stop it with an effect value of `00` or no effect value at all.
## volume
- `0Axy`: **Volume slide.**
- If `x` is 0 then this slides volume down by `y` each tick.
- If `y` is 0 then this slides volume up by `x` each tick.
- `FAxy`: **Fast volume slide.** same as `0Axy` above but 4× faster.
- `F3xx`: **Fine volume slide up.** same as `0Ax0` but 64× slower.
- `F4xx`: **Fine volume slide down.** same as `0A0x` but 64× slower.
- `F8xx`: **Single tick volume slide up.** adds `x` to volume on first tick only.
- `F9xx`: **Single tick volume slide down.** subtracts `x` from volume on first tick only.
- `07xy`: **Tremolo.** changes volume to be "wavy" with a sine LFO. `x` is the speed. `y` is the depth.
- Tremolo is downward only.
- Maximum tremolo depth is -60 volume steps.
## pitch
- `E5xx`: **Set pitch.** `00` is -1 semitone, `80` is base pitch, `FF` is nearly +1 semitone.
- `01xx`: **Pitch slide up.**
- `02xx`: **Pitch slide down.**
- `F1xx`: **Single tick pitch slide up.**
- `F2xx`: **Single tick pitch slide down.**
- `03xx`: **Portamento.** slides the current note's pitch to the specified note. `x` is the slide speed.
- 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. default is 1.
- `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. default.
- `01`: Up only.
- `02`: Down only.
- `E4xx`: **Set vibrato range** in 1/16th of a semitone.
## panning
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.
- `81xx`: **Set volume of left channel** (from `00` to `FF`).
- `82xx`: **Set volume of right channel** (from `00` to `FF`).
- `89xx`: **Set volume of rear left channel** (from `00` to `FF`).
- `8Axx`: **Set volume of rear right channel** (from `00` to `FF`).
- `80xx`: **Set panning (linear).** this effect behaves more like other trackers:
- `00` is left.
- `80` is center.
- `FF` is right.
- not all chips support this effect.
- **`81xx`**: set volume of left channel (from `00` to `FF`).
- not all chips support this effect.
- **`82xx`**: set volume of right channel (from `00` to `FF`).
- not all chips support this effect.
- **`09xx`**: set speed 1.
- **`0Axy`**: volume slide.
- if `x` is 0 then this is a slide down.
- if `y` is 0 then this is a slide up.
- **`0Bxx`**: jump to pattern.
- **`0Cxx`**: retrigger note every `xx` ticks.
- this effect is not continuous.
- **`0Dxx`**: jump to next pattern.
- **`0Fxx`**: set speed 2.
- **`9xxx`**: set sample position to `xxx`\*0x100.
- not all chips support this effect.
## time
- **`Cxxx`**: change song Hz.
- `xxx` may be from `000` to `3ff`.
- `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.
- **`E0xx`**: set arpeggio tick.
- this sets the number of ticks between arpeggio values.
- **`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.
- **`E3xx`**: set vibrato direction. `xx` may be one of the following:
- `00`: up and down.
- `01`: up only.
- `02`: down only.
- **`E4xx`**: set vibrato range in 1/16th of a semitone.
- **`E5xx`**: set pitch. `80` is 0 cents.
- range is ±1 semitone.
- **`EAxx`**: toggle legato.
- **`EBxx`**: set sample bank.
- does not apply on Amiga.
- **`ECxx`**: note off after `xx` ticks.
- **`EDxx`**: delay note by `xx` ticks.
- **`EExx`**: send external command.
- this effect is currently incomplete.
- **`F0xx`**: change song Hz by BPM value.
- **`F1xx`**: single tick slide up.
- **`F2xx`**: single tick slide down.
- **`F3xx`**: fine volume slide up (64x slower than `0Axy`).
- **`F4xx`**: fine volume slide down (64x slower than `0Axy`).
- **`F5xx`**: disable macro.
- see macro table at the end of this document for possible values.
- **`F6xx`**: enable macro.
- **`F8xx`**: single tick volume slide up.
- **`F9xx`**: single tick volume slide down.
- **`FAxy`**: fast volume slide (4x faster than `0Axy`).
- if `x` is 0 then this is a slide down.
- if `y` is 0 then this is a slide up.
- **`FFxx`**: end of song/stop playback.
- `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. range is `01` to `FF`.
additionally each chip has its own effects. [click here for more details](../7-systems/README.md).
- `0Bxx`: **Jump to order.** `x` is the order to play after the current row.
- this marks the end of a loop with order `x` as the loop start.
- `0Dxx`: **Jump to next pattern.** skips the current row and remainder of current order.
- this can be used to shorten the current order.
- `FFxx`: **Stop song.** stops playback and ends the song. `x` is ignored.
## note
- `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.
## other
- `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.
- `F6xx`: **Enable macro.**
additionally, [each chip has its own effects](../7-systems/README.md).
## macro table
@ -98,8 +119,8 @@ ID | macro
11 | extra 6
12 | extra 7
13 | extra 8
---|-----------------------------
20 | **operator 1 macros** - AM
| | **operator 1 macros**
20 | AM
21 | AR
22 | DR
23 | MULT
@ -119,10 +140,9 @@ ID | macro
31 | VIB
32 | WS
33 | KSR
---|-----------------------------
40 | operator 2 macros
60 | operator 3 macros
80 | operator 4 macros
40 | **operator 2 macros**
60 | **operator 3 macros**
80 | **operator 4 macros**
the interpretation of duty, wave and extra macros depends on chip/instrument type:

View File

@ -1,99 +1,114 @@
# 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 chip.
- [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.
- [Namco 163](n163.md) - for use with Namco 163.
- [Konami VRC6](vrc6.md) - for use with VRC6's PSG sound source.
# macros
Macros are incredibly versatile tools for automating instrument parameters.
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
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.
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.
- 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.
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.
![macro ADSR chart](macro-ADSRchart.png)
### LFO
![LFO macro editor](macro-LFO.png)
- **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.
# 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 many different types of instrument editor:
- [FM synthesis](fm.md) - for use with YM2612, YM2151 and FM block portion of YM2610.
- [PSG](psg.md) - for use with TI SN76489 and derivatives like Sega Master System's PSG.
- [NES](nes.md) - for use with NES.
- [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 chip.
- [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.
- [Namco 163](n163.md) - for use with Namco 163.
- [Konami VRC6](vrc6.md) - for use with VRC6's PSG sound source.
- [SNES](snes.md) - for use with SNES S-APU.
- [Casio PV-1000](pv1000.md) - for use with Casio PV-1000.
# macros
Macros are incredibly versatile tools for automating instrument parameters.
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
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.
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.
- 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.
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.
![macro ADSR chart](macro-ADSRchart.png)
### LFO
![LFO macro editor](macro-LFO.png)
- **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.
# samples
This tab appears for Generic PCM, SNES, Amiga, and other sample-based instruments.
![](sample-map.png)
- **Initial Sample**: the sample that the instrument will use.
- **Use wavetable**: instead of samples, use wavetables. this causes the [Wavetables](../5-wave/README.md) tab to appear next to Sample.
- depending on the system and use of the wavetable synthesizer, this may or may not be reproducible on hardware.
- **Use sample map**: assigns a sample to each note.
- samples will be played at their default pitch.
- to set a note's sample, click the list entry in the `#` column then type the number of the sample.

View File

@ -1,4 +1,4 @@
# Amiga/PCM sound sourceinstrument editor
# Amiga/PCM sound source instrument editor
The PCM instrument editor consists of a sample selector and several macros:
@ -8,7 +8,7 @@ The PCM instrument editor consists of a sample selector and several macros:
# Macros
- **Volume**: volume sequence WARNING: it works only on Amiga system, as of version 0.5.5!!
- **Volume**: volume sequence. _warning:_ it works only on Amiga system, as of version 0.5.5!
- **Arpeggio**: pitch sequence
- **Waveform**: sample sequence
- **Panning (left)**: output level for left channel

18
doc/4-instrument/nes.md Normal file
View File

@ -0,0 +1,18 @@
# Standard instrument editor
The instrument editor for NES consists of these macros:
- **Volume**: volume.
- **Arpeggio**: pitch in half-steps.
- **Duty**: duty cycle and noise mode.
- pulse duty cycles:
- `0`: 12.5%
- `1`: 25%
- `2`: 50%
- `3`: 75%
- noise modes:
- `0`: long noise.
- `1`: short noise.
- **Panning**: output for left and right channels.
- **Pitch**: fine pitch.
- **Phase Reset**: trigger restart of waveform.

14
doc/4-instrument/psg.md Normal file
View File

@ -0,0 +1,14 @@
# PSG instrument editor
The instrument editor for PSG (SMS, MSX, and other TI SN76489 derivatives) consists of these macros:
- **Volume**: volume.
- **Arpeggio**: pitch in half-steps.
- **Duty**: noise mode.
- `0`: short noise, preset frequencies.
- `1`: long noise, preset frequencies.
- `2`: short noise, use channel 3 for frequency.
- `3`: long noise, use channel 3 for frequency.
- **Panning**: output for left and right channels.
- **Pitch**: fine pitch.
- **Phase Reset**: trigger restart of waveform.

View File

@ -0,0 +1,7 @@
# PV-1000 instrument editor
The instrument editor for the Casio PV-1000 consists of these macros:
- **Volume**: volume
- **Arpeggio**: pitch in half-steps
- **Pitch**: fine pitch

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

46
doc/4-instrument/snes.md Normal file
View File

@ -0,0 +1,46 @@
# SNES instrument editor
these tabs are unique to the editor for SNES instruments.
# SNES
**Use envelope** enables the ADSR volume envelope. if it's on:
- **A**: attack rate.
- **D**: decay rate.
- **S**: sustain level.
- **D2**: decay rate during sustain.
- **R**: release rate.
- **Sustain/release mode**:
- **Direct**: note release acts as note cut.
- **Effective (linear decrease)**: after release, volume lowers by subtractions of 1/64 steps.
- **Effective (exponential decrease)**: after release, volume decays exponentially. see [gain chart](../7-systems/snes.md).
- **Delayed (write R on release)**: after release, waits until A and D have completed before starting exponential decrease.
if envelope is off, select gain mode as described below.
# Macros
- **Volume**: volume.
- **Arpeggio**: pitch in half-steps.
- **Noise Freq**: preset frequency of noise generator.
- **Waveform**: waveform.
- **Panning (left)**: output level of left channel.
- **Panning (right)**: output level of right channel.
- **Pitch**: fine pitch.
- **Special**: bitmap of flags.
- invert left: inverts output of left channel.
- invert right: inverts output of right channel.
- pitch mod: modulates pitch using previous channel's output.
- echo: enables echo.
- noise: enables noise generator.
- **Gain**: sets mode and value of gain.
- 0 - 127: direct gain from 0 to 127
- 128 - 159: linear gain from -0 to -31
- 160 - 191: exponential gain from -0 to -31
- 192 - 223: linear gain from +0 to +31
- 224 - 255: exponential gain from +0 to +31

View File

@ -1,10 +0,0 @@
# Standard instrument editor
The instrument editor for NES and PSG (SMS, MSX, and such) consists of these macros:
- **Volume**: volume
- **Arpeggio**: pitch in half-steps
- **Duty**: duty cycle and noise mode for NES channels. _Note:_ This has no effect on Sega Master System.
- **Panning**: output for left and right channels
- **Pitch**: fine pitch
- **Phase Reset**: trigger restart of waveform

View File

@ -1,11 +1,11 @@
# X1-010 instrument editor
X1-010 instrument editor consists of 7 macros.
X1-010 instrument editor consists of these macros.
- **Volume**: volume levels sequence
- **Arpeggio**: pitch sequence
- **Waveform**: spicifies wavetables sequence
- **Waveform**: specifies wavetables sequence
- **Envelope Mode**: allows shaping an envelope
- **Envelope**: spicifies envelope shape sequence, it's also wavetable.
- **Envelope**: specifies envelope shape sequence, it's also wavetable.
- **Auto envelope numerator**: sets the envelope to the channel's frequency multiplied by numerator
- **Auto envelope denominator**: sets the envelope to the channel's frequency divided by denominator

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

View File

@ -6,7 +6,7 @@ In Furnace, these samples can be generated by importing a .wav (think of it as a
## supported chips
as of Furnace 0.6, the following sound chips have sample support:
the following sound chips have sample support:
- NES/Ricoh 2A03 (with DPCM support and only on channel 5)
- Sega Genesis/YM2612 (channel 6 only)
@ -32,6 +32,7 @@ as of Furnace 0.6, the following sound chips have sample support:
- Ensoniq OTTO/ES5506
- Yamaha PCMD8/YMZ280B
- MMC5 (last channel only)
- SNES/S-DSP
## compatible sample mode
@ -46,7 +47,7 @@ use of this mode is discouraged in favor of Sample type instruments.
due to limitations in some of those sound chips, some restrictions exist:
- Amiga: sample lengths and loop will be set to an even number, and your sample can't be longer than 131070.
- Amiga: maximum frequency is 31,469Hz, but anything over 28,867 will sound glitchy on hardware. sample lengths and loop will be set to an even number, and your sample can't be longer than 131070.
- NES: if on DPCM mode, only a limited selection of frequencies is available, and loop position isn't supported (only entire sample).
- SegaPCM: your sample can't be longer than 65535, and the maximum frequency is 31.25KHz.
- QSound: your sample can't be longer than 65535, and the loop length shall not be greater than 32767.
@ -61,12 +62,77 @@ furthermore, many of these chips have a limited amount of sample memory. check m
# the sample editor
You can actually tweak your samples in Furnace's sample editor, which can be accessed by clicking on `window` (at the top of the screen) then clicking on `sample editor`.
you can actually tweak your samples in Furnace's sample editor, which can be accessed by clicking on `window` (at the top of the screen) then clicking on `sample editor`.
In there, you can modify certain data pertaining to your sample, such as the:
the changes you make will be applied as soon as you've committed them to your sample, but they can be undone and redone, just like text.
in there, you can modify certain data pertaining to your sample, such as the:
- volume of the sample in percentage, where 100% is the current level of the sample (note that you can distort it if you put it too high)
- the sample rate.
- what frequencies to filter, along with filter level/sweep and resonance options (much like the C64)
- and many more.
The changes you make will be applied as soon as you've committed them to your sample, but they can be undone and redoed, just like text.
![sample editor](sample-editor.png)
- top-left drop-down box: sample slot.
- **Open**: replaces current sample.
- **Save**: saves current sample to disk.
- **Name**: name in sample list.
- button to left of **Info**: collapses and expands the info bar.
- **Type**: sample format. only 8-bit and 16-bit PCM samples are editable. selecting a format converts the sample data.
- **BRR emphasis**: boosts higher frequencies to compensate for the SNES low-pass filter. should not be enabled for BRR-type samples.
- **Rate**: switches to normal rate values.
- **Compat Rate**: switches to DefleMask-compatible rate values for sample mapping.
- **Hz**: base frequency of sample played at `C-4`.
- **Note**: note corresponding to Hz.
- **Fine**: fine tuning. ranges from -64 to 63, which maps to -1 to almost +1 semitone.
- **Loop**: enable or disable sample loop. only on supported chips.
- **Mode**: direction of loop. backward and ping pong loops are only natively available on some chips; on others, loop will be automatically unrolled as needed.
- **Start**: start of loop.
- **End**: end of loop.
- **Chips:** set assignment to chips and sample banks.
- sample will only be uploaded to selected chips.
- columns correspond to chips in use.
- rows correspond to sample banks.
![sample editor button bar](sample-editor-buttons.png)
- **Edit mode: Select**: cursor selects portion of sample.
- **Edit mode: Draw**: cursor draws over wave.
- **Resize**: stretches sample. pops up a dialog to type new length.
- **Resample**: stretches sample. pops up a dialog box:
- **Rate**: new sample rate.
- **0.5x**: halves sample rate.
- **==**: returns to original sample rate.
- **2.0x**: doubles sample rate.
- **Factor**: multiplier of original sample rate.
- **Filter**: selects interpolation filter for resampling.
- **Undo**: undoes previous edit.
- **Redo**: redoes undone edit.
- **Amplify**: changes amplitude of selection. pops up a dialog to type amount.
- **Normalize**: adjusts amplitude of selection to maximum without clipping.
- **Fade in**: ramp amplitude of selection from 0 to original.
- **Fade in**: ramp amplitude of selection from original to 0.
- **Insert silence**: inserts silence. pops up a dialog to type length.
- **Apply silence**: reduces amplitude of selection to 0.
- **Delete**: removes selection.
- **Trim**: removes all but selection.
- **Reverse**: reverses direction of selection.
- **Invert**: flips selection "vertically".
- **Signed/unsigned exchange**: reinterprets selection data as being of the opposite sign. if a sample sounds fine elsewhere but is distorted on import, it may have been interpreted as signed when it should be unsigned, or vice versa; this will correct that.
- **Apply filter**: filters the selection. pops up a dialog box:
- **From**: filter cutoff frequency at start of selection.
- **To**: filter cutoff frequency at end of selection.
- **Resonance**: emphasizes frequencies around filter cutoff.
- **Power**: number of times resonance is applied.
- **Low-pass**: amount to attenuate everything above cutoff.
- **Band-pass**: amount to attenuate everything outside cutoff.
- **High-pass**: amount to attenuate everything below cutoff.
- **Preview sample**: plays sample at base frequency.
- **Stop sample preview**: stops preview.
- **Create instrument from sample**: creates a new instrument with its initial sample set to the current sample.
- **Zoom**: shows and sets sample view zoom level.
- **Zoom mode**: switches between "Auto" (entire sample fits in window) and "100%" (each horizontal pixel represents one sample point).

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 192 KiB

View File

@ -6,6 +6,7 @@ this is a list of sound chips that Furnace supports, including effects.
- [AY-3-8910](ay8910.md)
- [Microchip AY8930](ay8930.md)
- [Bubble System WSG](bubblesystem.md)
- [Casio PV-1000](pv1000.md)
- [Commodore 64](c64.md)
- [Commodore PET](pet.md)
- [Commodore VIC-20](vic20.md)
@ -26,6 +27,7 @@ this is a list of sound chips that Furnace supports, including effects.
- [PC Engine/TurboGrafx-16](pce.md)
- [PC Speaker](pcspkr.md)
- [Philips SAA1099](saa1099.md)
- [Pokémon mini](pokemini.md)
- [Capcom QSound](qsound.md)
- [Ricoh RF5C68](ricoh.md)
- [SegaPCM](segapcm.md)

View File

@ -4,12 +4,20 @@ a computer with a desktop OS, lifelike graphics and 4 channels of PCM sound in 1
in this very computer music trackers were born...
imported MOD files use this chip, and will set A-4 tuning to 436.
# 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.
# info
- the maximum rate for sample playback is technically 31469Hz but anything higher than 28867Hz will sound glitchy on hardware.
- sample lengths and loop will be set to an even number.
- samples can't be longer than 131070.

View File

@ -6,41 +6,52 @@ it is a 3-channel square/noise/envelope sound generator. the chip's powerful sou
the AY-3-8914 variant was used in Intellivision, which is pretty much an AY with 4 level envelope volume per channel and different register format.
as of Furnace 0.6pre7, AY-3-8910 supports software sample playback, where all 3 channels can play 4-bit PCM samples (at the cost of a very high CPU usage)
# 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.
# chip config
## AY derivative modes
AY-3-810 was an absurdly popular chip that was blessed with many third-party clones, licensed or not.
- the AY-3-8914 variant was used in Intellivision, which is pretty much an 8910 with 4 level envelope volume per channel and different register format.
- Yamaha YM2149 was an AY-3-8910 clone released in 1983. it's almost identical to AY with minor differences being: higher hardware envelope step resolution (16 vs 32), half-clock mode when voltage level is low, much stronger DC offset and cleaner, but softer output.
- Sunsoft 5B is YM2149 clone with half-clock mode forced on.

View File

@ -3,52 +3,54 @@
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.
as of Furnace 0.6pre7, AY8930 supports software PCM, where all 3 channels can play 5-bit PCM samples (at the cost of a very high CPU usage)
# 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.

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.**

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`.

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.**

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

View File

@ -2,17 +2,27 @@
the Nintendo Game Boy is one of the most successful portable game systems ever made.
with stereo sound, two pulse channels, a wave channel and a noise one it packed some serious punch.
with stereo sound, two pulse channels, a wave channel and a noise channel, it packed some serious punch.
# 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.
# links
- [Gameboy sound hardware](https://gbdev.gg8.se/wiki/articles/Gameboy_sound_hardware) - detailed technical information
- [GameBoy Sound Table](http://www.devrs.com/gb/files/sndtab.html) - note frequency table

View File

@ -6,32 +6,56 @@ 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.
# system modes
## extended channel 3
in ExtCh mode, channel 3 is split into one column for each of its four operators. feedback and LFO levels are shared. the frequency of each operator may be controlled independently with notes and effects. this can be used for more polyphony or more complex sounds.
all four operators are still combined according to the algorithm in use. for example, algorithm 7 acts as four independent sine waves. algorithm 4 acts as two independent 2op sounds. even with algorithm 0, placing a note in any operator triggers that operator alone.
## CSM
CSM is short for "Composite Sinusoidal Modeling". CSM works by sending key-on and key-off commands to channel 3 at a specific frequency, controlled by the added "CSM Timer" channel. this can be used to create vocal formants (speech synthesis!) or other complex effects.
CSM is beyond the scope of this documentation. for more information, see this [brief SSG-EG and CSM video tutorial](https://www.youtube.com/watch?v=IKOR0TUlnWU).
## DualPCM
[info here.](ym2612.md)
## Sega CD
this isn't a mode so much as a chip configuration. it adds the [Ricoh RF5C68](ricoh.md) found in the Sega CD add-on, providing 8 channels of PCM.

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.

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.

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.

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.

View File

@ -1,7 +1,20 @@
# OKI MSM6258
a single-channel ADPCM sound source developed by OKI. it allows max sample rate of 15.6 KHz... with no variable pitch. most prominent use of this chip was Sharp X68000 computer, where it was paired with Yamaha YM2151.
Furnace's implementation is MSM6258V, a CPU driven variant that is unlimited by amount of sample data, being able to be fed from the system's RAM.
# effects
...
# chip config
## chip clock rates
MSM6258 is an extremely basic ADPCM sound codec. it has no variable frequency rate; it depends on clock rate of a chip itself. Furnace supports following rates:
| clock rate | sampling rate |
|--------------------|---------------|
| 4 MHz | 7812 Hz |
| 4.096 MHz | 8000 Hz |
| 8 MHz | 15625 Hz |
| 8.192 MHz | 16000 Hz |

View File

@ -1,7 +1,33 @@
# 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...). Without bankswitching, the chip supports 256kB of sample RAM and can hold up to 127 samples at once.
# effects
- **`20xx`**: set chip output rate.
- `20xx`: **set chip output rate.**
# chip config
## chip clock rates
like MSM6258, MSM295 is an extremely basic ADPCM sound codec. it has no variable frequency rate, it depends on clock rate of a chip itself. Furnace supports following rates:
| clock rate | sampling rate |
|--------------------|---------------|
| 1 MHz | 7576 Hz |
| 1.02 MHz | 7727 Hz |
| 1.056 MHz | 8000 Hz |
| 1.193 MHz | 9038 Hz |
| 0.89 MHz | 6742 Hz |
| 0.875 MHz | 6629 Hz |
| 0.9375 MHz | 7102 Hz |
| 1.5 MHz | 11364 Hz |
| 1.79 MHz | 13561 Hz |
| 2 MHz | 15152Hz |
| 2.112 MHz | 16000 Hz |
| 3 MHz | 22728 Hz |
| 3.58 MHz | 27122 Hz |
| 4 MHz | 30304 Hz |
| 4.224 MHz | 32000 Hz |
## chip clock divisor
MSM6295 clock rate could be divided by 132 (resulting sample rates above), or by 165. To get a clock rate using divisor of 165, formula is clock rate (in Hz) / 165. Example: 1 MHz MSM6295 in 165 divisor mode results in output rate of 6060 Hz.

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.

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.

View File

@ -6,30 +6,37 @@ 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.** range is `00` to `7F`.
- this may be used to attenuate the triangle and noise channels; at `7F`, they will be at about 57% volume.
- 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:
- `0`: 12.5%
- `1`: 25%
- `2`: 50%
- `3`: 75%
- may be `0` or `1` for the noise channel:
- `0`: long (15-bit LFSR, 32767-step)
- `1`: short (9-bit LFSR, 93-step)
- `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,73 +45,137 @@ 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
# tables
val | NTSC | PAL
----|-----------|-----------
00 | 4181.7Hz | 4177.4Hz
01 | 4709.9Hz | 4696.6Hz
02 | 5264.0Hz | 5261.4Hz
03 | 5593.0Hz | 5579.2Hz
04 | 6257.9Hz | 6023.9Hz
05 | 7046.3Hz | 7044.9Hz
06 | 7919.3Hz | 7917.2Hz
07 | 8363.4Hz | 8397.0Hz
08 | 9419.9Hz | 9446.6Hz
09 | 11186.1Hz | 11233.8Hz
0A | 12604.0Hz | 12595.5Hz
0B | 13982.6Hz | 14089.9Hz
0C | 16884.6Hz | 16965.4Hz
0D | 21306.8Hz | 21315.5Hz
0E | 24858.0Hz | 25191.0Hz
0F | 33143.9Hz | 33252.1Hz
## short noise frequencies (NTSC)
# length counter table
note | arpeggio | fundamental | MIDI note | pitch
:---- | -------: | ----------: | --------: | :----------
`C-0` | @0 | 4.7 Hz | -9.47 | `d_1` + 53¢
`C#0` | @1 | 9.5 Hz | 2.53 | `D-0` + 53¢
`D-0` | @2 | 18.9 Hz | 14.55 | `D-1` + 55¢
`D#0` | @3 | 25.3 Hz | 19.53 | `G-1` + 53¢
`E-0` | @4 | 37.9 Hz | 26.55 | `D-2` + 55¢
`F-0` | @5 | 50.6 Hz | 31.57 | `G-2` + 57¢
`F#0` | @6 | 75.8 Hz | 38.55 | `D-3` + 55¢
`G-0` | @7 | 95.3 Hz | 42.51 | `F#3` + 51¢
`G#0` | @8 | 120.3 Hz | 46.55 | `A#3` + 55¢
`A-0` | @9 | 150.4 Hz | 50.41 | `D-4` + 41¢
`A#0` | @10 | 200.5 Hz | 55.39 | `G-4` + 39¢
`B-0` | @11 | 300.7 Hz | 62.41 | `D-5` + 41¢
`C-1` | @12 | 601.4 Hz | 74.41 | `D-6` + 41¢
`C#1` | @13 | 1202.8 Hz | 86.41 | `D-7` + 41¢
`D-1` | @14 | 2405.6 Hz | 98.41 | `D-8` + 41¢
`D#1` | @15 | 4811.2 Hz | 110.41 | `D-9` + 41¢
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
03 | 2 | 17ms | 20ms | 17ms | 21ms | 25ms | 21ms
04 | 40 | 333ms | 400ms | 336ms | 417ms | 500ms | 421ms
05 | 4 | 33ms | 40ms | 34ms | 42ms | 50ms | 42ms
06 | 80 | 667ms | 800ms | 673ms | 833ms | 1.0s | 841ms
07 | 6 | 50ms | 60ms | 50ms | 63ms | 75ms | 63ms
08 | 160 | 1.3s | 1.6s | 1.3s | 1.7s | 2.0s | 1.7s
09 | 8 | 67ms | 80ms | 67ms | 83ms | 100ms | 84ms
0A | 60 | 500ms | 600ms | 505ms | 625ms | 750ms | 631ms
0B | 10 | 83ms | 100ms | 84ms | 104ms | 125ms | 105ms
0C | 14 | 117ms | 140ms | 118ms | 146ms | 175ms | 147ms
0D | 12 | 100ms | 120ms | 101ms | 125ms | 150ms | 126ms
0E | 26 | 217ms | 260ms | 219ms | 271ms | 325ms | 273ms
0F | 14 | 117ms | 140ms | 118ms | 145ms | 175ms | 147ms
10 | 12 | 100ms | 120ms | 101ms | 125ms | 150ms | 126ms
11 | 16 | 133ms | 160ms | 135ms | 167ms | 200ms | 168ms
12 | 24 | 200ms | 240ms | 202ms | 250ms | 300ms | 252ms
13 | 18 | 150ms | 180ms | 151ms | 188ms | 225ms | 189ms
14 | 48 | 400ms | 480ms | 404ms | 500ms | 600ms | 505ms
15 | 20 | 167ms | 200ms | 168ms | 208ms | 250ms | 210ms
16 | 96 | 800ms | 960ms | 807ms | 1.0s | 1.2s | 1.0s
17 | 22 | 183ms | 220ms | 185ms | 229ms | 275ms | 231ms
18 | 192 | 1.6s | 1.9s | 1.6s | 2.0s | 2.4s | 2.0s
19 | 24 | 200ms | 240ms | 202ms | 250ms | 300ms | 252ms
1A | 72 | 600ms | 720ms | 606ms | 750ms | 900ms | 757ms
1B | 26 | 217ms | 260ms | 219ms | 271ms | 325ms | 273ms
1C | 16 | 133ms | 160ms | 135ms | 167ms | 200ms | 168ms
1D | 28 | 233ms | 280ms | 235ms | 292ms | 350ms | 294ms
1E | 32 | 267ms | 320ms | 269ms | 333ms | 400ms | 336ms
1F | 30 | 250ms | 300ms | 252ms | 313ms | 375ms | 315ms
reference: [NESdev](https://www.nesdev.org/wiki/APU_Noise)
## length counter table
<!-- organized by input value... of little use -->
<!--
value | 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
`03` | 2 | 17ms | 20ms | 17ms | 21ms | 25ms | 21ms
`04` | 40 | 333ms | 400ms | 336ms | 417ms | 500ms | 421ms
`05` | 4 | 33ms | 40ms | 34ms | 42ms | 50ms | 42ms
`06` | 80 | 667ms | 800ms | 673ms | 833ms | 1.0s | 841ms
`07` | 6 | 50ms | 60ms | 50ms | 63ms | 75ms | 63ms
`08` | 160 | 1.3s | 1.6s | 1.3s | 1.7s | 2.0s | 1.7s
`09` | 8 | 67ms | 80ms | 67ms | 83ms | 100ms | 84ms
`0A` | 60 | 500ms | 600ms | 505ms | 625ms | 750ms | 631ms
`0B` | 10 | 83ms | 100ms | 84ms | 104ms | 125ms | 105ms
`0C` | 14 | 117ms | 140ms | 118ms | 146ms | 175ms | 147ms
`0D` | 12 | 100ms | 120ms | 101ms | 125ms | 150ms | 126ms
`0E` | 26 | 217ms | 260ms | 219ms | 271ms | 325ms | 273ms
`0F` | 14 | 117ms | 140ms | 118ms | 145ms | 175ms | 147ms
`10` | 12 | 100ms | 120ms | 101ms | 125ms | 150ms | 126ms
`11` | 16 | 133ms | 160ms | 135ms | 167ms | 200ms | 168ms
`12` | 24 | 200ms | 240ms | 202ms | 250ms | 300ms | 252ms
`13` | 18 | 150ms | 180ms | 151ms | 188ms | 225ms | 189ms
`14` | 48 | 400ms | 480ms | 404ms | 500ms | 600ms | 505ms
`15` | 20 | 167ms | 200ms | 168ms | 208ms | 250ms | 210ms
`16` | 96 | 800ms | 960ms | 807ms | 1.0s | 1.2s | 1.0s
`17` | 22 | 183ms | 220ms | 185ms | 229ms | 275ms | 231ms
`18` | 192 | 1.6s | 1.9s | 1.6s | 2.0s | 2.4s | 2.0s
`19` | 24 | 200ms | 240ms | 202ms | 250ms | 300ms | 252ms
`1A` | 72 | 600ms | 720ms | 606ms | 750ms | 900ms | 757ms
`1B` | 26 | 217ms | 260ms | 219ms | 271ms | 325ms | 273ms
`1C` | 16 | 133ms | 160ms | 135ms | 167ms | 200ms | 168ms
`1D` | 28 | 233ms | 280ms | 235ms | 292ms | 350ms | 294ms
`1E` | 32 | 267ms | 320ms | 269ms | 333ms | 400ms | 336ms
`1F` | 30 | 250ms | 300ms | 252ms | 313ms | 375ms | 315ms
-->
<!-- organized by resulting times... more useful! -->
value | raw | NTSC | PAL | Dendy | NTSC 5-step | PAL 5-step | Dendy 5-step
-----:|----:|------:|------:|------:|------------:|-----------:|-------------:
`03` | 2 | 17ms | 20ms | 17ms | 21ms | 25ms | 21ms
`05` | 4 | 33ms | 40ms | 34ms | 42ms | 50ms | 42ms
`07` | 6 | 50ms | 60ms | 50ms | 63ms | 75ms | 63ms
`09` | 8 | 67ms | 80ms | 67ms | 83ms | 100ms | 84ms
`00` | 10 | 83ms | 100ms | 84ms | 104ms | 125ms | 105ms
`0B` | 10 | 83ms | 100ms | 84ms | 104ms | 125ms | 105ms
`0D` | 12 | 100ms | 120ms | 101ms | 125ms | 150ms | 126ms
`10` | 12 | 100ms | 120ms | 101ms | 125ms | 150ms | 126ms
`0C` | 14 | 117ms | 140ms | 118ms | 146ms | 175ms | 147ms
`0F` | 14 | 117ms | 140ms | 118ms | 145ms | 175ms | 147ms
`1C` | 16 | 133ms | 160ms | 135ms | 167ms | 200ms | 168ms
`11` | 16 | 133ms | 160ms | 135ms | 167ms | 200ms | 168ms
`13` | 18 | 150ms | 180ms | 151ms | 188ms | 225ms | 189ms
`02` | 20 | 166ms | 200ms | 168ms | 208ms | 250ms | 210ms
`15` | 20 | 167ms | 200ms | 168ms | 208ms | 250ms | 210ms
`17` | 22 | 183ms | 220ms | 185ms | 229ms | 275ms | 231ms
`12` | 24 | 200ms | 240ms | 202ms | 250ms | 300ms | 252ms
`19` | 24 | 200ms | 240ms | 202ms | 250ms | 300ms | 252ms
`0E` | 26 | 217ms | 260ms | 219ms | 271ms | 325ms | 273ms
`1B` | 26 | 217ms | 260ms | 219ms | 271ms | 325ms | 273ms
`1D` | 28 | 233ms | 280ms | 235ms | 292ms | 350ms | 294ms
`1F` | 30 | 250ms | 300ms | 252ms | 313ms | 375ms | 315ms
`1E` | 32 | 267ms | 320ms | 269ms | 333ms | 400ms | 336ms
`04` | 40 | 333ms | 400ms | 336ms | 417ms | 500ms | 421ms
`14` | 48 | 400ms | 480ms | 404ms | 500ms | 600ms | 505ms
`0A` | 60 | 500ms | 600ms | 505ms | 625ms | 750ms | 631ms
`1A` | 72 | 600ms | 720ms | 606ms | 750ms | 900ms | 757ms
`06` | 80 | 667ms | 800ms | 673ms | 833ms | 1.0s | 841ms
`16` | 96 | 800ms | 960ms | 807ms | 1.0s | 1.2s | 1.0s
`08` | 160 | 1.3s | 1.6s | 1.3s | 1.7s | 2.0s | 1.7s
`18` | 192 | 1.6s | 1.9s | 1.6s | 2.0s | 2.4s | 2.0s
`01` | 254 | 2.1s | 2.5s | 2.1s | 2.6s | 3.2s | 2.7s
reference: [NESdev](https://www.nesdev.org/wiki/APU_Length_Counter)
## DPCM frequency table
value | NTSC | PAL
------|----------:|----------:
`00` | 4181.7Hz | 4177.4Hz
`01` | 4709.9Hz | 4696.6Hz
`02` | 5264.0Hz | 5261.4Hz
`03` | 5593.0Hz | 5579.2Hz
`04` | 6257.9Hz | 6023.9Hz
`05` | 7046.3Hz | 7044.9Hz
`06` | 7919.3Hz | 7917.2Hz
`07` | 8363.4Hz | 8397.0Hz
`08` | 9419.9Hz | 9446.6Hz
`09` | 11186.1Hz | 11233.8Hz
`0A` | 12604.0Hz | 12595.5Hz
`0B` | 13982.6Hz | 14089.9Hz
`0C` | 16884.6Hz | 16965.4Hz
`0D` | 21306.8Hz | 21315.5Hz
`0E` | 24858.0Hz | 25191.0Hz
`0F` | 33143.9Hz | 33252.1Hz

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.

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.

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.**

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).

View File

@ -8,4 +8,4 @@ some of these didn't even have sound...
# effects
- **`10xx`**: set waveform. `xx` is a bitmask.
- `10xx`: **set waveform.** `xx` is a bitmask.

View File

@ -0,0 +1,7 @@
# Pokémon Mini
the Pokémon Mini is a ridiculously small handheld system from 2001. its single pulse channel has only three volume steps (full, half, and off)... but variable pulse width.
# effects
none.

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.

7
doc/7-systems/pv1000.md Normal file
View File

@ -0,0 +1,7 @@
# Casio PV-1000
released only in Japan, this console was pulled after only a few weeks on the market. it has only 3 square waves with 6-bit pitch resolution and no bass.
# effects
- `10xx`: **set ring modulation.** amplitude modulation by the previous channel's output. `0` turns it off and `1` turns it on.

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.**

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.

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.**

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.

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.

View File

@ -1,17 +1,31 @@
# 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.
# chip config
## SN7 versions
SN7 was extremely popular due to low cost. Therefore, it was cloned and copied to no end, often with minor differences between each other. Furnace supports several of these:
- SN94624, can only produce tones as low as 100Hz, and is clocked at 447 KHz.
- SN76494, which can play notes as low as 13.670 Hz (A -1). It has a different noise feedback and invert masks.
- SN76489, identical to SN94624, just without a clock divider
- SN76489A, identical to 76494, just with a /8 clock divider
- SN76496, literally identical to former. Why is it even here?
- SN76496 with a Atari-like short noise. The chip of many legend and rumours, might be a result of inaccurate emulation.
- Sega Master System VDP version has a different, characteristic noise LFSR.
- Game Gear SN7, identical to the above, but with stereo
- NCR8496, different noise invert masks
- PSSJ3, literally identical to the former, it just swaps "high" and "low" signals in the output, which results in no audible difference
TODO: all these checkboxes

View File

@ -1,8 +1,8 @@
# Super Nintendo Entertainment System (SNES)/Super Famicom
# Super Nintendo Entertainment System (SNES) / Super Famicom
the successor to NES to compete with Genesis, packing superior graphics and sample-based audio.
its audio system, developed by Sony, features a DSP chip, SPC700 CPU and 64KB of dedicated SRAM used by both.
its Sony-developed audio system features a DSP chip, SPC700 CPU, and 64KB of dedicated SRAM used by both.
this whole system itself is pretty much a separate computer that the main CPU needs to upload its program and samples to.
Furnace communicates with the DSP directly and provides a full 64KB of memory. this memory might be reduced excessively on ROM export to make up for playback engine and pattern data. you can go to window > statistics to see how much memory your samples are using.
@ -22,60 +22,156 @@ 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.
- 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.
- this is a signed number.
- 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.
- this is a signed number.
- 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.
- this is a signed number.
- 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.
- this does not affect echo.
- **`1Fxx`**: set right dry/global volume.
- this does not affect echo.
- **`20xx`**: set attack (0 to F).
- only in ADSR envelope mode.
- **`21xx`**: set decay (0 to 7).
- only in ADSR envelope mode.
- **`22xx`**: set sustain (0 to 7).
- only in ADSR envelope mode.
- **`23xx`**: set release (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.
- `10xx`: **set waveform.**
- `11xx`: **toggle noise mode.**
- `12xx`: **toggle echo on this channel.**
- `13xx`: **toggle pitch modulation.** frequency modulation by the previous channel's output. no effect on channel 1.
- `14xy`: **toggle inverting the left or right channels.** `x` is left, `y` is right.
- `15xx`: **set envelope mode.** see gain chart below for `1` through `5`.
- `0`: ADSR mode.
- `1`: gain (direct). volume holds at one level.
- `2`: linear decrement. volume lowers by subtractions of 1/64.
- `3`: exponential decrement. volume lowers by multiplications of 255/256.
- `4`: linear increment. volume rises by additions of 1/64.
- `5`: bent line (inverse log) increment. volume rises by additions of 1/64 until 3/4, then additions of 1/256.
- `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.**\
`1Bxx`: **set right echo channel volume.**\
`1Cxx`: **set echo feedback.**
- 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.
- setting these to -128 is not recommended as it may cause echo output to overflow and therefore click.
- `1Dxx`: **set noise generator frequency.** range is `00` to `1F`. see noise frequencies chart below.
- `1Exx`: **set left dry / global volume.**\
`1Fxx`: **set right dry / global volume.**
- these do not affect echo.
- `20xx`: **set attack.** range is `0` to `F`.\
`21xx`: **set decay.** range is `0` to `7`.\
`22xx`: **set sustain.** range is `0` to `7`.\
`23xx`: **set release.** range is `00` to `1F`.
- these four are only used in ADSR envelope mode. see ADSR chart below.
- `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.
- _Note:_ Be sure the sum of all coefficients is between -128 and 127. sums outside that may result in overflow and therefore clicking.
- see [SnesLab](https://sneslab.net/wiki/FIR_Filter) for a full explanation and examples.
# tables
## ADSR
| attack | 0→1 time | decay | 1→S time | sustain | ratio | release | S→0 time
| -----: | -------: | ----: | -------: | ------: | :---: | ------: | -------:
| `00` | 4.1s | `00` | 1.2s | `00` | 1/8 | `00` | ∞
| `01` | 2.5s | `01` | 740ms | `01` | 2/8 | `01` | 38s
| `02` | 1.5s | `02` | 440ms | `02` | 3/8 | `02` | 28s
| `03` | 1.0s | `03` | 290ms | `03` | 4/8 | `03` | 24s
| `04` | 640ms | `04` | 180ms | `04` | 5/8 | `04` | 19s
| `05` | 380ms | `05` | 110ms | `05` | 6/8 | `05` | 14s
| `06` | 260ms | `06` | 74ms | `06` | 7/8 | `06` | 12s
| `07` | 160ms | `07` | 37ms | `07` | 1 | `07` | 9.4s
| `08` | 96ms | | | | | `08` | 7.1s
| `09` | 64ms | | | | | `09` | 5.9s
| `0A` | 40ms | | | | | `0A` | 4.7s
| `0B` | 24ms | | | | | `0B` | 3.5s
| `0C` | 16ms | | | | | `0C` | 2.9s
| `0D` | 10ms | | | | | `0D` | 2.4s
| `0E` | 6ms | | | | | `0E` | 1.8s
| `0F` | 0ms | | | | | `0F` | 1.5s
| | | | | | | `10` | 1.2s
| | | | | | | `11` | 880ms
| | | | | | | `12` | 740ms
| | | | | | | `13` | 590ms
| | | | | | | `14` | 440ms
| | | | | | | `15` | 370ms
| | | | | | | `16` | 290ms
| | | | | | | `17` | 220ms
| | | | | | | `18` | 180ms
| | | | | | | `19` | 150ms
| | | | | | | `1A` | 110ms
| | | | | | | `1B` | 92ms
| | | | | | | `1C` | 74ms
| | | | | | | `1D` | 55ms
| | | | | | | `1E` | 37ms
| | | | | | | `1F` | 18ms
reference: [Super Famicom Development Wiki](https://wiki.superfamicom.org/spc700-reference#dsp-voice-register:-adsr-1097)
## gain
value | linear inc. | bent line inc. | linear dec. | exponent dec.
----: | ----------: | -------------: | ----------: | ------------:
`00` | ∞ | ∞ | ∞ | ∞
`01` | 4.1s | 7.2s | 4.1s | 38s
`02` | 3.1s | 5.4s | 3.1s | 28s
`03` | 2.6s | 4.6s | 2.6s | 24s
`04` | 2.0s | 3.5s | 2.0s | 19s
`05` | 1.5s | 2.6s | 1.5s | 14s
`06` | 1.3s | 2.3s | 1.3s | 12s
`07` | 1.0s | 1.8s | 1.0s | 9.4s
`08` | 770ms | 1.3s | 770ms | 7.1s
`09` | 640ms | 1.1s | 640ms | 5.9s
`0A` | 510ms | 900ms | 510ms | 4.7s
`0B` | 380ms | 670ms | 380ms | 3.5s
`0C` | 320ms | 560ms | 320ms | 2.9s
`0D` | 260ms | 450ms | 260ms | 2.4s
`0E` | 190ms | 340ms | 190ms | 1.8s
`0F` | 160ms | 280ms | 160ms | 1.5s
`10` | 130ms | 220ms | 130ms | 1.2s
`11` | 96ms | 170ms | 96ms | 880ms
`12` | 80ms | 140ms | 80ms | 740ms
`13` | 64ms | 110ms | 64ms | 590ms
`14` | 48ms | 84ms | 48ms | 440ms
`15` | 40ms | 70ms | 40ms | 370ms
`16` | 32ms | 56ms | 32ms | 290ms
`17` | 24ms | 42ms | 24ms | 220ms
`18` | 20ms | 35ms | 20ms | 180ms
`19` | 16ms | 28ms | 16ms | 150ms
`1A` | 12ms | 21ms | 12ms | 110ms
`1B` | 10ms | 18ms | 10ms | 92ms
`1C` | 8ms | 14ms | 8ms | 74ms
`1D` | 6ms | 11ms | 6ms | 55ms
`1E` | 4ms | 7ms | 4ms | 37ms
`1F` | 2ms | 3.5ms | 2ms | 18ms
reference: [Super Famicom Development Wiki](https://wiki.superfamicom.org/spc700-reference#dsp-voice-register:-gain-1156)
## noise frequencies
value | freq. | value | freq.
----: | -----: | ----: | -------:
`00` | 0 Hz | `10` | 500 Hz
`01` | 16 Hz | `11` | 667 Hz
`02` | 21 Hz | `12` | 800 Hz
`03` | 25 Hz | `13` | 1.0 KHz
`04` | 31 Hz | `14` | 1.3 KHz
`05` | 42 Hz | `15` | 1.6 KHz
`06` | 50 Hz | `16` | 2.0 KHz
`07` | 63 Hz | `17` | 2.7 KHz
`08` | 83 Hz | `18` | 3.2 KHz
`09` | 100 Hz | `19` | 4.0 KHz
`0A` | 125 Hz | `1A` | 5.3 KHz
`0B` | 167 Hz | `1B` | 6.4 KHz
`0C` | 200 Hz | `1C` | 8.0 KHz
`0D` | 250 Hz | `1D` | 10.7 KHz
`0E` | 333 Hz | `1E` | 16 KHz
`0F` | 400 Hz | `1F` | 32 KHz
reference: [Super Famicom Development Wiki](https://wiki.superfamicom.org/spc700-reference#dsp-register:-flg-1318)
# resources
- [SNES-format BRR samples](https://www.smwcentral.net/?p=stion&s=brrsamples) at SMW Central

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`.

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.

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

View File

@ -7,9 +7,11 @@ 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`.
- `EExx`: **ZSM synchronization event.**
- Where `xx` is the event payload. This has no effect in how the music is played in Furnace, but the ZSMKit library for the Commander X16 interprets these events inside ZSM files and optionally triggers a callback routine. This can be used, for instance, to cause game code to respond to beats or at certain points in the music.

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`.

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.

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.**

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.

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.

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.**

View File

@ -11,91 +11,97 @@ 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.**
# system modes
## extended channel 3
in ExtCh mode, channel 3 is split into one column for each of its four operators and feedback are shared. the frequency of each operator may be controlled independently with notes and effects. this can be used for more polyphony or more complex sounds.
all four operators are still combined according to the algorithm in use. for example, algorithm 7 acts as four independent sine waves. algorithm 4 acts as two independent 2op sounds. even with algorithm 0, placing a note in any operator triggers that operator alone.

View File

@ -2,32 +2,32 @@
like YM2203, but with twice the FM channels, stereo, an ADPCM channel and built-in drums ("rhythm")!
it was one of the available sound chips for the NEC PC-88VA and PC-98 series of computers.
it was one of the available sound chips for the NEC PC-88VA and later models of PC-98 series of computers.
the YM2610 (OPNB) and YM2610B chips are very similar to this one, but the built-in drums have been replaced with 6 sample channels.
# 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,72 @@ 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.**
# system modes
## extended channel 3
in ExtCh mode, channel 3 is split into one column for each of its four operators. feedback and LFO levels are shared. the frequency of each operator may be controlled independently with notes and effects. this can be used for more polyphony or more complex sounds.
all four operators are still combined according to the algorithm in use. for example, algorithm 7 acts as four independent sine waves. algorithm 4 acts as two independent 2op sounds. even with algorithm 0, placing a note in any operator triggers that operator alone.

View File

@ -2,73 +2,73 @@
originally an arcade board, but SNK shortly adapted it to a rather expensive video game console with the world's biggest cartridges because some people liked the system so much they wanted a home version of it.
its soundchip is a 4-in-1: 4ch 4-op FM, YM2149 (AY-3-8910 clone) and 2 different format ADPCM in a single package!
its soundchip is a 4-in-1: 4ch 4-op FM, YM2149 (AY-3-8910 clone) and [2 different format ADPCM](https://wiki.neogeodev.org/index.php?title=ADPCM) in a single package!
# 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,27 @@ 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.**
# system modes
## extended channel 2
in ExtCh mode, channel 2 is split into one column for each of its four operators. feedback and LFO levels are shared. the frequency of each operator may be controlled independently with notes and effects. this can be used for more polyphony or more complex sounds.
all four operators are still combined according to the algorithm in use. for example, algorithm 7 acts as four independent sine waves. algorithm 4 acts as two independent 2op sounds. even with algorithm 0, placing a note in any operator triggers that operator alone.

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,72 @@ 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.**
# system modes
## extended channel 3
in ExtCh mode, channel 3 is split into one column for each of its four operators. feedback and LFO levels are shared. the frequency of each operator may be controlled independently with notes and effects. this can be used for more polyphony or more complex sounds.
all four operators are still combined according to the algorithm in use. for example, algorithm 7 acts as four independent sine waves. algorithm 4 acts as two independent 2op sounds. even with algorithm 0, placing a note in any operator triggers that operator alone.

View File

@ -1,67 +1,68 @@
# 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, a Z80 driver that splits channel 6 into two individual PCM channels with variable pitch. using the console's Z80 processor, these are mixed together in software and streamed to channel 6 in PCM mode with a mix rate of 13750 Hz. VGM export requires the "direct stream mode" option to be enabled, and resulting files will be very large.
# 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.**

View File

@ -2,7 +2,10 @@
rather than having a dedicated sound synthesizer, early ZX Spectrum models had one piezo beeper, controlled by Z80 CPU and ULA chip. its capabilities should be on par with an IBM PC speaker... right?
not really - very soon talented programmers found out ways to output much more than one square wave channel. a lot of ZX beeper routines do exist, but as of 0.6 Furnace supports only a Follin/SFX-like engine with 6 channels of narrow pulse wave and click drums.
not really - very soon talented programmers found out ways to output much more than one square wave channel. a lot of ZX beeper routines do exist, but as of 0.6 Furnace supports two engines:
- a Follin/SFX-like engine with 6 channels of narrow pulse wave and click drums.
- QuadTone: PWM-driven engine with 4ch of pulse wave with freely variable duty cycles and 1-bit PCM drums.
# effects

Some files were not shown because too many files have changed in this diff Show More