Added mp3 tagging

deemix/downloader.js

@@ -1,5 +1,6 @@
 const { Track, AlbumDoesntExists } = require('./types/Track.js')
 const { streamTrack, generateStreamURL } = require('./decryption.js')
+const { tagID3 } = require('./tagger.js')
 const { TrackFormats } = require('deezer-js')
 const { USER_AGENT_HEADER } = require('./utils/index.js')
 const { DEFAULTS } = require('./settings.js')
@@ -192,7 +193,8 @@ class Downloader {
 
     // Make sure the filepath exsists
     fs.mkdirSync(filepath, { recursive: true })
-    let writepath = `${filepath}/${filename}${extensions[track.bitrate]}`
+    let extension = extensions[track.bitrate]
+    let writepath = `${filepath}/${filename}${extension}`
 
     // Save extrasPath
     if (extrasPath && !this.extrasPath) this.extrasPath = extrasPath
@@ -212,7 +214,9 @@ class Downloader {
     await streamTrack(stream, track, 0, this.downloadObject, this.listener)
     console.log(filename)
     // Adding tags
-
+    if (extension == '.mp3'){
+      tagID3(writepath, track, this.settings.tags)
+    }
   }
 }
 

deemix/tagger.js

@@ -0,0 +1,129 @@
+const ID3Writer = require('browser-id3-writer')
+const fs = require('fs')
+
+function tagID3(path, track, save){
+  const songBuffer = fs.readFileSync(path)
+  const tag = new ID3Writer(songBuffer)
+
+  if (save.title) tag.setFrame('TIT2', track.title)
+
+  if (save.artist && track.artists.length){
+    if (save.multiArtistSeparator == "default"){
+      tag.setFrame('TPE1', track.artists)
+    }else{
+      if (save.multiArtistSeparator == "nothing"){
+        tag.setFrame('TPE1', track.mainArtist.name)
+      } else {
+        tag.setFrame('TPE1', track.artistString)
+      }
+      // Tag ARTISTS is added to keep the multiartist support when using a non standard tagging method
+      // https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#artists
+      tag.setFrame('TXXX', {
+        description: 'ARTISTS',
+        value: track.artists
+      })
+    }
+  }
+
+  if (save.album) tag.setFrame('TALB', track.album.title)
+
+  if (save.albumArtist && track.album.artists.length){
+    if (save.singleAlbumArtist && track.album.mainArtist.save){
+      tag.setFrame('TPE2', track.album.mainArtist.name)
+    } else {
+      tag.setFrame('TPE2', track.album.artists)
+    }
+  }
+
+  if (save.trackNumber){
+    let trackNumber = String(track.trackNumber)
+    if (save.trackTotal) trackNumber += `/${track.album.discTotal}`
+    tag.setFrame('TRCK', trackNumber)
+  }
+  if (save.discNumber){
+    let discNumber = String(track.discNumber)
+    if (save.discTotal) discNumber += `/${track.album.discTotal}`
+    tag.setFrame('TPOS', discNumber)
+  }
+
+  if (save.genre) tag.setFrame('TCON', track.album.genre)
+  if (save.year) tag.setFrame('TYER', track.date.year)
+
+  // Referencing ID3 standard
+  // https://id3.org/id3v2.3.0#TDAT
+  // The 'Date' frame is a numeric string in the DDMM format.
+  if (save.date) tag.setFrame('TDAT', "" + track.date.day + track.date.month)
+
+  if (save.length) tag.setFrame('TLEN', parseInt(track.duration)*1000)
+  if (save.bpm) tag.setFrame('TBPM', track.bpm)
+  if (save.label) tag.setFrame('TPUB', track.album.label)
+  if (save.isrc) tag.setFrame('TSRC', track.ISRC)
+  if (save.barcode) tag.setFrame('TXXX', {
+    description: 'BARCODE',
+    value: track.album.barcode
+  })
+  if (save.explicit) tag.setFrame('TXXX', {
+    description: 'ITUNESADVISORY',
+    value: track.explicit ? "1" : "0"
+  })
+  if (save.replayGain) tag.setFrame('TXXX', {
+    description: 'REPLAYGAIN_TRACK_GAIN',
+    value: track.replayGain
+  })
+  if (save.lyrics && track.lyrics.unsync) tag.setFrame('USLT', track.lyrics.unsync)
+
+  // TODO: Uncomment when implemented in lib
+  /*
+  if (save.syncedLyrics && track.lyrics.syncID3) tag.setFrame('SYLT', {
+    text: track.lyrics.syncID3,
+    type: 1,
+    timestampFormat: 2,
+    useUnicodeEncoding: true
+  })
+  */
+
+  let involvedPeople = []
+  Object.keys(track.contributors).forEach((role) => {
+    if (['author', 'engineer', 'mixer', 'producer', 'writer'].indexOf(role) != -1){
+      track.contributors[role].forEach((person) => {
+        involvedPeople.push([role, person])
+      })
+    } else if (role === 'composer' && save.composer){
+      tag.setFrame('TCOM', track.contributors.composer)
+    }
+  })
+  // TODO: Uncomment when implemented in lib
+  // if (involvedPeople.length && save.involvedPeople) tag.setFrame('IPLS', involvedPeople)
+
+  if (save.copyright) tag.setFrame('TCOP', track.copyright)
+  if (save.savePlaylistAsCompilation && track.playlist || track.album.recordType == "compile")
+    tag._setIntegerFrame('TCMP', 1) // tag.setFrame('TCMP', 1)
+
+  if (save.source){
+    tag.setFrame('TXXX', {
+      description: 'SOURCE',
+      value: 'Deezer'
+    })
+    tag.setFrame('TXXX', {
+      description: 'SOURCEID',
+      value: track.id
+    })
+  }
+
+  if (save.cover && track.album.embeddedCoverPath){
+    const coverArrayBuffer = fs.readFileSync(track.album.picturePath)
+    tag.setFrame('APIC', {
+      type: 3,
+      data: coverArrayBuffer,
+      description: 'cover',
+      useUnicodeEncoding: save.coverDescriptionUTF8
+    })
+  }
+  tag.addTag()
+  
+  fs.writeFileSync(path, Buffer.from(tag.arrayBuffer))
+}
+
+module.exports = {
+  tagID3
+}

package-lock.json

@@ -9,6 +9,7 @@
       "version": "0.0.0",
       "license": "GPL-3.0-or-later",
       "dependencies": {
+        "browser-id3-writer": "^4.4.0",
         "crypto": "^1.0.1",
         "deezer-js": "^0.0.3",
         "got": "^11.8.2"
@@ -312,6 +313,11 @@
         "concat-map": "0.0.1"
       }
     },
+    "node_modules/browser-id3-writer": {
+      "version": "4.4.0",
+      "resolved": "https://registry.npmjs.org/browser-id3-writer/-/browser-id3-writer-4.4.0.tgz",
+      "integrity": "sha512-8xce9wo4VoKNR4udEGOAf8vndYxhToqQS+1wyrjdYVPQKRc4Wm6xwGG6XrKYgax28y5AvrbCkqK6t1RplPN2Ew=="
+    },
     "node_modules/cacheable-lookup": {
       "version": "5.0.4",
       "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-5.0.4.tgz",
@@ -1882,6 +1888,11 @@
         "concat-map": "0.0.1"
       }
     },
+    "browser-id3-writer": {
+      "version": "4.4.0",
+      "resolved": "https://registry.npmjs.org/browser-id3-writer/-/browser-id3-writer-4.4.0.tgz",
+      "integrity": "sha512-8xce9wo4VoKNR4udEGOAf8vndYxhToqQS+1wyrjdYVPQKRc4Wm6xwGG6XrKYgax28y5AvrbCkqK6t1RplPN2Ew=="
+    },
     "cacheable-lookup": {
       "version": "5.0.4",
       "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-5.0.4.tgz",

package.json

@@ -9,6 +9,7 @@
   "author": "RemixDev",
   "license": "GPL-3.0-or-later",
   "dependencies": {
+    "browser-id3-writer": "^4.4.0",
     "crypto": "^1.0.1",
     "deezer-js": "^0.0.3",
     "got": "^11.8.2"