パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v1.8.1

audio_metadata_reader

オーディオファイル用のメタデータリーダー。ID3、Vorbisコメント、ILST iTunesに対応

AndroidiOSmacOSWindowsLinux
30日間ダウンロード
1.9万
いいね数
45
Pub ポイント
160

パッケージをインストール

flutter pub add audio_metadata_reader

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Flutter/Dartパッケージで、音声ファイルからメタデータを抽出し、MP3に一般的なID3タグ、OGGファイルで使用されるVorbisコメント、およびILST iTunesメタデータをサポートしています。開発者が複数のプラットフォームでタイトル、アーティスト、アルバム、ジャンルなど重要なオーディオ情報を読み取れるようにします。このパッケージは軽量で、オーディオファイル解析が必要なマルチメディアアプリケーションへのシームレスな統合を目的としています。Android、iOS、macOS、Windows、Linuxで動作するため、クロスプラットフォーム音声ツールに最適です。

用途

  • 音楽アプリで曲のメタデータを読み取る
  • オーディオファイルからアーティストとアルバム情報を抽出する
  • メディアライブラリ管理システムの構築
  • ポッドキャストアプリのメタデータを解析する
  • オーディオファイルのタグ付け機能をサポート

主な機能

  • ID3、Vorbis コメント、ILST メタデータをサポート
  • クロスプラットフォーム互換性
  • 軽量で統合が簡単
  • 構造化メタデータ出力を提供します
  • 一般的なオーディオ形式に対応しています

適している対象

  • 音楽プレーヤー開発者
  • メディアライブラリービルダー
  • オーディオファイル処理ツール
  • ポッドキャストアプリの開発者
  • クロスプラットフォームマルチメディアアプリ

注意事項

  • メタデータの読み取りに限定され、編集は不可
  • すべてのオーディオ形式をサポートしていません
  • メタデータの解析はファイルの整合性に依存します
  • 破損したファイルに対する組み込みのエラー処理なし
  • 一部のプラットフォームでは、適切なファイル権限が必要です

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Audio Metadata Reader

A pure Dart package for reading and writing metadata in various audio formats.

File Format Metadata Format(s) Read Write
MP3 ID3v1, ID3v2 ✅ ✅
MP4 iTunes-style ilst ✅ ✅
FLAC Vorbis Comments ✅ ✅
OGG Vorbis Comments ✅ ❌
Opus Vorbis Comments ✅ ❌
WebM/Matroska Tags / Opus ✅ ❌
WAV RIFF ✅ ✅
AIFF/AIFC IFF chunks ✅ ❌
APE APEv2 ✅ ✅

This package is still under active development. If there's a metadata format you'd like to see supported or specific information you’d like the library to expose, feel free to open an issue.

Usage

Read
import 'dart:io';
import 'package:audio_metadata_reader/audio_metadata_reader.dart';

void main() {
  final track = File("Pieces.mp3");

  // Fetching images can slow down metadata reading
  final metadata = readMetadata(track, getImage: false);

  print(metadata.title);
  print(metadata.album);
}

readMetadata returns the common AudioMetadata view shared by all supported formats. Use readAllMetadata when you need the format-specific metadata object, such as Mp3Metadata, Mp4Metadata, VorbisMetadata, RiffMetadata or ApeMetadata.

import 'dart:io';

import 'package:audio_metadata_reader/audio_metadata_reader.dart';

final track = File("Pieces.mp3");
final metadata = readAllMetadata(track, getImage: false);
print(metadata);
Supported File Extensions

The package currently recognizes these extensions:

.mp3, .flac, .mp4, .m4a, .ape, .ogg, .opus, .wav, .webm, .mkv, .aif, .aiff, .aifc and .mov.

Use supportedFileExtensions when filtering files before parsing:

final isSupported = supportedFileExtensions.any(
  (ext) => file.path.toLowerCase().endsWith(ext),
);
Write
import 'dart:io';
import 'dart:typed_data';

import 'package:audio_metadata_reader/audio_metadata_reader.dart';

void main() {
  final track = File("Pieces.mp3");

  // Use a switch if you want to update metadata based on the file type
  updateMetadata(
    track,
    (metadata) {
      switch (metadata) {
        case Mp3Metadata m:
          m.songName = "New title";
          break;
        case Mp4Metadata m:
          m.title = "New title";
          break;
        case VorbisMetadata m:
          m.title = ["New title"];
          break;
        case RiffMetadata m:
          m.title = "New title";
          break;
        case ApeMetadata m:
          m.title = "New title";
      }
    },
  );

  // Or use extension methods for common metadata updates
  updateMetadata(
    track,
    (metadata) {
      metadata.setTitle("New title");
      metadata.setArtist("New artist");
      metadata.setAlbum("New album");
      metadata.setTrackNumber(1);
      metadata.setYear(DateTime(2014));
      metadata.setLyrics("I'm singing");
      metadata.setGenres(["Rock", "Metal", "Salsa"]);
      metadata.setPictures([
        Picture(Uint8List.fromList([]), "image/png", PictureType.coverFront)
      ]);
    },
  );
}

updateMetadata reads the existing format-specific metadata, applies the callback, then writes it back to the same file while retaining metadata that the callback does not change. For an already constructed metadata object, use replaceMetadata directly:

import 'dart:io';

import 'package:audio_metadata_reader/audio_metadata_reader.dart';

final metadata = Mp3Metadata()..songName = "New title";
replaceMetadata(File("Pieces.mp3"), metadata);

replaceMetadata reconstructs the supported metadata from the object you provide. It is destructive: tags that are not represented by that object may be removed. writeMetadata is deprecated and behaves the same way; use updateMetadata when you need to preserve existing metadata that you are not editing.

The replacement is written to a temporary file in the same directory and renamed into place only after the writer completes, so a failed write leaves the original file untouched. The format-specific writer classes use the same atomic write path.

The common setter extension also provides setTrackTotal and setCD. Some formats do not support every field; unsupported setters are intentionally ignored for those formats.

MP4 metadata can also contain Chapter markers. OGG, Opus and AIFF/AIFC are currently read-only; metadata writing is supported for MP3, MP4, FLAC, WAV and APE files.

Performance

On my laptop with an SSD, the library can process metadata from 3,392 tracks in under 200ms — assuming covers aren't fetched. With covers, it's around 400ms.

import 'dart:io';
import 'package:audio_metadata_reader/audio_metadata_reader.dart';

void main() {
  final folder = Directory(r"music folder")
      .listSync(recursive: true)
      .whereType<File>()
      .where(
        (file) => supportedFileExtensions.any(
          (ext) => file.path.toLowerCase().endsWith(ext),
        ),
      )
      .toList();

  print("Number of tracks: ${folder.length}");

  final start = DateTime.now();

  for (final file in folder) {
    readMetadata(file, getImage: false);
  }

  final end = DateTime.now();
  print("Duration: ${end.difference(start)}");
}
Compare with FFmpeg/libavformat

The repository includes a standalone benchmark that recursively scans a music directory and reads metadata without loading cover images:

dart run tool/benchmark_metadata.dart --backend both --runs 3

It defaults to ~/Music. Use --music PATH for another directory and --backend library to measure only this package. The ffprobe comparison uses FFmpeg/libavformat through the ffprobe executable and requests only format_tags; its timing includes one process launch per file.

To list the files that fail to parse, run the diagnostic script:

dart run tool/find_metadata_errors.dart --music ~/Music

It prints each failing path, the exception message, and an error summary. Add --stack-traces when investigating a parser failure in detail.

Anonymize a Music Track

If you need to report an issue or test the library without sharing private audio, you can anonymize a track by replacing its audio with white noise using ffmpeg:

ffmpeg -i <your_track> -f lavfi -t 5 -i "anoisesrc=color=white:duration=5" -map_metadata 0 -map 1:a -t 5 <output_track>

カテゴリー

依存関係

依存関係一覧 3 件

ソースリポジトリ

このパッケージを使用しているプロジェクト