examples/cl_events.cpp

   1 /*
   2  * Copyright (c) 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 "utils/Utils.h"
  32
  33 using namespace arm_compute;
  34 using namespace utils;
  35
  36 void main_cl_events(int argc, const char **argv)
  37 {
  38     /** [OpenCL events] **/
  39     PPMLoader     ppm;
  40     CLImage       src, tmp_scale_median, tmp_median_gauss, dst;
  41     constexpr int scale_factor = 2;
  42
  43     CLScheduler::get().default_init();
  44
  45     if(argc < 2)
  46     {
  47         // Print help
  48         std::cout << "Usage: ./build/cl_events [input_image.ppm]\n\n";
  49         std::cout << "No input_image provided, creating a dummy 640x480 image\n";
  50         // Create an empty grayscale 640x480 image
  51         src.allocator()->init(TensorInfo(640, 480, Format::U8));
  52     }
  53     else
  54     {
  55         ppm.open(argv[1]);
  56         ppm.init_image(src, Format::U8);
  57     }
  58
  59     // Declare and configure the functions to create the following pipeline: scale -> median -> gauss
  60     CLScale       scale;
  61     CLMedian3x3   median;
  62     CLGaussian5x5 gauss;
  63
  64     TensorInfo dst_info(src.info()->dimension(0) / scale_factor, src.info()->dimension(1) / scale_factor, Format::U8);
  65
  66     // Configure the temporary and destination images
  67     dst.allocator()->init(dst_info);
  68     tmp_scale_median.allocator()->init(dst_info);
  69     tmp_median_gauss.allocator()->init(dst_info);
  70
  71     //Configure the functions:
  72     scale.configure(&src, &tmp_scale_median, InterpolationPolicy::NEAREST_NEIGHBOR, BorderMode::REPLICATE);
  73     median.configure(&tmp_scale_median, &tmp_median_gauss, BorderMode::REPLICATE);
  74     gauss.configure(&tmp_median_gauss, &dst, BorderMode::REPLICATE);
  75
  76     // Allocate all the images
  77     src.allocator()->allocate();
  78     dst.allocator()->allocate();
  79     tmp_scale_median.allocator()->allocate();
  80     tmp_median_gauss.allocator()->allocate();
  81     // Fill the input image with the content of the PPM image if a filename was provided:
  82     if(ppm.is_open())
  83     {
  84         ppm.fill_image(src);
  85     }
  86
  87     // Enqueue and flush the scale OpenCL kernel:
  88     scale.run();
  89     // Create a synchronisation event between scale and median:
  90     cl::Event scale_event = CLScheduler::get().enqueue_sync_event();
  91     // Enqueue and flush the median OpenCL kernel:
  92     median.run();
  93     // Enqueue and flush the Gaussian OpenCL kernel:
  94     gauss.run();
  95
  96     //Make sure all the OpenCL jobs are done executing:
  97     scale_event.wait();        // Block until Scale is done executing (Median3x3 and Gaussian5x5 might still be running)
  98     CLScheduler::get().sync(); // Block until Gaussian5x5 is done executing
  99
 100     // Save the result to file:
 101     if(ppm.is_open())
 102     {
 103         const std::string output_filename = std::string(argv[1]) + "_out.ppm";
 104         save_to_ppm(dst, output_filename); // save_to_ppm maps and unmaps the image to store as PPM
 105     }
 106     /** [OpenCL events] **/
 107 }
 108
 109 /** Main program for convolution test
 110  *
 111  * @param[in] argc Number of arguments
 112  * @param[in] argv Arguments ( [optional] Path to PPM image to process )
 113  */
 114 int main(int argc, const char **argv)
 115 {
 116     return utils::run_example(argc, argv, main_cl_events);
 117 }