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

   1 #ifndef DALI_ANIMATED_IMAGE_LOADING_H
   2 #define DALI_ANIMATED_IMAGE_LOADING_H
   3
   4 /*
   5  * Copyright (c) 2021 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/public-api/common/dali-vector.h>
  22 #include <dali/public-api/common/vector-wrapper.h>
  23 #include <dali/public-api/math/uint-16-pair.h>
  24 #include <dali/public-api/object/base-handle.h>
  25 #include <dali/public-api/images/image-operations.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  29 #include <dali/public-api/dali-adaptor-common.h>
  30
  31 namespace Dali
  32 {
  33 class PixelData;
  34 typedef Dali::Uint16Pair ImageDimensions;
  35
  36 /**
  37  * @addtogroup dali_adaptor_framework
  38  * @{
  39  */
  40
  41 namespace Internal DALI_INTERNAL
  42 {
  43 namespace Adaptor
  44 {
  45 class AnimatedImageLoading;
  46 }
  47 } // namespace DALI_INTERNAL
  48
  49 /**
  50  * Class to manage loading frames of an animated image in small chunks. Lazy initializes only when
  51  * data is actually needed.
  52  * Note, once the Animated Image has loaded, the undecoded data will reside in memory until this object
  53  * is released. (This is to speed up frame loads, which would otherwise have to re-acquire the
  54  * data from disk)
  55  */
  56 class DALI_ADAPTOR_API AnimatedImageLoading : public BaseHandle
  57 {
  58 public:
  59   /**
  60    * Create a GifLoading with the given url and resourceType.
  61    * @param[in] url The url of the animated image to load
  62    * @param[in] isLocalResource The true or false whether this is a local resource.
  63    * @return A newly created GifLoading.
  64    */
  65   static AnimatedImageLoading New(const std::string& url, bool isLocalResource);
  66
  67   /**
  68    * @brief Constructor
  69    */
  70   AnimatedImageLoading();
  71
  72   /**
  73    * @brief Downcast an Object handle to Capture handle.
  74    *
  75    * If handle points to a Capture object the downcast produces valid
  76    * handle. If not the returned handle is left uninitialized.
  77    *
  78    * @param[in] handle to An object.
  79    * @return handle to a Capture object or an uninitialized handle.
  80    */
  81   static AnimatedImageLoading DownCast(BaseHandle handle);
  82
  83   /**
  84    * @brief Copy constructor.
  85    *
  86    * @param[in] copy The AnimatedImageLoading to copy
  87    */
  88   AnimatedImageLoading(const AnimatedImageLoading& copy) = default;
  89
  90   /**
  91    * @brief Assignment operator
  92    *
  93    * @param[in] rhs The AnimatedImageLoading to copy
  94    * @return A reference to this
  95    */
  96   AnimatedImageLoading& operator=(const AnimatedImageLoading& rhs) = default;
  97
  98   /**
  99    * @brief Destructor
 100    */
 101   ~AnimatedImageLoading();
 102
 103   /**
 104    * @brief Load the next N Frames of the animated image.
 105    *
 106    * @note This function will load the entire animated image into memory if not already loaded.
 107    * @param[in] frameStartIndex The frame counter to start from. Will usually be the next frame
 108    * after the previous invocation of this method, or 0 to start.
 109    * @param[in] count The number of frames to load
 110    * @param[out] pixelData The vector in which to return the frame data
 111    * @return True if the frame data was successfully loaded
 112    */
 113   bool LoadNextNFrames(uint32_t frameStartIndex, int count, std::vector<Dali::PixelData>& pixelData);
 114
 115   /**
 116    * @brief Load a frame of the animated image.
 117    *
 118    * @note This function will load the entire animated image into memory if not already loaded.
 119    * @param[in] frameIndex The frame index to load.
 120    * @param[in] size The width and height to fit the loaded image to.
 121    * @param[in] fittingMode The FittingMode of the resource to load
 122    * @param[in] samplingMode The SamplingMode of the resource to load
 123    *
 124    * @return Dali::Devel::PixelBuffer The loaded PixelBuffer. If loading is fail, return empty handle.
 125    */
 126   Dali::Devel::PixelBuffer LoadFrame(uint32_t                 frameIndex,
 127                                      ImageDimensions          size,
 128                                      FittingMode::Type        fittingMode,
 129                                      Dali::SamplingMode::Type samplingMode);
 130
 131   /**
 132    * @brief Get the size of a animated image.
 133    *
 134    * @return The width and height in pixels of the animated image.
 135    */
 136   ImageDimensions GetImageSize() const;
 137
 138   /**
 139    * @brief Get the number of frames in this animated image.
 140    */
 141   uint32_t GetImageCount() const;
 142
 143   /**
 144    * @brief Get the frame interval of the frame index
 145    *
 146    * @note The frame is needed to be loaded before this function is called.
 147    *
 148    * @return The time interval of the frame(microsecond).
 149    */
 150   uint32_t GetFrameInterval(uint32_t frameIndex) const;
 151
 152   /**
 153    * @brief Get the animated image file URL
 154    *
 155    * @return The URL string of the animated image file
 156    */
 157   std::string GetUrl() const;
 158
 159   /**
 160    * @brief Return whether the animated image loading is succeeded or not.
 161    *
 162    * @return True when the animated image loading is succeeded.
 163    */
 164   bool HasLoadingSucceeded() const;
 165
 166 public: // Not intended for application developers
 167   /// @cond internal
 168   /**
 169    * @brief This constructor is used by New() methods.
 170    *
 171    * @param[in] internal A pointer to a newly allocated Dali resource.
 172    */
 173   explicit DALI_INTERNAL AnimatedImageLoading(Internal::Adaptor::AnimatedImageLoading* internal);
 174   /// @endcond
 175 };
 176
 177 } // namespace Dali
 178
 179 #endif // DALI_ANIMATED_IMAGE_LOADING_H