OpenSheetMusicDisplay 中实现音符音高名称渲染的技术解析

在音乐记谱软件OpenSheetMusicDisplay中，开发者经常需要实现音符音高名称的显示功能。本文将深入探讨如何在该项目中实现这一需求。

核心实现原理

OpenSheetMusicDisplay提供了灵活的渲染机制，允许开发者在音符上叠加自定义文本。实现这一功能的关键在于理解项目的图形渲染架构：

1. 图形对象层级结构：从Measure(小节)到StaffEntry(谱表条目)，再到GraphicalNote(图形音符)的层级访问
2. 坐标系统：使用绝对位置坐标确定文本显示位置
3. 标签渲染系统：通过GraphicalLabel类实现文本渲染

具体实现步骤

1. 遍历音符结构

首先需要遍历整个乐谱的音符结构，获取每个音符的音高信息：

osmd.GraphicSheet.measureList.forEach(measureList => {
  measureList.forEach(measure => {
    measure.staffEntries.forEach(staffEntry => {
      staffEntry.graphicalVoiceEntries.forEach(graphicalVoiceEntry => {
        graphicalVoiceEntry.notes.forEach(graphicalNote => {
          // 处理每个音符
        });
      });
    });
  });
});

2. 获取音高信息

从每个音符对象中提取音高数据并转换为可读字符串：

const pitch = graphicalNote.sourceNote.Pitch;
if (pitch === undefined) return;
const pitchName = pitch.ToStringShort(); // 如"C4", "D#5"等

3. 创建并配置标签

创建文本标签并设置其显示属性：

const label = new Label(pitchName);
const graphicalLabel = new GraphicalLabel(
  label, 
  0.8, // 文本高度
  TextAlignmentEnum.CenterCenter, // 居中对齐
  osmd.rules // 渲染规则
);

4. 关键设置

必须调用setLabelPositionAndShapeBorders方法，这是确保标签正确显示的关键步骤：

graphicalLabel.setLabelPositionAndShapeBorders();

5. 计算显示位置

获取音符的绝对位置并应用屏幕变换：

const scaledPosition = osmd.drawer.applyScreenTransformation(
  graphicalNote.PositionAndShape.absolutePosition
);

6. 执行渲染

最后调用渲染方法显示标签：

osmd.drawer.renderLabel(
  graphicalLabel, 
  5,       // 图层
  10,      // 宽度
  10,      // 高度
  12,      // 字体高度
  scaledPosition // 位置
);

高级技巧与注意事项

1. 位置调整：可以通过y坐标偏移量微调文本显示位置
2. 样式定制：通过rules对象可以自定义文本颜色等样式
3. 性能优化：大量标签渲染时需考虑性能影响
4. 图层管理：合理设置图层确保文本不被其他元素遮挡

实际应用效果

实现后可以在每个音符上方或下方显示其音高名称，如"C4"、"G#5"等，便于音乐学习者识别音高。

这种技术不仅适用于音高显示，还可扩展用于其他音乐标记的添加，为OpenSheetMusicDisplay的功能扩展提供了良好范例。开发者可以根据需要调整文本大小、颜色、位置等参数，实现多样化的显示效果。