• 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_CLCHANNELEXTRACT_H
25 #define ARM_COMPUTE_CLCHANNELEXTRACT_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class ICLMultiImage;
34 class ICLTensor;
35 using ICLImage = ICLTensor;
36 
37 /** Basic function to run @ref CLChannelExtractKernel to perform channel extraction.
38  *
39  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
40  *
41 */
42 class CLChannelExtract : public ICLSimpleFunction
43 {
44 public:
45     /** Initialize the function's source, destination
46      *
47      * @param[in]  input   The input tensor to extract the channel from. Formats supported: RGB888/RGBA8888/YUYV422/UYVY422
48      * @param[in]  channel The channel to extract.
49      * @param[out] output  The extracted channel. Must be of U8 format.
50      */
51     void configure(const ICLTensor *input, Channel channel, ICLTensor *output);
52     /** Initialize the function's source, destination
53      *
54      * @param[in]  compile_context The compile context to be used.
55      * @param[in]  input           The input tensor to extract the channel from. Formats supported: RGB888/RGBA8888/YUYV422/UYVY422
56      * @param[in]  channel         The channel to extract.
57      * @param[out] output          The extracted channel. Must be of U8 format.
58      */
59     void configure(const CLCompileContext &compile_context, const ICLTensor *input, Channel channel, ICLTensor *output);
60     /** Initialize the function's source, destination
61      *
62      * @param[in]  input   The multi-planar input image to extract channel from. Formats supported: NV12/NV21/IYUV/YUV444
63      * @param[in]  channel The channel to extract.
64      * @param[out] output  The extracted 2D channel. Must be of U8 format.
65      */
66     void configure(const ICLMultiImage *input, Channel channel, ICLImage *output);
67     /** Initialize the function's source, destination
68      *
69      * @param[in]  compile_context The compile context to be used.
70      * @param[in]  input           The multi-planar input image to extract channel from. Formats supported: NV12/NV21/IYUV/YUV444
71      * @param[in]  channel         The channel to extract.
72      * @param[out] output          The extracted 2D channel. Must be of U8 format.
73      */
74     void configure(const CLCompileContext &compile_context, const ICLMultiImage *input, Channel channel, ICLImage *output);
75 };
76 }
77 #endif /*ARM_COMPUTE_CLCHANNELEXTRACT_H*/
78