• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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  */
24 #ifndef ARM_COMPUTE_CLCHANNELEXTRACTKERNEL_H
25 #define ARM_COMPUTE_CLCHANNELEXTRACTKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "src/core/CL/ICLKernel.h"
29 
30 #include <cstdint>
31 
32 namespace arm_compute
33 {
34 class ICLMultiImage;
35 class ICLTensor;
36 using ICLImage = ICLTensor;
37 
38 /** Interface for the channel extract kernel */
39 class CLChannelExtractKernel : public ICLKernel
40 {
41 public:
42     /** Default constructor */
43     CLChannelExtractKernel();
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     CLChannelExtractKernel(const CLChannelExtractKernel &) = delete;
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     CLChannelExtractKernel &operator=(const CLChannelExtractKernel &) = delete;
48     /** Allow instances of this class to be moved */
49     CLChannelExtractKernel(CLChannelExtractKernel &&) = default;
50     /** Allow instances of this class to be moved */
51     CLChannelExtractKernel &operator=(CLChannelExtractKernel &&) = default;
52     /** Default destructor */
53     ~CLChannelExtractKernel() = default;
54     /** Set the input and output of the kernel
55      *
56      * @param[in]  input   Source tensor. Formats supported: RGB888/RGBA8888/YUYV422/UYVY422
57      * @param[in]  channel Channel to extract.
58      * @param[out] output  Destination tensor. Must be of U8 format.
59      */
60     void configure(const ICLTensor *input, Channel channel, ICLTensor *output);
61     /** Set the input and output of the kernel
62      *
63      * @param[in]  compile_context The compile context to be used.
64      * @param[in]  input           Source tensor. Formats supported: RGB888/RGBA8888/YUYV422/UYVY422
65      * @param[in]  channel         Channel to extract.
66      * @param[out] output          Destination tensor. Must be of U8 format.
67      */
68     void configure(const CLCompileContext &compile_context, const ICLTensor *input, Channel channel, ICLTensor *output);
69     /** Set the input and output of the kernel
70      *
71      * @param[in]  input   Multi-planar source image. Formats supported: NV12/NV21/IYUV/YUV444
72      * @param[in]  channel Channel to extract.
73      * @param[out] output  Single-planar 2D destination image. Must be of U8 format.
74      */
75     void configure(const ICLMultiImage *input, Channel channel, ICLImage *output);
76     /** Set the input and output of the kernel
77      *
78      * @param[in]  compile_context The compile context to be used.
79      * @param[in]  input           Multi-planar source image. Formats supported: NV12/NV21/IYUV/YUV444
80      * @param[in]  channel         Channel to extract.
81      * @param[out] output          Single-planar 2D destination image. Must be of U8 format.
82      */
83     void configure(const CLCompileContext &compile_context, const ICLMultiImage *input, Channel channel, ICLImage *output);
84 
85     // Inherited methods overridden:
86     void run(const Window &window, cl::CommandQueue &queue) override;
87 
88 private:
89     const ICLTensor *_input;
90     ICLTensor       *_output;
91     uint32_t         _num_elems_processed_per_iteration;
92     uint32_t         _subsampling;
93 };
94 } // namespace arm_compute
95 #endif /* ARM_COMPUTE_CLCHANNELEXTRACTKERNEL_H */
96