arm_compute/core/CL/kernels/CLChannelCombineKernel.h

/*
 * Copyright (c) 2016-2020 ARM Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef ARM_COMPUTE_CLCHANNELCOMBINEKERNEL_H
#define ARM_COMPUTE_CLCHANNELCOMBINEKERNEL_H

#include "arm_compute/core/CL/ICLKernel.h"

#include <array>
#include <cstdint>

namespace arm_compute
{
class ICLMultiImage;
class ICLTensor;
using ICLImage = ICLTensor;

/** Interface for the channel combine kernel */
class CLChannelCombineKernel : public ICLKernel
{
public:
    /** Default constructor */
    CLChannelCombineKernel();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLChannelCombineKernel(const CLChannelCombineKernel &) = delete;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLChannelCombineKernel &operator=(const CLChannelCombineKernel &) = delete;
    /** Allow instances of this class to be moved */
    CLChannelCombineKernel(CLChannelCombineKernel &&) = default;
    /** Allow instances of this class to be moved */
    CLChannelCombineKernel &operator=(CLChannelCombineKernel &&) = default;
    /** Default destructor */
    ~CLChannelCombineKernel() = default;
    /** Configure function's inputs and outputs.
     *
     * @param[in]  plane0 The 2D plane that forms channel 0. Must be of U8 format.
     * @param[in]  plane1 The 2D plane that forms channel 1. Must be of U8 format.
     * @param[in]  plane2 The 2D plane that forms channel 2. Must be of U8 format.
     * @param[in]  plane3 The 2D plane that forms channel 3. Must be of U8 format.
     * @param[out] output The single planar output tensor.
     */
    void configure(const ICLTensor *plane0, const ICLTensor *plane1, const ICLTensor *plane2, const ICLTensor *plane3, ICLTensor *output);
    /** Configure function's inputs and outputs.
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  plane0          The 2D plane that forms channel 0. Must be of U8 format.
     * @param[in]  plane1          The 2D plane that forms channel 1. Must be of U8 format.
     * @param[in]  plane2          The 2D plane that forms channel 2. Must be of U8 format.
     * @param[in]  plane3          The 2D plane that forms channel 3. Must be of U8 format.
     * @param[out] output          The single planar output tensor.
     */
    void configure(CLCompileContext &compile_context, const ICLTensor *plane0, const ICLTensor *plane1, const ICLTensor *plane2, const ICLTensor *plane3, ICLTensor *output);
    /** Configure function's inputs and outputs.
     *
     * @param[in]  plane0 The 2D plane that forms channel 0. Must be of U8 format.
     * @param[in]  plane1 The 2D plane that forms channel 1. Must be of U8 format.
     * @param[in]  plane2 The 2D plane that forms channel 2. Must be of U8 format.
     * @param[out] output The multi planar output tensor.
     */
    void configure(const ICLImage *plane0, const ICLImage *plane1, const ICLImage *plane2, ICLMultiImage *output);
    /** Configure function's inputs and outputs.
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  plane0          The 2D plane that forms channel 0. Must be of U8 format.
     * @param[in]  plane1          The 2D plane that forms channel 1. Must be of U8 format.
     * @param[in]  plane2          The 2D plane that forms channel 2. Must be of U8 format.
     * @param[out] output          The multi planar output tensor.
     */
    void configure(CLCompileContext &compile_context, const ICLImage *plane0, const ICLImage *plane1, const ICLImage *plane2, ICLMultiImage *output);

    // Inherited methods overridden:
    void run(const Window &window, cl::CommandQueue &queue) override;

private:
    std::array<const ICLTensor *, 4> _planes;
    ICLTensor     *_output;
    ICLMultiImage *_output_multi;
    std::array<uint32_t, 3> _x_subsampling;
    std::array<uint32_t, 3> _y_subsampling;
};
} // namespace arm_compute
#endif /* ARM_COMPUTE_CLCHANNELCOMBINEKERNEL_H */