image/VectorImage.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "VectorImage.h"
   7
   8 #include "gfx2DGlue.h"
   9 #include "gfxContext.h"
  10 #include "gfxDrawable.h"
  11 #include "gfxPlatform.h"
  12 #include "gfxUtils.h"
  13 #include "imgFrame.h"
  14 #include "mozilla/AutoRestore.h"
  15 #include "mozilla/MemoryReporting.h"
  16 #include "mozilla/dom/Event.h"
  17 #include "mozilla/dom/SVGSVGElement.h"
  18 #include "mozilla/dom/SVGDocument.h"
  19 #include "mozilla/gfx/2D.h"
  20 #include "mozilla/gfx/gfxVars.h"
  21 #include "mozilla/PendingAnimationTracker.h"
  22 #include "mozilla/PresShell.h"
  23 #include "mozilla/RefPtr.h"
  24 #include "mozilla/Tuple.h"
  25 #include "nsIStreamListener.h"
  26 #include "nsMimeTypes.h"
  27 #include "nsPresContext.h"
  28 #include "nsRect.h"
  29 #include "nsString.h"
  30 #include "nsStubDocumentObserver.h"
  31 #include "SVGObserverUtils.h"  // for SVGRenderingObserver
  32 #include "nsWindowSizes.h"
  33 #include "ImageRegion.h"
  34 #include "ISurfaceProvider.h"
  35 #include "LookupResult.h"
  36 #include "Orientation.h"
  37 #include "SVGDocumentWrapper.h"
  38 #include "SVGDrawingParameters.h"
  39 #include "nsIDOMEventListener.h"
  40 #include "SurfaceCache.h"
  41 #include "mozilla/dom/Document.h"
  42
  43 namespace mozilla {
  44
  45 using namespace dom;
  46 using namespace dom::SVGPreserveAspectRatio_Binding;
  47 using namespace gfx;
  48 using namespace layers;
  49
  50 namespace image {
  51
  52 // Helper-class: SVGRootRenderingObserver
  53 class SVGRootRenderingObserver final : public SVGRenderingObserver {
  54  public:
  55   NS_DECL_ISUPPORTS
  56
  57   SVGRootRenderingObserver(SVGDocumentWrapper* aDocWrapper,
  58                            VectorImage* aVectorImage)
  59       : SVGRenderingObserver(),
  60         mDocWrapper(aDocWrapper),
  61         mVectorImage(aVectorImage),
  62         mHonoringInvalidations(true) {
  63     MOZ_ASSERT(mDocWrapper, "Need a non-null SVG document wrapper");
  64     MOZ_ASSERT(mVectorImage, "Need a non-null VectorImage");
  65
  66     StartObserving();
  67     Element* elem = GetReferencedElementWithoutObserving();
  68     MOZ_ASSERT(elem, "no root SVG node for us to observe");
  69
  70     SVGObserverUtils::AddRenderingObserver(elem, this);
  71     mInObserverSet = true;
  72   }
  73
  74   void ResumeHonoringInvalidations() { mHonoringInvalidations = true; }
  75
  76  protected:
  77   virtual ~SVGRootRenderingObserver() {
  78     // This needs to call our GetReferencedElementWithoutObserving override,
  79     // so must be called here rather than in our base class's dtor.
  80     StopObserving();
  81   }
  82
  83   Element* GetReferencedElementWithoutObserving() final {
  84     return mDocWrapper->GetRootSVGElem();
  85   }
  86
  87   virtual void OnRenderingChange() override {
  88     Element* elem = GetReferencedElementWithoutObserving();
  89     MOZ_ASSERT(elem, "missing root SVG node");
  90
  91     if (mHonoringInvalidations && !mDocWrapper->ShouldIgnoreInvalidation()) {
  92       nsIFrame* frame = elem->GetPrimaryFrame();
  93       if (!frame || frame->PresShell()->IsDestroying()) {
  94         // We're being destroyed. Bail out.
  95         return;
  96       }
  97
  98       // Ignore further invalidations until we draw.
  99       mHonoringInvalidations = false;
 100
 101       mVectorImage->InvalidateObserversOnNextRefreshDriverTick();
 102     }
 103
 104     // Our caller might've removed us from rendering-observer list.
 105     // Add ourselves back!
 106     if (!mInObserverSet) {
 107       SVGObserverUtils::AddRenderingObserver(elem, this);
 108       mInObserverSet = true;
 109     }
 110   }
 111
 112   // Private data
 113   const RefPtr<SVGDocumentWrapper> mDocWrapper;
 114   VectorImage* const mVectorImage;  // Raw pointer because it owns me.
 115   bool mHonoringInvalidations;
 116 };
 117
 118 NS_IMPL_ISUPPORTS(SVGRootRenderingObserver, nsIMutationObserver)
 119
 120 class SVGParseCompleteListener final : public nsStubDocumentObserver {
 121  public:
 122   NS_DECL_ISUPPORTS
 123
 124   SVGParseCompleteListener(SVGDocument* aDocument, VectorImage* aImage)
 125       : mDocument(aDocument), mImage(aImage) {
 126     MOZ_ASSERT(mDocument, "Need an SVG document");
 127     MOZ_ASSERT(mImage, "Need an image");
 128
 129     mDocument->AddObserver(this);
 130   }
 131
 132  private:
 133   ~SVGParseCompleteListener() {
 134     if (mDocument) {
 135       // The document must have been destroyed before we got our event.
 136       // Otherwise this can't happen, since documents hold strong references to
 137       // their observers.
 138       Cancel();
 139     }
 140   }
 141
 142  public:
 143   void EndLoad(Document* aDocument) override {
 144     MOZ_ASSERT(aDocument == mDocument, "Got EndLoad for wrong document?");
 145
 146     // OnSVGDocumentParsed will release our owner's reference to us, so ensure
 147     // we stick around long enough to complete our work.
 148     RefPtr<SVGParseCompleteListener> kungFuDeathGrip(this);
 149
 150     mImage->OnSVGDocumentParsed();
 151   }
 152
 153   void Cancel() {
 154     MOZ_ASSERT(mDocument, "Duplicate call to Cancel");
 155     if (mDocument) {
 156       mDocument->RemoveObserver(this);
 157       mDocument = nullptr;
 158     }
 159   }
 160
 161  private:
 162   RefPtr<SVGDocument> mDocument;
 163   VectorImage* const mImage;  // Raw pointer to owner.
 164 };
 165
 166 NS_IMPL_ISUPPORTS(SVGParseCompleteListener, nsIDocumentObserver)
 167
 168 class SVGLoadEventListener final : public nsIDOMEventListener {
 169  public:
 170   NS_DECL_ISUPPORTS
 171
 172   SVGLoadEventListener(Document* aDocument, VectorImage* aImage)
 173       : mDocument(aDocument), mImage(aImage) {
 174     MOZ_ASSERT(mDocument, "Need an SVG document");
 175     MOZ_ASSERT(mImage, "Need an image");
 176
 177     mDocument->AddEventListener(NS_LITERAL_STRING("MozSVGAsImageDocumentLoad"),
 178                                 this, true, false);
 179     mDocument->AddEventListener(NS_LITERAL_STRING("SVGAbort"), this, true,
 180                                 false);
 181     mDocument->AddEventListener(NS_LITERAL_STRING("SVGError"), this, true,
 182                                 false);
 183   }
 184
 185  private:
 186   ~SVGLoadEventListener() {
 187     if (mDocument) {
 188       // The document must have been destroyed before we got our event.
 189       // Otherwise this can't happen, since documents hold strong references to
 190       // their observers.
 191       Cancel();
 192     }
 193   }
 194
 195  public:
 196   NS_IMETHOD HandleEvent(Event* aEvent) override {
 197     MOZ_ASSERT(mDocument, "Need an SVG document. Received multiple events?");
 198
 199     // OnSVGDocumentLoaded/OnSVGDocumentError will release our owner's reference
 200     // to us, so ensure we stick around long enough to complete our work.
 201     RefPtr<SVGLoadEventListener> kungFuDeathGrip(this);
 202
 203     nsAutoString eventType;
 204     aEvent->GetType(eventType);
 205     MOZ_ASSERT(eventType.EqualsLiteral("MozSVGAsImageDocumentLoad") ||
 206                    eventType.EqualsLiteral("SVGAbort") ||
 207                    eventType.EqualsLiteral("SVGError"),
 208                "Received unexpected event");
 209
 210     if (eventType.EqualsLiteral("MozSVGAsImageDocumentLoad")) {
 211       mImage->OnSVGDocumentLoaded();
 212     } else {
 213       mImage->OnSVGDocumentError();
 214     }
 215
 216     return NS_OK;
 217   }
 218
 219   void Cancel() {
 220     MOZ_ASSERT(mDocument, "Duplicate call to Cancel");
 221     if (mDocument) {
 222       mDocument->RemoveEventListener(
 223           NS_LITERAL_STRING("MozSVGAsImageDocumentLoad"), this, true);
 224       mDocument->RemoveEventListener(NS_LITERAL_STRING("SVGAbort"), this, true);
 225       mDocument->RemoveEventListener(NS_LITERAL_STRING("SVGError"), this, true);
 226       mDocument = nullptr;
 227     }
 228   }
 229
 230  private:
 231   nsCOMPtr<Document> mDocument;
 232   VectorImage* const mImage;  // Raw pointer to owner.
 233 };
 234
 235 NS_IMPL_ISUPPORTS(SVGLoadEventListener, nsIDOMEventListener)
 236
 237 // Helper-class: SVGDrawingCallback
 238 class SVGDrawingCallback : public gfxDrawingCallback {
 239  public:
 240   SVGDrawingCallback(SVGDocumentWrapper* aSVGDocumentWrapper,
 241                      const IntSize& aViewportSize, const IntSize& aSize,
 242                      uint32_t aImageFlags)
 243       : mSVGDocumentWrapper(aSVGDocumentWrapper),
 244         mViewportSize(aViewportSize),
 245         mSize(aSize),
 246         mImageFlags(aImageFlags) {}
 247   virtual bool operator()(gfxContext* aContext, const gfxRect& aFillRect,
 248                           const SamplingFilter aSamplingFilter,
 249                           const gfxMatrix& aTransform) override;
 250
 251  private:
 252   RefPtr<SVGDocumentWrapper> mSVGDocumentWrapper;
 253   const IntSize mViewportSize;
 254   const IntSize mSize;
 255   uint32_t mImageFlags;
 256 };
 257
 258 // Based loosely on nsSVGIntegrationUtils' PaintFrameCallback::operator()
 259 bool SVGDrawingCallback::operator()(gfxContext* aContext,
 260                                     const gfxRect& aFillRect,
 261                                     const SamplingFilter aSamplingFilter,
 262                                     const gfxMatrix& aTransform) {
 263   MOZ_ASSERT(mSVGDocumentWrapper, "need an SVGDocumentWrapper");
 264
 265   // Get (& sanity-check) the helper-doc's presShell
 266   RefPtr<PresShell> presShell = mSVGDocumentWrapper->GetPresShell();
 267   MOZ_ASSERT(presShell, "GetPresShell returned null for an SVG image?");
 268
 269 #ifdef MOZ_GECKO_PROFILER
 270   Document* doc = presShell->GetDocument();
 271   nsIURI* uri = doc ? doc->GetDocumentURI() : nullptr;
 272   AUTO_PROFILER_LABEL_DYNAMIC_NSCSTRING(
 273       "SVG Image drawing", GRAPHICS,
 274       nsPrintfCString("%dx%d %s", mSize.width, mSize.height,
 275                       uri ? uri->GetSpecOrDefault().get() : "N/A"));
 276 #endif
 277
 278   gfxContextAutoSaveRestore contextRestorer(aContext);
 279
 280   // Clip to aFillRect so that we don't paint outside.
 281   aContext->NewPath();
 282   aContext->Rectangle(aFillRect);
 283   aContext->Clip();
 284
 285   gfxMatrix matrix = aTransform;
 286   if (!matrix.Invert()) {
 287     return false;
 288   }
 289   aContext->SetMatrixDouble(
 290       aContext->CurrentMatrixDouble().PreMultiply(matrix).PreScale(
 291           double(mSize.width) / mViewportSize.width,
 292           double(mSize.height) / mViewportSize.height));
 293
 294   nsPresContext* presContext = presShell->GetPresContext();
 295   MOZ_ASSERT(presContext, "pres shell w/out pres context");
 296
 297   nsRect svgRect(0, 0, presContext->DevPixelsToAppUnits(mViewportSize.width),
 298                  presContext->DevPixelsToAppUnits(mViewportSize.height));
 299
 300   RenderDocumentFlags renderDocFlags =
 301       RenderDocumentFlags::IgnoreViewportScrolling;
 302   if (!(mImageFlags & imgIContainer::FLAG_SYNC_DECODE)) {
 303     renderDocFlags |= RenderDocumentFlags::AsyncDecodeImages;
 304   }
 305
 306   presShell->RenderDocument(svgRect, renderDocFlags,
 307                             NS_RGBA(0, 0, 0, 0),  // transparent
 308                             aContext);
 309
 310   return true;
 311 }
 312
 313 class MOZ_STACK_CLASS AutoRestoreSVGState final {
 314  public:
 315   AutoRestoreSVGState(const SVGDrawingParameters& aParams,
 316                       SVGDocumentWrapper* aSVGDocumentWrapper, bool& aIsDrawing,
 317                       bool aContextPaint)
 318       : mIsDrawing(aIsDrawing)
 319         // Apply any 'preserveAspectRatio' override (if specified) to the root
 320         // element:
 321         ,
 322         mPAR(aParams.svgContext, aSVGDocumentWrapper->GetRootSVGElem())
 323         // Set the animation time:
 324         ,
 325         mTime(aSVGDocumentWrapper->GetRootSVGElem(), aParams.animationTime) {
 326     MOZ_ASSERT(!aIsDrawing);
 327     MOZ_ASSERT(aSVGDocumentWrapper->GetDocument());
 328
 329     aIsDrawing = true;
 330
 331     // Set context paint (if specified) on the document:
 332     if (aContextPaint) {
 333       MOZ_ASSERT(aParams.svgContext->GetContextPaint());
 334       mContextPaint.emplace(*aParams.svgContext->GetContextPaint(),
 335                             *aSVGDocumentWrapper->GetDocument());
 336     }
 337   }
 338
 339  private:
 340   AutoRestore<bool> mIsDrawing;
 341   AutoPreserveAspectRatioOverride mPAR;
 342   AutoSVGTimeSetRestore mTime;
 343   Maybe<AutoSetRestoreSVGContextPaint> mContextPaint;
 344 };
 345
 346 // Implement VectorImage's nsISupports-inherited methods
 347 NS_IMPL_ISUPPORTS(VectorImage, imgIContainer, nsIStreamListener,
 348                   nsIRequestObserver)
 349
 350 //------------------------------------------------------------------------------
 351 // Constructor / Destructor
 352
 353 VectorImage::VectorImage(nsIURI* aURI /* = nullptr */)
 354     : ImageResource(aURI),  // invoke superclass's constructor
 355       mLockCount(0),
 356       mIsInitialized(false),
 357       mDiscardable(false),
 358       mIsFullyLoaded(false),
 359       mIsDrawing(false),
 360       mHaveAnimations(false),
 361       mHasPendingInvalidation(false) {}
 362
 363 VectorImage::~VectorImage() {
 364   CancelAllListeners();
 365   SurfaceCache::RemoveImage(ImageKey(this));
 366 }
 367
 368 //------------------------------------------------------------------------------
 369 // Methods inherited from Image.h
 370
 371 nsresult VectorImage::Init(const char* aMimeType, uint32_t aFlags) {
 372   // We don't support re-initialization
 373   if (mIsInitialized) {
 374     return NS_ERROR_ILLEGAL_VALUE;
 375   }
 376
 377   MOZ_ASSERT(!mIsFullyLoaded && !mHaveAnimations && !mError,
 378              "Flags unexpectedly set before initialization");
 379   MOZ_ASSERT(!strcmp(aMimeType, IMAGE_SVG_XML), "Unexpected mimetype");
 380
 381   mDiscardable = !!(aFlags & INIT_FLAG_DISCARDABLE);
 382
 383   // Lock this image's surfaces in the SurfaceCache if we're not discardable.
 384   if (!mDiscardable) {
 385     mLockCount++;
 386     SurfaceCache::LockImage(ImageKey(this));
 387   }
 388
 389   mIsInitialized = true;
 390   return NS_OK;
 391 }
 392
 393 size_t VectorImage::SizeOfSourceWithComputedFallback(
 394     SizeOfState& aState) const {
 395   if (!mSVGDocumentWrapper) {
 396     return 0;  // No document, so no memory used for the document.
 397   }
 398
 399   SVGDocument* doc = mSVGDocumentWrapper->GetDocument();
 400   if (!doc) {
 401     return 0;  // No document, so no memory used for the document.
 402   }
 403
 404   nsWindowSizes windowSizes(aState);
 405   doc->DocAddSizeOfIncludingThis(windowSizes);
 406
 407   if (windowSizes.getTotalSize() == 0) {
 408     // MallocSizeOf fails on this platform. Because we also use this method for
 409     // determining the size of cache entries, we need to return something
 410     // reasonable here. Unfortunately, there's no way to estimate the document's
 411     // size accurately, so we just use a constant value of 100KB, which will
 412     // generally underestimate the true size.
 413     return 100 * 1024;
 414   }
 415
 416   return windowSizes.getTotalSize();
 417 }
 418
 419 void VectorImage::CollectSizeOfSurfaces(
 420     nsTArray<SurfaceMemoryCounter>& aCounters,
 421     MallocSizeOf aMallocSizeOf) const {
 422   SurfaceCache::CollectSizeOfSurfaces(ImageKey(this), aCounters, aMallocSizeOf);
 423 }
 424
 425 nsresult VectorImage::OnImageDataComplete(nsIRequest* aRequest,
 426                                           nsISupports* aContext,
 427                                           nsresult aStatus, bool aLastPart) {
 428   // Call our internal OnStopRequest method, which only talks to our embedded
 429   // SVG document. This won't have any effect on our ProgressTracker.
 430   nsresult finalStatus = OnStopRequest(aRequest, aStatus);
 431
 432   // Give precedence to Necko failure codes.
 433   if (NS_FAILED(aStatus)) {
 434     finalStatus = aStatus;
 435   }
 436
 437   Progress loadProgress = LoadCompleteProgress(aLastPart, mError, finalStatus);
 438
 439   if (mIsFullyLoaded || mError) {
 440     // Our document is loaded, so we're ready to notify now.
 441     mProgressTracker->SyncNotifyProgress(loadProgress);
 442   } else {
 443     // Record our progress so far; we'll actually send the notifications in
 444     // OnSVGDocumentLoaded or OnSVGDocumentError.
 445     mLoadProgress = Some(loadProgress);
 446   }
 447
 448   return finalStatus;
 449 }
 450
 451 nsresult VectorImage::OnImageDataAvailable(nsIRequest* aRequest,
 452                                            nsISupports* aContext,
 453                                            nsIInputStream* aInStr,
 454                                            uint64_t aSourceOffset,
 455                                            uint32_t aCount) {
 456   return OnDataAvailable(aRequest, aInStr, aSourceOffset, aCount);
 457 }
 458
 459 nsresult VectorImage::StartAnimation() {
 460   if (mError) {
 461     return NS_ERROR_FAILURE;
 462   }
 463
 464   MOZ_ASSERT(ShouldAnimate(), "Should not animate!");
 465
 466   mSVGDocumentWrapper->StartAnimation();
 467   return NS_OK;
 468 }
 469
 470 nsresult VectorImage::StopAnimation() {
 471   nsresult rv = NS_OK;
 472   if (mError) {
 473     rv = NS_ERROR_FAILURE;
 474   } else {
 475     MOZ_ASSERT(mIsFullyLoaded && mHaveAnimations,
 476                "Should not have been animating!");
 477
 478     mSVGDocumentWrapper->StopAnimation();
 479   }
 480
 481   mAnimating = false;
 482   return rv;
 483 }
 484
 485 bool VectorImage::ShouldAnimate() {
 486   return ImageResource::ShouldAnimate() && mIsFullyLoaded && mHaveAnimations;
 487 }
 488
 489 NS_IMETHODIMP_(void)
 490 VectorImage::SetAnimationStartTime(const TimeStamp& aTime) {
 491   // We don't care about animation start time.
 492 }
 493
 494 //------------------------------------------------------------------------------
 495 // imgIContainer methods
 496
 497 //******************************************************************************
 498 NS_IMETHODIMP
 499 VectorImage::GetWidth(int32_t* aWidth) {
 500   if (mError || !mIsFullyLoaded) {
 501     // XXXdholbert Technically we should leave outparam untouched when we
 502     // fail. But since many callers don't check for failure, we set it to 0 on
 503     // failure, for sane/predictable results.
 504     *aWidth = 0;
 505     return NS_ERROR_FAILURE;
 506   }
 507
 508   SVGSVGElement* rootElem = mSVGDocumentWrapper->GetRootSVGElem();
 509   MOZ_ASSERT(rootElem,
 510              "Should have a root SVG elem, since we finished "
 511              "loading without errors");
 512   int32_t rootElemWidth = rootElem->GetIntrinsicWidth();
 513   if (rootElemWidth < 0) {
 514     *aWidth = 0;
 515     return NS_ERROR_FAILURE;
 516   }
 517   *aWidth = rootElemWidth;
 518   return NS_OK;
 519 }
 520
 521 //******************************************************************************
 522 nsresult VectorImage::GetNativeSizes(nsTArray<IntSize>& aNativeSizes) const {
 523   return NS_ERROR_NOT_IMPLEMENTED;
 524 }
 525
 526 //******************************************************************************
 527 size_t VectorImage::GetNativeSizesLength() const { return 0; }
 528
 529 //******************************************************************************
 530 NS_IMETHODIMP_(void)
 531 VectorImage::RequestRefresh(const TimeStamp& aTime) {
 532   if (HadRecentRefresh(aTime)) {
 533     return;
 534   }
 535
 536   PendingAnimationTracker* tracker =
 537       mSVGDocumentWrapper->GetDocument()->GetPendingAnimationTracker();
 538   if (tracker && ShouldAnimate()) {
 539     tracker->TriggerPendingAnimationsOnNextTick(aTime);
 540   }
 541
 542   EvaluateAnimation();
 543
 544   mSVGDocumentWrapper->TickRefreshDriver();
 545
 546   if (mHasPendingInvalidation) {
 547     SendInvalidationNotifications();
 548   }
 549 }
 550
 551 void VectorImage::SendInvalidationNotifications() {
 552   // Animated images don't send out invalidation notifications as soon as
 553   // they're generated. Instead, InvalidateObserversOnNextRefreshDriverTick
 554   // records that there are pending invalidations and then returns immediately.
 555   // The notifications are actually sent from RequestRefresh(). We send these
 556   // notifications there to ensure that there is actually a document observing
 557   // us. Otherwise, the notifications are just wasted effort.
 558   //
 559   // Non-animated images post an event to call this method from
 560   // InvalidateObserversOnNextRefreshDriverTick, because RequestRefresh is never
 561   // called for them. Ordinarily this isn't needed, since we send out
 562   // invalidation notifications in OnSVGDocumentLoaded, but in rare cases the
 563   // SVG document may not be 100% ready to render at that time. In those cases
 564   // we would miss the subsequent invalidations if we didn't send out the
 565   // notifications indirectly in |InvalidateObservers...|.
 566
 567   MOZ_ASSERT(mHasPendingInvalidation);
 568   mHasPendingInvalidation = false;
 569   SurfaceCache::RemoveImage(ImageKey(this));
 570
 571   if (UpdateImageContainer(Nothing())) {
 572     // If we have image containers, that means we probably won't get a Draw call
 573     // from the owner since they are using the container. We must assume all
 574     // invalidations need to be handled.
 575     MOZ_ASSERT(mRenderingObserver, "Should have a rendering observer by now");
 576     mRenderingObserver->ResumeHonoringInvalidations();
 577   }
 578
 579   if (mProgressTracker) {
 580     mProgressTracker->SyncNotifyProgress(FLAG_FRAME_COMPLETE,
 581                                          GetMaxSizedIntRect());
 582   }
 583 }
 584
 585 NS_IMETHODIMP_(IntRect)
 586 VectorImage::GetImageSpaceInvalidationRect(const IntRect& aRect) {
 587   return aRect;
 588 }
 589
 590 //******************************************************************************
 591 NS_IMETHODIMP
 592 VectorImage::GetHeight(int32_t* aHeight) {
 593   if (mError || !mIsFullyLoaded) {
 594     // XXXdholbert Technically we should leave outparam untouched when we
 595     // fail. But since many callers don't check for failure, we set it to 0 on
 596     // failure, for sane/predictable results.
 597     *aHeight = 0;
 598     return NS_ERROR_FAILURE;
 599   }
 600
 601   SVGSVGElement* rootElem = mSVGDocumentWrapper->GetRootSVGElem();
 602   MOZ_ASSERT(rootElem,
 603              "Should have a root SVG elem, since we finished "
 604              "loading without errors");
 605   int32_t rootElemHeight = rootElem->GetIntrinsicHeight();
 606   if (rootElemHeight < 0) {
 607     *aHeight = 0;
 608     return NS_ERROR_FAILURE;
 609   }
 610   *aHeight = rootElemHeight;
 611   return NS_OK;
 612 }
 613
 614 //******************************************************************************
 615 NS_IMETHODIMP
 616 VectorImage::GetIntrinsicSize(nsSize* aSize) {
 617   if (mError || !mIsFullyLoaded) {
 618     return NS_ERROR_FAILURE;
 619   }
 620
 621   nsIFrame* rootFrame = mSVGDocumentWrapper->GetRootLayoutFrame();
 622   if (!rootFrame) {
 623     return NS_ERROR_FAILURE;
 624   }
 625
 626   *aSize = nsSize(-1, -1);
 627   IntrinsicSize rfSize = rootFrame->GetIntrinsicSize();
 628   if (rfSize.width) {
 629     aSize->width = *rfSize.width;
 630   }
 631   if (rfSize.height) {
 632     aSize->height = *rfSize.height;
 633   }
 634   return NS_OK;
 635 }
 636
 637 //******************************************************************************
 638 Maybe<AspectRatio> VectorImage::GetIntrinsicRatio() {
 639   if (mError || !mIsFullyLoaded) {
 640     return Nothing();
 641   }
 642
 643   nsIFrame* rootFrame = mSVGDocumentWrapper->GetRootLayoutFrame();
 644   if (!rootFrame) {
 645     return Nothing();
 646   }
 647
 648   return Some(rootFrame->GetIntrinsicRatio());
 649 }
 650
 651 NS_IMETHODIMP_(Orientation)
 652 VectorImage::GetOrientation() { return Orientation(); }
 653
 654 //******************************************************************************
 655 NS_IMETHODIMP
 656 VectorImage::GetType(uint16_t* aType) {
 657   NS_ENSURE_ARG_POINTER(aType);
 658
 659   *aType = imgIContainer::TYPE_VECTOR;
 660   return NS_OK;
 661 }
 662
 663 //******************************************************************************
 664 NS_IMETHODIMP
 665 VectorImage::GetProducerId(uint32_t* aId) {
 666   NS_ENSURE_ARG_POINTER(aId);
 667
 668   *aId = ImageResource::GetImageProducerId();
 669   return NS_OK;
 670 }
 671
 672 //******************************************************************************
 673 NS_IMETHODIMP
 674 VectorImage::GetAnimated(bool* aAnimated) {
 675   if (mError || !mIsFullyLoaded) {
 676     return NS_ERROR_FAILURE;
 677   }
 678
 679   *aAnimated = mSVGDocumentWrapper->IsAnimated();
 680   return NS_OK;
 681 }
 682
 683 //******************************************************************************
 684 int32_t VectorImage::GetFirstFrameDelay() {
 685   if (mError) {
 686     return -1;
 687   }
 688
 689   if (!mSVGDocumentWrapper->IsAnimated()) {
 690     return -1;
 691   }
 692
 693   // We don't really have a frame delay, so just pretend that we constantly
 694   // need updates.
 695   return 0;
 696 }
 697
 698 NS_IMETHODIMP_(bool)
 699 VectorImage::WillDrawOpaqueNow() {
 700   return false;  // In general, SVG content is not opaque.
 701 }
 702
 703 //******************************************************************************
 704 NS_IMETHODIMP_(already_AddRefed<SourceSurface>)
 705 VectorImage::GetFrame(uint32_t aWhichFrame, uint32_t aFlags) {
 706   if (mError) {
 707     return nullptr;
 708   }
 709
 710   // Look up height & width
 711   // ----------------------
 712   SVGSVGElement* svgElem = mSVGDocumentWrapper->GetRootSVGElem();
 713   MOZ_ASSERT(svgElem,
 714              "Should have a root SVG elem, since we finished "
 715              "loading without errors");
 716   nsIntSize imageIntSize(svgElem->GetIntrinsicWidth(),
 717                          svgElem->GetIntrinsicHeight());
 718
 719   if (imageIntSize.IsEmpty()) {
 720     // We'll get here if our SVG doc has a percent-valued or negative width or
 721     // height.
 722     return nullptr;
 723   }
 724
 725   return GetFrameAtSize(imageIntSize, aWhichFrame, aFlags);
 726 }
 727
 728 NS_IMETHODIMP_(already_AddRefed<SourceSurface>)
 729 VectorImage::GetFrameAtSize(const IntSize& aSize, uint32_t aWhichFrame,
 730                             uint32_t aFlags) {
 731 #ifdef DEBUG
 732   NotifyDrawingObservers();
 733 #endif
 734
 735   auto result = GetFrameInternal(aSize, Nothing(), aWhichFrame, aFlags);
 736   return Get<2>(result).forget();
 737 }
 738
 739 Tuple<ImgDrawResult, IntSize, RefPtr<SourceSurface>>
 740 VectorImage::GetFrameInternal(const IntSize& aSize,
 741                               const Maybe<SVGImageContext>& aSVGContext,
 742                               uint32_t aWhichFrame, uint32_t aFlags) {
 743   MOZ_ASSERT(aWhichFrame <= FRAME_MAX_VALUE);
 744
 745   if (aSize.IsEmpty() || aWhichFrame > FRAME_MAX_VALUE) {
 746     return MakeTuple(ImgDrawResult::BAD_ARGS, aSize, RefPtr<SourceSurface>());
 747   }
 748
 749   if (mError) {
 750     return MakeTuple(ImgDrawResult::BAD_IMAGE, aSize, RefPtr<SourceSurface>());
 751   }
 752
 753   if (!mIsFullyLoaded) {
 754     return MakeTuple(ImgDrawResult::NOT_READY, aSize, RefPtr<SourceSurface>());
 755   }
 756
 757   RefPtr<SourceSurface> sourceSurface;
 758   IntSize decodeSize;
 759   Tie(sourceSurface, decodeSize) =
 760       LookupCachedSurface(aSize, aSVGContext, aFlags);
 761   if (sourceSurface) {
 762     return MakeTuple(ImgDrawResult::SUCCESS, decodeSize,
 763                      std::move(sourceSurface));
 764   }
 765
 766   if (mIsDrawing) {
 767     NS_WARNING("Refusing to make re-entrant call to VectorImage::Draw");
 768     return MakeTuple(ImgDrawResult::TEMPORARY_ERROR, decodeSize,
 769                      RefPtr<SourceSurface>());
 770   }
 771
 772   // By using a null gfxContext, we ensure that we will always attempt to
 773   // create a surface, even if we aren't capable of caching it (e.g. due to our
 774   // flags, having an animation, etc). Otherwise CreateSurface will assume that
 775   // the caller is capable of drawing directly to its own draw target if we
 776   // cannot cache.
 777   SVGDrawingParameters params(
 778       nullptr, decodeSize, aSize, ImageRegion::Create(decodeSize),
 779       SamplingFilter::POINT, aSVGContext,
 780       mSVGDocumentWrapper->GetCurrentTimeAsFloat(), aFlags, 1.0);
 781
 782   bool didCache;  // Was the surface put into the cache?
 783   bool contextPaint = aSVGContext && aSVGContext->GetContextPaint();
 784
 785   AutoRestoreSVGState autoRestore(params, mSVGDocumentWrapper, mIsDrawing,
 786                                   contextPaint);
 787
 788   RefPtr<gfxDrawable> svgDrawable = CreateSVGDrawable(params);
 789   RefPtr<SourceSurface> surface = CreateSurface(params, svgDrawable, didCache);
 790   if (!surface) {
 791     MOZ_ASSERT(!didCache);
 792     return MakeTuple(ImgDrawResult::TEMPORARY_ERROR, decodeSize,
 793                      RefPtr<SourceSurface>());
 794   }
 795
 796   SendFrameComplete(didCache, params.flags);
 797   return MakeTuple(ImgDrawResult::SUCCESS, decodeSize, std::move(surface));
 798 }
 799
 800 //******************************************************************************
 801 Tuple<ImgDrawResult, IntSize> VectorImage::GetImageContainerSize(
 802     LayerManager* aManager, const IntSize& aSize, uint32_t aFlags) {
 803   if (mError) {
 804     return MakeTuple(ImgDrawResult::BAD_IMAGE, IntSize(0, 0));
 805   }
 806
 807   if (!mIsFullyLoaded) {
 808     return MakeTuple(ImgDrawResult::NOT_READY, IntSize(0, 0));
 809   }
 810
 811   if (mHaveAnimations ||
 812       aManager->GetBackendType() != LayersBackend::LAYERS_WR) {
 813     return MakeTuple(ImgDrawResult::NOT_SUPPORTED, IntSize(0, 0));
 814   }
 815
 816   // We don't need to check if the size is too big since we only support
 817   // WebRender backends.
 818   if (aSize.IsEmpty()) {
 819     return MakeTuple(ImgDrawResult::BAD_ARGS, IntSize(0, 0));
 820   }
 821
 822   return MakeTuple(ImgDrawResult::SUCCESS, aSize);
 823 }
 824
 825 NS_IMETHODIMP_(bool)
 826 VectorImage::IsImageContainerAvailable(LayerManager* aManager,
 827                                        uint32_t aFlags) {
 828   if (mError || !mIsFullyLoaded || mHaveAnimations ||
 829       aManager->GetBackendType() != LayersBackend::LAYERS_WR) {
 830     return false;
 831   }
 832
 833   return true;
 834 }
 835
 836 //******************************************************************************
 837 NS_IMETHODIMP_(already_AddRefed<ImageContainer>)
 838 VectorImage::GetImageContainer(LayerManager* aManager, uint32_t aFlags) {
 839   MOZ_ASSERT(aManager->GetBackendType() != LayersBackend::LAYERS_WR,
 840              "WebRender should always use GetImageContainerAvailableAtSize!");
 841   return nullptr;
 842 }
 843
 844 //******************************************************************************
 845 NS_IMETHODIMP_(bool)
 846 VectorImage::IsImageContainerAvailableAtSize(LayerManager* aManager,
 847                                              const IntSize& aSize,
 848                                              uint32_t aFlags) {
 849   // Since we only support image containers with WebRender, and it can handle
 850   // textures larger than the hw max texture size, we don't need to check aSize.
 851   return !aSize.IsEmpty() && IsImageContainerAvailable(aManager, aFlags);
 852 }
 853
 854 //******************************************************************************
 855 NS_IMETHODIMP_(ImgDrawResult)
 856 VectorImage::GetImageContainerAtSize(layers::LayerManager* aManager,
 857                                      const gfx::IntSize& aSize,
 858                                      const Maybe<SVGImageContext>& aSVGContext,
 859                                      uint32_t aFlags,
 860                                      layers::ImageContainer** aOutContainer) {
 861   Maybe<SVGImageContext> newSVGContext;
 862   MaybeRestrictSVGContext(newSVGContext, aSVGContext, aFlags);
 863
 864   // The aspect ratio flag was already handled as part of the SVG context
 865   // restriction above.
 866   uint32_t flags = aFlags & ~(FLAG_FORCE_PRESERVEASPECTRATIO_NONE);
 867   return GetImageContainerImpl(aManager, aSize,
 868                                newSVGContext ? newSVGContext : aSVGContext,
 869                                flags, aOutContainer);
 870 }
 871
 872 bool VectorImage::MaybeRestrictSVGContext(
 873     Maybe<SVGImageContext>& aNewSVGContext,
 874     const Maybe<SVGImageContext>& aSVGContext, uint32_t aFlags) {
 875   bool overridePAR =
 876       (aFlags & FLAG_FORCE_PRESERVEASPECTRATIO_NONE) && aSVGContext;
 877
 878   bool haveContextPaint = aSVGContext && aSVGContext->GetContextPaint();
 879   bool blockContextPaint = false;
 880   if (haveContextPaint) {
 881     blockContextPaint = !SVGContextPaint::IsAllowedForImageFromURI(mURI);
 882   }
 883
 884   if (overridePAR || blockContextPaint) {
 885     // The key that we create for the image surface cache must match the way
 886     // that the image will be painted, so we need to initialize a new matching
 887     // SVGImageContext here in order to generate the correct key.
 888
 889     aNewSVGContext = aSVGContext;  // copy
 890
 891     if (overridePAR) {
 892       // The SVGImageContext must take account of the preserveAspectRatio
 893       // overide:
 894       MOZ_ASSERT(!aSVGContext->GetPreserveAspectRatio(),
 895                  "FLAG_FORCE_PRESERVEASPECTRATIO_NONE is not expected if a "
 896                  "preserveAspectRatio override is supplied");
 897       Maybe<SVGPreserveAspectRatio> aspectRatio = Some(SVGPreserveAspectRatio(
 898           SVG_PRESERVEASPECTRATIO_NONE, SVG_MEETORSLICE_UNKNOWN));
 899       aNewSVGContext->SetPreserveAspectRatio(aspectRatio);
 900     }
 901
 902     if (blockContextPaint) {
 903       // The SVGImageContext must not include context paint if the image is
 904       // not allowed to use it:
 905       aNewSVGContext->ClearContextPaint();
 906     }
 907   }
 908
 909   return haveContextPaint && !blockContextPaint;
 910 }
 911
 912 //******************************************************************************
 913 NS_IMETHODIMP_(ImgDrawResult)
 914 VectorImage::Draw(gfxContext* aContext, const nsIntSize& aSize,
 915                   const ImageRegion& aRegion, uint32_t aWhichFrame,
 916                   SamplingFilter aSamplingFilter,
 917                   const Maybe<SVGImageContext>& aSVGContext, uint32_t aFlags,
 918                   float aOpacity) {
 919   if (aWhichFrame > FRAME_MAX_VALUE) {
 920     return ImgDrawResult::BAD_ARGS;
 921   }
 922
 923   if (!aContext) {
 924     return ImgDrawResult::BAD_ARGS;
 925   }
 926
 927   if (mError) {
 928     return ImgDrawResult::BAD_IMAGE;
 929   }
 930
 931   if (!mIsFullyLoaded) {
 932     return ImgDrawResult::NOT_READY;
 933   }
 934
 935   if (mAnimationConsumers == 0) {
 936     SendOnUnlockedDraw(aFlags);
 937   }
 938
 939   // We should bypass the cache when:
 940   // - We are using a DrawTargetRecording because we prefer the drawing commands
 941   //   in general to the rasterized surface. This allows blob images to avoid
 942   //   rasterized SVGs with WebRender.
 943   // - The size exceeds what we are willing to cache as a rasterized surface.
 944   //   We don't do this for WebRender because the performance of the fallback
 945   //   path is quite bad and upscaling the SVG from the clamped size is better
 946   //   than bringing the browser to a crawl.
 947   if (aContext->GetDrawTarget()->GetBackendType() == BackendType::RECORDING ||
 948       (!gfxVars::UseWebRender() &&
 949        aSize != SurfaceCache::ClampVectorSize(aSize))) {
 950     aFlags |= FLAG_BYPASS_SURFACE_CACHE;
 951   }
 952
 953   MOZ_ASSERT(!(aFlags & FLAG_FORCE_PRESERVEASPECTRATIO_NONE) ||
 954                  (aSVGContext && aSVGContext->GetViewportSize()),
 955              "Viewport size is required when using "
 956              "FLAG_FORCE_PRESERVEASPECTRATIO_NONE");
 957
 958   float animTime = (aWhichFrame == FRAME_FIRST)
 959                        ? 0.0f
 960                        : mSVGDocumentWrapper->GetCurrentTimeAsFloat();
 961
 962   Maybe<SVGImageContext> newSVGContext;
 963   bool contextPaint =
 964       MaybeRestrictSVGContext(newSVGContext, aSVGContext, aFlags);
 965
 966   SVGDrawingParameters params(aContext, aSize, aSize, aRegion, aSamplingFilter,
 967                               newSVGContext ? newSVGContext : aSVGContext,
 968                               animTime, aFlags, aOpacity);
 969
 970   // If we have an prerasterized version of this image that matches the
 971   // drawing parameters, use that.
 972   RefPtr<SourceSurface> sourceSurface;
 973   Tie(sourceSurface, params.size) =
 974       LookupCachedSurface(aSize, params.svgContext, aFlags);
 975   if (sourceSurface) {
 976     RefPtr<gfxDrawable> drawable =
 977         new gfxSurfaceDrawable(sourceSurface, params.size);
 978     Show(drawable, params);
 979     return ImgDrawResult::SUCCESS;
 980   }
 981
 982   // else, we need to paint the image:
 983
 984   if (mIsDrawing) {
 985     NS_WARNING("Refusing to make re-entrant call to VectorImage::Draw");
 986     return ImgDrawResult::TEMPORARY_ERROR;
 987   }
 988
 989   AutoRestoreSVGState autoRestore(params, mSVGDocumentWrapper, mIsDrawing,
 990                                   contextPaint);
 991
 992   bool didCache;  // Was the surface put into the cache?
 993   RefPtr<gfxDrawable> svgDrawable = CreateSVGDrawable(params);
 994   sourceSurface = CreateSurface(params, svgDrawable, didCache);
 995   if (!sourceSurface) {
 996     MOZ_ASSERT(!didCache);
 997     Show(svgDrawable, params);
 998     return ImgDrawResult::SUCCESS;
 999   }
1000
1001   RefPtr<gfxDrawable> drawable =
1002       new gfxSurfaceDrawable(sourceSurface, params.size);
1003   Show(drawable, params);
1004   SendFrameComplete(didCache, params.flags);
1005   return ImgDrawResult::SUCCESS;
1006 }
1007
1008 already_AddRefed<gfxDrawable> VectorImage::CreateSVGDrawable(
1009     const SVGDrawingParameters& aParams) {
1010   RefPtr<gfxDrawingCallback> cb = new SVGDrawingCallback(
1011       mSVGDocumentWrapper, aParams.viewportSize, aParams.size, aParams.flags);
1012
1013   RefPtr<gfxDrawable> svgDrawable = new gfxCallbackDrawable(cb, aParams.size);
1014   return svgDrawable.forget();
1015 }
1016
1017 Tuple<RefPtr<SourceSurface>, IntSize> VectorImage::LookupCachedSurface(
1018     const IntSize& aSize, const Maybe<SVGImageContext>& aSVGContext,
1019     uint32_t aFlags) {
1020   // If we're not allowed to use a cached surface, don't attempt a lookup.
1021   if (aFlags & FLAG_BYPASS_SURFACE_CACHE) {
1022     return MakeTuple(RefPtr<SourceSurface>(), aSize);
1023   }
1024
1025   // We don't do any caching if we have animation, so don't bother with a lookup
1026   // in this case either.
1027   if (mHaveAnimations) {
1028     return MakeTuple(RefPtr<SourceSurface>(), aSize);
1029   }
1030
1031   LookupResult result(MatchType::NOT_FOUND);
1032   SurfaceKey surfaceKey = VectorSurfaceKey(aSize, aSVGContext);
1033   if ((aFlags & FLAG_SYNC_DECODE) || !(aFlags & FLAG_HIGH_QUALITY_SCALING)) {
1034     result = SurfaceCache::Lookup(ImageKey(this), surfaceKey,
1035                                   /* aMarkUsed = */ true);
1036   } else {
1037     result = SurfaceCache::LookupBestMatch(ImageKey(this), surfaceKey,
1038                                            /* aMarkUsed = */ true);
1039   }
1040
1041   IntSize rasterSize =
1042       result.SuggestedSize().IsEmpty() ? aSize : result.SuggestedSize();
1043   MOZ_ASSERT(result.Type() != MatchType::SUBSTITUTE_BECAUSE_PENDING);
1044   if (!result || result.Type() == MatchType::SUBSTITUTE_BECAUSE_NOT_FOUND) {
1045     // No matching surface, or the OS freed the volatile buffer.
1046     return MakeTuple(RefPtr<SourceSurface>(), rasterSize);
1047   }
1048
1049   RefPtr<SourceSurface> sourceSurface = result.Surface()->GetSourceSurface();
1050   if (!sourceSurface) {
1051     // Something went wrong. (Probably a GPU driver crash or device reset.)
1052     // Attempt to recover.
1053     RecoverFromLossOfSurfaces();
1054     return MakeTuple(RefPtr<SourceSurface>(), rasterSize);
1055   }
1056
1057   return MakeTuple(std::move(sourceSurface), rasterSize);
1058 }
1059
1060 already_AddRefed<SourceSurface> VectorImage::CreateSurface(
1061     const SVGDrawingParameters& aParams, gfxDrawable* aSVGDrawable,
1062     bool& aWillCache) {
1063   MOZ_ASSERT(mIsDrawing);
1064
1065   mSVGDocumentWrapper->UpdateViewportBounds(aParams.viewportSize);
1066   mSVGDocumentWrapper->FlushImageTransformInvalidation();
1067
1068   // Determine whether or not we should put the surface to be created into
1069   // the cache. If we fail, we need to reset this to false to let the caller
1070   // know nothing was put in the cache.
1071   aWillCache = !(aParams.flags & FLAG_BYPASS_SURFACE_CACHE) &&
1072                // Refuse to cache animated images:
1073                // XXX(seth): We may remove this restriction in bug 922893.
1074                !mHaveAnimations &&
1075                // The image is too big to fit in the cache:
1076                SurfaceCache::CanHold(aParams.size);
1077
1078   // If we weren't given a context, then we know we just want the rasterized
1079   // surface. We will create the frame below but only insert it into the cache
1080   // if we actually need to.
1081   if (!aWillCache && aParams.context) {
1082     return nullptr;
1083   }
1084
1085   // We're about to rerasterize, which may mean that some of the previous
1086   // surfaces we've rasterized aren't useful anymore. We can allow them to
1087   // expire from the cache by unlocking them here, and then sending out an
1088   // invalidation. If this image is locked, any surfaces that are still useful
1089   // will become locked again when Draw touches them, and the remainder will
1090   // eventually expire.
1091   if (aWillCache) {
1092     SurfaceCache::UnlockEntries(ImageKey(this));
1093   }
1094
1095   // If there is no context, the default backend is fine.
1096   BackendType backend =
1097       aParams.context ? aParams.context->GetDrawTarget()->GetBackendType()
1098                       : gfxPlatform::GetPlatform()->GetDefaultContentBackend();
1099
1100   // Try to create an imgFrame, initializing the surface it contains by drawing
1101   // our gfxDrawable into it. (We use FILTER_NEAREST since we never scale here.)
1102   auto frame = MakeNotNull<RefPtr<imgFrame>>();
1103   nsresult rv = frame->InitWithDrawable(
1104       aSVGDrawable, aParams.size, SurfaceFormat::B8G8R8A8,
1105       SamplingFilter::POINT, aParams.flags, backend,
1106       aParams.context ? aParams.context->GetDrawTarget() : nullptr);
1107
1108   // If we couldn't create the frame, it was probably because it would end
1109   // up way too big. Generally it also wouldn't fit in the cache, but the prefs
1110   // could be set such that the cache isn't the limiting factor.
1111   if (NS_FAILED(rv)) {
1112     aWillCache = false;
1113     return nullptr;
1114   }
1115
1116   // Take a strong reference to the frame's surface and make sure it hasn't
1117   // already been purged by the operating system.
1118   RefPtr<SourceSurface> surface = frame->GetSourceSurface();
1119   if (!surface) {
1120     aWillCache = false;
1121     return nullptr;
1122   }
1123
1124   // We created the frame, but only because we had no context to draw to
1125   // directly. All the caller wants is the surface in this case.
1126   if (!aWillCache) {
1127     return surface.forget();
1128   }
1129
1130   // Attempt to cache the frame.
1131   SurfaceKey surfaceKey = VectorSurfaceKey(aParams.size, aParams.svgContext);
1132   NotNull<RefPtr<ISurfaceProvider>> provider =
1133       MakeNotNull<SimpleSurfaceProvider*>(ImageKey(this), surfaceKey, frame);
1134
1135   if (SurfaceCache::Insert(provider) == InsertOutcome::SUCCESS &&
1136       aParams.size != aParams.drawSize) {
1137     // We created a new surface that wasn't the size we requested, which means
1138     // we entered factor-of-2 mode. We should purge any surfaces we no longer
1139     // need rather than waiting for the cache to expire them.
1140     SurfaceCache::PruneImage(ImageKey(this));
1141   }
1142
1143   return surface.forget();
1144 }
1145
1146 void VectorImage::SendFrameComplete(bool aDidCache, uint32_t aFlags) {
1147   // If the cache was not updated, we have nothing to do.
1148   if (!aDidCache) {
1149     return;
1150   }
1151
1152   // Send out an invalidation so that surfaces that are still in use get
1153   // re-locked. See the discussion of the UnlockSurfaces call above.
1154   if (!(aFlags & FLAG_ASYNC_NOTIFY)) {
1155     mProgressTracker->SyncNotifyProgress(FLAG_FRAME_COMPLETE,
1156                                          GetMaxSizedIntRect());
1157   } else {
1158     NotNull<RefPtr<VectorImage>> image = WrapNotNull(this);
1159     NS_DispatchToMainThread(CreateMediumHighRunnable(NS_NewRunnableFunction(
1160         "ProgressTracker::SyncNotifyProgress", [=]() -> void {
1161           RefPtr<ProgressTracker> tracker = image->GetProgressTracker();
1162           if (tracker) {
1163             tracker->SyncNotifyProgress(FLAG_FRAME_COMPLETE,
1164                                         GetMaxSizedIntRect());
1165           }
1166         })));
1167   }
1168 }
1169
1170 void VectorImage::Show(gfxDrawable* aDrawable,
1171                        const SVGDrawingParameters& aParams) {
1172   // The surface size may differ from the size at which we wish to draw. As
1173   // such, we may need to adjust the context/region to take this into account.
1174   gfxContextMatrixAutoSaveRestore saveMatrix(aParams.context);
1175   ImageRegion region(aParams.region);
1176   if (aParams.drawSize != aParams.size) {
1177     gfx::Size scale(double(aParams.drawSize.width) / aParams.size.width,
1178                     double(aParams.drawSize.height) / aParams.size.height);
1179     aParams.context->Multiply(gfxMatrix::Scaling(scale.width, scale.height));
1180     region.Scale(1.0 / scale.width, 1.0 / scale.height);
1181   }
1182
1183   MOZ_ASSERT(aDrawable, "Should have a gfxDrawable by now");
1184   gfxUtils::DrawPixelSnapped(aParams.context, aDrawable,
1185                              SizeDouble(aParams.size), region,
1186                              SurfaceFormat::B8G8R8A8, aParams.samplingFilter,
1187                              aParams.flags, aParams.opacity, false);
1188
1189 #ifdef DEBUG
1190   NotifyDrawingObservers();
1191 #endif
1192
1193   MOZ_ASSERT(mRenderingObserver, "Should have a rendering observer by now");
1194   mRenderingObserver->ResumeHonoringInvalidations();
1195 }
1196
1197 void VectorImage::RecoverFromLossOfSurfaces() {
1198   NS_WARNING("An imgFrame became invalid. Attempting to recover...");
1199
1200   // Discard all existing frames, since they're probably all now invalid.
1201   SurfaceCache::RemoveImage(ImageKey(this));
1202 }
1203
1204 NS_IMETHODIMP
1205 VectorImage::StartDecoding(uint32_t aFlags, uint32_t aWhichFrame) {
1206   // Nothing to do for SVG images
1207   return NS_OK;
1208 }
1209
1210 bool VectorImage::StartDecodingWithResult(uint32_t aFlags,
1211                                           uint32_t aWhichFrame) {
1212   // SVG images are ready to draw when they are loaded
1213   return mIsFullyLoaded;
1214 }
1215
1216 bool VectorImage::RequestDecodeWithResult(uint32_t aFlags,
1217                                           uint32_t aWhichFrame) {
1218   // SVG images are ready to draw when they are loaded
1219   return mIsFullyLoaded;
1220 }
1221
1222 NS_IMETHODIMP
1223 VectorImage::RequestDecodeForSize(const nsIntSize& aSize, uint32_t aFlags,
1224                                   uint32_t aWhichFrame) {
1225   // Nothing to do for SVG images, though in theory we could rasterize to the
1226   // provided size ahead of time if we supported off-main-thread SVG
1227   // rasterization...
1228   return NS_OK;
1229 }
1230
1231 //******************************************************************************
1232
1233 NS_IMETHODIMP
1234 VectorImage::LockImage() {
1235   MOZ_ASSERT(NS_IsMainThread());
1236
1237   if (mError) {
1238     return NS_ERROR_FAILURE;
1239   }
1240
1241   mLockCount++;
1242
1243   if (mLockCount == 1) {
1244     // Lock this image's surfaces in the SurfaceCache.
1245     SurfaceCache::LockImage(ImageKey(this));
1246   }
1247
1248   return NS_OK;
1249 }
1250
1251 //******************************************************************************
1252
1253 NS_IMETHODIMP
1254 VectorImage::UnlockImage() {
1255   MOZ_ASSERT(NS_IsMainThread());
1256
1257   if (mError) {
1258     return NS_ERROR_FAILURE;
1259   }
1260
1261   if (mLockCount == 0) {
1262     MOZ_ASSERT_UNREACHABLE("Calling UnlockImage with a zero lock count");
1263     return NS_ERROR_ABORT;
1264   }
1265
1266   mLockCount--;
1267
1268   if (mLockCount == 0) {
1269     // Unlock this image's surfaces in the SurfaceCache.
1270     SurfaceCache::UnlockImage(ImageKey(this));
1271   }
1272
1273   return NS_OK;
1274 }
1275
1276 //******************************************************************************
1277
1278 NS_IMETHODIMP
1279 VectorImage::RequestDiscard() {
1280   MOZ_ASSERT(NS_IsMainThread());
1281
1282   if (mDiscardable && mLockCount == 0) {
1283     SurfaceCache::RemoveImage(ImageKey(this));
1284     mProgressTracker->OnDiscard();
1285   }
1286
1287   return NS_OK;
1288 }
1289
1290 void VectorImage::OnSurfaceDiscarded(const SurfaceKey& aSurfaceKey) {
1291   MOZ_ASSERT(mProgressTracker);
1292
1293   NS_DispatchToMainThread(NewRunnableMethod("ProgressTracker::OnDiscard",
1294                                             mProgressTracker,
1295                                             &ProgressTracker::OnDiscard));
1296 }
1297
1298 //******************************************************************************
1299 NS_IMETHODIMP
1300 VectorImage::ResetAnimation() {
1301   if (mError) {
1302     return NS_ERROR_FAILURE;
1303   }
1304
1305   if (!mIsFullyLoaded || !mHaveAnimations) {
1306     return NS_OK;  // There are no animations to be reset.
1307   }
1308
1309   mSVGDocumentWrapper->ResetAnimation();
1310
1311   return NS_OK;
1312 }
1313
1314 NS_IMETHODIMP_(float)
1315 VectorImage::GetFrameIndex(uint32_t aWhichFrame) {
1316   MOZ_ASSERT(aWhichFrame <= FRAME_MAX_VALUE, "Invalid argument");
1317   return aWhichFrame == FRAME_FIRST
1318              ? 0.0f
1319              : mSVGDocumentWrapper->GetCurrentTimeAsFloat();
1320 }
1321
1322 //------------------------------------------------------------------------------
1323 // nsIRequestObserver methods
1324
1325 //******************************************************************************
1326 NS_IMETHODIMP
1327 VectorImage::OnStartRequest(nsIRequest* aRequest) {
1328   MOZ_ASSERT(!mSVGDocumentWrapper,
1329              "Repeated call to OnStartRequest -- can this happen?");
1330
1331   mSVGDocumentWrapper = new SVGDocumentWrapper();
1332   nsresult rv = mSVGDocumentWrapper->OnStartRequest(aRequest);
1333   if (NS_FAILED(rv)) {
1334     mSVGDocumentWrapper = nullptr;
1335     mError = true;
1336     return rv;
1337   }
1338
1339   // Create a listener to wait until the SVG document is fully loaded, which
1340   // will signal that this image is ready to render. Certain error conditions
1341   // will prevent us from ever getting this notification, so we also create a
1342   // listener that waits for parsing to complete and cancels the
1343   // SVGLoadEventListener if needed. The listeners are automatically attached
1344   // to the document by their constructors.
1345   SVGDocument* document = mSVGDocumentWrapper->GetDocument();
1346   mLoadEventListener = new SVGLoadEventListener(document, this);
1347   mParseCompleteListener = new SVGParseCompleteListener(document, this);
1348
1349   return NS_OK;
1350 }
1351
1352 //******************************************************************************
1353 NS_IMETHODIMP
1354 VectorImage::OnStopRequest(nsIRequest* aRequest, nsresult aStatus) {
1355   if (mError) {
1356     return NS_ERROR_FAILURE;
1357   }
1358
1359   return mSVGDocumentWrapper->OnStopRequest(aRequest, aStatus);
1360 }
1361
1362 void VectorImage::OnSVGDocumentParsed() {
1363   MOZ_ASSERT(mParseCompleteListener, "Should have the parse complete listener");
1364   MOZ_ASSERT(mLoadEventListener, "Should have the load event listener");
1365
1366   if (!mSVGDocumentWrapper->GetRootSVGElem()) {
1367     // This is an invalid SVG document. It may have failed to parse, or it may
1368     // be missing the <svg> root element, or the <svg> root element may not
1369     // declare the correct namespace. In any of these cases, we'll never be
1370     // notified that the SVG finished loading, so we need to treat this as an
1371     // error.
1372     OnSVGDocumentError();
1373   }
1374 }
1375
1376 void VectorImage::CancelAllListeners() {
1377   if (mParseCompleteListener) {
1378     mParseCompleteListener->Cancel();
1379     mParseCompleteListener = nullptr;
1380   }
1381   if (mLoadEventListener) {
1382     mLoadEventListener->Cancel();
1383     mLoadEventListener = nullptr;
1384   }
1385 }
1386
1387 void VectorImage::OnSVGDocumentLoaded() {
1388   MOZ_ASSERT(mSVGDocumentWrapper->GetRootSVGElem(),
1389              "Should have parsed successfully");
1390   MOZ_ASSERT(!mIsFullyLoaded && !mHaveAnimations,
1391              "These flags shouldn't get set until OnSVGDocumentLoaded. "
1392              "Duplicate calls to OnSVGDocumentLoaded?");
1393
1394   CancelAllListeners();
1395
1396   // XXX Flushing is wasteful if embedding frame hasn't had initial reflow.
1397   mSVGDocumentWrapper->FlushLayout();
1398
1399   mIsFullyLoaded = true;
1400   mHaveAnimations = mSVGDocumentWrapper->IsAnimated();
1401
1402   // Start listening to our image for rendering updates.
1403   mRenderingObserver = new SVGRootRenderingObserver(mSVGDocumentWrapper, this);
1404
1405   // ProgressTracker::SyncNotifyProgress may release us, so ensure we
1406   // stick around long enough to complete our work.
1407   RefPtr<VectorImage> kungFuDeathGrip(this);
1408
1409   // Tell *our* observers that we're done loading.
1410   if (mProgressTracker) {
1411     Progress progress = FLAG_SIZE_AVAILABLE | FLAG_HAS_TRANSPARENCY |
1412                         FLAG_FRAME_COMPLETE | FLAG_DECODE_COMPLETE;
1413
1414     if (mHaveAnimations) {
1415       progress |= FLAG_IS_ANIMATED;
1416     }
1417
1418     // Merge in any saved progress from OnImageDataComplete.
1419     if (mLoadProgress) {
1420       progress |= *mLoadProgress;
1421       mLoadProgress = Nothing();
1422     }
1423
1424     mProgressTracker->SyncNotifyProgress(progress, GetMaxSizedIntRect());
1425   }
1426
1427   EvaluateAnimation();
1428 }
1429
1430 void VectorImage::OnSVGDocumentError() {
1431   CancelAllListeners();
1432
1433   mError = true;
1434
1435   if (mProgressTracker) {
1436     // Notify observers about the error and unblock page load.
1437     Progress progress = FLAG_HAS_ERROR;
1438
1439     // Merge in any saved progress from OnImageDataComplete.
1440     if (mLoadProgress) {
1441       progress |= *mLoadProgress;
1442       mLoadProgress = Nothing();
1443     }
1444
1445     mProgressTracker->SyncNotifyProgress(progress);
1446   }
1447 }
1448
1449 //------------------------------------------------------------------------------
1450 // nsIStreamListener method
1451
1452 //******************************************************************************
1453 NS_IMETHODIMP
1454 VectorImage::OnDataAvailable(nsIRequest* aRequest, nsIInputStream* aInStr,
1455                              uint64_t aSourceOffset, uint32_t aCount) {
1456   if (mError) {
1457     return NS_ERROR_FAILURE;
1458   }
1459
1460   return mSVGDocumentWrapper->OnDataAvailable(aRequest, aInStr, aSourceOffset,
1461                                               aCount);
1462 }
1463
1464 // --------------------------
1465 // Invalidation helper method
1466
1467 void VectorImage::InvalidateObserversOnNextRefreshDriverTick() {
1468   if (mHasPendingInvalidation) {
1469     return;
1470   }
1471
1472   mHasPendingInvalidation = true;
1473
1474   // Animated images can wait for the refresh tick.
1475   if (mHaveAnimations) {
1476     return;
1477   }
1478
1479   // Non-animated images won't get the refresh tick, so we should just send an
1480   // invalidation outside the current execution context. We need to defer
1481   // because the layout tree is in the middle of invalidation, and the tree
1482   // state needs to be consistent. Specifically only some of the frames have
1483   // had the NS_FRAME_DESCENDANT_NEEDS_PAINT and/or NS_FRAME_NEEDS_PAINT bits
1484   // set by InvalidateFrameInternal in layout/generic/nsFrame.cpp. These bits
1485   // get cleared when we repaint the SVG into a surface by
1486   // nsIFrame::ClearInvalidationStateBits in nsDisplayList::PaintRoot.
1487   nsCOMPtr<nsIEventTarget> eventTarget;
1488   if (mProgressTracker) {
1489     eventTarget = mProgressTracker->GetEventTarget();
1490   } else {
1491     eventTarget = do_GetMainThread();
1492   }
1493
1494   RefPtr<VectorImage> self(this);
1495   nsCOMPtr<nsIRunnable> ev(NS_NewRunnableFunction(
1496       "VectorImage::SendInvalidationNotifications",
1497       [=]() -> void { self->SendInvalidationNotifications(); }));
1498   eventTarget->Dispatch(CreateMediumHighRunnable(ev.forget()),
1499                         NS_DISPATCH_NORMAL);
1500 }
1501
1502 void VectorImage::PropagateUseCounters(Document* aParentDocument) {
1503   Document* doc = mSVGDocumentWrapper->GetDocument();
1504   if (doc) {
1505     doc->PropagateUseCounters(aParentDocument);
1506   }
1507 }
1508
1509 void VectorImage::ReportUseCounters() {
1510   if (Document* doc = mSVGDocumentWrapper->GetDocument()) {
1511     doc->ReportUseCounters();
1512   }
1513 }
1514
1515 nsIntSize VectorImage::OptimalImageSizeForDest(const gfxSize& aDest,
1516                                                uint32_t aWhichFrame,
1517                                                SamplingFilter aSamplingFilter,
1518                                                uint32_t aFlags) {
1519   MOZ_ASSERT(aDest.width >= 0 || ceil(aDest.width) <= INT32_MAX ||
1520                  aDest.height >= 0 || ceil(aDest.height) <= INT32_MAX,
1521              "Unexpected destination size");
1522
1523   // We can rescale SVGs freely, so just return the provided destination size.
1524   return nsIntSize::Ceil(aDest.width, aDest.height);
1525 }
1526
1527 already_AddRefed<imgIContainer> VectorImage::Unwrap() {
1528   nsCOMPtr<imgIContainer> self(this);
1529   return self.forget();
1530 }
1531
1532 }  // namespace image
1533 }  // namespace mozilla