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) 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/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
  26 // INTERNAL INCLUDES
  27 #include <dali/public-api/dali-adaptor-common.h>
  28 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  29
  30 namespace Dali
  31 {
  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 }
  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   /**
  61    * Create a GifLoading with the given url and resourceType.
  62    * @param[in] url The url of the animated image to load
  63    * @param[in] isLocalResource The true or false whether this is a local resource.
  64    * @return A newly created GifLoading.
  65    */
  66   static AnimatedImageLoading New( const std::string& url, bool isLocalResource );
  67
  68   /**
  69    * @brief Constructor
  70    */
  71   AnimatedImageLoading();
  72
  73   /**
  74    * @brief Downcast an Object handle to Capture handle.
  75    *
  76    * If handle points to a Capture object the downcast produces valid
  77    * handle. If not the returned handle is left uninitialized.
  78    *
  79    * @param[in] handle to An object.
  80    * @return handle to a Capture object or an uninitialized handle.
  81    */
  82   static AnimatedImageLoading DownCast( BaseHandle handle );
  83
  84
  85   /**
  86    * @brief Copy constructor.
  87    *
  88    * @param[in] copy The AnimatedImageLoading to copy
  89    */
  90   AnimatedImageLoading(const AnimatedImageLoading& copy) = default;
  91
  92   /**
  93    * @brief Assignment operator
  94    *
  95    * @param[in] rhs The AnimatedImageLoading to copy
  96    * @return A reference to this
  97    */
  98   AnimatedImageLoading& operator=(const AnimatedImageLoading& rhs) = default;
  99
 100   /**
 101    * @brief Destructor
 102    */
 103   ~AnimatedImageLoading();
 104
 105   /**
 106    * @brief Load the next N Frames of the animated image.
 107    *
 108    * @note This function will load the entire animated image into memory if not already loaded.
 109    * @param[in] frameStartIndex The frame counter to start from. Will usually be the next frame
 110    * after the previous invocation of this method, or 0 to start.
 111    * @param[in] count The number of frames to load
 112    * @param[out] pixelData The vector in which to return the frame data
 113    * @return True if the frame data was successfully loaded
 114    */
 115   bool LoadNextNFrames( uint32_t frameStartIndex, int count, std::vector<Dali::PixelData>& pixelData );
 116
 117    /**
 118    * @brief Load a frame of the animated image.
 119    *
 120    * @note This function will load the entire animated image into memory if not already loaded.
 121    * @param[in] frameIndex The frame index to load.
 122    * @return Dali::Devel::PixelBuffer The loaded PixelBuffer. If loading is fail, return empty handle.
 123    */
 124
 125   Dali::Devel::PixelBuffer LoadFrame( uint32_t frameIndex );
 126
 127   /**
 128    * @brief Get the size of a animated image.
 129    *
 130    * @return The width and height in pixels of the animated image.
 131    */
 132   ImageDimensions GetImageSize() const;
 133
 134   /**
 135    * @brief Get the number of frames in this animated image.
 136    */
 137   uint32_t GetImageCount() const;
 138
 139   /**
 140    * @brief Get the frame interval of the frame index
 141    *
 142    * @note The frame is needed to be loaded before this function is called.
 143    *
 144    * @return The time interval of the frame(microsecond).
 145    */
 146   uint32_t GetFrameInterval( uint32_t frameIndex ) const;
 147
 148   /**
 149    * @brief Get the animated image file URL
 150    *
 151    * @return The URL string of the animated image file
 152    */
 153   std::string GetUrl() const;
 154
 155 public: // Not intended for application developers
 156   /// @cond internal
 157   /**
 158    * @brief This constructor is used by New() methods.
 159    *
 160    * @param[in] internal A pointer to a newly allocated Dali resource.
 161    */
 162   explicit DALI_INTERNAL AnimatedImageLoading( Internal::Adaptor::AnimatedImageLoading* internal );
 163   /// @endcond
 164 };
 165
 166 } // namespace Dali
 167
 168 #endif // DALI_ANIMATED_IMAGE_LOADING_H