diff --git a/doc/2-interface/effect-list-window.md b/doc/2-interface/effect-list-window.md index 35c738387..268cb02cc 100644 --- a/doc/2-interface/effect-list-window.md +++ b/doc/2-interface/effect-list-window.md @@ -7,7 +7,7 @@ this window provides a list of the effects that are available. for more details about these effects, see [the effects page](../3-pattern/effects.md). - **Chip at cursor**: the currently selected chip. the list only shows available effects for this chip. -- filter bar: type to filter the list to show only matching effects. +- filter bar: search for effects. - menu button: opens a small list of effect categories. toggle each to change whether effects belonging to such categories will be shown in the list. - **All**: show all effects. - - **None**: show no effects. + - **None**: don't show any effects. diff --git a/doc/2-interface/export.md b/doc/2-interface/export.md index 8e6abc390..c54e72edd 100644 --- a/doc/2-interface/export.md +++ b/doc/2-interface/export.md @@ -4,42 +4,44 @@ Furnace allows you to export your song in several formats. this section deals wi ## audio -this option allows you to export your song in .wav format. I know I know, no .mp3 or .ogg export yet, but you can use a converter. +this option allows you to export your song to another audio format. - **Export type**: - **one file**: exports your song to a single file. - - **multiple files (one per chip)**: exports the output of each chip to its own file. - - **multiple files (one per channel)**: exports the output of each channel to its own file. + - **multiple files (one per chip)**: exports the output of each chip to separate files. + - **multiple files (one per channel)**: exports the output of each channel to separate files. - ideal for use with a channel visualizer such as [corrscope](https://github.com/corrscope/corrscope). -- **File Format**: select the output format. each format has its own options. +- **File Format**: select the output file format. each format has its own options. - **Wave**: lossless uncompressed .wav format. largest file size but perfect quality. most useful for files that will need further editing. - **Bit depth**: default is 16-bit integer. + - integer formats should be supported by all players, but are clipped to -1.0/+1.0 range. + - float formats are supported by most software players and have infinite range, but take more space. - **Sample rate**: affects the quality of the output file. - default is 44100, "CD quality". - lower sample rates lose fidelity as upper frequencies disappear. - higher sample rates gain frequencies that can't be heard at the cost of file size and rendering time. - - **Channels in file**: default is 2 (stereo). Set to 1 for mono. - - **Opus**: lossy compressed .opus format. smaller size than either MP3 or Vorbis for better quality sound, but less common support than other formats. - - **Channels in file**: default is 2 (stereo). Set to 1 for mono. - - **Bit rate**: higher numbers generate better quality sound and larger file size. default is 128000. + - **Channels in file**: default is 2 (stereo). set to 1 for mono. + - **Opus**: modern lossy compressed .ogg format. better audio quality than MP3 or Vorbis. not supported by all players, especially Apple devices. + - **Channels in file**: default is 2 (stereo). set to 1 for mono. + - **Bit rate**: higher numbers result in better quality sound at the cost of larger file size. default is 128000. - **FLAC (Free Lossless Audio Codec)**: lossless compressed .flac format. good for archival or editing, as it preserves original sound data. - **Sample rate**: affects the quality of the output file. see above. - - **Channels in file**: default is 2 (stereo). Set to 1 for mono. + - **Channels in file**: default is 2 (stereo). set to 1 for mono. - **Compression level**: higher levels take slightly longer to pack but yield much better compression. default is 6.0. - - **Vorbis**: lossy compressed .ogg format. better quality sound than MP3 with smaller file size. fairly common support + - **Vorbis**: lossy compressed .ogg format. better quality sound than MP3 with smaller file size. fairly common support except for Apple devices. - **Sample rate**: affects the quality of the output file. see above. - - **Channels in file**: default is 2 (stereo). Set to 1 for mono. + - **Channels in file**: default is 2 (stereo). set to 1 for mono. - **Quality**: compression rate. higher numbers produce larger files of higher fidelity. default is 8.0. - - **MP3**: lossy compressed .mp3 format. it's the old standard; worst quality for the file size, but it sees the most widespread support and use. + - **MP3**: lossy compressed .mp3 format. an old standard for compressed audio; it enjoys widespread support but has poor quality. - **Sample rate**: affects the quality of the output file. see above. - - **Channels in file**: default is 2 (stereo). Set to 1 for mono. + - **Channels in file**: default is 2 (stereo). set to 1 for mono. - **Bit rate mode**: - **Constant**: fixed bit rate regardless of content. default. - - **Bit rate**: higher numbers generate better quality sound and larger file size. default is 128000. - - **Variable**: bit rate adapts to the content. generates smaller files for the same quality. + - **Bit rate**: higher numbers result in better quality sound at the cost of larger file size. default is 128000. + - **Variable**: bit rate adapts to the content. generates smaller files for the same quality. not all players support this mode. - **Quality**: higher numbers produce larger files of higher fidelity. default is 6.0. - - **Average**: a compromise; the steady bit rate of "constant" with higher quality, but less efficiently compressed than "variable". - - **Bit rate**: higher numbers generate better quality sound and larger file size. default is 128000. + - **Average**: a compromise; the steady bit rate of "constant" with higher quality, but less efficiently compressed than "variable". not all players support this mode. + - **Bit rate**: higher numbers result in better quality sound at the cost of larger file size. default is 128000. - **Loops**: sets the number of times the song will loop. - does not have effect if the song ends with `FFxx` effect. - **Fade out (seconds)**: sets the fade out time when the song is over. diff --git a/doc/2-interface/play-edit-controls.md b/doc/2-interface/play-edit-controls.md index 733158a26..951213616 100644 --- a/doc/2-interface/play-edit-controls.md +++ b/doc/2-interface/play-edit-controls.md @@ -14,7 +14,7 @@ the "Play/Edit Controls" are used to control playback and change parameters of t - polyphony toggle: cycles through the following options. - **Mono**: monophony. preview one note at a time only. - **Poly**: polyphony. preview multiple notes at once, using other channels of the same type on the same chip. default. - - **Chord**: chord input. as polyphony, with the added feature that while keys are held, notes past the first are entered on the same row in adjacent channels. + - **Chord**: chord input. same as polyphony, with the added feature that while keys are held, notes past the first are entered on the same row in adjacent channels. - some keyboards have limits on the number of keys that can be held at the same time. this is not a Furnace issue. - **Octave**: sets current input octave. - **Edit Step**: sets edit step. if this is 1, entering a note or effect will move to the next row. if this is a larger number, rows will be skipped. if this is 0, the cursor will stay in place. diff --git a/doc/2-interface/settings.md b/doc/2-interface/settings.md index fb7804559..25e0e6f65 100644 --- a/doc/2-interface/settings.md +++ b/doc/2-interface/settings.md @@ -95,7 +95,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o ### Import - **Use OPL3 instead of OPL2 for S3M import**: changes which system is used for the import of S3M files that contain FM channels. -- **Load sample fine tuning when importing a sample**: as it says. may result in glitches with some samples. +- **Load sample fine tuning when importing a sample**: if the file has note tuning information, it will be loaded. may result in glitches with some samples. ## Audio @@ -105,7 +105,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o - SDL: the default one. - JACK: the JACK Audio Connection Kit (low-latency audio server). only appears on Linux, or MacOS compiled with JACK support. - PortAudio: this may or may not perform better than the SDL backend. - - ASIO: Audio Stream Input/Output. extremely low latency, if your system has a driver for it. after selecting it, click "Apply" to see available devices. + - ASIO: Audio Stream Input/Output. low latency, if your system has a driver for it. after selecting it, click "Apply" to see available devices. - **Control Panel**: opens the ASIO driver's control panel. you must first select a device and click "Apply". - **Driver**: select a different audio driver if you're having problems with the default one. - only appears when Backend is SDL. diff --git a/doc/6-sample/README.md b/doc/6-sample/README.md index cef846130..1c8e82a32 100644 --- a/doc/6-sample/README.md +++ b/doc/6-sample/README.md @@ -127,7 +127,7 @@ in there, you can modify certain data pertaining to your sample, such as the: - **Filter**: selects interpolation filter for resampling. - **Undo**: undoes previous edit. - **Redo**: redoes undone edit. -- **Amplify/Offset**: pops up a dialog to enter amounts. +- **Amplify/Offset**: allows you to change amplitude of selection or offset it. - **Volume**: amplifies selection. - **DC Offset**: shifts selection up (positive values) or down (negative values). - **Normalize**: adjusts amplitude of selection to maximum without clipping. @@ -172,6 +172,6 @@ in the sample viewer: - **create wavetable from selection**: copies the selection into a new wavetable entry. in the bottom status bar: -- **Select**: set selection start and end positions using the two numeric entry boxes. total selection length will be shown next to them. +- **Select**: set selection start and end positions. total selection length will be shown next to them. - cursor position and sample value. - loop size in samples and bytes. diff --git a/doc/7-systems/pce.md b/doc/7-systems/pce.md index 6c72f9e15..92bdc7ad3 100644 --- a/doc/7-systems/pce.md +++ b/doc/7-systems/pce.md @@ -36,5 +36,5 @@ the following icons are displayed when channel status is enabled in the pattern the following options are available in the Chip Manager window: - **Pseudo-PAL**: run the chip on a PAL clock. such a configuration has (probably) never existed, despite a planned official PAL version of the PC Engine. -- **Disable anti-click**: waveform switching requires a phase reset, which may cause clicks. Furnace uses a wave-position predicting algorithm to minimize these clicks. enable this option to turn off the feature. +- **Disable anti-click**: waveform switching requires a phase reset, which may cause clicks. Furnace uses a wave-position predicting algorithm to minimize these clicks. check this option to disable the feature. - **Chip revision**: sets the chip revision. HuC6280A has less pops. diff --git a/doc/7-systems/watarasv.md b/doc/7-systems/watarasv.md index 876f996ce..168088621 100644 --- a/doc/7-systems/watarasv.md +++ b/doc/7-systems/watarasv.md @@ -16,6 +16,7 @@ this chip uses the [Watara Supervision](../4-instrument/watarasv.md) and [Generi ### sample info the sample channel is a 4-bit DMA channel with 4 playback frequencies (1953.125, 3906.25, 7812.5, and 15625) assigned to the notes C, C#, D, and D# in all octaves. +- note that these frequencies will differ if a custom clock rate is used. max sample size is 4 kilobytes (8192 samples), samples are padded to multiples of 32 samples, and loop points are ignored. diff --git a/doc/8-advanced/channels-swap.png b/doc/8-advanced/channels-swap.png new file mode 100644 index 000000000..46925f76d Binary files /dev/null and b/doc/8-advanced/channels-swap.png differ diff --git a/doc/8-advanced/channels.md b/doc/8-advanced/channels.md index ecf19330e..07692bd8d 100644 --- a/doc/8-advanced/channels.md +++ b/doc/8-advanced/channels.md @@ -7,7 +7,7 @@ the "Channels" dialog allows manipulation of the song's channels. each channel has the following options: - **Pat**: uncheck the box to hide the channel from the pattern view. pattern data will be kept. - **Osc**: uncheck the box to hide the channel from the per-channel oscilloscope view. -- crossed arrows buttons: click and drag to rearrange pattern data throughout the song. +- ![crossed arrow button](channels-swap.png): click and drag to rearrange pattern data throughout the song. shift-click and drag to copy pattern data. - note: this does **not** move channels around! it only moves the channel's pattern data. - **Name**: the name displayed at the top of each channel in the pattern view. - the next setting is "short name", which is displayed in the orders view and/or when a channel is collapsed.