3a061049c85e2951b2c77d73579e6b3b9c2dd3b1
[WebKit-https.git] / Source / WebCore / platform / graphics / filters / FilterOperation.h
1 /*
2  * Copyright (C) 2011 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef FilterOperation_h
27 #define FilterOperation_h
28
29 #include "Color.h"
30 #include "LayoutSize.h"
31 #include "Length.h"
32 #include <wtf/RefCounted.h>
33 #include <wtf/TypeCasts.h>
34 #include <wtf/text/WTFString.h>
35
36 // Annoyingly, wingdi.h #defines this.
37 #ifdef PASSTHROUGH
38 #undef PASSTHROUGH
39 #endif
40
41 namespace WebCore {
42
43 // CSS Filters
44
45 class CachedResourceLoader;
46 class CachedSVGDocumentReference;
47 class FilterEffect;
48 struct ResourceLoaderOptions;
49
50 class FilterOperation : public RefCounted<FilterOperation> {
51 public:
52     enum OperationType {
53         REFERENCE, // url(#somefilter)
54         GRAYSCALE,
55         SEPIA,
56         SATURATE,
57         HUE_ROTATE,
58         INVERT,
59         OPACITY,
60         BRIGHTNESS,
61         CONTRAST,
62         BLUR,
63         DROP_SHADOW,
64         PASSTHROUGH,
65         DEFAULT,
66         NONE
67     };
68
69     virtual ~FilterOperation() = default;
70
71     virtual Ref<FilterOperation> clone() const = 0;
72
73     virtual bool operator==(const FilterOperation&) const = 0;
74     bool operator!=(const FilterOperation& o) const { return !(*this == o); }
75
76     virtual RefPtr<FilterOperation> blend(const FilterOperation* /*from*/, double /*progress*/, bool /*blendToPassthrough*/ = false)
77     {
78         return nullptr;
79     }
80
81     OperationType type() const { return m_type; }
82
83     bool isBasicColorMatrixFilterOperation() const
84     {
85         return m_type == GRAYSCALE || m_type == SEPIA || m_type == SATURATE || m_type == HUE_ROTATE;
86     }
87
88     bool isBasicComponentTransferFilterOperation() const
89     {
90         return m_type == INVERT || m_type == BRIGHTNESS || m_type == CONTRAST || m_type == OPACITY;
91     }
92
93     bool isSameType(const FilterOperation& o) const { return o.type() == m_type; }
94
95     // True if the alpha channel of any pixel can change under this operation.
96     virtual bool affectsOpacity() const { return false; }
97     // True if the value of one pixel can affect the value of another pixel under this operation, such as blur.
98     virtual bool movesPixels() const { return false; }
99     // True if the filter should not be allowed to work on content that is not available from this security origin.
100     virtual bool shouldBeRestrictedBySecurityOrigin() const { return false; }
101
102 protected:
103     FilterOperation(OperationType type)
104         : m_type(type)
105     {
106     }
107
108     OperationType m_type;
109 };
110
111 class WEBCORE_EXPORT DefaultFilterOperation : public FilterOperation {
112 public:
113     static Ref<DefaultFilterOperation> create(OperationType representedType)
114     {
115         return adoptRef(*new DefaultFilterOperation(representedType));
116     }
117
118     Ref<FilterOperation> clone() const override
119     {
120         return adoptRef(*new DefaultFilterOperation(representedType()));
121     }
122
123     OperationType representedType() const { return m_representedType; }
124
125 private:
126     bool operator==(const FilterOperation&) const override;
127
128     DefaultFilterOperation(OperationType representedType)
129         : FilterOperation(DEFAULT)
130         , m_representedType(representedType)
131     {
132     }
133
134     OperationType m_representedType;
135 };
136
137 class PassthroughFilterOperation : public FilterOperation {
138 public:
139     static Ref<PassthroughFilterOperation> create()
140     {
141         return adoptRef(*new PassthroughFilterOperation());
142     }
143
144     Ref<FilterOperation> clone() const override
145     {
146         return adoptRef(*new PassthroughFilterOperation());
147     }
148
149 private:
150     bool operator==(const FilterOperation& o) const override
151     {
152         return isSameType(o);
153     }
154
155     PassthroughFilterOperation()
156         : FilterOperation(PASSTHROUGH)
157     {
158     }
159 };
160
161 class ReferenceFilterOperation : public FilterOperation {
162 public:
163     static Ref<ReferenceFilterOperation> create(const String& url, const String& fragment)
164     {
165         return adoptRef(*new ReferenceFilterOperation(url, fragment));
166     }
167     virtual ~ReferenceFilterOperation();
168
169     Ref<FilterOperation> clone() const final
170     {
171         // Reference filters cannot be cloned.
172         RELEASE_ASSERT_NOT_REACHED();
173     }
174
175     bool affectsOpacity() const override { return true; }
176     bool movesPixels() const override { return true; }
177     // FIXME: This only needs to return true for graphs that include ConvolveMatrix, DisplacementMap, Morphology and possibly Lighting.
178     // https://bugs.webkit.org/show_bug.cgi?id=171753
179     bool shouldBeRestrictedBySecurityOrigin() const override { return true; }
180
181     const String& url() const { return m_url; }
182     const String& fragment() const { return m_fragment; }
183
184     void loadExternalDocumentIfNeeded(CachedResourceLoader&, const ResourceLoaderOptions&);
185
186     CachedSVGDocumentReference* cachedSVGDocumentReference() const { return m_cachedSVGDocumentReference.get(); }
187
188     FilterEffect* filterEffect() const { return m_filterEffect.get(); }
189     void setFilterEffect(RefPtr<FilterEffect>&&);
190
191 private:
192     ReferenceFilterOperation(const String& url, const String& fragment);
193
194     bool operator==(const FilterOperation&) const override;
195
196     String m_url;
197     String m_fragment;
198     std::unique_ptr<CachedSVGDocumentReference> m_cachedSVGDocumentReference;
199     RefPtr<FilterEffect> m_filterEffect;
200 };
201
202 // GRAYSCALE, SEPIA, SATURATE and HUE_ROTATE are variations on a basic color matrix effect.
203 // For HUE_ROTATE, the angle of rotation is stored in m_amount.
204 class WEBCORE_EXPORT BasicColorMatrixFilterOperation : public FilterOperation {
205 public:
206     static Ref<BasicColorMatrixFilterOperation> create(double amount, OperationType type)
207     {
208         return adoptRef(*new BasicColorMatrixFilterOperation(amount, type));
209     }
210
211     Ref<FilterOperation> clone() const override
212     {
213         return adoptRef(*new BasicColorMatrixFilterOperation(amount(), type()));
214     }
215
216     double amount() const { return m_amount; }
217
218     RefPtr<FilterOperation> blend(const FilterOperation* from, double progress, bool blendToPassthrough = false) override;
219
220 private:
221     bool operator==(const FilterOperation&) const override;
222
223     double passthroughAmount() const;
224
225     BasicColorMatrixFilterOperation(double amount, OperationType type)
226         : FilterOperation(type)
227         , m_amount(amount)
228     {
229     }
230
231     double m_amount;
232 };
233
234 // INVERT, BRIGHTNESS, CONTRAST and OPACITY are variations on a basic component transfer effect.
235 class WEBCORE_EXPORT BasicComponentTransferFilterOperation : public FilterOperation {
236 public:
237     static Ref<BasicComponentTransferFilterOperation> create(double amount, OperationType type)
238     {
239         return adoptRef(*new BasicComponentTransferFilterOperation(amount, type));
240     }
241
242     Ref<FilterOperation> clone() const override
243     {
244         return adoptRef(*new BasicComponentTransferFilterOperation(amount(), type()));
245     }
246
247     double amount() const { return m_amount; }
248
249     bool affectsOpacity() const override { return m_type == OPACITY; }
250
251     RefPtr<FilterOperation> blend(const FilterOperation* from, double progress, bool blendToPassthrough = false) override;
252
253 private:
254     bool operator==(const FilterOperation&) const override;
255
256     double passthroughAmount() const;
257
258     BasicComponentTransferFilterOperation(double amount, OperationType type)
259         : FilterOperation(type)
260         , m_amount(amount)
261     {
262     }
263
264     double m_amount;
265 };
266
267 class WEBCORE_EXPORT BlurFilterOperation : public FilterOperation {
268 public:
269     static Ref<BlurFilterOperation> create(Length stdDeviation)
270     {
271         return adoptRef(*new BlurFilterOperation(WTFMove(stdDeviation)));
272     }
273
274     Ref<FilterOperation> clone() const override
275     {
276         return adoptRef(*new BlurFilterOperation(stdDeviation()));
277     }
278
279     const Length& stdDeviation() const { return m_stdDeviation; }
280
281     bool affectsOpacity() const override { return true; }
282     bool movesPixels() const override { return true; }
283
284     RefPtr<FilterOperation> blend(const FilterOperation* from, double progress, bool blendToPassthrough = false) override;
285
286 private:
287     bool operator==(const FilterOperation&) const override;
288
289     BlurFilterOperation(Length stdDeviation)
290         : FilterOperation(BLUR)
291         , m_stdDeviation(WTFMove(stdDeviation))
292     {
293     }
294
295     Length m_stdDeviation;
296 };
297
298 class WEBCORE_EXPORT DropShadowFilterOperation : public FilterOperation {
299 public:
300     static Ref<DropShadowFilterOperation> create(const IntPoint& location, int stdDeviation, const Color& color)
301     {
302         return adoptRef(*new DropShadowFilterOperation(location, stdDeviation, color));
303     }
304
305     Ref<FilterOperation> clone() const override
306     {
307         return adoptRef(*new DropShadowFilterOperation(location(), stdDeviation(), color()));
308     }
309
310     int x() const { return m_location.x(); }
311     int y() const { return m_location.y(); }
312     IntPoint location() const { return m_location; }
313     int stdDeviation() const { return m_stdDeviation; }
314     const Color& color() const { return m_color; }
315
316     bool affectsOpacity() const override { return true; }
317     bool movesPixels() const override { return true; }
318
319     RefPtr<FilterOperation> blend(const FilterOperation* from, double progress, bool blendToPassthrough = false) override;
320
321 private:
322     bool operator==(const FilterOperation&) const override;
323
324     DropShadowFilterOperation(const IntPoint& location, int stdDeviation, const Color& color)
325         : FilterOperation(DROP_SHADOW)
326         , m_location(location)
327         , m_stdDeviation(stdDeviation)
328         , m_color(color)
329     {
330     }
331
332     IntPoint m_location; // FIXME: should location be in Lengths?
333     int m_stdDeviation;
334     Color m_color;
335 };
336
337 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, const FilterOperation&);
338
339 } // namespace WebCore
340
341 #define SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(ToValueTypeName, predicate) \
342 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
343     static bool isType(const WebCore::FilterOperation& operation) { return operation.predicate; } \
344 SPECIALIZE_TYPE_TRAITS_END()
345
346 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(DefaultFilterOperation, type() == WebCore::FilterOperation::DEFAULT)
347 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(PassthroughFilterOperation, type() == WebCore::FilterOperation::PASSTHROUGH)
348 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(ReferenceFilterOperation, type() == WebCore::FilterOperation::REFERENCE)
349 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(BasicColorMatrixFilterOperation, isBasicColorMatrixFilterOperation())
350 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(BasicComponentTransferFilterOperation, isBasicComponentTransferFilterOperation())
351 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(BlurFilterOperation, type() == WebCore::FilterOperation::BLUR)
352 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(DropShadowFilterOperation, type() == WebCore::FilterOperation::DROP_SHADOW)
353
354 #endif // FilterOperation_h