discord:音楽botで再生中にはキューに入れて再生終了後に次の曲を再生させたい

Question

前提

pythonでdiscordの音楽botを作成中です。
youtubeのURLをコマンドとして受付け(入力のイベント)、ダウンロード後に再生するというものです。
現在は再生中ですと、何もせずreturnするようになっております。

実現したいこと

再生中にURLが入力された場合にはそのURLをlistか何かで保存して、
再生終了(再生中ではない場合)時にlist[0]をダウンロードし、list[0]を削除し...とキューの実装をしたいです。

ご質問させていただきたいのは、大掛かりなコードの変更をせずに実装が可能か(現在がキューに対応した作りになってるのか。)
と何を使えばいいのかを教えていただきたいです。

発生している問題・エラーメッセージ

メッセージのイベントとしてURLを受け付けて、ダウンロードし、再生という仕組みに現在なっているので
URLを裏に保存後、再生処理にどうやって入ればよいのかわかりません。

URLコマンド受付
↓
キューに追加
↓
再生中なら待機、再生中でなくなったらキューから取り出す

みたいな実装をしたいです。

該当のソースコード

# インストールした discord.py を読み込む
import asyncio
import discord
# 定数を読み込む
import constant
import os
import random
from urllib.parse import urlparse
from discord.ext import tasks
from datetime import datetime
import youtube_dl

# Suppress noise about console usage from errors
youtube_dl.utils.bug_reports_message = lambda: ''

ytdl_format_options = {
    'format': 'bestaudio/best',
    'outtmpl': '%(extractor)s-%(id)s-%(title)s.%(ext)s',
    'restrictfilenames': True,
    'noplaylist': True,
    'nocheckcertificate': True,
    'ignoreerrors': False,
    'logtostderr': False,
    'quiet': True,
    'no_warnings': True,
    'default_search': 'auto',
    'source_address': '0.0.0.0'  # bind to ipv4 since ipv6 addresses cause issues sometimes
}

ffmpeg_options = {
    'options': '-vn'
}

ytdl = youtube_dl.YoutubeDL(ytdl_format_options)


class YTDLSource(discord.PCMVolumeTransformer):
    def __init__(self, source, *, data, volume=0.5):
        super().__init__(source, volume)

        self.data = data

        self.title = data.get('title')
        self.url = data.get('url')

    @classmethod
    async def from_url(cls, url, *, loop=None, stream=False):
        loop = loop or asyncio.get_event_loop()
        data = await loop.run_in_executor(None, lambda: ytdl.extract_info(url, download=not stream))

        if 'entries' in data:
            # take first item from a playlist
            data = data['entries'][0]

        filename = data['url'] if stream else ytdl.prepare_filename(data)
        return cls(discord.FFmpegPCMAudio(filename, **ffmpeg_options), data=data)


# 自分のBotのアクセストークンに置き換えてください
TOKEN = constant.TOKEN

# 接続に必要なオブジェクトを生成
client = discord.Client()
# メッセージ受信時に動作する処理
@client.event
async def on_message(message):
    if message.content == "!join":
        if message.author.voice is None:
            await message.channel.send("あなたはボイスチャンネルに接続していません。")
            return
        # ボイスチャンネルに接続する
        await message.author.voice.channel.connect()
        await message.channel.send("接続しました。")
    elif message.content.startswith("!play "):
        print("test")
        if message.guild.voice_client is None:
            await message.channel.send("接続していません。")
            return

        # 再生中の場合は再生しない
        if message.guild.voice_client.is_playing():
            await message.channel.send("再生中です。")
            return

        url = message.content[6:]
        # youtubeから音楽をダウンロードする
        # TODO :TypeError: object NoneType can't be used in 'await' expression
        await message.channel.send("DL now")
        player = await YTDLSource.from_url(url, loop=client.loop)

        # 再生する
        await message.guild.voice_client.play(player)

        await message.channel.send('{} を再生します。'.format(player.title))

試したこと

こちらが参考になるかと思いますが、難しくてよくわかりませんでした。
https://sigmoid-poke.hatenablog.com/entry/make_bot_bgm7

asyncio.Queue()でなんとか解決できるのではないかと思い質問させていただきました。

よろしくお願いします。

Answer 1

記載の通りasyncio.Queue() で対応できると思います。
「再生が終わったら、次の曲」という動作は、play 関数 の after 引数に、終わった後に実行する関数を指定することで一応実現できるはずです。

ただし今回は実行対象がコルーチンなので少し工夫が必要です。
（lambda と Eventloop.create_task() を使う。↓の部分です）

    # 再生する
    loop = asyncio.get_event_loop()
    message.guild.voice_client.play(player,
        after=lambda _: loop.create_task(play_song(message))
    )

※なお、自分の環境ではytdlをインストールせずダミーファイルの再生処理で動作するかどうかしか試していません。
したがってytdlに起因するエラーは対処いたしかねます。

---

＜コード＞

※
async def play_song
async def on_message
はこの順番に書かないとエラーになると思います。

# インストールした discord.py を読み込む
import asyncio
略


# 追加：曲URLを含むメッセージ（!play https;//www.~~)を入れるキュー
que = asyncio.Queue() 

# 以降 async def play_song(message): まで変えていません。
# Suppress noise about console usage from errors
youtube_dl.utils.bug_reports_message = lambda: ''
.....
...
略


async def play_song(message):
    # 再生中の場合は再生しない
    if message.guild.voice_client.is_playing():
        await message.channel.send("再生中です。")
        return
    if que.empty():
        return
    # キューから１曲取り出す。
    msg = await que.get()
    url = msg.content[6:]
    
    await message.channel.send("DL now")
    player = await YTDLSource.from_url(url, loop=client.loop)
    # 再生する
    loop = asyncio.get_event_loop()
    message.guild.voice_client.play(player,
        after=lambda _: loop.create_task(play_song(message))
    )
    await message.channel.send('{} を再生します。'.format(player.title))

# メッセージ受信時に動作する処理
@client.event
async def on_message(message):
    if message.content == "!join":
        if message.author.voice is None:
            await message.channel.send("あなたはボイスチャンネルに接続していません。")
            return
        # ボイスチャンネルに接続する
        await message.author.voice.channel.connect()
        await message.channel.send("接続しました。")
    elif message.content.startswith("!play "):
        print("test")
        if message.guild.voice_client is None:
            await message.channel.send("接続していません。")
            return
        # キューに曲を入れる
        await que.put(message)
        await message.channel.send("キューに追加しました")
        await play_song(message)

Comments

[退会済みユーザー]

迅速かつ丁寧な回答有り難うございます。
上記の動作確認ができました。
大変参考、勉強になりました。
ありがとうございました。
非同期処理に関して勉強します...