From b89a74e6e90c5e348f1eb7d141befa407cd644d1 Mon Sep 17 00:00:00 2001
From: Borewit <borewit@users.noreply.github.com>
Date: Sun, 4 Mar 2018 13:48:07 +0100
Subject: [PATCH 01/10] #1332: Improve the poster selection for audio/music
 based torrent, aiming to get the cover-art selected as the torrent poster.

---
 src/renderer/lib/torrent-poster.js | 104 ++++++++++++++++++++++++-----
 1 file changed, 88 insertions(+), 16 deletions(-)

diff --git a/src/renderer/lib/torrent-poster.js b/src/renderer/lib/torrent-poster.js
index f05d1bb58b..d90d6b8720 100644
--- a/src/renderer/lib/torrent-poster.js
+++ b/src/renderer/lib/torrent-poster.js
@@ -3,6 +3,13 @@ module.exports = torrentPoster
 const captureFrame = require('capture-frame')
 const path = require('path')
 
+const mediaExtensions = {
+  audio: ['.aac', '.asf', '.flac', '.m2a', '.m4a', '.mp2', '.mp4', '.mp3', '.oga', '.ogg', '.opus',
+    '.wma', '.wav', '.wv', '.wvp'],
+  video: ['.mp4', '.m4v', '.webm', '.mov', '.mkv'],
+  image: ['.gif', '.jpg', '.jpeg', '.png']
+}
+
 function torrentPoster (torrent, cb) {
   // First, try to use a poster image if available
   const posterFile = torrent.files.filter(function (file) {
@@ -10,32 +17,95 @@ function torrentPoster (torrent, cb) {
   })[0]
   if (posterFile) return torrentPosterFromImage(posterFile, torrent, cb)
 
-  // Second, try to use the largest video file
-  // Filter out file formats that the <video> tag definitely can't play
-  const videoFile = getLargestFileByExtension(torrent, ['.mp4', '.m4v', '.webm', '.mov', '.mkv'])
-  if (videoFile) return torrentPosterFromVideo(videoFile, torrent, cb)
+  // 'score' each media type based on total size present in torrent
+  const bestScore = ['audio', 'video', 'image'].map(mediaType => {
+    return {
+      type: mediaType,
+      size: calculateDataLengthByExtension(torrent, mediaExtensions[mediaType])}
+  }).sort((a, b) => { // sort descending on size
+    return b.size - a.size
+  })[0]
 
-  // Third, try to use the largest image file
-  const imgFile = getLargestFileByExtension(torrent, ['.gif', '.jpg', '.jpeg', '.png'])
-  if (imgFile) return torrentPosterFromImage(imgFile, torrent, cb)
+  if (bestScore.size === 0) {
+    // Admit defeat, no video, audio or image had a significant presence
+    return cb(new Error('Cannot generate a poster from any files in the torrent'))
+  }
+
+  // Based on which media type is dominant we select the corresponding poster function
+  switch (bestScore.type) {
+    case 'audio':
+      return torrentPosterFromAudio(torrent, cb)
+    case 'image':
+      return torrentPosterFromImage(torrent, cb)
+    case 'video':
+      return torrentPosterFromVideo(torrent, cb)
+  }
+}
 
-  // TODO: generate a waveform from the largest sound file
-  // Finally, admit defeat
-  return cb(new Error('Cannot generate a poster from any files in the torrent'))
+/**
+ * Calculate the total data size of file matching one of the provided extensions
+ * @param torrent
+ * @param extensions List of extension to match
+ * @returns {number} total size, of matches found (>= 0)
+ */
+function calculateDataLengthByExtension (torrent, extensions) {
+  const files = filterOnExtension(torrent, extensions)
+  if (files.length === 0) return 0
+  return files
+    .map(file => file.length)
+    .reduce((a, b) => {
+      return a + b
+    })
 }
 
 function getLargestFileByExtension (torrent, extensions) {
-  const files = torrent.files.filter(function (file) {
+  const files = filterOnExtension(torrent, extensions)
+  if (files.length === 0) return undefined
+  return files.reduce((a, b) => {
+    return a.length > b.length ? a : b
+  })
+}
+
+function filterOnExtension (torrent, extensions) {
+  return torrent.files.filter(file => {
     const extname = path.extname(file.name).toLowerCase()
     return extensions.indexOf(extname) !== -1
   })
-  if (files.length === 0) return undefined
-  return files.reduce(function (a, b) {
-    return a.length > b.length ? a : b
+}
+
+function scoreCoverFile (file) {
+  const name = path.basename(file.name, path.extname(file.name)).toLowerCase()
+  switch (name) {
+    case 'cover': return 100
+    case 'folder': return 95
+    case 'front': return 85
+    case 'front-cover': return 90
+    case 'back': return 40
+    default: return 0
+  }
+}
+
+function torrentPosterFromAudio (torrent, cb) {
+  const imageFiles = filterOnExtension(torrent, mediaExtensions.image)
+
+  const bestCover = imageFiles.map(file => {
+    return {
+      file: file,
+      score: scoreCoverFile(file)
+    }
+  }).sort((a, b) => {
+    return b.score - a.score
   })
+
+  if (bestCover.length < 1) return cb(new Error('Generated poster contains no data'))
+
+  const extname = path.extname(bestCover[0].file.name)
+  bestCover[0].file.getBuffer((err, buf) => cb(err, buf, extname))
 }
 
-function torrentPosterFromVideo (file, torrent, cb) {
+function torrentPosterFromVideo (torrent, cb) {
+  const file = getLargestFileByExtension(torrent, mediaExtensions.video)
+
   const index = torrent.files.indexOf(file)
 
   const server = torrent.createServer(0)
@@ -77,7 +147,9 @@ function torrentPosterFromVideo (file, torrent, cb) {
   }
 }
 
-function torrentPosterFromImage (file, torrent, cb) {
+function torrentPosterFromImage (torrent, cb) {
+  const file = getLargestFileByExtension(torrent, mediaExtensions.image)
+
   const extname = path.extname(file.name)
   file.getBuffer((err, buf) => cb(err, buf, extname))
 }

From cf2a3b894872af8054a4f5004c88b7271327f23a Mon Sep 17 00:00:00 2001
From: Borewit <borewit@users.noreply.github.com>
Date: Sun, 4 Mar 2018 16:24:07 +0100
Subject: [PATCH 02/10] #1332: Improve cover image score algorithm: - If
 filename score is equal, pick highest resolution - Search for keyword
 occurrence in file name

---
 src/renderer/lib/torrent-poster.js | 28 +++++++++++++++++++---------
 1 file changed, 19 insertions(+), 9 deletions(-)

diff --git a/src/renderer/lib/torrent-poster.js b/src/renderer/lib/torrent-poster.js
index d90d6b8720..d4d2e60184 100644
--- a/src/renderer/lib/torrent-poster.js
+++ b/src/renderer/lib/torrent-poster.js
@@ -74,15 +74,23 @@ function filterOnExtension (torrent, extensions) {
 }
 
 function scoreCoverFile (file) {
-  const name = path.basename(file.name, path.extname(file.name)).toLowerCase()
-  switch (name) {
-    case 'cover': return 100
-    case 'folder': return 95
-    case 'front': return 85
-    case 'front-cover': return 90
-    case 'back': return 40
-    default: return 0
+  const fileName = path.basename(file.name, path.extname(file.name)).toLowerCase()
+  const relevanceScore = {
+    cover: 100,
+    folder: 95,
+    front: 90,
+    back: 20
   }
+
+  for (let keyword in relevanceScore) {
+    if (fileName === keyword) {
+      return relevanceScore[keyword]
+    }
+    if (fileName.indexOf(keyword) !== -1) {
+      return 0.8 * relevanceScore[keyword]
+    }
+  }
+  return 0
 }
 
 function torrentPosterFromAudio (torrent, cb) {
@@ -94,7 +102,9 @@ function torrentPosterFromAudio (torrent, cb) {
       score: scoreCoverFile(file)
     }
   }).sort((a, b) => {
-    return b.score - a.score
+    const delta = b.score - a.score
+    // If score is equal, pick the largest file, aiming for highest resolution
+    return delta === 0 ? b.file.length - a.file.length : delta
   })
 
   if (bestCover.length < 1) return cb(new Error('Generated poster contains no data'))

From 2d17cfa7e15fee53482a5237c32b01acb51b0780 Mon Sep 17 00:00:00 2001
From: Borewit <borewit@users.noreply.github.com>
Date: Sun, 4 Mar 2018 18:43:12 +0100
Subject: [PATCH 03/10] #1332: Fix selection of poster.jpg|png|gif image

---
 src/renderer/lib/torrent-poster.js | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/renderer/lib/torrent-poster.js b/src/renderer/lib/torrent-poster.js
index d4d2e60184..c9b405d455 100644
--- a/src/renderer/lib/torrent-poster.js
+++ b/src/renderer/lib/torrent-poster.js
@@ -15,7 +15,7 @@ function torrentPoster (torrent, cb) {
   const posterFile = torrent.files.filter(function (file) {
     return /^poster\.(jpg|png|gif)$/.test(file.name)
   })[0]
-  if (posterFile) return torrentPosterFromImage(posterFile, torrent, cb)
+  if (posterFile) return extractPoster(posterFile, cb)
 
   // 'score' each media type based on total size present in torrent
   const bestScore = ['audio', 'video', 'image'].map(mediaType => {
@@ -159,7 +159,10 @@ function torrentPosterFromVideo (torrent, cb) {
 
 function torrentPosterFromImage (torrent, cb) {
   const file = getLargestFileByExtension(torrent, mediaExtensions.image)
+  extractPoster(file, cb)
+}
 
+function extractPoster (file, cb) {
   const extname = path.extname(file.name)
-  file.getBuffer((err, buf) => cb(err, buf, extname))
+  file.getBuffer((err, buf) => { return cb(err, buf, extname) })
 }

From 5802cd35915738d17813b0bb44b80eb4988d5289 Mon Sep 17 00:00:00 2001
From: Borewit <borewit@users.noreply.github.com>
Date: Sun, 4 Mar 2018 18:44:14 +0100
Subject: [PATCH 04/10] #1332: Add unit test for cover selection algorithm.

---
 test/test-select-poster.js | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 test/test-select-poster.js

diff --git a/test/test-select-poster.js b/test/test-select-poster.js
new file mode 100644
index 0000000000..a515f5c2b8
--- /dev/null
+++ b/test/test-select-poster.js
@@ -0,0 +1,25 @@
+const test = require('tape')
+
+const fs = require('fs')
+const path = require('path')
+
+const WebTorrent = require('webtorrent')
+const torrentPoster = require('../build/renderer/lib/torrent-poster')
+
+const client = new WebTorrent()
+
+test("get cover from: 'wiredCd.torrent'", (t) => {
+  const torrentPath = path.join(__dirname, '..', 'static', 'wiredCd.torrent')
+  const torrentData = fs.readFileSync(torrentPath)
+
+  client.add(torrentData, (torrent) => {
+    torrentPoster(torrent, (err, buf, extension) => {
+      if (err) {
+        t.fail(err)
+      } else {
+        t.equals(extension, '.jpg')
+        t.end();
+      }
+    })
+  })
+})

From 8d657d93e03eb7236934702ed98b1513b3292c65 Mon Sep 17 00:00:00 2001
From: Borewit <borewit@users.noreply.github.com>
Date: Sun, 4 Mar 2018 18:49:59 +0100
Subject: [PATCH 05/10] Fix code style

---
 test/test-select-poster.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/test/test-select-poster.js b/test/test-select-poster.js
index a515f5c2b8..501acdfe43 100644
--- a/test/test-select-poster.js
+++ b/test/test-select-poster.js
@@ -18,7 +18,7 @@ test("get cover from: 'wiredCd.torrent'", (t) => {
         t.fail(err)
       } else {
         t.equals(extension, '.jpg')
-        t.end();
+        t.end()
       }
     })
   })

From a114a22770750c3e0097030a82fcde9fc13dd9c1 Mon Sep 17 00:00:00 2001
From: Borewit <borewit@users.noreply.github.com>
Date: Sun, 4 Mar 2018 19:04:18 +0100
Subject: [PATCH 06/10] #1332: Add album as likely name for an image containing
 the cover

---
 src/renderer/lib/torrent-poster.js | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/renderer/lib/torrent-poster.js b/src/renderer/lib/torrent-poster.js
index c9b405d455..e9cc39e2c5 100644
--- a/src/renderer/lib/torrent-poster.js
+++ b/src/renderer/lib/torrent-poster.js
@@ -78,7 +78,8 @@ function scoreCoverFile (file) {
   const relevanceScore = {
     cover: 100,
     folder: 95,
-    front: 90,
+    album: 90,
+    front: 80,
     back: 20
   }
 

From 30693d7d16daad4e5ad62c4d69a10261cf2b5674 Mon Sep 17 00:00:00 2001
From: Borewit <borewit@users.noreply.github.com>
Date: Sun, 11 Mar 2018 17:33:02 +0100
Subject: [PATCH 07/10] Added some function comments. Simplified code a bit.

---
 src/renderer/lib/torrent-poster.js | 43 +++++++++++++++++++++++-------
 1 file changed, 34 insertions(+), 9 deletions(-)

diff --git a/src/renderer/lib/torrent-poster.js b/src/renderer/lib/torrent-poster.js
index e9cc39e2c5..8c81531a89 100644
--- a/src/renderer/lib/torrent-poster.js
+++ b/src/renderer/lib/torrent-poster.js
@@ -58,6 +58,12 @@ function calculateDataLengthByExtension (torrent, extensions) {
     })
 }
 
+/**
+ * Get the largest file of a given torrent, filtered by provided extension
+ * @param torrent Torrent to search in
+ * @param extensions Extension whitelist filter
+ * @returns Torrent file object
+ */
 function getLargestFileByExtension (torrent, extensions) {
   const files = filterOnExtension(torrent, extensions)
   if (files.length === 0) return undefined
@@ -66,6 +72,12 @@ function getLargestFileByExtension (torrent, extensions) {
   })
 }
 
+/**
+ * Filter file on a list extension, can be used to find al image files
+ * @param torrent Torrent to filter files from
+ * @param extensions File extensions to filter on
+ * @returns {number} Array of torrent file objects matching one of the given extensions
+ */
 function filterOnExtension (torrent, extensions) {
   return torrent.files.filter(file => {
     const extname = path.extname(file.name).toLowerCase()
@@ -73,8 +85,13 @@ function filterOnExtension (torrent, extensions) {
   })
 }
 
-function scoreCoverFile (file) {
-  const fileName = path.basename(file.name, path.extname(file.name)).toLowerCase()
+/**
+ * Returns a score how likely the file is suitable as a poster
+ * @param imgFile File object of an image
+ * @returns {number} Score, higher score is a better match
+ */
+function scoreAudioCoverFile (imgFile) {
+  const fileName = path.basename(imgFile.name, path.extname(imgFile.name)).toLowerCase()
   const relevanceScore = {
     cover: 100,
     folder: 95,
@@ -100,18 +117,26 @@ function torrentPosterFromAudio (torrent, cb) {
   const bestCover = imageFiles.map(file => {
     return {
       file: file,
-      score: scoreCoverFile(file)
+      score: scoreAudioCoverFile(file)
+    }
+  }).reduce((a, b) => {
+    if (a.score > b.score) {
+      return a
+    }
+    if (b.score > a.score) {
+      return b
     }
-  }).sort((a, b) => {
-    const delta = b.score - a.score
     // If score is equal, pick the largest file, aiming for highest resolution
-    return delta === 0 ? b.file.length - a.file.length : delta
+    if (a.file.length > b.file.length) {
+      return a
+    }
+    return b
   })
 
-  if (bestCover.length < 1) return cb(new Error('Generated poster contains no data'))
+  if (!bestCover) return cb(new Error('Generated poster contains no data'))
 
-  const extname = path.extname(bestCover[0].file.name)
-  bestCover[0].file.getBuffer((err, buf) => cb(err, buf, extname))
+  const extname = path.extname(bestCover.file.name)
+  bestCover.file.getBuffer((err, buf) => cb(err, buf, extname))
 }
 
 function torrentPosterFromVideo (torrent, cb) {

From c688313239eea30e641764aa37db339683883a96 Mon Sep 17 00:00:00 2001
From: Alberto Miranda <codealchemist@gmail.com>
Date: Thu, 19 Apr 2018 14:49:17 -0300
Subject: [PATCH 08/10] Displaying filename while music metadata is being
 downloaded.

---
 src/renderer/pages/player-page.js | 3 ++-
 src/renderer/webtorrent.js        | 4 ++++
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/renderer/pages/player-page.js b/src/renderer/pages/player-page.js
index c6a2b72afd..ccc73f1b0b 100644
--- a/src/renderer/pages/player-page.js
+++ b/src/renderer/pages/player-page.js
@@ -207,7 +207,7 @@ function renderOverlay (state) {
 function renderAudioMetadata (state) {
   const fileSummary = state.getPlayingFileSummary()
   if (!fileSummary.audioInfo) return
-  const common = fileSummary.audioInfo.common
+  const common = fileSummary.audioInfo.common || {}
 
   // Get audio track info
   const title = common.title ? common.title : fileSummary.name
@@ -273,6 +273,7 @@ function renderAudioMetadata (state) {
 
   // Audio metadata: format
   const format = []
+  fileSummary.audioInfo.format = fileSummary.audioInfo.format || ''
   if (fileSummary.audioInfo.format.dataformat) {
     format.push(fileSummary.audioInfo.format.dataformat)
   }
diff --git a/src/renderer/webtorrent.js b/src/renderer/webtorrent.js
index 44b67377c5..a8679fef7a 100644
--- a/src/renderer/webtorrent.js
+++ b/src/renderer/webtorrent.js
@@ -340,6 +340,10 @@ function getAudioMetadata (infoHash, index) {
   const torrent = client.get(infoHash)
   const file = torrent.files[index]
 
+  // Set initial matadata to display the filename first.
+  const metadata = { title: file.name }
+  ipc.send('wt-audio-metadata', infoHash, index, metadata)
+
   const options = {native: false, skipCovers: true, fileSize: file.length}
   const onMetaData = file.done
     // If completed; use direct file access

From 57c1a97ebffad094318b7e52c8c98ac6a5913a09 Mon Sep 17 00:00:00 2001
From: Borewit <borewit@users.noreply.github.com>
Date: Fri, 20 Apr 2018 07:43:15 +0200
Subject: [PATCH 09/10] Update music-metadata dependency to v0.9.15.

---
 package.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/package.json b/package.json
index ed4715785f..1d89fd7166 100644
--- a/package.json
+++ b/package.json
@@ -32,7 +32,7 @@
     "location-history": "^1.0.0",
     "material-ui": "^0.17.0",
     "mkdirp": "^0.5.1",
-    "music-metadata": "^0.9.8",
+    "music-metadata": "^0.9.15",
     "network-address": "^1.1.0",
     "parse-torrent": "^5.7.3",
     "prettier-bytes": "^1.0.1",

From f47055c51b0162908920abda05f4dd11ac0e3d27 Mon Sep 17 00:00:00 2001
From: Borewit <borewit@users.noreply.github.com>
Date: Fri, 20 Apr 2018 08:07:27 +0200
Subject: [PATCH 10/10] Adjust the filename score, size is probably more
 relevant.

---
 src/renderer/lib/torrent-poster.js | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/renderer/lib/torrent-poster.js b/src/renderer/lib/torrent-poster.js
index 8c81531a89..ec10913510 100644
--- a/src/renderer/lib/torrent-poster.js
+++ b/src/renderer/lib/torrent-poster.js
@@ -93,9 +93,9 @@ function filterOnExtension (torrent, extensions) {
 function scoreAudioCoverFile (imgFile) {
   const fileName = path.basename(imgFile.name, path.extname(imgFile.name)).toLowerCase()
   const relevanceScore = {
-    cover: 100,
-    folder: 95,
-    album: 90,
+    cover: 80,
+    folder: 80,
+    album: 80,
     front: 80,
     back: 20
   }