arm_compute v18.05
[platform/upstream/armcl.git] / arm_compute / core / GLES_COMPUTE / kernels / GCNormalizePlanarYUVLayerKernel.h
1 /*
2  * Copyright (c) 2017-2018 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__H__
25 #define __ARM_COMPUTE_GCNORMALIZEPLANARYUVLAYERKERNEL_H__
26
27 #include "arm_compute/core/GLES_COMPUTE/IGCKernel.h"
28
29 namespace arm_compute
30 {
31 class IGCTensor;
32
33 /** Interface for the NormalizePlanarYUV layer kernel.
34  */
35 class GCNormalizePlanarYUVLayerKernel : public IGCKernel
36 {
37 public:
38     /** Constructor */
39     GCNormalizePlanarYUVLayerKernel();
40     /** Prevent instances of this class from being copied (As this class contains pointers) */
41     GCNormalizePlanarYUVLayerKernel(const GCNormalizePlanarYUVLayerKernel &) = delete;
42     /** Prevent instances of this class from being copied (As this class contains pointers) */
43     GCNormalizePlanarYUVLayerKernel &operator=(const GCNormalizePlanarYUVLayerKernel &) = delete;
44     /** Default Move Constructor. */
45     GCNormalizePlanarYUVLayerKernel(GCNormalizePlanarYUVLayerKernel &&) = default;
46     /** Default move assignment operator */
47     GCNormalizePlanarYUVLayerKernel &operator=(GCNormalizePlanarYUVLayerKernel &&) = default;
48     /** Default destructor */
49     ~GCNormalizePlanarYUVLayerKernel() = default;
50
51     /** Set the input and output tensors.
52      *
53      * @param[in]  input  Source tensor. 3 lower dimensions represent a single input with dimensions [width, height, FM].
54      *                    Data types supported: F16.
55      * @param[out] output Destination tensor. Output will have the same number of dimensions as input. Data type supported: same as @p input
56      * @param[in]  mean   Mean values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input
57      * @param[in]  sd     Standard deviation values tensor. 1 dimension with size equal to the feature maps [FM].
58      *                     Data types supported: Same as @p input
59      */
60     void configure(const IGCTensor *input, IGCTensor *output, const IGCTensor *mean, const IGCTensor *sd);
61
62     // Inherited methods overridden:
63     void run(const Window &window) override;
64
65 private:
66     const IGCTensor *_input;
67     IGCTensor       *_output;
68     const IGCTensor *_mean;
69     const IGCTensor *_sd;
70 };
71 }
72 #endif /*__ARM_COMPUTE_GCNORMALIZEPLANARYUVLAYERKERNEL_H__ */