1 /* 2 * Copyright (c) 2016-2019 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_CLMULTIIMAGE_H 25 #define ARM_COMPUTE_CLMULTIIMAGE_H 26 27 #include "arm_compute/core/CL/ICLMultiImage.h" 28 #include "arm_compute/core/MultiImageInfo.h" 29 #include "arm_compute/core/Types.h" 30 #include "arm_compute/runtime/CL/CLTensor.h" 31 32 #include <array> 33 34 namespace arm_compute 35 { 36 class ICLTensor; 37 using ICLImage = ICLTensor; 38 39 /** Basic implementation of the CL multi-planar image interface */ 40 class CLMultiImage : public ICLMultiImage 41 { 42 public: 43 /** Constructor */ 44 CLMultiImage(); 45 /** Init the multi-planar image 46 * 47 * @param[in] width Width of the whole image 48 * @param[in] height Heigth of the whole image 49 * @param[in] format Format of the whole image 50 */ 51 void init(unsigned int width, unsigned int height, Format format); 52 /** Init the multi-planar image 53 * 54 * @note Uses conservative padding strategy which fits all kernels. 55 * 56 * @param[in] width Width of the whole image 57 * @param[in] height Height of the whole image 58 * @param[in] format Format of the whole image 59 */ 60 void init_auto_padding(unsigned int width, unsigned int height, Format format); 61 /** Allocated a previously initialised multi image 62 * 63 * @note The multi image must not already be allocated when calling this function. 64 * 65 **/ 66 void allocate(); 67 68 // Inherited methods overridden: 69 const MultiImageInfo *info() const override; 70 CLImage *cl_plane(unsigned int index) override; 71 const CLImage *cl_plane(unsigned int index) const override; 72 73 private: 74 /** Init the multi-planar image 75 * 76 * @param[in] width Width of the whole image 77 * @param[in] height Height of the whole image 78 * @param[in] format Format of the whole image 79 * @param[in] auto_padding Specifies whether the image uses auto padding 80 */ 81 void internal_init(unsigned int width, unsigned int height, Format format, bool auto_padding); 82 83 MultiImageInfo _info; /** Instance of the multi-planar image's meta data */ 84 std::array<CLImage, 3> _plane; /* Instance CLImage to hold the planar's information */ 85 }; 86 } 87 #endif /*ARM_COMPUTE_CLMULTIIMAGE_H */ 88