Merge pull request #1382 from Demizo/feature-trackmatching

[Feature] Track Matching
nukeop · Jan 3, 2023 · 95cfe0e · 95cfe0e
2 parents e4154fc + 8dec1d6
commit 95cfe0e
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 31 deletions.
diff --git a/packages/core/src/rest/Youtube.ts b/packages/core/src/rest/Youtube.ts
@@ -47,7 +47,7 @@ function analyseUrlType(url) {
 
 function formatPlaylistTrack(track: ytpl.Item) {
   return {
-    streams: [{source: 'Youtube', id: track.id}],
+    streams: [{ source: 'Youtube', id: track.id }],
     name: track.title,
     thumbnail: track.thumbnails[0].url,
     artist: track.author.name
@@ -89,12 +89,12 @@ async function handleYoutubeVideo(url: string): Promise<YoutubeResult[]> {
         const videoDetails = info.videoDetails;
 
         return [{
-          streams: [{source: 'Youtube', id: videoDetails.videoId}],
+          streams: [{ source: 'Youtube', id: videoDetails.videoId }],
           name: videoDetails.title,
           thumbnail: videoDetails.thumbnails[0].url,
-          artist: {name: videoDetails.ownerChannelName}
+          artist: { name: videoDetails.ownerChannelName }
         }];
-      } 
+      }
       return [];
     })
     .catch(function () {
@@ -129,10 +129,10 @@ export async function liveStreamSearch(query: string): Promise<YoutubeResult[]>
 
   return searchResults.items.map((video: ytsr.Video) => {
     return {
-      streams: [{source: 'Youtube', id: video.id}],
+      streams: [{ source: 'Youtube', id: video.id }],
       name: video.title,
       thumbnail: video.bestThumbnail.url,
-      artist: {name: video.author.name}
+      artist: { name: video.author.name }
     };
   });
 }
@@ -145,15 +145,20 @@ export async function trackSearchByString(query: StreamQuery, sourceName?: strin
   const terms = query.artist + ' ' + query.track;
   const filterOptions = await ytsr.getFilters(terms);
   const filterVideoOnly = filterOptions.get('Type').get('Video');
-  const results = await ytsr(filterVideoOnly.url, { limit: 15 });
+  const results = await ytsr(filterVideoOnly.url, { limit: 10 });
   const heuristics = new YoutubeHeuristics();
 
-  const orderedTracks = heuristics.orderTracks({
+  let orderedTracks = heuristics.orderTracks({
     tracks: results.items as ytsr.Video[],
     artist: query.artist,
     title: query.track
   });
 
+  // [HACK] Currently a bug exists where some tracks are returned as not defined. If this happens to the top track loading the track will fail...
+  // This is a HACK to ensure that doesn't happen 
+  while (orderedTracks[0].id === undefined) {
+    orderedTracks = orderedTracks.slice(1);
+  }
   return [
     await getStreamForId(orderedTracks[0].id, sourceName),
     ...orderedTracks
@@ -168,7 +173,7 @@ export const getStreamForId = async (id: string, sourceName: string, useSponsorB
     const trackInfo = await ytdl.getInfo(videoUrl);
     const formatInfo = ytdl.chooseFormat(trackInfo.formats, { quality: 'highestaudio' });
     const segments = useSponsorBlock ? await SponsorBlock.getSegments(id) : [];
-  
+
     return {
       id,
       source: sourceName,
@@ -199,12 +204,12 @@ function videoToStreamData(video: ytsr.Video, source: string): StreamData {
     stream: undefined,
     duration: parseInt(video.duration),
     title: video.title,
-    thumbnail: video.bestThumbnail.url,
+    thumbnail: video.bestThumbnail?.url,
     originalUrl: video.url,
     isLive: video.isLive,
     author: {
-      name: video.author.name,
-      thumbnail: video.author.bestAvatar.url
+      name: video.author?.name,
+      thumbnail: video.author?.bestAvatar.url
     }
   };
 }
diff --git a/packages/core/src/rest/heuristics.ts b/packages/core/src/rest/heuristics.ts
@@ -3,22 +3,22 @@ import { Video } from 'ytsr';
 import levenshtein from 'fast-levenshtein';
 
 type ScoreTrackArgs<Track> = {
-    track: Track;
-    artist: string;
-    title: string;
-    duration?: number;
+  track: Track;
+  artist: string;
+  title: string;
+  duration?: number;
 }
 
 type OrderTracksArgs<Track> = {
-    tracks: Track[];
-    artist: string;
-    title: string;
-    duration?: number;
+  tracks: Track[];
+  artist: string;
+  title: string;
+  duration?: number;
 };
 
 interface SearchHeuristics<Track> {
-    scoreTrack: (args: ScoreTrackArgs<Track>) => number;
-    orderTracks: (args: OrderTracksArgs<Track>) => Track[];
+  scoreTrack: (args: ScoreTrackArgs<Track>) => number;
+  orderTracks: (args: OrderTracksArgs<Track>) => Track[];
 }
 
 const penalizedWords = [
@@ -35,7 +35,7 @@ const promotedWords = [
 
 export class YoutubeHeuristics implements SearchHeuristics<Partial<Video>> {
   static createTitle = ({
-    artist, 
+    artist,
     title
   }: { artist: string; title: string; }) => `${artist} - ${title}`.toLowerCase();
 
@@ -47,27 +47,27 @@ export class YoutubeHeuristics implements SearchHeuristics<Partial<Video>> {
   }: ScoreTrackArgs<Partial<Video>>) => {
     const trackTitle = YoutubeHeuristics.createTitle({ artist, title });
     const lowercaseResultTitle = track.title.toLowerCase();
-    
-    const titleScore = (1 - (levenshtein.get(trackTitle, lowercaseResultTitle)/trackTitle.length)) * 100;
-    
-    const verbatimSubstringScore = lowercaseResultTitle.includes(trackTitle) ? 100 : 0;
+
+    const titleScore = (1 - (levenshtein.get(trackTitle, lowercaseResultTitle) / trackTitle.length)) * 25;
+
+    const verbatimSubstringScore = lowercaseResultTitle.includes(title.toLowerCase()) ? 300 : 0;
 
     const durationDelta = Math.abs(Number.parseFloat(track.duration) - duration);
     const durationScore = track.duration && duration
-      ? (1 - durationDelta/duration) * 100
+      ? (1 - durationDelta / duration) * 800
       : 0;
 
     const promotedWordsScore = promotedWords.some(promotedWord => lowercaseResultTitle.includes(promotedWord)) ? 100 : 0;
 
-    const penalizedWordsScore = penalizedWords.some(word => lowercaseResultTitle.includes(word)) ? 0 : 100;
+    const penalizedWordsScore = penalizedWords.some(word => lowercaseResultTitle.includes(word)) ? 0 : 200;
 
     let liveVideoScore = 100;
     if (lowercaseResultTitle.includes('live') && !trackTitle.includes('live')) {
       liveVideoScore = 0;
     }
 
-    const channelNameScore = track.author.name.toLowerCase().includes(artist.toLowerCase()) ? 200 : 0;
-    const verifiedChannelScore = track.author.verified ? 200 : 0;
+    const channelNameScore = track.author?.name.toLowerCase().includes(artist.toLowerCase()) ? 300 : 0;
+    const verifiedChannelScore = track.author?.verified ? 200 : 0;
 
     return mean([
       titleScore,