Flutter ID3标签解析插件id3_codec的使用

Flutter ID3标签解析插件id3_codec的使用

id3_codec 是一个跨平台的纯 Dart 包，用于读取和编辑 ID3 元数据。它支持多种 ID3 版本的解码和编码功能。

支持的 ID3 版本

• 解码支持版本：

  • ✅ v1
  • ✅ v1.1
  • ✅ v2.2
  • ✅ v2.3
  • ✅ v2.4

• 编码支持版本：

  • ✅ v1
  • ✅ v1.1
  • ❌ v2.2（不支持）
  • ✅ v2.3
  • ✅ v2.4

安装

在 pubspec.yaml 文件中添加依赖：

dependencies:
  id3_codec: ^{latest version}

然后运行以下命令来安装依赖：

flutter pub add id3_codec

使用方法

解码

你可以从给定的字节序列中读取所有 ID3 标签信息，并以 ID3MetataInfo 或 Map 的形式显示。

异步读取

final data = await rootBundle.load("assets/song1.mp3");
final decoder = ID3Decoder(data.buffer.asUint8List());
decoder.decodeAsync().then((metadata) {
    debugPrint(metadata.toString());
});

同步读取

final data = await rootBundle.load("assets/song1.mp3");
final decoder = ID3Decoder(data.buffer.asUint8List());
final metadata = decoder.decodeSync();
debugPrint(metadata.toString());

编码

你可以编辑现有的 ID3 标签，或添加新的标签信息。

编辑或编码 v1 和 v1.1

final data = await rootBundle.load("assets/song2.mp3");
final bytes = data.buffer.asUint8List();
final encoder = ID3Encoder(bytes);
final resultBytes = encoder.encode(MetadataV1Body(
                title: 'Ting wo shuo,xiexie ni',
                artist: 'Wu ming',
                album: 'Gan en you ni',
                year: '2021',
                comment: 'I am very happy!',
                track: 1,
                genre: 2
               ));

// 你可以通过 ID3Decoder 或其他 ID3 标签库读取 [resultBytes]

编辑或编码 v2.3/v2.4

final data = await rootBundle.load("assets/song1.mp3");
final bytes = data.buffer.asUint8List();

final header = await rootBundle.load("assets/wx_header.png");
final headerBytes = header.buffer.asUint8List();

final encoder = ID3Encoder(bytes);
// 如果你需要编码或编辑 v2.4，只需使用 `MetadataV2p4Body` 而不是 `MetadataV2p3Body`
final resultBytes = encoder.encodeSync(MetadataV2p3Body(
    title: '听我说谢谢你！',
    imageBytes: headerBytes,
    artist: '歌手ijinfeng',
    userDefines: {
      "时长": '2:48',
      "userId": "ijinfeng"
    },
    album: 'ijinfeng的专辑',
)); 

// 你可以通过 `ID3Decoder` 或其他 ID3 标签库读取 [resultBytes]

完整示例 Demo

以下是一个完整的 Flutter 示例应用程序，展示了如何使用 id3_codec 插件进行 ID3 标签的解码和编码。

import 'dart:convert';
import 'dart:io';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:id3_codec/id3_codec.dart';
import 'package:path_provider/path_provider.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter ID3 Codec Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter ID3 Codec Demo'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  List<int> bytes = [];

  [@override](/user/override)
  void initState() {
    super.initState();
    // 加载 MP3 文件
    rootBundle.load("assets/song2.mp3").then((value) {
      setState(() {
        bytes = value.buffer.asUint8List();
      });
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.spaceEvenly,
          children: [
            TextButton(
              onPressed: () async {
                if (bytes.isNotEmpty) {
                  final decoder = ID3Decoder(bytes);
                  decoder.decodeAsync().then((metadatas) {
                    for (var metadata in metadatas) {
                      debugPrint(metadata.toTagMap().toString());
                    }
                  });
                }
              },
              child: const Text('解码 ID3v2.3'),
            ),
            TextButton(
              onPressed: () async {
                if (bytes.isNotEmpty) {
                  final encoder = ID3Encoder(bytes);
                  bytes = encoder.encodeSync(MetadataV1Body(
                    title: 'Ting wo shuo,xiexie ni',
                    artist: 'Wu ming',
                    album: 'Gan en you ni',
                    year: '2021',
                    comment: 'I am very happy!',
                    track: 1,
                    genre: 2,
                  ));
                  debugPrint("编码 ID3v1 成功");
                }
              },
              child: const Text('编码 ID3v1'),
            ),
            TextButton(
              onPressed: () async {
                if (bytes.isNotEmpty) {
                  final header = await rootBundle.load("assets/wx_header.png");
                  final headerBytes = header.buffer.asUint8List();
                  final encoder = ID3Encoder(bytes);
                  bytes = encoder.encodeSync(MetadataV2p3Body(
                    title: '听我说谢谢你！',
                    imageBytes: headerBytes,
                    artist: '歌手ijinfeng',
                    userDefines: {
                      "时长": '2:48',
                      "userId": "ijinfeng"
                    },
                    album: 'ijinfeng的专辑',
                  ));
                  debugPrint("编码 ID3v2.3 成功");
                }
              },
              child: const Text('编码 ID3v2.3'),
            ),
            TextButton(
              onPressed: () async {
                if (bytes.isNotEmpty) {
                  final header = await rootBundle.load("assets/wx_header.png");
                  final headerBytes = header.buffer.asUint8List();
                  final encoder = ID3Encoder(bytes);
                  bytes = encoder.encodeSync(MetadataV2p4Body(
                    title: '拔萝卜',
                    imageBytes: headerBytes,
                    artist: '歌手小兔子',
                    userDefines: {"种族": '兔八哥'},
                    album: '向着光明的太阳 GO~',
                  ));
                  debugPrint("编码 ID3v2.4 成功");
                }
              },
              child: const Text('编码 ID3v2.4'),
            ),
            TextButton(
              onPressed: () async {
                if (bytes.isNotEmpty) {
                  final downloadDir = await getDownloadsDirectory();
                  if (downloadDir != null) {
                    final file = File('${downloadDir.path}/rewrite_song.mp3');
                    await file.writeAsBytes(bytes);
                    debugPrint("写入文件成功: ${file.path}");
                  }
                }
              },
              child: const Text('写入文件'),
            ),
          ],
        ),
      ),
    );
  }
}