-
-
Notifications
You must be signed in to change notification settings - Fork 184
/
Copy pathClippedImage.cpp
512 lines (436 loc) · 18.7 KB
/
ClippedImage.cpp
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
/* -*- 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/. */
#include "ClippedImage.h"
#include <algorithm>
#include <cmath>
#include <new> // Workaround for bug in VS10; see bug 981264.
#include <utility>
#include "ImageRegion.h"
#include "Orientation.h"
#include "gfxContext.h"
#include "gfxDrawable.h"
#include "gfxPlatform.h"
#include "gfxUtils.h"
#include "mozilla/RefPtr.h"
#include "mozilla/SVGImageContext.h"
#include "mozilla/gfx/2D.h"
namespace mozilla {
using namespace gfx;
using std::max;
namespace image {
class ClippedImageCachedSurface {
public:
ClippedImageCachedSurface(already_AddRefed<SourceSurface> aSurface,
const nsIntSize& aSize,
const SVGImageContext& aSVGContext, float aFrame,
uint32_t aFlags, ImgDrawResult aDrawResult)
: mSurface(aSurface),
mSize(aSize),
mSVGContext(aSVGContext),
mFrame(aFrame),
mFlags(aFlags),
mDrawResult(aDrawResult) {
MOZ_ASSERT(mSurface, "Must have a valid surface");
}
bool Matches(const nsIntSize& aSize, const SVGImageContext& aSVGContext,
float aFrame, uint32_t aFlags) const {
return mSize == aSize && mSVGContext == aSVGContext && mFrame == aFrame &&
mFlags == aFlags;
}
already_AddRefed<SourceSurface> Surface() const {
RefPtr<SourceSurface> surf(mSurface);
return surf.forget();
}
ImgDrawResult GetDrawResult() const { return mDrawResult; }
bool NeedsRedraw() const {
return mDrawResult != ImgDrawResult::SUCCESS &&
mDrawResult != ImgDrawResult::BAD_IMAGE;
}
private:
RefPtr<SourceSurface> mSurface;
const nsIntSize mSize;
SVGImageContext mSVGContext;
const float mFrame;
const uint32_t mFlags;
const ImgDrawResult mDrawResult;
};
class DrawSingleTileCallback : public gfxDrawingCallback {
public:
DrawSingleTileCallback(ClippedImage* aImage, const nsIntSize& aSize,
const SVGImageContext& aSVGContext,
uint32_t aWhichFrame, uint32_t aFlags, float aOpacity)
: mImage(aImage),
mSize(aSize),
mSVGContext(aSVGContext),
mWhichFrame(aWhichFrame),
mFlags(aFlags),
mDrawResult(ImgDrawResult::NOT_READY),
mOpacity(aOpacity) {
MOZ_ASSERT(mImage, "Must have an image to clip");
}
virtual bool operator()(gfxContext* aContext, const gfxRect& aFillRect,
const SamplingFilter aSamplingFilter,
const gfxMatrix& aTransform) override {
MOZ_ASSERT(aTransform.IsIdentity(),
"Caller is probably CreateSamplingRestrictedDrawable, "
"which should not happen");
// Draw the image. |gfxCallbackDrawable| always calls this function with
// arguments that guarantee we never tile.
mDrawResult = mImage->DrawSingleTile(
aContext, mSize, ImageRegion::Create(aFillRect), mWhichFrame,
aSamplingFilter, mSVGContext, mFlags, mOpacity);
return true;
}
ImgDrawResult GetDrawResult() { return mDrawResult; }
private:
RefPtr<ClippedImage> mImage;
const nsIntSize mSize;
const SVGImageContext& mSVGContext;
const uint32_t mWhichFrame;
const uint32_t mFlags;
ImgDrawResult mDrawResult;
float mOpacity;
};
ClippedImage::ClippedImage(Image* aImage, nsIntRect aClip,
const Maybe<nsSize>& aSVGViewportSize)
: ImageWrapper(aImage), mClip(aClip) {
MOZ_ASSERT(aImage != nullptr, "ClippedImage requires an existing Image");
MOZ_ASSERT_IF(aSVGViewportSize,
aImage->GetType() == imgIContainer::TYPE_VECTOR);
if (aSVGViewportSize) {
mSVGViewportSize =
Some(aSVGViewportSize->ToNearestPixels(AppUnitsPerCSSPixel()));
}
}
ClippedImage::~ClippedImage() {}
bool ClippedImage::ShouldClip() {
// We need to evaluate the clipping region against the image's width and
// height once they're available to determine if it's valid and whether we
// actually need to do any work. We may fail if the image's width and height
// aren't available yet, in which case we'll try again later.
if (mShouldClip.isNothing()) {
int32_t width, height;
RefPtr<ProgressTracker> progressTracker =
InnerImage()->GetProgressTracker();
if (InnerImage()->HasError()) {
// If there's a problem with the inner image we'll let it handle
// everything.
mShouldClip.emplace(false);
} else if (mSVGViewportSize && !mSVGViewportSize->IsEmpty()) {
// Clamp the clipping region to the size of the SVG viewport.
nsIntRect svgViewportRect(nsIntPoint(0, 0), *mSVGViewportSize);
mClip = mClip.Intersect(svgViewportRect);
// If the clipping region is the same size as the SVG viewport size
// we don't have to do anything.
mShouldClip.emplace(!mClip.IsEqualInterior(svgViewportRect));
} else if (NS_SUCCEEDED(InnerImage()->GetWidth(&width)) && width > 0 &&
NS_SUCCEEDED(InnerImage()->GetHeight(&height)) && height > 0) {
// Clamp the clipping region to the size of the underlying image.
mClip = mClip.Intersect(nsIntRect(0, 0, width, height));
// If the clipping region is the same size as the underlying image we
// don't have to do anything.
mShouldClip.emplace(
!mClip.IsEqualInterior(nsIntRect(0, 0, width, height)));
} else if (progressTracker &&
!(progressTracker->GetProgress() & FLAG_LOAD_COMPLETE)) {
// The image just hasn't finished loading yet. We don't yet know whether
// clipping with be needed or not for now. Just return without memorizing
// anything.
return false;
} else {
// We have a fully loaded image without a clearly defined width and
// height. This can happen with SVG images.
mShouldClip.emplace(false);
}
}
MOZ_ASSERT(mShouldClip.isSome(), "Should have computed a result");
return *mShouldClip;
}
NS_IMETHODIMP
ClippedImage::GetWidth(int32_t* aWidth) {
if (!ShouldClip()) {
return InnerImage()->GetWidth(aWidth);
}
*aWidth = mClip.Width();
return NS_OK;
}
NS_IMETHODIMP
ClippedImage::GetHeight(int32_t* aHeight) {
if (!ShouldClip()) {
return InnerImage()->GetHeight(aHeight);
}
*aHeight = mClip.Height();
return NS_OK;
}
NS_IMETHODIMP
ClippedImage::GetIntrinsicSize(nsSize* aSize) {
if (!ShouldClip()) {
return InnerImage()->GetIntrinsicSize(aSize);
}
*aSize = nsSize(mClip.Width(), mClip.Height());
return NS_OK;
}
Maybe<AspectRatio> ClippedImage::GetIntrinsicRatio() {
if (!ShouldClip()) {
return InnerImage()->GetIntrinsicRatio();
}
return Some(AspectRatio::FromSize(mClip.Width(), mClip.Height()));
}
NS_IMETHODIMP_(already_AddRefed<SourceSurface>)
ClippedImage::GetFrame(uint32_t aWhichFrame, uint32_t aFlags) {
RefPtr<SourceSurface> surface;
std::tie(std::ignore, surface) = GetFrameInternal(
mClip.Size(), SVGImageContext(), Nothing(), aWhichFrame, aFlags, 1.0);
return surface.forget();
}
NS_IMETHODIMP_(already_AddRefed<SourceSurface>)
ClippedImage::GetFrameAtSize(const IntSize& aSize, uint32_t aWhichFrame,
uint32_t aFlags) {
// XXX(seth): It'd be nice to support downscale-during-decode for this case,
// but right now we just fall back to the intrinsic size.
return GetFrame(aWhichFrame, aFlags);
}
std::pair<ImgDrawResult, RefPtr<SourceSurface>> ClippedImage::GetFrameInternal(
const nsIntSize& aSize, const SVGImageContext& aSVGContext,
const Maybe<ImageIntRegion>& aRegion, uint32_t aWhichFrame, uint32_t aFlags,
float aOpacity) {
if (!ShouldClip()) {
RefPtr<SourceSurface> surface = InnerImage()->GetFrame(aWhichFrame, aFlags);
return std::make_pair(
surface ? ImgDrawResult::SUCCESS : ImgDrawResult::NOT_READY,
std::move(surface));
}
float frameToDraw = InnerImage()->GetFrameIndex(aWhichFrame);
if (!mCachedSurface ||
!mCachedSurface->Matches(aSize, aSVGContext, frameToDraw, aFlags) ||
mCachedSurface->NeedsRedraw()) {
// Create a surface to draw into.
RefPtr<DrawTarget> target =
gfxPlatform::GetPlatform()->CreateOffscreenContentDrawTarget(
IntSize(aSize.width, aSize.height), SurfaceFormat::OS_RGBA);
if (!target || !target->IsValid()) {
NS_ERROR("Could not create a DrawTarget");
return std::make_pair(ImgDrawResult::TEMPORARY_ERROR,
RefPtr<SourceSurface>());
}
gfxContext ctx(target);
// Create our callback.
RefPtr<DrawSingleTileCallback> drawTileCallback =
new DrawSingleTileCallback(this, aSize, aSVGContext, aWhichFrame,
aFlags, aOpacity);
RefPtr<gfxDrawable> drawable =
new gfxCallbackDrawable(drawTileCallback, aSize);
// Actually draw. The callback will end up invoking DrawSingleTile.
gfxUtils::DrawPixelSnapped(&ctx, drawable, SizeDouble(aSize),
ImageRegion::Create(aSize),
SurfaceFormat::OS_RGBA, SamplingFilter::LINEAR,
imgIContainer::FLAG_CLAMP);
// Cache the resulting surface.
mCachedSurface = MakeUnique<ClippedImageCachedSurface>(
target->Snapshot(), aSize, aSVGContext, frameToDraw, aFlags,
drawTileCallback->GetDrawResult());
}
MOZ_ASSERT(mCachedSurface, "Should have a cached surface now");
RefPtr<SourceSurface> surface = mCachedSurface->Surface();
return std::make_pair(mCachedSurface->GetDrawResult(), std::move(surface));
}
NS_IMETHODIMP_(b
67F4
ool)
ClippedImage::IsImageContainerAvailable(WindowRenderer* aRenderer,
uint32_t aFlags) {
if (!ShouldClip()) {
return InnerImage()->IsImageContainerAvailable(aRenderer, aFlags);
}
return false;
}
NS_IMETHODIMP_(ImgDrawResult)
ClippedImage::GetImageProvider(WindowRenderer* aRenderer,
const gfx::IntSize& aSize,
const SVGImageContext& aSVGContext,
const Maybe<ImageIntRegion>& aRegion,
uint32_t aFlags,
WebRenderImageProvider** aProvider) {
// XXX(seth): We currently don't have a way of clipping the result of
// GetImageContainer. We work around this by always returning null, but if it
// ever turns out that ClippedImage is widely used on codepaths that can
// actually benefit from GetImageContainer, it would be a good idea to fix
// that method for performance reasons.
if (!ShouldClip()) {
return InnerImage()->GetImageProvider(aRenderer, aSize, aSVGContext,
aRegion, aFlags, aProvider);
}
return ImgDrawResult::NOT_SUPPORTED;
}
static bool MustCreateSurface(gfxContext* aContext, const nsIntSize& aSize,
const ImageRegion& aRegion,
const uint32_t aFlags) {
gfxRect imageRect(0, 0, aSize.width, aSize.height);
bool willTile = !imageRect.Contains(aRegion.Rect()) &&
!(aFlags & imgIContainer::FLAG_CLAMP);
bool willResample = aContext->CurrentMatrix().HasNonIntegerTranslation() &&
(willTile || !aRegion.RestrictionContains(imageRect));
return willTile || willResample;
}
NS_IMETHODIMP_(ImgDrawResult)
ClippedImage::Draw(gfxContext* aContext, const nsIntSize& aSize,
const ImageRegion& aRegion, uint32_t aWhichFrame,
SamplingFilter aSamplingFilter,
const SVGImageContext& aSVGContext, uint32_t aFlags,
float aOpacity) {
if (!ShouldClip()) {
return InnerImage()->Draw(aContext, aSize, aRegion, aWhichFrame,
aSamplingFilter, aSVGContext, aFlags, aOpacity);
}
// Check for tiling. If we need to tile then we need to create a
// gfxCallbackDrawable to handle drawing for us.
if (MustCreateSurface(aContext, aSize, aRegion, aFlags)) {
// Create a temporary surface containing a single tile of this image.
// GetFrame will call DrawSingleTile internally.
auto [result, surface] = GetFrameInternal(aSize, aSVGContext, Nothing(),
aWhichFrame, aFlags, aOpacity);
if (!surface) {
MOZ_ASSERT(result != ImgDrawResult::SUCCESS);
return result;
}
// Create a drawable from that surface.
RefPtr<gfxSurfaceDrawable> drawable =
new gfxSurfaceDrawable(surface, aSize);
// Draw.
gfxUtils::DrawPixelSnapped(aContext, drawable, SizeDouble(aSize), aRegion,
SurfaceFormat::OS_RGBA, aSamplingFilter,
aOpacity);
return result;
}
return DrawSingleTile(aContext, aSize, aRegion, aWhichFrame, aSamplingFilter,
aSVGContext, aFlags, aOpacity);
}
ImgDrawResult ClippedImage::DrawSingleTile(
gfxContext* aContext, const nsIntSize& aSize, const ImageRegion& aRegion,
uint32_t aWhichFrame, SamplingFilter aSamplingFilter,
const SVGImageContext& aSVGContext, uint32_t aFlags, float aOpacity) {
MOZ_ASSERT(!MustCreateSurface(aContext, aSize, aRegion, aFlags),
"Shouldn't need to create a surface");
gfxRect clip(mClip.X(), mClip.Y(), mClip.Width(), mClip.Height());
nsIntSize size(aSize), innerSize(aSize);
bool needScale = false;
if (mSVGViewportSize && !mSVGViewportSize->IsEmpty()) {
innerSize = *mSVGViewportSize;
needScale = true;
} else if (NS_SUCCEEDED(InnerImage()->GetWidth(&innerSize.width)) &&
NS_SUCCEEDED(InnerImage()->GetHeight(&innerSize.height
A3D4
))) {
needScale = true;
} else {
MOZ_ASSERT_UNREACHABLE(
"If ShouldClip() led us to draw then we should never get here");
}
if (needScale) {
double scaleX = aSize.width / clip.Width();
double scaleY = aSize.height / clip.Height();
// Map the clip and size to the scale requested by the caller.
clip.Scale(scaleX, scaleY);
size = innerSize;
size.Scale(scaleX, scaleY);
}
// We restrict our drawing to only the clipping region, and translate so that
// the clipping region is placed at the position the caller expects.
ImageRegion region(aRegion);
region.MoveBy(clip.X(), clip.Y());
region = region.Intersect(clip);
gfxContextMatrixAutoSaveRestore saveMatrix(aContext);
aContext->Multiply(gfxMatrix::Translation(-clip.X(), -clip.Y()));
auto unclipViewport = [&](const SVGImageContext& aOldContext) {
// Map the viewport to the inner image. Note that we don't take the aSize
// parameter of imgIContainer::Draw into account, just the clipping region.
// The size in pixels at which the output will ultimately be drawn is
// irrelevant here since the purpose of the SVG viewport size is to
// determine what *region* of the SVG document will be drawn.
SVGImageContext context(aOldContext);
auto oldViewport = aOldContext.GetViewportSize();
if (oldViewport) {
CSSIntSize newViewport;
newViewport.width =
ceil(oldViewport->width * double(innerSize.width) / mClip.Width());
newViewport.height =
ceil(oldViewport->height * double(innerSize.height) / mClip.Height());
context.SetViewportSize(Some(newViewport));
}
return context;
};
return InnerImage()->Draw(aContext, size, region, aWhichFrame,
aSamplingFilter, unclipViewport(aSVGContext),
aFlags, aOpacity);
}
NS_IMETHODIMP
ClippedImage::RequestDiscard() {
// We're very aggressive about discarding.
mCachedSurface = nullptr;
return InnerImage()->RequestDiscard();
}
NS_IMETHODIMP_(Orientation)
ClippedImage::GetOrientation() {
// XXX(seth): This should not actually be here; this is just to work around a
// what appears to be a bug in MSVC's linker.
return InnerImage()->GetOrientation();
}
nsIntSize ClippedImage::OptimalImageSizeForDest(const gfxSize& aDest,
uint32_t aWhichFrame,
SamplingFilter aSamplingFilter,
uint32_t aFlags) {
if (!ShouldClip()) {
return InnerImage()->OptimalImageSizeForDest(aDest, aWhichFrame,
aSamplingFilter, aFlags);
}
int32_t imgWidth, imgHeight;
bool needScale = false;
bool forceUniformScaling = false;
if (mSVGViewportSize && !mSVGViewportSize->IsEmpty()) {
imgWidth = mSVGViewportSize->width;
imgHeight = mSVGViewportSize->height;
needScale = true;
forceUniformScaling = (aFlags & imgIContainer::FLAG_FORCE_UNIFORM_SCALING);
} else if (NS_SUCCEEDED(InnerImage()->GetWidth(&imgWidth)) &&
NS_SUCCEEDED(InnerImage()->GetHeight(&imgHeight))) {
needScale = true;
}
if (needScale) {
// To avoid ugly sampling artifacts, ClippedImage needs the image size to
// be chosen such that the clipping region lies on pixel boundaries.
// First, we select a scale that's good for ClippedImage. An integer
// multiple of the size of the clipping region is always fine.
IntSize scale = IntSize::Ceil(aDest.width / mClip.Width(),
aDest.height / mClip.Height());
if (forceUniformScaling) {
scale.width = scale.height = max(scale.height, scale.width);
}
// Determine the size we'd prefer to render the inner image at, and ask the
// inner image what size we should actually use.
gfxSize desiredSize(double(imgWidth) * scale.width,
double(imgHeight) * scale.height);
nsIntSize innerDesiredSize = InnerImage()->OptimalImageSizeForDest(
desiredSize, aWhichFrame, aSamplingFilter, aFlags);
// To get our final result, we take the inner image's desired size and
// determine how large the clipped region would be at that scale. (Again, we
// ensure an integer multiple of the size of the clipping region.)
IntSize finalScale =
IntSize::Ceil(double(innerDesiredSize.width) / imgWidth,
double(innerDesiredSize.height) / imgHeight);
return mClip.Size() * finalScale;
}
MOZ_ASSERT(false,
"If ShouldClip() led us to draw then we should never get here");
return InnerImage()->OptimalImageSizeForDest(aDest, aWhichFrame,
aSamplingFilter, aFlags);
}
NS_IMETHODIMP_(nsIntRect)
ClippedImage::GetImageSpaceInvalidationRect(const nsIntRect& aRect) {
if (!ShouldClip()) {
return InnerImage()->GetImageSpaceInvalidationRect(aRect);
}
nsIntRect rect(InnerImage()->GetImageSpaceInvalidationRect(aRect));
rect = rect.Intersect(mClip);
rect.MoveBy(-mClip.X(), -mClip.Y());
return rect;
}
} // namespace image
} // namespace mozilla