Add Tidal source (#256)

Co-authored-by: Nansess <[email protected]>
Co-authored-by: topi314 <[email protected]>

Author: 3 people

README.md

@@ -3,7 +3,7 @@
 # LavaSrc
 
 > [!IMPORTANT]
-> For LavaSrc v3 (Lavaplayer v1 & Lavalink v3) look [here](https://github.com/topi314/LavaSrc/tree/v3-legacy) 
+> For LavaSrc v3 (Lavaplayer v1 & Lavalink v3) look [here](https://github.com/topi314/LavaSrc/tree/v3-legacy)
 
 A collection of additional [Lavaplayer v2](https://github.com/sedmelluq/lavaplayer), [LavaSearch](https://github.com/topi314/LavaSearch) & [LavaLyrics](https://github.com/topi314/LavaLyrics) Audio Source Managers and [Lavalink v4](https://github.com/lavalink-devs/Lavalink) Plugin.
 * [Spotify](https://www.spotify.com) playlists/albums/songs/artists(top tracks)/search results/[LavaSearch](https://github.com/topi314/LavaSearch)/[LavaLyrics](https://github.com/topi314/LavaLyrics)
@@ -13,9 +13,10 @@ A collection of additional [Lavaplayer v2](https://github.com/sedmelluq/lavaplay
 * [Flowery TTS](https://flowery.pw/docs) (Thx to [bachtran02](https://github.com/bachtran02) for implementing it)
 * [YouTube](https://youtube.com) & [YouTubeMusic](https://music.youtube.com/) [LavaSearch](https://github.com/topi314/LavaSearch)/[LavaLyrics](https://github.com/topi314/LavaLyrics)  (Thx to [DRSchlaubi](https://github.com/DRSchlaubi) for helping me)
 * [Vk Music](https://music.vk.com/) playlists/albums/songs/artists(top tracks)/search results/[LavaLyrics](https://github.com/topi314/LavaLyrics)/[LavaSearch](https://github.com/topi314/LavaSearch) (Thx to [Krispeckt](https://github.com/Krispeckt) for implementing it)
+* [Tidal](https://tidal.com) playlists/albums/songs/search results (Thx to [Nansess](https://github.com/Nansess) and [InfNibor](https://github.com/infnibor) for implementing it)
 
 > [!IMPORTANT]
-> Tracks from Spotify & Apple Music don't actually play from their sources, but are instead resolved via the configured providers
+> Tracks from Spotify & Apple Music & Tidal don't actually play from their sources, but are instead resolved via the configured providers
 
 ## Summary
 
@@ -62,6 +63,8 @@ To get your Yandex Music access token go [here](#yandex-music)
 
 To get your Vk Music user token go [here](#vk-music)
 
+To get your Tidal token go [here](#tidal)
+
 > [!WARNING]
 > YES `plugins` IS AT ROOT IN THE YAML
 
@@ -82,6 +85,7 @@ plugins:
       flowerytts: false # Enable Flowery TTS source
       youtube: false # Enable YouTube search source (https://github.com/topi314/LavaSearch)
       vkmusic: false # Enable Vk Music source
+      tidal: false # Enable Tidal source
     lyrics-sources:
       spotify: false # Enable Spotify lyrics source
       deezer: false # Enable Deezer lyrics source
@@ -131,6 +135,10 @@ plugins:
       playlistLoadLimit: 1 # The number of pages at 50 tracks each
       artistLoadLimit: 1 # The number of pages at 10 tracks each
       recommendationsLoadLimit: 10 # Number of tracks
+    tidal:
+      countryCode: "US" # the country code for accessing region-specific content on Tidal (ISO 3166-1 alpha-2).
+      searchLimit: 6 # How many search results should be returned
+      token: "your tidal token" # the token used for accessing the tidal api. See https://github.com/topi314/LavaSrc#tidal
 ```
 
 ### Plugin Info
@@ -153,21 +161,21 @@ LavaSrc adds the following fields to tracks & playlists in Lavalink
 
 ```json
 {
-    "encoded": "...",
-    "info": {
-        ...
-    },
-    "pluginInfo": {
-        "albumName": "...",
-        "albumArtUrl": "...",
-        "artistUrl": "...",
-        "artistArtworkUrl": "...",
-        "previewUrl": "...",
-        "isPreview": false
-    },
-    "userData": {
-        ...
-    }
+  "encoded": "...",
+  "info": {
+    ...
+  },
+  "pluginInfo": {
+    "albumName": "...",
+    "albumArtUrl": "...",
+    "artistUrl": "...",
+    "artistArtworkUrl": "...",
+    "previewUrl": "...",
+    "isPreview": false
+  },
+  "userData": {
+    ...
+  }
 }
 ```
 
@@ -188,19 +196,19 @@ LavaSrc adds the following fields to tracks & playlists in Lavalink
 
 ```json
 {
-    "info": {
-        ...
-    },
-    "pluginInfo": {
-        "type": "playlist",
-        "url": "...",
-        "artworkUrl": "...",
-        "author": "...",
-        "totalTracks": 10
-    },
-    "tracks": [
-        ...
-    ]
+  "info": {
+    ...
+  },
+  "pluginInfo": {
+    "type": "playlist",
+    "url": "...",
+    "artworkUrl": "...",
+    "author": "...",
+    "totalTracks": 10
+  },
+  "tracks": [
+    ...
+  ]
 }
 ```
 
@@ -288,39 +296,38 @@ PATCH /v4/lavasrc/config
 
 ```json
 {
-    "spotify": {
-        "clientId": "your client id",
-        "clientSecret": "your client secret",
-        "spDc": "your sp dc cookie"
-    },
-    "applemusic": {
-        "mediaAPIToken": "your apple music api token"
-    },
-    "deezer": {
-        "arl": "your deezer arl",
-        "formats": [
-            "FLAC",
-            "MP3_320",
-            "MP3_256",
-            "MP3_128",
-            "MP3_64",
-            "AAC_64"
-        ]
-    },
-    "yandexMusic": {
-        "accessToken": "your access token"
-    },
-    "vkMusic": {
-        "userToken": "your user token"
-    }
+  "spotify": {
+    "clientId": "your client id",
+    "clientSecret": "your client secret",
+    "spDc": "your sp dc cookie"
+  },
+  "applemusic": {
+    "mediaAPIToken": "your apple music api token"
+  },
+  "deezer": {
+    "arl": "your deezer arl",
+    "formats": [
+      "FLAC",
+      "MP3_320",
+      "MP3_256",
+      "MP3_128",
+      "MP3_64",
+      "AAC_64"
+    ]
+  },
+  "yandexMusic": {
+    "accessToken": "your access token"
+  },
+  "vkMusic": {
+    "userToken": "your user token"
+  }
 }
 ```
 
 </details>
 
 ---
 
-
 ## Lavaplayer Usage
 
 Replace `x.y.z` with the latest version number
@@ -368,9 +375,9 @@ dependencies {
     <version>x.y.z</version>
   </dependency>
   <dependency>
-      <groupId>com.github.topi314.lavasrc</groupId>
-      <artifactId>lavasrc-protocol-jvm</artifactId>
-      <version>x.y.z</version>
+    <groupId>com.github.topi314.lavasrc</groupId>
+    <artifactId>lavasrc-protocol-jvm</artifactId>
+    <version>x.y.z</version>
   </dependency>
 </dependencies>
 ```
@@ -452,7 +459,7 @@ follow [this guide](https://developer.apple.com/help/account/configure-app-capab
 AudioPlayerManager playerManager = new DefaultAudioPlayerManager();
 
 // create a new AppleMusicSourceManager with the standard providers, apple music api token, countrycode and AudioPlayerManager and register it
-var appleMusic = new AppleMusicSourceManager(null, mediaAPIToken , "us", playerManager);
+var appleMusic = new AppleMusicSourceManager(null, mediaAPIToken, "us", playerManager);
 playerManager.registerSourceManager(appleMusic);
 ```
 
@@ -468,6 +475,7 @@ var searchManager = new SearchManager();
 // register source
 searchManager.registerSearchManager(appleMusic);
 ```
+
 </details>
 
 ---
@@ -537,7 +545,7 @@ searchManager.registerSearchManager(deezer);
 1. (Optional) Open DevTools in your browser and on the Network tab enable trotlining.
 2. Go to https://oauth.yandex.ru/authorize?response_type=token&client_id=23cabbbdc6cd418abb4b39c32c41195d
 3. Authorize and grant access
-4. The browser will redirect to the address like `https://music.yandex.ru/#access_token=AQAAAAAYc***&token_type=bearer&expires_in=31535645`.
+4. The browser will redirect to the address like `https://music.yandex.ru/#access_token=AQAAAAAYc***&token_type=bearer&expires_in=31535645`. 
    Very quickly there will be a redirect to another page, so you need to have time to copy the link. ![image](https://user-images.githubusercontent.com/68972811/196124196-a817b828-3387-4f70-a2b2-cdfdc71ce1f2.png)
 5. Your accessToken, what is after `access_token`.
 
@@ -673,6 +681,24 @@ searchManager.registerSearchManager(vkmusic);
 
 ---
 
+### Tidal
+
+<details>
+<summary>How to get tidal token</summary>
+
+Use Google to get the tidal token.
+
+</details>
+
+```java
+AudioPlayerManager playerManager = new DefaultAudioPlayerManager();
+
+// create a new TidalSourceManager with the token and register it
+var tidal = new TidalSourceManager(countryCode, () -> playerManager, new DefaultMirroringAudioTrackResolver(providers), "your tidal token");
+
+playerManager.registerSourceManager(tidal);
+```
+
 ## Supported URLs and Queries
 
 ### Spotify
@@ -740,4 +766,13 @@ You can read about all the available options [here](https://flowery.pw/docs), a
 * https://vk.com/audios700949584?q=phonk%20album&z=audio_playlist-2000933493_13933493%2Fbe3494d46d310b0d0d
 * https://vk.ru/audios700949584?q=phonk%20album&z=audio_playlist-2000933493_13933493
 
+### Tidal
+
+* `tdsearch:animals architects`
+* `tdrec:12345678` (`tdrec:{TRACK_ID}`)
+* https://tidal.com/browse/track/12345678
+* https://tidal.com/browse/album/12345678
+* https://tidal.com/browse/playlist/12345678
+* https://tidal.com/browse/artist/12345678
+
 ---

application.example.yml

@@ -20,6 +20,7 @@ plugins:
       youtube: false # Enable YouTube lyrics source
       yandexmusic: false # Enable Yandex Music lyrics source
       vkmusic: false # Enable Vk Music lyrics source
+      tidal: false # Enable Tidal source
     spotify:
       clientId: "your client id"
       clientSecret: "your client secret"
@@ -55,6 +56,10 @@ plugins:
       playlistLoadLimit: 1 # The number of pages at 50 tracks each
       artistLoadLimit: 1 # The number of pages at 10 tracks each
       recommendationsLoadLimit: 10 # Number of tracks
+    tidal:
+      countryCode: "US" # the country code for accessing region-specific content on Tidal (ISO 3166-1 alpha-2).
+      searchLimit: 6 # How many search results should be returned
+      token: "your tidal token" # the token used for accessing the tidal api. See https://github.com/topi314/LavaSrc#tidal
 
 server: # REST and WS server
   port: 2333

main/src/main/java/com/github/topi314/lavasrc/mirror/MirroringAudioTrack.java

@@ -25,7 +25,7 @@ public MirroringAudioTrack(AudioTrackInfo trackInfo, String albumName, String al
 		this.sourceManager = sourceManager;
 	}
 
-	abstract protected InternalAudioTrack createAudioTrack(AudioTrackInfo trackInfo, SeekableInputStream inputStream);
+	protected abstract InternalAudioTrack createAudioTrack(AudioTrackInfo trackInfo, SeekableInputStream inputStream);
 
 	@Override
 	public void process(LocalAudioTrackExecutor executor) throws Exception {

main/src/main/java/com/github/topi314/lavasrc/tidal/TidalAudioPlaylist.java

@@ -0,0 +1,12 @@
+package com.github.topi314.lavasrc.tidal;
+
+import com.github.topi314.lavasrc.ExtendedAudioPlaylist;
+import com.sedmelluq.discord.lavaplayer.track.AudioTrack;
+
+import java.util.List;
+
+public class TidalAudioPlaylist extends ExtendedAudioPlaylist {
+	public TidalAudioPlaylist(String name, List<AudioTrack> tracks, ExtendedAudioPlaylist.Type type, String url, String artworkURL, String author, Integer totalTracks) {
+		super(name, tracks, type, url, artworkURL, author, totalTracks);
+	}
+}

main/src/main/java/com/github/topi314/lavasrc/tidal/TidalAudioTrack.java

@@ -0,0 +1,28 @@
+package com.github.topi314.lavasrc.tidal;
+
+import com.github.topi314.lavasrc.mirror.MirroringAudioTrack;
+import com.sedmelluq.discord.lavaplayer.tools.io.SeekableInputStream;
+import com.sedmelluq.discord.lavaplayer.track.AudioTrack;
+import com.sedmelluq.discord.lavaplayer.track.AudioTrackInfo;
+import com.sedmelluq.discord.lavaplayer.track.InternalAudioTrack;
+
+public class TidalAudioTrack extends MirroringAudioTrack {
+
+	public TidalAudioTrack(AudioTrackInfo trackInfo, TidalSourceManager sourceManager) {
+		this(trackInfo, null, null, null, null, sourceManager);
+	}
+
+	public TidalAudioTrack(AudioTrackInfo trackInfo, String albumName, String albumUrl, String artistUrl, String artistArtworkUrl, TidalSourceManager sourceManager) {
+		super(trackInfo, albumName, albumUrl, artistUrl, artistArtworkUrl, null, false, sourceManager);
+	}
+
+	@Override
+	protected InternalAudioTrack createAudioTrack(AudioTrackInfo trackInfo, SeekableInputStream stream) {
+		throw new UnsupportedOperationException("Previews are not supported by Tidal");
+	}
+
+	@Override
+	protected AudioTrack makeShallowClone() {
+		return new TidalAudioTrack(this.trackInfo, (TidalSourceManager) this.sourceManager);
+	}
+}