1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_image_VectorImage_h
#define mozilla_image_VectorImage_h
#include "Image.h"
#include "nsIStreamListener.h"
#include "mozilla/gfx/Point.h"
#include "mozilla/MemoryReporting.h"
class nsIRequest;
class gfxDrawable;
namespace mozilla {
struct MediaFeatureChange;
namespace image {
class SourceSurfaceBlobImage;
struct SVGDrawingParameters;
class SVGDocumentWrapper;
class SVGRootRenderingObserver;
class SVGLoadEventListener;
class SVGParseCompleteListener;
class VectorImage final : public ImageResource, public nsIStreamListener {
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIREQUESTOBSERVER
NS_DECL_NSISTREAMLISTENER
NS_DECL_IMGICONTAINER
// (no public constructor - use ImageFactory)
// Methods inherited from Image
virtual size_t SizeOfSourceWithComputedFallback(
SizeOfState& aState) const override;
virtual nsresult OnImageDataAvailable(nsIRequest* aRequest,
nsIInputStream* aInStr,
uint64_t aSourceOffset,
uint32_t aCount) override;
virtual nsresult OnImageDataComplete(nsIRequest* aRequest, nsresult aResult,
bool aLastPart) override;
virtual void OnSurfaceDiscarded(const SurfaceKey& aSurfaceKey) override;
/**
* Callback for SVGRootRenderingObserver.
*
* This just sets a dirty flag that we check in VectorImage::RequestRefresh,
* which is called under the ticks of the refresh driver of any observing
* documents that we may have. Only then (after all animations in this image
* have been updated) do we send out "frame changed" notifications,
*/
void InvalidateObserversOnNextRefreshDriverTick();
// Callback for SVGParseCompleteListener.
void OnSVGDocumentParsed();
// Callbacks for SVGLoadEventListener.
void OnSVGDocumentLoaded();
void OnSVGDocumentError();
protected:
explicit VectorImage(nsIURI* aURI = nullptr);
virtual ~VectorImage();
virtual nsresult StartAnimation() override;
virtual nsresult StopAnimation() override;
virtual bool ShouldAnimate() override;
private:
friend class SourceSurfaceBlobImage;
/**
* Attempt to find a matching cached surface in the SurfaceCache. Returns the
* cached surface, if found, and the size to rasterize at, if applicable.
* If we cannot rasterize, it will be the requested size to draw at (aSize).
*/
std::tuple<RefPtr<gfx::SourceSurface>, gfx::IntSize> LookupCachedSurface(
const gfx::IntSize& aSize, const SVGImageContext& aSVGContext,
uint32_t aFlags);
bool MaybeRestrictSVGContext(SVGImageContext& aSVGContext, uint32_t aFlags);
/// Create a gfxDrawable which callbacks into the SVG document.
already_AddRefed<gfxDrawable> CreateSVGDrawable(
const SVGDrawingParameters& aParams);
/// Rasterize the SVG into a surface. aWillCache will be set to whether or
/// not the new surface was put into the cache.
already_AddRefed<gfx::SourceSurface> CreateSurface(
const SVGDrawingParameters& aParams, gfxDrawable* aSVGDrawable,
bool& aWillCache);
/// Send a frame complete notification if appropriate. Must be called only
/// after all drawing has been completed.
void SendFrameComplete(bool aDidCache, uint32_t aFlags);
void Show(gfxDrawable* aDrawable, const SVGDrawingParameters& aParams);
nsresult Init(const char* aMimeType, uint32_t aFlags);
/**
* In catastrophic circumstances like a GPU driver crash, we may lose our
* surfaces even if they're locked. RecoverFromLossOfSurfaces discards all
* existing surfaces, allowing us to recover.
*/
void RecoverFromLossOfSurfaces();
void CancelAllListeners();
void SendInvalidationNotifications();
void ReportDocumentUseCounters();
RefPtr<SVGDocumentWrapper> mSVGDocumentWrapper;
RefPtr<SVGRootRenderingObserver> mRenderingObserver;
RefPtr<SVGLoadEventListener> mLoadEventListener;
RefPtr<SVGParseCompleteListener> mParseCompleteListener;
/// Count of locks on this image (roughly correlated to visible instances).
uint32_t mLockCount;
// Stored result from the Necko load of the image, which we save in
// OnImageDataComplete if the underlying SVG document isn't loaded. If we save
// this, we actually notify this progress (and clear this value) in
// OnSVGDocumentLoaded or OnSVGDocumentError.
Maybe<Progress> mLoadProgress;
bool mIsInitialized; // Have we been initialized?
bool mDiscardable; // Are we discardable?
bool mIsFullyLoaded; // Has the SVG document finished
// loading?
bool mHaveAnimations; // Is our SVG content SMIL-animated?
// (Only set after mIsFullyLoaded.)
bool mHasPendingInvalidation; // Invalidate observers next refresh
// driver tick.
friend class ImageFactory;
};
inline NS_IMETHODIMP VectorImage::GetAnimationMode(uint16_t* aAnimationMode) {
return GetAnimationModeInternal(aAnimationMode);
}
inline NS_IMETHODIMP VectorImage::SetAnimationMode(uint16_t aAnimationMode) {
return SetAnimationModeInternal(aAnimationMode);
}
} // namespace image
} // namespace mozilla
#endif // mozilla_image_VectorImage_h
|