spotube/lib/services/sourced_track/sources/youtube.dart

import 'package:collection/collection.dart';
import 'package:drift/drift.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:spotify/spotify.dart';
import 'package:spotube/models/database/database.dart';
import 'package:spotube/provider/database/database.dart';
import 'package:spotube/provider/youtube_engine/youtube_engine.dart';
import 'package:spotube/services/logger/logger.dart';
import 'package:spotube/services/song_link/song_link.dart';
import 'package:spotube/services/sourced_track/enums.dart';
import 'package:spotube/services/sourced_track/exceptions.dart';
import 'package:spotube/services/sourced_track/models/source_info.dart';
import 'package:spotube/services/sourced_track/models/source_map.dart';
import 'package:spotube/services/sourced_track/models/video_info.dart';
import 'package:spotube/services/sourced_track/sourced_track.dart';
import 'package:spotube/utils/service_utils.dart';
import 'package:youtube_explode_dart/youtube_explode_dart.dart';

final officialMusicRegex = RegExp(
  r"official\s(video|audio|music\svideo|lyric\svideo|visualizer)",
  caseSensitive: false,
);

class YoutubeSourceInfo extends SourceInfo {
  YoutubeSourceInfo({
    required super.id,
    required super.title,
    required super.artist,
    required super.thumbnail,
    required super.pageUrl,
    required super.duration,
    required super.artistUrl,
    required super.album,
  });
}

class YoutubeSourcedTrack extends SourcedTrack {
  YoutubeSourcedTrack({
    required super.source,
    required super.siblings,
    required super.sourceInfo,
    required super.track,
    required super.ref,
  });

  static Future<YoutubeSourcedTrack> fetchFromTrack({
    required Track track,
    required Ref ref,
  }) async {
    // Indicates the track is requesting a stream refresh
    if (track is YoutubeSourcedTrack) {
      final manifest = await ref
          .read(youtubeEngineProvider)
          .getStreamManifest(track.sourceInfo.id);

      final sourcedTrack = YoutubeSourcedTrack(
        ref: ref,
        siblings: track.siblings,
        source: toSourceMap(manifest),
        sourceInfo: track.sourceInfo,
        track: track,
      );

      AppLogger.log.i("Refreshing ${track.name}: ${sourcedTrack.url}");

      return sourcedTrack;
    }

    final database = ref.read(databaseProvider);
    final cachedSource = await (database.select(database.sourceMatchTable)
          ..where((s) => s.trackId.equals(track.id!))
          ..limit(1)
          ..orderBy([
            (s) =>
                OrderingTerm(expression: s.createdAt, mode: OrderingMode.desc),
          ]))
        .get()
        .then((s) => s.firstOrNull);

    if (cachedSource == null || cachedSource.sourceType != SourceType.youtube) {
      final siblings = await fetchSiblings(ref: ref, track: track);
      if (siblings.isEmpty) {
        throw TrackNotFoundError(track);
      }

      await database.into(database.sourceMatchTable).insert(
            SourceMatchTableCompanion.insert(
              trackId: track.id!,
              sourceId: siblings.first.info.id,
              sourceType: const Value(SourceType.youtube),
            ),
          );

      return YoutubeSourcedTrack(
        ref: ref,
        siblings: siblings.map((s) => s.info).skip(1).toList(),
        source: siblings.first.source as SourceMap,
        sourceInfo: siblings.first.info,
        track: track,
      );
    }
    final (item, manifest) = await ref
        .read(youtubeEngineProvider)
        .getVideoWithStreamInfo(cachedSource.sourceId);

    final sourcedTrack = YoutubeSourcedTrack(
      ref: ref,
      siblings: [],
      source: toSourceMap(manifest),
      sourceInfo: YoutubeSourceInfo(
        id: item.id.value,
        artist: item.author,
        artistUrl: "https://www.youtube.com/channel/${item.channelId}",
        pageUrl: item.url,
        thumbnail: item.thumbnails.highResUrl,
        title: item.title,
        duration: item.duration ?? Duration.zero,
        album: null,
      ),
      track: track,
    );

    AppLogger.log.i("${track.name}: ${sourcedTrack.url}");

    return sourcedTrack;
  }

  static SourceMap toSourceMap(StreamManifest manifest) {
    var m4a = manifest.audioOnly
        .where((audio) => audio.codec.mimeType == "audio/mp4")
        .sortByBitrate();

    var weba = manifest.audioOnly
        .where((audio) => audio.codec.mimeType == "audio/webm")
        .sortByBitrate();

    m4a = m4a.isEmpty ? weba.toList() : m4a;
    weba = weba.isEmpty ? m4a.toList() : weba;

    return SourceMap(
      m4a: SourceQualityMap(
        high: m4a.first.url.toString(),
        medium: (m4a.elementAtOrNull(m4a.length ~/ 2) ?? m4a[1]).url.toString(),
        low: m4a.last.url.toString(),
      ),
      weba: SourceQualityMap(
        high: weba.first.url.toString(),
        medium:
            (weba.elementAtOrNull(weba.length ~/ 2) ?? weba[1]).url.toString(),
        low: weba.last.url.toString(),
      ),
    );
  }

  static Future<SiblingType> toSiblingType(
    int index,
    YoutubeVideoInfo item,
    dynamic ref,
  ) async {
    assert(ref is WidgetRef || ref is Ref, "Invalid ref type");
    SourceMap? sourceMap;
    if (index == 0) {
      final manifest =
          await ref.read(youtubeEngineProvider).getStreamManifest(item.id);
      sourceMap = toSourceMap(manifest);
    }

    final SiblingType sibling = (
      info: YoutubeSourceInfo(
        id: item.id,
        artist: item.channelName,
        artistUrl: "https://www.youtube.com/channel/${item.channelId}",
        pageUrl: "https://www.youtube.com/watch?v=${item.id}",
        thumbnail: item.thumbnailUrl,
        title: item.title,
        duration: item.duration,
        album: null,
      ),
      source: sourceMap,
    );

    return sibling;
  }

  static List<YoutubeVideoInfo> rankResults(
      List<YoutubeVideoInfo> results, Track track) {
    final artists =
        (track.artists ?? []).map((ar) => ar.name).toList().nonNulls.toList();

    return results
        .sorted((a, b) => b.views.compareTo(a.views))
        .map((sibling) {
          int score = 0;

          for (final artist in artists) {
            final isSameChannelArtist =
                sibling.channelName.toLowerCase() == artist.toLowerCase();
            final channelContainsArtist = sibling.channelName
                .toLowerCase()
                .contains(artist.toLowerCase());

            if (isSameChannelArtist || channelContainsArtist) {
              score += 1;
            }

            final titleContainsArtist =
                sibling.title.toLowerCase().contains(artist.toLowerCase());

            if (titleContainsArtist) {
              score += 1;
            }
          }

          final titleContainsTrackName =
              sibling.title.toLowerCase().contains(track.name!.toLowerCase());

          final hasOfficialFlag =
              officialMusicRegex.hasMatch(sibling.title.toLowerCase());

          if (titleContainsTrackName) {
            score += 3;
          }

          if (hasOfficialFlag) {
            score += 1;
          }

          if (hasOfficialFlag && titleContainsTrackName) {
            score += 2;
          }

          return (sibling: sibling, score: score);
        })
        .sorted((a, b) => b.score.compareTo(a.score))
        .map((e) => e.sibling)
        .toList();
  }

  static Future<List<YoutubeVideoInfo>> fetchFromIsrc({
    required Track track,
    required Provider provider,
    required Ref ref,
  }) async {
    final isrcResults = <YoutubeVideoInfo>[];
    final isrc = track.externalIds?.isrc;
    if (isrc != null && isrc.isNotEmpty) {
      final searchedVideos = await ref
          .read(provider)
          .searchVideos(isrc.toString());
      if (searchedVideos.isNotEmpty) {
        isrcResults.addAll(searchedVideos
            .map<YoutubeVideoInfo>(YoutubeVideoInfo.fromVideo)
            .map((YoutubeVideoInfo videoInfo) {
              final ytWords =
                  videoInfo.title
                      .toLowerCase()
                      .replaceAll(RegExp(r'[^a-zA-Z0-9\s]+'), '')
                      .split(RegExp(r'\s+'))
                      .where((item) => item.isNotEmpty);
              final spWords =
                  track.name!
                      .toLowerCase()
                      .replaceAll(RegExp(r'\((.*)\)'), '')
                      .replaceAll(RegExp(r'[^a-zA-Z0-9\s]+'), '')
                      .split(RegExp(r'\s+'))
                      .where((item) => item.isNotEmpty);
              // Word match to filter out unrelated results
              final matchCount =
                  ytWords.where((word) => spWords.contains(word)).length;
              if (matchCount > spWords.length ~/ 2) {
                return videoInfo;
              }
              return null;
            }
        ).whereType<YoutubeVideoInfo>().toList());
      }
    }
    return isrcResults;
  }

  static Future<List<SiblingType>> fetchSiblings({
    required Track track,
    required Ref ref,
  }) async {
    final videoResults = <YoutubeVideoInfo>[];

    videoResults.addAll(await fetchFromIsrc(track: track, provider: youtubeEngineProvider, ref: ref));

    final links = await SongLinkService.links(track.id!);
    final ytLink = links.firstWhereOrNull((link) => link.platform == "youtube");

    if (ytLink?.url != null) {
      try {
        videoResults.add(
            YoutubeVideoInfo.fromVideo(
                await ref.read(youtubeEngineProvider)
                    .getVideo(Uri.parse(ytLink!.url!).queryParameters["v"]!)
        ));
      } on VideoUnplayableException catch (e, stack) {
        // Ignore this error and continue with the search
        AppLogger.reportError(e, stack);
      }
    }

    final query = SourcedTrack.getSearchTerm(track);

    final searchResults =
        await ref.read(youtubeEngineProvider).searchVideos(query);

    if (ServiceUtils.onlyContainsEnglish(query)) {
      videoResults.addAll(
          searchResults.map(YoutubeVideoInfo.fromVideo).toList()
      );
    } else {
      videoResults.addAll(rankResults(
          searchResults.map(YoutubeVideoInfo.fromVideo).toList(),
          track,
      ));
    }

    final seenIds = <String>{};
    int index = 0;
    return await Future.wait(
      videoResults.map((videoResult) async {
        // Deduplicate results
        if (!seenIds.contains(videoResult.id)) {
          seenIds.add(videoResult.id);
          return await toSiblingType(index++, videoResult, ref);
        }
        return null;
      }),
    ).then((s) => s.whereType<SiblingType>().toList());
  }

  @override
  Future<YoutubeSourcedTrack?> swapWithSibling(SourceInfo sibling) async {
    if (sibling.id == sourceInfo.id) {
      return null;
    }

    // a sibling source that was fetched from the search results
    final isStepSibling = siblings.none((s) => s.id == sibling.id);

    final newSourceInfo = isStepSibling
        ? sibling
        : siblings.firstWhere((s) => s.id == sibling.id);
    final newSiblings = siblings.where((s) => s.id != sibling.id).toList()
      ..insert(0, sourceInfo);

    final manifest = await ref
        .read(youtubeEngineProvider)
        .getStreamManifest(newSourceInfo.id);

    final database = ref.read(databaseProvider);

    await database.into(database.sourceMatchTable).insert(
          SourceMatchTableCompanion.insert(
            trackId: id!,
            sourceId: newSourceInfo.id,
            sourceType: const Value(SourceType.youtube),
            // Because we're sorting by createdAt in the query
            // we have to update it to indicate priority
            createdAt: Value(DateTime.now()),
          ),
          mode: InsertMode.replace,
        );

    return YoutubeSourcedTrack(
      ref: ref,
      siblings: newSiblings,
      source: toSourceMap(manifest),
      sourceInfo: newSourceInfo,
      track: this,
    );
  }

  @override
  Future<YoutubeSourcedTrack> copyWithSibling() async {
    if (siblings.isNotEmpty) {
      return this;
    }
    final fetchedSiblings = await fetchSiblings(ref: ref, track: this);

    return YoutubeSourcedTrack(
      ref: ref,
      siblings: fetchedSiblings
          .where((s) => s.info.id != sourceInfo.id)
          .map((s) => s.info)
          .toList(),
      source: source,
      sourceInfo: sourceInfo,
      track: this,
    );
  }
}