Compute Library
 20.08
GCScaleKernel.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-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  */
25 
27 #include "arm_compute/core/Error.h"
36 #include "support/StringSupport.h"
37 
38 #include <set>
39 #include <string>
40 
41 using namespace arm_compute;
42 
44 {
45  return BorderSize(1);
46 }
47 
49 {
53  ARM_COMPUTE_ERROR_ON(output == input);
55 
56  _input = input;
57  _output = output;
58 
59  // Compute the ratio between source width/height and destination width/height
60  const auto wr = static_cast<float>(input->info()->dimension(0)) / static_cast<float>(output->info()->dimension(0));
61  const auto hr = static_cast<float>(input->info()->dimension(1)) / static_cast<float>(output->info()->dimension(1));
62 
63  // Compute actual border size
64  const bool border_undefined = info.border_mode == BorderMode::UNDEFINED;
65  BorderSize border = border_undefined ? BorderSize(0) : border_size();
66 
67  // Area interpolation behaves as Nearest Neighbour in case of up-sampling
68  auto interpolation_policy_to_use = info.interpolation_policy;
69  if(interpolation_policy_to_use == InterpolationPolicy::AREA && wr <= 1.f && hr <= 1.f)
70  {
71  interpolation_policy_to_use = InterpolationPolicy::NEAREST_NEIGHBOR;
72  }
73  else
74  {
75  ARM_COMPUTE_ERROR_ON(interpolation_policy_to_use == InterpolationPolicy::AREA);
76  }
77 
78  // Create kernel
79  std::set<std::string> build_opts;
80  build_opts.emplace("#define LOCAL_SIZE_X " + support::cpp11::to_string(1));
81  build_opts.emplace("#define LOCAL_SIZE_Y " + support::cpp11::to_string(1));
82  build_opts.emplace("#define LOCAL_SIZE_Z " + support::cpp11::to_string(1));
83 
84  build_opts.emplace("#define DATA_TYPE_FP16");
85  build_opts.emplace("#define BORDER_SIZE " + support::cpp11::to_string(border.right));
86  if(info.sampling_policy == SamplingPolicy::TOP_LEFT)
87  {
88  build_opts.emplace("#define SAMPLING_POLICY_TOP_LEFT");
89  }
90  else
91  {
92  build_opts.emplace("#define SAMPLING_POLICY_CENTER");
93  }
94 
95  // Configure kernel window
96  unsigned int num_elems_processed_per_iteration = 4;
97  unsigned int input_width_alignment = 2;
98 
99  // performance optimization for 2x upscaling with no border
100  if((fabs(wr - 0.5) < 1e-6) && (fabs(hr - 0.5) < 1e-6) && border_undefined)
101  {
103  input_width_alignment = 4;
104  build_opts.emplace("#define SCALE_NEAREST_8X");
105  }
106  else
107  {
108  build_opts.emplace("#define SCALE_NEAREST_GENERIC");
109  }
110 
111  std::string interpolation_name = string_from_interpolation_policy(interpolation_policy_to_use); // NOLINT
112  std::transform(interpolation_name.begin(), interpolation_name.end(), interpolation_name.begin(), ::tolower);
113  std::string kernel_name = "scale_" + interpolation_name;
114  _kernel = GCKernelLibrary::get().create_kernel(kernel_name, build_opts);
115 
117 
118  const ValidRegion &input_valid_region = input->info()->valid_region();
119 
120  const int total_width = border.left + input_valid_region.anchor[0] + input_valid_region.shape[0] + border.right;
121  const int padding_right = ceil_to_multiple(total_width, input_width_alignment) - border.left - input_valid_region.anchor[0] - input_valid_region.shape[0];
122 
123  // Reads can occur within the valid region of the input
124  AccessWindowStatic input_access(input->info(),
125  input_valid_region.anchor[0] - border.left, input_valid_region.anchor[1] - border.top,
126  input_valid_region.anchor[0] + input_valid_region.shape[0] + padding_right,
127  input_valid_region.anchor[1] + input_valid_region.shape[1] + border.bottom);
128 
130 
131  update_window_and_padding(win, input_access, output_access);
132 
133  output_access.set_valid_region(win, calculate_valid_region_scale(*(input->info()),
134  output->info()->tensor_shape(),
135  info.interpolation_policy,
136  info.sampling_policy,
137  border_undefined));
138 
139  IGCKernel::configure(win);
140 
141  unsigned int idx = 2 * num_arguments_per_3D_tensor(); //Skip the tensor parameters
142  _kernel.set_argument<float>(idx++, static_cast<float>(input->info()->dimension(0)));
143  _kernel.set_argument<float>(idx++, static_cast<float>(input->info()->dimension(1)));
144  _kernel.set_argument<float>(idx++, wr);
145  _kernel.set_argument<float>(idx++, hr);
146 }
147 
148 void GCScaleKernel::run(const Window &window)
149 {
152 
153  _kernel.use();
154 
155  _output->set_needs_shifting(true);
156 
158  Window slice_in = window.first_slice_window_3D();
159 
160  slice.shift(Window::DimX, -(_output->info()->padding()).left);
161 
162  do
163  {
164  unsigned int idx = 0;
165  add_3D_tensor_argument(idx, _input, 1, slice_in);
166  add_3D_tensor_argument(idx, _output, 2, slice);
167  _kernel.update_shader_params();
168  enqueue(*this, slice);
169  }
171 }
unsigned int top
top of the border
Definition: Types.h:352
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void add_3D_tensor_argument(unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, const Window &window)
Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx.
Definition: IGCKernel.cpp:132
BorderSize border_size() const override
The size of the border for that kernel.
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
#define ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES(...)
Definition: Validate.h:543
Container for 2D border size.
Definition: Types.h:272
void enqueue(cl::CommandQueue &queue, ICLKernel &kernel, const Window &window, const cl::NDRange &lws_hint=CLKernelLibrary::get().default_ndrange(), bool use_dummy_work_items=false)
Add the kernel to the command queue with the given window.
Definition: ICLKernel.cpp:39
std::string to_string(T &&value)
Convert integer and float values to string.
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
Interface for GLES Compute tensor.
Definition: IGCTensor.h:35
unsigned int bottom
bottom of the border
Definition: Types.h:354
unsigned int num_arguments_per_3D_tensor() const
Returns the number of arguments enqueued per 3D tensor object.
Definition: IGCKernel.cpp:147
Output values are defined to match the source pixel whose center is nearest to the sample position.
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps=Steps(), bool skip_border=false, BorderSize border_size=BorderSize())
Calculate the maximum window for a given tensor shape and border setting.
Definition: Helpers.cpp:28
Copyright (c) 2017-2020 Arm Limited.
1 channel, 1 F16 per channel
ITensorInfo * info() const override
Interface to be implemented by the child class to return the tensor's metadata.
Definition: Tensor.cpp:33
Implementation of a static rectangular access pattern.
void configure(const IGCTensor *input, IGCTensor *output, const ScaleKernelInfo &info)
Initialise the kernel's inputs, output and interpolation policy.
std::string tolower(std::string string)
Convert string to lower case.
Definition: Utility.h:203
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
Definition: Helpers.h:437
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
auto ceil_to_multiple(S value, T divisor) -> decltype(((value+divisor - 1)/divisor) *divisor)
Computes the smallest number larger or equal to value that is a multiple of divisor.
Definition: Utils.h:67
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Implementation of a row access pattern.
std::string kernel_name
const std::string & string_from_interpolation_policy(InterpolationPolicy policy)
Translates a given interpolation policy to a string.
Definition: Utils.cpp:212
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
Samples are taken at pixel top left corner.
virtual PaddingSize padding() const =0
Padding of tensor.
unsigned int left
left of the border
Definition: Types.h:355
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:333
unsigned int right
right of the border
Definition: Types.h:353
Output values are determined by averaging the source pixels whose areas fall under the area of the de...
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
ValidRegion calculate_valid_region_scale(const ITensorInfo &src_info, const TensorShape &dst_shape, InterpolationPolicy interpolate_policy, SamplingPolicy sampling_policy, bool border_undefined)
Helper function to calculate the Valid Region for Scale.
Definition: Helpers.cpp:184
static GCKernelLibrary & get()
Get the static instance of GCKernelLibrary.
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
Borders are left undefined.
void run(const Window &window) override
Enqueue the OpenGL ES shader to process the given window.
GCKernel create_kernel(const std::string &shader_name, const StringSet &build_options_set={}) const
Creates a kernel from the kernel library.
unsigned int num_elems_processed_per_iteration
Container for valid region of a window.
Definition: Types.h:187
Window first_slice_window_3D() const
First 3D slice of the window.
Definition: Window.h:289
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)