Skip to content

Music streaming platforms (Youtube Music, Spotify, Tidal) synchronization tool

License

Notifications You must be signed in to change notification settings

SilentVoid13/SyncDisBoi

Repository files navigation

SyncDisBoi - Sync this boy!

SyncDisBoi is a simple and efficient tool designed to synchronize playlists across different music streaming platforms. It currently supports:

SyncDisBoi is the ideal tool for music enthusiasts who want to:

  • Seamlessly migrate to a new music platform while preserving their playlists and likes
  • Keep playlists in sync across multiple platforms and enjoy each platform's unique recommendation algorithms
  • Export existing playlists in a portable JSON format for easy backup or sharing

Disclaimer: While SyncDisBoi doesn't perform any deletion operations, it's always a good practice to backup your playlists. I am not responsible for any unintended changes to your playlists.

Tool workflow

For the best experience, it is recommended to use a single "source of truth" for your playlists, a primary platform where all playlist modifications are made. This ensures consistency across platforms when syncing.

Note that YouTube Music is not ideal for this role due to its limited and often inaccurate song metadata (most notably missing ISRC codes), which are essential for precise song matching when synchronizing.

SyncDisBoi synchronization workflow goes like this:

  • if the destination playlist does not exist, SyncDisBoi will create a new playlist containing the synchronized songs
  • if the destination playlist already exists, SyncDisBoi will only add songs that are not already present
  • if the --sync-likes option is specified, SyncDisBoi will also synchronize likes
  • if the --like-all option is specified, SyncDisBoi will like all synchonized songs on the destination platform

By default, SyncDisBoi does not remove songs. This is a safety measure to prevent accidental data loss. Consequently, deleting a song on the source platform and syncing will not remove it from the destination playlist.

Accuracy

SyncDisBoi focuses on synchronization accuracy, ensuring that each track on the source playlist accurately matches the corresponding track on the destination playlist. This feature is particularly useful for users who prioritize maintaining the integrity of their playlists and avoid ending up with unexpected remixes during synchronization.

If available, SyncDisBoi uses the International Standard Recording Code (ISRC) to guarantee correct track matching.

When ISRC codes are not available on the platform API, SyncDisBoi falls back to verifying the following properties to ensure that the two tracks match:

Notes:

  • The artist names are not used because the metadata is inconsistent across platforms.
  • For Youtube Music, SyncDisBoi won't sync tracks lacking album metadata, as this typically indicates a video from Youtube, which lacks the necessary metadata for accurate synchronization.

Download and Build

Pre-built binaries of SyncDisBoi for Linux, Windows, and macOS are available under the releases section.

If you prefer to build SyncDisBoi from source you simply need the rust toolchain, e.g. available via rustup. A Nix flake is also available with a pre-configured environment with support for cross-compilation.

Usage

Here are some command examples:

# sync from Youtube Music to Spotify
./sync_dis_boi \
    yt-music --client-id "<CLIENT_ID>" --client-secret "<CLIENT_SECRET>" \
    spotify --client-id "<CLIENT_ID>" --client-secret "<CLIENT_SECRET>"

# sync from Spotify to Tidal, sync likes as well
./sync_dis_boi --sync-likes \
    spotify --client-id "<CLIENT_ID>" --client-secret "<CLIENT_SECRET>" \
    tidal

# sync from Tidal to Youtube Music, like all synchronized songs
./sync_dis_boi --like-all \
    tidal \
    yt-music --client-id "<CLIENT_ID>" --client-secret "<CLIENT_SECRET>"

# sync from Spotify to Youtube Music, with debug mode enabled to generate detailed statistics about the synchronization process
./sync_dis_boi --debug \
    spotify --client-id "<CLIENT_ID>" --client-secret "<CLIENT_SECRET>" \
    yt-music --client-id "<CLIENT_ID>" --client-secret "<CLIENT_SECRET>"

# export Spotify playlists to JSON
./sync_dis_boi \
    spotify --client-id "<CLIENT_ID>" --client-secret "<CLIENT_SECRET>" \
    export -d ./spotify.json

# export Youtube Music playlists to JSON
./sync_dis_boi \
    yt-music --client-id "<CLIENT_ID>" --client-secret "<CLIENT_SECRET>" \
    export -d ./yt_music.json

# export Tidal playlists to JSON
./sync_dis_boi \
    tidal \
    export -d ./tidal.json

To use SyncDisBoi, you need to set up account access for the API of the corresponding music platform.

Spotify API setup

You will then need to provide the client id and client secret as arguments for SyncDisBoi. After the first authorization, the OAuth token will be cached in ~/.config/SyncDisBoi/spotify_oauth.json (on Linux) for future use.

Notes:

  • After authorizing access for your Spotify account, SyncDisBoi will open the 'http://localhost:8888/callback' URL in your browser. If you get an 'Unable to connect' response this is normal as the server is quickly opened and shutdown once it receives the auth code.

Youtube Music API setup

The convenient OAuth "Android Auto" access has been removed by Youtube. You now have to create your own OAuth application:

  • Sign in at https://console.developers.google.com/
  • Create a new project
  • Select the project
  • Under "Enabled APIs & services" click "+ Enable APIs and services", select "Youtube Data API v3" and enable
  • Under "OAuth consent screen" create an "external" user type (fill in the app name, set the developer email as your own)
  • Add your own email for "Test users"
  • Under "Credentials" click "+ Create credentials" > OAuth client ID > Set "TVs and Limited Input devices" as the application type
  • Copy the Client ID and the Client secret

You will then need to provide the client id and client secret as arguments for SyncDisBoi. After the first authorization, the OAuth token will be cached in ~/.config/SyncDisBoi/ytmusic_oauth.json (on Linux) for future use.

Alternatively, you can use request headers to login:

  • Follow ytmusicapi's guide to generate a browser.json file.
  • Pass the browser.json file as an argument for SyncDisBoi

Notes:

  • You may have to refresh the cookies regularly as they can expire very quickly

Tidal API setup

  • On the first run, SyncDisBoi will open up a browser tab to request OAuth access for your Tidal Account.
  • Authorize the application in your browser, then press ENTER in the CLI to continue.

After the first authorization, the OAuth token will be cached in ~/.config/SyncDisBoi/tidal_oauth.json (on Linux) for future use.

Notes:

  • By default, SyncDisBoi uses Tidal's "Android Auto" application credentials to request OAuth access.
  • However, you can also create your own Tidal application and then use it in SyncDisBoi by providing its client id and client secret.

Debug mode

You can enable debug mode (--debug) to generate detailed statistics about the synchronization process.

Files are saved in the debug/ folder:

  • conversion_rate.json: success rate of song synchronization
  • missing_songs.json: list of tracks that couldn’t be synchronized
  • new_songs.json: list of tracks successfully synchronized
  • songs_with_no_albums.json: list of songs skipped due to missing album metadata

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details on how to contribute to this project.

License

SyncDisBoi is licensed under the GNU AGPLv3 license. Refer to LICENSE for more information.

Support

Your support helps me continue to maintain and improve this project. If you find SyncDisBoi useful and want to show your appreciation, consider sponsoring or donating:

  • GitHub Sponsors: Preferred method. You can sponsor me on GitHub Sponsors.
  • PayPal: You can also make a donation via PayPal.

Every bit of support is greatly appreciated!

GitHub Sponsors Paypal