Publish 3.9.1

Author: xnetcat

.dockerignore

@@ -0,0 +1,4 @@
+Dockerfile
+
+# Ignore .git folder
+.git

Dockerfile

@@ -0,0 +1,23 @@
+FROM python:3-alpine
+
+# Install ffmpeg and g++
+RUN apk add --no-cache ffmpeg g++
+
+# Create project directory
+WORKDIR /app
+
+# Add source code files to WORKDIR
+ADD . .
+
+# Upgrade pip
+RUN python -m pip install --upgrade --no-cache-dir pip
+
+# Install spotdl
+RUN pip install --no-cache-dir .
+
+# Create music directory
+RUN mkdir /music
+WORKDIR /music
+
+# Entrypoint command
+ENTRYPOINT [ "spotdl" ]

README.md

@@ -38,28 +38,28 @@ spotDL is being redesigned! This means we are currently not accepting new featur
 
 ## Prerequisites
 
--   Python 3.6.1 or above (added to PATH)
--   FFmpeg 4.2 or above (added to PATH)
+- Python 3.6.1 or above (added to PATH)
+- FFmpeg 4.2 or above (added to PATH)
 
 > **_YouTube Music must be available in your country for spotDL to work. This is because we use YouTube Music to filter search results. You can check if YouTube Music is available in your country, by visiting [YouTube Music](https://music.youtube.com)._**
 
 ## Installation
 
 ### Installing FFmpeg
 
--   [Windows Tutorial](https://windowsloop.com/install-ffmpeg-windows-10/)
--   OSX - `brew install ffmpeg`
--   Linux - `sudo apt install ffmpeg`
+- [Windows Tutorial](https://windowsloop.com/install-ffmpeg-windows-10/)
+- OSX - `brew install ffmpeg`
+- Linux - `sudo apt install ffmpeg`
 
 ### Installing spotDL
 
--   Recommended Stable Version:
+- Recommended Stable Version:
 
     ```bash
     pip install spotdl
     ```
 
--   Dev Version: **(NOT STABLE)**
+- Dev Version: **(NOT STABLE)**
 
     ```bash
     pip install https://codeload.github.com/spotDL/spotify-downloader/zip/dev
@@ -81,7 +81,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
 
 ## Usage
 
--   #### To download a song, run
+- #### To download a song, run
 
     ```bash
     spotdl [trackUrl]
@@ -93,7 +93,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
     spotdl https://open.spotify.com/track/0VjIjW4GlUZAMYd2vXMi3b
     ```
 
--   #### To download an album, run
+- #### To download an album, run
 
     ```bash
     spotdl [albumUrl]
@@ -105,7 +105,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
     spotdl https://open.spotify.com/album/4yP0hdKOZPNshxUOjY0cZj
     ```
 
--   #### To download a playlist, run
+- #### To download a playlist, run
 
     ```bash
     spotdl [playlistUrl]
@@ -117,7 +117,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
     spotdl https://open.spotify.com/playlist/37i9dQZF1E8UXBoz02kGID
     ```
 
--   #### To download all songs from an artist run
+- #### To download all songs from an artist run
 
     ```bash
     spotdl [artistUrl]
@@ -129,7 +129,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
     spotdl https://open.spotify.com/artist/1fZAAHNWdSM5gqbi9o5iEA
     ```
 
--   #### To search for and download a song, run, **with quotation marks**
+- #### To search for and download a song, run, **with quotation marks**
 
     ```bash
     spotdl '[songQuery]'
@@ -143,7 +143,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
 
     > _Note: This is not accurate and often causes errors._
 
--   #### To resume a failed/incomplete download, run
+- #### To resume a failed/incomplete download, run
 
     ```bash
     spotdl [pathToTrackingFile]
@@ -157,7 +157,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
 
     > _Note: `.spotdlTrackingFile`s are automatically created when a download starts and deleted on completion_
 
--   #### You can queue up multiple download tasks by separating the arguments with spaces
+- #### You can queue up multiple download tasks by separating the arguments with spaces
 
     ```bash
     spotdl [songQuery1] [albumUrl] [songQuery2] ... (order does not matter)
@@ -171,7 +171,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
 
     > _Note: spotDL downloads up to 4 songs in parallel, so for a faster experience, download albums and playlist, rather than tracks._
 
--   #### To download youtube video with metadata from spotify run:
+- #### To download youtube video with metadata from spotify, run
 
     ```bash
     spotdl "YouTubeURL|SpotifyURL"
@@ -185,7 +185,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
 
     > Note: Urls have to be separated with `|` and quoted properly ex. "YouTubeURL|SpotifyUrl"
 
--   #### To download songs with different output format run
+- #### To download songs with different output format run
 
     ```bash
     spotdl [songUrl] --output-format mp3/m4a/flac/opus/ogg/wav
@@ -197,7 +197,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
     spotdl [songUrl] --output-format opus
     ```
 
--   #### To use ffmpeg binary that is not on PATH run
+- #### To use ffmpeg binary that is not on PATH run
 
     ```bash
     spotdl [songUrl] --ffmpeg path/to/your/ffmpeg.exe
@@ -209,7 +209,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
     spotdl [songUrl] --ffmpeg C:\ffmpeg\bin\ffmpeg.exe
     ```
 
--   #### To generate .m3u file for each playlist run
+- #### To generate .m3u file for each playlist run
 
     ```bash
     spotdl [playlistUrl] --m3u
@@ -221,7 +221,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
       spotdl https://open.spotify.com/playlist/37i9dQZF1E8UXBoz02kGID --m3u
     ```
 
--   #### To use youtube instead of youtube music run
+- #### To use youtube instead of youtube music run
 
     ```bash
     spotdl [songUrl] --use-youtube
@@ -233,7 +233,23 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
       spotdl https://open.spotify.com/track/4fzsfWzRhPawzqhX8Qt9F3 --use-youtube
     ```
 
--   #### To change number of threads used when downloading songs run
+- #### To manually choose a lyrics provider, run
+  
+    ```bash
+      spotdl [songUrl] --lyrics-provider lyrics_provider
+    ```
+
+    available lyrics providers:
+    - genius
+    - musixmatch
+
+    example:
+
+    ```bash
+      spotdl https://open.spotify.com/track/4fzsfWzRhPawzqhX8Qt9F3 --lyrics-provider genius
+    ```
+
+- #### To change number of threads used when downloading songs run
 
     ```bash
     spotdl [songUrl] --dt [number]
@@ -245,7 +261,7 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
     spotdl https://open.spotify.com/track/4fzsfWzRhPawzqhX8Qt9F3 --dt 8
     ```
 
--   #### To change number of threads used when searching for songs run
+- #### To change number of threads used when searching for songs run
 
     ```bash
     spotdl [songUrl] --st [number]
@@ -257,19 +273,20 @@ There is an Arch User Repository (AUR) package for [spotDL](https://aur.archlinu
     spotdl https://open.spotify.com/track/4fzsfWzRhPawzqhX8Qt9F3 --st 8
     ```
 
--   #### To ignore your ffmpeg version run
+- #### To ignore your ffmpeg version run
 
     ```bash
     spotdl [songUrl] --ignore-ffmpeg-version
     ```
 
--   #### To use path template
+- #### To use path template
 
     ```bash
     spotdl [songUrl] --path-template 'template'
     ```
 
     example:
+
     ```bash
     spotdl https://open.spotify.com/track/0VjIjW4GlUZAMYd2vXMi3b --path-template '{artist}/{album}/{title} - {artist}.{ext}'
     ```

setup.cfg

@@ -1,5 +1,5 @@
 [metadata]
-version = 3.9.0
+version = 3.9.1
 
 name = spotdl
 url = https://github.com/spotDL/spotify-downloader

spotdl/console/__init__.py

@@ -1,7 +1,7 @@
 import os
 import sys
+from pathlib import Path
 import signal
-import pkg_resources
 
 from spotdl.download import ffmpeg, DownloadManager
 from spotdl.parsers import parse_arguments, parse_query
@@ -14,23 +14,20 @@ def console_entry_point():
     Its super simple, rudimentary even but, it's dead simple & it works.
     """
 
-    # If -v parameter is specified print version and exit
-    if len(sys.argv) >= 2 and sys.argv[1] in ["-v", "--version"]:
-        version = pkg_resources.require("spotdl")[0].version
-        print(version)
-        sys.exit(0)
-
-    # Parser arguments
+    # Parse arguments
     arguments = parse_arguments()
 
     # Convert arguments to dict
     args_dict = vars(arguments)
 
+    if arguments.ffmpeg:
+        args_dict["ffmpeg"] = str(Path(arguments.ffmpeg).absolute())
+    else:
+        args_dict["ffmpeg"] = "ffmpeg"
+
     # Check if ffmpeg has correct version, if not exit
     if (
-        ffmpeg.has_correct_version(
-            arguments.ignore_ffmpeg_version, arguments.ffmpeg or "ffmpeg"
-        )
+        ffmpeg.has_correct_version(arguments.ignore_ffmpeg_version, args_dict["ffmpeg"])
         is False
     ):
         sys.exit(1)
@@ -85,6 +82,7 @@ def graceful_exit(signal, frame):
             arguments.generate_m3u,
             arguments.lyrics_provider,
             arguments.search_threads,
+            arguments.path_template,
         )
 
         # Start downloading

spotdl/download/downloader.py

@@ -163,8 +163,6 @@ async def download_song(self, song_object: SongObject) -> None:
                     song_object, self.arguments["output_format"]
                 )
 
-            converted_file_path.parent.mkdir(parents=True, exist_ok=True)
-
             # if a song is already downloaded skip it
             if converted_file_path.is_file():
                 if self.display_manager:
@@ -176,10 +174,12 @@ async def download_song(self, song_object: SongObject) -> None:
                 # ! it here as a continent way to avoid executing the rest of the function.
                 return None
 
+            converted_file_path.parent.mkdir(parents=True, exist_ok=True)
+
             if self.arguments["output_format"] == "m4a":
-                ytdl_format = "bestaudio[ext=m4a]"
+                ytdl_format = "bestaudio[ext=m4a]/bestaudio/best"
             elif self.arguments["output_format"] == "opus":
-                ytdl_format = "bestaudio[ext=webm]"
+                ytdl_format = "bestaudio[ext=webm]/bestaudio/best"
             else:
                 ytdl_format = "bestaudio"
 
@@ -199,7 +199,7 @@ async def download_song(self, song_object: SongObject) -> None:
 
             try:
                 downloaded_file_path_string = await self._perform_audio_download_async(
-                    converted_file_path.name.split(".")[0],
+                    converted_file_path.name.rsplit(".", 1)[0],
                     temp_folder,
                     audio_handler,
                     song_object.youtube_link,
@@ -220,16 +220,19 @@ async def download_song(self, song_object: SongObject) -> None:
 
             downloaded_file_path = Path(downloaded_file_path_string)
 
-            if self.arguments["output_format"] != "m4a":
+            if (
+                downloaded_file_path.suffix == ".m4a"
+                and self.arguments["output_format"] == "m4a"
+            ):
+                downloaded_file_path.rename(converted_file_path)
+                ffmpeg_success = True
+            else:
                 ffmpeg_success = await ffmpeg.convert(
                     downloaded_file_path=downloaded_file_path,
                     converted_file_path=converted_file_path,
                     output_format=self.arguments["output_format"],
                     ffmpeg_path=self.arguments["ffmpeg"],
                 )
-            else:
-                downloaded_file_path.rename(converted_file_path)
-                ffmpeg_success = True
 
             if display_progress_tracker:
                 display_progress_tracker.notify_conversion_completion()

spotdl/download/embed_metadata.py

@@ -1,4 +1,5 @@
 import base64
+from pathlib import Path
 
 from urllib.request import urlopen
 from mutagen.oggopus import OggOpus

spotdl/download/ffmpeg.py

@@ -28,12 +28,13 @@ def has_correct_version(
 
     # fallback to copyright date check
     if result is not None:
-        version = result.group(0).replace("ffmpeg version ", "")
+        version_str = result.group(0)
 
         # remove all non numeric characters from string example: n4.3
-        version = re.sub(r"[a-zA-Z]", "", version)
+        version_str = re.sub(r"[a-zA-Z]", "", version_str)
+        version = float(version_str)
 
-        if float(version) < 4.2:
+        if version < 4.2:
             print(
                 f"Your FFmpeg installation is too old ({version}), please update to 4.2+\n",
                 file=sys.stderr,
@@ -43,12 +44,10 @@ def has_correct_version(
         return True
     else:
         # fallback to copyright date check
-        date_result = re.search(r"Copyright \(c\) \d\d\d\d\-\d\d\d\d", output)
+        date_result = re.search(r"Copyright \(c\) \d\d\d\d\-202\d", output)
 
         if date_result is not None:
-            date = date_result.group(0)
-            if "2021" in date or "2020" in date:
-                return True
+            return True
 
         print("Your FFmpeg version couldn't be detected", file=sys.stderr)
         return False
@@ -62,14 +61,16 @@ async def convert(
     # ! sampled length of songs matches the actual length (i.e. a 5 min song won't display
     # ! as 47 seconds long in your music player, yeah that was an issue earlier.)
 
-    downloaded_file_path = str(downloaded_file_path)
-    converted_file_path = str(converted_file_path)
+    downloaded_file_path = str(downloaded_file_path.absolute())
+    converted_file_path = str(converted_file_path.absolute())
 
     formats = {
         "mp3": ["-codec:a", "libmp3lame"],
         "flac": ["-codec:a", "flac"],
         "ogg": ["-codec:a", "libvorbis"],
-        "opus": ["-vn", "-c:a", "copy"],
+        "opus": ["-vn", "-c:a", "copy"]
+        if downloaded_file_path.endswith(".opus")
+        else ["-c:a", "libopus"],
         "m4a": ["-codec:a", "aac", "-vn"],
         "wav": [],
     }