1 /* 2 * Copyright (c) 2019-2021 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_CLFFT2D_H 25 #define ARM_COMPUTE_CLFFT2D_H 26 27 #include "arm_compute/runtime/IFunction.h" 28 29 #include "arm_compute/runtime/CL/CLTensor.h" 30 #include "arm_compute/runtime/CL/functions/CLFFT1D.h" 31 #include "arm_compute/runtime/FunctionDescriptors.h" 32 #include "arm_compute/runtime/MemoryGroup.h" 33 34 namespace arm_compute 35 { 36 // Forward declaration 37 class ICLTensor; 38 39 /** Basic function to execute two dimensional FFT. This function calls the following OpenCL kernels: 40 * 41 * -# @ref CLFFT1D 1D FFT is performed on the first given axis 42 * -# @ref CLFFT1D 1D FFT is performed on the second given axis 43 */ 44 class CLFFT2D : public IFunction 45 { 46 public: 47 /** Default Constructor */ 48 CLFFT2D(std::shared_ptr<IMemoryManager> memory_manager = nullptr); 49 /** Prevent instances of this class from being copied */ 50 CLFFT2D(const CLFFT2D &) = delete; 51 /** Prevent instances of this class from being copied */ 52 CLFFT2D &operator=(const CLFFT2D &) = delete; 53 /** Default move constructor */ 54 CLFFT2D(CLFFT2D &&) = default; 55 /** Default move assignment operator */ 56 CLFFT2D &operator=(CLFFT2D &&) = default; 57 /** Default destructor */ 58 ~CLFFT2D(); 59 /** Initialise the function's source, destinations and border mode. 60 * 61 * Valid data layouts: 62 * - All 63 * 64 * Valid data type configurations: 65 * |src |dst | 66 * |:------|:------| 67 * |F32 |F32 | 68 * |F16 |F16 | 69 * 70 * @param[in] input Source tensor. Data types supported: F16/F32. 71 * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input. 72 * @param[in] config FFT related configuration 73 */ 74 void configure(const ICLTensor *input, ICLTensor *output, const FFT2DInfo &config); 75 /** Initialise the function's source, destinations and border mode. 76 * 77 * @param[in] compile_context The compile context to be used. 78 * @param[in] input Source tensor. Data types supported: F16/F32. 79 * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input. 80 * @param[in] config FFT related configuration 81 */ 82 void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const FFT2DInfo &config); 83 /** Static function to check if given info will lead to a valid configuration of @ref CLFFT2D. 84 * 85 * @param[in] input Source tensor info. Data types supported: F16/F32. 86 * @param[in] output Destination tensor info. Data types and data layouts supported: Same as @p input. 87 * @param[in] config FFT related configuration 88 * 89 * @return a status 90 */ 91 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFT2DInfo &config); 92 93 // Inherited methods overridden: 94 void run() override; 95 96 protected: 97 MemoryGroup _memory_group; 98 CLFFT1D _first_pass_func; 99 CLFFT1D _second_pass_func; 100 CLTensor _first_pass_tensor; 101 }; 102 } // namespace arm_compute 103 #endif /*ARM_COMPUTE_CLFFT2D_H */ 104