dali/devel-api/adaptor-framework/image-loading.h

   1 #ifndef DALI_IMAGE_LOADING_H
   2 #define DALI_IMAGE_LOADING_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 // EXTERNAL INCLUDES
  21 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  22 #include <dali/public-api/images/image-operations.h>
  23 #include <string>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/dali-adaptor-common.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @brief Load an image synchronously from local file.
  32  *
  33  * @note This method is thread safe, i.e. can be called from any thread.
  34  *
  35  * @param [in] url The URL of the image file to load.
  36  * @param [in] size The width and height to fit the loaded image to, 0.0 means whole image
  37  * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
  38  * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
  39  * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
  40  * @return handle to the loaded PixelBuffer object or an empty handle in case loading failed.
  41  */
  42 DALI_ADAPTOR_API Devel::PixelBuffer LoadImageFromFile(
  43   const std::string& url,
  44   ImageDimensions    size                  = ImageDimensions(0, 0),
  45   FittingMode::Type  fittingMode           = FittingMode::DEFAULT,
  46   SamplingMode::Type samplingMode          = SamplingMode::BOX_THEN_LINEAR,
  47   bool               orientationCorrection = true);
  48
  49 /**
  50  * @brief Determine the size of an image that LoadImageFromFile will provide when
  51  * given the same image loading parameters.
  52  *
  53  * This is a synchronous request.
  54  * This function is used to determine the size of an image before it has loaded.
  55  * @param[in] filename name of the image.
  56  * @param[in] size The requested size for the image.
  57  * @param[in] fittingMode The method to use to map the source image to the desired
  58  * dimensions.
  59  * @param[in] samplingMode The image filter to use if the image needs to be
  60  * downsampled to the requested size.
  61  * @param[in] orientationCorrection Whether to use image metadata to rotate or
  62  * flip the image, e.g., from portrait to landscape.
  63  * @return dimensions that image will have if it is loaded with given parameters.
  64  */
  65 DALI_ADAPTOR_API ImageDimensions GetClosestImageSize(
  66   const std::string& filename,
  67   ImageDimensions    size                  = ImageDimensions(0, 0),
  68   FittingMode::Type  fittingMode           = FittingMode::DEFAULT,
  69   SamplingMode::Type samplingMode          = SamplingMode::BOX_THEN_LINEAR,
  70   bool               orientationCorrection = true);
  71
  72 /**
  73  * @brief Get the size of an original image. this method will not respect any rotation of image.
  74  * @param[in] filename name of the image.
  75  *
  76  * @return dimensions to original image
  77  */
  78 DALI_ADAPTOR_API ImageDimensions GetOriginalImageSize(
  79   const std::string& filename);
  80
  81 /**
  82  * @brief Get the size of an original image. this method will respect any rotation of image.
  83  * @param[in] filename name of the image.
  84  * @param[in] orientationCorrection Whether to use image metadata to rotate or
  85  * @return dimensions to original image
  86  */
  87 DALI_ADAPTOR_API ImageDimensions GetOriginalImageSize(
  88   const std::string& filename, bool orientationCorrection);
  89
  90 /**
  91  * @brief Load an image synchronously from a remote resource.
  92  *
  93  * @param [in] url The URL of the image file to load.
  94  * @param [in] size The width and height to fit the loaded image to, 0.0 means whole image
  95  * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
  96  * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
  97  * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
  98  *
  99  * @return handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.
 100  */
 101 DALI_ADAPTOR_API Devel::PixelBuffer DownloadImageSynchronously(
 102   const std::string& url,
 103   ImageDimensions    size                  = ImageDimensions(0, 0),
 104   FittingMode::Type  fittingMode           = FittingMode::DEFAULT,
 105   SamplingMode::Type samplingMode          = SamplingMode::BOX_THEN_LINEAR,
 106   bool               orientationCorrection = true);
 107
 108 /**
 109  * @brief get the maximum texture size.
 110  *
 111  * @return The maximum texture size
 112  */
 113 DALI_ADAPTOR_API unsigned int GetMaxTextureSize();
 114
 115 } // namespace Dali
 116
 117 #endif // DALI_IMAGE_LOADING_H