import base64 import json import os import random import shutil import tempfile import time import xml.etree.ElementTree as ET from collections.abc import Callable from logging import Logger from uuid import uuid4 import ffmpeg import m3u8 import requests from helper.format import is_json, is_xml from helper.tidal import name_builder_item from model.tidal import StreamManifest from requests.exceptions import HTTPError from rich.progress import Progress from tidalapi import Album, Mix, Playlist, Session, Track, UserPlaylist, Video from tidal_dl_ng.config import Settings from tidal_dl_ng.constants import REQUESTS_TIMEOUT_SEC, MediaType, SkipExisting from tidal_dl_ng.helper.decryption import decrypt_file, decrypt_security_token from tidal_dl_ng.helper.exceptions import MediaMissing, MediaUnknown, UnknownManifestFormat from tidal_dl_ng.helper.path import check_file_exists, format_path_media, path_file_sanitize from tidal_dl_ng.helper.wrapper import WrapperLogger from tidal_dl_ng.metadata import Metadata from tidal_dl_ng.model.gui_data import ProgressBars # TODO: Set appropriate client string and use it for video download. # https://github.com/globocom/m3u8#using-different-http-clients class RequestsClient: def download( self, uri: str, timeout: int = REQUESTS_TIMEOUT_SEC, headers: dict | None = None, verify_ssl: bool = True ): if not headers: headers = {} o = requests.get(uri, timeout=timeout, headers=headers) return o.text, o.url class Download: # TODO: Implement download cover 1280. session: Session = None skip_existing: SkipExisting = False def __init__(self, session: Session, skip_existing: SkipExisting = SkipExisting.Disabled): self.session = session self.skip_existing = skip_existing def _audio_mpeg_dash(self, audio: Track, path_file: str) -> str | None: pass def _video(self, video: Video, path_file: str) -> str | None: result: str | None = None m3u8_variant: m3u8.M3U8 = m3u8.load(video.get_url()) m3u8_playlist: m3u8.M3U8 | bool = False settings: Settings = Settings() resolution_best: int = 0 if m3u8_variant.is_variant: for playlist in m3u8_variant.playlists: if resolution_best < playlist.stream_info.resolution[1]: resolution_best = playlist.stream_info.resolution[1] m3u8_playlist = m3u8.load(playlist.uri) if settings.data.quality_video.value == playlist.stream_info.resolution[1]: break if m3u8_playlist: with open(path_file, "wb") as f: for segment in m3u8_playlist.data["segments"]: url = segment["uri"] r = requests.get(url, timeout=REQUESTS_TIMEOUT_SEC) f.write(r.content) result = path_file return result def instantiate_media( self, session: Session, media_type: MediaType.Track | MediaType.Video, id_media: str ) -> Track | Video: if media_type == MediaType.Track: media = Track(session, id_media) elif media_type == MediaType.Video: media = Video(session, id_media) else: raise MediaUnknown return media def item( self, path_base: str, file_template: str, fn_logger: Callable, media: Track | Video = None, media_id: str = None, media_type: MediaType = None, video_download: bool = True, progress_gui: ProgressBars = None, progress: Progress = None, ) -> (bool, str): # If only a media_id is provided, we need to create the media instance. if media_id and media_type: media = self.instantiate_media(self.session, media_type, media_id) elif not media: raise MediaMissing # If video download is not allowed end here if not video_download: fn_logger.info( f"Video downloads are deactivated (see settings). Skipping video: {name_builder_item(media)}" ) return False, "" # Create file name and path file_name_relative = format_path_media(file_template, media) path_file = os.path.abspath(os.path.normpath(os.path.join(path_base, file_name_relative))) # Compute the file extension # TODO: Move further down? if isinstance(media, Track): stream = media.stream() stream_manifest = self.stream_manifest_parse(stream.manifest) # Sanitize final path_file to fit into OS boundaries. path_file = path_file_sanitize(path_file, adapt=True) # Compute if and how downloads need to be skipped. if self.skip_existing: if self.skip_existing == SkipExisting.ExtensionIgnore: extension_ignore = True else: extension_ignore = False # TODO: Check if extension is already in `path_file` or not. download_skip = check_file_exists(path_file, extension_ignore=extension_ignore) else: download_skip = False if not download_skip: # Create a temp directory and file. with tempfile.TemporaryDirectory(ignore_cleanup_errors=True) as tmp_path_dir: tmp_path_file = os.path.join(tmp_path_dir, str(uuid4())) if isinstance(media, Track): tmp_path_file = self._audio_stream( fn_logger, media, progress, progress_gui, stream_manifest, tmp_path_file ) elif isinstance(media, Video): tmp_path_file = self._video(media, tmp_path_file) # TODO: Check if is possible to write metadata to MPEG Transport Stream files. # TODO: Make optional. # Convert `*.ts` file to `*.mp4` using ffmpeg if True: tmp_path_file = self._video_convert(tmp_path_file) path_file = os.path.splitext(path_file)[0] + ".mp4" # Move final file to the configured destination directory. os.makedirs(os.path.dirname(path_file), exist_ok=True) shutil.move(tmp_path_file, path_file) else: fn_logger.debug(f"Download skipped, since file exists: '{path_file}'") return not download_skip, path_file def _audio_stream( self, fn_logger: Callable, media: Track, progress: Progress, progress_gui: ProgressBars, stream_manifest: StreamManifest, path_file: str, ): # Set the correct progress output channel. if progress_gui is None: progress_stdout: bool = True else: progress_stdout: bool = False progress_gui.item_name.emit(media.name) try: # Download the media as stream, so we can iterate over the response. r = requests.get(stream_manifest.stream_url, stream=True, timeout=REQUESTS_TIMEOUT_SEC) r.raise_for_status() # Get file size and compute progress steps total_size_in_bytes = int(r.headers.get("content-length", 0)) block_size = 4096 p_task = progress.add_task( f"[blue]Item '{media.name[:30]}'", total=total_size_in_bytes / block_size, visible=progress_stdout, ) # Write content to file until progress is finished. while not progress.tasks[p_task].finished: with open(path_file, "wb") as f: for data in r.iter_content(chunk_size=block_size): f.write(data) # Advance progress bar. progress.advance(p_task) # To send the progress to the GUI, we need to emit the percentage. if not progress_stdout: progress_gui.item.emit(progress.tasks[p_task].percentage) except HTTPError as e: # TODO: Handle Exception... fn_logger(e) # Check if file is encrypted. needs_decryption = self.is_encrypted(stream_manifest.encryption_type) if needs_decryption: key, nonce = decrypt_security_token(stream_manifest.encryption_key) tmp_path_file_decrypted = path_file + "_decrypted" decrypt_file(path_file, tmp_path_file_decrypted, key, nonce) else: tmp_path_file_decrypted = path_file # Write metadata to file. self.metadata_write(media, tmp_path_file_decrypted) return tmp_path_file_decrypted def cover_url(self, sid: str, width: int = 320, height: int = 320): if sid is None: return "" return f"https://resources.tidal.com/images/{sid.replace('-', '/')}/{int(width)}x{int(height)}.jpg" def metadata_write(self, track: Track, path_file: str): settings: Settings = Settings() result: bool = False release_date: str = track.album.release_date.strftime("%Y-%m-%d") if track.album.release_date else "" copy_right: str = track.copyright if track.copyright else "" isrc: str = track.isrc if track.isrc else "" try: lyrics: str = track.lyrics().subtitles if hasattr(track, "lyrics") else "" except HTTPError: lyrics: str = "" # TODO: Check if it is possible to pass "None" values. m: Metadata = Metadata( path_file=path_file, lyrics=lyrics, copy_right=copy_right, title=track.name, artists=[artist.name for artist in track.artists], album=track.album.name, tracknumber=track.track_num, date=release_date, isrc=isrc, albumartist=track.artist.name, totaltrack=track.album.num_tracks if track.album.num_tracks else 1, totaldisc=track.album.num_volumes if track.album.num_volumes else 1, discnumber=track.volume_num, url_cover=self.cover_url( track.album.cover, settings.data.metadata_cover_width, settings.data.metadata_cover_height ), ) m.save() result = True return result def items( self, path_base: str, fn_logger: Logger | WrapperLogger, id_media: str = None, media_type: MediaType = None, file_template: str = None, list_media: Album | Playlist | UserPlaylist | Mix = None, video_download: bool = False, progress_gui: ProgressBars = None, progress: Progress = None, download_delay: bool = True, ): if not list_media: if media_type == MediaType.Album: list_media = Album(self.session, id_media) elif media_type == MediaType.Playlist: list_media = Playlist(self.session, id_media) elif media_type == MediaType.Mix: list_media = Mix(self.session, id_media) else: raise MediaUnknown if file_template: file_name_relative = format_path_media(file_template, list_media) path_file = path_base else: file_name_relative = file_template path_file = format_path_media(path_base, list_media) # TODO: Extend with pagination support: Iterate through `items` and `tracks`until len(returned list) == 0 if isinstance(list_media, Mix): items = list_media.items() list_media_name = list_media.title[:30] elif video_download: items = list_media.items(limit=100) list_media_name = list_media.name[:30] else: items = list_media.tracks(limit=999) list_media_name = list_media.name[:30] if progress_gui is None: progress_stdout: bool = True else: progress_stdout: bool = False p_task1 = progress.add_task(f"[green]List '{list_media_name}'", total=len(items), visible=progress_stdout) while not progress.finished: for media in items: Progress() # TODO: Handle return value of `track` method. status_download, result_path_file = self.item( path_base=path_file, file_template=file_name_relative, media=media, progress_gui=progress_gui, progress=progress, fn_logger=fn_logger, ) progress.advance(p_task1) if not progress_stdout: progress_gui.list_item.emit(progress.tasks[p_task1].percentage) if download_delay and status_download: time_sleep: float = round(random.SystemRandom().uniform(2, 5), 1) # TODO: Fix logging. Is not displayed in debug window. fn_logger.debug(f"Next download will start in {time_sleep} seconds.") time.sleep(time_sleep) def is_encrypted(self, encryption_type: str) -> bool: result = encryption_type != "NONE" return result def get_file_extension(self, stream_url: str, stream_codec: str) -> str: result = None if ".flac" in stream_url: result = ".flac" elif ".mp4" in stream_url: if "ac4" in stream_codec or "mha1" in stream_codec: result = ".mp4" elif "flac" in stream_codec: result = ".flac" else: result = ".m4a" else: result = ".m4a" return result def _video_convert(self, path_file: str) -> str: path_file_out = os.path.splitext(path_file)[0] + ".mp4" result, _ = ffmpeg.input(path_file).output(path_file_out, map=0, c="copy").run() return path_file_out def stream_manifest_parse(self, manifest: str) -> StreamManifest: # Stream Manifest is base64 encoded. manifest_parsed: str = base64.b64decode(manifest).decode("utf-8") if is_xml(manifest_parsed): root = ET.fromstring(manifest_parsed) stream_url: str = root[0][0][0][0].attrib["media"] codecs: str = root[0][0][0].attrib["codecs"] mime_type: str = root[0][0].attrib["mimeType"] file_extension: str = self.get_file_extension(stream_url, codecs) # TODO: Handle encryption key. But I have never seen an encrypted file so far. encryption_type: str = "NONE" encryption_key: str | None = None elif is_json(manifest_parsed): # JSON string to object. stream_manifest = json.loads(manifest_parsed) # TODO: Handle more than one dowload URL stream_url: str = stream_manifest["urls"][0] codecs: str = stream_manifest["codecs"] mime_type: str = stream_manifest["mimeType"] file_extension: str = self.get_file_extension(stream_url, codecs) encryption_type: str = stream_manifest["encryptionType"] encryption_key: str | None = ( stream_manifest["encryptionKey"] if self.is_encrypted(encryption_type) else None ) else: raise UnknownManifestFormat result: StreamManifest = StreamManifest( stream_url=stream_url, codecs=codecs, file_extension=file_extension, encryption_type=encryption_type, encryption_key=encryption_key, mime_type=mime_type, ) return result