Compute Library
 20.02.1
CLColorConvertKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2019 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_CLCOLORCONVERTKERNEL_H
25 #define ARM_COMPUTE_CLCOLORCONVERTKERNEL_H
26 
28 
29 namespace arm_compute
30 {
31 class ICLMultiImage;
32 class ICLTensor;
33 using ICLImage = ICLTensor;
34 
35 /** Interface for the color convert kernel.
36  *
37  */
39 {
40 public:
41  /** Default constructor. */
43  /** Prevent instances of this class from being copied (As this class contains pointers) */
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  /** Allow instances of this class to be moved */
49  /** Allow instances of this class to be moved */
51  /** Default destructor. */
52  ~CLColorConvertKernel() = default;
53 
54  /** Set the input and output of the kernel
55  *
56  * @param[in] input Source tensor. Formats supported: RGBA8888/UYVY422/YUYV422/RGB888
57  * @param[out] output Destination tensor. Formats supported: RGB888 (if the formats of @p input are RGBA8888/UYVY422/YUYV422),
58  * RGBA8888 (if the formats of @p input are UYVY422/YUYV422/RGB888/),
59  * U8 (if the formats of @p input is RGB888)
60  */
61  void configure(const ICLTensor *input, ICLTensor *output);
62  /** Set the input and output of the kernel
63  *
64  * @param[in] input Multi-planar source image. Formats supported: NV12/NV21/IYUV
65  * @param[out] output Single-planar destination image. Formats supported: RGB888/RGBA8888
66  */
67  void configure(const ICLMultiImage *input, ICLImage *output);
68  /** Set the input and output of the kernel
69  *
70  * @param[in] input Single-planar source image. Formats supported: RGB888/RGBA8888/UYVY422/YUYV422
71  * @param[out] output Multi-planar destination image. Formats supported: NV12/IYUV/YUV444 (if the formats of @p input are RGB888/RGB8888)
72  */
73  void configure(const ICLImage *input, ICLMultiImage *output);
74  /** Set the input and output of the kernel
75  *
76  * @param[in] input Multi-planar source image. Formats supported: NV12/NV21/IYUV
77  * @param[out] output Multi-planar destination image. Formats supported: YUV444/IYUV (if the formats of @p input are NV12/NV21)/NV12 (if the format of @p input is IYUV)
78  */
79  void configure(const ICLMultiImage *input, ICLMultiImage *output);
80 
81  // Inherited methods overridden:
82  void run(const Window &window, cl::CommandQueue &queue) override;
83 
84 private:
85  const ICLTensor *_input; /*pointer to single planar tensor input */
86  ICLTensor *_output; /*pointer to single planar tensor output */
87  const ICLMultiImage *_multi_input; /*pointer to multi-planar input */
88  ICLMultiImage *_multi_output; /*pointer to multi-planar output */
89 };
90 } // namespace arm_compute
91 #endif /* ARM_COMPUTE_CLCOLORCONVERTKERNEL_H */
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Interface for the color convert kernel.
~CLColorConvertKernel()=default
Default destructor.
ICLTensor ICLImage
Interface for OpenCL images.
Definition: ICLMultiImage.h:33
Interface for OpenCL multi-planar images.
Definition: ICLMultiImage.h:36
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:43
Copyright (c) 2017-2020 ARM Limited.
CLColorConvertKernel & operator=(const CLColorConvertKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers)
void configure(const ICLTensor *input, ICLTensor *output)
Set the input and output of the kernel.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Describe a multidimensional execution window.
Definition: Window.h:39