1
0
Fork 0
mirror of https://github.com/fiso64/slsk-batchdl.git synced 2024-12-22 06:22:41 +00:00
slsk-batchdl/README.md

246 lines
16 KiB
Markdown
Raw Normal View History

2023-03-24 23:42:01 +00:00
# slsk-batchdl
2024-01-20 08:41:23 +00:00
A batch downloader for Soulseek built with Soulseek.NET. Accepts CSV files or Spotify and YouTube urls.
2023-03-24 23:42:01 +00:00
2024-04-27 19:46:35 +00:00
## Examples
2024-05-05 19:39:18 +00:00
Download tracks from a csv file:
2023-03-24 23:42:01 +00:00
```
2023-11-28 13:31:42 +00:00
slsk-batchdl test.csv
2023-06-12 15:04:49 +00:00
```
2024-05-05 19:39:18 +00:00
The names of the columns in the csv should be: `Artist`, `Title`, `Album`, `Length`. Some alternatives are also accepted. You can use `--print tracks` before downloading to check if everything has been parsed correctly. Only the title or album column is required, but additional info may improve search results.
<br>
Download spotify likes while skipping songs that already exist in the output folder:
2023-06-12 15:04:49 +00:00
```
2023-11-28 13:31:42 +00:00
slsk-batchdl spotify-likes --skip-existing
2023-06-12 15:04:49 +00:00
```
2023-11-15 21:45:51 +00:00
To download private playlists or liked songs you will need to provide a client id and secret, which you can get here https://developer.spotify.com/dashboard/applications. Create an app and add `http://localhost:48721/callback` as a redirect url in its settings.
2024-05-05 19:39:18 +00:00
<br>
Download from a youtube playlist with fallback to yt-dlp in case it is not found on soulseek, and retrieve deleted video titles from wayback machine:
2023-06-12 15:04:49 +00:00
```
2023-11-28 13:31:42 +00:00
slsk-batchdl --get-deleted --yt-dlp "https://www.youtube.com/playlist?list=PLI_eFW8NAFzYAXZ5DrU6E6mQ_XfhaLBUX"
2023-06-12 15:04:49 +00:00
```
2024-05-05 19:39:18 +00:00
Playlists are retrieved using the YoutubeExplode library which unfortunately doesn't always return all videos. You can use the official API by providing a key with `--youtube-key`. Get it here https://console.cloud.google.com. Create a new project, click "Enable Api" and search for "youtube data", then follow the prompts.
Also note that due the high number of music videos in the above example playlist, it may be better to remove all text in parentheses and disable song duration checking: `--regex "[\[\(].*?[\]\)]" --length-tol -1 --pref-length-tol -1`.
2023-06-12 15:04:49 +00:00
2024-05-05 19:39:18 +00:00
<br>
Search & download a specific song, preferring lossless:
2023-06-12 15:04:49 +00:00
```
2023-11-28 13:31:42 +00:00
slsk-batchdl "title=MC MENTAL @ HIS BEST,length=242" --pref-format "flac,wav"
2023-10-08 20:41:44 +00:00
```
2024-03-12 22:50:22 +00:00
2024-05-05 19:39:18 +00:00
<br>
Interactive album download:
2024-03-12 22:50:22 +00:00
```
slsk-batchdl "album=Some Album" --interactive
```
2023-10-08 20:41:44 +00:00
2024-05-05 19:39:18 +00:00
<br>
Print all songs by an artist which are not in your library:
2023-10-08 20:41:44 +00:00
```
2023-12-21 16:35:04 +00:00
slsk-batchdl "artist=MC MENTAL" --aggregate --print tracks-full --skip-existing --music-dir "path\to\music"
2023-06-12 15:04:49 +00:00
```
2024-05-04 23:01:26 +00:00
## Download Modes
Depending on the provided input, the download behaviour changes:
- Normal download: When the song title is set (in the CSV row, or in the string input), the program will download a single file for every entry.
- Album download: When the album name is set and the song title is NOT set, the program will search for the album and download the entire folder.
- Aggregate download: With `--aggregate`, the program will first perform an ordinary search for the input, then attempt to group the results into distinct songs and download one of each kind. This can be used to download an artist's entire discography (or simply printing it, like in the example above).
2024-04-27 19:46:35 +00:00
## Options
2023-06-12 15:04:49 +00:00
```
2023-11-28 13:31:42 +00:00
Usage: slsk-batchdl <input> [OPTIONS]
2023-10-08 20:41:44 +00:00
2023-11-28 13:31:42 +00:00
<input> <input> is one of the following:
2023-10-08 20:41:44 +00:00
2024-03-12 22:50:22 +00:00
Spotify playlist url or 'spotify-likes': Download a spotify
2023-10-08 20:41:44 +00:00
playlist or your liked songs. --spotify-id and
--spotify-secret may be required in addition.
Youtube playlist url: Download songs from a youtube playlist.
Provide a --youtube-key to include unavailabe uploads.
Path to a local CSV file: Use a csv file containing track
info to download. The names of the columns should be Artist,
2024-05-04 22:38:47 +00:00
Title, Album, Length. Only the title or album column is
required, but extra info may improve search results.
2023-10-08 20:41:44 +00:00
2023-11-15 21:45:51 +00:00
Name of the track, album, or artist to search for:
Can either be any typical search string or a comma-separated
2024-03-12 22:50:22 +00:00
list like 'title=Song Name,artist=Artist Name,length=215'
2023-11-15 21:45:51 +00:00
Allowed properties are: title, artist, album, length (sec)
2024-03-12 22:50:22 +00:00
Specify artist and album only to download an album.
2023-10-08 20:41:44 +00:00
2023-03-24 23:42:01 +00:00
Options:
2023-06-12 15:04:49 +00:00
--user <username> Soulseek username
--pass <password> Soulseek password
2024-03-12 22:50:22 +00:00
-p --path <path> Download folder
-f --folder <name> Subfolder name. Set to '.' to output directly to the
download folder (default: playlist/csv name)
-n --number <maxtracks> Download the first n tracks of a playlist
-o --offset <offset> Skip a specified number of tracks
-r --reverse Download tracks in reverse order
--name-format <format> Name format for downloaded tracks, e.g "{artist} - {title}"
--fast-search Begin downloading as soon as a file satisfying the preferred
conditions is found. Increases chance to download bad files.
--m3u <option> Create an m3u8 playlist file
'none': Do not create a playlist file
'fails' (default): Write only failed downloads to the m3u
'all': Write successes + fails as comments
2023-11-15 21:45:51 +00:00
--spotify-id <id> spotify client ID
--spotify-secret <secret> spotify client secret
2024-05-05 19:39:18 +00:00
--remove-from-playlist Remove downloaded tracks from playlist (spotify only)
2023-10-08 20:41:44 +00:00
--youtube-key <key> Youtube data API key
2023-11-15 21:45:51 +00:00
--get-deleted Attempt to retrieve titles of deleted videos from wayback
machine. Requires yt-dlp.
2023-10-08 20:41:44 +00:00
--time-format <format> Time format in Length column of the csv file (e.g h:m:s.ms
2023-11-15 21:45:51 +00:00
for durations like 1:04:35.123). Default: s
2023-10-08 20:41:44 +00:00
--yt-parse Enable if the csv file contains YouTube video titles and
2023-11-15 21:45:51 +00:00
channel names; attempt to parse them into title and artist
names.
2023-10-08 20:41:44 +00:00
--format <format> Accepted file format(s), comma-separated
2023-11-28 13:31:42 +00:00
--length-tol <sec> Length tolerance in seconds (default: 3)
2023-10-08 20:41:44 +00:00
--min-bitrate <rate> Minimum file bitrate
--max-bitrate <rate> Maximum file bitrate
2024-05-04 22:25:31 +00:00
--min-samplerate <rate> Minimum file sample rate
2023-10-08 20:41:44 +00:00
--max-samplerate <rate> Maximum file sample rate
2024-05-04 22:25:31 +00:00
--min-bitdepth <depth> Minimum bit depth
--max-bitdepth <depth> Maximum bit depth
2023-10-08 20:41:44 +00:00
--strict-title Only download if filename contains track title
--strict-artist Only download if filepath contains track artist
--banned-users <list> Comma-separated list of users to ignore
2023-11-30 12:17:11 +00:00
2023-06-12 15:04:49 +00:00
--pref-format <format> Preferred file format(s), comma-separated (default: mp3)
2023-11-28 13:31:42 +00:00
--pref-length-tol <sec> Preferred length tolerance in seconds (default: 2)
2023-06-12 15:04:49 +00:00
--pref-min-bitrate <rate> Preferred minimum bitrate (default: 200)
--pref-max-bitrate <rate> Preferred maximum bitrate (default: 2200)
2024-05-04 22:25:31 +00:00
--pref-min-samplerate <rate> Preferred minimum sample rate
2023-06-12 15:04:49 +00:00
--pref-max-samplerate <rate> Preferred maximum sample rate (default: 96000)
2024-05-04 22:25:31 +00:00
--pref-min-bitdepth <depth> Preferred minimum bit depth
--pref-max-bitdepth <depth> Preferred maximum bit depth
2023-06-12 15:04:49 +00:00
--pref-strict-artist Prefer download if filepath contains track artist
2023-10-08 20:41:44 +00:00
--pref-banned-users <list> Comma-separated list of users to deprioritize
2024-05-05 19:39:18 +00:00
2024-04-27 19:46:35 +00:00
--strict Skip files with missing properties instead of accepting by
default; if --min-bitrate is set, ignores any files with
unknown bitrate.
2023-03-26 15:35:41 +00:00
2024-05-04 22:38:47 +00:00
-a --aggregate Instead of downloading a single track matching the input,
find and download all distinct songs associated with the
provided artist, album, or track title.
2024-03-12 22:50:22 +00:00
--min-users-aggregate <num> Minimum number of users sharing a track before it is
downloaded in aggregate mode. Setting it to higher values
will significantly reduce false positives, but may introduce
false negatives. Default: 2
--relax Slightly relax file filtering in aggregate mode to include
more results
--interactive When downloading albums: Allows to select the wanted album
--album-track-count <num> Specify the exact number of tracks in the album. Folders
with a different number of tracks will be ignored. Append
2024-04-27 19:46:35 +00:00
a '+' or '-' after the number for the inequalities >= and <=
2024-03-12 22:50:22 +00:00
--album-ignore-fails When downloading an album and one of the files fails, do not
skip to the next source and do not delete all successfully
downloaded files
--album-art <option> When downloading albums, optionally retrieve album images
from another location:
'default': Download from the same folder as the music
'largest': Download from the folder with the largest image
'most': Download from the folder containing the most images
2023-10-09 09:29:00 +00:00
-s --skip-existing Skip if a track matching file conditions is found in the
2023-06-12 15:04:49 +00:00
output folder or your music library (if provided)
2024-03-12 22:50:22 +00:00
--skip-mode <mode> 'name': Use only filenames to check if a track exists
'name-precise' (default): Use filenames and check conditions
'tag': Use file tags (slower)
'tag-precise': Use file tags and check file conditions
2023-06-12 15:04:49 +00:00
--music-dir <path> Specify to skip downloading tracks found in a music library
2023-11-15 21:45:51 +00:00
Use with --skip-existing
2023-06-12 15:04:49 +00:00
--skip-not-found Skip searching for tracks that weren't found on Soulseek
2024-03-12 22:50:22 +00:00
during the last run. Fails are read from the m3u file.
--no-remove-special-chars Do not remove special characters before searching
--remove-ft Remove 'feat.' and everything after before searching
--remove-brackets Remove square brackets and their contents before searching
--regex <regex> Remove a regexp from all track titles and artist names.
Optionally specify the replacement regex after a semicolon
--artist-maybe-wrong Performs an additional search without the artist name.
Useful for sources like SoundCloud where the "artist"
could just be an uploader. Note that when downloading a
YouTube playlist via url, this option is set automatically
on a per track basis, so it is best kept off in that case.
-d --desperate Tries harder to find the desired track by searching for the
2024-05-05 19:39:18 +00:00
artist/album/title only, then filtering. (slower search)
2023-06-12 15:04:49 +00:00
--yt-dlp Use yt-dlp to download tracks that weren't found on
Soulseek. yt-dlp must be available from the command line.
2023-03-24 23:42:01 +00:00
2023-11-28 13:31:42 +00:00
--config <path> Manually specify config file location
2024-03-12 22:50:22 +00:00
--search-timeout <ms> Max search time in ms (default: 5000)
2023-10-08 20:41:44 +00:00
--max-stale-time <ms> Max download time without progress in ms (default: 50000)
2023-11-28 13:31:42 +00:00
--concurrent-downloads <num> Max concurrent downloads (default: 2)
--searches-per-time <num> Max searches per time interval. Higher values may cause
30-minute bans. (default: 34)
2024-03-12 22:50:22 +00:00
--searches-renew-time <sec> Controls how often available searches are replenished.
2023-11-28 13:31:42 +00:00
Lower values may cause 30-minute bans. (default: 220)
2023-11-15 21:45:51 +00:00
--display <option> Changes how searches and downloads are displayed:
2024-04-08 19:59:04 +00:00
'single' (default): Show transfer state and percentage
'double': Transfer state and a large progress bar
'simple': No download bars or changing percentages
2023-12-20 17:23:15 +00:00
--listen-port <port> Port for incoming connections (default: 50000)
2023-06-12 15:04:49 +00:00
2023-11-15 21:45:51 +00:00
--print <option> Print tracks or search results instead of downloading:
2024-03-12 22:50:22 +00:00
'tracks': Print all tracks to be downloaded
'tracks-full': Print extended information about all tracks
'results': Print search results satisfying file conditions
'results-full': Print search results including full paths
2024-04-08 19:59:04 +00:00
--debug Print extra debug info
```
2024-05-05 19:39:18 +00:00
### File conditions
Files not satisfying the conditions will not be downloaded. For example, `--length-tol` is set to 3 by default, meaning that files whose duration differs from the supplied duration by more than 3 seconds will not be downloaded (can be disabled by setting it to -1).
Files satisfying `pref-` conditions will be preferred; setting `--pref-format "flac,wav"` will make it download high quality files if they exist, and only download low quality files if there's nothing else. Conditions can also be supplied as a semicolon-delimited string to `--cond` and `--pref`, e.g `--cond "br>=320;f=mp3,ogg;sr<96000"`.\
**Important note**: Some info may be unavailable depending on the client used by the peer. For example, the default Soulseek client does not share the file bitrate. By default, if `--min-bitrate` is set, then files with unknown bitrate will still be downloaded. You can configure it to reject all files where one of the checked properties is unavailable by enabling `--strict`. (As a consequence, if `--strict` and `--min-bitrate` is set then any files shared by users with the default client will be ignored)
2024-03-12 22:50:22 +00:00
2024-05-05 19:39:18 +00:00
### Name format
2024-03-12 22:50:22 +00:00
Available tags are: artist, artists, album_artist, album_artists, title, album, year, track, disc, filename, default_foldername. Name format supports subdirectories as well as conditional expressions: `{str1|str2}` If any tags in str1 are null, choose str2. String literals enclosed in parentheses are ignored in the null check.
```
{artist( - )title|album_artist( - )title|filename}
2024-05-05 19:39:18 +00:00
```
```
2024-03-12 22:50:22 +00:00
{album(/)}{track(. )}{artist|(unknown artist)} - {title|(unknown title)}
```
2024-05-05 19:39:18 +00:00
Here `{album(/)}` will conditionally put the download into a subfolder; if the album tag is null, then the slash won't be added to the path. An alternative is `{album|(missing album)}/` which will save all songs with unknown album under `missing album`.
### Speed vs Quality
The following options will make it go faster, but may decrease search result quality or cause instability:
- `--fast-search` skips waiting until the search completes and downloads as soon as a matching file is found
- `--concurrent-downloads` - set it to 4 or more
- `--max-stale-time` is set to 50 seconds by default, so it will wait a long time before giving up on a file
- `--searches-per-time` increase at the risk of ban, see the notes section for details.
2024-03-12 22:50:22 +00:00
2024-05-04 22:25:31 +00:00
## Configuration
2024-03-12 22:50:22 +00:00
Create a file named `slsk-batchdl.conf` in the same directory as the executable and write your arguments there, e.g:
2023-05-25 19:55:02 +00:00
```
--username "fakename"
--password "fakepass"
--pref-format "flac"
```
2024-04-27 19:46:35 +00:00
## Notes
2024-04-11 12:20:36 +00:00
- For macOS builds you can use publish.sh to build the app. Download dotnet from https://dotnet.microsoft.com/en-us/download/dotnet/6.0, then run `chmod +x publish.sh && sh publish.sh`
2023-10-08 20:41:44 +00:00
- `--display single` and especially `double` can cause the printed lines to be duplicated or overwritten on some configurations. Use `simple` if that's an issue.
2024-05-07 12:40:46 +00:00
- The server will ban you for 30 minutes if too many searches are performed within a short timespan. The program has a search limiter which can be adjusted with `--searches-per-time` and `--searches-renew-time` (when limit is reached, the status of the downloads will be "Waiting"). By default it is configured to allow up to 34 searches every 220 seconds. These values were determined through experimentation as unfortunately I couldn't find any information regarding soulseek's rate limits, so they may be incorrect.