From 506c2dc00738ecee28eff045993aa180564b2607 Mon Sep 17 00:00:00 2001 From: Brett Anda Date: Sat, 4 May 2024 11:11:59 -0600 Subject: [PATCH] new lavalink and wavelink updates/fix --- cogs/music.py | 164 +++++++++++++++++++------------------------- docker-compose.yml | 2 +- lavalink.config.yml | 33 ++++++++- requirements.txt | 2 +- 4 files changed, 103 insertions(+), 98 deletions(-) diff --git a/cogs/music.py b/cogs/music.py index 74538d6e..7ca99ff5 100644 --- a/cogs/music.py +++ b/cogs/music.py @@ -16,7 +16,6 @@ import copy as co from yarl import URL from typing_extensions import Annotated -from wavelink.ext import spotify from functions import (MessageColors, checks, config, embed, exceptions, paginator) @@ -168,19 +167,9 @@ class Track(wavelink.Playable): requester: discord.Member -class SearchType(Enum): - Generic = wavelink.GenericTrack # direct playback url - YouTube = wavelink.YouTubeTrack - YouTubeMusic = wavelink.YouTubeMusicTrack - YouTubePlaylist = wavelink.YouTubePlaylist - SoundCloud = wavelink.SoundCloudTrack - SoundCloudPlaylist = wavelink.SoundCloudPlaylist - Spotify = spotify.SpotifyTrack - - class CustomSearch(discord.app_commands.Transformer): @staticmethod - def get_platform(value: str) -> SearchType: + def get_platform(value: str) -> str: if value.startswith("http"): link = URL(value) log.info(link.host) @@ -188,59 +177,46 @@ def get_platform(value: str) -> SearchType: log.info(link.query) if link.host and ("youtube.com" in link.host or "youtu.be" in link.host): if link.path == "/playlist" or link.query.get("list") is not None: - return SearchType.YouTubePlaylist - return SearchType.YouTube + return "youtubeplaylist" + return "youtube" elif link.host and "soundcloud.com" in link.host: - return SearchType.SoundCloud + return "soundcloud" elif link.host and "spotify.com" in link.host: - return SearchType.Spotify - return SearchType.Generic - return SearchType.YouTube - - @classmethod - async def transform(cls, interaction: discord.Interaction, value: str, /) -> list[Track]: - platform = cls.get_platform(value) - value = value.strip("<>") - log.info(platform) - if platform is SearchType.Spotify: - decoded = spotify.decode_url(value) - if decoded: - if decoded['type'] is spotify.SpotifySearchType.playlist: - tracks = [] - async for t in spotify.SpotifyTrack.iterator(query=value): - t.requester = interaction.user # type: ignore - tracks.append(t) - return tracks - tracks = await platform.value.search(value) - if platform == SearchType.YouTubePlaylist and isinstance(tracks, wavelink.YouTubePlaylist): - tracks = tracks.tracks - for t in tracks: - t.requester = interaction.user # type: ignore - return tracks # type: ignore + return "spotify" + return "youtube" + + # @classmethod + # async def transform(cls, interaction: discord.Interaction, value: str, /) -> list[Track]: + # platform = cls.get_platform(value) + # value = value.strip("<>") + # log.info(platform) + # if platform is SearchType.Spotify: + # decoded = spotify.decode_url(value) + # if decoded: + # if decoded['type'] is spotify.SpotifySearchType.playlist: + # tracks = [] + # async for t in spotify.SpotifyTrack.iterator(query=value): + # t.requester = interaction.user + # tracks.append(t) + # return tracks + # tracks = await platform.value.search(value) + # if platform == SearchType.YouTubePlaylist and isinstance(tracks, wavelink.YouTubePlaylist): + # tracks = tracks.tracks + # for t in tracks: + # t.requester = interaction.user + # return tracks async def convert(self, ctx: MyContext, value: str) -> list[Track]: platform = self.get_platform(value) value = value.strip("<>") - log.info(platform) - tracks: list[Track] = [] - if platform is SearchType.Spotify: - decoded = spotify.decode_url(value) - if decoded: - if decoded['type'] is spotify.SpotifySearchType.playlist: - async for t in spotify.SpotifyTrack.iterator(query=value): - t.requester = ctx.author # type: ignore - tracks.append(t) # type: ignore - return tracks - tracks = await platform.value.search(value) # type: ignore - if platform == SearchType.YouTubePlaylist and isinstance(tracks, wavelink.YouTubePlaylist): - tracks = tracks.tracks # type: ignore + tracks = await wavelink.Playable.search(value) + if isinstance(tracks, list): for t in tracks: - t.requester = ctx.author # type: ignore + t.requester = ctx.author return tracks async def autocomplete(self, interaction: discord.Interaction, value: str, /) -> List[discord.app_commands.Choice[str]]: - platform = self.get_platform(value) - search = await platform.value.search(value) + search = await wavelink.Playable.search(value) return [discord.app_commands.Choice(name=track.title, value=track.uri or track.title) for track in search[:25]] @@ -275,11 +251,11 @@ def __init__( super().__init__(*args, **kwargs) -class TrackEventPayload(wavelink.TrackEventPayload): - player: Player - track: Track - ctx: GuildContext - original: Track | None +# class TrackEventPayload(wavelink.TrackEventPayload): +# player: Player +# track: Track +# ctx: GuildContext +# original: Track | None NUMTOEMOTES = { @@ -323,18 +299,13 @@ def __repr__(self) -> str: async def cog_load(self): nodes = [ wavelink.Node( - id=f"{os.environ.get('LAVALINKUSID','MAIN')}", + identifier=f"{os.environ.get('LAVALINKUSID','MAIN')}", uri=f"http://{os.environ['LAVALINKUSHOST']}:{os.environ['LAVALINKUSPORT']}", password=os.environ["LAVALINKUSPASS"], ) ] - spotify_client = spotify.SpotifyClient( - client_id=os.environ["SPOTIFYID"], - client_secret=os.environ["SPOTIFYSECRET"], - ) - - await wavelink.NodePool.connect(client=self.bot, nodes=nodes, spotify=spotify_client) + await wavelink.Pool.connect(client=self.bot, nodes=nodes)#, spotify=spotify_client) def cog_check(self, ctx: MyContext) -> bool: if not ctx.guild: @@ -360,11 +331,15 @@ async def cog_command_error(self, ctx: MyContext, error: commands.CommandError): log.error(f"Error in {ctx.command.qualified_name}: {type(error).__name__}: {error}") @commands.Cog.listener() - async def on_wavelink_node_ready(self, node: wavelink.Node): - log.info(f"Node {node.id} is ready!") + async def on_wavelink_node_ready(self, payload: wavelink.NodeReadyEventPayload): + log.info(f"Node {payload.node.identifier} is ready!") + + @commands.Cog.listener() + async def on_wavelink_track_exception(self, payload: wavelink.TrackExceptionEventPayload) -> None: + print(payload.exception) @commands.Cog.listener() - async def on_wavelink_track_start(self, payload: TrackEventPayload): + async def on_wavelink_track_start(self, payload: wavelink.TrackStartEventPayload): # TrackEventPayload if payload.player.channel is None: return @@ -390,11 +365,11 @@ async def on_wavelink_track_start(self, payload: TrackEventPayload): # await payload.player.channel.create_instance(topic=f"🎵 {payload.track.title}{' by ' + payload.track.requester if payload.track.requester is not None else ''}", reason="Next track started.") @commands.Cog.listener() - async def on_wavelink_track_end(self, payload: TrackEventPayload): - if not payload.player.queue.is_empty: + async def on_wavelink_inactive_player(self, player: wavelink.Player): #TrackEventPayload): + if not player.queue.is_empty: return - await payload.player.disconnect() + await player.disconnect() def required(self, ctx: GuildContext, player: Player) -> int: channel = player.channel @@ -470,7 +445,6 @@ async def play(self, ctx: GuildContext, *, query: discord.app_commands.Transform player.ctx = ctx else: player: Player = ctx.voice_client # type: ignore - player.autoplay = True # if player.channel.instance is None: # await player.channel.create_instance(topic=track.title, reason="Music time!") @@ -484,7 +458,6 @@ async def play(self, ctx: GuildContext, *, query: discord.app_commands.Transform await ctx.guild.me.request_to_speak() new_tracks = [] - is_playing = co.deepcopy(player.is_playing()) async def _play(track): track.requester = ctx.author @@ -498,10 +471,10 @@ async def _play(track): except BaseException: raise TrackNotFound() - if not player.is_playing(): - await player.play(await player.queue.get_wait()) + if not player.playing: + await player.play(query[0]) - if is_playing: + if player.playing: if len(new_tracks) == 1: await ctx.send(embed=embed(title=f"Added **{new_tracks[0].title}** to the queue.", color=MessageColors.music())) else: @@ -515,14 +488,14 @@ async def pause(self, ctx: GuildContext): """Pause the currently playing song.""" player: Player | None = ctx.voice_client # type: ignore - if player is None or player.is_paused() or player.current is None: + if player is None or player.paused or player.current is None: raise NothingPlaying() if self.is_privileged(ctx): await ctx.send(embed=embed(title='An admin or DJ has paused the player.', color=MessageColors.music())) player.pause_votes.clear() - return await player.pause() + return await player.pause(True) required = self.required(ctx, player=player) player.pause_votes.add(ctx.author) @@ -530,7 +503,7 @@ async def pause(self, ctx: GuildContext): if len(player.pause_votes) >= required: await ctx.send(embed=embed(title='Vote to pause passed. Pausing player.', color=MessageColors.music())) player.pause_votes.clear() - await player.pause() + await player.pause(True) else: await ctx.send(embed=embed(title=f'{ctx.author} has voted to pause the player.', color=MessageColors.music())) @@ -542,14 +515,14 @@ async def resume(self, ctx: GuildContext): """Resume a currently paused player.""" player: Player | None = ctx.voice_client # type: ignore - if player is None or not player.is_paused() or player.current is None: + if player is None or not player.paused or player.current is None: raise NothingPlaying() if self.is_privileged(ctx): await ctx.send(embed=embed(title='An admin or DJ has resumed the player.', color=MessageColors.music())) player.resume_votes.clear() - return await player.resume() + return await player.pause(False) required = self.required(ctx, player) player.resume_votes.add(ctx.author) @@ -557,7 +530,7 @@ async def resume(self, ctx: GuildContext): if len(player.resume_votes) >= required: await ctx.send(embed=embed(title='Vote to resume passed. Resuming player.', color=MessageColors.music())) player.resume_votes.clear() - await player.resume() + await player.pause(False) else: await ctx.send(embed=embed(title=f'{ctx.author.mention} has voted to resume the player.', color=MessageColors.music())) @@ -574,12 +547,11 @@ async def loop(self, ctx: GuildContext, type: Literal['all', 'one'] = None) -> N def set_loop(type): if type == "one": - player.queue.loop = not player.queue.loop + player.queue.mode = wavelink.QueueMode.loop elif type == "all": - player.queue.loop_all = not player.queue.loop_all + player.queue.mode = wavelink.QueueMode.loop_all else: - player.queue.loop = False - player.queue.loop_all = False + player.queue.mode = wavelink.QueueMode.normal if self.is_privileged(ctx): await ctx.send(embed=embed(title=f'An admin or DJ has set the loop to {type}.', color=MessageColors.music())) @@ -603,13 +575,13 @@ async def skip(self, ctx: GuildContext): await ctx.send(embed=embed(title='An admin or DJ has skipped the song.', color=MessageColors.music())) player.skip_votes.clear() - return await player.stop() + return await player.skip(force=False) if hasattr(player.current, "requester") and ctx.author == player.current.requester: await ctx.send(embed=embed(title='The song requester has skipped the song.', color=MessageColors.music())) player.skip_votes.clear() - return await player.stop() + return await player.skip(force=False) required = self.required(ctx, player) player.skip_votes.add(ctx.author) @@ -617,7 +589,7 @@ async def skip(self, ctx: GuildContext): if len(player.skip_votes) >= required: await ctx.send(embed=embed(title='Vote to skip passed. Skipping song.', color=MessageColors.music())) player.skip_votes.clear() - await player.stop() + await player.skip(force=False) else: await ctx.send(embed=embed(title=f'{ctx.author} has voted to skip the song. {len(player.skip_votes)}/{required}', color=MessageColors.music())) @@ -720,8 +692,10 @@ async def equalizer(self, ctx: GuildContext, *, equalizer: Annotated[str, Equali joined = "\n".join(eqs.keys()) return await ctx.send(embed=embed(title=f'Invalid EQ provided. Valid EQs:\n\n{joined}', color=MessageColors.error())) + filters = player.filters + filters.equalizer.set(bands=eq.eq) + await player.set_filters(filters) await ctx.send(embed=embed(title=f'Successfully changed equalizer to {equalizer}', color=MessageColors.music())) - await player.set_filter(wavelink.Filter(equalizer=eq)) @commands.group(name="queue", aliases=['que'], invoke_without_command=True) @commands.guild_only() @@ -737,7 +711,7 @@ async def queue(self, ctx: GuildContext): if player.queue.is_empty: return await ctx.send(embed=embed(title='There are no more songs in the queue.', color=MessageColors.error())) - entries = [track.title for track in player.queue._queue] + entries = [track.title for track in player.queue] source = PaginatorSource(entries=entries) pages = paginator.RoboPages(source=source, ctx=ctx, compact=True) @@ -753,9 +727,9 @@ async def queue_remove(self, ctx: GuildContext, *, index: int): if not player or not player.current: raise NothingPlaying() - if index < 1 or index > len(player.queue._queue): + if index < 1 or index > player.queue.count: return await ctx.send(embed=embed(title='Invalid index provided.', color=MessageColors.error())) - entry = player.queue._queue[index - 1] + entry = player.queue[index - 1] if self.is_privileged(ctx): del player.queue[index - 1] diff --git a/docker-compose.yml b/docker-compose.yml index e1893840..e319cbab 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -34,7 +34,7 @@ services: retries: 5 start_period: 5s lavalink: - image: fredboat/lavalink:3.7.8 + image: ghcr.io/lavalink-devs/lavalink:4 restart: unless-stopped env_file: .env ports: diff --git a/lavalink.config.yml b/lavalink.config.yml index 7eeaed5d..f5d0d6b5 100644 --- a/lavalink.config.yml +++ b/lavalink.config.yml @@ -2,9 +2,14 @@ server: # REST and WS server port: 2333 address: 0.0.0.0 lavalink: + plugins: + - dependency: "com.github.topi314.lavasrc:lavasrc-plugin:4.0.1" + - dependency: "com.github.topi314.lavasearch:lavasearch-plugin:1.0.0" + - dependency: "com.github.lavalink-devs.lavaplayer-youtube-source:plugin:1.0.7" + repository: "https://jitpack.io" server: sources: - youtube: true + youtube: false bandcamp: true soundcloud: true twitch: true @@ -38,6 +43,32 @@ lavalink: #strategy: "RotateOnBan" # RotateOnBan | LoadBalance | NanoSwitch | RotatingNanoSwitch #searchTriggersFail: true # Whether a search 429 should trigger marking the ip as failing #retryLimit: -1 # -1 = use default lavaplayer value | 0 = infinity | >0 = retry will happen this numbers times + +plugins: + lavasrc: + providers: # Custom providers for track loading. This is the default + # - "dzisrc:%ISRC%" # Deezer ISRC provider + # - "dzsearch:%QUERY%" # Deezer search provider + - "ytsearch:\"%ISRC%\"" # Will be ignored if track does not have an ISRC. See https://en.wikipedia.org/wiki/International_Standard_Recording_Code + - "ytsearch:%QUERY%" # Will be used if track has no ISRC or no track could be found for the ISRC + # you can add multiple other fallback sources here + sources: + spotify: true # Enable Spotify source + applemusic: false # Enable Apple Music source + deezer: false # Enable Deezer source + yandexmusic: false # Enable Yandex Music source + flowerytts: false # Enable Flowery TTS source + youtube: false # Enable YouTube search source (https://github.com/topi314/LavaSearch) + spotify: + # clientId: "your client id" + # clientSecret: "your client secret" + countryCode: "US" # the country code you want to use for filtering the artists top tracks. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 + playlistLoadLimit: 6 # The number of pages at 100 tracks each + albumLoadLimit: 6 # The number of pages at 50 tracks each + youtube: + enabled: true + clients: ["MUSIC", "ANDROID", "WEB"] + metrics: prometheus: enabled: false diff --git a/requirements.txt b/requirements.txt index 1b7319c2..7e31a129 100644 --- a/requirements.txt +++ b/requirements.txt @@ -24,7 +24,7 @@ python-dotenv==0.21.1 requests==2.28.2 urllib3==1.26.14 validators==0.20.0 -wavelink==2.6.3 +wavelink==3.3.0 youtube-dl==2021.1.24.1 google-cloud-translate==3.10.1 openai>=0.27.0