[Audio] Expose the Keep in Queue mode, where the queue acts more like a playlist

Author: Mg Grignard

redbot/cogs/audio/core/__init__.py

@@ -134,6 +134,7 @@ def __init__(self, bot: Red):
             prefer_lyrics=False,
             repeat=False,
             shuffle=False,
+            keep_in_queue=False,
             shuffle_bumped=True,
             thumbnail=False,
             volume=100,

redbot/cogs/audio/core/commands/controller.py

@@ -124,6 +124,7 @@ async def command_now(self, ctx: commands.Context):
         shuffle = guild_data["shuffle"]
         repeat = guild_data["repeat"]
         autoplay = guild_data["auto_play"]
+        keep_in_queue = guild_data["keep_in_queue"]
         text = ""
         text += (
             _("Auto-Play")
@@ -148,6 +149,12 @@ async def command_now(self, ctx: commands.Context):
             + ": "
             + ("\N{WHITE HEAVY CHECK MARK}" if player.repeat_current else "\N{CROSS MARK}")
         )
+        text += (
+            (" | " if text else "")
+            + _("Keep in Queue")
+            + ": "
+            + ("\N{WHITE HEAVY CHECK MARK}" if keep_in_queue else "\N{CROSS MARK}")
+        )
 
         message = await self.send_embed_msg(ctx, embed=embed, footer=text)
 
@@ -608,6 +615,7 @@ async def command_stop(self, ctx: commands.Context):
             if eq:
                 await self.config.custom("EQUALIZER", ctx.guild.id).eq_bands.set(eq.bands)
             player.queue = []
+            player.next_queue_position = 0
             player.store("playing_song", None)
             player.store("prev_requester", None)
             player.store("prev_song", None)
@@ -830,6 +838,46 @@ async def command_repeat_current(self, ctx: commands.Context):
         embed = discord.Embed(title=_("Setting Changed"), description=msg)
         await self.send_embed_msg(ctx, embed=embed)
 
+    @commands.command(name="keepinqueue")
+    @commands.guild_only()
+    @commands.bot_has_permissions(embed_links=True)
+    async def command_keepinqueue(self, ctx: commands.Context):
+        """Toggle keep in queue."""
+        dj_enabled = self._dj_status_cache.setdefault(
+            ctx.guild.id, await self.config.guild(ctx.guild).dj_enabled()
+        )
+        can_skip = await self._can_instaskip(ctx, ctx.author)
+        if dj_enabled and not can_skip and not await self._has_dj_role(ctx, ctx.author):
+            return await self.send_embed_msg(
+                ctx,
+                title=_("Unable To Toggle Keep In Queue"),
+                description=_("You need the DJ role to toggle keep in queue."),
+            )
+        if self._player_check(ctx):
+            await self.set_player_settings(ctx)
+            player = lavalink.get_player(ctx.guild.id)
+            if (
+                not ctx.author.voice or ctx.author.voice.channel != player.channel
+            ) and not can_skip:
+                return await self.send_embed_msg(
+                    ctx,
+                    title=_("Unable To Toggle Keep In Queue"),
+                    description=_("You must be in the voice channel to toggle keep in queue."),
+                )
+            player.store("notify_channel", ctx.channel.id)
+
+        keep_in_queue = await self.config.guild(ctx.guild).keep_in_queue()
+        msg = ""
+        msg += _("Keep tracks in queue: {true_or_false}.").format(
+            true_or_false=_("Enabled") if not keep_in_queue else _("Disabled")
+        )
+        await self.config.guild(ctx.guild).keep_in_queue.set(not keep_in_queue)
+
+        embed = discord.Embed(title=_("Setting Changed"), description=msg)
+        await self.send_embed_msg(ctx, embed=embed)
+        if self._player_check(ctx):
+            await self.set_player_settings(ctx)
+
     @commands.command(name="remove")
     @commands.guild_only()
     @commands.bot_has_permissions(embed_links=True)
@@ -868,6 +916,9 @@ async def command_remove(self, ctx: commands.Context, index_or_url: Union[int, s
                 )
             index_or_url -= 1
             removed = player.queue.pop(index_or_url)
+            if index_or_url < player.next_queue_position:
+                player.next_queue_position -= 1
+
             await self.api_interface.persistent_queue_api.played(
                 ctx.guild.id, removed.extras.get("enqueue_time")
             )
@@ -989,6 +1040,11 @@ async def command_move(self, ctx: commands.Context, from_index: int, to_index: i
         player.store("notify_channel", ctx.channel.id)
         removed = player.queue.pop(from_index - 1)
         player.queue.insert(to_index - 1, removed)
+        original_next = player.next_queue_position
+        if from_index - 1 < original_next:
+            player.next_queue_position -= 1
+        if to_index - 1 < original_next:
+            player.next_queue_position += 1
         description = await self.get_track_description(removed, self.local_folder_current_path)
         await self.send_embed_msg(
             ctx,

redbot/cogs/audio/core/commands/queue.py

@@ -88,6 +88,7 @@ async def _queue_menu(
             shuffle = guild_data["shuffle"]
             repeat = guild_data["repeat"]
             autoplay = guild_data["auto_play"]
+            keep_in_queue = guild_data["keep_in_queue"]
             text = ""
             text += (
                 _("Auto-Play")
@@ -112,6 +113,12 @@ async def _queue_menu(
                 + ": "
                 + ("\N{WHITE HEAVY CHECK MARK}" if player.repeat_current else "\N{CROSS MARK}")
             )
+            text += (
+                (" | " if text else "")
+                + _("Keep in Queue")
+                + ": "
+                + ("\N{WHITE HEAVY CHECK MARK}" if keep_in_queue else "\N{CROSS MARK}")
+            )
             embed.set_footer(text=text)
             message = await self.send_embed_msg(ctx, embed=embed)
             dj_enabled = self._dj_status_cache.setdefault(ctx.guild.id, guild_data["dj_enabled"])

redbot/cogs/audio/core/utilities/miscellaneous.py

@@ -214,9 +214,12 @@ def time_convert(self, length: Union[int, str]) -> int:
 
     async def queue_duration(self, ctx: commands.Context) -> int:
         player = lavalink.get_player(ctx.guild.id)
+        next_index = min(player.next_queue_position, len(player.queue))
         dur = [
             i.length
-            async for i in AsyncIter(player.queue, steps=50).filter(lambda x: not x.is_stream)
+            async for i in AsyncIter(player.queue[next_index:], steps=50).filter(
+                lambda x: not x.is_stream
+            )
         ]
         queue_dur = sum(dur)
         if not player.queue:

redbot/cogs/audio/core/utilities/player.py

@@ -162,7 +162,7 @@ async def _skip_action(self, ctx: commands.Context, skip_to_track: int = None) -
             return
 
         queue_to_append = []
-        if skip_to_track is not None and skip_to_track != 1:
+        if skip_to_track is not None:
             if skip_to_track < 1:
                 await self.send_embed_msg(
                     ctx, title=_("Track number must be equal to or greater than 1.")
@@ -176,15 +176,26 @@ async def _skip_action(self, ctx: commands.Context, skip_to_track: int = None) -
                     ),
                 )
                 return
-            embed = discord.Embed(
-                title=_("{skip_to_track} Tracks Skipped").format(skip_to_track=skip_to_track)
-            )
+            if skip_to_track - 1 >= player.next_queue_position:
+                skipped_count = skip_to_track - player.next_queue_position
+                embed = discord.Embed(
+                    title=_("{skipped_count} Tracks Skipped").format(skipped_count=skipped_count)
+                )
+            else:
+                embed = discord.Embed(
+                    title=_("Skipped to Track {skip_to_track}").format(skip_to_track=skip_to_track)
+                )
             await self.send_embed_msg(ctx, embed=embed)
-            if player.repeat:
-                queue_to_append = player.queue[0 : min(skip_to_track - 1, len(player.queue) - 1)]
-            player.queue = player.queue[
-                min(skip_to_track - 1, len(player.queue) - 1) : len(player.queue)
-            ]
+            if player.keep_in_queue:
+                player.next_queue_position = skip_to_track - 1
+            else:
+                if player.repeat:
+                    queue_to_append = player.queue[
+                        0 : min(skip_to_track - 1, len(player.queue) - 1)
+                    ]
+                player.queue = player.queue[
+                    min(skip_to_track - 1, len(player.queue) - 1) : len(player.queue)
+                ]
         else:
             embed = discord.Embed(
                 title=_("Track Skipped"),
@@ -651,10 +662,12 @@ async def set_player_settings(self, ctx: commands.Context) -> None:
         player = lavalink.get_player(ctx.guild.id)
         shuffle = await self.config.guild(ctx.guild).shuffle()
         repeat = await self.config.guild(ctx.guild).repeat()
+        keep_in_queue = await self.config.guild(ctx.guild).keep_in_queue()
         volume = await self.config.guild(ctx.guild).volume()
         shuffle_bumped = await self.config.guild(ctx.guild).shuffle_bumped()
         player.repeat = repeat
         player.shuffle = shuffle
+        player.keep_in_queue = keep_in_queue
         player.shuffle_bumped = shuffle_bumped
         if player.volume != volume:
             await player.set_volume(volume)

redbot/cogs/audio/core/utilities/queue.py

@@ -32,6 +32,7 @@ async def _build_queue_page(
         shuffle = await self.config.guild(ctx.guild).shuffle()
         repeat = await self.config.guild(ctx.guild).repeat()
         autoplay = await self.config.guild(ctx.guild).auto_play()
+        keep_in_queue = await self.config.guild(ctx.guild).keep_in_queue()
 
         queue_num_pages = math.ceil(len(queue) / 10)
         queue_idx_start = (page_num - 1) * 10
@@ -44,25 +45,26 @@ async def _build_queue_page(
         arrow = await self.draw_time(ctx)
         pos = self.format_time(player.position)
 
-        if player.current.is_stream:
-            dur = "LIVE"
-        else:
-            dur = self.format_time(player.current.length)
+        if player.current:
+            if player.current.is_stream:
+                dur = "LIVE"
+            else:
+                dur = self.format_time(player.current.length)
 
-        query = Query.process_input(player.current, self.local_folder_current_path)
-        current_track_description = await self.get_track_description(
-            player.current, self.local_folder_current_path
-        )
-        if query.is_stream:
-            queue_list += _("**Currently livestreaming:**\n")
-            queue_list += f"{current_track_description}\n"
-            queue_list += _("Requested by: **{user}**").format(user=player.current.requester)
-            queue_list += f"\n\n{arrow}`{pos}`/`{dur}`\n\n"
-        else:
-            queue_list += _("Playing: ")
-            queue_list += f"{current_track_description}\n"
-            queue_list += _("Requested by: **{user}**").format(user=player.current.requester)
-            queue_list += f"\n\n{arrow}`{pos}`/`{dur}`\n\n"
+            query = Query.process_input(player.current, self.local_folder_current_path)
+            current_track_description = await self.get_track_description(
+                player.current, self.local_folder_current_path
+            )
+            if query.is_stream:
+                queue_list += _("**Currently livestreaming:**\n")
+                queue_list += f"{current_track_description}\n"
+                queue_list += _("Requested by: **{user}**").format(user=player.current.requester)
+                queue_list += f"\n\n{arrow}`{pos}`/`{dur}`\n\n"
+            else:
+                queue_list += _("Playing: ")
+                queue_list += f"{current_track_description}\n"
+                queue_list += _("Requested by: **{user}**").format(user=player.current.requester)
+                queue_list += f"\n\n{arrow}`{pos}`/`{dur}`\n\n"
 
         async for i, track in AsyncIter(queue[queue_idx_start:queue_idx_end]).enumerate(
             start=queue_idx_start
@@ -116,6 +118,12 @@ async def _build_queue_page(
             + ": "
             + ("\N{WHITE HEAVY CHECK MARK}" if player.repeat_current else "\N{CROSS MARK}")
         )
+        text += (
+            (" | " if text else "")
+            + _("Keep in Queue")
+            + ": "
+            + ("\N{WHITE HEAVY CHECK MARK}" if keep_in_queue else "\N{CROSS MARK}")
+        )
         embed.set_footer(text=text)
         return embed