2 * Copyright (c) 2016, 2018 ARM Limited.
4 * SPDX-License-Identifier: MIT
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:
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
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
24 #ifndef ARM_COMPUTE_CL /* Needed by Utils.cpp to handle OpenCL exceptions properly */
25 #error "This example needs to be built with -DARM_COMPUTE_CL"
26 #endif /* ARM_COMPUTE_CL */
28 #include "arm_compute/core/Types.h"
29 #include "arm_compute/runtime/CL/CLFunctions.h"
30 #include "arm_compute/runtime/CL/CLScheduler.h"
31 #include "arm_compute/runtime/NEON/NEFunctions.h"
32 #include "utils/Utils.h"
34 using namespace arm_compute;
35 using namespace utils;
37 /** Example demonstrating how to use both CL and NEON functions in the same pipeline
39 * @param[in] argc Number of arguments
40 * @param[in] argv Arguments ( [optional] Path to PPM image to process )
42 class NEONCLScaleMedianGaussianExample : public Example
45 void do_setup(int argc, char **argv) override
47 /** [NEON / OpenCL Interop] */
50 CLScheduler::get().default_init();
55 std::cout << "Usage: ./build/cl_convolution [input_image.ppm]\n\n";
56 std::cout << "No input_image provided, creating a dummy 640x480 image\n";
57 // Create an empty grayscale 640x480 image
58 src.allocator()->init(TensorInfo(640, 480, Format::U8));
63 ppm.init_image(src, Format::U8);
66 TensorInfo scale_median_info(TensorInfo(src.info()->dimension(0) / 2, src.info()->dimension(1) / 2, Format::U8));
68 // Configure the temporary and destination images
69 scale_median.allocator()->init(scale_median_info);
70 median_gauss.allocator()->init(scale_median_info);
71 dst.allocator()->init(scale_median_info);
73 scale.configure(&src, &scale_median, InterpolationPolicy::NEAREST_NEIGHBOR, BorderMode::REPLICATE);
74 median.configure(&scale_median, &median_gauss, BorderMode::REPLICATE);
75 gauss.configure(&median_gauss, &dst, BorderMode::REPLICATE);
77 // Allocate all the images
78 src.allocator()->allocate();
79 scale_median.allocator()->allocate();
80 median_gauss.allocator()->allocate();
81 dst.allocator()->allocate();
83 // Fill the input image with the content of the PPM image if a filename was provided:
87 const std::string output_filename = std::string(argv[1]) + "_out.ppm";
89 /** [NEON / OpenCL Interop] */
91 void do_run() override
93 // Enqueue and flush the OpenCL kernel:
96 // Do a blocking map of the input and output buffers of the NEON function:
100 // Run the NEON function:
103 // Unmap the output buffer before it's used again by OpenCL:
104 scale_median.unmap();
105 median_gauss.unmap();
107 // Run the final OpenCL function:
110 // Make sure all the OpenCL jobs are done executing:
111 CLScheduler::get().sync();
113 void do_teardown() override
115 // Save the result to file:
116 if(!output_filename.empty())
118 save_to_ppm(dst, output_filename); // save_to_ppm maps and unmaps the image to store as PPM
123 CLImage src{}, scale_median{}, median_gauss{}, dst{};
125 NEMedian3x3 median{};
126 CLGaussian5x5 gauss{};
127 std::string output_filename{};
130 /** Main program for neon/cl scale median gaussian test
132 * @param[in] argc Number of arguments
133 * @param[in] argv Arguments ( [optional] Path to PPM image to process )
135 int main(int argc, char **argv)
137 return utils::run_example<NEONCLScaleMedianGaussianExample>(argc, argv);