|
Packit |
f0b94e |
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
Packit |
f0b94e |
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
Packit |
f0b94e |
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
Packit |
f0b94e |
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
#include "IDecodingTask.h"
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
#include "gfxPrefs.h"
|
|
Packit |
f0b94e |
#include "nsThreadUtils.h"
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
#include "Decoder.h"
|
|
Packit |
f0b94e |
#include "DecodePool.h"
|
|
Packit |
f0b94e |
#include "RasterImage.h"
|
|
Packit |
f0b94e |
#include "SurfaceCache.h"
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
#include "mozilla/SystemGroup.h"
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
namespace mozilla {
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
using gfx::IntRect;
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
namespace image {
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
///////////////////////////////////////////////////////////////////////////////
|
|
Packit |
f0b94e |
// Helpers for sending notifications to the image associated with a decoder.
|
|
Packit |
f0b94e |
///////////////////////////////////////////////////////////////////////////////
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void IDecodingTask::EnsureHasEventTarget(NotNull<RasterImage*> aImage) {
|
|
Packit |
f0b94e |
if (!mEventTarget) {
|
|
Packit |
f0b94e |
// We determine the event target as late as possible, at the first dispatch
|
|
Packit |
f0b94e |
// time, because the observers bound to an imgRequest will affect it.
|
|
Packit |
f0b94e |
// We cache it rather than query for the event target each time because the
|
|
Packit |
f0b94e |
// event target can change. We don't want to risk events being executed in
|
|
Packit |
f0b94e |
// a different order than they are dispatched, which can happen if we
|
|
Packit |
f0b94e |
// selected scheduler groups which have no ordering guarantees relative to
|
|
Packit |
f0b94e |
// each other (e.g. it moves from scheduler group A for doc group DA to
|
|
Packit |
f0b94e |
// scheduler group B for doc group DB due to changing observers -- if we
|
|
Packit |
f0b94e |
// dispatched the first event on A, and the second on B, we don't know which
|
|
Packit |
f0b94e |
// will execute first.)
|
|
Packit |
f0b94e |
RefPtr<ProgressTracker> tracker = aImage->GetProgressTracker();
|
|
Packit |
f0b94e |
if (tracker) {
|
|
Packit |
f0b94e |
mEventTarget = tracker->GetEventTarget();
|
|
Packit |
f0b94e |
} else {
|
|
Packit |
f0b94e |
mEventTarget = SystemGroup::EventTargetFor(TaskCategory::Other);
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
bool IDecodingTask::IsOnEventTarget() const {
|
|
Packit |
f0b94e |
// This is essentially equivalent to NS_IsOnMainThread() because all of the
|
|
Packit |
f0b94e |
// event targets are for the main thread (although perhaps with a different
|
|
Packit |
f0b94e |
// label / scheduler group). The observers in ProgressTracker may have
|
|
Packit |
f0b94e |
// different event targets from this, so this is just a best effort guess.
|
|
Packit |
f0b94e |
bool current = false;
|
|
Packit |
f0b94e |
mEventTarget->IsOnCurrentThread(¤t;;
|
|
Packit |
f0b94e |
return current;
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void IDecodingTask::NotifyProgress(NotNull<RasterImage*> aImage,
|
|
Packit |
f0b94e |
NotNull<Decoder*> aDecoder) {
|
|
Packit |
f0b94e |
MOZ_ASSERT(aDecoder->HasProgress() && !aDecoder->IsMetadataDecode());
|
|
Packit |
f0b94e |
EnsureHasEventTarget(aImage);
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
// Capture the decoder's state. If we need to notify asynchronously, it's
|
|
Packit |
f0b94e |
// important that we don't wait until the lambda actually runs to capture the
|
|
Packit |
f0b94e |
// state that we're going to notify. That would both introduce data races on
|
|
Packit |
f0b94e |
// the decoder's state and cause inconsistencies between the NotifyProgress()
|
|
Packit |
f0b94e |
// calls we make off-main-thread and the notifications that RasterImage
|
|
Packit |
f0b94e |
// actually receives, which would cause bugs.
|
|
Packit |
f0b94e |
Progress progress = aDecoder->TakeProgress();
|
|
Packit |
f0b94e |
IntRect invalidRect = aDecoder->TakeInvalidRect();
|
|
Packit |
f0b94e |
Maybe<uint32_t> frameCount = aDecoder->TakeCompleteFrameCount();
|
|
Packit |
f0b94e |
DecoderFlags decoderFlags = aDecoder->GetDecoderFlags();
|
|
Packit |
f0b94e |
SurfaceFlags surfaceFlags = aDecoder->GetSurfaceFlags();
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
// Synchronously notify if we can.
|
|
Packit |
f0b94e |
if (IsOnEventTarget() && !(decoderFlags & DecoderFlags::ASYNC_NOTIFY)) {
|
|
Packit |
f0b94e |
aImage->NotifyProgress(progress, invalidRect, frameCount, decoderFlags,
|
|
Packit |
f0b94e |
surfaceFlags);
|
|
Packit |
f0b94e |
return;
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
// We're forced to notify asynchronously.
|
|
Packit |
f0b94e |
NotNull<RefPtr<RasterImage>> image = aImage;
|
|
Packit |
f0b94e |
mEventTarget->Dispatch(NS_NewRunnableFunction("IDecodingTask::NotifyProgress",
|
|
Packit |
f0b94e |
[=]() -> void {
|
|
Packit |
f0b94e |
image->NotifyProgress(
|
|
Packit |
f0b94e |
progress, invalidRect,
|
|
Packit |
f0b94e |
frameCount, decoderFlags,
|
|
Packit |
f0b94e |
surfaceFlags);
|
|
Packit |
f0b94e |
}),
|
|
Packit |
f0b94e |
NS_DISPATCH_NORMAL);
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void IDecodingTask::NotifyDecodeComplete(NotNull<RasterImage*> aImage,
|
|
Packit |
f0b94e |
NotNull<Decoder*> aDecoder) {
|
|
Packit |
f0b94e |
MOZ_ASSERT(aDecoder->HasError() || !aDecoder->InFrame(),
|
|
Packit |
f0b94e |
"Decode complete in the middle of a frame?");
|
|
Packit |
f0b94e |
EnsureHasEventTarget(aImage);
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
// Capture the decoder's state.
|
|
Packit |
f0b94e |
DecoderFinalStatus finalStatus = aDecoder->FinalStatus();
|
|
Packit |
f0b94e |
ImageMetadata metadata = aDecoder->GetImageMetadata();
|
|
Packit |
f0b94e |
DecoderTelemetry telemetry = aDecoder->Telemetry();
|
|
Packit |
f0b94e |
Progress progress = aDecoder->TakeProgress();
|
|
Packit |
f0b94e |
IntRect invalidRect = aDecoder->TakeInvalidRect();
|
|
Packit |
f0b94e |
Maybe<uint32_t> frameCount = aDecoder->TakeCompleteFrameCount();
|
|
Packit |
f0b94e |
DecoderFlags decoderFlags = aDecoder->GetDecoderFlags();
|
|
Packit |
f0b94e |
SurfaceFlags surfaceFlags = aDecoder->GetSurfaceFlags();
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
// Synchronously notify if we can.
|
|
Packit |
f0b94e |
if (IsOnEventTarget() && !(decoderFlags & DecoderFlags::ASYNC_NOTIFY)) {
|
|
Packit |
f0b94e |
aImage->NotifyDecodeComplete(finalStatus, metadata, telemetry, progress,
|
|
Packit |
f0b94e |
invalidRect, frameCount, decoderFlags,
|
|
Packit |
f0b94e |
surfaceFlags);
|
|
Packit |
f0b94e |
return;
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
// We're forced to notify asynchronously.
|
|
Packit |
f0b94e |
NotNull<RefPtr<RasterImage>> image = aImage;
|
|
Packit |
f0b94e |
mEventTarget->Dispatch(
|
|
Packit |
f0b94e |
NS_NewRunnableFunction("IDecodingTask::NotifyDecodeComplete",
|
|
Packit |
f0b94e |
[=]() -> void {
|
|
Packit |
f0b94e |
image->NotifyDecodeComplete(
|
|
Packit |
f0b94e |
finalStatus, metadata, telemetry, progress,
|
|
Packit |
f0b94e |
invalidRect, frameCount, decoderFlags,
|
|
Packit |
f0b94e |
surfaceFlags);
|
|
Packit |
f0b94e |
}),
|
|
Packit |
f0b94e |
NS_DISPATCH_NORMAL);
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
///////////////////////////////////////////////////////////////////////////////
|
|
Packit |
f0b94e |
// IDecodingTask implementation.
|
|
Packit |
f0b94e |
///////////////////////////////////////////////////////////////////////////////
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void IDecodingTask::Resume() { DecodePool::Singleton()->AsyncRun(this); }
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
///////////////////////////////////////////////////////////////////////////////
|
|
Packit |
f0b94e |
// MetadataDecodingTask implementation.
|
|
Packit |
f0b94e |
///////////////////////////////////////////////////////////////////////////////
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
MetadataDecodingTask::MetadataDecodingTask(NotNull<Decoder*> aDecoder)
|
|
Packit |
f0b94e |
: mMutex("mozilla::image::MetadataDecodingTask"), mDecoder(aDecoder) {
|
|
Packit |
f0b94e |
MOZ_ASSERT(mDecoder->IsMetadataDecode(),
|
|
Packit |
f0b94e |
"Use DecodingTask for non-metadata decodes");
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void MetadataDecodingTask::Run() {
|
|
Packit |
f0b94e |
MutexAutoLock lock(mMutex);
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
LexerResult result = mDecoder->Decode(WrapNotNull(this));
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
if (result.is<TerminalState>()) {
|
|
Packit |
f0b94e |
NotifyDecodeComplete(mDecoder->GetImage(), mDecoder);
|
|
Packit |
f0b94e |
return; // We're done.
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
if (result == LexerResult(Yield::NEED_MORE_DATA)) {
|
|
Packit |
f0b94e |
// We can't make any more progress right now. We also don't want to report
|
|
Packit |
f0b94e |
// any progress, because it's important that metadata decode results are
|
|
Packit |
f0b94e |
// delivered atomically. The decoder itself will ensure that we get
|
|
Packit |
f0b94e |
// reenqueued when more data is available; just return for now.
|
|
Packit |
f0b94e |
return;
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
MOZ_ASSERT_UNREACHABLE("Metadata decode yielded for an unexpected reason");
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
///////////////////////////////////////////////////////////////////////////////
|
|
Packit |
f0b94e |
// AnonymousDecodingTask implementation.
|
|
Packit |
f0b94e |
///////////////////////////////////////////////////////////////////////////////
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
AnonymousDecodingTask::AnonymousDecodingTask(NotNull<Decoder*> aDecoder)
|
|
Packit |
f0b94e |
: mDecoder(aDecoder) {}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void AnonymousDecodingTask::Run() {
|
|
Packit |
f0b94e |
while (true) {
|
|
Packit |
f0b94e |
LexerResult result = mDecoder->Decode(WrapNotNull(this));
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
if (result.is<TerminalState>()) {
|
|
Packit |
f0b94e |
return; // We're done.
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
if (result == LexerResult(Yield::NEED_MORE_DATA)) {
|
|
Packit |
f0b94e |
// We can't make any more progress right now. Let the caller decide how to
|
|
Packit |
f0b94e |
// handle it.
|
|
Packit |
f0b94e |
return;
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
// Right now we don't do anything special for other kinds of yields, so just
|
|
Packit |
f0b94e |
// keep working.
|
|
Packit |
f0b94e |
MOZ_ASSERT(result.is<Yield>());
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
} // namespace image
|
|
Packit |
f0b94e |
} // namespace mozilla
|