verovio_flutter 0.1.6 copy "verovio_flutter: ^0.1.6" to clipboard
verovio_flutter: ^0.1.6 copied to clipboard

Published 8 days ago • verified publishercsa8820.top• Latest: 0.2.1
[unknown platforms]
→

Metadata

Flutter FFI plugin for Verovio music notation rendering.

More...

verovio_flutter #

Render beautiful sheet music in your Flutter app — from MEI, MusicXML, ABC, Humdrum or PAE, straight to SVG.

License: LGPL-3.0 Platform Verovio

Language: English | 中文

[verovio_flutter demo on iPhone]

verovio_flutter is a Flutter FFI plugin that embeds Verovio — the open-source music notation engraving library used by the MEI community, RISM, and the Music Encoding Initiative — directly into your Android and iOS apps. No server, no WebView, no network. Just native engraving on device.

Why use it #

  • Real engraving, not just rendering — Verovio lays out music with publication quality (beams, slurs, ties, articulations, lyrics, multi-voice, page breaks).
  • Works offline — everything runs natively on the device via FFI. No HTTP, no JS bridge.
  • Multiple input formats — MEI, MusicXML, Humdrum, ABC, Plaine & Easie.
  • SVG output — vector graphics that scale on any screen, embed in your own widgets, export to PDF, or post-process freely.
  • Isolate-friendly — VerovioAsyncService runs the toolkit on a worker isolate so rendering never blocks your UI.
  • Drop-in size — ~7 MB per ABI after --split-per-abi on Android.

Install #

dependencies:
  verovio_flutter: ^0.1.6

Quick start #

import 'package:flutter/material.dart';
import 'package:verovio_flutter/verovio_flutter.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 1. Unpack the Verovio font/data assets once.
  final resourcePath = await VerovioResourceManager.ensureVerovioAssetsReady();

  // 2. Spawn a worker isolate that owns the toolkit.
  final service = await VerovioAsyncService.spawn(resourcePath: resourcePath);

  // 3. Feed it MEI / MusicXML / ABC / Humdrum.
  await service.loadData('''<mei xmlns="http://www.music-encoding.org/ns/mei">
    <music><body><mdiv><score><section/></score></mdiv></body></music>
  </mei>''');

  // 4. Get an SVG string for any page and draw it.
  final svg = await service.renderToSvg(1);

  // Render `svg` with any SVG widget of your choice
  // (e.g. flutter_svg, jovial_svg, a WebView, or your own renderer).
  print(svg);
}

VerovioAsyncService runs every FFI call on a dedicated worker isolate, so your UI thread stays responsive. This is the only recommended entry point.

A complete runnable example lives in example/.

Optional page cache #

If you render the same page repeatedly, VerovioPageCache can keep SVG strings in memory:

final cache = VerovioPageCache(capacity: 32);
final svg = await cache.getOrRender(
  data: mei,
  optionsJson: '{}',
  pageNo: 1,
  render: () => service.renderToSvg(1),
);

Platform support #

Platform Minimum version Architectures
Android API 21 arm64-v8a / x86_64
iOS 13.0 arm64 (device) / arm64 + x86_64 (simulator)

Size #

Component Size
android/src/main/jniLibs 14 MB
ios/Frameworks/VerovioFFI.xcframework 14.8 MB
assets/verovio_data (fonts + schemas) 11.4 MB
Bundled total 40.2 MB

Per-ABI install footprint on Android with --split-per-abi: ~6.8 MB (arm64-v8a) / ~7.2 MB (x86_64) before APK compression.

Note: the iOS binary size increased after changing the packaging flow to ship a fuller .xcframework build.

API reference #

See doc/api.md for the full VerovioAsyncService surface (options, page navigation, MIDI export, time-map, etc.), along with VerovioResourceManager and VerovioPageCache.

Troubleshooting #

  • spawn() throws ArgumentError: make sure resourcePath is an absolute path returned by VerovioResourceManager.ensureVerovioAssetsReady().
  • VerovioException after loadData(): inspect exception.log; Verovio usually explains the parse or layout error there.
  • Empty output / pageCount == 0: confirm the input is a supported score format and that the data is not empty.
  • Package score is lower than expected on pub.dev: republish after documentation changes, then wait for pub.dev to reanalyze the package.

Version mapping #

verovio_flutter Verovio upstream
0.1.0 version-2.7.1-10372-g8100cb396 (8100cb39604d40102a9c2ce75719136f3fb52a77)
0.1.1 version-6.2.1 (8d42439dc9231f6c87779287b542febcb3d609b3)
0.1.2 version-6.2.1 (8d42439dc9231f6c87779287b542febcb3d609b3)
0.1.3 version-6.2.1 (8d42439dc9231f6c87779287b542febcb3d609b3)
0.1.4 version-6.2.1 (8d42439dc9231f6c87779287b542febcb3d609b3)
0.1.6 version-6.2.1 (8d42439dc9231f6c87779287b542febcb3d609b3)

License #

LGPL-3.0. Verovio is LGPL-3.0; any derivative work must comply with the same obligations. You can use this plugin in closed-source apps as long as you respect the LGPL dynamic-linking rules.

Maintainer guide #

Build and sync commands
  • Clone with submodules: git clone --recurse-submodules https://github.com/csa8820/verovio_flutter
  • Rebuild Android .so: bash tool/build_android_so.sh
  • Rebuild iOS .xcframework: bash tool/build_ios_xcframework.sh
  • Sync upstream Verovio sources: bash tool/sync_verovio_sources.sh
  • GitHub Actions CI runs Android + iOS build validation on PRs and pushes to main.

Credits #

Built on top of Verovio by the RISM Digital Center. This plugin only provides the Flutter / FFI glue — all the engraving magic is theirs.

← Metadata

1
likes
0
points
340
downloads

Publisher

verified publishercsa8820.top

Weekly Downloads

Metadata

Flutter FFI plugin for Verovio music notation rendering.

Homepage
Repository (GitHub)
View/report issues

License

unknown (license)

Dependencies

ffi, flutter, path_provider, plugin_platform_interface

More

Packages that depend on verovio_flutter

Packages that implement verovio_flutter

Back