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

   1 #ifndef DALI_TOOLKIT_INTERNAL_FIXED_IMAGE_CACHE_H
   2 #define DALI_TOOLKIT_INTERNAL_FIXED_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/visuals/animated-image/image-cache.h>
  23
  24 namespace Dali
  25 {
  26 namespace Toolkit
  27 {
  28 namespace Internal
  29 {
  30 class FixedImageCache : public ImageCache, public TextureUploadObserver
  31 {
  32 public:
  33   /**
  34    * Constructor.
  35    * @param[in] textureManager The texture manager
  36    * @param[in] urlList List of urls to cache
  37    * @param[in] observer FrameReady observer
  38    * @param[in] batchSize The size of a batch to load
  39    * @param[in] interval Time interval between each frame
  40    *
  41    * This will start loading textures immediately, according to the
  42    * batch and cache sizes. The cache is as large as the number of urls.
  43    */
  44   FixedImageCache(TextureManager&                 textureManager,
  45                   UrlList&                        urlList,
  46                   ImageCache::FrameReadyObserver& observer,
  47                   uint32_t                        batchSize,
  48                   uint32_t                        interval);
  49
  50   ~FixedImageCache() override;
  51
  52   /**
  53    * @copydoc Internal::ImageCache::Frame()
  54    */
  55   TextureSet Frame(uint32_t frameIndex) override;
  56
  57   /**
  58    * @copydoc Internal::ImageCache::FirstFrame()
  59    */
  60   TextureSet FirstFrame() override;
  61
  62   /**
  63    * @copydoc Internal::ImageCache::GetFrameInterval()
  64    */
  65   uint32_t GetFrameInterval(uint32_t frameIndex) const override;
  66
  67   /**
  68    * @copydoc Internal::ImageCache::GetCurrentFrameIndex()
  69    */
  70   int32_t GetCurrentFrameIndex() const override;
  71
  72   /**
  73    * @copydoc Internal::ImageCache::GetTotalFrameCount()
  74    */
  75   int32_t GetTotalFrameCount() const override;
  76
  77   /**
  78    * @copydoc Internal::ImageCache::ClearCache()
  79    */
  80   void ClearCache() override;
  81
  82 private:
  83   /**
  84    * @brief Check whether the front frame is ready or not.
  85    *
  86    * @return true if the front frame is ready
  87    */
  88   bool IsFrontReady() const;
  89
  90   /**
  91    * @brief Load the next batch of images
  92    */
  93   void LoadBatch();
  94
  95   /**
  96    * @brief Get the texture set of the front frame.
  97    *
  98    * @return the texture set of the front of Cache.
  99    */
 100   TextureSet GetFrontTextureSet() const;
 101
 102   /**
 103    * @brief Check if the front frame has become ready - if so, inform observer
 104    *
 105    * @param[in] wasReady Readiness before call.
 106    */
 107   void CheckFrontFrame(bool wasReady);
 108
 109 protected:
 110   /**
 111    * @copydoc Toolkit::TextureUploadObserver::LoadComplete()
 112    */
 113   void LoadComplete(bool loadSuccess, TextureInformation textureInformation) override;
 114
 115 private:
 116   std::vector<UrlStore>&                 mImageUrls;
 117   std::vector<bool>                      mReadyFlags;
 118   std::vector<TextureManager::LoadState> mLoadStates;
 119   uint32_t                               mFront;
 120 };
 121
 122 } //namespace Internal
 123 } //namespace Toolkit
 124 } //namespace Dali
 125
 126 #endif // DALI_TOOLKIT_INTERNAL_FIXED_IMAGE_CACHE_H