SkMatrixConvolutionImageFilter.cpp revision 025128811219dc45fd99b6c4d1d14f833cf7a26e
15d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)/*
2c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Copyright 2012 The Android Open Source Project
3c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) *
4c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Use of this source code is governed by a BSD-style license that can be
55d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) * found in the LICENSE file.
6c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */
7c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)
8c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "SkMatrixConvolutionImageFilter.h"
9c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "SkBitmap.h"
10c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "SkColorPriv.h"
11c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "SkFlattenableBuffers.h"
12c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "SkRect.h"
13c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "SkUnPreMultiply.h"
14c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)
15c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#if SK_SUPPORT_GPU
16c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "gl/GrGLEffect.h"
171e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles)#include "effects/GrSingleTextureEffect.h"
185d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "GrTBackendEffectFactory.h"
195d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "GrTexture.h"
20cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "SkMatrix.h"
21c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#endif
22c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)
23c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)static bool tile_mode_is_valid(SkMatrixConvolutionImageFilter::TileMode tileMode) {
24c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    switch (tileMode) {
25c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    case SkMatrixConvolutionImageFilter::kClamp_TileMode:
26c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    case SkMatrixConvolutionImageFilter::kRepeat_TileMode:
275d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    case SkMatrixConvolutionImageFilter::kClampToBlack_TileMode:
28c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)        return true;
295d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    default:
305d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)        break;
315d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    }
32116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch    return false;
33c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)}
34116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch
35116680a4aac90f2aa7413d9095a592090648e557Ben MurdochSkMatrixConvolutionImageFilter::SkMatrixConvolutionImageFilter(
36116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch    const SkISize& kernelSize,
37c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    const SkScalar* kernel,
38c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    SkScalar gain,
39c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    SkScalar bias,
40c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    const SkIPoint& target,
41c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    TileMode tileMode,
42c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    bool convolveAlpha,
43e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch    SkImageFilter* input,
44e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch    const CropRect* cropRect)
45e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch  : INHERITED(input, cropRect),
460529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch    fKernelSize(kernelSize),
476d86b77056ed63eb6871182f42a9fd5f07550f90Torne (Richard Coles)    fGain(gain),
486d86b77056ed63eb6871182f42a9fd5f07550f90Torne (Richard Coles)    fBias(bias),
496d86b77056ed63eb6871182f42a9fd5f07550f90Torne (Richard Coles)    fTarget(target),
506d86b77056ed63eb6871182f42a9fd5f07550f90Torne (Richard Coles)    fTileMode(tileMode),
516d86b77056ed63eb6871182f42a9fd5f07550f90Torne (Richard Coles)    fConvolveAlpha(convolveAlpha) {
52c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    uint32_t size = fKernelSize.fWidth * fKernelSize.fHeight;
53c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    fKernel = SkNEW_ARRAY(SkScalar, size);
54c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    memcpy(fKernel, kernel, size * sizeof(SkScalar));
555d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    SkASSERT(kernelSize.fWidth >= 1 && kernelSize.fHeight >= 1);
56c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    SkASSERT(target.fX >= 0 && target.fX < kernelSize.fWidth);
575d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    SkASSERT(target.fY >= 0 && target.fY < kernelSize.fHeight);
58c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)}
59c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)
60c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)SkMatrixConvolutionImageFilter::SkMatrixConvolutionImageFilter(SkFlattenableReadBuffer& buffer)
61c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    : INHERITED(buffer) {
62c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    // We need to be able to read at most SK_MaxS32 bytes, so divide that
63c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    // by the size of a scalar to know how many scalars we can read.
645d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    static const int32_t kMaxSize = SK_MaxS32 / sizeof(SkScalar);
655d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    fKernelSize.fWidth = buffer.readInt();
665d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    fKernelSize.fHeight = buffer.readInt();
675d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    if ((fKernelSize.fWidth >= 1) && (fKernelSize.fHeight >= 1) &&
68c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)        // Make sure size won't be larger than a signed int,
69c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)        // which would still be extremely large for a kernel,
70c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)        // but we don't impose a hard limit for kernel size
71c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)        (kMaxSize / fKernelSize.fWidth >= fKernelSize.fHeight)) {
72c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)        size_t size = fKernelSize.fWidth * fKernelSize.fHeight;
73c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)        fKernel = SkNEW_ARRAY(SkScalar, size);
74c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)        SkDEBUGCODE(bool success =) buffer.readScalarArray(fKernel, size);
75c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)        SkASSERT(success);
765d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    } else {
77c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)        fKernel = 0;
78c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    }
79c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    fGain = buffer.readScalar();
80c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    fBias = buffer.readScalar();
81c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    fTarget.fX = buffer.readInt();
82c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    fTarget.fY = buffer.readInt();
83c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    fTileMode = (TileMode) buffer.readInt();
84c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    fConvolveAlpha = buffer.readBool();
855d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    buffer.validate((fKernel != 0) &&
86c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)                    SkScalarIsFinite(fGain) &&
87c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)                    SkScalarIsFinite(fBias) &&
88c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)                    tile_mode_is_valid(fTileMode));
89c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)}
90c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)
91c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)void SkMatrixConvolutionImageFilter::flatten(SkFlattenableWriteBuffer& buffer) const {
92c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    this->INHERITED::flatten(buffer);
93c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    buffer.writeInt(fKernelSize.fWidth);
945d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    buffer.writeInt(fKernelSize.fHeight);
955d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    buffer.writeScalarArray(fKernel, fKernelSize.fWidth * fKernelSize.fHeight);
96c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    buffer.writeScalar(fGain);
97c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    buffer.writeScalar(fBias);
98c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    buffer.writeInt(fTarget.fX);
99c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    buffer.writeInt(fTarget.fY);
100c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    buffer.writeInt((int) fTileMode);
1015d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    buffer.writeBool(fConvolveAlpha);
102f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)}
103c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)
104c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)SkMatrixConvolutionImageFilter::~SkMatrixConvolutionImageFilter() {
1055f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)    delete[] fKernel;
106c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)}
107c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)
108c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)class UncheckedPixelFetcher {
109c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)public:
110c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    static inline SkPMColor fetch(const SkBitmap& src, int x, int y, const SkIRect& bounds) {
111c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)        return *src.getAddr32(x, y);
112c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    }
113};
114
115class ClampPixelFetcher {
116public:
117    static inline SkPMColor fetch(const SkBitmap& src, int x, int y, const SkIRect& bounds) {
118        x = SkPin32(x, bounds.fLeft, bounds.fRight - 1);
119        y = SkPin32(y, bounds.fTop, bounds.fBottom - 1);
120        return *src.getAddr32(x, y);
121    }
122};
123
124class RepeatPixelFetcher {
125public:
126    static inline SkPMColor fetch(const SkBitmap& src, int x, int y, const SkIRect& bounds) {
127        x = (x - bounds.left()) % bounds.width() + bounds.left();
128        y = (y - bounds.top()) % bounds.height() + bounds.top();
129        if (x < bounds.left()) {
130            x += bounds.width();
131        }
132        if (y < bounds.top()) {
133            y += bounds.height();
134        }
135        return *src.getAddr32(x, y);
136    }
137};
138
139class ClampToBlackPixelFetcher {
140public:
141    static inline SkPMColor fetch(const SkBitmap& src, int x, int y, const SkIRect& bounds) {
142        if (x < bounds.fLeft || x >= bounds.fRight || y < bounds.fTop || y >= bounds.fBottom) {
143            return 0;
144        } else {
145            return *src.getAddr32(x, y);
146        }
147    }
148};
149
150template<class PixelFetcher, bool convolveAlpha>
151void SkMatrixConvolutionImageFilter::filterPixels(const SkBitmap& src,
152                                                  SkBitmap* result,
153                                                  const SkIRect& rect,
154                                                  const SkIRect& bounds) {
155    for (int y = rect.fTop; y < rect.fBottom; ++y) {
156        SkPMColor* dptr = result->getAddr32(rect.fLeft - bounds.fLeft, y - bounds.fTop);
157        for (int x = rect.fLeft; x < rect.fRight; ++x) {
158            SkScalar sumA = 0, sumR = 0, sumG = 0, sumB = 0;
159            for (int cy = 0; cy < fKernelSize.fHeight; cy++) {
160                for (int cx = 0; cx < fKernelSize.fWidth; cx++) {
161                    SkPMColor s = PixelFetcher::fetch(src,
162                                                      x + cx - fTarget.fX,
163                                                      y + cy - fTarget.fY,
164                                                      bounds);
165                    SkScalar k = fKernel[cy * fKernelSize.fWidth + cx];
166                    if (convolveAlpha) {
167                        sumA += SkScalarMul(SkIntToScalar(SkGetPackedA32(s)), k);
168                    }
169                    sumR += SkScalarMul(SkIntToScalar(SkGetPackedR32(s)), k);
170                    sumG += SkScalarMul(SkIntToScalar(SkGetPackedG32(s)), k);
171                    sumB += SkScalarMul(SkIntToScalar(SkGetPackedB32(s)), k);
172                }
173            }
174            int a = convolveAlpha
175                  ? SkClampMax(SkScalarFloorToInt(SkScalarMul(sumA, fGain) + fBias), 255)
176                  : 255;
177            int r = SkClampMax(SkScalarFloorToInt(SkScalarMul(sumR, fGain) + fBias), a);
178            int g = SkClampMax(SkScalarFloorToInt(SkScalarMul(sumG, fGain) + fBias), a);
179            int b = SkClampMax(SkScalarFloorToInt(SkScalarMul(sumB, fGain) + fBias), a);
180            if (!convolveAlpha) {
181                a = SkGetPackedA32(PixelFetcher::fetch(src, x, y, bounds));
182                *dptr++ = SkPreMultiplyARGB(a, r, g, b);
183            } else {
184                *dptr++ = SkPackARGB32(a, r, g, b);
185            }
186        }
187    }
188}
189
190template<class PixelFetcher>
191void SkMatrixConvolutionImageFilter::filterPixels(const SkBitmap& src,
192                                                  SkBitmap* result,
193                                                  const SkIRect& rect,
194                                                  const SkIRect& bounds) {
195    if (fConvolveAlpha) {
196        filterPixels<PixelFetcher, true>(src, result, rect, bounds);
197    } else {
198        filterPixels<PixelFetcher, false>(src, result, rect, bounds);
199    }
200}
201
202void SkMatrixConvolutionImageFilter::filterInteriorPixels(const SkBitmap& src,
203                                                          SkBitmap* result,
204                                                          const SkIRect& rect,
205                                                          const SkIRect& bounds) {
206    filterPixels<UncheckedPixelFetcher>(src, result, rect, bounds);
207}
208
209void SkMatrixConvolutionImageFilter::filterBorderPixels(const SkBitmap& src,
210                                                        SkBitmap* result,
211                                                        const SkIRect& rect,
212                                                        const SkIRect& bounds) {
213    switch (fTileMode) {
214        case kClamp_TileMode:
215            filterPixels<ClampPixelFetcher>(src, result, rect, bounds);
216            break;
217        case kRepeat_TileMode:
218            filterPixels<RepeatPixelFetcher>(src, result, rect, bounds);
219            break;
220        case kClampToBlack_TileMode:
221            filterPixels<ClampToBlackPixelFetcher>(src, result, rect, bounds);
222            break;
223    }
224}
225
226// FIXME:  This should be refactored to SkImageFilterUtils for
227// use by other filters.  For now, we assume the input is always
228// premultiplied and unpremultiply it
229static SkBitmap unpremultiplyBitmap(const SkBitmap& src)
230{
231    SkAutoLockPixels alp(src);
232    if (!src.getPixels()) {
233        return SkBitmap();
234    }
235    SkBitmap result;
236    result.setConfig(src.config(), src.width(), src.height());
237    result.allocPixels();
238    if (!result.getPixels()) {
239        return SkBitmap();
240    }
241    for (int y = 0; y < src.height(); ++y) {
242        const uint32_t* srcRow = src.getAddr32(0, y);
243        uint32_t* dstRow = result.getAddr32(0, y);
244        for (int x = 0; x < src.width(); ++x) {
245            dstRow[x] = SkUnPreMultiply::PMColorToColor(srcRow[x]);
246        }
247    }
248    return result;
249}
250
251bool SkMatrixConvolutionImageFilter::onFilterImage(Proxy* proxy,
252                                                   const SkBitmap& source,
253                                                   const SkMatrix& matrix,
254                                                   SkBitmap* result,
255                                                   SkIPoint* loc) {
256    SkBitmap src = source;
257    if (getInput(0) && !getInput(0)->filterImage(proxy, source, matrix, &src, loc)) {
258        return false;
259    }
260
261    if (src.config() != SkBitmap::kARGB_8888_Config) {
262        return false;
263    }
264
265    SkIRect bounds;
266    src.getBounds(&bounds);
267    if (!this->applyCropRect(&bounds, matrix)) {
268        return false;
269    }
270
271    if (!fConvolveAlpha && !src.isOpaque()) {
272        src = unpremultiplyBitmap(src);
273    }
274
275    SkAutoLockPixels alp(src);
276    if (!src.getPixels()) {
277        return false;
278    }
279
280    result->setConfig(src.config(), bounds.width(), bounds.height());
281    result->allocPixels();
282
283    SkIRect interior = SkIRect::MakeXYWH(bounds.left() + fTarget.fX,
284                                         bounds.top() + fTarget.fY,
285                                         bounds.width() - fKernelSize.fWidth + 1,
286                                         bounds.height() - fKernelSize.fHeight + 1);
287    SkIRect top = SkIRect::MakeLTRB(bounds.left(), bounds.top(), bounds.right(), interior.top());
288    SkIRect bottom = SkIRect::MakeLTRB(bounds.left(), interior.bottom(),
289                                       bounds.right(), bounds.bottom());
290    SkIRect left = SkIRect::MakeLTRB(bounds.left(), interior.top(),
291                                     interior.left(), interior.bottom());
292    SkIRect right = SkIRect::MakeLTRB(interior.right(), interior.top(),
293                                      bounds.right(), interior.bottom());
294    filterBorderPixels(src, result, top, bounds);
295    filterBorderPixels(src, result, left, bounds);
296    filterInteriorPixels(src, result, interior, bounds);
297    filterBorderPixels(src, result, right, bounds);
298    filterBorderPixels(src, result, bottom, bounds);
299    loc->fX += bounds.fLeft;
300    loc->fY += bounds.fTop;
301    return true;
302}
303
304#if SK_SUPPORT_GPU
305
306///////////////////////////////////////////////////////////////////////////////
307
308class GrGLMatrixConvolutionEffect;
309
310class GrMatrixConvolutionEffect : public GrSingleTextureEffect {
311public:
312    typedef SkMatrixConvolutionImageFilter::TileMode TileMode;
313    static GrEffectRef* Create(GrTexture* texture,
314                               const SkIRect& bounds,
315                               const SkISize& kernelSize,
316                               const SkScalar* kernel,
317                               SkScalar gain,
318                               SkScalar bias,
319                               const SkIPoint& target,
320                               TileMode tileMode,
321                               bool convolveAlpha) {
322        AutoEffectUnref effect(SkNEW_ARGS(GrMatrixConvolutionEffect, (texture,
323                                                                      bounds,
324                                                                      kernelSize,
325                                                                      kernel,
326                                                                      gain,
327                                                                      bias,
328                                                                      target,
329                                                                      tileMode,
330                                                                      convolveAlpha)));
331        return CreateEffectRef(effect);
332    }
333    virtual ~GrMatrixConvolutionEffect();
334
335    virtual void getConstantColorComponents(GrColor* color,
336                                            uint32_t* validFlags) const SK_OVERRIDE {
337        // TODO: Try to do better?
338        *validFlags = 0;
339    }
340
341    static const char* Name() { return "MatrixConvolution"; }
342    const SkIRect& bounds() const { return fBounds; }
343    const SkISize& kernelSize() const { return fKernelSize; }
344    const float* target() const { return fTarget; }
345    const float* kernel() const { return fKernel; }
346    float gain() const { return fGain; }
347    float bias() const { return fBias; }
348    TileMode tileMode() const { return fTileMode; }
349    bool convolveAlpha() const { return fConvolveAlpha; }
350
351    typedef GrGLMatrixConvolutionEffect GLEffect;
352
353    virtual const GrBackendEffectFactory& getFactory() const SK_OVERRIDE;
354
355private:
356    GrMatrixConvolutionEffect(GrTexture*,
357                              const SkIRect& bounds,
358                              const SkISize& kernelSize,
359                              const SkScalar* kernel,
360                              SkScalar gain,
361                              SkScalar bias,
362                              const SkIPoint& target,
363                              TileMode tileMode,
364                              bool convolveAlpha);
365
366    virtual bool onIsEqual(const GrEffect&) const SK_OVERRIDE;
367
368    SkIRect  fBounds;
369    SkISize  fKernelSize;
370    float   *fKernel;
371    float    fGain;
372    float    fBias;
373    float    fTarget[2];
374    TileMode fTileMode;
375    bool     fConvolveAlpha;
376
377    GR_DECLARE_EFFECT_TEST;
378
379    typedef GrSingleTextureEffect INHERITED;
380};
381
382class GrGLMatrixConvolutionEffect : public GrGLEffect {
383public:
384    GrGLMatrixConvolutionEffect(const GrBackendEffectFactory& factory,
385                                const GrDrawEffect& effect);
386    virtual void emitCode(GrGLShaderBuilder*,
387                          const GrDrawEffect&,
388                          EffectKey,
389                          const char* outputColor,
390                          const char* inputColor,
391                          const TransformedCoordsArray&,
392                          const TextureSamplerArray&) SK_OVERRIDE;
393
394    static inline EffectKey GenKey(const GrDrawEffect&, const GrGLCaps&);
395
396    virtual void setData(const GrGLUniformManager&, const GrDrawEffect&) SK_OVERRIDE;
397
398private:
399    typedef GrGLUniformManager::UniformHandle        UniformHandle;
400    typedef SkMatrixConvolutionImageFilter::TileMode TileMode;
401    SkISize             fKernelSize;
402    TileMode            fTileMode;
403    bool                fConvolveAlpha;
404
405    UniformHandle       fBoundsUni;
406    UniformHandle       fKernelUni;
407    UniformHandle       fImageIncrementUni;
408    UniformHandle       fTargetUni;
409    UniformHandle       fGainUni;
410    UniformHandle       fBiasUni;
411
412    typedef GrGLEffect INHERITED;
413};
414
415GrGLMatrixConvolutionEffect::GrGLMatrixConvolutionEffect(const GrBackendEffectFactory& factory,
416                                                         const GrDrawEffect& drawEffect)
417    : INHERITED(factory) {
418    const GrMatrixConvolutionEffect& m = drawEffect.castEffect<GrMatrixConvolutionEffect>();
419    fKernelSize = m.kernelSize();
420    fTileMode = m.tileMode();
421    fConvolveAlpha = m.convolveAlpha();
422}
423
424static void appendTextureLookup(GrGLShaderBuilder* builder,
425                                const GrGLShaderBuilder::TextureSampler& sampler,
426                                const char* coord,
427                                const char* bounds,
428                                SkMatrixConvolutionImageFilter::TileMode tileMode) {
429    SkString clampedCoord;
430    switch (tileMode) {
431        case SkMatrixConvolutionImageFilter::kClamp_TileMode:
432            clampedCoord.printf("clamp(%s, %s.xy, %s.zw)", coord, bounds, bounds);
433            coord = clampedCoord.c_str();
434            break;
435        case SkMatrixConvolutionImageFilter::kRepeat_TileMode:
436            clampedCoord.printf("mod(%s - %s.xy, %s.zw - %s.xy) + %s.xy", coord, bounds, bounds, bounds, bounds);
437            coord = clampedCoord.c_str();
438            break;
439        case SkMatrixConvolutionImageFilter::kClampToBlack_TileMode:
440            builder->fsCodeAppendf("clamp(%s, %s.xy, %s.zw) != %s ? vec4(0, 0, 0, 0) : ", coord, bounds, bounds, coord);
441            break;
442    }
443    builder->fsAppendTextureLookup(sampler, coord);
444}
445
446void GrGLMatrixConvolutionEffect::emitCode(GrGLShaderBuilder* builder,
447                                           const GrDrawEffect&,
448                                           EffectKey key,
449                                           const char* outputColor,
450                                           const char* inputColor,
451                                           const TransformedCoordsArray& coords,
452                                           const TextureSamplerArray& samplers) {
453    sk_ignore_unused_variable(inputColor);
454    SkString coords2D = builder->ensureFSCoords2D(coords, 0);
455    fBoundsUni = builder->addUniform(GrGLShaderBuilder::kFragment_Visibility,
456                                     kVec4f_GrSLType, "Bounds");
457    fImageIncrementUni = builder->addUniform(GrGLShaderBuilder::kFragment_Visibility,
458                                             kVec2f_GrSLType, "ImageIncrement");
459    fKernelUni = builder->addUniformArray(GrGLShaderBuilder::kFragment_Visibility,
460                                             kFloat_GrSLType,
461                                             "Kernel",
462                                             fKernelSize.width() * fKernelSize.height());
463    fTargetUni = builder->addUniform(GrGLShaderBuilder::kFragment_Visibility,
464                                             kVec2f_GrSLType, "Target");
465    fGainUni = builder->addUniform(GrGLShaderBuilder::kFragment_Visibility,
466                                   kFloat_GrSLType, "Gain");
467    fBiasUni = builder->addUniform(GrGLShaderBuilder::kFragment_Visibility,
468                                   kFloat_GrSLType, "Bias");
469
470    const char* bounds = builder->getUniformCStr(fBoundsUni);
471    const char* target = builder->getUniformCStr(fTargetUni);
472    const char* imgInc = builder->getUniformCStr(fImageIncrementUni);
473    const char* kernel = builder->getUniformCStr(fKernelUni);
474    const char* gain = builder->getUniformCStr(fGainUni);
475    const char* bias = builder->getUniformCStr(fBiasUni);
476    int kWidth = fKernelSize.width();
477    int kHeight = fKernelSize.height();
478
479    builder->fsCodeAppend("\t\tvec4 sum = vec4(0, 0, 0, 0);\n");
480    builder->fsCodeAppendf("\t\tvec2 coord = %s - %s * %s;\n", coords2D.c_str(), target, imgInc);
481    builder->fsCodeAppendf("\t\tfor (int y = 0; y < %d; y++) {\n", kHeight);
482    builder->fsCodeAppendf("\t\t\tfor (int x = 0; x < %d; x++) {\n", kWidth);
483    builder->fsCodeAppendf("\t\t\t\tfloat k = %s[y * %d + x];\n", kernel, kWidth);
484    builder->fsCodeAppendf("\t\t\t\tvec2 coord2 = coord + vec2(x, y) * %s;\n", imgInc);
485    builder->fsCodeAppend("\t\t\t\tvec4 c = ");
486    appendTextureLookup(builder, samplers[0], "coord2", bounds, fTileMode);
487    builder->fsCodeAppend(";\n");
488    if (!fConvolveAlpha) {
489        builder->fsCodeAppend("\t\t\t\tc.rgb /= c.a;\n");
490    }
491    builder->fsCodeAppend("\t\t\t\tsum += c * k;\n");
492    builder->fsCodeAppend("\t\t\t}\n");
493    builder->fsCodeAppend("\t\t}\n");
494    if (fConvolveAlpha) {
495        builder->fsCodeAppendf("\t\t%s = sum * %s + %s;\n", outputColor, gain, bias);
496        builder->fsCodeAppendf("\t\t%s.rgb = clamp(%s.rgb, 0.0, %s.a);\n",
497            outputColor, outputColor, outputColor);
498    } else {
499        builder->fsCodeAppend("\t\tvec4 c = ");
500        appendTextureLookup(builder, samplers[0], coords2D.c_str(), bounds, fTileMode);
501        builder->fsCodeAppend(";\n");
502        builder->fsCodeAppendf("\t\t%s.a = c.a;\n", outputColor);
503        builder->fsCodeAppendf("\t\t%s.rgb = sum.rgb * %s + %s;\n", outputColor, gain, bias);
504        builder->fsCodeAppendf("\t\t%s.rgb *= %s.a;\n", outputColor, outputColor);
505    }
506}
507
508namespace {
509
510int encodeXY(int x, int y) {
511    SkASSERT(x >= 1 && y >= 1 && x * y <= 32);
512    if (y < x)
513        return 0x40 | encodeXY(y, x);
514    else
515        return (0x40 >> x) | (y - x);
516}
517
518};
519
520GrGLEffect::EffectKey GrGLMatrixConvolutionEffect::GenKey(const GrDrawEffect& drawEffect,
521                                                          const GrGLCaps&) {
522    const GrMatrixConvolutionEffect& m = drawEffect.castEffect<GrMatrixConvolutionEffect>();
523    EffectKey key = encodeXY(m.kernelSize().width(), m.kernelSize().height());
524    key |= m.tileMode() << 7;
525    key |= m.convolveAlpha() ? 1 << 9 : 0;
526    return key;
527}
528
529void GrGLMatrixConvolutionEffect::setData(const GrGLUniformManager& uman,
530                                          const GrDrawEffect& drawEffect) {
531    const GrMatrixConvolutionEffect& conv = drawEffect.castEffect<GrMatrixConvolutionEffect>();
532    GrTexture& texture = *conv.texture(0);
533    // the code we generated was for a specific kernel size
534    SkASSERT(conv.kernelSize() == fKernelSize);
535    SkASSERT(conv.tileMode() == fTileMode);
536    float imageIncrement[2];
537    float ySign = texture.origin() == kTopLeft_GrSurfaceOrigin ? 1.0f : -1.0f;
538    imageIncrement[0] = 1.0f / texture.width();
539    imageIncrement[1] = ySign / texture.height();
540    uman.set2fv(fImageIncrementUni, 0, 1, imageIncrement);
541    uman.set2fv(fTargetUni, 0, 1, conv.target());
542    uman.set1fv(fKernelUni, 0, fKernelSize.width() * fKernelSize.height(), conv.kernel());
543    uman.set1f(fGainUni, conv.gain());
544    uman.set1f(fBiasUni, conv.bias());
545    const SkIRect& bounds = conv.bounds();
546    float left = (float) bounds.left() / texture.width();
547    float top = (float) bounds.top() / texture.height();
548    float right = (float) bounds.right() / texture.width();
549    float bottom = (float) bounds.bottom() / texture.height();
550    if (texture.origin() == kBottomLeft_GrSurfaceOrigin) {
551        uman.set4f(fBoundsUni, left, 1.0f - bottom, right, 1.0f - top);
552    } else {
553        uman.set4f(fBoundsUni, left, top, right, bottom);
554    }
555}
556
557GrMatrixConvolutionEffect::GrMatrixConvolutionEffect(GrTexture* texture,
558                                                     const SkIRect& bounds,
559                                                     const SkISize& kernelSize,
560                                                     const SkScalar* kernel,
561                                                     SkScalar gain,
562                                                     SkScalar bias,
563                                                     const SkIPoint& target,
564                                                     TileMode tileMode,
565                                                     bool convolveAlpha)
566  : INHERITED(texture, MakeDivByTextureWHMatrix(texture)),
567    fBounds(bounds),
568    fKernelSize(kernelSize),
569    fGain(SkScalarToFloat(gain)),
570    fBias(SkScalarToFloat(bias) / 255.0f),
571    fTileMode(tileMode),
572    fConvolveAlpha(convolveAlpha) {
573    fKernel = new float[kernelSize.width() * kernelSize.height()];
574    for (int i = 0; i < kernelSize.width() * kernelSize.height(); i++) {
575        fKernel[i] = SkScalarToFloat(kernel[i]);
576    }
577    fTarget[0] = static_cast<float>(target.x());
578    fTarget[1] = static_cast<float>(target.y());
579    this->setWillNotUseInputColor();
580}
581
582GrMatrixConvolutionEffect::~GrMatrixConvolutionEffect() {
583    delete[] fKernel;
584}
585
586const GrBackendEffectFactory& GrMatrixConvolutionEffect::getFactory() const {
587    return GrTBackendEffectFactory<GrMatrixConvolutionEffect>::getInstance();
588}
589
590bool GrMatrixConvolutionEffect::onIsEqual(const GrEffect& sBase) const {
591    const GrMatrixConvolutionEffect& s = CastEffect<GrMatrixConvolutionEffect>(sBase);
592    return this->texture(0) == s.texture(0) &&
593           fKernelSize == s.kernelSize() &&
594           !memcmp(fKernel, s.kernel(),
595                   fKernelSize.width() * fKernelSize.height() * sizeof(float)) &&
596           fGain == s.gain() &&
597           fBias == s.bias() &&
598           fTarget == s.target() &&
599           fTileMode == s.tileMode() &&
600           fConvolveAlpha == s.convolveAlpha();
601}
602
603GR_DEFINE_EFFECT_TEST(GrMatrixConvolutionEffect);
604
605// A little bit less than the minimum # uniforms required by DX9SM2 (32).
606// Allows for a 5x5 kernel (or 25x1, for that matter).
607#define MAX_KERNEL_SIZE 25
608
609GrEffectRef* GrMatrixConvolutionEffect::TestCreate(SkRandom* random,
610                                                   GrContext* context,
611                                                   const GrDrawTargetCaps&,
612                                                   GrTexture* textures[]) {
613    int texIdx = random->nextBool() ? GrEffectUnitTest::kSkiaPMTextureIdx :
614                                      GrEffectUnitTest::kAlphaTextureIdx;
615    int width = random->nextRangeU(1, MAX_KERNEL_SIZE);
616    int height = random->nextRangeU(1, MAX_KERNEL_SIZE / width);
617    SkISize kernelSize = SkISize::Make(width, height);
618    SkAutoTDeleteArray<SkScalar> kernel(new SkScalar[width * height]);
619    for (int i = 0; i < width * height; i++) {
620        kernel.get()[i] = random->nextSScalar1();
621    }
622    SkScalar gain = random->nextSScalar1();
623    SkScalar bias = random->nextSScalar1();
624    SkIPoint target = SkIPoint::Make(random->nextRangeU(0, kernelSize.width()),
625                                     random->nextRangeU(0, kernelSize.height()));
626    SkIRect bounds = SkIRect::MakeXYWH(random->nextRangeU(0, textures[texIdx]->width()),
627                                       random->nextRangeU(0, textures[texIdx]->height()),
628                                       random->nextRangeU(0, textures[texIdx]->width()),
629                                       random->nextRangeU(0, textures[texIdx]->height()));
630    TileMode tileMode = static_cast<TileMode>(random->nextRangeU(0, 2));
631    bool convolveAlpha = random->nextBool();
632    return GrMatrixConvolutionEffect::Create(textures[texIdx],
633                                             bounds,
634                                             kernelSize,
635                                             kernel.get(),
636                                             gain,
637                                             bias,
638                                             target,
639                                             tileMode,
640                                             convolveAlpha);
641}
642
643bool SkMatrixConvolutionImageFilter::asNewEffect(GrEffectRef** effect,
644                                                 GrTexture* texture,
645                                                 const SkMatrix&,
646                                                 const SkIRect& bounds
647                                                 ) const {
648    if (!effect) {
649        return fKernelSize.width() * fKernelSize.height() <= MAX_KERNEL_SIZE;
650    }
651    SkASSERT(fKernelSize.width() * fKernelSize.height() <= MAX_KERNEL_SIZE);
652    *effect = GrMatrixConvolutionEffect::Create(texture,
653                                                bounds,
654                                                fKernelSize,
655                                                fKernel,
656                                                fGain,
657                                                fBias,
658                                                fTarget,
659                                                fTileMode,
660                                                fConvolveAlpha);
661    return true;
662}
663
664///////////////////////////////////////////////////////////////////////////////
665
666#endif
667