633696f2ea466f0886493f34748336bb2180a674
[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() { }
70
71     virtual PassRefPtr<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 PassRefPtr<FilterOperation> blend(const FilterOperation* /*from*/, double /*progress*/, bool /*blendToPassthrough*/ = false)
77     {
78         ASSERT(!blendingNeedsRendererSize());
79         return 0;
80     }
81
82     virtual PassRefPtr<FilterOperation> blend(const FilterOperation* /*from*/, double /*progress*/, const LayoutSize&, bool /*blendToPassthrough*/ = false)
83     {
84         ASSERT(blendingNeedsRendererSize());
85         return 0;
86     }
87
88     OperationType type() const { return m_type; }
89
90     bool isBasicColorMatrixFilterOperation() const
91     {
92         return m_type == GRAYSCALE || m_type == SEPIA || m_type == SATURATE || m_type == HUE_ROTATE;
93     }
94
95     bool isBasicComponentTransferFilterOperation() const
96     {
97         return m_type == INVERT || m_type == BRIGHTNESS || m_type == CONTRAST || m_type == OPACITY;
98     }
99
100     bool isSameType(const FilterOperation& o) const { return o.type() == m_type; }
101
102     // True if the alpha channel of any pixel can change under this operation.
103     virtual bool affectsOpacity() const { return false; }
104     // True if the the value of one pixel can affect the value of another pixel under this operation, such as blur.
105     virtual bool movesPixels() const { return false; }
106     // True if the filter needs the size of the box in order to calculate the animations.
107     virtual bool blendingNeedsRendererSize() const { return false; }
108
109 protected:
110     FilterOperation(OperationType type)
111         : m_type(type)
112     {
113     }
114
115     OperationType m_type;
116 };
117
118 class WEBCORE_EXPORT DefaultFilterOperation : public FilterOperation {
119 public:
120     static PassRefPtr<DefaultFilterOperation> create(OperationType representedType)
121     {
122         return adoptRef(new DefaultFilterOperation(representedType));
123     }
124
125     PassRefPtr<FilterOperation> clone() const override
126     {
127         return adoptRef(new DefaultFilterOperation(representedType()));
128     }
129
130     OperationType representedType() const { return m_representedType; }
131
132 private:
133     bool operator==(const FilterOperation&) const override;
134
135     DefaultFilterOperation(OperationType representedType)
136         : FilterOperation(DEFAULT)
137         , m_representedType(representedType)
138     {
139     }
140
141     OperationType m_representedType;
142 };
143
144 class PassthroughFilterOperation : public FilterOperation {
145 public:
146     static PassRefPtr<PassthroughFilterOperation> create()
147     {
148         return adoptRef(new PassthroughFilterOperation());
149     }
150
151     PassRefPtr<FilterOperation> clone() const override
152     {
153         return adoptRef(new PassthroughFilterOperation());
154     }
155
156 private:
157     bool operator==(const FilterOperation& o) const override
158     {
159         return isSameType(o);
160     }
161
162     PassthroughFilterOperation()
163         : FilterOperation(PASSTHROUGH)
164     {
165     }
166 };
167
168 class ReferenceFilterOperation : public FilterOperation {
169 public:
170     static PassRefPtr<ReferenceFilterOperation> create(const String& url, const String& fragment)
171     {
172         return adoptRef(new ReferenceFilterOperation(url, fragment));
173     }
174     virtual ~ReferenceFilterOperation();
175
176     PassRefPtr<FilterOperation> clone() const override
177     {
178         // Reference filters cannot be cloned.
179         ASSERT_NOT_REACHED();
180         return nullptr;
181     }
182
183     bool affectsOpacity() const override { return true; }
184     bool movesPixels() const override { return true; }
185
186     const String& url() const { return m_url; }
187     const String& fragment() const { return m_fragment; }
188
189     void loadExternalDocumentIfNeeded(CachedResourceLoader&, const ResourceLoaderOptions&);
190
191     CachedSVGDocumentReference* cachedSVGDocumentReference() const { return m_cachedSVGDocumentReference.get(); }
192
193     FilterEffect* filterEffect() const { return m_filterEffect.get(); }
194     void setFilterEffect(PassRefPtr<FilterEffect>);
195
196 private:
197     ReferenceFilterOperation(const String& url, const String& fragment);
198
199     bool operator==(const FilterOperation&) const override;
200
201     String m_url;
202     String m_fragment;
203     std::unique_ptr<CachedSVGDocumentReference> m_cachedSVGDocumentReference;
204     RefPtr<FilterEffect> m_filterEffect;
205 };
206
207 // GRAYSCALE, SEPIA, SATURATE and HUE_ROTATE are variations on a basic color matrix effect.
208 // For HUE_ROTATE, the angle of rotation is stored in m_amount.
209 class WEBCORE_EXPORT BasicColorMatrixFilterOperation : public FilterOperation {
210 public:
211     static PassRefPtr<BasicColorMatrixFilterOperation> create(double amount, OperationType type)
212     {
213         return adoptRef(new BasicColorMatrixFilterOperation(amount, type));
214     }
215
216     PassRefPtr<FilterOperation> clone() const override
217     {
218         return adoptRef(new BasicColorMatrixFilterOperation(amount(), type()));
219     }
220
221     double amount() const { return m_amount; }
222
223     PassRefPtr<FilterOperation> blend(const FilterOperation* from, double progress, bool blendToPassthrough = false) override;
224
225 private:
226     bool operator==(const FilterOperation&) const override;
227
228     double passthroughAmount() const;
229
230     BasicColorMatrixFilterOperation(double amount, OperationType type)
231         : FilterOperation(type)
232         , m_amount(amount)
233     {
234     }
235
236     double m_amount;
237 };
238
239 // INVERT, BRIGHTNESS, CONTRAST and OPACITY are variations on a basic component transfer effect.
240 class WEBCORE_EXPORT BasicComponentTransferFilterOperation : public FilterOperation {
241 public:
242     static PassRefPtr<BasicComponentTransferFilterOperation> create(double amount, OperationType type)
243     {
244         return adoptRef(new BasicComponentTransferFilterOperation(amount, type));
245     }
246
247     PassRefPtr<FilterOperation> clone() const override
248     {
249         return adoptRef(new BasicComponentTransferFilterOperation(amount(), type()));
250     }
251
252     double amount() const { return m_amount; }
253
254     bool affectsOpacity() const override { return m_type == OPACITY; }
255
256     PassRefPtr<FilterOperation> blend(const FilterOperation* from, double progress, bool blendToPassthrough = false) override;
257
258 private:
259     bool operator==(const FilterOperation&) const override;
260
261     double passthroughAmount() const;
262
263     BasicComponentTransferFilterOperation(double amount, OperationType type)
264         : FilterOperation(type)
265         , m_amount(amount)
266     {
267     }
268
269     double m_amount;
270 };
271
272 class WEBCORE_EXPORT BlurFilterOperation : public FilterOperation {
273 public:
274     static PassRefPtr<BlurFilterOperation> create(Length stdDeviation)
275     {
276         return adoptRef(new BlurFilterOperation(WTFMove(stdDeviation)));
277     }
278
279     PassRefPtr<FilterOperation> clone() const override
280     {
281         return adoptRef(new BlurFilterOperation(stdDeviation()));
282     }
283
284     const Length& stdDeviation() const { return m_stdDeviation; }
285
286     bool affectsOpacity() const override { return true; }
287     bool movesPixels() const override { return true; }
288
289     PassRefPtr<FilterOperation> blend(const FilterOperation* from, double progress, bool blendToPassthrough = false) override;
290
291 private:
292     bool operator==(const FilterOperation&) const override;
293
294     BlurFilterOperation(Length stdDeviation)
295         : FilterOperation(BLUR)
296         , m_stdDeviation(WTFMove(stdDeviation))
297     {
298     }
299
300     Length m_stdDeviation;
301 };
302
303 class WEBCORE_EXPORT DropShadowFilterOperation : public FilterOperation {
304 public:
305     static PassRefPtr<DropShadowFilterOperation> create(const IntPoint& location, int stdDeviation, const Color& color)
306     {
307         return adoptRef(new DropShadowFilterOperation(location, stdDeviation, color));
308     }
309
310     PassRefPtr<FilterOperation> clone() const override
311     {
312         return adoptRef(new DropShadowFilterOperation(location(), stdDeviation(), color()));
313     }
314
315     int x() const { return m_location.x(); }
316     int y() const { return m_location.y(); }
317     IntPoint location() const { return m_location; }
318     int stdDeviation() const { return m_stdDeviation; }
319     const Color& color() const { return m_color; }
320
321     bool affectsOpacity() const override { return true; }
322     bool movesPixels() const override { return true; }
323
324     PassRefPtr<FilterOperation> blend(const FilterOperation* from, double progress, bool blendToPassthrough = false) override;
325
326 private:
327     bool operator==(const FilterOperation&) const override;
328
329     DropShadowFilterOperation(const IntPoint& location, int stdDeviation, const Color& color)
330         : FilterOperation(DROP_SHADOW)
331         , m_location(location)
332         , m_stdDeviation(stdDeviation)
333         , m_color(color)
334     {
335     }
336
337     IntPoint m_location; // FIXME: should location be in Lengths?
338     int m_stdDeviation;
339     Color m_color;
340 };
341
342 WEBCORE_EXPORT TextStream& operator<<(TextStream&, const FilterOperation&);
343
344 } // namespace WebCore
345
346 #define SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(ToValueTypeName, predicate) \
347 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
348     static bool isType(const WebCore::FilterOperation& operation) { return operation.predicate; } \
349 SPECIALIZE_TYPE_TRAITS_END()
350
351 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(DefaultFilterOperation, type() == WebCore::FilterOperation::DEFAULT)
352 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(PassthroughFilterOperation, type() == WebCore::FilterOperation::PASSTHROUGH)
353 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(ReferenceFilterOperation, type() == WebCore::FilterOperation::REFERENCE)
354 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(BasicColorMatrixFilterOperation, isBasicColorMatrixFilterOperation())
355 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(BasicComponentTransferFilterOperation, isBasicComponentTransferFilterOperation())
356 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(BlurFilterOperation, type() == WebCore::FilterOperation::BLUR)
357 SPECIALIZE_TYPE_TRAITS_FILTEROPERATION(DropShadowFilterOperation, type() == WebCore::FilterOperation::DROP_SHADOW)
358
359 #endif // FilterOperation_h