🎵 Music Feature Analyzer #

✨ Features #

• 📊 Metadata Extraction: Title, Artist, Album, Album Art, Duration, Genre, Year, Bitrate, and more
• 🤖 AI Analysis: Genre, Instruments, Mood, Vocals detection using YAMNet
• 🎵 Signal Processing: Tempo (BPM), Energy, Danceability, Spectral features
• ⚡ Background Processing: Process multiple files with progress tracking

🚀 Quick Start #

Installation #

✅ Zero Configuration Required! When using the published package from pub.dev, no platform-specific setup is needed. Just add it to your pubspec.yaml:

dependencies:
  music_feature_analyzer: ^1.0.1-beta-03

flutter pub get

The plugin automatically registers itself - no manual MainActivity.kt or AppDelegate.swift changes needed!

Note: For local path dependencies (development), see BUILD_COMPATIBILITY.md

Basic Usage #

import 'package:music_feature_analyzer/music_feature_analyzer.dart';

// Extract metadata (no initialization needed)
final song = await MusicFeatureAnalyzer.metadata('/path/to/song.mp3');
print('Title: ${song?.title}');
print('Artist: ${song?.artist}');

// Extract AI features (requires initialization)
await MusicFeatureAnalyzer.initialize();
final features = await MusicFeatureAnalyzer.analyzeSong(song!);
print('Genre: ${features?.estimatedGenre}');
print('Tempo: ${features?.tempoBpm} BPM');

📊 Extracted Data #

Metadata #

AI Features #

Signal Processing #

📚 API Reference #

Metadata Extraction #

// Single file
final song = await MusicFeatureAnalyzer.metadata('/path/to/song.mp3');

// Multiple files
final songs = await MusicFeatureAnalyzer.extractMetadataBatch([
  '/path/to/song1.mp3',
  '/path/to/song2.mp3',
]);

Feature Extraction #

// Initialize (required once)
await MusicFeatureAnalyzer.initialize();

// Analyze single song
final features = await MusicFeatureAnalyzer.analyzeSong(song);

// Batch analysis
final featuresList = await MusicFeatureAnalyzer.analyzeSongs(songs);

// Background processing with progress
final results = await MusicFeatureAnalyzer.extractFeaturesInBackground(
  filePaths,
  onProgress: (current, total) {
    print('Progress: $current/$total');
  },
);

Utility Functions #

// Verify setup
final setup = await MusicFeatureAnalyzer.verifyPlatformSetup();

// Get progress
final progress = MusicFeatureAnalyzer.getExtractionProgress(filePaths);

// Clean up
await MusicFeatureAnalyzer.dispose();

⚙️ Platform Setup #

✅ Automatic Registration #

For published packages (pub.dev): No setup required! The plugin automatically registers itself via Flutter's plugin system. Just add the package and use it.

📱 Permissions (Optional) #

Permissions are only required if you need to access files from the device's media library. If you're providing file paths directly (e.g., from file picker), permissions are not needed.

Android

If accessing media library, add to android/app/src/main/AndroidManifest.xml:

<uses-permission android:name="android.permission.READ_MEDIA_AUDIO" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" 
                 android:maxSdkVersion="32" />

Request permissions at runtime:

import 'package:permission_handler/permission_handler.dart';
await Permission.audio.request(); // Android 13+
await Permission.storage.request(); // Android 12-

iOS

If accessing media library, add to ios/Runner/Info.plist:

<key>NSAppleMusicUsageDescription</key>
<string>This app needs access to your music library.</string>
<key>NSMediaLibraryUsageDescription</key>
<string>This app needs access to your media library.</string>

Request permissions at runtime:

import 'package:permission_handler/permission_handler.dart';
await Permission.mediaLibrary.request();

🎯 Supported Formats #

MP3, WAV, FLAC, AAC, M4A, OGG, WMA, OPUS, AIFF, ALAC

📋 Requirements #

• Flutter: 3.0.0+
• Dart: 3.8.1+
• iOS: 12.0+
• Android: API 21+

📚 Documentation #

• Build Compatibility - Local path dependency setup
• Changelog - Version history

🤝 Contributing #

Contributions are welcome! Please open an issue or submit a pull request.

📄 License #

MIT License - see LICENSE file for details.