senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2012 The Android Open Source Project |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
| 6 | */ |
| 7 | |
| 8 | #ifndef SkMatrixConvolutionImageFilter_DEFINED |
| 9 | #define SkMatrixConvolutionImageFilter_DEFINED |
| 10 | |
Cary Clark | 4dc5a45 | 2018-05-21 11:56:57 -0400 | [diff] [blame] | 11 | #include "SkFlattenable.h" |
senorblanco@chromium.org | 377c14a | 2013-02-04 22:57:21 +0000 | [diff] [blame] | 12 | #include "SkImageFilter.h" |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 13 | #include "SkScalar.h" |
| 14 | #include "SkSize.h" |
| 15 | #include "SkPoint.h" |
| 16 | |
senorblanco | 32eaa89 | 2016-04-21 06:49:15 -0700 | [diff] [blame] | 17 | class SkBitmap; |
| 18 | |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 19 | /*! \class SkMatrixConvolutionImageFilter |
| 20 | Matrix convolution image filter. This filter applies an NxM image |
| 21 | processing kernel to a given input image. This can be used to produce |
| 22 | effects such as sharpening, blurring, edge detection, etc. |
| 23 | */ |
| 24 | |
senorblanco@chromium.org | 377c14a | 2013-02-04 22:57:21 +0000 | [diff] [blame] | 25 | class SK_API SkMatrixConvolutionImageFilter : public SkImageFilter { |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 26 | public: |
| 27 | /*! \enum TileMode */ |
| 28 | enum TileMode { |
joshualitt | ac97792 | 2014-07-22 09:52:11 -0700 | [diff] [blame] | 29 | kClamp_TileMode = 0, /*!< Clamp to the image's edge pixels. */ |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 30 | kRepeat_TileMode, /*!< Wrap around to the image's opposite edge. */ |
| 31 | kClampToBlack_TileMode, /*!< Fill with transparent black. */ |
Robert Phillips | bee2732 | 2018-01-23 09:58:18 -0500 | [diff] [blame] | 32 | kLast_TileMode = kClampToBlack_TileMode, |
| 33 | |
| 34 | // TODO: remove kMax - it is non-standard but used by Chromium! |
joshualitt | ac97792 | 2014-07-22 09:52:11 -0700 | [diff] [blame] | 35 | kMax_TileMode = kClampToBlack_TileMode |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 36 | }; |
| 37 | |
robertphillips | dada4dd | 2016-04-13 04:54:36 -0700 | [diff] [blame] | 38 | ~SkMatrixConvolutionImageFilter() override; |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 39 | |
commit-bot@chromium.org | cac5fd5 | 2014-03-10 10:51:58 +0000 | [diff] [blame] | 40 | /** Construct a matrix convolution image filter. |
| 41 | @param kernelSize The kernel size in pixels, in each dimension (N by M). |
| 42 | @param kernel The image processing kernel. Must contain N * M |
| 43 | elements, in row order. |
| 44 | @param gain A scale factor applied to each pixel after |
| 45 | convolution. This can be used to normalize the |
| 46 | kernel, if it does not sum to 1. |
| 47 | @param bias A bias factor added to each pixel after convolution. |
| 48 | @param kernelOffset An offset applied to each pixel coordinate before |
| 49 | convolution. This can be used to center the kernel |
| 50 | over the image (e.g., a 3x3 kernel should have an |
| 51 | offset of {1, 1}). |
| 52 | @param tileMode How accesses outside the image are treated. (@see |
| 53 | TileMode). |
| 54 | @param convolveAlpha If true, all channels are convolved. If false, |
| 55 | only the RGB channels are convolved, and |
| 56 | alpha is copied from the source image. |
| 57 | @param input The input image filter. If NULL, the src bitmap |
| 58 | passed to filterImage() is used instead. |
| 59 | @param cropRect The rectangle to which the output processing will be limited. |
| 60 | */ |
robertphillips | ef6a47b | 2016-04-08 08:01:20 -0700 | [diff] [blame] | 61 | static sk_sp<SkImageFilter> Make(const SkISize& kernelSize, |
| 62 | const SkScalar* kernel, |
| 63 | SkScalar gain, |
| 64 | SkScalar bias, |
| 65 | const SkIPoint& kernelOffset, |
| 66 | TileMode tileMode, |
| 67 | bool convolveAlpha, |
| 68 | sk_sp<SkImageFilter> input, |
| 69 | const CropRect* cropRect = nullptr); |
| 70 | |
Cary Clark | 4dc5a45 | 2018-05-21 11:56:57 -0400 | [diff] [blame] | 71 | Factory getFactory() const override { return CreateProc; } |
robertphillips | ef6a47b | 2016-04-08 08:01:20 -0700 | [diff] [blame] | 72 | |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 73 | protected: |
commit-bot@chromium.org | bd0be25 | 2014-05-15 15:40:41 +0000 | [diff] [blame] | 74 | SkMatrixConvolutionImageFilter(const SkISize& kernelSize, |
| 75 | const SkScalar* kernel, |
| 76 | SkScalar gain, |
| 77 | SkScalar bias, |
| 78 | const SkIPoint& kernelOffset, |
| 79 | TileMode tileMode, |
| 80 | bool convolveAlpha, |
robertphillips | ef6a47b | 2016-04-08 08:01:20 -0700 | [diff] [blame] | 81 | sk_sp<SkImageFilter> input, |
senorblanco | 24e06d5 | 2015-03-18 12:11:33 -0700 | [diff] [blame] | 82 | const CropRect* cropRect); |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 83 | void flatten(SkWriteBuffer&) const override; |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 84 | |
robertphillips | dada4dd | 2016-04-13 04:54:36 -0700 | [diff] [blame] | 85 | sk_sp<SkSpecialImage> onFilterImage(SkSpecialImage* source, const Context&, |
| 86 | SkIPoint* offset) const override; |
Matt Sarett | 6d72ed9 | 2017-04-10 16:35:33 -0400 | [diff] [blame] | 87 | sk_sp<SkImageFilter> onMakeColorSpace(SkColorSpaceXformer*) const override; |
Robert Phillips | 1207843 | 2018-05-17 11:17:39 -0400 | [diff] [blame] | 88 | SkIRect onFilterNodeBounds(const SkIRect&, const SkMatrix& ctm, |
| 89 | MapDirection, const SkIRect* inputRect) const override; |
senorblanco | 6db0a7b | 2016-04-01 16:41:10 -0700 | [diff] [blame] | 90 | bool affectsTransparentBlack() const override; |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 91 | |
| 92 | private: |
Cary Clark | 4dc5a45 | 2018-05-21 11:56:57 -0400 | [diff] [blame] | 93 | static sk_sp<SkFlattenable> CreateProc(SkReadBuffer&); |
| 94 | friend class SkFlattenable::PrivateInitializer; |
| 95 | |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 96 | SkISize fKernelSize; |
| 97 | SkScalar* fKernel; |
| 98 | SkScalar fGain; |
| 99 | SkScalar fBias; |
commit-bot@chromium.org | cac5fd5 | 2014-03-10 10:51:58 +0000 | [diff] [blame] | 100 | SkIPoint fKernelOffset; |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 101 | TileMode fTileMode; |
senorblanco@chromium.org | 8640d50 | 2012-09-25 14:32:42 +0000 | [diff] [blame] | 102 | bool fConvolveAlpha; |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 103 | |
senorblanco@chromium.org | 8640d50 | 2012-09-25 14:32:42 +0000 | [diff] [blame] | 104 | template <class PixelFetcher, bool convolveAlpha> |
senorblanco@chromium.org | 7938bae | 2013-10-18 20:08:14 +0000 | [diff] [blame] | 105 | void filterPixels(const SkBitmap& src, |
| 106 | SkBitmap* result, |
Robert Phillips | 1207843 | 2018-05-17 11:17:39 -0400 | [diff] [blame] | 107 | SkIVector& offset, |
senorblanco@chromium.org | 7938bae | 2013-10-18 20:08:14 +0000 | [diff] [blame] | 108 | const SkIRect& rect, |
commit-bot@chromium.org | ae761f7 | 2014-02-05 22:32:02 +0000 | [diff] [blame] | 109 | const SkIRect& bounds) const; |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 110 | template <class PixelFetcher> |
senorblanco@chromium.org | 7938bae | 2013-10-18 20:08:14 +0000 | [diff] [blame] | 111 | void filterPixels(const SkBitmap& src, |
| 112 | SkBitmap* result, |
Robert Phillips | 1207843 | 2018-05-17 11:17:39 -0400 | [diff] [blame] | 113 | SkIVector& offset, |
senorblanco@chromium.org | 7938bae | 2013-10-18 20:08:14 +0000 | [diff] [blame] | 114 | const SkIRect& rect, |
commit-bot@chromium.org | ae761f7 | 2014-02-05 22:32:02 +0000 | [diff] [blame] | 115 | const SkIRect& bounds) const; |
senorblanco@chromium.org | 7938bae | 2013-10-18 20:08:14 +0000 | [diff] [blame] | 116 | void filterInteriorPixels(const SkBitmap& src, |
| 117 | SkBitmap* result, |
Robert Phillips | 1207843 | 2018-05-17 11:17:39 -0400 | [diff] [blame] | 118 | SkIVector& offset, |
senorblanco@chromium.org | 7938bae | 2013-10-18 20:08:14 +0000 | [diff] [blame] | 119 | const SkIRect& rect, |
commit-bot@chromium.org | ae761f7 | 2014-02-05 22:32:02 +0000 | [diff] [blame] | 120 | const SkIRect& bounds) const; |
senorblanco@chromium.org | 7938bae | 2013-10-18 20:08:14 +0000 | [diff] [blame] | 121 | void filterBorderPixels(const SkBitmap& src, |
| 122 | SkBitmap* result, |
Robert Phillips | 1207843 | 2018-05-17 11:17:39 -0400 | [diff] [blame] | 123 | SkIVector& offset, |
senorblanco@chromium.org | 7938bae | 2013-10-18 20:08:14 +0000 | [diff] [blame] | 124 | const SkIRect& rect, |
commit-bot@chromium.org | ae761f7 | 2014-02-05 22:32:02 +0000 | [diff] [blame] | 125 | const SkIRect& bounds) const; |
robertphillips | ef6a47b | 2016-04-08 08:01:20 -0700 | [diff] [blame] | 126 | |
| 127 | typedef SkImageFilter INHERITED; |
senorblanco@chromium.org | 5faa2dc | 2012-09-18 20:32:34 +0000 | [diff] [blame] | 128 | }; |
| 129 | |
| 130 | #endif |