Package: tidal-wave
tidal-waveWaving at theTIDALmusic service withPython. Runs on (at least) Windows, macOS, and GNU/Linux.TIDAL is an artist-first, fan-centered music streaming platform that delivers over 100 million songs in HiFi sound quality to the global music community. © 2024 TIDAL Music ASThis project is inspired byqobuz-dl, and, particularly, is a continuation ofTidal-Media-Downloader.This project is intended for private use only: it is not intended for distribution of copyrighted content.This software uses libraries from theFFmpegproject under theLGPLv2.1. FFmpeg is a trademark ofFabrice Bellard, originator of the FFmpeg project.FeaturesRetrieveFLAC,Dolby Atmos,Sony 360 Reality Audio, orAACtracks;AVC/H.264(up to 1920x1080) +AACvideosEither a single track or an entire album can be retrievedAlbum covers and artist images are retrieved by defaultSupport for albums with multiple discsIf available, lyrics are added as metadata to tracksIf available, album reviews are retrieved as JSONVideo retrieval supportPlaylist retrieval support (video or audio or both)Mix retrieval support (video or audio)Artist's entire works retrieval support (video and audio; albums or albums and EPs and singles)Getting StartedAHiFi Plusaccount isrequiredin order to retrieve HiRes FLAC, Dolby Atmos, and Sony 360 Reality Audio tracks. Simply aHiFiplan is sufficient to retrieve in 16-bit, 44.1 kHz (i.e., lossless) or lower quality as well as videos. More information on sound quality atTIDAL's site here.RequirementsAs resources will be fetched from the World Wide Web, an Internet connection is requiredThe excellent toolFFmpegis necessary for audio file manipulation. Thecontainer imageas well as thepyinstaller-createdbinary for GNU/Linux,binary for Apple Silicon macOS,binary for x86_64 macOSbuild FFmpeg from source, so separate installation is unnecessary.Static builds are available fromJohn Van Sicklefor GNU/Linux, or most package managers featureffmpeg.For macOS, theFFmpeg download pagelinks tothis download source, or there is alwaysHomebrewFor Windows, theFFmpeg download pagelists 2 resources; orchocolateyis an optionThis is a Python package, soto use it in the default manneryou will needPython 3, version 3.8 or newer, on your system.However, as of version 2023.12.10, anOCI container image;pyapp-compiled binaries; andpyinstaller-created binaries for x86_64 GNU/Linux, Apple Silicon macOS, and x86_64 macOS are provided for download and use thatdo not require Python installedOnly a handful of Python libraries are dependencies:backoffdataclass-wizardffmpeg-pythonmutagenm3u8platformdirsrequeststyperInstallationpipInstall from PyPiInstall this project withpip: either with a virtual environment (preferred) or any other way you desire:$python3-mpipinstalltidal-waveOptionally, to get the fulltyperexperience when using this utility, add[all]to the end of thepip install command:$python3-mpipinstalltidal-wave[all]pipInstall from the RepositoryAlternatively, you can clone this repository;cdinto it; and install from there:$gitclone--depth=1https://github.com/ebb-earl-co/tidal-wave.git
$cdtidal-wave
$python3-mvenv.venv
$source.venv/bin/activate
$(.venv)pipinstall.PyinstallerexecutableThis is the preferred release artifact, compiled withpyinstaller. It bundles Python 3.11, FFmpeg 6.1.1, and thetidal-waveprogram into one binary, licensed under the terms of FFmpeg: with theGNU Lesser General Public License (LGPL) version 2.1. Installation is as simple as downloading the correct binary for your platform (currently, GNU/Linux x86_64; macOS x86_64; or macOS arm64), giving it execute permissions, and running it.$wgethttps://github.com/ebb-earl-co/tidal-wave/releases/latest/download/tidal-wave_py311_FFmpeg6.1.1_linux
$chmod+x./tidal-wave_py311_FFmpeg6.1.1_linux# optionally, rename the binary because the name is descriptive, but unwieldy$mv./tidal-wave_py311_FFmpeg6.1.1_linux./tidal-wave_linux
$./tidal-wave_linux--helppyappexecutableDownload the Rust-compiled binary fromthe Releases, and, on macOS or GNU/Linux, make it executable$wgethttps://github.com/ebb-earl-co/tidal-wave/releases/latest/download/tidal-wave_py311.pyapp
$chmod+x./tidal-wave_py311.pyappOr, on Windows, once the .exe file is downloaded, you might have to allow a security exception for an unknown developer, then:Invoke-WebRequesthttps://github.com/ebb-earl-co/tidal-wave/releases/latest/download/tidal-wave_py311_pyapp.exe&"tidal-wave_py311_pyapp.exe"--helpDockerPull the image from GitHub container repo:dockerpullghcr.io/ebb-earl-co/tidal-wave:latestQuickstartRunpython3 tidal-wave --helpto see the options available. Or, if you followed the repository cloning steps above, runpython3 -m tidal_wave --helpfrom the repository root directory,tidal-wave. In either case, you should see something like the following:Usage:python-mtidal_wave[OPTIONS]TIDAL_URL[OUTPUT_DIRECTORY]╭─Arguments───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│*tidal_urlTEXTTheTidalalbumorartistormixorplaylistortrackorvideotodownload[default:None][required]│
│output_directory[OUTPUT_DIRECTORY]Theparentdirectoryunderwhichdirectory(ies)offileswillbewritten[default:~/Music]│
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─Options─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│--audio-format[360|Atmos|HiRes|MQA|Lossless|High|Low][default:Lossless]│
│--loglevel[DEBUG|INFO|WARNING|ERROR|CRITICAL][default:INFO]│
│--include-eps-singlesNo-opunlesspassingTIDALartist.Whethertoincludeartist'sEPsandsingleswithalbums│
│--no-extra-filesWhethertonotevenattempttoretrieveartistbio,artistimage,albumreview,orplaylistm3u8│
│--no-flattenWhethertotreatplaylistsormixesasalistoftracks/videosand,assuch,retrievethemindependently│
│--install-completionInstallcompletionforthecurrentshell.│
│--show-completionShowcompletionforthecurrentshell,tocopyitorcustomizetheinstallation.│
│--helpShowthismessageandexit.│
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯UsageBy default, this tool can request (and, if no errors arise, retrieve) all of the audio formatsexceptHiResand360.TheHiRes FLACformat is only available if the credentials from an Android, Windows, iOS, or macOS device can be obtainedTheSony 360 Reality Audioformat is only available if the credentials from an Android or iOS device can be obtainedInvocation 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 theuser_config_path()function of theplatformdirspackage.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 probablyC:\Users\<USER>\Music. This directory is determined byplatformdirs.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.ExampleFirst, find the URL of the album/artist/mix/playlist/track/video desired. Then, simply pass it as the first argument totidal-wavewith no other arguments in order to:retrieve the album/artist/mix/playlist/track in Lossless quality to a subdirectory of user's music directory and INFO-level loggingin the case of audio;retrieve the video in 1080p, H.264+AAC quality to a subdirectory of user's music directory with INFO-level loggingin the case of a video URL.(.venv)$tidal-wavehttps://tidal.com/browse/track/226092704By default, the track(s) and/or video(s) are retrieved, and other files are retrieved as well; such as the artist's bio JSON, the artist's TIDAL image, the playlist's .m3u8 file, the album's review JSON, and a few others. In ordernot to retrieve any of those, pass the--no-extra-filesflag:(.venv)$tidal-wavehttps://tidal.com/browse/track/226092704--no-extra-filesTo (attempt to) get a Dolby Atmos track, and you desire to seeallof the log output, the following will do that(.venv)$tidal-wavehttps://tidal.com/browse/track/...--audio-formatatmos--logleveldebugKeep 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 tracksTo (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-wavehttps://tidal.com/browse/album/...--audio-formathires--loglevelwarningTo (attempt to) get a playlist, the following will do that.N.b.passing anything to--audio-formatis a no-op when retrieving videos.PSC:\Users\User>&tidal-wave_py311_pyapp.exehttps://tidal.com/browse/playlist/...To (attempt to) get a mix, the following will do that.N.b.passing anything to--audio-formatis a no-op when retrieving videos.$./tidal-wave_py311.pyapphttps://tidal.com/browse/mix/...To (attempt to) get all of an artist's works (albums and videos,excluding EPs and singles) in Sony 360 Reality Audio format and verbose logging, the following will do that:(.venv)$python3-mtidal_wavehttps://listen.tidal.com/artist/...--audio-format360--logleveldebugTo (attempt to) get all of an artist's works (including EPs and singles), in HiRes format, the following will do that:(.venv)$tidal-wavehttps://listen.tidal.com/artist/...--audio-formathires--include-eps-singlesPlaylists and MixesBy default, when passed a playlist or mix URL,tidal-wavewill retrieve all of the tracks and/or videos specified by that URL, and write them to a subdirectory of eitherPlaylistsorMixes, which itself is a subdirectory of the specifiedoutput_directory. E.g.~/Music/Mixes/My Daily Discovery [016dccd302e9ac6132d8334cfbc022]. In this directory, once all of the tracks and/or videos have been retrieved, they are renamed based on the order in which they appear in the playlist. E.g.(.venv)$tidal-wavehttps://listen.tidal.com/playlist/1b418bb8-90a7-4f87-901d-707993838346

$ls~/Music/Playlists/NewArrivals[1b418bb8-90a7-4f87-901d-707993838346]/'001 - Dance Alone [CD].flac''002 - Kissing Strangers [CD].flac''003 - Sunday Service [CD].flac'If this is not the desired behavior, pass the--no-flattenflag. This flag instructstidal-waveto leave the tracks and/or videos in the directory where they would be written if they had been passed totidal-waveindependently. E.g.(.venv)$tidal-wavehttps://listen.tidal.com/playlist/1b418bb8-90a7-4f87-901d-707993838346--no-flatten

$ls~/Music/'Sia/Dance Alone [343225498] [2024]/01 - Dance Alone [CD].flac''USHER/COMING HOME [339249017] [2024]/05 - Kissing Strangers [CD].flac''Latto/Sunday Service [344275657] [2024]/01 - Sunday Service [CD].flac'Docker exampleThe 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 executingdocker runto avoid permissions issues! For example,$mkdir-p./Music/./config/tidal-wave/
$dockerrun\--rm-it\--nametidal-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/
$dockerrun\--nametidal-wave\--rm-it\--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-formathires\--include-eps-singlesPerhaps you don't want a single-shot executable type of Docker invocation, but rather a long-lived container into which one candocker execin order to request media at one's leisure. This is one of the requested features from the GitHub Discussions, in particular for Unraid users. In order to do this, use the following, slightly modified Docker command:$mkdir-p./Music/./config/tidal-wave/
$dockerrun\--nametidal-wave\-dit\--volume./Music:/home/debian/Music\--volume./config/tidal-wave:/home/debian/.config/tidal-wave\--entrypoint"/bin/bash"\ghcr.io/ebb-earl-co/tidal-wave:latest
$dockerexec-ittidal-wavepython3-mtidal_wavehttps://tidal.com/browse/album/...
$dockerexec-ittidal-wavepython3-mtidal_wavehttps://tidal.com/browse/mix/...
$dockerexec-ittidal-wavepython3-mtidal_wavehttps://tidal.com/browse/playlist/...
$dockerexec-ittidal-wavepython3-mtidal_wavehttps://tidal.com/browse/track/...DevelopmentThe easiest way to start working on development is to fork this project on GitHub, or clone the repository to your local machine and do the pull requesting on GitHub later. In any case, there will need to be some getting from GitHub first, so, roughly, the process is:Get Python 3.8+ on your systemUse a virtualenv or some other Python environment system (poetry, pipenv, etc.)Clone the repository:$ git clone --depth=1 https://github.com/ebb-earl-co/tidal-wave/git* Obviously replace the URL with your forked version if you've followed that strategyActivate the virtual environment and install the required packages (requirements.txt):(some-virtual-env) $ python3 -m pip install -r requirements.txt* optional packages to follow the coding style and build process; `shiv`, `black`: `(some-virtual-env) $ python3 -m pip install shiv black`
* optionally, Rust and cargo in order to build the `pyapp` artifacts
* optionally, Docker to build the OCI container artifactsFrom a Python REPL (or, my preferred method, an iPython session), import all the relevant modules, or the targeted ones for development:fromtidal_waveimportalbum,artist,dash,hls,login,main,media,mix,models,oauth,playlist,requesting,track,utils,videofromtidal_wave.mainimportlogging,user_music_path,Path