Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

refactor(photos): remove memory music catalog

ashilkn10fd6562ab5d
diff --git a/mobile/apps/photos/lib/services/memories/bundled_memory_music_tracks.dart b/mobile/apps/photos/lib/services/memories/bundled_memory_music_tracks.dart
new file mode 100644
index 0000000000..fd4f29b489
--- /dev/null
+++ b/mobile/apps/photos/lib/services/memories/bundled_memory_music_tracks.dart
@@ -0,0 +1,22 @@
+import "package:photos/models/memories/memory_music_track.dart";
+
+const bundledMemoryMusicTracks = <MemoryMusicTrack>[
+ MemoryMusicTrack(
+ id: "puddles-instrumental-segment-1",
+ assetPath: "assets/memory-music/puddles-instrumental-01.mp3",
+ title: "Puddles (Zero 7 Remix)",
+ artist: "Not for Radio",
+ ),
+ MemoryMusicTrack(
+ id: "puddles-instrumental-segment-2",
+ assetPath: "assets/memory-music/puddles-instrumental-02.mp3",
+ title: "Puddles (Zero 7 Remix)",
+ artist: "Not for Radio",
+ ),
+ MemoryMusicTrack(
+ id: "puddles-instrumental-segment-3",
+ assetPath: "assets/memory-music/puddles-instrumental-03.mp3",
+ title: "Puddles (Zero 7 Remix)",
+ artist: "Not for Radio",
+ ),
+];
diff --git a/mobile/apps/photos/lib/services/memories/memory_music_catalog.dart b/mobile/apps/photos/lib/services/memories/memory_music_catalog.dart
deleted file mode 100644
index 2f85bcfa65..0000000000
--- a/mobile/apps/photos/lib/services/memories/memory_music_catalog.dart
+++ /dev/null
@@ -1,48 +0,0 @@
-import "package:photos/models/memories/memory_music_track.dart";
-
-class MemoryMusicCatalog {
- final List<MemoryMusicTrack> tracks;
- final Map<String, MemoryMusicTrack> _tracksByID =
- <String, MemoryMusicTrack>{};
-
- MemoryMusicCatalog(Iterable<MemoryMusicTrack> inputTracks)
- : tracks = List.unmodifiable(inputTracks) {
- for (final track in tracks) {
- if (track.id.isEmpty) {
- throw ArgumentError.value(track.id, "track.id", "Must not be empty");
- }
- if (_tracksByID.containsKey(track.id)) {
- throw ArgumentError.value(
- track.id,
- "track.id",
- "Memory music track IDs must be unique",
- );
- }
- _tracksByID[track.id] = track;
- }
- }
-
- MemoryMusicTrack? trackForID(String id) => _tracksByID[id];
-
- static final MemoryMusicCatalog bundled =
- MemoryMusicCatalog(const <MemoryMusicTrack>[
- MemoryMusicTrack(
- id: "puddles-instrumental-segment-1",
- assetPath: "assets/memory-music/puddles-instrumental-01.mp3",
- title: "Puddles (Zero 7 Remix)",
- artist: "Not for Radio",
- ),
- MemoryMusicTrack(
- id: "puddles-instrumental-segment-2",
- assetPath: "assets/memory-music/puddles-instrumental-02.mp3",
- title: "Puddles (Zero 7 Remix)",
- artist: "Not for Radio",
- ),
- MemoryMusicTrack(
- id: "puddles-instrumental-segment-3",
- assetPath: "assets/memory-music/puddles-instrumental-03.mp3",
- title: "Puddles (Zero 7 Remix)",
- artist: "Not for Radio",
- ),
- ]);
-}
diff --git a/mobile/apps/photos/lib/services/memories/memory_music_controller.dart b/mobile/apps/photos/lib/services/memories/memory_music_controller.dart
index bcf80aaf80..9e4f654f38 100644
--- a/mobile/apps/photos/lib/services/memories/memory_music_controller.dart
+++ b/mobile/apps/photos/lib/services/memories/memory_music_controller.dart
@@ -2,7 +2,7 @@ import "dart:async";
import "package:flutter/foundation.dart";
import "package:logging/logging.dart";
-import "package:photos/services/memories/memory_music_catalog.dart";
+import "package:photos/models/memories/memory_music_track.dart";
import "package:photos/services/memories/memory_music_player.dart";
enum _MemoryMusicPlaybackStatus { idle, loading, ready }
@@ -10,8 +10,7 @@ enum _MemoryMusicPlaybackStatus { idle, loading, ready }
enum _MemoryMusicPauseReason { appBackground, viewerAction, videoItem }
class MemoryMusicController extends ChangeNotifier {
- final MemoryMusicCatalog _catalog;
- final Map<String, String> _assignments;
+ final Map<String, MemoryMusicTrack> _assignments;
final MemoryMusicPlayer _player;
final Future<void> Function(bool isMuted) _persistMuted;
final Logger _logger = Logger("MemoryMusicController");
@@ -27,13 +26,11 @@ class MemoryMusicController extends ChangeNotifier {
int _loadGeneration = 0;
MemoryMusicController({
- required MemoryMusicCatalog catalog,
- required Map<String, String> assignments,
+ required Map<String, MemoryMusicTrack> assignments,
required bool initiallyMuted,
required Future<void> Function(bool isMuted) persistMuted,
MemoryMusicPlayer? player,
- }) : _catalog = catalog,
- _assignments = assignments,
+ }) : _assignments = assignments,
_isMuted = initiallyMuted,
_persistMuted = persistMuted,
_player = player ?? JustAudioMemoryMusicPlayer();
@@ -56,8 +53,7 @@ class MemoryMusicController extends ChangeNotifier {
return;
}
- final trackID = _assignments[memoryID];
- final track = trackID == null ? null : _catalog.trackForID(trackID);
+ final track = _assignments[memoryID];
final generation = ++_loadGeneration;
if (track == null) {
_status = _MemoryMusicPlaybackStatus.idle;
diff --git a/mobile/apps/photos/lib/services/memories/memory_music_selector.dart b/mobile/apps/photos/lib/services/memories/memory_music_selector.dart
index ece4501701..4e1f0c1b82 100644
--- a/mobile/apps/photos/lib/services/memories/memory_music_selector.dart
+++ b/mobile/apps/photos/lib/services/memories/memory_music_selector.dart
@@ -3,22 +3,22 @@ import "dart:convert";
import "package:crypto/crypto.dart";
import "package:photos/models/memories/memory_music_track.dart";
-Map<String, String> assignMemoryMusicTracks({
+Map<String, MemoryMusicTrack> assignMemoryMusicTracks({
required Iterable<String> memoryIDs,
required List<MemoryMusicTrack> tracks,
}) {
- if (tracks.isEmpty) return const <String, String>{};
+ if (tracks.isEmpty) return const <String, MemoryMusicTrack>{};
- final assignments = <String, String>{};
+ final assignments = <String, MemoryMusicTrack>{};
String? previousTrackID;
for (final memoryID in memoryIDs) {
var trackIndex = _stableTrackIndex(memoryID, tracks.length);
if (tracks.length > 1 && tracks[trackIndex].id == previousTrackID) {
trackIndex = (trackIndex + 1) % tracks.length;
}
- final trackID = tracks[trackIndex].id;
- assignments[memoryID] = trackID;
- previousTrackID = trackID;
+ final track = tracks[trackIndex];
+ assignments[memoryID] = track;
+ previousTrackID = track.id;
}
return Map.unmodifiable(assignments);
}
diff --git a/mobile/apps/photos/lib/services/memories_cache_service.dart b/mobile/apps/photos/lib/services/memories_cache_service.dart
index 4ebfcb47f9..e614f076cf 100644
--- a/mobile/apps/photos/lib/services/memories_cache_service.dart
+++ b/mobile/apps/photos/lib/services/memories_cache_service.dart
@@ -1394,7 +1394,7 @@ class MemoriesCacheService {
if (context != null && !context.mounted) return;
await _routeToPage(
MemoryMusicSession(
- memories: <SmartMemory>[selectedPersonMemory],
+ memoryIDs: <String>[selectedPersonMemory.id],
initialMemoryID: selectedPersonMemory.id,
initialItemIsVideo:
selectedPersonMemory.memories.first.file.fileType == FileType.video,
diff --git a/mobile/apps/photos/lib/ui/home/memories/all_memories_page.dart b/mobile/apps/photos/lib/ui/home/memories/all_memories_page.dart
index c8908d6175..80fe85069f 100644
--- a/mobile/apps/photos/lib/ui/home/memories/all_memories_page.dart
+++ b/mobile/apps/photos/lib/ui/home/memories/all_memories_page.dart
@@ -59,7 +59,7 @@ class _AllMemoriesPageState extends State<AllMemoriesPage>
final initialMemory = _memories[_initialPageIndex];
final initialItemIndex = _initialItemIndexForPage(_initialPageIndex);
return MemoryMusicSession(
- memories: _memories,
+ memoryIDs: _memories.map((memory) => memory.id).toList(),
initialMemoryID: initialMemory.id,
initialItemIsVideo:
initialMemory.memories[initialItemIndex].file.fileType ==
diff --git a/mobile/apps/photos/lib/ui/home/memories/memory_music_session.dart b/mobile/apps/photos/lib/ui/home/memories/memory_music_session.dart
index 02e984841b..c46d5e7d99 100644
--- a/mobile/apps/photos/lib/ui/home/memories/memory_music_session.dart
+++ b/mobile/apps/photos/lib/ui/home/memories/memory_music_session.dart
@@ -1,21 +1,20 @@
import "dart:async";
import "package:flutter/material.dart";
-import "package:photos/models/memories/smart_memory.dart";
import "package:photos/service_locator.dart";
-import "package:photos/services/memories/memory_music_catalog.dart";
+import "package:photos/services/memories/bundled_memory_music_tracks.dart";
import "package:photos/services/memories/memory_music_controller.dart";
import "package:photos/services/memories/memory_music_selector.dart";
class MemoryMusicSession extends StatefulWidget {
- final List<SmartMemory> memories;
+ final List<String> memoryIDs;
final String initialMemoryID;
final bool initialItemIsVideo;
final Widget Function(BuildContext context, MemoryMusicController controller)
builder;
const MemoryMusicSession({
- required this.memories,
+ required this.memoryIDs,
required this.initialMemoryID,
required this.initialItemIsVideo,
required this.builder,
@@ -34,13 +33,11 @@ class _MemoryMusicSessionState extends State<MemoryMusicSession>
void initState() {
super.initState();
WidgetsBinding.instance.addObserver(this);
- final catalog = MemoryMusicCatalog.bundled;
final assignments = assignMemoryMusicTracks(
- memoryIDs: widget.memories.map((memory) => memory.id),
- tracks: catalog.tracks,
+ memoryIDs: widget.memoryIDs,
+ tracks: bundledMemoryMusicTracks,
);
_controller = MemoryMusicController(
- catalog: catalog,
assignments: assignments,
initiallyMuted: localSettings.isMemoriesAudioMuted(),
persistMuted: localSettings.setMemoriesAudioMuted,
diff --git a/mobile/apps/photos/test/services/memories/memory_music_catalog_test.dart b/mobile/apps/photos/test/services/memories/memory_music_catalog_test.dart
deleted file mode 100644
index 71e0df3018..0000000000
--- a/mobile/apps/photos/test/services/memories/memory_music_catalog_test.dart
+++ /dev/null
@@ -1,26 +0,0 @@
-import "package:flutter_test/flutter_test.dart";
-import "package:photos/models/memories/memory_music_track.dart";
-import "package:photos/services/memories/memory_music_catalog.dart";
-
-void main() {
- test("catalog looks up tracks by their stable IDs", () {
- const track = MemoryMusicTrack(
- id: "track-1",
- assetPath: "assets/track-1.mp3",
- );
- final catalog = MemoryMusicCatalog(const <MemoryMusicTrack>[track]);
-
- expect(catalog.trackForID("track-1"), same(track));
- expect(catalog.trackForID("missing"), isNull);
- });
-
- test("catalog rejects duplicate track IDs", () {
- expect(
- () => MemoryMusicCatalog(const <MemoryMusicTrack>[
- MemoryMusicTrack(id: "duplicate", assetPath: "assets/track-1.mp3"),
- MemoryMusicTrack(id: "duplicate", assetPath: "assets/track-2.mp3"),
- ]),
- throwsArgumentError,
- );
- });
-}
diff --git a/mobile/apps/photos/test/services/memories/memory_music_controller_test.dart b/mobile/apps/photos/test/services/memories/memory_music_controller_test.dart
index d81b3651eb..3dc0032394 100644
--- a/mobile/apps/photos/test/services/memories/memory_music_controller_test.dart
+++ b/mobile/apps/photos/test/services/memories/memory_music_controller_test.dart
@@ -1,6 +1,5 @@
import "package:flutter_test/flutter_test.dart";
import "package:photos/models/memories/memory_music_track.dart";
-import "package:photos/services/memories/memory_music_catalog.dart";
import "package:photos/services/memories/memory_music_controller.dart";
import "package:photos/services/memories/memory_music_player.dart";
@@ -13,13 +12,15 @@ void main() {
player = _FakeMemoryMusicPlayer();
persistedMuteValues = <bool>[];
controller = MemoryMusicController(
- catalog: MemoryMusicCatalog(const <MemoryMusicTrack>[
- MemoryMusicTrack(id: "track-1", assetPath: "assets/track-1.mp3"),
- MemoryMusicTrack(id: "track-2", assetPath: "assets/track-2.mp3"),
- ]),
- assignments: const <String, String>{
- "memory-1": "track-1",
- "memory-2": "track-2",
+ assignments: const <String, MemoryMusicTrack>{
+ "memory-1": MemoryMusicTrack(
+ id: "track-1",
+ assetPath: "assets/track-1.mp3",
+ ),
+ "memory-2": MemoryMusicTrack(
+ id: "track-2",
+ assetPath: "assets/track-2.mp3",
+ ),
},
initiallyMuted: false,
persistMuted: (value) async => persistedMuteValues.add(value),
diff --git a/mobile/apps/photos/test/services/memories/memory_music_selector_test.dart b/mobile/apps/photos/test/services/memories/memory_music_selector_test.dart
index ce8378bb8c..cbc4b7cf22 100644
--- a/mobile/apps/photos/test/services/memories/memory_music_selector_test.dart
+++ b/mobile/apps/photos/test/services/memories/memory_music_selector_test.dart
@@ -26,7 +26,7 @@ void main() {
tracks: tracks,
);
final assignedTracks = memoryIDs
- .map((memoryID) => assignments[memoryID])
+ .map((memoryID) => assignments[memoryID]!.id)
.toList();
for (var index = 1; index < assignedTracks.length; index++) {
@@ -34,7 +34,7 @@ void main() {
}
});
- test("one-track catalog reuses its only track", () {
+ test("one-track list reuses its only track", () {
final assignments = assignMemoryMusicTracks(
memoryIDs: memoryIDs,
tracks: const <MemoryMusicTrack>[
@@ -42,10 +42,13 @@ void main() {
],
);
- expect(assignments.values, everyElement("track-1"));
+ expect(
+ assignments.values.map((track) => track.id),
+ everyElement("track-1"),
+ );
});
- test("empty catalog produces no assignments", () {
+ test("empty track list produces no assignments", () {
expect(
assignMemoryMusicTracks(
memoryIDs: memoryIDs,