arm_compute v18.02
[platform/upstream/armcl.git] / src / core / CL / cl_kernels / pixelwise_mul_int.cl
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 #include "helpers.h"
25
26 #if defined(FIXED_POINT_POSITION)
27
28 #include "fixed_point.h"
29
30 #if defined(SATURATE)
31 #define MUL_OP(x, y, scale, type, size) MUL_SAT_OP_EXPAND((x), (y), type, size, FIXED_POINT_POSITION)
32 #else // SATURATE
33 #define MUL_OP(x, y, scale, type, size) MUL_OP_EXPAND((x), (y), type, size, FIXED_POINT_POSITION)
34 #endif // SATURATE
35
36 #else // FIXED_POINT_POSITION
37
38 #if defined(SATURATE)
39 #define CONVERT_OP_INT_STR(x, type, size) (convert_##type##size##_sat(x))
40 #else // SATURATE
41 #define CONVERT_OP_INT_STR(x, type, size) (convert_##type##size(x))
42 #endif // SATURATE
43 #define CONVERT_OP_INT(x, type, size) CONVERT_OP_INT_STR(x, type, size)
44
45 #define MUL_OP(x, y, scale, type, size) CONVERT_OP_INT((x) * (y) >> scale, type, size)
46
47 #endif // FIXED_POINT_POSITION
48
49 /** Performs a pixelwise multiplication with integer scale of integer inputs.
50  *
51  * @attention The inputs and output data types need to be passed at compile time using -DDATA_TYPE_IN1, -DDATA_TYPE_IN2 and -DDATA_TYPE_OUT:
52  * e.g. -DDATA_TYPE_IN1=uchar -DDATA_TYPE_IN2=ushort -DDATA_TYPE_OUT=short
53  * @attention The data_type of the intermediate result of the multiplication should passed as well using -DDATA_TYPE_RES.
54  * e.g. If one of inputs is S16 -DDATA_TYPE_RES=int should be passed else -DDATA_TYPE_RES=short.
55  * @note In case of fixed-point operation -DFIXED_POINT_POSITION=fixed_point_position must be provided: e.g. -DFIXED_POINT_POSITION=3
56  *
57  * @param[in]  in1_ptr                           Pointer to the source image. Supported data types: U8/QS8/QS16/S16
58  * @param[in]  in1_stride_x                      Stride of the source image in X dimension (in bytes)
59  * @param[in]  in1_step_x                        in1_stride_x * number of elements along X processed per workitem(in bytes)
60  * @param[in]  in1_stride_y                      Stride of the source image in Y dimension (in bytes)
61  * @param[in]  in1_step_y                        in1_stride_y * number of elements along Y processed per workitem(in bytes)
62  * @param[in]  in1_stride_z                      Stride of the source image in Y dimension (in bytes)
63  * @param[in]  in1_step_z                        in1_stride_z * number of elements along Y processed per workitem(in bytes)
64  * @param[in]  in1_offset_first_element_in_bytes The offset of the first element in the source image
65  * @param[in]  in2_ptr                           Pointer to the source image. Supported data types: same as @p in1_ptr
66  * @param[in]  in2_stride_x                      Stride of the source image in X dimension (in bytes)
67  * @param[in]  in2_step_x                        in2_stride_x * number of elements along X processed per workitem(in bytes)
68  * @param[in]  in2_stride_y                      Stride of the source image in Y dimension (in bytes)
69  * @param[in]  in2_step_y                        in2_stride_y * number of elements along Y processed per workitem(in bytes)
70  * @param[in]  in2_stride_z                      Stride of the source image in Y dimension (in bytes)
71  * @param[in]  in2_step_z                        in2_stride_z * number of elements along Y processed per workitem(in bytes)
72  * @param[in]  in2_offset_first_element_in_bytes The offset of the first element in the source image
73  * @param[out] out_ptr                           Pointer to the destination image. Supported data types: same as @p in1_ptr
74  * @param[in]  out_stride_x                      Stride of the destination image in X dimension (in bytes)
75  * @param[in]  out_step_x                        out_stride_x * number of elements along X processed per workitem(in bytes)
76  * @param[in]  out_stride_y                      Stride of the destination image in Y dimension (in bytes)
77  * @param[in]  out_step_y                        out_stride_y * number of elements along Y processed per workitem(in bytes)
78  * @param[in]  out_stride_z                      Stride of the destination image in Y dimension (in bytes)
79  * @param[in]  out_step_z                        out_stride_z * number of elements along Y processed per workitem(in bytes)
80  * @param[in]  out_offset_first_element_in_bytes The offset of the first element in the destination image
81  * @param[in]  scale                             Integer scaling factor. Supported data types: S32 (ignored for QS8 and QS16 as the assumption is scale = 1).
82  */
83 __kernel void pixelwise_mul_int(
84     TENSOR3D_DECLARATION(in1),
85     TENSOR3D_DECLARATION(in2),
86     TENSOR3D_DECLARATION(out),
87     const uint scale)
88 {
89     // Get pixels pointer
90     Tensor3D in1 = CONVERT_TO_TENSOR3D_STRUCT(in1);
91     Tensor3D in2 = CONVERT_TO_TENSOR3D_STRUCT(in2);
92     Tensor3D out = CONVERT_TO_TENSOR3D_STRUCT(out);
93
94     // Load data
95     VEC_DATA_TYPE(DATA_TYPE_RES, 16)
96     in1_data = CONVERT(vload16(0, (__global DATA_TYPE_IN1 *)in1.ptr), VEC_DATA_TYPE(DATA_TYPE_RES, 16));
97     VEC_DATA_TYPE(DATA_TYPE_RES, 16)
98     in2_data = CONVERT(vload16(0, (__global DATA_TYPE_IN2 *)in2.ptr), VEC_DATA_TYPE(DATA_TYPE_RES, 16));
99
100     // Perform multiplication and store result
101     vstore16(MUL_OP(in1_data, in2_data, scale, DATA_TYPE_OUT, 16), 0, (__global DATA_TYPE_OUT *)out.ptr);
102 }