From 6e3c8273be15749f6216fae1423dbce8da5db897 Mon Sep 17 00:00:00 2001 From: Electric Keet Date: Sat, 7 Dec 2024 18:51:59 -0800 Subject: [PATCH] Docs: Small additions. "Bit depth" to the glossary, "Song Comments > Wrap text" to the settings, and a groove calculator link to grooves. --- doc/1-intro/glossary.md | 3 +++ doc/2-interface/settings.md | 4 ++++ doc/8-advanced/grooves.md | 4 +--- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/1-intro/glossary.md b/doc/1-intro/glossary.md index 47255ab4a..437b17669 100644 --- a/doc/1-intro/glossary.md +++ b/doc/1-intro/glossary.md @@ -16,6 +16,9 @@ **bitbang**: to achieve PCM sound by sending a rapid stream of volume commands to a non-PCM channel. +**bit depth**: the number of bits used for each sample in a PCM stream. 16-bit is considered high quality; lower bit depths introduce more noise and distortion, especially for quieter samples. +- the "1-bit DPCM" sample type has 6-bit amplitude resolution, but each sample is represented by only 1 bit indicating whether its amplitude differs from the previous sample by one step up or down. + **bitmask**: a set of bits which represent individual single-bit toggles or groups representing small numbers. these are explained fully in the [hexadecimal primer](hex.md). **BRR**: a lossy sample format used by the SNES. it has a fixed compression ratio; groups of 32 bytes (16 samples) are encoded in 9 bytes each. diff --git a/doc/2-interface/settings.md b/doc/2-interface/settings.md index c0d8dd855..2230c34e1 100644 --- a/doc/2-interface/settings.md +++ b/doc/2-interface/settings.md @@ -558,6 +558,10 @@ below all the binds, select a key from the dropdown list to add it. it will appe - **Fill entire window**: removes the gap between the waveform and the edge of the window. - **Waveform goes out of bounds**: allows the waveform to draw past the top and bottom of the oscilloscope. +### Song Comments + +- **Wrap text**: visually breaks long lines at the width of the text box. does not affect the text itself. + ### Windows - **Rounded window corners** diff --git a/doc/8-advanced/grooves.md b/doc/8-advanced/grooves.md index 3f566a7de..dc516226b 100644 --- a/doc/8-advanced/grooves.md +++ b/doc/8-advanced/grooves.md @@ -20,9 +20,7 @@ a single `09xx` command will switch to the matching numbered groove pattern. ## tempo -this is a non-exhaustive list of grooves and their equivalent tempo in BPM. - -note: this table assumes a song's tick rate setting is left at its default value for the chosen engine speed: 60 for NTSC, or 50 for PAL. +this is a non-exhaustive list of grooves and their equivalent tempo in BPM when using NTSC or PAL tick rates (60 or 50) and row highlight values of 4 and 16. for more accurate tempos, differing tick rates, or differing row highlight values, use the [groove calculator](https://pineight.com/ft/calcgroove.html) (courtesy of Damian Yerrick). BPM NTSC | BPM PAL | groove | | BPM NTSC | BPM PAL | groove --------:|--------:|:-----------------------|-|---------:|--------:|:----------------------