bump version

Update apple_music_api.py

README.md

@@ -14,7 +14,7 @@ A Python CLI app for downloading Apple Music songs/music videos/posts.
 
 ## Prerequisites
 * Python 3.8 or higher
-* The cookies file of your Apple Music browser session (requires an active subscription)
+* The cookies file of your Apple Music browser session in Netscape format (requires an active subscription)
     * You can get your cookies by using one of the following extensions on your browser of choice at the Apple Music website with your account signed in:
         * Firefox: https://addons.mozilla.org/addon/export-cookies-txt
         * Chromium based browsers: https://chrome.google.com/webstore/detail/gdocmgbfkjnnpapoeobnolbbkoibbcif
@@ -60,13 +60,18 @@ gamdl [OPTIONS] URLS...
 * Enter - Confirm selection
 
 ## Configuration
-gamdl can be configured by using the command line arguments or the config file. The config file is created automatically when you run gamdl for the first time at `~/.gamdl/config.json` on Linux and `%USERPROFILE%\.gamdl\config.json` on Windows. Config file values can be overridden using command line arguments.
+gamdl can be configured by using the command line arguments or the config file.
+
+The config file is created automatically when you run gamdl for the first time at `~/.gamdl/config.json` on Linux and `%USERPROFILE%\.gamdl\config.json` on Windows.
+
+Config file values can be overridden using command line arguments.
 | Command line argument / Config file key                         | Description                                                                  | Default value                |
 | --------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------- |
 | `--disable-music-video-skip` / `disable_music_video_skip`       | Don't skip downloading music videos in albums/playlists.                     | `false`                      |
 | `--save-cover`, `-s` / `save_cover`                             | Save cover as a separate file.                                               | `false`                      |
 | `--overwrite` / `overwrite`                                     | Overwrite existing files.                                                    | `false`                      |
 | `--read-urls-as-txt`, `-r` / -                                  | Interpret URLs as paths to text files containing URLs separated by newlines. | `false`                      |
+| `--save-playlist` / `save_playlist`                             | Save a M3U8 playlist file when downloading a playlist.                       | `false`                      |
 | `--synced-lyrics-only` / `synced_lyrics_only`                   | Download only the synced lyrics.                                             | `false`                      |
 | `--no-synced-lyrics` / `no_synced_lyrics`                       | Don't download the synced lyrics.                                            | `false`                      |
 | `--config-path` / -                                             | Path to config file.                                                         | `<home>/.gamdl/config.json`  |
@@ -90,10 +95,11 @@ gamdl can be configured by using the command line arguments or the config file.
 | `--template-file-multi-disc` / `template_file_multi_disc`       | Template file for the tracks that are part of a multi-disc album.            | `{disc}-{track:02d} {title}` |
 | `--template-folder-no-album` / `template_folder_no_album`       | Template folder for the tracks that are not part of an album.                | `{artist}/Unknown Album`     |
 | `--template-file-no-album` / `template_file_no_album`           | Template file for the tracks that are not part of an album.                  | `{title}`                    |
+| `--template-file-playlist` / `template_file_playlist`           | Template file for the M3U8 playlist.                                         | `Playlists/{playlist_title}` |
 | `--template-date` / `template_date`                             | Date tag template.                                                           | `%Y-%m-%dT%H:%M:%SZ`         |
 | `--exclude-tags` / `exclude_tags`                               | Comma-separated tags to exclude.                                             | `null`                       |
 | `--cover-size` / `cover_size`                                   | Cover size.                                                                  | `1200`                       |
-| `--truncate` / `truncate`                                       | Maximum length of the file/folder names.                                     | `40`                         |
+| `--truncate` / `truncate`                                       | Maximum length of the file/folder names.                                     | `null`                       |
 | `--codec-song` / `codec_song`                                   | Song codec.                                                                  | `aac-legacy`                 |
 | `--synced-lyrics-format` / `synced_lyrics_format`               | Synced lyrics format.                                                        | `lrc`                        |
 | `--codec-music-video` / `codec_music_video`                     | Music video codec.                                                           | `h264`                       |
@@ -125,6 +131,10 @@ The following variables can be used in the template folders/files and/or in the
 * `genre_id`
 * `lyrics`
 * `media_type`
+* `playlist_artist`
+* `playlist_id`
+* `playlist_title`
+* `playlist_track`
 * `rating`
 * `storefront`
 * `title`
@@ -198,4 +208,5 @@ The following cover formats are available:
 * `jpg`
 * `png`
 * `raw`
-    * This format gets the raw cover without any processing in JPEG format.
+    * This format gets the raw cover without any processing.
+    * Note that when using this format, the cover image will not be embedded within the files. To address this, you can enable `save_cover` option to save the cover as a separate file.

gamdl/__init__.py

@@ -1 +1 @@
-__version__ = "2.2.5"
+__version__ = "2.3.2"

gamdl/apple_music_api.py

@@ -78,7 +78,7 @@ class AppleMusicApi:
         try:
             response.raise_for_status()
             response_dict = response.json()
-            assert response_dict.get("data")
+            assert response_dict.get("data") or response_dict.get("results") is not None
         except (
             requests.HTTPError,
             requests.exceptions.JSONDecodeError,
@@ -190,6 +190,26 @@ class AppleMusicApi:
                 playlist["relationships"]["tracks"]["data"].extend(additional_data)
         return playlist
 
+    def search(
+        self,
+        term: str,
+        types: str = "songs,albums,artists,playlists",
+        limit: int = 25,
+        offset: int = 0,
+    ) -> dict:
+
+        response = self.session.get(
+            f"{self.AMP_API_URL}/v1/catalog/{self.storefront}/search",
+            params={
+                "term": term,
+                "types": types,
+                "limit": limit,
+                "offset": offset,
+            },
+        )
+        self._check_amp_api_response(response)
+        return response.json()["results"]
+
     def _extend_api_data(
         self,
         api_response: dict,

gamdl/cli.py

@@ -97,6 +97,11 @@ def load_config_file(
     is_flag=True,
     help="Interpret URLs as paths to text files containing URLs separated by newlines",
 )
+@click.option(
+    "--save-playlist",
+    is_flag=True,
+    help="Save a M3U8 playlist file when downloading a playlist.",
+)
 @click.option(
     "--synced-lyrics-only",
     is_flag=True,
@@ -237,6 +242,12 @@ def load_config_file(
     default=downloader_sig.parameters["template_file_no_album"].default,
     help="Template file for the tracks that are not part of an album.",
 )
+@click.option(
+    "--template-file-playlist",
+    type=str,
+    default=downloader_sig.parameters["template_file_playlist"].default,
+    help="Template file for the M3U8 playlist.",
+)
 @click.option(
     "--template-date",
     type=str,
@@ -302,6 +313,7 @@ def main(
     save_cover: bool,
     overwrite: bool,
     read_urls_as_txt: bool,
+    save_playlist: bool,
     synced_lyrics_only: bool,
     no_synced_lyrics: bool,
     config_path: Path,
@@ -325,6 +337,7 @@ def main(
     template_file_multi_disc: str,
     template_folder_no_album: str,
     template_file_no_album: str,
+    template_file_playlist: str,
     template_date: str,
     exclude_tags: str,
     cover_size: int,
@@ -372,6 +385,7 @@ def main(
         template_file_multi_disc,
         template_folder_no_album,
         template_file_no_album,
+        template_file_playlist,
         template_date,
         exclude_tags,
         cover_size,
@@ -443,7 +457,7 @@ def main(
         _urls = []
         for url in urls:
             if Path(url).exists():
-                _urls.extend(Path(url).read_text().splitlines())
+                _urls.extend(Path(url).read_text(encoding="utf-8").splitlines())
         urls = _urls
     for url_index, url in enumerate(urls, start=1):
         url_progress = f"URL {url_index}/{len(urls)}"
@@ -451,6 +465,7 @@ def main(
             logger.info(f'({url_progress}) Checking "{url}"')
             url_info = downloader.get_url_info(url)
             download_queue = downloader.get_download_queue(url_info)
+            download_queue_tracks_metadata = download_queue.tracks_metadata
         except Exception as e:
             error_count += 1
             logger.error(
@@ -458,23 +473,29 @@ def main(
                 exc_info=print_exceptions,
             )
             continue
-        for queue_index, queue_item in enumerate(download_queue, start=1):
-            queue_progress = f"Track {queue_index}/{len(download_queue)} from URL {url_index}/{len(urls)}"
-            track = queue_item.metadata
+        for download_index, track_metadata in enumerate(
+            download_queue_tracks_metadata, start=1
+        ):
+            queue_progress = f"Track {download_index}/{len(download_queue_tracks_metadata)} from URL {url_index}/{len(urls)}"
             try:
+                remuxed_path = None
+                if download_queue.playlist_attributes:
+                    playlist_track = download_index
+                else:
+                    playlist_track = None
                 logger.info(
-                    f'({queue_progress}) Downloading "{track["attributes"]["name"]}"'
+                    f'({queue_progress}) Downloading "{track_metadata["attributes"]["name"]}"'
                 )
-                if not track["attributes"].get("playParams"):
+                if not track_metadata["attributes"].get("playParams"):
                     logger.warning(
                         f"({queue_progress}) Track is not streamable, skipping"
                     )
                     continue
                 if (
-                    (synced_lyrics_only and track["type"] != "songs")
-                    or (track["type"] == "music-videos" and skip_mv)
+                    (synced_lyrics_only and track_metadata["type"] != "songs")
+                    or (track_metadata["type"] == "music-videos" and skip_mv)
                     or (
-                        track["type"] == "music-videos"
+                        track_metadata["type"] == "music-videos"
                         and url_info.type == "album"
                         and not disable_music_video_skip
                     )
@@ -482,18 +503,31 @@ def main(
                     logger.warning(
                         f"({queue_progress}) Track is not downloadable with current configuration, skipping"
                     )
-                elif track["type"] == "songs":
+                    continue
+                elif track_metadata["type"] == "songs":
                     logger.debug("Getting lyrics")
-                    lyrics = downloader_song.get_lyrics(track)
+                    lyrics = downloader_song.get_lyrics(track_metadata)
                     logger.debug("Getting webplayback")
-                    webplayback = apple_music_api.get_webplayback(track["id"])
+                    webplayback = apple_music_api.get_webplayback(track_metadata["id"])
                     tags = downloader_song.get_tags(webplayback, lyrics.unsynced)
+                    if playlist_track:
+                        tags = {
+                            **tags,
+                            **downloader.get_playlist_tags(
+                                download_queue.playlist_attributes,
+                                playlist_track,
+                            ),
+                        }
                     final_path = downloader.get_final_path(tags, ".m4a")
                     lyrics_synced_path = downloader_song.get_lyrics_synced_path(
                         final_path
                     )
-                    cover_path = downloader_song.get_cover_path(final_path)
-                    cover_url = downloader.get_cover_url(track)
+                    cover_url = downloader.get_cover_url(track_metadata)
+                    cover_file_extesion = downloader.get_cover_file_extension(cover_url)
+                    cover_path = downloader_song.get_cover_path(
+                        final_path,
+                        cover_file_extesion,
+                    )
                     if synced_lyrics_only:
                         pass
                     elif final_path.exists() and not overwrite:
@@ -508,10 +542,12 @@ def main(
                             )
                             logger.debug("Getting decryption key")
                             decryption_key = downloader_song_legacy.get_decryption_key(
-                                stream_info.pssh, track["id"]
+                                stream_info.pssh, track_metadata["id"]
                             )
                         else:
-                            stream_info = downloader_song.get_stream_info(track)
+                            stream_info = downloader_song.get_stream_info(
+                                track_metadata
+                            )
                             if not stream_info.stream_url or not stream_info.pssh:
                                 logger.warning(
                                     f"({queue_progress}) Song is not downloadable or is not"
@@ -520,11 +556,17 @@ def main(
                                 continue
                             logger.debug("Getting decryption key")
                             decryption_key = downloader.get_decryption_key(
-                                stream_info.pssh, track["id"]
+                                stream_info.pssh, track_metadata["id"]
                             )
-                        encrypted_path = downloader_song.get_encrypted_path(track["id"])
-                        decrypted_path = downloader_song.get_decrypted_path(track["id"])
-                        remuxed_path = downloader_song.get_remuxed_path(track["id"])
+                        encrypted_path = downloader_song.get_encrypted_path(
+                            track_metadata["id"]
+                        )
+                        decrypted_path = downloader_song.get_decrypted_path(
+                            track_metadata["id"]
+                        )
+                        remuxed_path = downloader_song.get_remuxed_path(
+                            track_metadata["id"]
+                        )
                         logger.debug(f'Downloading to "{encrypted_path}"')
                         downloader.download(encrypted_path, stream_info.stream_url)
                         if codec_song in LEGACY_CODECS:
@@ -548,10 +590,6 @@ def main(
                                 remuxed_path,
                                 stream_info.codec,
                             )
-                        logger.debug("Applying tags")
-                        downloader.apply_tags(remuxed_path, tags, cover_url)
-                        logger.debug(f'Moving to "{final_path}"')
-                        downloader.move_to_output_path(remuxed_path, final_path)
                     if no_synced_lyrics or not lyrics.synced:
                         pass
                     elif lyrics_synced_path.exists() and not overwrite:
@@ -563,18 +601,9 @@ def main(
                         downloader_song.save_lyrics_synced(
                             lyrics_synced_path, lyrics.synced
                         )
-                    if synced_lyrics_only or not save_cover:
-                        pass
-                    elif cover_path.exists() and not overwrite:
-                        logger.debug(
-                            f'Cover already exists at "{cover_path}", skipping'
-                        )
-                    else:
-                        logger.debug(f'Saving cover to "{cover_path}"')
-                        downloader.save_cover(cover_path, cover_url)
-                elif track["type"] == "music-videos":
+                elif track_metadata["type"] == "music-videos":
                     music_video_id_alt = downloader_music_video.get_music_video_id_alt(
-                        track
+                        track_metadata
                     )
                     logger.debug("Getting iTunes page")
                     itunes_page = itunes_api.get_itunes_page(
@@ -590,11 +619,23 @@ def main(
                     tags = downloader_music_video.get_tags(
                         music_video_id_alt,
                         itunes_page,
-                        track,
+                        track_metadata,
                     )
+                    if playlist_track:
+                        tags = {
+                            **tags,
+                            **downloader.get_playlist_tags(
+                                download_queue.playlist_attributes,
+                                playlist_track,
+                            ),
+                        }
                     final_path = downloader.get_final_path(tags, ".m4v")
-                    cover_path = downloader_music_video.get_cover_path(final_path)
-                    cover_url = downloader.get_cover_url(track)
+                    cover_url = downloader.get_cover_url(track_metadata)
+                    cover_file_extesion = downloader.get_cover_file_extension(cover_url)
+                    cover_path = downloader_music_video.get_cover_path(
+                        final_path,
+                        cover_file_extesion,
+                    )
                     if final_path.exists() and not overwrite:
                         logger.warning(
                             f'({queue_progress}) Music video already exists at "{final_path}", skipping'
@@ -610,25 +651,33 @@ def main(
                             ),
                         )
                         decryption_key_video = downloader.get_decryption_key(
-                            stream_info_video.pssh, track["id"]
+                            stream_info_video.pssh, track_metadata["id"]
                         )
                         decryption_key_audio = downloader.get_decryption_key(
-                            stream_info_audio.pssh, track["id"]
+                            stream_info_audio.pssh, track_metadata["id"]
                         )
                         encrypted_path_video = (
-                            downloader_music_video.get_encrypted_path_video(track["id"])
+                            downloader_music_video.get_encrypted_path_video(
+                                track_metadata["id"]
+                            )
                         )
                         encrypted_path_audio = (
-                            downloader_music_video.get_encrypted_path_audio(track["id"])
+                            downloader_music_video.get_encrypted_path_audio(
+                                track_metadata["id"]
+                            )
                         )
                         decrypted_path_video = (
-                            downloader_music_video.get_decrypted_path_video(track["id"])
+                            downloader_music_video.get_decrypted_path_video(
+                                track_metadata["id"]
+                            )
                         )
                         decrypted_path_audio = (
-                            downloader_music_video.get_decrypted_path_audio(track["id"])
+                            downloader_music_video.get_decrypted_path_audio(
+                                track_metadata["id"]
+                            )
                         )
                         remuxed_path = downloader_music_video.get_remuxed_path(
-                            track["id"]
+                            track_metadata["id"]
                         )
                         logger.debug(f'Downloading video to "{encrypted_path_video}"')
                         downloader.download(
@@ -658,50 +707,48 @@ def main(
                             stream_info_video.codec,
                             stream_info_audio.codec,
                         )
-                        logger.debug("Applying tags")
-                        downloader.apply_tags(remuxed_path, tags, cover_url)
-                        logger.debug(f'Moving to "{final_path}"')
-                        downloader.move_to_output_path(remuxed_path, final_path)
-                    if not save_cover:
-                        pass
-                    elif cover_path.exists() and not overwrite:
-                        logger.debug(
-                            f'Cover already exists at "{cover_path}", skipping'
-                        )
-                    else:
-                        logger.debug(f'Saving cover to "{cover_path}"')
-                        downloader.save_cover(cover_path, cover_url)
-                elif track["type"] == "uploaded-videos":
-                    stream_url = downloader_post.get_stream_url(track)
-                    tags = downloader_post.get_tags(track)
-                    post_temp_path = downloader_post.get_post_temp_path(track["id"])
+                elif track_metadata["type"] == "uploaded-videos":
+                    stream_url = downloader_post.get_stream_url(track_metadata)
+                    tags = downloader_post.get_tags(track_metadata)
                     final_path = downloader.get_final_path(tags, ".m4v")
-                    cover_path = downloader_music_video.get_cover_path(final_path)
-                    cover_url = downloader.get_cover_url(track)
+                    cover_url = downloader.get_cover_url(track_metadata)
+                    cover_file_extesion = downloader.get_cover_file_extension(cover_url)
+                    cover_path = downloader_music_video.get_cover_path(
+                        final_path,
+                        cover_file_extesion,
+                    )
                     if final_path.exists() and not overwrite:
                         logger.warning(
                             f'({queue_progress}) Post video already exists at "{final_path}", skipping'
                         )
                     else:
-                        logger.debug(f'Downloading to "{post_temp_path}"')
-                        downloader.download_ytdlp(post_temp_path, stream_url)
-                        logger.debug("Applying tags")
-                        downloader.apply_tags(post_temp_path, tags, cover_url)
-                        logger.debug(f'Moving to "{final_path}"')
-                        downloader.move_to_output_path(post_temp_path, final_path)
-                    if not save_cover:
-                        pass
-                    elif cover_path.exists() and not overwrite:
-                        logger.debug(
-                            f'Cover already exists at "{cover_path}", skipping'
+                        remuxed_path = downloader_post.get_post_temp_path(
+                            track_metadata["id"]
                         )
-                    else:
-                        logger.debug(f'Saving cover to "{cover_path}"')
-                        downloader.save_cover(cover_path, cover_url)
+                        logger.debug(f'Downloading to "{remuxed_path}"')
+                        downloader.download_ytdlp(remuxed_path, stream_url)
+                if not save_cover:
+                    pass
+                elif cover_path.exists() and not overwrite:
+                    logger.debug(f'Cover already exists at "{cover_path}", skipping')
+                else:
+                    logger.debug(f'Saving cover to "{cover_path}"')
+                    downloader.save_cover(cover_path, cover_url)
+                if remuxed_path:
+                    logger.debug("Applying tags")
+                    downloader.apply_tags(remuxed_path, tags, cover_url)
+                    logger.debug(f'Moving to "{final_path}"')
+                    downloader.move_to_output_path(remuxed_path, final_path)
+                    if save_playlist and download_queue.playlist_attributes:
+                        playlist_file_path = downloader.get_playlist_file_path(tags)
+                        logger.debug(
+                            f'Updating M3U8 playlist from "{playlist_file_path}"'
+                        )
+                        downloader.update_playlist_file(playlist_file_path, final_path)
             except Exception as e:
                 error_count += 1
                 logger.error(
-                    f'({queue_progress}) Failed to download "{track["attributes"]["name"]}"',
+                    f'({queue_progress}) Failed to download "{track_metadata["attributes"]["name"]}"',
                     exc_info=print_exceptions,
                 )
             finally:

gamdl/constants.py

@@ -208,6 +208,12 @@ SYNCED_LYRICS_FILE_EXTENSION_MAP = {
 }
 
 
+IMAGE_FILE_EXTENSION_MAP = {
+    "jpeg": ".jpg",
+    "tiff": ".tif",
+}
+
+
 EXCLUDED_CONFIG_FILE_PARAMS = (
     "urls",
     "config_path",

gamdl/downloader.py

@@ -2,9 +2,11 @@ from __future__ import annotations
 
 import base64
 import functools
+import io
 import re
 import shutil
 import subprocess
+import typing
 from pathlib import Path
 
 import ciso8601
@@ -12,19 +14,22 @@ import requests
 from InquirerPy import inquirer
 from InquirerPy.base.control import Choice
 from mutagen.mp4 import MP4, MP4Cover
+from PIL import Image
 from pywidevine import PSSH, Cdm, Device
 from yt_dlp import YoutubeDL
 
 from .apple_music_api import AppleMusicApi
-from .constants import MP4_TAGS_MAP
+from .constants import IMAGE_FILE_EXTENSION_MAP, MP4_TAGS_MAP
 from .enums import CoverFormat, DownloadMode, RemuxMode
 from .hardcoded_wvd import HARDCODED_WVD
 from .itunes_api import ItunesApi
-from .models import DownloadQueueItem, UrlInfo
+from .models import DownloadQueue, UrlInfo
 
 
 class Downloader:
-    ILLEGAL_CHARACTERS_REGEX = r'[\\/:*?"<>|;]'
+    ILLEGAL_CHARS_RE = r'[\\/:*?"<>|;]'
+    ILLEGAL_CHAR_REPLACEMENT = "_"
+    VALID_URL_RE = r"/([a-z]{2})/(artist|album|playlist|song|music-video|post)/([^/]*)(?:/([^/?]*))?(?:\?i=)?([0-9a-z]*)?"
 
     def __init__(
         self,
@@ -46,10 +51,11 @@ class Downloader:
         template_file_multi_disc: str = "{disc}-{track:02d} {title}",
         template_folder_no_album: str = "{artist}/Unknown Album",
         template_file_no_album: str = "{title}",
+        template_file_playlist: str = "Playlists/{playlist_title}",
         template_date: str = "%Y-%m-%dT%H:%M:%SZ",
         exclude_tags: str = None,
         cover_size: int = 1200,
-        truncate: int = 40,
+        truncate: int = None,
         silent: bool = False,
     ):
         self.apple_music_api = apple_music_api
@@ -70,6 +76,7 @@ class Downloader:
         self.template_file_multi_disc = template_file_multi_disc
         self.template_folder_no_album = template_folder_no_album
         self.template_file_no_album = template_file_no_album
+        self.template_file_playlist = template_file_playlist
         self.template_date = template_date
         self.exclude_tags = exclude_tags
         self.cover_size = cover_size
@@ -94,7 +101,8 @@ class Downloader:
         )
 
     def _set_truncate(self):
-        self.truncate = None if self.truncate < 4 else self.truncate
+        if self.truncate is not None:
+            self.truncate = None if self.truncate < 4 else self.truncate
 
     def _set_subprocess_additional_args(self):
         if self.silent:
@@ -114,7 +122,7 @@ class Downloader:
     def get_url_info(self, url: str) -> UrlInfo:
         url_info = UrlInfo()
         url_regex_result = re.search(
-            r"/([a-z]{2})/(artist|album|playlist|song|music-video|post)/([^/]*)(?:/([^/?]*))?(?:\?i=)?([0-9a-z]*)?",
+            self.VALID_URL_RE,
             url,
         )
         url_info.storefront = url_regex_result.group(1)
@@ -128,40 +136,42 @@ class Downloader:
         )
         return url_info
 
-    def get_download_queue(self, url_info: UrlInfo) -> list[DownloadQueueItem]:
+    def get_download_queue(self, url_info: UrlInfo) -> DownloadQueue:
         return self._get_download_queue(url_info.type, url_info.id)
 
-    def _get_download_queue(self, url_type: str, id: str) -> list[DownloadQueueItem]:
-        download_queue = []
+    def _get_download_queue(self, url_type: str, id: str) -> DownloadQueue:
+        download_queue = DownloadQueue()
         if url_type == "artist":
             artist = self.apple_music_api.get_artist(id)
-            download_queue.extend(self.get_download_queue_from_artist(artist))
+            download_queue.tracks_metadata = list(
+                self.get_download_queue_from_artist(artist)
+            )
         elif url_type == "song":
-            download_queue.append(DownloadQueueItem(self.apple_music_api.get_song(id)))
+            download_queue.tracks_metadata = [self.apple_music_api.get_song(id)]
         elif url_type == "album":
             album = self.apple_music_api.get_album(id)
-            download_queue.extend(
-                DownloadQueueItem(track)
-                for track in album["relationships"]["tracks"]["data"]
-            )
+            download_queue.tracks_metadata = [
+                track for track in album["relationships"]["tracks"]["data"]
+            ]
         elif url_type == "playlist":
-            download_queue.extend(
-                DownloadQueueItem(track)
+            playlist = self.apple_music_api.get_playlist(id)
+            download_queue.playlist_attributes = playlist["attributes"]
+            download_queue.tracks_metadata = [
+                track
                 for track in self.apple_music_api.get_playlist(id)["relationships"][
                     "tracks"
                 ]["data"]
-            )
+            ]
         elif url_type == "music-video":
-            download_queue.append(
-                DownloadQueueItem(self.apple_music_api.get_music_video(id))
-            )
+            download_queue.tracks_metadata = [self.apple_music_api.get_music_video(id)]
         elif url_type == "post":
-            download_queue.append(DownloadQueueItem(self.apple_music_api.get_post(id)))
-        else:
-            raise Exception(f"Invalid url type: {url_type}")
+            download_queue.tracks_metadata = [self.apple_music_api.get_post(id)]
         return download_queue
 
-    def get_download_queue_from_artist(self, artist: dict) -> list[DownloadQueueItem]:
+    def get_download_queue_from_artist(
+        self,
+        artist: dict,
+    ) -> typing.Generator[dict, None, None]:
         media_type = inquirer.select(
             message=f'Select which type to download for artist "{artist["attributes"]["name"]}":',
             choices=[
@@ -175,18 +185,18 @@ class Downloader:
             invalid_message="The artist doesn't have any items of this type",
         ).execute()
         if media_type == "albums":
-            return self.select_albums_from_artist(
+            yield from self.select_albums_from_artist(
                 artist["relationships"]["albums"]["data"]
             )
         elif media_type == "music-videos":
-            return self.select_music_videos_from_artist(
+            yield from self.select_music_videos_from_artist(
                 artist["relationships"]["music-videos"]["data"]
             )
 
     def select_albums_from_artist(
         self,
         albums: list[dict],
-    ) -> list[DownloadQueueItem]:
+    ) -> typing.Generator[dict, None, None]:
         choices = [
             Choice(
                 name=" | ".join(
@@ -206,20 +216,16 @@ class Downloader:
             choices=choices,
             multiselect=True,
         ).execute()
-        download_queue = []
         for album in selected:
-            download_queue.extend(
-                DownloadQueueItem(track)
-                for track in self.apple_music_api.get_album(album["id"])[
-                    "relationships"
-                ]["tracks"]["data"]
-            )
-        return download_queue
+            for track in self.apple_music_api.get_album(album["id"])["relationships"][
+                "tracks"
+            ]["data"]:
+                yield track
 
     def select_music_videos_from_artist(
         self,
         music_videos: list[dict],
-    ) -> list[DownloadQueueItem]:
+    ) -> typing.Generator[dict, None, None]:
         choices = [
             Choice(
                 name=" | ".join(
@@ -240,7 +246,54 @@ class Downloader:
             choices=choices,
             multiselect=True,
         ).execute()
-        return [DownloadQueueItem(music_video) for music_video in selected]
+        for music_video in selected:
+            yield music_video
+
+    def get_playlist_tags(
+        self,
+        playlist_attributes: dict,
+        playlist_track: int,
+    ) -> dict:
+        tags = {
+            "playlist_artist": playlist_attributes["curatorName"],
+            "playlist_id": playlist_attributes["playParams"]["id"],
+            "playlist_title": playlist_attributes["name"],
+            "playlist_track": playlist_track,
+        }
+        return tags
+
+    def get_playlist_file_path(
+        self,
+        tags: dict,
+    ):
+        template_folder = self.template_file_playlist.split("/")
+        template_file = self.template_file_playlist.split("/")
+        template_final = template_folder + template_file
+        return self.output_path.joinpath(
+            *[
+                self.get_sanitized_string(i.format(**tags), True)
+                for i in template_final[0:-1]
+            ]
+        ).joinpath(
+            *[
+                self.get_sanitized_string(template_final[-1].format(**tags), False)
+                + ".m3u8"
+            ]
+        )
+
+    def update_playlist_file(
+        self,
+        playlist_file_path: Path,
+        final_path: Path,
+    ):
+        playlist_file_path.parent.mkdir(parents=True, exist_ok=True)
+        with playlist_file_path.open("a", encoding="utf8") as playlist_file:
+            playlist_file.write(
+                final_path.relative_to(
+                    playlist_file_path.parent, walk_up=True
+                ).as_posix()
+                + "\n"
+            )
 
     @staticmethod
     def millis_to_min_sec(millis):
@@ -315,11 +368,15 @@ class Downloader:
         )
 
     def get_sanitized_string(self, dirty_string: str, is_folder: bool) -> str:
-        dirty_string = re.sub(self.ILLEGAL_CHARACTERS_REGEX, "_", dirty_string)
+        dirty_string = re.sub(
+            self.ILLEGAL_CHARS_RE,
+            self.ILLEGAL_CHAR_REPLACEMENT,
+            dirty_string,
+        )
         if is_folder:
             dirty_string = dirty_string[: self.truncate]
             if dirty_string.endswith("."):
-                dirty_string = dirty_string[:-1] + "_"
+                dirty_string = dirty_string[:-1] + self.ILLEGAL_CHAR_REPLACEMENT
         else:
             if self.truncate is not None:
                 dirty_string = dirty_string[: self.truncate - 4]
@@ -327,30 +384,34 @@ class Downloader:
 
     def get_final_path(self, tags: dict, file_extension: str) -> Path:
         if tags.get("album"):
-            final_path_folder = (
+            template_folder = (
                 self.template_folder_compilation.split("/")
                 if tags.get("compilation")
                 else self.template_folder_album.split("/")
             )
-            final_path_file = (
+            template_file = (
                 self.template_file_multi_disc.split("/")
                 if tags["disc_total"] > 1
                 else self.template_file_single_disc.split("/")
             )
         else:
-            final_path_folder = self.template_folder_no_album.split("/")
-            final_path_file = self.template_file_no_album.split("/")
-        final_path_folder = [
-            self.get_sanitized_string(i.format(**tags), True) for i in final_path_folder
-        ]
-        final_path_file = [
-            self.get_sanitized_string(i.format(**tags), True)
-            for i in final_path_file[:-1]
-        ] + [
-            self.get_sanitized_string(final_path_file[-1].format(**tags), False)
+            template_folder = self.template_folder_no_album.split("/")
+            template_file = self.template_file_no_album.split("/")
+        template_final = template_folder + template_file
+        return self.output_path.joinpath(
+            *[
+                self.get_sanitized_string(i.format(**tags), True)
+                for i in template_final[0:-1]
+            ]
+        ).joinpath(
+            self.get_sanitized_string(template_final[-1].format(**tags), False)
             + file_extension
-        ]
-        return self.output_path.joinpath(*final_path_folder).joinpath(*final_path_file)
+        )
+
+    def get_cover_file_extension(self, cover_url: str) -> str:
+        image_obj = Image.open(io.BytesIO(self.get_url_response_bytes(cover_url)))
+        image_format = image_obj.format.lower()
+        return IMAGE_FILE_EXTENSION_MAP.get(image_format, f".{image_format}")
 
     def get_cover_url(self, metadata: dict) -> str:
         if self.cover_format == CoverFormat.RAW:
@@ -422,13 +483,16 @@ class Downloader:
                 and tags.get(tag_name) is not None
             ):
                 mp4_tags[MP4_TAGS_MAP[tag_name]] = [tags[tag_name]]
-        if "cover" not in self.exclude_tags_list:
+        if (
+            "cover" not in self.exclude_tags_list
+            and self.cover_format != CoverFormat.RAW
+        ):
             mp4_tags["covr"] = [
                 MP4Cover(
                     self.get_url_response_bytes(cover_url),
                     imageformat=(
                         MP4Cover.FORMAT_JPEG
-                        if self.cover_format in (CoverFormat.JPG, CoverFormat.RAW)
+                        if self.cover_format == CoverFormat.JPG
                         else MP4Cover.FORMAT_PNG
                     ),
                 )
@@ -448,6 +512,7 @@ class Downloader:
 
     @functools.lru_cache()
     def save_cover(self, cover_path: Path, cover_url: str):
+        cover_path.parent.mkdir(parents=True, exist_ok=True)
         cover_path.write_bytes(self.get_url_response_bytes(cover_url))
 
     def cleanup_temp_path(self):

gamdl/downloader_music_video.py

@@ -300,5 +300,5 @@ class DownloaderMusicVideo:
                 codec_audio,
             )
 
-    def get_cover_path(self, final_path: Path) -> Path:
-        return final_path.with_suffix(f".{self.downloader.cover_format.value}")
+    def get_cover_path(self, final_path: Path, file_extension: str) -> Path:
+        return final_path.with_suffix(file_extension)

gamdl/downloader_song.py

@@ -9,9 +9,9 @@ from pathlib import Path
 from xml.dom import minidom
 from xml.etree import ElementTree
 
+import m3u8
 from InquirerPy import inquirer
 from InquirerPy.base.control import Choice
-import m3u8
 
 from .constants import SONG_CODEC_REGEX_MAP, SYNCED_LYRICS_FILE_EXTENSION_MAP
 from .downloader import Downloader
@@ -365,8 +365,8 @@ class DownloaderSong:
             SYNCED_LYRICS_FILE_EXTENSION_MAP[self.synced_lyrics_format]
         )
 
-    def get_cover_path(self, final_path: Path) -> Path:
-        return final_path.parent / f"Cover.{self.downloader.cover_format.value}"
+    def get_cover_path(self, final_path: Path, file_extension: str) -> Path:
+        return final_path.parent / ("Cover" + file_extension)
 
     def save_lyrics_synced(self, lyrics_synced_path: Path, lyrics_synced: str):
         lyrics_synced_path.parent.mkdir(parents=True, exist_ok=True)

gamdl/models.py

@@ -9,8 +9,9 @@ class UrlInfo:
 
 
 @dataclass
-class DownloadQueueItem:
-    metadata: dict = None
+class DownloadQueue:
+    playlist_attributes: dict = None
+    tracks_metadata: list[dict] = None
 
 
 @dataclass

pyproject.toml

@@ -8,6 +8,7 @@ dependencies = [
     "click",
     "inquirerpy",
     "m3u8",
+    "pillow",
     "pywidevine",
     "pyyaml",
     "yt-dlp",

requirements.txt

@@ -2,6 +2,7 @@ ciso8601
 click
 inquirerpy
 m3u8
+pillow
 pywidevine
 pyyaml
 yt-dlp