xref: /aosp_15_r20/external/ComputeLibrary/src/core/CL/kernels/CLNormalizePlanarYUVLayerKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-2020 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_CLNORMALIZEPLANARYUVLAYERKERNEL_H
25 #define ARM_COMPUTE_CLNORMALIZEPLANARYUVLAYERKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
32 
33 /** Interface for the NormalizePlanarYUV layer kernel. */
34 class CLNormalizePlanarYUVLayerKernel : public ICLKernel
35 {
36 public:
37     /** Constructor */
38     CLNormalizePlanarYUVLayerKernel();
39     /** Prevent instances of this class from being copied (As this class contains pointers) */
40     CLNormalizePlanarYUVLayerKernel(const CLNormalizePlanarYUVLayerKernel &) = delete;
41     /** Prevent instances of this class from being copied (As this class contains pointers) */
42     CLNormalizePlanarYUVLayerKernel &operator=(const CLNormalizePlanarYUVLayerKernel &) = delete;
43     /** Default Move Constructor. */
44     CLNormalizePlanarYUVLayerKernel(CLNormalizePlanarYUVLayerKernel &&) = default;
45     /** Default move assignment operator */
46     CLNormalizePlanarYUVLayerKernel &operator=(CLNormalizePlanarYUVLayerKernel &&) = default;
47     /** Default destructor */
48     ~CLNormalizePlanarYUVLayerKernel() = default;
49 
50     /** Set the input and output tensors.
51      *
52      * @param[in]  input  Source tensor. 3 lower dimensions represent a single input with dimensions [width, height, channels].
53      *                    Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
54      * @param[out] output Destination tensor. Data type supported: same as @p input
55      * @param[in]  mean   Mean values tensor. 1 dimension with size equal to the number of input channels. Data types supported: same as @p input
56      * @param[in]  std    Standard deviation values tensor. 1 dimension with size equal to the number of input channels.
57      *                    Data types supported: same as @p input
58      */
59     void configure(const ICLTensor *input, ICLTensor *output, const ICLTensor *mean, const ICLTensor *std);
60     /** Set the input and output tensors.
61      *
62      * @param[in]  compile_context The compile context to be used.
63      * @param[in]  input           Source tensor. 3 lower dimensions represent a single input with dimensions [width, height, channels].
64      *                             Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
65      * @param[out] output          Destination tensor. Data type supported: same as @p input
66      * @param[in]  mean            Mean values tensor. 1 dimension with size equal to the number of input channels. Data types supported: same as @p input
67      * @param[in]  std             Standard deviation values tensor. 1 dimension with size equal to the number of input channels.
68      *                             Data types supported: same as @p input
69      */
70     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const ICLTensor *mean, const ICLTensor *std);
71     /** Static function to check if given info will lead to a valid configuration of @ref CLNormalizePlanarYUVLayerKernel
72      *
73      * @param[in]  input  Source tensor info. 3 lower dimensions represent a single input with dimensions [width, height, channels].
74      *                    Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
75      * @param[out] output Destination tensor info. Data type supported: same as @p input
76      * @param[in]  mean   Mean values tensor info. 1 dimension with size equal to the number of input channels. Data types supported: same as @p input
77      * @param[in]  std    Standard deviation values tensor info. 1 dimension with size equal to the number of input channels.
78      *                    Data types supported: same as @p input
79      *
80      * @return a status
81      */
82     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *mean, const ITensorInfo *std);
83 
84     // Inherited methods overridden:
85     void run(const Window &window, cl::CommandQueue &queue) override;
86 
87 private:
88     const ICLTensor *_input;
89     ICLTensor       *_output;
90     const ICLTensor *_mean;
91     const ICLTensor *_std;
92 };
93 } // namespace arm_compute
94 #endif /*ARM_COMPUTE_CLNORMALIZEPLANARYUVLAYERKERNEL_H */
95