deemix-py/deemix/tagger.py

228 lines
8.4 KiB
Python
Raw Normal View History

from mutagen.flac import FLAC, Picture
2020-09-24 17:46:08 +02:00
from mutagen.id3 import ID3, ID3NoHeaderError, \
TXXX, TIT2, TPE1, TALB, TPE2, TRCK, TPOS, TCON, TYER, TDAT, TLEN, TBPM, \
2021-08-03 23:08:06 +02:00
TPUB, TSRC, USLT, SYLT, APIC, IPLS, TCOM, TCOP, TCMP, Encoding, PictureType, POPM
2020-08-14 20:31:37 +02:00
# Adds tags to a MP3 file
def tagID3(path, track, save):
2020-08-14 20:31:37 +02:00
# Delete exsisting tags
try:
tag = ID3(path)
tag.delete()
except ID3NoHeaderError:
tag = ID3()
2020-02-17 16:46:18 +01:00
if save['title']:
2020-08-15 21:34:10 +02:00
tag.add(TIT2(text=track.title))
if save['artist'] and len(track.artists):
2020-09-24 17:46:08 +02:00
if save['multiArtistSeparator'] == "default":
tag.add(TPE1(text=track.artists))
else:
if save['multiArtistSeparator'] == "nothing":
2021-01-31 17:59:15 +01:00
tag.add(TPE1(text=track.mainArtist.name))
else:
2020-08-15 21:34:10 +02:00
tag.add(TPE1(text=track.artistsString))
# Tag ARTISTS is added to keep the multiartist support when using a non standard tagging method
2020-12-17 18:17:45 +01:00
# https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html#artists
2021-12-19 17:28:56 +01:00
if save['artists']:
tag.add(TXXX(desc="ARTISTS", text=track.artists))
2020-08-14 20:31:37 +02:00
if save['album']:
2021-01-31 17:59:15 +01:00
tag.add(TALB(text=track.album.title))
2020-08-14 20:31:37 +02:00
2021-01-31 17:59:15 +01:00
if save['albumArtist'] and len(track.album.artists):
if save['singleAlbumArtist'] and track.album.mainArtist.save:
tag.add(TPE2(text=track.album.mainArtist.name))
else:
2021-01-31 17:59:15 +01:00
tag.add(TPE2(text=track.album.artists))
2020-08-14 20:31:37 +02:00
if save['trackNumber']:
2020-09-24 17:46:08 +02:00
trackNumber = str(track.trackNumber)
if save['trackTotal']:
2021-01-31 17:59:15 +01:00
trackNumber += "/" + str(track.album.trackTotal)
2020-09-24 17:46:08 +02:00
tag.add(TRCK(text=trackNumber))
if save['discNumber']:
2020-09-24 17:46:08 +02:00
discNumber = str(track.discNumber)
if save['discTotal']:
2021-01-31 17:59:15 +01:00
discNumber += "/" + str(track.album.discTotal)
2020-09-24 17:46:08 +02:00
tag.add(TPOS(text=discNumber))
if save['genre']:
2021-01-31 17:59:15 +01:00
tag.add(TCON(text=track.album.genre))
if save['year']:
2021-01-31 17:59:15 +01:00
tag.add(TYER(text=str(track.date.year)))
if save['date']:
2020-09-24 17:46:08 +02:00
# Referencing ID3 standard
# https://id3.org/id3v2.3.0#TDAT
# The 'Date' frame is a numeric string in the DDMM format.
2021-01-31 17:59:15 +01:00
tag.add(TDAT(text=str(track.date.day) + str(track.date.month)))
if save['length']:
2020-08-15 21:34:10 +02:00
tag.add(TLEN(text=str(int(track.duration)*1000)))
2021-09-30 19:40:46 +02:00
if save['bpm'] and track.bpm:
2020-08-15 21:34:10 +02:00
tag.add(TBPM(text=str(track.bpm)))
if save['label']:
2021-01-31 17:59:15 +01:00
tag.add(TPUB(text=track.album.label))
if save['isrc']:
2020-08-15 21:34:10 +02:00
tag.add(TSRC(text=track.ISRC))
if save['barcode']:
2021-01-31 17:59:15 +01:00
tag.add(TXXX(desc="BARCODE", text=track.album.barcode))
if save['explicit']:
2020-09-24 17:46:08 +02:00
tag.add(TXXX(desc="ITUNESADVISORY", text= "1" if track.explicit else "0" ))
if save['replayGain']:
2020-08-15 21:34:10 +02:00
tag.add(TXXX(desc="REPLAYGAIN_TRACK_GAIN", text=track.replayGain))
2021-01-31 17:59:15 +01:00
if track.lyrics.unsync and save['lyrics']:
tag.add(USLT(text=track.lyrics.unsync))
if track.lyrics.syncID3 and save['syncedLyrics']:
2020-09-24 17:46:08 +02:00
# Referencing ID3 standard
# https://id3.org/id3v2.3.0#sec4.10
# Type: 1 => is lyrics
# Format: 2 => Absolute time, 32 bit sized, using milliseconds as unit
2021-01-31 17:59:15 +01:00
tag.add(SYLT(Encoding.UTF8, type=1, format=2, text=track.lyrics.syncID3))
2020-08-14 20:31:37 +02:00
involved_people = []
2020-08-15 21:34:10 +02:00
for role in track.contributors:
if role in ['author', 'engineer', 'mixer', 'producer', 'writer']:
2020-08-15 21:34:10 +02:00
for person in track.contributors[role]:
involved_people.append([role, person])
elif role == 'composer' and save['composer']:
2020-08-15 21:34:10 +02:00
tag.add(TCOM(text=track.contributors['composer']))
if len(involved_people) > 0 and save['involvedPeople']:
tag.add(IPLS(people=involved_people))
2020-08-14 20:31:37 +02:00
2021-12-23 23:12:50 +01:00
if save['copyright'] and track.copyright:
2020-08-15 21:34:10 +02:00
tag.add(TCOP(text=track.copyright))
2021-01-31 17:59:15 +01:00
if save['savePlaylistAsCompilation'] and track.playlist or track.album.recordType == "compile":
tag.add(TCMP(text="1"))
2020-08-14 20:31:37 +02:00
if save['source']:
tag.add(TXXX(desc="SOURCE", text='Deezer'))
tag.add(TXXX(desc="SOURCEID", text=str(track.id)))
2021-08-04 20:39:51 +02:00
if save['rating']:
rank = round((int(track.rank) / 10000) * 2.55)
if rank > 255 :
rank = 255
else:
rank = round(rank, 0)
tag.add(POPM(rating=rank))
2021-01-31 17:59:15 +01:00
if save['cover'] and track.album.embeddedCoverPath:
2020-09-24 17:46:08 +02:00
descEncoding = Encoding.LATIN1
if save['coverDescriptionUTF8']:
descEncoding = Encoding.UTF8
mimeType = 'image/jpeg'
2021-01-31 17:59:15 +01:00
if str(track.album.embeddedCoverPath).endswith('png'):
2020-09-24 17:46:08 +02:00
mimeType = 'image/png'
2021-01-31 17:59:15 +01:00
with open(track.album.embeddedCoverPath, 'rb') as f:
2020-09-24 17:46:08 +02:00
tag.add(APIC(descEncoding, mimeType, PictureType.COVER_FRONT, desc='cover', data=f.read()))
2020-02-17 16:46:18 +01:00
tag.save( path,
2020-09-24 17:46:08 +02:00
v1=2 if save['saveID3v1'] else 0,
v2_version=3,
v23_sep=None if save['useNullSeparator'] else '/' )
2020-02-17 16:46:18 +01:00
2020-08-14 20:31:37 +02:00
# Adds tags to a FLAC file
def tagFLAC(path, track, save):
2020-08-14 20:31:37 +02:00
# Delete exsisting tags
tag = FLAC(path)
tag.delete()
tag.clear_pictures()
2020-08-14 20:31:37 +02:00
if save['title']:
2020-08-15 21:34:10 +02:00
tag["TITLE"] = track.title
2020-08-14 20:31:37 +02:00
2020-08-15 21:34:10 +02:00
if save['artist'] and len(track.artists):
2020-09-24 17:46:08 +02:00
if save['multiArtistSeparator'] == "default":
tag["ARTIST"] = track.artists
else:
if save['multiArtistSeparator'] == "nothing":
2021-01-31 17:59:15 +01:00
tag["ARTIST"] = track.mainArtist.name
else:
2020-08-15 21:34:10 +02:00
tag["ARTIST"] = track.artistsString
# Tag ARTISTS is added to keep the multiartist support when using a non standard tagging method
# https://picard-docs.musicbrainz.org/en/technical/tag_mapping.html#artists
2021-12-19 17:28:56 +01:00
if save['artists']:
tag["ARTISTS"] = track.artists
2020-08-14 20:31:37 +02:00
if save['album']:
2021-01-31 17:59:15 +01:00
tag["ALBUM"] = track.album.title
2020-08-14 20:31:37 +02:00
2021-01-31 17:59:15 +01:00
if save['albumArtist'] and len(track.album.artists):
if save['singleAlbumArtist'] and track.album.mainArtist.save:
tag["ALBUMARTIST"] = track.album.mainArtist.name
else:
2021-01-31 17:59:15 +01:00
tag["ALBUMARTIST"] = track.album.artists
2020-08-14 20:31:37 +02:00
if save['trackNumber']:
2020-08-15 21:34:10 +02:00
tag["TRACKNUMBER"] = str(track.trackNumber)
if save['trackTotal']:
2021-01-31 17:59:15 +01:00
tag["TRACKTOTAL"] = str(track.album.trackTotal)
if save['discNumber']:
2020-08-15 21:34:10 +02:00
tag["DISCNUMBER"] = str(track.discNumber)
if save['discTotal']:
2021-01-31 17:59:15 +01:00
tag["DISCTOTAL"] = str(track.album.discTotal)
if save['genre']:
2021-01-31 17:59:15 +01:00
tag["GENRE"] = track.album.genre
2020-09-24 17:46:08 +02:00
# YEAR tag is not suggested as a standard tag
# Being YEAR already contained in DATE will only use DATE instead
# Reference: https://www.xiph.org/vorbis/doc/v-comment.html#fieldnames
if save['date']:
2020-08-15 21:34:10 +02:00
tag["DATE"] = track.dateString
elif save['year']:
2021-01-31 17:59:15 +01:00
tag["DATE"] = str(track.date.year)
2020-09-24 17:46:08 +02:00
if save['length']:
2020-09-24 17:46:08 +02:00
tag["LENGTH"] = str(int(track.duration)*1000)
2021-09-30 19:40:46 +02:00
if save['bpm'] and track.bpm:
2020-08-15 21:34:10 +02:00
tag["BPM"] = str(track.bpm)
if save['label']:
2021-01-31 17:59:15 +01:00
tag["PUBLISHER"] = track.album.label
if save['isrc']:
2020-08-15 21:34:10 +02:00
tag["ISRC"] = track.ISRC
if save['barcode']:
2021-01-31 17:59:15 +01:00
tag["BARCODE"] = track.album.barcode
if save['explicit']:
2020-08-15 21:34:10 +02:00
tag["ITUNESADVISORY"] = "1" if track.explicit else "0"
if save['replayGain']:
2020-08-15 21:34:10 +02:00
tag["REPLAYGAIN_TRACK_GAIN"] = track.replayGain
2021-01-31 17:59:15 +01:00
if track.lyrics.unsync and save['lyrics']:
tag["LYRICS"] = track.lyrics.unsync
2020-08-14 20:31:37 +02:00
2020-08-15 21:34:10 +02:00
for role in track.contributors:
if role in ['author', 'engineer', 'mixer', 'producer', 'writer', 'composer']:
2020-09-24 17:46:08 +02:00
if save['involvedPeople'] and role != 'composer' or save['composer'] and role == 'composer':
2020-08-15 21:34:10 +02:00
tag[role] = track.contributors[role]
elif role == 'musicpublisher' and save['involvedPeople']:
2020-08-15 21:34:10 +02:00
tag["ORGANIZATION"] = track.contributors['musicpublisher']
2020-08-14 20:31:37 +02:00
2021-12-23 23:12:50 +01:00
if save['copyright'] and track.copyright:
2020-08-15 21:34:10 +02:00
tag["COPYRIGHT"] = track.copyright
2021-01-31 17:59:15 +01:00
if save['savePlaylistAsCompilation'] and track.playlist or track.album.recordType == "compile":
tag["COMPILATION"] = "1"
2020-02-17 16:46:18 +01:00
if save['source']:
tag["SOURCE"] = 'Deezer'
tag["SOURCEID"] = str(track.id)
2021-08-04 20:39:51 +02:00
if save['rating']:
rank = round((int(track.rank) / 10000))
tag['RATING'] = str(rank)
2021-01-31 17:59:15 +01:00
if save['cover'] and track.album.embeddedCoverPath:
image = Picture()
2020-09-24 17:46:08 +02:00
image.type = PictureType.COVER_FRONT
image.mime = 'image/jpeg'
2021-01-31 17:59:15 +01:00
if str(track.album.embeddedCoverPath).endswith('png'):
2020-09-24 17:46:08 +02:00
image.mime = 'image/png'
2021-01-31 17:59:15 +01:00
with open(track.album.embeddedCoverPath, 'rb') as f:
image.data = f.read()
tag.add_picture(image)
2020-02-17 16:46:18 +01:00
tag.save(deleteid3=True)