All files / jianpu-renderer/core/layout MeasureLayoutEngine.ts

0% Statements 0/438
0% Branches 0/1
0% Functions 0/1
0% Lines 0/438

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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
/**
 * 小节布局引擎
 * 
 * @description 计算小节宽度和音符X坐标(固定时间比例算法)
 * 
 * 核心算法:
 * - 小节宽度 = (拍数 / 单位拍 × 4) × 四分音符间距 + 左右padding
 * - 音符X坐标 = 小节起始X + 左padding + 时间戳 × 单位间距
 * 
 * 固定时间比例原则:
 * - 同一拍号的所有小节宽度完全相同
 * - 音符间距严格按时值比例分配
 * - 二分音符间距是四分音符的2倍
 * - 八分音符间距是四分音符的0.5倍
 */

import { JianpuMeasure } from '../../models/JianpuMeasure';
import { JianpuNote } from '../../models/JianpuNote';
import { RenderConfig, DEFAULT_RENDER_CONFIG } from '../config/RenderConfig';

// ==================== 类型定义 ====================

/** 小节布局配置 */
export interface MeasureLayoutConfig {
  /** 四分音符的基准间距(像素) */
  quarterNoteSpacing: number;
  /** 小节左右padding(像素) */
  measurePadding: number;
  /** 最小音符间距(像素,防止音符重叠) */
  minNoteSpacing: number;
  /** 音符字体大小(像素,用于计算音符宽度) */
  noteFontSize: number;
}

/** 小节布局结果 */
export interface MeasureLayoutResult {
  /** 小节索引 */
  measureIndex: number;
  /** 小节起始X坐标 */
  x: number;
  /** 小节宽度 */
  width: number;
  /** 内容宽度(不含padding) */
  contentWidth: number;
  /** 音符位置数组 */
  notePositions: NotePosition[];
}

/** 音符位置 */
export interface NotePosition {
  /** 音符ID */
  noteId: string;
  /** X坐标 */
  x: number;
  /** 音符宽度 */
  width: number;
  /** 声部索引 */
  voiceIndex: number;
  /** 在小节内的时间戳 */
  timestamp: number;
}

/** 布局统计 */
export interface LayoutStats {
  /** 布局的小节数量 */
  measureCount: number;
  /** 布局的音符数量 */
  noteCount: number;
  /** 总宽度 */
  totalWidth: number;
  /** 最大小节宽度 */
  maxMeasureWidth: number;
  /** 最小小节宽度 */
  minMeasureWidth: number;
  /** 布局耗时(ms) */
  layoutTime: number;
}

// ==================== 主类 ====================

/**
 * 小节布局引擎
 */
export class MeasureLayoutEngine {
  /** 布局配置 */
  private config: MeasureLayoutConfig;
  
  /** 布局统计 */
  private stats: LayoutStats = {
    measureCount: 0,
    noteCount: 0,
    totalWidth: 0,
    maxMeasureWidth: 0,
    minMeasureWidth: Infinity,
    layoutTime: 0,
  };

  /**
   * 构造函数
   * @param config 布局配置(可选)
   */
  constructor(config: Partial<MeasureLayoutConfig> = {}) {
    this.config = {
      quarterNoteSpacing: config.quarterNoteSpacing ?? DEFAULT_RENDER_CONFIG.quarterNoteSpacing,
      measurePadding: config.measurePadding ?? DEFAULT_RENDER_CONFIG.measurePadding,
      minNoteSpacing: config.minNoteSpacing ?? DEFAULT_RENDER_CONFIG.minNoteSpacing,
      noteFontSize: config.noteFontSize ?? DEFAULT_RENDER_CONFIG.noteFontSize,
    };
  }

  /**
   * 计算单个小节的布局
   * 
   * @param measure 小节对象
   * @param startX 小节起始X坐标(默认0)
   * @returns 布局结果
   */
  layoutMeasure(measure: JianpuMeasure, startX: number = 0): MeasureLayoutResult {
    // 1. 计算小节宽度
    const { width, contentWidth } = this.calculateMeasureWidth(measure);
    
    // 2. 设置小节位置
    measure.x = startX;
    measure.width = width;
    
    // 3. 计算音符位置
    const notePositions = this.calculateNotePositions(measure);
    
    return {
      measureIndex: measure.index,
      x: startX,
      width,
      contentWidth,
      notePositions,
    };
  }

  /**
   * 批量布局多个小节
   * 
   * @param measures 小节数组
   * @param startX 起始X坐标(默认0)
   * @returns 布局结果数组
   */
  layoutMeasures(measures: JianpuMeasure[], startX: number = 0): MeasureLayoutResult[] {
    const startTime = performance.now();
    
    // 重置统计
    this.resetStats();
    
    const results: MeasureLayoutResult[] = [];
    let currentX = startX;
    
    for (const measure of measures) {
      const result = this.layoutMeasure(measure, currentX);
      results.push(result);
      
      // 更新统计
      this.stats.measureCount++;
      this.stats.noteCount += result.notePositions.length;
      this.stats.maxMeasureWidth = Math.max(this.stats.maxMeasureWidth, result.width);
      this.stats.minMeasureWidth = Math.min(this.stats.minMeasureWidth, result.width);
      
      // 累计X坐标
      currentX += result.width;
    }
    
    this.stats.totalWidth = currentX - startX;
    this.stats.layoutTime = performance.now() - startTime;
    
    if (this.stats.minMeasureWidth === Infinity) {
      this.stats.minMeasureWidth = 0;
    }
    
    return results;
  }

  /**
   * 计算小节宽度
   * 
   * 公式:小节宽度 = (拍数 / 单位拍 × 4) × 四分音符间距 + 左右padding
   * 
   * @param measure 小节对象
   * @returns 宽度信息
   */
  calculateMeasureWidth(measure: JianpuMeasure): { width: number; contentWidth: number } {
    const { beats, beatType } = measure.timeSignature;
    const { quarterNoteSpacing, measurePadding } = this.config;
    
    // 小节时值(以四分音符为单位)
    // 例如:4/4拍 = 4 / 4 * 4 = 4个四分音符
    // 例如:3/4拍 = 3 / 4 * 4 = 3个四分音符
    // 例如:6/8拍 = 6 / 8 * 4 = 3个四分音符
    const measureRealValue = (beats / beatType) * 4;
    
    // 内容宽度 = 时值 × 四分音符间距
    const contentWidth = measureRealValue * quarterNoteSpacing;
    
    // 总宽度 = 内容宽度 + 左右padding
    const width = contentWidth + measurePadding * 2;
    
    return { width, contentWidth };
  }

  /**
   * 计算小节内所有音符的位置
   * 
   * 布局原则:
   * 1. 多音符小节:两端对齐,第一个音符在左边距,最后一个音符在右边距
   * 2. 单音符小节:音符从左边距位置开始
   * 3. 音符间距根据时值成比例分配
   * 4. 这样保证所有小节的左右边距基本一致
   * 
   * @param measure 小节对象
   * @returns 音符位置数组
   */
  calculateNotePositions(measure: JianpuMeasure): NotePosition[] {
    const positions: NotePosition[] = [];
    const { measurePadding, minNoteSpacing } = this.config;
    
    // 收集所有音符并排序
    const allNotes: { note: JianpuNote; voiceIndex: number }[] = [];
    for (let voiceIndex = 0; voiceIndex < measure.voices.length; voiceIndex++) {
      const voice = measure.voices[voiceIndex];
      for (const note of voice) {
        allNotes.push({ note, voiceIndex });
      }
    }
    
    // 按时间戳排序
    allNotes.sort((a, b) => a.note.timestamp - b.note.timestamp);
    
    if (allNotes.length === 0) {
      return positions;
    }
    
    // 计算可用内容区域
    const startX = measure.x + measurePadding;
    const endX = measure.x + measure.width - measurePadding;
    const availableWidth = endX - startX;
    
    // 获取时间戳范围
    const firstTimestamp = allNotes[0].note.timestamp;
    const lastTimestamp = allNotes[allNotes.length - 1].note.timestamp;
    const timestampRange = lastTimestamp - firstTimestamp;
    
    let prevX = -Infinity;
    
    for (const { note, voiceIndex } of allNotes) {
      let x: number;
      
      if (allNotes.length === 1 || timestampRange === 0) {
        // 只有一个音符或所有音符同时间戳:从左边距开始
        x = startX;
      } else {
        // 多个音符:两端对齐,第一个在 startX,最后一个在 endX
        const ratio = (note.timestamp - firstTimestamp) / timestampRange;
        x = startX + ratio * availableWidth;
      }
      
      // 应用最小间距限制(防止音符重叠)
      if (x - prevX < minNoteSpacing && prevX !== -Infinity) {
        x = prevX + minNoteSpacing;
      }
      
      // 计算音符宽度(基于字体大小)
      const noteWidth = this.calculateNoteWidth(note);
      
      // 更新音符位置
      note.x = x;
      note.width = noteWidth;
      
      positions.push({
        noteId: note.id,
        x,
        width: noteWidth,
        voiceIndex,
        timestamp: note.timestamp,
      });
      
      prevX = x;
    }
    
    return positions;
  }

  /**
   * 计算单个音符的宽度
   * 
   * @param note 音符对象
   * @returns 音符宽度(像素)
   */
  calculateNoteWidth(note: JianpuNote): number {
    const { noteFontSize } = this.config;
    
    // 基础宽度(单个数字的宽度约等于字体大小的0.6倍)
    let width = noteFontSize * 0.6;
    
    // 如果有升降号,增加宽度
    if (note.accidental) {
      width += noteFontSize * 0.4;
    }
    
    // 如果有附点,增加宽度
    if (note.dots > 0) {
      width += noteFontSize * 0.3 * note.dots;
    }
    
    return width;
  }

  /**
   * 根据拍号计算标准小节宽度
   * 
   * @param beats 拍数
   * @param beatType 单位拍
   * @returns 小节宽度
   */
  getStandardMeasureWidth(beats: number, beatType: number): number {
    const { quarterNoteSpacing, measurePadding } = this.config;
    const measureRealValue = (beats / beatType) * 4;
    return measureRealValue * quarterNoteSpacing + measurePadding * 2;
  }

  /**
   * 计算音符在小节内的X偏移
   * 
   * @param timestamp 音符时间戳(以四分音符为单位)
   * @param beatType 单位拍
   * @returns X偏移量
   */
  calculateNoteOffset(timestamp: number, beatType: number): number {
    const { quarterNoteSpacing, measurePadding } = this.config;
    const spacingFactor = 4 / beatType;
    return measurePadding + timestamp * spacingFactor * quarterNoteSpacing;
  }

  /**
   * 获取布局统计
   */
  getStats(): LayoutStats {
    return { ...this.stats };
  }

  /**
   * 重置统计
   */
  private resetStats(): void {
    this.stats = {
      measureCount: 0,
      noteCount: 0,
      totalWidth: 0,
      maxMeasureWidth: 0,
      minMeasureWidth: Infinity,
      layoutTime: 0,
    };
  }

  /**
   * 获取当前配置
   */
  getConfig(): MeasureLayoutConfig {
    return { ...this.config };
  }

  /**
   * 更新配置
   */
  updateConfig(config: Partial<MeasureLayoutConfig>): void {
    Object.assign(this.config, config);
  }
}

// ==================== 工厂函数 ====================

/**
 * 创建小节布局引擎
 */
export function createMeasureLayoutEngine(config?: Partial<MeasureLayoutConfig>): MeasureLayoutEngine {
  return new MeasureLayoutEngine(config);
}

// ==================== 工具函数 ====================

/**
 * 计算拍号对应的小节时值
 * @param beats 拍数
 * @param beatType 单位拍
 * @returns 小节时值(以四分音符为单位)
 */
export function calculateMeasureRealValue(beats: number, beatType: number): number {
  return (beats / beatType) * 4;
}

/**
 * 计算时间戳对应的X偏移比例
 * @param timestamp 时间戳
 * @param beatType 单位拍
 * @returns X偏移比例(0-1)
 */
export function calculateTimestampRatio(timestamp: number, beats: number, beatType: number): number {
  const measureRealValue = calculateMeasureRealValue(beats, beatType);
  return timestamp / measureRealValue;
}

/**
 * 验证小节宽度是否符合固定比例
 * @param measures 小节数组
 * @param tolerance 容差(默认0.001)
 * @returns 是否符合
 */
export function validateMeasureWidths(measures: JianpuMeasure[], tolerance: number = 0.001): boolean {
  // 按拍号分组
  const groupedByTimeSignature = new Map<string, JianpuMeasure[]>();
  
  for (const measure of measures) {
    const key = `${measure.timeSignature.beats}/${measure.timeSignature.beatType}`;
    if (!groupedByTimeSignature.has(key)) {
      groupedByTimeSignature.set(key, []);
    }
    groupedByTimeSignature.get(key)!.push(measure);
  }
  
  // 验证同一拍号的小节宽度是否相同
  for (const [key, group] of groupedByTimeSignature) {
    if (group.length < 2) continue;
    
    const firstWidth = group[0].width;
    for (let i = 1; i < group.length; i++) {
      if (Math.abs(group[i].width - firstWidth) > tolerance) {
        console.warn(`[MeasureLayoutEngine] 拍号 ${key} 的小节宽度不一致: ${firstWidth} vs ${group[i].width}`);
        return false;
      }
    }
  }
  
  return true;
}