arm_compute/runtime/NEON/functions/NEChannelExtract.h

   1 /*
   2  * Copyright (c) 2016, 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_NECHANNELEXTRACT_H__
  25 #define __ARM_COMPUTE_NECHANNELEXTRACT_H__
  26
  27 #include "arm_compute/core/Types.h"
  28 #include "arm_compute/runtime/NEON/INESimpleFunction.h"
  29
  30 namespace arm_compute
  31 {
  32 class IMultiImage;
  33 class ITensor;
  34 using IImage = ITensor;
  35
  36 /**Basic function to run @ref NEChannelExtractKernel to perform channel extraction. */
  37 class NEChannelExtract : public INESimpleFunction
  38 {
  39 public:
  40     /** Initialize the function's source, destination
  41      *
  42      * @param[in]  input   The input tensor to extract the channel from. Formats supported: Formats supported: RGB888/RGBA8888/YUYV422/UYVY422
  43      * @param[in]  channel The channel to extract.
  44      * @param[out] output  The extracted channel. Format supported: U8
  45      */
  46     void configure(const ITensor *input, Channel channel, ITensor *output);
  47     /** Initialize the function's source, destination
  48      *
  49      * @param[in]  input   The multi-planar input image to extract channel from. Formats supported: NV12/NV21/IYUV/YUV444
  50      * @param[in]  channel The channel to extract.
  51      * @param[out] output  The extracted channel. Format supported: U8
  52      */
  53     void configure(const IMultiImage *input, Channel channel, IImage *output);
  54 };
  55 }
  56 #endif /*__ARM_COMPUTE_NECHANNELEXTRACT_H__*/