Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | 38x 38x 38x 38x 38x 38x 3x 3x 38x 3x 38x 38x 38x 460x 450x 10x 10x 38x 458x 4x 38x 459x 38x 459x 38x 3x 3x 38x 4x 1x 3x 1x 2x 38x 9x 1x 8x 2x 2x 2x 2x 2x 6x 38x 2x 38x 38x 38x 38x | import { InstrumentType } from "shared/lib/music/types";
import { PatternCell } from "shared/lib/uge/types";
import clamp from "shared/lib/helpers/clamp";
import { OCTAVE_SIZE, TRACKER_NUM_CHANNELS } from "consts";
import l10n from "shared/lib/lang/l10n";
/** Note name labels indexed by semitone within an octave (C through B). */
export const noteName = [
"C-",
"C#",
"D-",
"D#",
"E-",
"F-",
"F#",
"G-",
"G#",
"A-",
"A#",
"B-",
];
/**
* Get localised channel name
*/
export const getL10NChannelName = (channelId: 0 | 1 | 2 | 3): string => {
if (channelId === 0) {
return l10n("FIELD_CHANNEL_DUTY_1");
} else if (channelId === 1) {
return l10n("FIELD_CHANNEL_DUTY_2");
} else if (channelId === 2) {
return l10n("FIELD_CHANNEL_WAVE");
} else {
return l10n("FIELD_CHANNEL_NOISE");
}
};
/**
* Calculates BPM from a ticks-per-row value.
*/
export const getBPM = (ticksPerRow: number): number => {
const BPM_FACTOR = (64 * 60) / 4;
return BPM_FACTOR / ticksPerRow;
};
/**
* Derives a visually distinct HSL hue (0-360) for a pattern by index.
* Uses the golden-angle increment so adjacent patterns have different hues.
*/
export const patternHue = (index: number): number =>
((index + 1) * 137.5) % 360;
/**
* Derives a visually distinct gradient for a pattern by index.
* If pattern is filtered provides a greyscale gradient
*/
export const patternGradient = (
index: number,
isFiltered: boolean,
flat?: boolean,
): string =>
isFiltered
? `linear-gradient(0deg, hsl(0deg 0% 50%) 0%, hsl(0deg 0% 60%) 100%)`
: `linear-gradient(0deg, hsl(${patternHue(index)}deg 100% 70%) 0%, hsl(${patternHue(index)}deg 100% ${flat ? "80" : "90"}%) 100%)`;
export const patternBorder = (index: number, isFiltered: boolean): string =>
isFiltered
? `hsl(0deg 0% 50% / 30%)`
: `hsl(${patternHue(index)}deg 80% 50% / 30%)`;
/**
* Renders a note number as a tracker display string (e.g. `"C-4"`, `"A#5"`).
* Returns `"..."` when note is null.
*/
export const renderNote = (note: number | null): string => {
if (note === null) {
return "...";
}
const octave = ~~(note / 12) + 3;
return `${noteName[note % 12]}${octave}`;
};
/**
* Renders an instrument index as a zero-padded 2-digit string (1-based, e.g. `"01"`, `"16"`).
* Returns `".."` when instrument is null.
*/
export const renderInstrument = (instrument: number | null): string => {
if (instrument === null) return "..";
return (instrument + 1).toString().padStart(2, "0") || "..";
};
/**
* Renders an effect code as an uppercase hex character (e.g. `"A"`, `"F"`).
* Returns `"."` when effectCode is null.
*/
export const renderEffect = (effectCode: number | null): string => {
return effectCode?.toString(16).toUpperCase() || ".";
};
/**
* Renders an effect parameter as a zero-padded 2-digit uppercase hex string (e.g. `"0F"`, `"FF"`).
* Returns `".."` when effectParam is null.
*/
export const renderEffectParam = (effectParam: number | null): string => {
return effectParam?.toString(16).toUpperCase().padStart(2, "0") || "..";
};
/**
* Wraps a note value to the valid note range (0–71) using modulo arithmetic.
* Handles negative values correctly.
*/
export const wrapNote = (note: number): number => {
const TOTAL_NOTES = 72;
return ((note % TOTAL_NOTES) + TOTAL_NOTES) % TOTAL_NOTES;
};
/**
* Maps a GB channel ID to its instrument type.
* Channels 0 and 1 are duty, channel 2 is wave, channel 3 is noise.
*/
export const channelIdToInstrumentType = (
channelId: 0 | 1 | 2 | 3,
): InstrumentType => {
if (channelId === 2) {
return "wave";
}
if (channelId === 3) {
return "noise";
}
return "duty";
};
/**
* Transposes a note value by `noteDelta` semitones, clamped to the valid range (0–71).
* When transposing by a full octave, keeps the note within its octave class boundaries.
* Returns null unchanged.
*/
export const transposeNoteValue = (
note: number | null,
noteDelta: number,
): number | null => {
if (note === null) {
return note;
}
if (Math.abs(noteDelta) === OCTAVE_SIZE) {
const noteClass = note % OCTAVE_SIZE;
const min = noteClass;
const max =
noteClass + Math.floor((71 - noteClass) / OCTAVE_SIZE) * OCTAVE_SIZE;
const next = note + noteDelta;
return clamp(next, min, max);
}
return clamp(note + noteDelta, 0, 71);
};
/**
* Renders a full pattern cell as a compact display object for debugging or logging.
* Returns an object with string representations of each field.
*/
export const renderPatternCell = (
cell: PatternCell,
): { note: string; instrument: string; effect: string; param: string } => ({
note: renderNote(cell.note),
instrument: renderInstrument(cell.instrument),
effect: renderEffect(cell.effectCode),
param: renderEffectParam(cell.effectParam),
});
/**
* Convert raw pattern index to pattern block index where patterns are in blocks of 4 by channel
*/
export const patternBlockIndex = (patternIndex: number): number =>
Math.floor(patternIndex / TRACKER_NUM_CHANNELS);
/**
* Convert raw pattern index to pattern block channel offset
*/
export const patternBlockOffset = (patternIndex: number): number =>
patternIndex % TRACKER_NUM_CHANNELS;
/**
* Convert raw pattern index to pattern labels
* when not split just returns block index e.g. patternIndex=9 label=02
* when split includes channel index e.g. patternIndex=9 label=02.1
*/
export const patternIndexLabel = (
patternIndex: number,
splitPattern: boolean,
): string => {
const blockIndex = patternBlockIndex(patternIndex);
const blockLabel = String(blockIndex).padStart(2, "0");
Iif (!splitPattern) {
return blockLabel;
}
const blockOffset = patternBlockOffset(patternIndex);
const offsetLabel = splitPattern ? `.${blockOffset}` : "";
return `${blockLabel}${offsetLabel}`;
};
/**
* Convert row index to two digit display value e.g. rowIndex=5 label=05
*/
export const rowIndexLabel = (rowIndex: number) =>
String(rowIndex).padStart(2, "0");
|