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