8c26e2b339044d0d7a780c0aedbc7a3e1492cea4
[WebKit-https.git] / Source / WebCore / platform / graphics / filters / FilterEffect.h
1 /*
2  * Copyright (C) 2008 Alex Mathews <possessedpenguinbob@gmail.com>
3  * Copyright (C) 2009 Dirk Schulze <krit@webkit.org>
4  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #pragma once
23
24 #include "ColorSpace.h"
25 #include "FloatRect.h"
26 #include "IntRect.h"
27 #include <JavaScriptCore/Uint8ClampedArray.h>
28 #include <wtf/MathExtras.h>
29 #include <wtf/RefCounted.h>
30 #include <wtf/RefPtr.h>
31 #include <wtf/Vector.h>
32
33 namespace WTF {
34 class TextStream;
35 }
36
37 namespace WebCore {
38
39 class Filter;
40 class FilterEffect;
41 class ImageBuffer;
42
43 typedef Vector<RefPtr<FilterEffect>> FilterEffectVector;
44
45 enum FilterEffectType {
46     FilterEffectTypeUnknown,
47     FilterEffectTypeImage,
48     FilterEffectTypeTile,
49     FilterEffectTypeSourceInput
50 };
51
52 class FilterEffect : public RefCounted<FilterEffect> {
53 public:
54     virtual ~FilterEffect();
55
56     void clearResult();
57     void clearResultsRecursive();
58
59     ImageBuffer* imageBufferResult();
60     RefPtr<Uint8ClampedArray> unmultipliedResult(const IntRect&);
61     RefPtr<Uint8ClampedArray> premultipliedResult(const IntRect&);
62
63     void copyUnmultipliedResult(Uint8ClampedArray& destination, const IntRect&);
64     void copyPremultipliedResult(Uint8ClampedArray& destination, const IntRect&);
65
66     FilterEffectVector& inputEffects() { return m_inputEffects; }
67     FilterEffect* inputEffect(unsigned) const;
68     unsigned numberOfEffectInputs() const { return m_inputEffects.size(); }
69     unsigned totalNumberOfEffectInputs() const;
70     
71     inline bool hasResult() const
72     {
73         // This function needs platform specific checks, if the memory managment is not done by FilterEffect.
74         return m_imageBufferResult
75             || m_unmultipliedImageResult
76             || m_premultipliedImageResult;
77     }
78
79     FloatRect drawingRegionOfInputImage(const IntRect&) const;
80     IntRect requestedRegionOfInputImageData(const IntRect&) const;
81     
82     // Recurses on inputs.
83     FloatRect determineFilterPrimitiveSubregion();
84
85     // Solid black image with different alpha values.
86     bool isAlphaImage() const { return m_alphaImage; }
87     void setIsAlphaImage(bool alphaImage) { m_alphaImage = alphaImage; }
88
89     IntRect absolutePaintRect() const { return m_absolutePaintRect; }
90     void setAbsolutePaintRect(const IntRect& absolutePaintRect) { m_absolutePaintRect = absolutePaintRect; }
91
92     FloatRect maxEffectRect() const { return m_maxEffectRect; }
93     void setMaxEffectRect(const FloatRect& maxEffectRect) { m_maxEffectRect = maxEffectRect; } 
94
95     void apply();
96     inline void applyAll() { apply(); }
97
98     // Correct any invalid pixels, if necessary, in the result of a filter operation.
99     // This method is used to ensure valid pixel values on filter inputs and the final result.
100     // Only the arithmetic composite filter ever needs to perform correction.
101     virtual void correctFilterResultIfNeeded() { }
102
103     virtual void determineAbsolutePaintRect();
104
105     virtual FilterEffectType filterEffectType() const { return FilterEffectTypeUnknown; }
106
107     enum class RepresentationType { TestOutput, Debugging };
108     virtual WTF::TextStream& externalRepresentation(WTF::TextStream&, RepresentationType = RepresentationType::TestOutput) const;
109
110     // The following functions are SVG specific and will move to RenderSVGResourceFilterPrimitive.
111     // See bug https://bugs.webkit.org/show_bug.cgi?id=45614.
112     bool hasX() const { return m_hasX; }
113     void setHasX(bool value) { m_hasX = value; }
114
115     bool hasY() const { return m_hasY; }
116     void setHasY(bool value) { m_hasY = value; }
117
118     bool hasWidth() const { return m_hasWidth; }
119     void setHasWidth(bool value) { m_hasWidth = value; }
120
121     bool hasHeight() const { return m_hasHeight; }
122     void setHasHeight(bool value) { m_hasHeight = value; }
123
124     FloatRect filterPrimitiveSubregion() const { return m_filterPrimitiveSubregion; }
125     void setFilterPrimitiveSubregion(const FloatRect& filterPrimitiveSubregion) { m_filterPrimitiveSubregion = filterPrimitiveSubregion; }
126
127     FloatRect effectBoundaries() const { return m_effectBoundaries; }
128     void setEffectBoundaries(const FloatRect& effectBoundaries) { m_effectBoundaries = effectBoundaries; }
129     
130     void setUnclippedAbsoluteSubregion(const FloatRect& r) { m_absoluteUnclippedSubregion = r; }
131     
132     FloatPoint mapPointFromUserSpaceToBuffer(FloatPoint) const;
133
134     Filter& filter() { return m_filter; }
135     const Filter& filter() const { return m_filter; }
136
137     bool clipsToBounds() const { return m_clipsToBounds; }
138     void setClipsToBounds(bool value) { m_clipsToBounds = value; }
139
140     ColorSpace operatingColorSpace() const { return m_operatingColorSpace; }
141     virtual void setOperatingColorSpace(ColorSpace colorSpace) { m_operatingColorSpace = colorSpace; }
142     ColorSpace resultColorSpace() const { return m_resultColorSpace; }
143     virtual void setResultColorSpace(ColorSpace colorSpace) { m_resultColorSpace = colorSpace; }
144
145     virtual void transformResultColorSpace(FilterEffect* in, const int) { in->transformResultColorSpace(m_operatingColorSpace); }
146     void transformResultColorSpace(ColorSpace);
147
148 protected:
149     FilterEffect(Filter&);
150     
151     virtual const char* filterName() const = 0;
152
153     ImageBuffer* createImageBufferResult();
154     Uint8ClampedArray* createUnmultipliedImageResult();
155     Uint8ClampedArray* createPremultipliedImageResult();
156
157     // Return true if the filter will only operate correctly on valid RGBA values, with
158     // alpha in [0,255] and each color component in [0, alpha].
159     virtual bool requiresValidPreMultipliedPixels() { return true; }
160
161     // If a pre-multiplied image, check every pixel for validity and correct if necessary.
162     void forceValidPreMultipliedPixels();
163
164     void clipAbsolutePaintRect();
165     
166     static Vector<float> normalizedFloats(const Vector<float>& values)
167     {
168         Vector<float> normalizedValues(values.size());
169         for (size_t i = 0; i < values.size(); ++i)
170             normalizedValues[i] = normalizedFloat(values[i]);
171         return normalizedValues;
172     }
173
174 private:
175     virtual void platformApplySoftware() = 0;
176
177     void copyImageBytes(const Uint8ClampedArray& source, Uint8ClampedArray& destination, const IntRect&) const;
178
179     Filter& m_filter;
180     FilterEffectVector m_inputEffects;
181
182     std::unique_ptr<ImageBuffer> m_imageBufferResult;
183     RefPtr<Uint8ClampedArray> m_unmultipliedImageResult;
184     RefPtr<Uint8ClampedArray> m_premultipliedImageResult;
185
186     IntRect m_absolutePaintRect;
187     
188     // The maximum size of a filter primitive. In SVG this is the primitive subregion in absolute coordinate space.
189     // The absolute paint rect should never be bigger than m_maxEffectRect.
190     FloatRect m_maxEffectRect;
191     
192     // The subregion of a filter primitive according to the SVG Filter specification in local coordinates.
193     // This is SVG specific and needs to move to RenderSVGResourceFilterPrimitive.
194     FloatRect m_filterPrimitiveSubregion;
195
196     // x, y, width and height of the actual SVGFE*Element. Is needed to determine the subregion of the
197     // filter primitive on a later step.
198     FloatRect m_effectBoundaries;
199     
200     // filterPrimitiveSubregion mapped to absolute coordinates before clipping.
201     FloatRect m_absoluteUnclippedSubregion;
202
203     bool m_alphaImage { false };
204     bool m_hasX { false };
205     bool m_hasY { false };
206     bool m_hasWidth { false };
207     bool m_hasHeight { false };
208
209     // Should the effect clip to its primitive region, or expand to use the combined region of its inputs.
210     bool m_clipsToBounds { true };
211
212     ColorSpace m_operatingColorSpace { ColorSpaceLinearRGB };
213     ColorSpace m_resultColorSpace { ColorSpaceSRGB };
214 };
215
216 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, const FilterEffect&);
217
218 } // namespace WebCore
219