Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2016, 2017 ARM Limited. |
| 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 | */ |
| 24 | #ifndef __ARM_COMPUTE_CLCONVOLUTION_H__ |
| 25 | #define __ARM_COMPUTE_CLCONVOLUTION_H__ |
| 26 | |
| 27 | #include "arm_compute/core/CL/kernels/CLConvolutionKernel.h" |
| 28 | #include "arm_compute/core/CL/kernels/CLFillBorderKernel.h" |
| 29 | #include "arm_compute/core/Types.h" |
Georgios Pinitas | 8a94e7c | 2017-09-15 19:06:47 +0100 | [diff] [blame] | 30 | #include "arm_compute/runtime/CL/CLMemoryGroup.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 31 | #include "arm_compute/runtime/CL/CLTensor.h" |
| 32 | #include "arm_compute/runtime/CL/ICLSimpleFunction.h" |
| 33 | #include "arm_compute/runtime/IFunction.h" |
Georgios Pinitas | 8a94e7c | 2017-09-15 19:06:47 +0100 | [diff] [blame] | 34 | #include "arm_compute/runtime/IMemoryManager.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 35 | |
| 36 | #include <cstdint> |
Georgios Pinitas | 8a94e7c | 2017-09-15 19:06:47 +0100 | [diff] [blame] | 37 | #include <memory> |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 38 | |
| 39 | namespace arm_compute |
| 40 | { |
| 41 | class ICLTensor; |
| 42 | |
| 43 | /** Basic function to execute convolution of size 3x3. This function calls the following OpenCL kernels: |
| 44 | * |
| 45 | * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) |
| 46 | * -# @ref CLConvolution3x3Kernel |
| 47 | * |
| 48 | */ |
| 49 | class CLConvolution3x3 : public ICLSimpleFunction |
| 50 | { |
| 51 | public: |
| 52 | /** Initialize the function's source, destination, conv and border_mode. |
| 53 | * |
| 54 | * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) |
| 55 | * @param[out] output Destination tensor, Data types supported: U8 or S16. |
| 56 | * @param[in] conv matrix_size x matrix_size S16 coefficients structured as a row-major 2D array in a linear buffer. |
| 57 | * @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. |
| 58 | * @param[in] border_mode Strategy to use for borders. |
| 59 | * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. |
| 60 | */ |
| 61 | void configure(ICLTensor *input, ICLTensor *output, const int16_t *conv, uint32_t scale, BorderMode border_mode, uint8_t constant_border_value = 0); |
| 62 | }; |
| 63 | |
| 64 | /** Basic function to execute square convolution.Currently it supports 5x5, 7x7, 9x9. This function calls the following OpenCL kernels: |
| 65 | * |
| 66 | * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) |
| 67 | * -# @ref CLConvolutionKernel or<br/> |
| 68 | * @ref CLSeparableConvolutionHorKernel and @ref CLSeparableConvolutionVertKernel (if convolution matrix is separable) |
| 69 | * |
| 70 | */ |
| 71 | template <unsigned int matrix_size> |
| 72 | class CLConvolutionSquare : public IFunction |
| 73 | { |
| 74 | public: |
| 75 | /** Default constructor */ |
Georgios Pinitas | 8a94e7c | 2017-09-15 19:06:47 +0100 | [diff] [blame] | 76 | CLConvolutionSquare(std::shared_ptr<IMemoryManager> memory_manager = nullptr); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 77 | /** Initialize the function's source, destination, conv and border_mode. |
| 78 | * |
| 79 | * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) |
| 80 | * @param[out] output Destination tensor, Data types supported: U8 or S16. |
| 81 | * @param[in] conv matrix_size x matrix_size S16 coefficients structured as a row-major 2D array in a linear buffer. |
| 82 | * @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. |
| 83 | * @param[in] border_mode Strategy to use for borders. |
| 84 | * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. |
| 85 | */ |
| 86 | void configure(ICLTensor *input, ICLTensor *output, const int16_t *conv, uint32_t scale, BorderMode border_mode, uint8_t constant_border_value = 0); |
| 87 | |
| 88 | // Inherited methods overriden: |
| 89 | void run() override; |
| 90 | |
| 91 | private: |
Georgios Pinitas | 8a94e7c | 2017-09-15 19:06:47 +0100 | [diff] [blame] | 92 | CLMemoryGroup _memory_group; /**< Function's memory group */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 93 | CLTensor _tmp; /**< temporary buffer for output of horizontal pass */ |
| 94 | bool _is_separable; /**< true if the convolution can be separated */ |
| 95 | CLSeparableConvolutionHorKernel<matrix_size> _kernel_hor; /**< kernel for horizontal pass of separated convolution */ |
| 96 | CLSeparableConvolutionVertKernel<matrix_size> _kernel_vert; /**< kernel for vertical pass of separated convolution */ |
| 97 | CLConvolutionKernel<matrix_size> _kernel; /**< kernel for non-separated convolution **/ |
| 98 | CLFillBorderKernel _border_handler; /**< kernel for border handling */ |
| 99 | }; |
| 100 | |
| 101 | /** Basic function to run 5x5 convolution. */ |
| 102 | using CLConvolution5x5 = CLConvolutionSquare<5>; |
| 103 | /** Basic function to run 7x7 convolution. */ |
| 104 | using CLConvolution7x7 = CLConvolutionSquare<7>; |
| 105 | /** Basic function to run 9x9 convolution. */ |
| 106 | using CLConvolution9x9 = CLConvolutionSquare<9>; |
| 107 | |
| 108 | /** Basic function to execute non-square convolution. This function calls the following CL kernels: |
| 109 | * |
| 110 | * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) |
| 111 | * -# @ref CLConvolutionRectangleKernel or<br/> |
| 112 | * |
| 113 | * @note Convolution rectangle should have dimensions of 3, 5, 7, 9 |
| 114 | */ |
| 115 | class CLConvolutionRectangle : public ICLSimpleFunction |
| 116 | { |
| 117 | public: |
| 118 | /** Initialize the function's source, destination, conv and border_mode. |
| 119 | * |
| 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] rows Rows of convolution kernel. |
| 124 | * @param[in] cols Columns of convolution kernel. |
| 125 | * @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. |
| 126 | * @param[in] border_mode Strategy to use for borders. |
| 127 | * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. |
| 128 | */ |
| 129 | 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); |
| 130 | }; |
| 131 | } |
| 132 | #endif /*__ARM_COMPUTE_CLCONVOLUTION_H__ */ |