Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Michele Di Giorgio | d9eaf61 | 2020-07-08 11:12:57 +0100 | [diff] [blame] | 2 | * Copyright (c) 2016-2020 Arm Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 3 | * |
| 4 | * SPDX-License-Identifier: MIT |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | * of this software and associated documentation files (the "Software"), to |
| 8 | * deal in the Software without restriction, including without limitation the |
| 9 | * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| 10 | * sell copies of the Software, and to permit persons to whom the Software is |
| 11 | * furnished to do so, subject to the following conditions: |
| 12 | * |
| 13 | * The above copyright notice and this permission notice shall be included in all |
| 14 | * copies or substantial portions of the Software. |
| 15 | * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 22 | * SOFTWARE. |
| 23 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_CLCONVOLUTION_H |
| 25 | #define ARM_COMPUTE_CLCONVOLUTION_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 27 | #include "arm_compute/core/Types.h" |
| 28 | #include "arm_compute/runtime/CL/CLTensor.h" |
| 29 | #include "arm_compute/runtime/CL/ICLSimpleFunction.h" |
| 30 | #include "arm_compute/runtime/IFunction.h" |
Georgios Pinitas | 8a94e7c | 2017-09-15 19:06:47 +0100 | [diff] [blame] | 31 | #include "arm_compute/runtime/IMemoryManager.h" |
Georgios Pinitas | 26014cf | 2019-09-09 19:00:57 +0100 | [diff] [blame] | 32 | #include "arm_compute/runtime/MemoryGroup.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 33 | |
| 34 | #include <cstdint> |
Georgios Pinitas | 8a94e7c | 2017-09-15 19:06:47 +0100 | [diff] [blame] | 35 | #include <memory> |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 36 | |
| 37 | namespace arm_compute |
| 38 | { |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 39 | template <unsigned int matrix_size> |
| 40 | class CLConvolutionKernel; |
| 41 | template <unsigned int matrix_size> |
| 42 | class CLSeparableConvolutionHorKernel; |
| 43 | template <unsigned int matrix_size> |
| 44 | class CLSeparableConvolutionVertKernel; |
| 45 | class CLFillBorderKernel; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 46 | class ICLTensor; |
| 47 | |
| 48 | /** Basic function to execute convolution of size 3x3. This function calls the following OpenCL kernels: |
| 49 | * |
| 50 | * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) |
| 51 | * -# @ref CLConvolution3x3Kernel |
| 52 | * |
morgolock | 00c7601 | 2020-11-06 10:40:12 +0000 | [diff] [blame] | 53 | * @deprecated This function is deprecated and is intended to be removed in 21.05 release |
| 54 | * |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 55 | */ |
| 56 | class CLConvolution3x3 : public ICLSimpleFunction |
| 57 | { |
| 58 | public: |
| 59 | /** Initialize the function's source, destination, conv and border_mode. |
| 60 | * |
| 61 | * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) |
| 62 | * @param[out] output Destination tensor, Data types supported: U8 or S16. |
| 63 | * @param[in] conv matrix_size x matrix_size S16 coefficients structured as a row-major 2D array in a linear buffer. |
| 64 | * @param[in] scale Scale of the convolution matrix. If 0 is passed, it will be set to the sum of the coefficients of the convolution or 1 if they add up to 0. |
| 65 | * @param[in] border_mode Strategy to use for borders. |
| 66 | * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. |
| 67 | */ |
| 68 | void configure(ICLTensor *input, ICLTensor *output, const int16_t *conv, uint32_t scale, BorderMode border_mode, uint8_t constant_border_value = 0); |
Manuel Bottini | 2b84be5 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 69 | /** Initialize the function's source, destination, conv and border_mode. |
| 70 | * |
| 71 | * @param[in] compile_context The compile context to be used. |
| 72 | * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) |
| 73 | * @param[out] output Destination tensor, Data types supported: U8 or S16. |
| 74 | * @param[in] conv matrix_size x matrix_size S16 coefficients structured as a row-major 2D array in a linear buffer. |
| 75 | * @param[in] scale Scale of the convolution matrix. If 0 is passed, it will be set to the sum of the coefficients of the convolution or 1 if they add up to 0. |
| 76 | * @param[in] border_mode Strategy to use for borders. |
| 77 | * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. |
| 78 | */ |
| 79 | void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const int16_t *conv, uint32_t scale, BorderMode border_mode, uint8_t constant_border_value = 0); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 80 | }; |
| 81 | |
| 82 | /** Basic function to execute square convolution.Currently it supports 5x5, 7x7, 9x9. This function calls the following OpenCL kernels: |
| 83 | * |
| 84 | * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) |
| 85 | * -# @ref CLConvolutionKernel or<br/> |
| 86 | * @ref CLSeparableConvolutionHorKernel and @ref CLSeparableConvolutionVertKernel (if convolution matrix is separable) |
| 87 | * |
morgolock | 00c7601 | 2020-11-06 10:40:12 +0000 | [diff] [blame] | 88 | * @deprecated This function is deprecated and is intended to be removed in 21.05 release |
| 89 | * |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 90 | */ |
| 91 | template <unsigned int matrix_size> |
| 92 | class CLConvolutionSquare : public IFunction |
| 93 | { |
| 94 | public: |
| 95 | /** Default constructor */ |
Georgios Pinitas | 8a94e7c | 2017-09-15 19:06:47 +0100 | [diff] [blame] | 96 | CLConvolutionSquare(std::shared_ptr<IMemoryManager> memory_manager = nullptr); |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 97 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 98 | CLConvolutionSquare(const CLConvolutionSquare &) = delete; |
| 99 | /** Default move constructor */ |
| 100 | CLConvolutionSquare(CLConvolutionSquare &&) = default; |
| 101 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 102 | CLConvolutionSquare &operator=(const CLConvolutionSquare &) = delete; |
| 103 | /** Default move assignment operator */ |
| 104 | CLConvolutionSquare &operator=(CLConvolutionSquare &&) = default; |
| 105 | /** Default destructor */ |
| 106 | ~CLConvolutionSquare(); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 107 | /** Initialize the function's source, destination, conv and border_mode. |
| 108 | * |
| 109 | * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) |
| 110 | * @param[out] output Destination tensor, Data types supported: U8 or S16. |
| 111 | * @param[in] conv matrix_size x matrix_size S16 coefficients structured as a row-major 2D array in a linear buffer. |
| 112 | * @param[in] scale Scale of the convolution matrix. If 0 is passed, it will be set to the sum of the coefficients of the convolution or 1 if they add up to 0. |
| 113 | * @param[in] border_mode Strategy to use for borders. |
| 114 | * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. |
| 115 | */ |
| 116 | void configure(ICLTensor *input, ICLTensor *output, const int16_t *conv, uint32_t scale, BorderMode border_mode, uint8_t constant_border_value = 0); |
Manuel Bottini | 2b84be5 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 117 | /** Initialize the function's source, destination, conv and border_mode. |
| 118 | * |
| 119 | * @param[in] compile_context The compile context to be used. |
| 120 | * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) |
| 121 | * @param[out] output Destination tensor, Data types supported: U8 or S16. |
| 122 | * @param[in] conv matrix_size x matrix_size S16 coefficients structured as a row-major 2D array in a linear buffer. |
| 123 | * @param[in] scale Scale of the convolution matrix. If 0 is passed, it will be set to the sum of the coefficients of the convolution or 1 if they add up to 0. |
| 124 | * @param[in] border_mode Strategy to use for borders. |
| 125 | * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. |
| 126 | */ |
| 127 | void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const int16_t *conv, uint32_t scale, BorderMode border_mode, uint8_t constant_border_value = 0); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 128 | |
| 129 | // Inherited methods overriden: |
| 130 | void run() override; |
| 131 | |
| 132 | private: |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 133 | MemoryGroup _memory_group; /**< Function's memory group */ |
| 134 | CLTensor _tmp; /**< temporary buffer for output of horizontal pass */ |
| 135 | bool _is_separable; /**< true if the convolution can be separated */ |
| 136 | std::unique_ptr<CLSeparableConvolutionHorKernel<matrix_size>> _kernel_hor; /**< kernel for horizontal pass of separated convolution */ |
| 137 | std::unique_ptr<CLSeparableConvolutionVertKernel<matrix_size>> _kernel_vert; /**< kernel for vertical pass of separated convolution */ |
| 138 | std::unique_ptr<CLConvolutionKernel<matrix_size>> _kernel; /**< kernel for non-separated convolution **/ |
| 139 | std::unique_ptr<CLFillBorderKernel> _border_handler; /**< kernel for border handling */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 140 | }; |
| 141 | |
| 142 | /** Basic function to run 5x5 convolution. */ |
| 143 | using CLConvolution5x5 = CLConvolutionSquare<5>; |
| 144 | /** Basic function to run 7x7 convolution. */ |
| 145 | using CLConvolution7x7 = CLConvolutionSquare<7>; |
| 146 | /** Basic function to run 9x9 convolution. */ |
| 147 | using CLConvolution9x9 = CLConvolutionSquare<9>; |
| 148 | |
| 149 | /** Basic function to execute non-square convolution. This function calls the following CL kernels: |
| 150 | * |
| 151 | * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) |
| 152 | * -# @ref CLConvolutionRectangleKernel or<br/> |
| 153 | * |
| 154 | * @note Convolution rectangle should have dimensions of 3, 5, 7, 9 |
morgolock | 00c7601 | 2020-11-06 10:40:12 +0000 | [diff] [blame] | 155 | * |
| 156 | * @deprecated This function is deprecated and is intended to be removed in 21.05 release |
| 157 | * |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 158 | */ |
| 159 | class CLConvolutionRectangle : public ICLSimpleFunction |
| 160 | { |
| 161 | public: |
| 162 | /** Initialize the function's source, destination, conv and border_mode. |
| 163 | * |
| 164 | * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) |
| 165 | * @param[out] output Destination tensor, Data types supported: U8 or S16. |
| 166 | * @param[in] conv Matrix_size x matrix_size S16 coefficients structured as a row-major 2D array in a linear buffer. |
| 167 | * @param[in] rows Rows of convolution kernel. |
| 168 | * @param[in] cols Columns of convolution kernel. |
| 169 | * @param[in] scale Scale of the convolution matrix. If 0 is passed, it will be set to the sum of the coefficients of the convolution or 1 if they add up to 0. |
| 170 | * @param[in] border_mode Strategy to use for borders. |
| 171 | * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. |
| 172 | */ |
| 173 | void configure(ICLTensor *input, ICLTensor *output, const int16_t *conv, uint32_t rows, uint32_t cols, uint32_t scale, BorderMode border_mode, uint8_t constant_border_value = 0); |
Manuel Bottini | 2b84be5 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 174 | /** Initialize the function's source, destination, conv and border_mode. |
| 175 | * |
| 176 | * @param[in] compile_context The compile context to be used. |
| 177 | * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) |
| 178 | * @param[out] output Destination tensor, Data types supported: U8 or S16. |
| 179 | * @param[in] conv Matrix_size x matrix_size S16 coefficients structured as a row-major 2D array in a linear buffer. |
| 180 | * @param[in] rows Rows of convolution kernel. |
| 181 | * @param[in] cols Columns of convolution kernel. |
| 182 | * @param[in] scale Scale of the convolution matrix. If 0 is passed, it will be set to the sum of the coefficients of the convolution or 1 if they add up to 0. |
| 183 | * @param[in] border_mode Strategy to use for borders. |
| 184 | * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. |
| 185 | */ |
| 186 | void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const int16_t *conv, uint32_t rows, uint32_t cols, uint32_t scale, BorderMode border_mode, |
| 187 | uint8_t constant_border_value = 0); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 188 | }; |
| 189 | } |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 190 | #endif /*ARM_COMPUTE_CLCONVOLUTION_H */ |