mirror of
https://github.com/zarzet/SpotiFLAC-Mobile.git
synced 2026-11-21 20:00:49 +01:00
feat(metadata): offer only lyrics extensions as the source for lyrics
Auto-fill in the metadata editor listed the metadata extensions as its source even when Lyrics was the only field asked for, although a metadata source has no say in where lyrics come from. With Lyrics alone selected the source choice now lists the enabled lyrics extensions, and a chosen one is the only provider asked. Automatic still asks every enabled lyrics provider in the order of the lyrics settings.
This commit is contained in:
1 parent
fa667d6a0d
commit
a612b2dd65
3 files changed
+106
-8
No files matched your search
@@ -223,6 +223,15 @@ extension _EditMetadataSheetAutoFill on _EditMetadataSheetState {
|
||||
final usesAutomaticProvider =
|
||||
selectedProviderId == null || selectedProviderId.isEmpty;
|
||||
final needsTrackLookup = fields.any((key) => key != 'lyrics');
|
||||
final lyricsExtensionId =
|
||||
configuredProviderId == null ||
|
||||
!MetadataAutofillService.lyricsOnly(fields)
|
||||
? null
|
||||
: _autofill
|
||||
.lyricsProviders(extensionState)
|
||||
.where((extension) => extension.id == configuredProviderId)
|
||||
.firstOrNull
|
||||
?.id;
|
||||
Map<String, dynamic>? best;
|
||||
|
||||
final queryParts = <String>[];
|
||||
@@ -313,6 +322,7 @@ extension _EditMetadataSheetAutoFill on _EditMetadataSheetState {
|
||||
durationMs: widget.durationMs,
|
||||
syncLyricsSettings: settingsNotifier.syncLyricsSettingsToBackend,
|
||||
isCurrent: isCurrent,
|
||||
lyricsExtensionId: lyricsExtensionId,
|
||||
);
|
||||
if (!mounted || !isCurrent() || result == null) return;
|
||||
final availableValues = result.values;
|
||||
@@ -462,7 +472,10 @@ extension _EditMetadataSheetAutoFill on _EditMetadataSheetState {
|
||||
Consumer(
|
||||
builder: (context, ref, _) {
|
||||
final extensionState = ref.watch(extensionProvider);
|
||||
final providers = _autofill.orderedProviders(extensionState);
|
||||
final providers =
|
||||
MetadataAutofillService.lyricsOnly(_form.autoFillFields)
|
||||
? _autofill.lyricsProviders(extensionState)
|
||||
: _autofill.orderedProviders(extensionState);
|
||||
final selectedProviderIsAvailable = providers.any(
|
||||
(extension) => extension.id == _selectedMetadataProviderId,
|
||||
);
|
||||
|
||||
@@ -122,6 +122,7 @@ class MetadataAutofillService {
|
||||
required int durationMs,
|
||||
required Future<void> Function() syncLyricsSettings,
|
||||
required bool Function() isCurrent,
|
||||
String? lyricsExtensionId,
|
||||
}) async {
|
||||
if (!isCurrent()) return null;
|
||||
final title = currentValues['title']?.trim() ?? '';
|
||||
@@ -236,12 +237,22 @@ class MetadataAutofillService {
|
||||
|
||||
if (lyricsTitle.isNotEmpty && lyricsArtist.isNotEmpty) {
|
||||
try {
|
||||
final lyricsResult = await PlatformBridge.getLyricsLRCWithSource(
|
||||
rawSpotifyId ?? '',
|
||||
lyricsTitle,
|
||||
lyricsArtist,
|
||||
durationMs: durationMs,
|
||||
);
|
||||
// A chosen lyrics extension answers alone; otherwise every enabled
|
||||
// provider is asked in the order of the lyrics settings.
|
||||
final lyricsResult = lyricsExtensionId == null
|
||||
? await PlatformBridge.getLyricsLRCWithSource(
|
||||
rawSpotifyId ?? '',
|
||||
lyricsTitle,
|
||||
lyricsArtist,
|
||||
durationMs: durationMs,
|
||||
)
|
||||
: await PlatformBridge.getLyricsFromProvider(
|
||||
'extension:${lyricsExtensionId.toLowerCase()}',
|
||||
trackName: lyricsTitle,
|
||||
artistName: lyricsArtist,
|
||||
spotifyId: rawSpotifyId ?? '',
|
||||
durationMs: durationMs,
|
||||
);
|
||||
final lyricsText = lyricsResult['lyrics']?.toString().trim() ?? '';
|
||||
final lyricsSource = lyricsResult['source']?.toString().trim() ?? '';
|
||||
if (lyricsSource.isNotEmpty) lyricsSourceName = lyricsSource;
|
||||
@@ -279,11 +290,29 @@ class MetadataAutofillService {
|
||||
: null,
|
||||
sourceId: providerId?.isNotEmpty == true
|
||||
? providerId!
|
||||
: selectedBest?['provider_id']?.toString().trim() ?? '',
|
||||
: selectedBest?['provider_id']?.toString().trim() ??
|
||||
lyricsExtensionId ??
|
||||
'',
|
||||
lyricsSource: selectedBest == null ? lyricsSourceName : null,
|
||||
);
|
||||
}
|
||||
|
||||
/// Whether lyrics are the only thing [fields] asks for. The source choice
|
||||
/// then lists [lyricsProviders], since a metadata source has no say in
|
||||
/// where lyrics come from.
|
||||
static bool lyricsOnly(Set<String> fields) =>
|
||||
fields.length == 1 && fields.contains('lyrics');
|
||||
|
||||
/// The enabled extensions that provide lyrics, by name.
|
||||
List<Extension> lyricsProviders(ExtensionState state) =>
|
||||
[
|
||||
for (final extension in state.extensions)
|
||||
if (extension.enabled && extension.hasLyricsProvider) extension,
|
||||
]..sort(
|
||||
(a, b) =>
|
||||
a.displayName.toLowerCase().compareTo(b.displayName.toLowerCase()),
|
||||
);
|
||||
|
||||
List<Extension> orderedProviders(ExtensionState state) {
|
||||
final providersById = <String, Extension>{
|
||||
for (final extension in state.extensions)
|
||||
|
||||
@@ -212,4 +212,60 @@ void main() {
|
||||
expect(result.values.containsKey('lyrics'), !instrumental);
|
||||
});
|
||||
}
|
||||
|
||||
test('a chosen lyrics extension is the only provider asked', () async {
|
||||
const channel = MethodChannel('com.zarz.mornye/backend');
|
||||
final messenger =
|
||||
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger;
|
||||
messenger.setMockMethodCallHandler(channel, (call) async {
|
||||
expect(call.method, 'getLyricsFromProvider');
|
||||
expect((call.arguments as Map)['provider'], 'extension:example.lyrics');
|
||||
return jsonEncode({'lyrics': '[00:01.00]Lyric'});
|
||||
});
|
||||
addTearDown(() => messenger.setMockMethodCallHandler(channel, null));
|
||||
final result = await service.enrich(
|
||||
null,
|
||||
currentValues: const {'title': 'Song', 'artist': 'Artist'},
|
||||
fields: {'lyrics'},
|
||||
providerId: null,
|
||||
sourceTrackId: null,
|
||||
durationMs: 180000,
|
||||
syncLyricsSettings: () async {},
|
||||
isCurrent: () => true,
|
||||
lyricsExtensionId: 'Example.Lyrics',
|
||||
);
|
||||
expect(result!.values['lyrics'], '[00:01.00]Lyric');
|
||||
expect(result.sourceId, 'Example.Lyrics');
|
||||
});
|
||||
|
||||
test('the source choice for lyrics alone lists lyrics extensions only', () {
|
||||
Extension extension(String id, {bool lyrics = false, bool on = true}) =>
|
||||
Extension(
|
||||
id: id,
|
||||
name: id,
|
||||
displayName: id,
|
||||
version: '1.0.0',
|
||||
description: '',
|
||||
enabled: on,
|
||||
status: 'loaded',
|
||||
hasMetadataProvider: !lyrics,
|
||||
hasLyricsProvider: lyrics,
|
||||
);
|
||||
final state = ExtensionState(
|
||||
extensions: [
|
||||
extension('metadata'),
|
||||
extension('words-b', lyrics: true),
|
||||
extension('words-a', lyrics: true),
|
||||
extension('words-off', lyrics: true, on: false),
|
||||
],
|
||||
);
|
||||
expect(MetadataAutofillService.lyricsOnly({'lyrics'}), isTrue);
|
||||
expect(MetadataAutofillService.lyricsOnly({'lyrics', 'cover'}), isFalse);
|
||||
expect(MetadataAutofillService.lyricsOnly({'cover'}), isFalse);
|
||||
expect(service.lyricsProviders(state).map((e) => e.id), [
|
||||
'words-a',
|
||||
'words-b',
|
||||
]);
|
||||
expect(service.orderedProviders(state).map((e) => e.id), ['metadata']);
|
||||
});
|
||||
}
|
||||
Reference in new issue
Block a user