Files
ladybird/Libraries/LibMedia/PlaybackManager.cpp
Zaggy1024 470248e00d LibMedia+LibWeb: Stop ref counting PlaybackManager
PlaybackManager's ref counting was only used to keep it alive in a few
callbacks. Instead, the callbacks can use weak references that can only
be used from the thread that the PlaybackManager was created on, to
ensure that the PlaybackManager can't be destroyed while being
accessed.

This ensures that:
- The PlaybackManager is destroyed immediately when it is reassigned
  by HTMLMediaElement
- No callbacks are invoked after that point

This fixes the crash initially being addressed by #8081. The test from
that PR has been included as a regression test.
2026-02-23 08:49:13 +00:00

308 lines
11 KiB
C++

/*
* Copyright (c) 2022-2025, Gregory Bertilson <gregory@ladybird.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <LibMedia/Containers/Matroska/MatroskaDemuxer.h>
#include <LibMedia/Demuxer.h>
#include <LibMedia/FFmpeg/FFmpegDemuxer.h>
#include <LibMedia/PlaybackStates/PausedStateHandler.h>
#include <LibMedia/Providers/AudioDataProvider.h>
#include <LibMedia/Providers/GenericTimeProvider.h>
#include <LibMedia/Providers/VideoDataProvider.h>
#include <LibMedia/Providers/WrapperTimeProvider.h>
#include <LibMedia/Sinks/AudioMixingSink.h>
#include <LibMedia/Sinks/DisplayingVideoSink.h>
#include <LibMedia/Track.h>
#include <LibThreading/Thread.h>
#include "PlaybackManager.h"
namespace Media {
DecoderErrorOr<void> PlaybackManager::prepare_playback_from_media_data(WeakPlaybackManager const& self, NonnullRefPtr<IncrementallyPopulatedStream> stream, NonnullRefPtr<Core::WeakEventLoopReference> const& main_thread_event_loop_reference)
{
auto demuxer = TRY([&] -> DecoderErrorOr<NonnullRefPtr<Demuxer>> {
if (Matroska::Reader::is_matroska_or_webm(stream->create_cursor()))
return Matroska::MatroskaDemuxer::from_stream(stream);
return FFmpeg::FFmpegDemuxer::from_stream(stream);
}());
// Create the video tracks and their data providers.
auto all_video_tracks = TRY(demuxer->get_tracks_for_type(TrackType::Video));
auto supported_video_tracks = VideoTracks();
auto supported_video_track_datas = VideoTrackDatas();
supported_video_tracks.ensure_capacity(all_video_tracks.size());
supported_video_track_datas.ensure_capacity(all_video_tracks.size());
for (auto const& track : all_video_tracks) {
auto video_data_provider_result = VideoDataProvider::try_create(main_thread_event_loop_reference, demuxer, track);
if (video_data_provider_result.is_error())
continue;
supported_video_tracks.append(track);
supported_video_track_datas.empend(VideoTrackData(track, video_data_provider_result.release_value(), nullptr));
}
supported_video_tracks.shrink_to_fit();
supported_video_track_datas.shrink_to_fit();
// Create all the audio tracks, their data providers, and the audio output.
auto all_audio_tracks = TRY(demuxer->get_tracks_for_type(TrackType::Audio));
auto supported_audio_tracks = AudioTracks();
auto supported_audio_track_datas = AudioTrackDatas();
supported_audio_tracks.ensure_capacity(all_audio_tracks.size());
supported_audio_track_datas.ensure_capacity(all_audio_tracks.size());
for (auto const& track : all_audio_tracks) {
auto audio_data_provider_result = AudioDataProvider::try_create(main_thread_event_loop_reference, demuxer, track);
if (audio_data_provider_result.is_error())
continue;
auto audio_data_provider = audio_data_provider_result.release_value();
supported_audio_tracks.append(track);
supported_audio_track_datas.empend(AudioTrackData(track, move(audio_data_provider)));
}
supported_audio_tracks.shrink_to_fit();
supported_audio_track_datas.shrink_to_fit();
if (supported_video_tracks.is_empty() && supported_audio_tracks.is_empty())
return DecoderError::with_description(DecoderErrorCategory::NotImplemented, "No supported video or audio tracks found"sv);
auto preferred_video_track = demuxer->get_preferred_track_for_type(TrackType::Video).value_or({});
if (preferred_video_track.has_value() && !supported_video_tracks.contains_slow(*preferred_video_track))
preferred_video_track = {};
auto preferred_audio_track = demuxer->get_preferred_track_for_type(TrackType::Audio).value_or({});
if (preferred_audio_track.has_value() && !supported_audio_tracks.contains_slow(*preferred_audio_track))
preferred_audio_track = {};
auto duration = demuxer->total_duration().value_or(AK::Duration::zero());
auto main_thread_event_loop = main_thread_event_loop_reference->take();
main_thread_event_loop->deferred_invoke([self, video_tracks = move(supported_video_tracks), video_track_datas = move(supported_video_track_datas), preferred_video_track, audio_tracks = move(supported_audio_tracks), audio_track_datas = move(supported_audio_track_datas), preferred_audio_track, duration] mutable {
if (!self)
return;
self->m_video_tracks.extend(move(video_tracks));
self->m_video_track_datas.extend(move(video_track_datas));
self->m_audio_tracks.extend(move(audio_tracks));
self->m_audio_track_datas.extend(move(audio_track_datas));
self->m_preferred_video_track = preferred_video_track;
self->m_preferred_audio_track = preferred_audio_track;
self->check_for_duration_change(duration);
self->set_up_data_providers();
if (!self->m_audio_tracks.is_empty()) {
self->m_audio_sink = MUST(AudioMixingSink::try_create());
}
if (auto audio_sink = self->m_audio_sink) {
VERIFY(self->current_time().is_zero());
self->m_time_provider = make_ref_counted<WrapperTimeProvider<AudioMixingSink>>(*audio_sink);
}
if (self->on_track_added) {
for (auto const& audio_track : self->m_audio_tracks)
self->on_track_added(TrackType::Audio, audio_track);
for (auto const& video_track : self->m_video_tracks)
self->on_track_added(TrackType::Video, video_track);
}
if (self->on_metadata_parsed)
self->on_metadata_parsed();
});
return {};
}
NonnullOwnPtr<PlaybackManager> PlaybackManager::create()
{
auto playback_manager = adopt_own(*new (nothrow) PlaybackManager());
playback_manager->m_handler = make<PausedStateHandler>(*playback_manager, RESUMING_SUSPEND_TIMEOUT_MS);
playback_manager->m_handler->on_enter();
return playback_manager;
}
PlaybackManager::PlaybackManager()
: m_weak_link(make_ref_counted<WeakPlaybackManagerLink>(*this))
, m_time_provider(make_ref_counted<GenericTimeProvider>())
{
}
PlaybackManager::~PlaybackManager()
{
m_weak_link->revoke({});
}
void PlaybackManager::add_media_source(NonnullRefPtr<IncrementallyPopulatedStream> const& stream)
{
auto thread = Threading::Thread::construct("Media Init"sv, [self = weak(), stream = stream, main_thread_event_loop_reference = Core::EventLoop::current_weak()] mutable -> int {
auto maybe_error = prepare_playback_from_media_data(self, stream, main_thread_event_loop_reference);
if (maybe_error.is_error()) {
auto main_thread_event_loop = main_thread_event_loop_reference->take();
main_thread_event_loop->deferred_invoke([self = move(self), error = maybe_error.release_error()] mutable {
if (!self)
return;
if (self->on_unsupported_format_error)
self->on_unsupported_format_error(move(error));
});
return 0;
}
return 0;
});
thread->start();
thread->detach();
}
WeakPlaybackManager PlaybackManager::weak()
{
return WeakPlaybackManager(m_weak_link);
}
void PlaybackManager::set_up_data_providers()
{
for (auto const& video_track_data : m_video_track_datas) {
video_track_data.provider->set_error_handler([self = weak()](DecoderError&& error) {
if (!self)
return;
self->dispatch_error(move(error));
});
video_track_data.provider->set_frame_end_time_handler([self = weak()](AK::Duration time) {
if (!self)
return;
self->check_for_duration_change(time);
});
video_track_data.provider->set_frames_queue_is_full_handler([self = weak()] {
if (!self)
return;
self->m_handler->exit_buffering();
});
}
for (auto const& audio_track_data : m_audio_track_datas) {
audio_track_data.provider->set_error_handler([self = weak()](DecoderError&& error) {
if (!self)
return;
self->dispatch_error(move(error));
});
audio_track_data.provider->set_block_end_time_handler([self = weak()](AK::Duration time) {
if (!self)
return;
self->check_for_duration_change(time);
});
}
}
void PlaybackManager::check_for_duration_change(AK::Duration duration)
{
if (m_duration >= duration)
return;
m_duration = duration;
if (on_duration_change)
on_duration_change(m_duration);
}
void PlaybackManager::dispatch_error(DecoderError&& error)
{
if (m_is_in_error_state)
return;
m_is_in_error_state = true;
if (on_error)
on_error(move(error));
}
PlaybackManager::VideoTrackData& PlaybackManager::get_video_data_for_track(Track const& track)
{
for (auto& track_data : m_video_track_datas) {
if (track_data.track == track)
return track_data;
}
VERIFY_NOT_REACHED();
}
NonnullRefPtr<DisplayingVideoSink> PlaybackManager::get_or_create_the_displaying_video_sink_for_track(Track const& track)
{
auto& track_data = get_video_data_for_track(track);
if (track_data.display == nullptr) {
track_data.display = MUST(Media::DisplayingVideoSink::try_create(m_time_provider));
track_data.display->set_provider(track, track_data.provider);
track_data.display->m_on_start_buffering = [this] {
m_handler->enter_buffering();
};
m_handler->on_track_enabled(track);
}
VERIFY(track_data.display->provider(track) == track_data.provider);
return *track_data.display;
}
void PlaybackManager::remove_the_displaying_video_sink_for_track(Track const& track)
{
auto& track_data = get_video_data_for_track(track);
track_data.display->set_provider(track, nullptr);
track_data.display = nullptr;
}
PlaybackManager::AudioTrackData& PlaybackManager::get_audio_data_for_track(Track const& track)
{
for (auto& track_data : m_audio_track_datas) {
if (track_data.track == track)
return track_data;
}
VERIFY_NOT_REACHED();
}
void PlaybackManager::enable_an_audio_track(Track const& track)
{
auto& track_data = get_audio_data_for_track(track);
auto had_provider = m_audio_sink->provider(track) != nullptr;
m_audio_sink->set_provider(track, track_data.provider);
if (!had_provider) {
m_handler->on_track_enabled(track);
}
}
void PlaybackManager::disable_an_audio_track(Track const& track)
{
auto& track_data = get_audio_data_for_track(track);
VERIFY(track_data.provider == m_audio_sink->provider(track));
m_audio_sink->set_provider(track, nullptr);
}
void PlaybackManager::play()
{
m_handler->play();
}
void PlaybackManager::pause()
{
m_handler->pause();
}
void PlaybackManager::seek(AK::Duration timestamp, SeekMode mode)
{
m_handler->seek(timestamp, mode);
m_is_in_error_state = false;
}
bool PlaybackManager::is_playing()
{
return m_handler->is_playing();
}
PlaybackState PlaybackManager::state()
{
return m_handler->state();
}
void PlaybackManager::set_volume(double volume)
{
if (m_audio_sink)
m_audio_sink->set_volume(volume);
}
}