feat: add endless playback support #285

Author: KRTirtho

analysis_options.yaml

@@ -31,4 +31,6 @@ linter:
 analyzer:
   enable-experiment:
     - records
-    - patterns
+    - patterns
+  errors:
+    invalid_annotation_target: ignore

lib/components/shared/track_tile/track_options.dart

@@ -106,14 +106,22 @@ class TrackOptions extends HookConsumerWidget {
         ) ??
         [];
 
-    final radios = pages.expand((e) => e.items ?? <PlaylistSimple>[]).toList();
+    final radios = pages
+        .expand((e) => e.items?.toList() ?? <PlaylistSimple>[])
+        .toList()
+        .cast<PlaylistSimple>();
 
     final artists = track.artists!.map((e) => e.name);
 
     final radio = radios.firstWhere(
-      (e) =>
-          e.name == "${track.name} Radio" &&
-          artists.where((a) => e.name!.contains(a!)).length >= 2,
+      (e) {
+        final validPlaylists =
+            artists.where((a) => e.description!.contains(a!));
+        return e.name == "${track.name} Radio" &&
+            (validPlaylists.length >= 2 ||
+                validPlaylists.length == artists.length) &&
+            e.owner?.displayName == "Spotify";
+      },
       orElse: () => radios.first,
     );
 
@@ -129,9 +137,12 @@ class TrackOptions extends HookConsumerWidget {
       );
     }
 
-    if (replaceQueue) {
+    if (replaceQueue || playlist.tracks.isEmpty) {
       await playback.stop();
       await playback.load([track], autoPlay: true);
+
+      // we don't have to add those tracks as useEndlessPlayback will do it for us
+      return;
     } else {
       await playback.addTrack(track);
     }

lib/hooks/configurators/use_endless_playback.dart

@@ -0,0 +1,102 @@
+import 'package:catcher_2/catcher_2.dart';
+import 'package:fl_query_hooks/fl_query_hooks.dart';
+import 'package:flutter_hooks/flutter_hooks.dart';
+import 'package:flutter_riverpod/flutter_riverpod.dart';
+import 'package:spotify/spotify.dart';
+import 'package:spotube/provider/authentication_provider.dart';
+import 'package:spotube/provider/proxy_playlist/proxy_playlist_provider.dart';
+import 'package:spotube/provider/spotify_provider.dart';
+import 'package:spotube/provider/user_preferences/user_preferences_provider.dart';
+import 'package:spotube/services/audio_player/audio_player.dart';
+import 'package:spotube/services/queries/search.dart';
+
+void useEndlessPlayback(WidgetRef ref) {
+  final auth = ref.watch(AuthenticationNotifier.provider);
+  final playback = ref.watch(ProxyPlaylistNotifier.notifier);
+  final playlist = ref.watch(ProxyPlaylistNotifier.provider);
+  final spotify = ref.watch(spotifyProvider);
+  final endlessPlayback =
+      ref.watch(userPreferencesProvider.select((s) => s.endlessPlayback));
+
+  final queryClient = useQueryClient();
+
+  useEffect(
+    () {
+      if (!endlessPlayback || auth == null) return null;
+
+      void listener(int index) async {
+        try {
+          final playlist = ref.read(ProxyPlaylistNotifier.provider);
+          if (index != playlist.tracks.length - 1) return;
+
+          final track = playlist.tracks.last;
+
+          final pages = await queryClient.fetchInfiniteQueryJob<List<Page>,
+                  dynamic, int, SearchParams>(
+                job: SearchQueries.queryJob(SearchType.playlist.name),
+                args: (
+                  spotify: spotify,
+                  searchType: SearchType.playlist,
+                  query: "${track.name} Radio"
+                ),
+              ) ??
+              [];
+
+          final radios = pages
+              .expand((e) => e.items?.toList() ?? <PlaylistSimple>[])
+              .toList()
+              .cast<PlaylistSimple>();
+
+          final artists = track.artists!.map((e) => e.name);
+
+          final radio = radios.firstWhere(
+            (e) {
+              final validPlaylists =
+                  artists.where((a) => e.description!.contains(a!));
+              return e.name == "${track.name} Radio" &&
+                  (validPlaylists.length >= 2 ||
+                      validPlaylists.length == artists.length) &&
+                  e.owner?.displayName != "Spotify";
+            },
+            orElse: () => radios.first,
+          );
+
+          final tracks =
+              await spotify.playlists.getTracksByPlaylistId(radio.id!).all();
+
+          await playback.addTracks(
+            tracks.toList()
+              ..removeWhere((e) {
+                final playlist = ref.read(ProxyPlaylistNotifier.provider);
+                final isDuplicate = playlist.tracks.any((t) => t.id == e.id);
+                return e.id == track.id || isDuplicate;
+              }),
+          );
+        } catch (e, stack) {
+          Catcher2.reportCheckedError(e, stack);
+        }
+      }
+
+      // Sometimes user can change settings for which the currentIndexChanged
+      // might not be called. So we need to check if the current track is the
+      // last track and if it is then we need to call the listener manually.
+      if (playlist.active == playlist.tracks.length - 1 &&
+          audioPlayer.isPlaying) {
+        listener(playlist.active!);
+      }
+
+      final subscription =
+          audioPlayer.currentIndexChangedStream.listen(listener);
+
+      return subscription.cancel;
+    },
+    [
+      spotify,
+      playback,
+      queryClient,
+      playlist.tracks,
+      endlessPlayback,
+      auth,
+    ],
+  );
+}

lib/l10n/app_en.arb

@@ -289,5 +289,6 @@
   "no_lyrics_available": "Sorry, unable find lyrics for this track",
   "start_a_radio": "Start a Radio",
   "how_to_start_radio": "How do you want to start the radio?",
-  "replace_queue_question": "Do you want to replace the current queue or append to it?"
+  "replace_queue_question": "Do you want to replace the current queue or append to it?",
+  "endless_playback": "Endless Playback"
 }

lib/pages/root/root_app.dart

@@ -15,6 +15,7 @@ import 'package:spotube/components/root/bottom_player.dart';
 import 'package:spotube/components/root/sidebar.dart';
 import 'package:spotube/components/root/spotube_navigation_bar.dart';
 import 'package:spotube/extensions/context.dart';
+import 'package:spotube/hooks/configurators/use_endless_playback.dart';
 import 'package:spotube/hooks/configurators/use_update_checker.dart';
 import 'package:spotube/provider/download_manager_provider.dart';
 import 'package:spotube/utils/persisted_state_notifier.dart';
@@ -134,6 +135,8 @@ class RootApp extends HookConsumerWidget {
     // checks for latest version of the application
     useUpdateChecker(ref);
 
+    useEndlessPlayback(ref);
+
     final backgroundColor = Theme.of(context).scaffoldBackgroundColor;
 
     useEffect(() {

lib/pages/settings/sections/playback.dart

@@ -221,6 +221,12 @@ class SettingsPlaybackSection extends HookConsumerWidget {
               preferencesNotifier.setDownloadMusicCodec(value);
             },
           ),
+        SwitchListTile(
+          secondary: const Icon(SpotubeIcons.repeat),
+          title: Text(context.l10n.endless_playback),
+          value: preferences.endlessPlayback,
+          onChanged: preferencesNotifier.setEndlessPlayback,
+        ),
       ],
     );
   }

lib/provider/user_preferences/user_preferences_provider.dart

@@ -123,6 +123,10 @@ class UserPreferencesNotifier extends PersistedStateNotifier<UserPreferences> {
     audioPlayer.setAudioNormalization(normalize);
   }
 
+  void setEndlessPlayback(bool endless) {
+    state = state.copyWith(endlessPlayback: endless);
+  }
+
   Future<String> _getDefaultDownloadDirectory() async {
     if (kIsAndroid) return "/storage/emulated/0/Download/Spotube";