dali-toolkit/internal/visuals/animated-image/image-cache.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H
   2 #define DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H
   3
   4 /*
   5  * Copyright (c) 2022 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-toolkit/internal/texture-manager/texture-manager-impl.h>
  22 #include <dali-toolkit/internal/texture-manager/texture-upload-observer.h>
  23
  24 namespace Dali
  25 {
  26 namespace Toolkit
  27 {
  28 namespace Internal
  29 {
  30 class ImageCache : public TextureManager::LifecycleObserver
  31 {
  32 public:
  33   /**
  34    * Observer class to inform when the next image is ready
  35    */
  36   class FrameReadyObserver
  37   {
  38   public:
  39     /**
  40      * @brief Informs observer when the next texture set is ready to display
  41      * @param[in] textureSet The ready texture set
  42      * @param[in] interval interval(ms) for the frame
  43      */
  44     virtual void FrameReady(TextureSet textureSet, uint32_t interval) = 0;
  45   };
  46
  47   struct UrlStore
  48   {
  49     TextureManager::TextureId mTextureId = TextureManager::INVALID_TEXTURE_ID;
  50     std::string               mUrl;
  51   };
  52
  53   /**
  54    * List of URLs
  55    */
  56   typedef std::vector<UrlStore> UrlList;
  57
  58 public:
  59   /**
  60    * @brief Constructor.
  61    * @param[in] textureManager The texture manager
  62    * @param[in] urlList List of urls to cache
  63    * @param[in] observer FrameReady observer
  64    * @param[in] maskingData    Masking data to be applied.
  65    * @param[in] batchSize The size of a batch to load
  66    * @param[in] interval Time interval(ms) between each frame
  67    *
  68    * This will start loading textures immediately, according to the
  69    * batch and cache sizes. The cache is as large as the number of urls.
  70    */
  71   ImageCache(TextureManager&                     textureManager,
  72              TextureManager::MaskingDataPointer& maskingData,
  73              ImageCache::FrameReadyObserver&     observer,
  74              uint32_t                            batchSize,
  75              uint32_t                            interval);
  76
  77   virtual ~ImageCache();
  78
  79   /**
  80    * @brief Get the first frame. If it's not ready, this will trigger the
  81    * sending of FrameReady() when the image becomes ready.
  82    *
  83    * @return TextureSet of the first frame.
  84    */
  85   virtual TextureSet FirstFrame() = 0;
  86
  87   /**
  88    * @brief Get the Nth frame. If it's not ready, this will trigger the
  89    * sending of FrameReady() when the image becomes ready.
  90    *
  91    * @param[in] frameIndex required frame index to be returned.
  92    * @return TextureSet of the frame index.
  93    */
  94   virtual TextureSet Frame(uint32_t frameIndex) = 0;
  95
  96   /**
  97    * @brief Get the interval(ms) of Nth frame.
  98    *
  99    * @param[in] frameIndex frame index to get frame interval.
 100    * @return Time interval in millisecond between frames of frameIndex and frameIndex + 1.
 101    */
 102   virtual uint32_t GetFrameInterval(uint32_t frameIndex) const = 0;
 103
 104   /**
 105    * @brief Get the current rendered frame index.
 106    * If there isn't any loaded frame, returns -1.
 107    *
 108    * @return Frame index of currently showing frame.
 109    */
 110   virtual int32_t GetCurrentFrameIndex() const = 0;
 111
 112   /**
 113    * @brief Get total frame count of the animated image file.
 114    *
 115    * @return Total frame count of the animated image file.
 116    */
 117   virtual int32_t GetTotalFrameCount() const = 0;
 118
 119   /**
 120    * @brief Clears animated image cache and remove loaded textures.
 121    */
 122   virtual void ClearCache() = 0;
 123
 124   /**
 125    * @brief Set default interval(ms) between each frame.
 126    *
 127    * @param[in] interval time interval in millisecond to be used as default interval.
 128    */
 129   virtual void SetInterval(uint32_t interval);
 130
 131 private:
 132   /**
 133    * @brief Called before the texture manager is destroyed.
 134    */
 135   void TextureManagerDestroyed() final;
 136
 137   void AllocateMaskData();
 138
 139 protected:
 140   TextureManager&                     mTextureManager;
 141   FrameReadyObserver&                 mObserver;
 142   TextureManager::MaskingDataPointer& mMaskingData;
 143   uint32_t                            mBatchSize;
 144   uint32_t                            mInterval;
 145   TextureManager::LoadState           mLoadState;
 146   bool                                mRequestingLoad : 1;
 147   bool                                mTextureManagerAlive : 1;
 148 };
 149
 150 } // namespace Internal
 151 } // namespace Toolkit
 152 } // namespace Dali
 153
 154 #endif // DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H