added copyright tags and support for mp3 embedded covers

qobuz_dl/metadata.py

@@ -2,11 +2,16 @@ import os
 import logging
 
 from mutagen.flac import FLAC, Picture
-from mutagen.mp3 import EasyMP3
+import mutagen.id3 as id3
+from mutagen.id3 import ID3NoHeaderError
 
 logger = logging.getLogger(__name__)
 
 
+# unicode symbols
+COPYRIGHT, PHON_COPYRIGHT = '\u2117', '\u00a9'
+
+
 def get_title(track_dict):
     title = track_dict["title"]
     version = track_dict.get("version")
@@ -19,8 +24,15 @@ def get_title(track_dict):
     return title
 
 
+def _format_copyright(s: str) -> str:
+    s = s.replace('(P)', PHON_COPYRIGHT)
+    s = s.replace('(C)', COPYRIGHT)
+    return s
+
+
 # Use KeyError catching instead of dict.get to avoid empty tags
-def tag_flac(filename, root_dir, final_name, d, album, istrack=True, em_image=False):
+def tag_flac(filename, root_dir, final_name, d, album,
+             istrack=True, em_image=False):
     """
     Tag a FLAC file
 
@@ -32,6 +44,14 @@ def tag_flac(filename, root_dir, final_name, d, album, istrack=True, em_image=Fa
     :param bool istrack
     :param bool em_image: Embed cover art into file
     """
+    print('in tag_flac d:')
+    # print(json.dumps(d.keys(), indent=2))
+    # print(d.keys())
+    print('album:')
+    # print(album.keys())
+    # print(json.dumps(album.keys(), indent=2))
+    print(f'{filename=}')
+    print(f'{istrack=}')
     audio = FLAC(filename)
 
     audio["TITLE"] = get_title(d)
@@ -65,19 +85,25 @@ def tag_flac(filename, root_dir, final_name, d, album, istrack=True, em_image=Fa
         audio["TRACKTOTAL"] = str(d["album"]["tracks_count"])  # TRACK TOTAL
         audio["ALBUM"] = d["album"]["title"]                   # ALBUM TITLE
         audio["DATE"] = d["album"]["release_date_original"]
+        audio["COPYRIGHT"] = _format_copyright(d["copyright"])
     else:
         audio["GENRE"] = ", ".join(album["genres_list"])  # GENRE
         audio["ALBUMARTIST"] = album["artist"]["name"]    # ALBUM ARTIST
         audio["TRACKTOTAL"] = str(album["tracks_count"])  # TRACK TOTAL
         audio["ALBUM"] = album["title"]                   # ALBUM TITLE
         audio["DATE"] = album["release_date_original"]
+        audio["COPYRIGHT"] = _format_copyright(album["copyright"])
 
     if em_image:
         emb_image = os.path.join(root_dir, "cover.jpg")
         multi_emb_image = os.path.join(
             os.path.abspath(os.path.join(root_dir, os.pardir)), "cover.jpg"
         )
-        cover_image = emb_image if os.path.isfile(emb_image) else multi_emb_image
+        if os.path.isfile(emb_image):
+            cover_image = emb_image
+        else:
+            cover_image = multi_emb_image
+
         try:
             image = Picture()
             image.type = 3
@@ -93,50 +119,97 @@ def tag_flac(filename, root_dir, final_name, d, album, istrack=True, em_image=Fa
     os.rename(filename, final_name)
 
 
-def tag_mp3(filename, root_dir, final_name, d, album, istrack=True, em_image=False):
+def tag_mp3(filename, root_dir, final_name, d, album,
+            istrack=True, em_image=False):
     """
-    Tag a mp3 file
+    Tag an mp3 file
 
-    :param str filename: mp3 file path
+    :param str filename: mp3 temporary file path
     :param str root_dir: Root dir used to get the cover art
     :param str final_name: Final name of the mp3 file (complete path)
     :param dict d: Track dictionary from Qobuz_client
-    :param bool istrack: Embed cover art into file
+    :param bool istrack
     :param bool em_image: Embed cover art into file
     """
-    # TODO: add embedded cover art support for mp3
-    audio = EasyMP3(filename)
-
-    audio["title"] = get_title(d)
-
-    audio["tracknumber"] = str(d["track_number"])
-
-    if "Disc " in final_name:
-        audio["discnumber"] = str(d["media_number"])
 
+    id3_legend = {
+        "album": id3.TALB,
+        "albumartist": id3.TPE2,
+        "artist": id3.TPE1,
+        "comment": id3.COMM,
+        "composer": id3.TCOM,
+        "copyright": id3.TCOP,
+        "date": id3.TDAT,
+        "genre": id3.TCON,
+        "isrc": id3.TSRC,
+        "label": id3.TPUB,
+        "performer": id3.TOPE,
+        "title": id3.TIT2,
+        "year": id3.TYER
+    }
     try:
-        audio["composer"] = d["composer"]["name"]
+        audio = id3.ID3(filename)
+    except ID3NoHeaderError:
+        audio = id3.ID3()
+
+    # temporarily holds metadata
+    tags = dict()
+    tags['title'] = get_title(d)
+    try:
+        tags['label'] = album["label"]["name"]
     except KeyError:
         pass
 
     try:
-        audio["artist"] = d["performer"]["name"]  # TRACK ARTIST
+        tags['artist'] = d["performer"]["name"]
     except KeyError:
         if istrack:
-            audio["artist"] = d["album"]["artist"]["name"]  # TRACK ARTIST
+            tags['artist'] = d["album"]["artist"]["name"]
         else:
-            audio["artist"] = album["artist"]["name"]
+            tags['artist'] = album["artist"]["name"]
 
     if istrack:
-        audio["genre"] = ", ".join(d["album"]["genres_list"])  # GENRE
+        tags["genre"] = ", ".join(d["album"]["genres_list"])
-        audio["albumartist"] = d["album"]["artist"]["name"]  # ALBUM ARTIST
+        tags["albumartist"] = d["album"]["artist"]["name"]
-        audio["album"] = d["album"]["title"]  # ALBUM TITLE
+        tags["album"] = d["album"]["title"]
-        audio["date"] = d["album"]["release_date_original"]
+        tags["date"] = d["album"]["release_date_original"]
+        tags["copyright"] = _format_copyright(d["copyright"])
+        tracktotal = str(d["album"]["tracks_count"])
     else:
-        audio["genre"] = ", ".join(album["genres_list"])  # GENRE
+        tags["genre"] = ", ".join(album["genres_list"])
-        audio["albumartist"] = album["artist"]["name"]  # ALBUM ARTIST
+        tags["albumartist"] = album["artist"]["name"]
-        audio["album"] = album["title"]  # ALBUM TITLE
+        tags["album"] = album["title"]
-        audio["date"] = album["release_date_original"]
+        tags["date"] = album["release_date_original"]
+        tags["copyright"] = _format_copyright(album["copyright"])
+        tracktotal = str(album["tracks_count"])
 
-    audio.save()
+    tags['year'] = tags['date'][:4]
+
+    audio['TRCK'] = id3.TRCK(encoding=3,
+                             text=f'{d["track_number"]}/{tracktotal}')
+    audio['TPOS'] = id3.TPOS(encoding=3,
+                             text=str(d["media_number"]))
+
+    def lookup_and_set_tags(tag_name, value):
+        id3tag = id3_legend[tag_name]
+        audio[id3tag.__name__] = id3tag(encoding=3, text=value)
+
+    # write metadata in `tags` to file
+    for k, v in tags.items():
+        lookup_and_set_tags(k, v)
+
+    if em_image:
+        emb_image = os.path.join(root_dir, "cover.jpg")
+        multi_emb_image = os.path.join(
+            os.path.abspath(os.path.join(root_dir, os.pardir)), "cover.jpg"
+        )
+        if os.path.isfile(emb_image):
+            cover_image = emb_image
+        else:
+            cover_image = multi_emb_image
+
+        with open(cover_image, 'rb') as cover:
+            audio.add(id3.APIC(3, 'image/jpeg', 3, '', cover.read()))
+
+    audio.save(filename, 'v2_version=3')
     os.rename(filename, final_name)