xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/CL/functions/CLNormalizePlanarYUVLayer.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_CLNORMALIZEPLANARYUVLAYER_H
25 #define ARM_COMPUTE_CLNORMALIZEPLANARYUVLAYER_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
29 
30 #include <cstdint>
31 
32 namespace arm_compute
33 {
34 class CLCompileContext;
35 class ICLTensor;
36 class ITensorInfo;
37 
38 /** Basic function to run @ref CLNormalizePlanarYUVLayerKernel
39  *
40  *  @note The function simulates a NormalizePlanarYUV layer.
41  */
42 class CLNormalizePlanarYUVLayer : public ICLSimpleFunction
43 {
44 public:
45     /** Set the input and output tensors.
46      *
47      * @param[in]  input  Source tensor. 3 lower dimensions represent a single input with dimensions [width, height, channels].
48      *                    Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
49      * @param[out] output Destinationfeature tensor. Data type supported: same as @p input
50      * @param[in]  mean   Mean values tensor. 1 dimension with size equal to the number of input channels. Data types supported: Same as @p input
51      * @param[in]  std    Standard deviation values tensor. 1 dimension with size equal to the number of input channels.
52      *                    Data types supported: Same as @p input
53      */
54     void configure(const ICLTensor *input, ICLTensor *output, const ICLTensor *mean, const ICLTensor *std);
55     /** Set the input and output tensors.
56      *
57      * @param[in]  compile_context The compile context to be used.
58      * @param[in]  input           Source tensor. 3 lower dimensions represent a single input with dimensions [width, height, channels].
59      *                             Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
60      * @param[out] output          Destinationfeature tensor. Data type supported: same as @p input
61      * @param[in]  mean            Mean values tensor. 1 dimension with size equal to the number of input channels. Data types supported: Same as @p input
62      * @param[in]  std             Standard deviation values tensor. 1 dimension with size equal to the number of input channels.
63      *                    Data types supported: Same as @p input
64      */
65     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const ICLTensor *mean, const ICLTensor *std);
66     /** Static function to check if given info will lead to a valid configuration of @ref CLNormalizePlanarYUVLayer
67      *
68      * @param[in]  input  Source tensor info. 3 lower dimensions represent a single input with dimensions [width, height, channels].
69      *                    Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
70      * @param[out] output Destination tensor info. Data type supported: same as @p input
71      * @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
72      * @param[in]  std    Standard deviation values tensor info. 1 dimension with size equal to the number of input channels.
73      *                    Data types supported: Same as @p input
74      *
75      * @return a status
76      */
77     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *mean, const ITensorInfo *std);
78 };
79 } // namespace arm_compute
80 #endif /* ARM_COMPUTE_CLNORMALIZEPLANARYUVLAYER_H */
81