refactor: 波形ピーク関連の型・変数名を変更

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

Author: sigprogramming

src/components/Sing/SequencerWaveform.vue

@@ -13,9 +13,9 @@ import { useMounted } from "@/composables/useMounted";
 import { tickToBaseX, type ViewportInfo } from "@/sing/viewHelper";
 import { secondToTick, tickToSecond } from "@/sing/music";
 import {
-  generateWaveformPeaks,
+  generateWaveformPeaksMipmap,
   resamplePeaks,
-  type WaveformPeaks,
+  type WaveformPeaksMipmap,
 } from "@/sing/waveformPeaks";
 import { Mutex } from "@/helpers/mutex";
 import { createLogger } from "@/helpers/log";
@@ -99,13 +99,15 @@ const audioEvents = computed<ReadonlyMap<AudioEventId, AudioEvent>>(() => {
   return events;
 });
 
-// AudioBufferから算出した波形ピークのMap
-const peaksMap = ref<ReadonlyMap<AudioEventId, WaveformPeaks>>(new Map());
+// AudioBufferから算出した波形ピークmipmapのMap
+const peaksMipmaps = ref<ReadonlyMap<AudioEventId, WaveformPeaksMipmap>>(
+  new Map(),
+);
 
-const updatePeaksMap = () => {
+const updatePeaksMipmaps = () => {
   const audioEventsValue = audioEvents.value;
 
-  const tempMap = new Map(peaksMap.value);
+  const tempMap = new Map(peaksMipmaps.value);
 
   // 不要なキーを削除
   for (const eventId of tempMap.keys()) {
@@ -114,16 +116,16 @@ const updatePeaksMap = () => {
     }
   }
 
-  // 新規キーについてpeaksを生成
+  // 新規キーについてpeaksMipmapを生成
   // NOTE: sequenceIdに対応するAudioBufferは不変なので、既存キーの再計算は不要
   for (const [eventId, event] of audioEventsValue) {
     if (!tempMap.has(eventId)) {
       // mipmapの最小のバケツサイズは、最大ズーム時にも解像度が足りる 16 を採用
-      tempMap.set(eventId, generateWaveformPeaks(event.buffer, 16));
+      tempMap.set(eventId, generateWaveformPeaksMipmap(event.buffer, 16));
     }
   }
 
-  peaksMap.value = tempMap;
+  peaksMipmaps.value = tempMap;
 };
 
 // 描画用の波形データのMap
@@ -136,7 +138,7 @@ const waveformDataMutex = new Mutex({ maxPending: 1 });
 
 const computeWaveformData = (
   event: AudioEvent,
-  peaks: WaveformPeaks,
+  peaksMipmap: WaveformPeaksMipmap,
   scaleXValue: number,
   temposValue: readonly Tempo[],
   tpqnValue: number,
@@ -167,7 +169,10 @@ const computeWaveformData = (
     );
   }
 
-  const { minValues, maxValues } = resamplePeaks(peaks, pixelBoundarySamples);
+  const { minValues, maxValues } = resamplePeaks(
+    peaksMipmap,
+    pixelBoundarySamples,
+  );
 
   return {
     startX: startScreenXAtZeroOffset,
@@ -179,7 +184,7 @@ const computeWaveformData = (
 
 const updateWaveformDataMap = async () => {
   const audioEventsValue = audioEvents.value;
-  const peaksMapValue = peaksMap.value;
+  const peaksMipmapsValue = peaksMipmaps.value;
   const scaleXValue = scaleX.value;
   // NOTE: Tempoが型レベルでイミュータブルになっていないので、cloneしている
   const temposValue = cloneWithUnwrapProxy(tempos.value);
@@ -212,10 +217,10 @@ const updateWaveformDataMap = async () => {
   // 新規キーについて描画用の波形データを計算
   for (const [key, { eventId, event }] of keyedEvents) {
     if (!tempMap.has(key)) {
-      const peaks = getOrThrow(peaksMapValue, eventId);
+      const peaksMipmap = getOrThrow(peaksMipmapsValue, eventId);
       const waveformData = computeWaveformData(
         event,
-        peaks,
+        peaksMipmap,
         scaleXValue,
         temposValue,
         tpqnValue,
@@ -232,13 +237,13 @@ const { mounted } = useMounted();
 // NOTE: mountedをwatchしているので、onMountedの直後に必ず１回実行される
 watch([mounted, audioEvents], ([mountedValue]) => {
   if (mountedValue) {
-    updatePeaksMap();
+    updatePeaksMipmaps();
   }
 });
 
 // NOTE: mountedをwatchしているので、onMountedの直後に必ず１回実行される
 watch(
-  [mounted, audioEvents, peaksMap, scaleX, tempos, tpqn],
+  [mounted, audioEvents, peaksMipmaps, scaleX, tempos, tpqn],
   async ([mountedValue]) => {
     if (mountedValue) {
       try {

src/sing/waveformPeaks.ts

@@ -11,7 +11,7 @@ import { getLast } from "@/sing/utility";
 /**
  * mipmapのレベル。バケツサイズと、各バケツのmin/max値を保持する。
  */
-type WaveformMipmapLevel = {
+type WaveformPeaksMipmapLevel = {
   readonly bucketSize: number;
   readonly minBuckets: Float32Array;
   readonly maxBuckets: Float32Array;
@@ -21,7 +21,7 @@ type WaveformMipmapLevel = {
  * 波形ピークのmipmap。
  * 先頭のレベルが最も細かいレベルで、以降はバケツサイズの昇順に並ぶ。
  */
-export type WaveformPeaks = readonly WaveformMipmapLevel[];
+export type WaveformPeaksMipmap = readonly WaveformPeaksMipmapLevel[];
 
 /**
  * 波形ピークをリサンプルしたもの。
@@ -38,10 +38,10 @@ export type ResampledPeaks = {
  * @param minBucketSize 最小のバケツサイズ。1以上の整数でなければならない。
  * @returns 生成されたピークのmipmap。レベルはバケツサイズで昇順にソートされている。
  */
-export function generateWaveformPeaks(
+export function generateWaveformPeaksMipmap(
   audioBuffer: AudioBuffer,
   minBucketSize: number,
-): WaveformPeaks {
+): WaveformPeaksMipmap {
   if (!Number.isInteger(minBucketSize) || minBucketSize < 1) {
     throw new Error("minBucketSize must be a positive integer.");
   }
@@ -72,7 +72,7 @@ export function generateWaveformPeaks(
     baseMaxBuckets[bucketIndex] = max;
   }
 
-  const levels: WaveformMipmapLevel[] = [
+  const levels: WaveformPeaksMipmapLevel[] = [
     {
       bucketSize: minBucketSize,
       minBuckets: baseMinBuckets,
@@ -116,7 +116,7 @@ export function generateWaveformPeaks(
  * 各区間に対応するサンプル範囲を境界配列で指定して、ピークをリサンプルする。
  * 区間ごとに最適なmipmapレベルを選択するため、サンプル幅が不均等でも適切な解像度になる。
  *
- * @param peaks リサンプル元のピークmipmap。
+ * @param peaksMipmap リサンプル元のピークmipmap。
  *   レベルはバケツサイズで昇順にソートされていなければならない。
  * @param binBoundarySamples 各区間の境界をサンプル位置で表した配列。
  *   `binBoundarySamples[i]` 以上 `binBoundarySamples[i + 1]` 未満が区間 `i` のサンプル範囲。
@@ -127,23 +127,25 @@ export function generateWaveformPeaks(
  * @returns 各区間のmin/max値。
  */
 export function resamplePeaks(
-  peaks: WaveformPeaks,
+  peaksMipmap: WaveformPeaksMipmap,
   binBoundarySamples: number[],
 ): ResampledPeaks {
-  if (peaks.length === 0) {
-    throw new Error("peaks must have at least one level.");
+  if (peaksMipmap.length === 0) {
+    throw new Error("peaksMipmap must have at least one level.");
   }
-  for (const level of peaks) {
+  for (const level of peaksMipmap) {
     if (level.minBuckets.length !== level.maxBuckets.length) {
       throw new Error("minBuckets and maxBuckets must have the same length.");
     }
     if (level.minBuckets.length === 0) {
       throw new Error("every level must have at least one bucket.");
     }
   }
-  for (let i = 1; i < peaks.length; i++) {
-    if (peaks[i].bucketSize <= peaks[i - 1].bucketSize) {
-      throw new Error("peaks levels must be in ascending order of bucketSize.");
+  for (let i = 1; i < peaksMipmap.length; i++) {
+    if (peaksMipmap[i].bucketSize <= peaksMipmap[i - 1].bucketSize) {
+      throw new Error(
+        "peaksMipmap levels must be in ascending order of bucketSize.",
+      );
     }
   }
   if (binBoundarySamples.length < 2) {
@@ -165,8 +167,8 @@ export function resamplePeaks(
     }
     // bucketSize <= samplesPerBin を満たす最大の bucketSize のレベルを選ぶ
     // どのレベルも条件を満たさないときは、最も細かいレベルを使う
-    let selectedLevel = peaks[0];
-    for (const level of peaks) {
+    let selectedLevel = peaksMipmap[0];
+    for (const level of peaksMipmap) {
       if (level.bucketSize > samplesPerBin) {
         break;
       }