Flutter实现简单五线谱🎼

前言:为何会写这篇文章,主要是技术群经常有小伙伴问如何绘制五线谱,网上也基本找不到相关demo,感觉像是个很冷门的需求点;加之我对音乐和五线谱有一些不成熟的项目规划,希望能作为一个完整开源项目进行维护。因此在中秋假期第一天,花点时间简单绘制一个五线谱。

效果图

五线谱

知识点

  1. 音符其实是一种字体:akvo,绘制五线谱,其实就是显示这种字体即可;
  2. 涉及到Flutter canvas绘制和字体绘制;
  3. 音乐相关知识🎵【这点是这篇文章缺失的】

实现步骤

1. 基本需求

从最简单的业务出发的话,至少会有这些需求:根据时长规划线谱长度、对应时间点显示对应音符、播放到对应音符着重显示......但限于笔者对音乐一窍不通,所以五线谱的实现只有两个需求:五条线+音符🤣。笔者本次仅做到均匀的在五线谱显示音符

2. 绘制五线谱

非常简单,根据传入的音符长度,绘制横线。见代码:

/// 绘制5条基线
class BaseLinePainter extends CustomPainter {
  final double lineSpace; // 每条线的间隙
  final double rowSpace; // 每段五线谱的间隙
  final int noteLength; // 音符的长度

  BaseLinePainter(this.lineSpace, this.rowSpace, this.noteLength);

  @override
  void paint(Canvas canvas, Size size) {
    Paint _paint = Paint()
      ..color = Colors.black
      ..isAntiAlias = false
      ..style = PaintingStyle.stroke
      ..strokeWidth = 1.0;

    double w = size.width;
    int rowCount = (noteLength / 6).ceil(); // 每行6个音符,向上取整
    double h = 0;

    for (int c = 0; c < rowCount; c++) {
      canvas.save();
      h = c * (4 * lineSpace + rowSpace);
      for (int i = 0; i < 5; i++) {
        Path path = new Path();
        path.moveTo(0, h + i * lineSpace);
        path.lineTo(w, h + i * lineSpace);
        canvas.drawPath(path, _paint);
      }
      canvas.restore();
    }
  }

  @override
  bool shouldRepaint(covariant CustomPainter oldDelegate) => false;
}

绘制音符

绘制音符其实就绘制文字,字体设为akvo即可,因此我们需要提前在yaml导入字体包

flutter:
  fonts:
    - family: akvo
      fonts:
        - asset: assets/fonts/akvo.ttf

在上面绘制横线的时候,我们规定一行五线谱绘制6个音符,下面是绘制代码:

/// 音符绘制方法
class NotesPainter extends CustomPainter {
  final List<StaffModel> noteList; // 音符列表
  final double lineSpace; // 每条线的间隙
  final double rowSpace; // 每段五线谱的间隙

  NotesPainter(this.noteList, this.lineSpace, this.rowSpace);

  @override
  void paint(Canvas canvas, Size size) {

    double cellWidth = size.width / 6; // 每个音符的宽度
    double rowTotalHeight = lineSpace * 4 + rowSpace;
    final textStyle = ui.TextStyle(
      fontFamily: 'akvo',
      fontSize: 24, // 这里其实需要根据五线谱每条线之间的空隙来计算字体的size
      color: Colors.brown,
    );
    for (int i = 0; i < noteList.length; i++) {
      canvas.save();
      int rowCount = (i / 6).floor(); // 第几行
      int lineCount = (i % 6); // 第几列
      Offset noteOffset = Offset(lineCount * cellWidth + (cellWidth - 12) / 2,
          rowCount * rowTotalHeight + (noteList[i].level - 1) * lineSpace);

      final paragraphBuilder = ui.ParagraphBuilder(ui.ParagraphStyle())
        ..pushStyle(textStyle)
        ..addText(noteList[i].note);
      final paragraph = paragraphBuilder.build()..layout(ui.ParagraphConstraints(width: cellWidth));
      canvas.drawParagraph(paragraph, noteOffset);
      canvas.restore();
    }
  }

  @override
  bool shouldRepaint(covariant CustomPainter oldDelegate) => false;
}

封装widget

传入音符model即可

class Staff extends StatelessWidget {
  Staff(this.size, {Key? key}) : super(key: key);
  final Size size;
  final List<StaffModel> _list = [
    StaffModel('e', 1),
    StaffModel('e', 2),
    StaffModel('g', 3),
    StaffModel('e', 4),
    StaffModel('h', 4),
    StaffModel('f', 0),
    StaffModel('e', 1),
    StaffModel('e', 1),
    StaffModel('1', 1),
    StaffModel('2', 3),
    StaffModel('3', 4),
    StaffModel('4', 2),
    StaffModel('5', 3),
    StaffModel('6', 2),
    StaffModel('e', 1),
    StaffModel('g', 1),
    StaffModel("\$", 3),
    StaffModel('e', 2),
    StaffModel('g', 3),
    StaffModel('e', 4),
    StaffModel('h', 4),
    StaffModel('f', 0),
  ];

  @override
  Widget build(BuildContext context) {
    return RepaintBoundary(
      child: CustomPaint(
        size: size,
        painter: BaseLinePainter(12, 24, _list.length),
        child: RepaintBoundary(
          child: CustomPaint(
            size: size,
            painter: NotesPainter(_list, 12, 24),
          ),
        ),
      ),
    );
  }
}

相关资源和代码

音符使用的是akvo字体包,下面是akvo的键位对照表;至于字体可以自行网上下载,实在找不到的见下:
https://pan.baidu.com/s/1HVRHWi1KgOrsrepoKmg-lA
提取码: 62dq

akvo键位对照表.jpg

完整代码

class Staff extends StatelessWidget {
  Staff(this.size, {Key? key}) : super(key: key);
  final Size size;
  final List<StaffModel> _list = [
    StaffModel('e', 1),
    StaffModel('e', 2),
    StaffModel('g', 3),
    StaffModel('e', 4),
    StaffModel('h', 4),
    StaffModel('f', 0),
    StaffModel('e', 1),
    StaffModel('e', 1),
    StaffModel('1', 1),
    StaffModel('2', 3),
    StaffModel('3', 4),
    StaffModel('4', 2),
    StaffModel('5', 3),
    StaffModel('6', 2),
    StaffModel('e', 1),
    StaffModel('g', 1),
    StaffModel("\$", 3),
    StaffModel('e', 2),
    StaffModel('g', 3),
    StaffModel('e', 4),
    StaffModel('h', 4),
    StaffModel('f', 0),
  ];

  @override
  Widget build(BuildContext context) {
    return RepaintBoundary(
      child: CustomPaint(
        size: size,
        painter: BaseLinePainter(12, 24, _list.length),
        child: RepaintBoundary(
          child: CustomPaint(
            size: size,
            painter: NotesPainter(_list, 12, 24),
          ),
        ),
      ),
    );
  }
}

class StaffModel {
  final String note; // 音符
  final int level; // 音符显示的层级 1、2、3、4、5

  StaffModel(this.note, this.level);
}

写在最后

正如我一直强调的,这次编写五线谱,纯粹是一次简单的技术预研,代码的可用性不强,原因只有一个:对音乐、音符领域还没有任何研究。
我需要对这块有一定了解,得知道五线谱怎么画才是合格的,才能造出优秀的轮子。因此,我非常希望:

  1. 在音乐领域有相关了解的,可以让我取取经😋;
  2. 同时这个领域我认为是有商业/技术价值可挖掘的,我将深入开源,渴求有志之士一同加入;

说说近况吧。😄特效的编写应该会断更一段时间,之前的几个特效UI会在国庆期间优化好,作为pub发布。然后最近一直在复盘Android,接下来我会以一个Flutter开发者的角度,记录从0到0.5学习Android的过程,并分享给大家。

好了,小弟班门弄斧,希望能一起学习进步!!!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,366评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,521评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,689评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,925评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,942评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,727评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,447评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,349评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,820评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,990评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,127评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,812评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,471评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,017评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,142评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,388评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,066评论 2 355

推荐阅读更多精彩内容