VoiceClient.play() doesn't pass FFMPEG error to 'after' function.

SpongeManiac commented 5 months ago

Summary

Reproduction Steps

I know from #5131 that the session invalidation error is not a Discord.py error, however, the VoiceClient's play() function does not seem to be capturing and passing the FFMPEG error into my provided after function. I would like to notify when this error happens, so capturing this error would be very helpful. It also appears that Discord.py wrongly states that FFMPEG exited successfully, even when it exits with code 1, which by definition, is not successful.

Here is my current code and log results: Code:

def sync_playback_error(error: Exception = None):
    async def playback_error(error: Exception = None):
        has_error: bool = error != None
        if has_error:
            print('Sending error to chat...')
            await ctx.message.channel.send('A playback error has caused the audio stream to stop.')
        else:
            print('No error in playback!')
    print('Starting async callback...')
    asyncio.run_coroutine_threadsafe(playback_error(error), self.bot.loop)

# Attempt to play ffmpeg source
vc.play(ffmpeg_src, after=sync_playback_error)

Logs:

[tls @ 0x5632a384eb80] Error in the pull function.
[matroska,webm @ 0x5632a384a600] Read error
[tls @ 0x5632a384eb80] The specified session has been invalidated for some reason.
    Last message repeated 1 times
Starting async callback...
DEBUG:asyncio:Using selector: EpollSelector
No error in playback!
2024-06-15 16:58:28 INFO     discord.player ffmpeg process 2801802 successfully terminated with return code of 1.

Minimal Reproducible Code

No response

Expected Results

I expected the FFMPEG error to be passed to the after function

Actual Results

The error was not captured and passed to the after function

Intents

discord.Intents.default()

System Information

Python v3.10.12-final
discord.py v2.3.2-final
aiohttp v3.9.5
system info: Linux 5.15.0-112-generic #122-Ubuntu SMP Thu May 23 07:48:21 UTC 2024

Checklist

[X] I have searched the open issues for duplicates.
[X] I have shown the entire traceback, if possible.
[X] I have removed my token from display, if visible.

Additional Context

No response

SpongeManiac commented 5 months ago

Also, while I'm at it, Is there a way to put an async function in the after parameter, or do I just use the method that I've implemented?

CptDarkrex commented 3 months ago

import discord
import asyncio

# Define the async error handling function
async def playback_error(error: Exception):
    if error:
        print(f'Error in playback: {error}')
        await ctx.message.channel.send(f'A playback error has caused the audio stream to stop: {error}')
    else:
        print('No error in playback!')

# Wrapper to run the async function
def sync_playback_error(error: Exception):
    asyncio.run_coroutine_threadsafe(playback_error(error), bot.loop)

# Attempt to play ffmpeg source
vc.play(ffmpeg_src, after=sync_playback_error)

Explanation:

playback_error Function: This async function logs the error and sends a message to the Discord channel if an error occurs.
sync_playback_error Function: This function wraps the async playback_error function and ensures it runs in the bot's event loop.
vc.play Call: Passes the sync_playback_error function to the after parameter of vc.play, which will be called when playback finishes or if an error occurs.

Rapptz / discord.py