""" Module for converting audio files to different formats and checking for ffmpeg binary, and downloading it if not found. """ import os import platform import re import shlex import shutil import stat import subprocess from pathlib import Path from typing import Any, Callable, Dict, List, Optional, Tuple, Union import requests from spotdl.utils.config import get_spotdl_path from spotdl.utils.formatter import to_ms __all__ = [ "FFMPEG_URLS", "FFMPEG_FORMATS", "DUR_REGEX", "TIME_REGEX", "VERSION_REGEX", "YEAR_REGEX", "FFmpegError", "is_ffmpeg_installed", "get_ffmpeg_path", "get_ffmpeg_version", "get_local_ffmpeg", "download_ffmpeg", "convert", ] FFMPEG_URLS = { "windows": { "amd64": "https://github.com/eugeneware/ffmpeg-static/releases/download/b4.4/win32-x64", "i686": "https://github.com/eugeneware/ffmpeg-static/releases/download/b4.4/win32-ia32", }, "linux": { "x86_64": "https://github.com/eugeneware/ffmpeg-static/releases/download/b4.4/linux-x64", "x86": "https://github.com/eugeneware/ffmpeg-static/releases/download/b4.4/linux-ia32", "arm32": "https://github.com/eugeneware/ffmpeg-static/releases/download/b4.4/linux-arm", "aarch64": "https://github.com/eugeneware/ffmpeg-static/releases/download/b4.4/linux-arm64", }, "darwin": { "x86_64": "https://github.com/eugeneware/ffmpeg-static/releases/download/b4.4/darwin-x64", "arm64": "https://github.com/eugeneware/ffmpeg-static/releases/download/b4.4/darwin-arm64", }, } FFMPEG_FORMATS = { "mp3": ["-codec:a", "libmp3lame"], "flac": ["-codec:a", "flac", "-sample_fmt", "s16"], "ogg": ["-codec:a", "libvorbis"], "opus": ["-codec:a", "libopus"], "m4a": ["-codec:a", "aac"], "wav": ["-codec:a", "pcm_s16le"], } DUR_REGEX = re.compile( r"Duration: (?P\d{2}):(?P\d{2}):(?P\d{2})\.(?P\d{2})" ) TIME_REGEX = re.compile( r"out_time=(?P\d{2}):(?P\d{2}):(?P\d{2})\.(?P\d{2})" ) VERSION_REGEX = re.compile(r"ffmpeg version \w?(\d+\.)?(\d+)") YEAR_REGEX = re.compile(r"Copyright \(c\) \d\d\d\d\-\d\d\d\d") class FFmpegError(Exception): """ Base class for all exceptions related to FFmpeg. """ def is_ffmpeg_installed(ffmpeg: str = "ffmpeg") -> bool: """ Check if ffmpeg is installed. ### Arguments - ffmpeg: ffmpeg executable to check ### Returns - True if ffmpeg is installed, False otherwise. """ if ffmpeg == "ffmpeg": global_ffmpeg = shutil.which("ffmpeg") if global_ffmpeg is None: ffmpeg_path = get_ffmpeg_path() else: ffmpeg_path = Path(global_ffmpeg) else: ffmpeg_path = Path(ffmpeg) if ffmpeg_path is None: return False # else check if path to ffmpeg is valid # and if ffmpeg has the correct access rights return ffmpeg_path.exists() and os.access(ffmpeg_path, os.X_OK) def get_ffmpeg_path() -> Optional[Path]: """ Get path to global ffmpeg binary or a local ffmpeg binary. ### Returns - Path to ffmpeg binary or None if not found. """ # Check if ffmpeg is installed global_ffmpeg = shutil.which("ffmpeg") if global_ffmpeg: return Path(global_ffmpeg) # Get local ffmpeg path return get_local_ffmpeg() def get_ffmpeg_version(ffmpeg: str = "ffmpeg") -> Tuple[Optional[float], Optional[int]]: """ Get ffmpeg version. ### Arguments - ffmpeg: ffmpeg executable to check ### Returns - Tuple of optional version and optional year. ### Errors - FFmpegError if ffmpeg is not installed. - FFmpegError if ffmpeg version is not found. """ # Check if ffmpeg is installed if not is_ffmpeg_installed(ffmpeg): if ffmpeg == "ffmpeg": raise FFmpegError("ffmpeg is not installed.") raise FFmpegError(f"{ffmpeg} is not a valid ffmpeg executable.") with subprocess.Popen( [ffmpeg, "-version"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, encoding="utf-8", ) as process: output = "".join(process.communicate()) # Search for version and build year in output version_result = VERSION_REGEX.search(output) year_result = YEAR_REGEX.search(output) build_year = None version = None if version_result is not None: # remove all non numeric characters from string example: n4.3 version_str = re.sub(r"[a-zA-Z]", "", version_result.group(0)) # parse version string to float version = float(version_str) if version_str else None if year_result is not None: # get build years from string example: Copyright (c) 2019-2020 build_years = [ int( re.sub(r"[^0-9]", "", year) ) # remove all non numeric characters from string for year in year_result.group(0).split( "-" ) # split string into list of years ] # get the highest build year build_year = max(build_years) return (version, build_year) def get_local_ffmpeg() -> Optional[Path]: """ Get local ffmpeg binary path. ### Returns - Path to ffmpeg binary or None if not found. """ ffmpeg_path = Path(get_spotdl_path()) / ( "ffmpeg" + (".exe" if platform.system() == "Windows" else "") ) if ffmpeg_path.is_file(): return ffmpeg_path return None def download_ffmpeg() -> Path: """ Download ffmpeg binary to spotdl directory. ### Returns - Path to ffmpeg binary. ### Notes - ffmpeg is downloaded from github releases for current platform and architecture. - executable permission is set for ffmpeg binary. """ os_name = platform.system().lower() os_arch = platform.machine().lower() ffmpeg_url: Optional[str] = None # if platform.system() == "Darwin" and ( # platform.processor() == "arm" # or subprocess.run(["sysctl", "-n", "sysctl.proc_translated"], check=False) # ): # ffmpeg_url = FFMPEG_URLS["darwin"]["arm"] # else: # ffmpeg_url = FFMPEG_URLS.get(os_name, {}).get(os_arch) ffmpeg_url = FFMPEG_URLS.get(os_name, {}).get(os_arch) if ffmpeg_url is None: raise FFmpegError("FFmpeg binary is not available for your system.") ffmpeg_path = Path( os.path.join( get_spotdl_path(), "ffmpeg" + (".exe" if os_name == "windows" else "") ) ) # Download binary and save it to a file in spotdl directory ffmpeg_binary = requests.get(ffmpeg_url, allow_redirects=True, timeout=10).content with open(ffmpeg_path, "wb") as ffmpeg_file: ffmpeg_file.write(ffmpeg_binary) # Set executable permission on linux and mac if os_name in ["linux", "darwin"]: ffmpeg_path.chmod(ffmpeg_path.stat().st_mode | stat.S_IEXEC) return ffmpeg_path def convert( input_file: Union[Path, Tuple[str, str]], output_file: Path, ffmpeg: str = "ffmpeg", output_format: str = "mp3", bitrate: Optional[str] = None, ffmpeg_args: Optional[str] = None, progress_handler: Optional[Callable[[int], None]] = None, ) -> Tuple[bool, Optional[Dict[str, Any]]]: """ Convert the input file to the output file synchronously with progress handler. ### Arguments - input_file: Path to input file or tuple of (url, file_format). - output_file: Path to output file. - ffmpeg: ffmpeg executable to use. - output_format: output format. - bitrate: constant/variable bitrate. - ffmpeg_args: ffmpeg arguments. - progress_handler: progress handler, has to accept an integer as argument. ### Returns - Tuple of conversion status and error dictionary. ### Notes - Make sure to check if ffmpeg is installed before calling this function. """ # Initialize ffmpeg command # -i is the input file arguments: List[str] = [ "-nostdin", "-y", "-i", str(input_file.resolve()) if isinstance(input_file, Path) else input_file[0], "-movflags", "+faststart", "-v", "debug", "-progress", "-", "-nostats", ] file_format = ( str(input_file.suffix).split(".")[1] if isinstance(input_file, Path) else input_file[1] ) # Add output format to command # -c:a is used if the file is not an matroska container # and we want to convert to opus # otherwise we use arguments from FFMPEG_FORMATS if output_format == "opus" and file_format != "webm": arguments.extend(["-c:a", "libopus"]) else: if ( (output_format == "opus" and file_format == "webm") or (output_format == "m4a" and file_format == "m4a") and not (bitrate or ffmpeg_args) ): # Copy the audio stream to the output file arguments.extend(["-vn", "-c:a", "copy"]) else: arguments.extend(FFMPEG_FORMATS[output_format]) # Add bitrate if specified if bitrate: # Check if bitrate is an integer # if it is then use it as variable bitrate if bitrate.isdigit(): arguments.extend(["-q:a", bitrate]) else: arguments.extend(["-b:a", bitrate]) # Add other ffmpeg arguments if specified if ffmpeg_args: arguments.extend(shlex.split(ffmpeg_args)) # Add output file at the end arguments.append(str(output_file.resolve())) # Run ffmpeg with subprocess.Popen( [ffmpeg, *arguments], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=False, ) as process: if not progress_handler: # Wait for process to finish proc_out = process.communicate() if process.returncode != 0: # get version and build year version = get_ffmpeg_version(ffmpeg) # join stdout and stderr and decode to utf-8 message = b"".join([out for out in proc_out if out]).decode("utf-8") # return error dictionary return False, { "return_code": process.returncode, "arguments": arguments, "ffmpeg": ffmpeg, "version": version[0], "build_year": version[1], "error": message, } return True, None progress_handler(0) out_buffer = [] total_dur = None while True: if process.stdout is None: continue out_line = ( process.stdout.readline().decode("utf-8", errors="replace").strip() ) if out_line == "" and process.poll() is not None: break out_buffer.append(out_line.strip()) total_dur_match = DUR_REGEX.search(out_line) if total_dur is None and total_dur_match: total_dur = to_ms(**total_dur_match.groupdict()) # type: ignore continue if total_dur: progress_time = TIME_REGEX.search(out_line) if progress_time: elapsed_time = to_ms(**progress_time.groupdict()) # type: ignore progress_handler(int(elapsed_time / total_dur * 100)) # type: ignore if process.returncode != 0: # get version and build year version = get_ffmpeg_version(ffmpeg) return False, { "return_code": process.returncode, "arguments": arguments, "ffmpeg": ffmpeg, "version": version[0], "build_year": version[1], "error": "\n".join(out_buffer), } progress_handler(100) return True, None