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_MULTIIMAGE_H 25 #define ARM_COMPUTE_MULTIIMAGE_H 26 27 #include "arm_compute/core/IMultiImage.h" 28 #include "arm_compute/core/MultiImageInfo.h" 29 #include "arm_compute/core/Types.h" 30 #include "arm_compute/runtime/Tensor.h" 31 32 #include <array> 33 34 namespace arm_compute 35 { 36 class Coordinates; 37 class ITensor; 38 using IImage = ITensor; 39 40 /** Basic implementation of the multi-planar image interface */ 41 class MultiImage : public IMultiImage 42 { 43 public: 44 /** Constructor */ 45 MultiImage(); 46 /** Allocate the multi-planar image 47 * 48 * @param[in] width Width of the whole image 49 * @param[in] height Height of the whole image 50 * @param[in] format Format of the whole image 51 */ 52 void init(unsigned int width, unsigned int height, Format format); 53 /** Allocate the multi-planar image 54 * 55 * @note Uses conservative padding strategy which fits all kernels. 56 * 57 * @param[in] width Width of the whole image 58 * @param[in] height Height of the whole image 59 * @param[in] format Format of the whole image 60 */ 61 void init_auto_padding(unsigned int width, unsigned int height, Format format); 62 /** Allocated a previously initialised multi image 63 * 64 * @note The multi image must not already be allocated when calling this function. 65 * 66 **/ 67 void allocate(); 68 /** Create a subimage from an existing MultiImage. 69 * 70 * @param[in] image Image to use backing memory from 71 * @param[in] coords Starting coordinates of the new image. Should be within the parent image sizes 72 * @param[in] width The width of the subimage 73 * @param[in] height The height of the subimage 74 */ 75 void create_subimage(MultiImage *image, const Coordinates &coords, unsigned int width, unsigned int height); 76 77 // Inherited methods overridden: 78 const MultiImageInfo *info() const override; 79 Image *plane(unsigned int index) override; 80 const Image *plane(unsigned int index) const override; 81 82 private: 83 /** Init the multi-planar image 84 * 85 * @param[in] width Width of the whole image 86 * @param[in] height Height of the whole image 87 * @param[in] format Format of the whole image 88 * @param[in] auto_padding Specifies whether the image uses auto padding 89 */ 90 void internal_init(unsigned int width, unsigned int height, Format format, bool auto_padding); 91 92 MultiImageInfo _info; /** Instance of the multi-planar image's meta data */ 93 std::array<Image, 3> _plane; /* Instance Image to hold the planar's information */ 94 }; 95 } 96 #endif /*ARM_COMPUTE_MULTIIMAGE_H */ 97