arm_compute v17.09
[platform/upstream/armcl.git] / examples / neoncl_scale_median_gaussian.cpp
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 #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 */
27
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"
33
34 using namespace arm_compute;
35 using namespace utils;
36
37 /** Example demonstrating how to use both CL and NEON functions in the same pipeline
38  *
39  * @param[in] argc Number of arguments
40  * @param[in] argv Arguments ( [optional] Path to PPM image to process )
41  */
42 void main_neoncl_scale_median_gaussian(int argc, const char **argv)
43 {
44     /** [NEON / OpenCL Interop] */
45     PPMLoader ppm;
46     CLImage   src, scale_median, median_gauss, dst;
47
48     CLScheduler::get().default_init();
49
50     if(argc < 2)
51     {
52         // Print help
53         std::cout << "Usage: ./build/cl_convolution [input_image.ppm]\n\n";
54         std::cout << "No input_image provided, creating a dummy 640x480 image\n";
55         // Create an empty grayscale 640x480 image
56         src.allocator()->init(TensorInfo(640, 480, Format::U8));
57     }
58     else
59     {
60         ppm.open(argv[1]);
61         ppm.init_image(src, Format::U8);
62     }
63
64     TensorInfo scale_median_info(TensorInfo(src.info()->dimension(0) / 2, src.info()->dimension(1) / 2, Format::U8));
65
66     // Configure the temporary and destination images
67     scale_median.allocator()->init(scale_median_info);
68     median_gauss.allocator()->init(scale_median_info);
69     dst.allocator()->init(scale_median_info);
70
71     // Declare and configure the functions to create the following pipeline: scale -> median -> gauss
72     CLScale       scale;
73     NEMedian3x3   median;
74     CLGaussian5x5 gauss;
75
76     scale.configure(&src, &scale_median, InterpolationPolicy::NEAREST_NEIGHBOR, BorderMode::REPLICATE);
77     median.configure(&scale_median, &median_gauss, BorderMode::REPLICATE);
78     gauss.configure(&median_gauss, &dst, BorderMode::REPLICATE);
79
80     // Allocate all the images
81     src.allocator()->allocate();
82     scale_median.allocator()->allocate();
83     median_gauss.allocator()->allocate();
84     dst.allocator()->allocate();
85
86     // Fill the input image with the content of the PPM image if a filename was provided:
87     if(ppm.is_open())
88     {
89         ppm.fill_image(src);
90     }
91
92     // Enqueue and flush the OpenCL kernel:
93     scale.run();
94
95     // Do a blocking map of the input and output buffers of the NEON function:
96     scale_median.map();
97     median_gauss.map();
98
99     // Run the NEON function:
100     median.run();
101
102     // Unmap the output buffer before it's used again by OpenCL:
103     scale_median.unmap();
104     median_gauss.unmap();
105
106     // Run the final OpenCL function:
107     gauss.run();
108
109     // Make sure all the OpenCL jobs are done executing:
110     CLScheduler::get().sync();
111
112     // Save the result to file:
113     if(ppm.is_open())
114     {
115         const std::string output_filename = std::string(argv[1]) + "_out.ppm";
116         save_to_ppm(dst, output_filename); // save_to_ppm maps and unmaps the image to store as PPM
117     }
118     /** [NEON / OpenCL Interop] */
119 }
120
121 /** Main program for convolution test
122  *
123  * @param[in] argc Number of arguments
124  * @param[in] argv Arguments ( [optional] Path to PPM image to process )
125  */
126 int main(int argc, const char **argv)
127 {
128     return utils::run_example(argc, argv, main_neoncl_scale_median_gaussian);
129 }