A tool to wave at the TIDAL music service.
Project description
tidal-wave
Waving at the TIDAL music service. Runs on (at least) Windows, macOS, and GNU/Linux.
This project is inspired by qobuz-dl
, and, particularly, is a continuation of Tidal-Media-Downloader
. This project is intended for private use only: it is not intended for distribution of copyrighted content
Features
- Download FLAC, Dolby Atmos, Sony 360 Reality Audio, or AAC tracks; AVC/H.264 (up to 1920x1080) + AAC videos
- Either a single track or an entire album can be downloaded
- Album covers and artist images are downloaded by default
- Support for albums with multiple discs
- If available, lyrics are added as metadata to tracks
- If available, album reviews are downloaded as JSON
- Video download support
- Playlist download support (video or audio or both)
- Mix download support (video or audio)
- Artist's entire works download support (video and audio; albums or albums and EPs and singles)
Getting Started
A HiFi Plus account is required in order to retrieve HiRes FLAC, Dolby Atmos, and Sony 360 Reality Audio tracks. Simply a HiFi plan is sufficient to download in 16-bit, 44.1 kHz (i.e. lossless) or lower quality as well as videos.
Requirements
- This is a Python tool, so you will need Python 3 on your system: this tool supports Python 3.8 or newer.
- However, as of version 2023.12.10, a GitHub container and
pyapp
-compiled binaries are release artifacts that do not require Python installed
- However, as of version 2023.12.10, a GitHub container and
- As resources will be fetched from the World Wide Web, an Internet connection is required
- The excellent tool FFmpeg is necessary for audio file manipulation. It is available from almost every package manager; or static builds are available from John Van Sickle.
- For Windows, the FFmpeg download page lists 2 resources; or
chocolatey
is an option - The Dockerfile builds FFmpeg into the image
- For Windows, the FFmpeg download page lists 2 resources; or
- Only a handful of Python libraries are dependencies:
Installation
pip
install
Install this project with pip
: either with a virtual environment (preferred) or any other way you desire:
$ python3 -m pip install tidal-wave
Optionally, to get the full typer
experience when using this utility, add [all]
to the end of the pip install command
:
$ python3 -m pip install tidal-wave[all]
Local pip
install
Alternatively, you can clone this repository; cd
into it; and install from there:
$ git clone https://github.com/ebb-earl-co/tidal-wave.git
$ cd tidal-wave
$ python3 -m venv .venv
$ source .venv/bin/activate
$ (.venv) pip install .
Shiv executable
As yet another option, if you don't want to mess with pip
, you can download the .pyz
artifact in the releases page. It is a binary created using the shiv
project and is used in the following way:
# download the .pyz file of the latest (or your desired) release
$ wget https://github.com/ebb-earl-co/tidal-wave/releases/download/<VERSION>/tidal-wave_<VERSION>.pyz
$ ./tidal-wave_<VERSION>.pyz --help
pyapp
executable
Download the Rust-compiled binary from the Releases, and, on macOS or GNU/Linux, make it executable
$ wget https://github.com/ebb-earl-co/tidal-wave/releases/download/<VERSION>/tidal-wave_<VERSION>.pyapp
$ chmod +x ./tidal-wave_<VERSION>.pyapp
Or, on Windows, once the .exe file is downloaded, you might have to allow a security exception for an unkown developer.
Docker
Pull the image from GitHub container repo:
docker pull ghcr.io/ebb-earl-co/tidal-wave:latest
pyapp
executable
Download the Rust-compiled binary from the Releases, and, on macOS or GNU/Linux, make it executable
$ wget https://github.com/ebb-earl-co/tidal-wave/releases/download/<VERSION>/tidal-wave_<VERSION>.pyapp
$ chmod +x ./tidal-wave_<VERSION>.pyapp
Or, on Windows, once the .exe file is downloaded, you might have to allow a security exception for an unkown developer.
Docker
Pull the image from GitHub container repo:
docker pull ghcr.io/ebb-earl-co/tidal-wave:latest
Quickstart
Run python3 tidal-wave --help
to see the options available. Or, if you followed the repository cloning steps above, run python3 -m tidal_wave --help
from the repository root directory, tidal-wave
. In either case, you should see something like the following:
Usage: tidal-wave [OPTIONS] TIDAL_URL [OUTPUT_DIRECTORY]
╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * tidal_url TEXT The Tidal album or mix or playlist or track or video to download [default: None] [required] │
│ output_directory [OUTPUT_DIRECTORY] The parent directory under which files will be written [default: /home/${USER}/music/] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --audio-format [360|Atmos|HiRes|MQA|Lossless|High|Low] [default: Lossless] │
│ --loglevel [DEBUG|INFO|WARNING|ERROR|CRITICAL] [default: INFO] │
│ --include-eps-singles No-op unless passing TIDAL artist. Whether to include artist's EPs and singles with albums │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Usage
By default, this tool can request (and, if no errors arise, retrieve) all of the audio formats except
HiRes
and360
.
The HiRes FLAC format is only available if the credentials from an Android, Windows, iOS, or macOS device can be obtained
The Sony 360 Reality Audio format is only available if the credentials from an Android or iOS device can be obtained
Invocation of this tool will store credentials in a particular directory in the user's "home" directory: for Unix-like systems, this will be /home/${USER}/.config/tidal-wave
: for Windows, it varies: in either OS situation, the exact directory is determined by the user_config_path()
function of the platformdirs
package.
Similarly, all media retrieved is placed in subdirectories of the user's default Music directory: for Unix-like systems, this probably is /home/${USER}/Music
; for Windows it is probably C:\Users\<USER>\Music
. This directory is determined by platformdirs.user_music_path()
.
- If a different path is passed to the second CLI argument,
output_directory
, then all media is written to subdirectories of that directory. - Even videos are downloaded here (for now) for simplicity
Example
- First, find the URL of the track or album ID desired. Then, simmply pass it as the first argument to
tidal-wave
with no other arguments to: download the track/album/playlist in Lossless quality to a subdirectory of user's music directory and INFO-level logging.
(.venv) $ tidal-wave https://tidal.com/browse/track/226092704
- To (attempt to) get a Dolby Atmos track, and you desire to see all of the log output, the following will do that
(.venv) $ tidal-wave https://tidal.com/browse/track/... --audio-format atmos --loglevel debug
Keep in mind that authentication from an Android (preferred), iOS, Windows, or macOS device will need to be extracted and passed to this tool in order to access HiRes FLAC and Sony 360 Reality Audio versions of tracks
- To (attempt to) get a HiRes FLAC version of an album, and you desire to see only warnings and errors, the following will do that:
$ ./tidal-wave_<VERSION>.pyz https://tidal.com/browse/album/... --audio-format hires --loglevel warning
- To (attempt to) get a video, the following will do that. N.b. passing anything to
--audio-format
is a no-op when downloading videos.
$ ./tidal-wave_<VERSION>.pyz https://tidal.com/browse/video/...
- To (attempt to) get an entire playlist, the following will do that. N.b. passing anything to
--audio-format
is a no-op when downloading videos.
$ ./tidal-wave_<VERSION>.pyapp https://tidal.com/browse/playlist/...
- To (attempt to) get an mix, the following will do that. N.b. passing anything to
--audio-format
is a no-op when downloading videos.
$ ./tidal-wave_<VERSION>.pyapp https://tidal.com/browse/mix/...
- To (attempt to) get all of an artist's works (albums and videos, excluding EPs and singles) in Dolby Atmos format and verbose logging, the following will do that:
(.venv) $ python3 -m tidal_wave https://listen.tidal.com/artist/... --audio-format atmos --loglevel debug
- To (attempt to) get all of an artist's works (including EPs and singles), in HiRes format, the following will do that:
(.venv) $ tidal-wave https://listen.tidal.com/artist/... --audio-format hires --include-eps-singles
Docker example
The command line options are the same for the Python invocation, but in order to save configuration and audio data, volumes need to be passed. If they are bind mounts to directories, they must be created before executing docker run
to avoid permissions issues! For example,
$ mkdir -p ./Music/ ./config/tidal-wave/
$ docker run \
--name tidal-wave \
--volume ./Music:/home/debian/Music \
--volume ./config/tidal-wave:/home/debian/.config/tidal-wave \
ghcr.io/ebb-earl-co/tidal-wave:latest \
https://tidal.com/browse/track/...
Using Docker might be an attractive idea in the event that you want to retrieve all of the videos, albums, EPs, and singles in highest quality possible for a given artist. The following Docker invocation will do that for you:
$ mkdir -p ./Music/ ./config/tidal-wave/
$ docker run \
--name tidal-wave \
--volume ./Music:/home/debian/Music \
--volume ./config/tidal-wave:/home/debian/.config/tidal-wave \
ghcr.io/ebb-earl-co/tidal-wave:latest \
https://listen.tidal.com/artist/... \
--audio-format hires \
--include-eps-singles
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tidal_wave-2024.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06d5216ea98e09724e8eebb695bb5f5a521ade87248ce9e9eb259ac17bf1459d |
|
MD5 | d7e73ef26c7625bab4d0296581d3d068 |
|
BLAKE2b-256 | 9a23d0b08a0bcdccf3da9e83b51a12ca5ee2088ffd8a103fe67ffb53875959dd |