spotube/lib/provider/proxy_playlist/proxy_playlist_provider.dart

import 'dart:async';
import 'dart:convert';
import 'dart:math';

import 'package:catcher/catcher.dart';
import 'package:collection/collection.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:http/http.dart';
import 'package:palette_generator/palette_generator.dart';
import 'package:spotify/spotify.dart';
import 'package:spotube/components/shared/image/universal_image.dart';
import 'package:spotube/models/local_track.dart';
import 'package:spotube/models/logger.dart';
import 'package:spotube/models/matched_track.dart';
import 'package:spotube/models/skip_segment.dart';
import 'package:spotube/models/spotube_track.dart';
import 'package:spotube/provider/blacklist_provider.dart';
import 'package:spotube/provider/palette_provider.dart';
import 'package:spotube/provider/proxy_playlist/next_fetcher_mixin.dart';
import 'package:spotube/provider/proxy_playlist/proxy_playlist.dart';
import 'package:spotube/provider/user_preferences_provider.dart';
import 'package:spotube/provider/youtube_provider.dart';
import 'package:spotube/services/audio_player/audio_player.dart';
import 'package:spotube/services/audio_services/audio_services.dart';
import 'package:spotube/services/youtube/youtube.dart';
import 'package:spotube/utils/persisted_state_notifier.dart';
import 'package:spotube/utils/type_conversion_utils.dart';

/// Things implemented:
/// * [x] Sponsor-Block skip
/// * [x] Prefetch next track as [SpotubeTrack] on 80% of current track
/// * [x] Mixed Queue containing both [SpotubeTrack] and [LocalTrack]
/// * [x] Modification of the Queue
///       * [x] Add track at the end
///       * [x] Add track at the beginning
///       * [x] Remove track
///       * [x] Reorder track
/// * [x] Caching and loading of cache of tracks
/// * [x] Shuffling
/// * [x] loop => playlist, track, none
/// * [x] Alternative Track Source
/// * [x] Blacklisting of tracks and artist
///
/// Don'ts:
/// * It'll not have any proxy method for [SpotubeAudioPlayer]
/// * It'll not store any sort of player state e.g playing, paused, shuffled etc
///   * For that, use [SpotubeAudioPlayer]

class ProxyPlaylistNotifier extends PersistedStateNotifier<ProxyPlaylist>
    with NextFetcher {
  final Ref ref;
  late final AudioServices notificationService;

  UserPreferences get preferences => ref.read(userPreferencesProvider);
  YoutubeEndpoints get youtube => ref.read(youtubeProvider);
  ProxyPlaylist get playlist => state;
  BlackListNotifier get blacklist =>
      ref.read(BlackListNotifier.provider.notifier);

  static final provider =
      StateNotifierProvider<ProxyPlaylistNotifier, ProxyPlaylist>(
    (ref) => ProxyPlaylistNotifier(ref),
  );

  static AlwaysAliveRefreshable<ProxyPlaylistNotifier> get notifier =>
      provider.notifier;

  ProxyPlaylistNotifier(this.ref) : super(ProxyPlaylist({}), "playlist") {
    () async {
      notificationService = await AudioServices.create(ref, this);

      // listeners state
      final currentSegments =
          // using source as unique id because alternative track source support
          ObjectRef<({String source, List<SkipSegment> segments})?>(null);
      final isPreSearching = ObjectRef(false);
      final isFetchingSegments = ObjectRef(false);

      audioPlayer.activeSourceChangedStream.listen((newActiveSource) async {
        try {
          final newActiveTrack =
              mapSourcesToTracks([newActiveSource]).firstOrNull;

          if (newActiveTrack == null ||
              newActiveTrack.id == state.activeTrack?.id) {
            return;
          }

          notificationService.addTrack(newActiveTrack);
          state = state.copyWith(
            active: state.tracks
                .toList()
                .indexWhere((element) => element.id == newActiveTrack.id),
          );

          updatePalette();
        } catch (e, stackTrace) {
          Catcher.reportCheckedError(e, stackTrace);
        }
      });

      audioPlayer.shuffledStream.listen((event) {
        try {
          final newlyOrderedTracks = mapSourcesToTracks(audioPlayer.sources);

          final newActiveIndex = newlyOrderedTracks.indexWhere(
            (element) => element.id == state.activeTrack?.id,
          );

          if (newActiveIndex == -1) return;

          state = state.copyWith(
            tracks: newlyOrderedTracks.toSet(),
            active: newActiveIndex,
          );
        } catch (e, stackTrace) {
          Catcher.reportCheckedError(e, stackTrace);
        }
      });

      listenTo2Percent(int percent) async {
        if (isPreSearching.value ||
            audioPlayer.currentSource == null ||
            audioPlayer.nextSource == null ||
            isPlayable(audioPlayer.nextSource!)) return;

        try {
          isPreSearching.value = true;

          final oldTrack =
              mapSourcesToTracks([audioPlayer.nextSource!]).firstOrNull;

          final track = await ensureSourcePlayable(audioPlayer.nextSource!);

          if (track != null) {
            state = state.copyWith(tracks: mergeTracks([track], state.tracks));
          }

          if (oldTrack != null && track != null) {
            await storeTrack(
              oldTrack,
              track,
            );
          }
        } catch (e, stackTrace) {
          // Removing tracks that were not found to avoid queue interruption
          // TODO: Add a flag to enable/disable skip not found tracks
          if (e is TrackNotFoundException) {
            final oldTrack =
                mapSourcesToTracks([audioPlayer.nextSource!]).firstOrNull;
            await removeTrack(oldTrack!.id!);
          }
          Catcher.reportCheckedError(e, stackTrace);
        } finally {
          isPreSearching.value = false;
        }
      }

      audioPlayer.percentCompletedStream(2).listen(listenTo2Percent);

      audioPlayer.positionStream.listen((position) async {
        if (state.activeTrack == null || state.activeTrack is LocalTrack) {
          isFetchingSegments.value = false;
          return;
        }
        try {
          final isYTMusicMode =
              preferences.youtubeApiType == YoutubeApiType.piped &&
                  preferences.searchMode == SearchMode.youtubeMusic;

          if (isYTMusicMode || !preferences.skipNonMusic) return;

          final isNotSameSegmentId =
              currentSegments.value?.source != audioPlayer.currentSource;

          if (currentSegments.value == null ||
              (isNotSameSegmentId && !isFetchingSegments.value)) {
            isFetchingSegments.value = true;
            try {
              currentSegments.value = (
                source: audioPlayer.currentSource!,
                segments: await getAndCacheSkipSegments(
                  (state.activeTrack as SpotubeTrack).ytTrack.id,
                ),
              );
            } catch (e) {
              if (audioPlayer.currentSource != null) {
                currentSegments.value = (
                  source: audioPlayer.currentSource!,
                  segments: [],
                );
              }
            } finally {
              isFetchingSegments.value = false;
            }
          }

          final (source: _, :segments) = currentSegments.value!;

          // skipping in first 2 second breaks stream
          if (segments.isEmpty || position < const Duration(seconds: 3)) return;

          for (final segment in segments) {
            if (position.inSeconds >= segment.start &&
                position.inSeconds < segment.end) {
              await audioPlayer.seek(Duration(seconds: segment.end));
            }
          }
        } catch (e, stackTrace) {
          Catcher.reportCheckedError(e, stackTrace);
        }
      });
    }();
  }

  Future<SpotubeTrack?> ensureSourcePlayable(String source) async {
    if (isPlayable(source)) return null;

    final track = mapSourcesToTracks([source]).firstOrNull;

    if (track == null || track is LocalTrack) {
      return null;
    }

    final nthFetchedTrack = switch (track.runtimeType) {
      SpotubeTrack => track as SpotubeTrack,
      _ => await SpotubeTrack.fetchFromTrack(
          track,
          youtube,
          preferences.streamMusicCodec,
        ),
    };

    await audioPlayer.replaceSource(
      source,
      nthFetchedTrack.ytUri,
    );

    return nthFetchedTrack;
  }

  // Basic methods for adding or removing tracks to playlist

  Future<void> addTrack(Track track) async {
    if (blacklist.contains(track)) return;
    state = state.copyWith(tracks: {...state.tracks, track});
    await audioPlayer.addTrack(makeAppropriateSource(track));
  }

  Future<void> addTracks(Iterable<Track> tracks) async {
    tracks = blacklist.filter(tracks).toList() as List<Track>;
    state = state.copyWith(tracks: {...state.tracks, ...tracks});
    for (final track in tracks) {
      await audioPlayer.addTrack(makeAppropriateSource(track));
    }
  }

  void addCollection(String collectionId) {
    state = state.copyWith(collections: {
      ...state.collections,
      collectionId,
    });
  }

  void removeCollection(String collectionId) {
    state = state.copyWith(collections: {
      ...state.collections..remove(collectionId),
    });
  }

  // TODO: Safely Remove playing tracks

  Future<void> removeTrack(String trackId) async {
    final track =
        state.tracks.firstWhereOrNull((element) => element.id == trackId);
    if (track == null) return;
    state = state.copyWith(tracks: {...state.tracks..remove(track)});
    final index = audioPlayer.sources.indexOf(makeAppropriateSource(track));
    if (index == -1) return;
    await audioPlayer.removeTrack(index);
  }

  Future<void> removeTracks(Iterable<String> tracksIds) async {
    final tracks =
        state.tracks.where((element) => tracksIds.contains(element.id));

    state = state.copyWith(tracks: {
      ...state.tracks..removeWhere((element) => tracksIds.contains(element.id))
    });

    for (final track in tracks) {
      final index = audioPlayer.sources.indexOf(makeAppropriateSource(track));
      if (index == -1) continue;
      await audioPlayer.removeTrack(index);
    }
  }

  Future<void> load(
    Iterable<Track> tracks, {
    int initialIndex = 0,
    bool autoPlay = false,
  }) async {
    tracks = blacklist.filter(tracks).toList() as List<Track>;
    final indexTrack = tracks.elementAtOrNull(initialIndex) ?? tracks.first;

    if (indexTrack is LocalTrack) {
      state = state.copyWith(
        tracks: tracks.toSet(),
        active: initialIndex,
        collections: {},
      );
      await notificationService.addTrack(indexTrack);
    } else {
      final addableTrack = await SpotubeTrack.fetchFromTrack(
        tracks.elementAtOrNull(initialIndex) ?? tracks.first,
        youtube,
        preferences.streamMusicCodec,
      ).catchError((e, stackTrace) {
        return SpotubeTrack.fetchFromTrack(
          tracks.elementAtOrNull(initialIndex + 1) ?? tracks.first,
          youtube,
          preferences.streamMusicCodec,
        );
      });

      state = state.copyWith(
        tracks: mergeTracks([addableTrack], tracks),
        active: initialIndex,
        collections: {},
      );
      await notificationService.addTrack(addableTrack);
      await storeTrack(
        tracks.elementAt(initialIndex),
        addableTrack,
      );
    }

    await audioPlayer.openPlaylist(
      state.tracks.map(makeAppropriateSource).toList(),
      initialIndex: initialIndex,
      autoPlay: autoPlay,
    );
  }

  Future<void> jumpTo(int index) async {
    final oldTrack =
        mapSourcesToTracks([audioPlayer.currentSource!]).firstOrNull;

    state = state.copyWith(active: index);
    await audioPlayer.pause();
    final track = await ensureSourcePlayable(audioPlayer.sources[index]);

    if (track != null) {
      state = state.copyWith(
        tracks: mergeTracks([track], state.tracks),
        active: index,
      );
    }

    await audioPlayer.jumpTo(index);

    if (oldTrack != null || track != null) {
      await notificationService.addTrack(track ?? oldTrack!);
    }

    if (oldTrack != null && track != null) {
      await storeTrack(
        oldTrack,
        track,
      );
    }
  }

  Future<void> jumpToTrack(Track track) async {
    final index =
        state.tracks.toList().indexWhere((element) => element.id == track.id);
    if (index == -1) return;
    await jumpTo(index);
  }

  // TODO: add safe guards for active/playing track that needs to be moved
  Future<void> moveTrack(int oldIndex, int newIndex) async {
    if (oldIndex == newIndex ||
        newIndex < 0 ||
        oldIndex < 0 ||
        newIndex > state.tracks.length - 1 ||
        oldIndex > state.tracks.length - 1) return;

    final tracks = state.tracks.toList();
    final track = tracks.removeAt(oldIndex);
    tracks.insert(newIndex, track);
    state = state.copyWith(tracks: {...tracks});

    await audioPlayer.moveTrack(oldIndex, newIndex);
  }

  Future<void> addTracksAtFirst(Iterable<Track> tracks) async {
    if (state.tracks.length == 1) {
      return addTracks(tracks);
    }

    tracks = blacklist.filter(tracks).toList() as List<Track>;
    final destIndex = state.active != null ? state.active! + 1 : 0;
    final newTracks = state.tracks.toList()..insertAll(destIndex, tracks);
    state = state.copyWith(tracks: newTracks.toSet());

    tracks.forEachIndexed((index, track) async {
      audioPlayer.addTrackAt(
        makeAppropriateSource(track),
        destIndex + index,
      );
    });
  }

  Future<void> populateSibling() async {
    if (state.activeTrack is SpotubeTrack) {
      final activeTrackWithSiblingsForSure =
          await (state.activeTrack as SpotubeTrack).populatedCopy(youtube);

      state = state.copyWith(
        tracks: mergeTracks([activeTrackWithSiblingsForSure], state.tracks),
        active: state.tracks.toList().indexWhere(
            (element) => element.id == activeTrackWithSiblingsForSure.id),
      );
    }
  }

  Future<void> swapSibling(YoutubeVideoInfo video) async {
    if (state.activeTrack is SpotubeTrack) {
      await populateSibling();
      final newTrack =
          await (state.activeTrack as SpotubeTrack).swappedCopy(video, youtube);
      if (newTrack == null) return;
      state = state.copyWith(
        tracks: mergeTracks([newTrack], state.tracks),
        active: state.tracks
            .toList()
            .indexWhere((element) => element.id == newTrack.id),
      );
      await audioPlayer.pause();
      await audioPlayer.replaceSource(
        audioPlayer.currentSource!,
        makeAppropriateSource(newTrack),
      );
    }
  }

  Future<void> next() async {
    if (audioPlayer.nextSource == null) return;
    final oldTrack = mapSourcesToTracks([audioPlayer.nextSource!]).firstOrNull;

    state = state.copyWith(
      active: state.tracks
          .toList()
          .indexWhere((element) => element.id == oldTrack?.id),
    );

    await audioPlayer.pause();
    final track = await ensureSourcePlayable(audioPlayer.nextSource!);

    if (track != null) {
      state = state.copyWith(
        tracks: mergeTracks([track], state.tracks),
        active: state.tracks
            .toList()
            .indexWhere((element) => element.id == track.id),
      );
    }
    await audioPlayer.skipToNext();

    if (oldTrack != null || track != null) {
      await notificationService.addTrack(track ?? oldTrack!);
    }
    if (oldTrack != null && track != null) {
      await storeTrack(
        oldTrack,
        track,
      );
    }
  }

  Future<void> previous() async {
    if (audioPlayer.previousSource == null) return;
    final oldTrack =
        mapSourcesToTracks([audioPlayer.previousSource!]).firstOrNull;
    state = state.copyWith(
      active: state.tracks
          .toList()
          .indexWhere((element) => element.id == oldTrack?.id),
    );
    await audioPlayer.pause();
    final track = await ensureSourcePlayable(audioPlayer.previousSource!);
    if (track != null) {
      state = state.copyWith(
        tracks: mergeTracks([track], state.tracks),
        active: state.tracks
            .toList()
            .indexWhere((element) => element.id == track.id),
      );
    }
    await audioPlayer.skipToPrevious();
    if (oldTrack != null || track != null) {
      await notificationService.addTrack(track ?? oldTrack!);
    }
    if (oldTrack != null && track != null) {
      await storeTrack(
        oldTrack,
        track,
      );
    }
  }

  Future<void> stop() async {
    state = ProxyPlaylist({});
    await audioPlayer.stop();
  }

  Future<void> updatePalette() async {
    final palette = ref.read(paletteProvider);
    if (!preferences.albumColorSync) {
      if (palette != null) ref.read(paletteProvider.notifier).state = null;
      return;
    }
    return Future.microtask(() async {
      if (state.activeTrack == null) return;

      final palette = await PaletteGenerator.fromImageProvider(
        UniversalImage.imageProvider(
          TypeConversionUtils.image_X_UrlString(
            state.activeTrack?.album?.images,
            placeholder: ImagePlaceholder.albumArt,
          ),
          height: 50,
          width: 50,
        ),
      );
      ref.read(paletteProvider.notifier).state = palette;
    });
  }

  Future<List<SkipSegment>> getAndCacheSkipSegments(String id) async {
    if (!preferences.skipNonMusic ||
        (preferences.youtubeApiType == YoutubeApiType.piped &&
            preferences.searchMode == SearchMode.youtubeMusic)) return [];

    try {
      final cached = await SkipSegment.box.get(id);
      if (cached != null && cached.isNotEmpty) {
        return List.castFrom<dynamic, SkipSegment>(
          (cached as List)
              .map(
                (json) => SkipSegment.fromJson(
                  Map.castFrom<dynamic, dynamic, String, dynamic>(json),
                ),
              )
              .toList(),
        );
      }

      final res = await get(Uri(
        scheme: "https",
        host: "sponsor.ajay.app",
        path: "/api/skipSegments",
        queryParameters: {
          "videoID": id,
          "category": [
            'sponsor',
            'selfpromo',
            'interaction',
            'intro',
            'outro',
            'music_offtopic'
          ],
          "actionType": 'skip'
        },
      ));

      if (res.body == "Not Found") {
        return List.castFrom<dynamic, SkipSegment>([]);
      }

      final data = jsonDecode(res.body) as List;
      final segments = data.map((obj) {
        final start = obj["segment"].first.toInt();
        final end = obj["segment"].last.toInt();
        return SkipSegment(
          start,
          end,
        );
      }).toList();
      getLogger('getSkipSegments').v(
        "[SponsorBlock] successfully fetched skip segments for $id",
      );

      await SkipSegment.box.put(
        id,
        segments.map((e) => e.toJson()).toList(),
      );
      return List.castFrom<dynamic, SkipSegment>(segments);
    } catch (e, stack) {
      await SkipSegment.box.put(id, []);
      Catcher.reportCheckedError(e, stack);
      return List.castFrom<dynamic, SkipSegment>([]);
    }
  }

  @override
  set state(state) {
    super.state = state;
    if (state.tracks.isEmpty && ref.read(paletteProvider) != null) {
      ref.read(paletteProvider.notifier).state = null;
    } else {
      updatePalette();
    }
  }

  @override
  onInit() async {
    if (state.tracks.isEmpty) return null;
    final oldCollections = state.collections;
    await load(
      state.tracks,
      initialIndex: max(state.active ?? 0, 0),
      autoPlay: false,
    );
    state = state.copyWith(collections: oldCollections);
  }

  @override
  FutureOr<ProxyPlaylist> fromJson(Map<String, dynamic> json) {
    return ProxyPlaylist.fromJson(json);
  }

  @override
  Map<String, dynamic> toJson() {
    final json = state.toJson();
    return json;
  }
}