Remove some dead and unneeded code (ScrollbarThemeSafari, RenderThemeSafari, OPENCL...
[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 #ifndef FilterEffect_h
23 #define FilterEffect_h
24
25 #include "ColorSpace.h"
26 #include "FloatRect.h"
27 #include "IntRect.h"
28 #include <runtime/Uint8ClampedArray.h>
29 #include <wtf/RefCounted.h>
30 #include <wtf/RefPtr.h>
31 #include <wtf/Vector.h>
32
33 namespace WebCore {
34
35 class Filter;
36 class FilterEffect;
37 class ImageBuffer;
38 class TextStream;
39
40 typedef Vector<RefPtr<FilterEffect>> FilterEffectVector;
41
42 enum FilterEffectType {
43     FilterEffectTypeUnknown,
44     FilterEffectTypeImage,
45     FilterEffectTypeTile,
46     FilterEffectTypeSourceInput
47 };
48
49 class FilterEffect : public RefCounted<FilterEffect> {
50 public:
51     virtual ~FilterEffect();
52
53     void clearResult();
54     void clearResultsRecursive();
55
56     ImageBuffer* asImageBuffer();
57     PassRefPtr<Uint8ClampedArray> asUnmultipliedImage(const IntRect&);
58     PassRefPtr<Uint8ClampedArray> asPremultipliedImage(const IntRect&);
59     void copyUnmultipliedImage(Uint8ClampedArray* destination, const IntRect&);
60     void copyPremultipliedImage(Uint8ClampedArray* destination, const IntRect&);
61
62 #if ENABLE(OPENCL)
63     OpenCLHandle openCLImage() { return m_openCLImageResult; }
64     void setOpenCLImage(OpenCLHandle openCLImage) { m_openCLImageResult = openCLImage; }
65     ImageBuffer* openCLImageToImageBuffer();
66 #endif
67
68     FilterEffectVector& inputEffects() { return m_inputEffects; }
69     FilterEffect* inputEffect(unsigned) const;
70     unsigned numberOfEffectInputs() const { return m_inputEffects.size(); }
71     unsigned totalNumberOfEffectInputs() const;
72     
73     inline bool hasResult() const
74     {
75         // This function needs platform specific checks, if the memory managment is not done by FilterEffect.
76         return m_imageBufferResult
77 #if ENABLE(OPENCL)
78             || m_openCLImageResult
79 #endif
80             || m_unmultipliedImageResult
81             || m_premultipliedImageResult;
82     }
83
84     FloatRect drawingRegionOfInputImage(const IntRect&) const;
85     IntRect requestedRegionOfInputImageData(const IntRect&) const;
86
87     // Solid black image with different alpha values.
88     bool isAlphaImage() const { return m_alphaImage; }
89     void setIsAlphaImage(bool alphaImage) { m_alphaImage = alphaImage; }
90
91     IntRect absolutePaintRect() const { return m_absolutePaintRect; }
92     void setAbsolutePaintRect(const IntRect& absolutePaintRect) { m_absolutePaintRect = absolutePaintRect; }
93
94     FloatRect maxEffectRect() const { return m_maxEffectRect; }
95     void setMaxEffectRect(const FloatRect& maxEffectRect) { m_maxEffectRect = maxEffectRect; } 
96
97     void apply();
98 #if ENABLE(OPENCL)
99     void applyAll();
100 #else
101     inline void applyAll() { apply(); }
102 #endif
103
104     // Correct any invalid pixels, if necessary, in the result of a filter operation.
105     // This method is used to ensure valid pixel values on filter inputs and the final result.
106     // Only the arithmetic composite filter ever needs to perform correction.
107     virtual void correctFilterResultIfNeeded() { }
108
109     virtual void platformApplySoftware() = 0;
110 #if ENABLE(OPENCL)
111     virtual bool platformApplyOpenCL();
112 #endif
113     virtual void dump() = 0;
114
115     virtual void determineAbsolutePaintRect();
116
117     virtual FilterEffectType filterEffectType() const { return FilterEffectTypeUnknown; }
118
119     virtual TextStream& externalRepresentation(TextStream&, int indention = 0) const;
120
121 public:
122     // The following functions are SVG specific and will move to RenderSVGResourceFilterPrimitive.
123     // See bug https://bugs.webkit.org/show_bug.cgi?id=45614.
124     bool hasX() const { return m_hasX; }
125     void setHasX(bool value) { m_hasX = value; }
126
127     bool hasY() const { return m_hasY; }
128     void setHasY(bool value) { m_hasY = value; }
129
130     bool hasWidth() const { return m_hasWidth; }
131     void setHasWidth(bool value) { m_hasWidth = value; }
132
133     bool hasHeight() const { return m_hasHeight; }
134     void setHasHeight(bool value) { m_hasHeight = value; }
135
136     FloatRect filterPrimitiveSubregion() const { return m_filterPrimitiveSubregion; }
137     void setFilterPrimitiveSubregion(const FloatRect& filterPrimitiveSubregion) { m_filterPrimitiveSubregion = filterPrimitiveSubregion; }
138
139     FloatRect effectBoundaries() const { return m_effectBoundaries; }
140     void setEffectBoundaries(const FloatRect& effectBoundaries) { m_effectBoundaries = effectBoundaries; }
141
142     Filter& filter() { return m_filter; }
143
144     bool clipsToBounds() const { return m_clipsToBounds; }
145     void setClipsToBounds(bool value) { m_clipsToBounds = value; }
146
147     ColorSpace operatingColorSpace() const { return m_operatingColorSpace; }
148     virtual void setOperatingColorSpace(ColorSpace colorSpace) { m_operatingColorSpace = colorSpace; }
149     ColorSpace resultColorSpace() const { return m_resultColorSpace; }
150     virtual void setResultColorSpace(ColorSpace colorSpace) { m_resultColorSpace = colorSpace; }
151
152     virtual void transformResultColorSpace(FilterEffect* in, const int) { in->transformResultColorSpace(m_operatingColorSpace); }
153     void transformResultColorSpace(ColorSpace);
154
155 protected:
156     FilterEffect(Filter&);
157
158     ImageBuffer* createImageBufferResult();
159     Uint8ClampedArray* createUnmultipliedImageResult();
160     Uint8ClampedArray* createPremultipliedImageResult();
161 #if ENABLE(OPENCL)
162     OpenCLHandle createOpenCLImageResult(uint8_t* = 0);
163 #endif
164
165     // Return true if the filter will only operate correctly on valid RGBA values, with
166     // alpha in [0,255] and each color component in [0, alpha].
167     virtual bool requiresValidPreMultipliedPixels() { return true; }
168
169     // If a pre-multiplied image, check every pixel for validity and correct if necessary.
170     void forceValidPreMultipliedPixels();
171
172     void clipAbsolutePaintRect();
173
174 private:
175     std::unique_ptr<ImageBuffer> m_imageBufferResult;
176     RefPtr<Uint8ClampedArray> m_unmultipliedImageResult;
177     RefPtr<Uint8ClampedArray> m_premultipliedImageResult;
178     FilterEffectVector m_inputEffects;
179 #if ENABLE(OPENCL)
180     OpenCLHandle m_openCLImageResult;
181 #endif
182
183     bool m_alphaImage;
184
185     IntRect m_absolutePaintRect;
186     
187     // The maximum size of a filter primitive. In SVG this is the primitive subregion in absolute coordinate space.
188     // The absolute paint rect should never be bigger than m_maxEffectRect.
189     FloatRect m_maxEffectRect;
190     Filter& m_filter;
191     
192 private:
193     inline void copyImageBytes(Uint8ClampedArray* source, Uint8ClampedArray* destination, const IntRect&);
194
195     // The following member variables are SVG specific and will move to RenderSVGResourceFilterPrimitive.
196     // See bug https://bugs.webkit.org/show_bug.cgi?id=45614.
197
198     // The subregion of a filter primitive according to the SVG Filter specification in local coordinates.
199     // This is SVG specific and needs to move to RenderSVGResourceFilterPrimitive.
200     FloatRect m_filterPrimitiveSubregion;
201
202     // x, y, width and height of the actual SVGFE*Element. Is needed to determine the subregion of the
203     // filter primitive on a later step.
204     FloatRect m_effectBoundaries;
205     bool m_hasX;
206     bool m_hasY;
207     bool m_hasWidth;
208     bool m_hasHeight;
209
210     // Should the effect clip to its primitive region, or expand to use the combined region of its inputs.
211     bool m_clipsToBounds;
212
213     ColorSpace m_operatingColorSpace;
214     ColorSpace m_resultColorSpace;
215 };
216
217 } // namespace WebCore
218
219 #endif // FilterEffect_h