• 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_NECHANNELEXTRACTKERNEL_H
25 #define ARM_COMPUTE_NECHANNELEXTRACTKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "src/core/NEON/INESimpleKernel.h"
29 
30 namespace arm_compute
31 {
32 class IMultiImage;
33 class ITensor;
34 using IImage = ITensor;
35 
36 /** Interface for the channel extract kernel */
37 class NEChannelExtractKernel : public INESimpleKernel
38 {
39 public:
name()40     const char *name() const override
41     {
42         return "NEChannelExtractKernel";
43     }
44     /** Default constructor */
45     NEChannelExtractKernel();
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     NEChannelExtractKernel(const NEChannelExtractKernel &) = delete;
48     /** Prevent instances of this class from being copied (As this class contains pointers) */
49     NEChannelExtractKernel &operator=(const NEChannelExtractKernel &) = delete;
50     /** Allow instances of this class to be moved */
51     NEChannelExtractKernel(NEChannelExtractKernel &&) = default;
52     /** Allow instances of this class to be moved */
53     NEChannelExtractKernel &operator=(NEChannelExtractKernel &&) = default;
54     /** Default destructor */
55     ~NEChannelExtractKernel() = default;
56 
57     /** Set the input and output of the kernel
58      *
59      * @param[in]  input   Source tensor. Formats supported: RGB888/RGBA8888/YUYV422/UYVY422
60      * @param[in]  channel Channel to extract.
61      * @param[out] output  Destination tensor. Format supported: U8
62      */
63     void configure(const ITensor *input, Channel channel, ITensor *output);
64     /** Set the input and output of the kernel
65      *
66      * @param[in]  input   Multi-planar source image. Formats supported: NV12/NV21/IYUV/YUV444
67      * @param[in]  channel Channel to extract.
68      * @param[out] output  Single-planar destination image. Format supported: U8
69      */
70     void configure(const IMultiImage *input, Channel channel, IImage *output);
71 
72     // Inherited methods overridden:
73     void run(const Window &window, const ThreadInfo &info) override;
74 
75 private:
76     /** Extract one channel from a two channel planar tensor.
77      *
78      * @param[in] win Region on which to execute the kernel.
79      */
80     void extract_1C_from_2C_img(const Window &win);
81     /** Extract one channel from a three channel planar tensor.
82      *
83      * @param[in] win Region on which to execute the kernel.
84      */
85     void extract_1C_from_3C_img(const Window &win);
86     /** Extract one channel from a four channel planar tensor.
87      *
88      * @param[in] win Region on which to execute the kernel.
89      */
90     void extract_1C_from_4C_img(const Window &win);
91     /** Extract U/V channel from a single planar YUVY/UYVY tensor.
92      *
93      * @param[in] win Region on which to execute the kernel.
94      */
95     void extract_YUYV_uv(const Window &win);
96     /** Copies a full plane to the output tensor.
97      *
98      * @param[in] win Region on which to execute the kernel.
99      */
100     void copy_plane(const Window &win);
101     /** Common signature for all the specialised ChannelExtract functions
102      *
103      * @param[in] window Region on which to execute the kernel.
104      */
105     using ChannelExtractFunction = void (NEChannelExtractKernel::*)(const Window &window);
106     /** ChannelExtract function to use for the particular tensor types passed to configure() */
107     ChannelExtractFunction _func;
108     unsigned int           _lut_index;
109 };
110 } // namespace arm_compute
111 #endif /* ARM_COMPUTE_NECHANNELEXTRACTKERNEL_H */
112