Refactoring Animated image visual

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / animated-image / rolling-image-cache.h

diff --git a/dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h b/dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h
index 1aed961..98ba45c 100644 (file)
--- a/dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h
+++ b/dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_ROLLING_IMAGE_CACHE_H
 
 /*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,10 +18,9 @@
  */
 
 // EXTERNAL INCLUDES
-
-#include <dali/devel-api/common/circular-queue.h>
+#include <dali-toolkit/internal/texture-manager/texture-manager-impl.h>
 #include <dali-toolkit/internal/visuals/animated-image/image-cache.h>
-#include <dali-toolkit/internal/visuals/texture-manager-impl.h>
+#include <dali/devel-api/common/circular-queue.h>
 
 namespace Dali
 {
@@ -29,12 +28,11 @@ namespace Toolkit
 {
 namespace Internal
 {
-
 /**
  * Class to manage a rolling cache of images, where the cache size
  * is smaller than the total number of images.
  */
-class RollingImageCache : public ImageCache
+class RollingImageCache : public ImageCache, public TextureUploadObserver
 {
 public:
   /**
@@ -44,74 +42,94 @@ public:
    * @param[in] observer FrameReady observer
    * @param[in] cacheSize The size of the cache
    * @param[in] batchSize The size of a batch to load
+   * @param[in] interval Time interval between each frame
    *
    * This will start loading textures immediately, according to the
    * batch and cache sizes.
    */
-  RollingImageCache( TextureManager&                 textureManager,
-                     UrlList&                        urlList,
-                     ImageCache::FrameReadyObserver& observer,
-                     uint16_t                        cacheSize,
-                     uint16_t                        batchSize );
+  RollingImageCache(TextureManager&                 textureManager,
+                    UrlList&                        urlList,
+                    ImageCache::FrameReadyObserver& observer,
+                    uint16_t                        cacheSize,
+                    uint16_t                        batchSize,
+                    uint32_t                        interval);
 
   /**
    * Destructor
    */
-  virtual ~RollingImageCache();
+  ~RollingImageCache() override;
 
   /**
-   * Get the first frame. If it's not ready, this will trigger the
-   * sending of FrameReady() when the image becomes ready.
+   * @copydoc Internal::ImageCache::Frame()
    */
-  virtual TextureSet FirstFrame();
+  TextureSet Frame(uint32_t frameIndex) override;
 
   /**
-   * Get the next frame. If it's not ready, this will trigger the
-   * sending of FrameReady() when the image becomes ready.
-   * This will trigger the loading of the next batch.
+   * @copydoc Internal::ImageCache::FirstFrame()
    */
-  virtual TextureSet NextFrame();
+  TextureSet FirstFrame() override;
 
-private:
   /**
-   * @return true if the front frame is ready
+   * @copydoc Internal::ImageCache::GetFrameInterval()
    */
-  bool IsFrontReady() const;
+  uint32_t GetFrameInterval(uint32_t frameIndex) const override;
+
+  /**
+   * @copydoc Internal::ImageCache::GetCurrentFrameIndex()
+   */
+  int32_t GetCurrentFrameIndex() const override;
+
+  /**
+   * @copydoc Internal::ImageCache::GetTotalFrameCount()
+   */
+  int32_t GetTotalFrameCount() const override;
 
   /**
-   * Load the next batch of images
+   * @copydoc Internal::ImageCache::ClearCache()
    */
-  void LoadBatch();
+  void ClearCache() override;
 
+private:
   /**
-   * Find the matching image frame, and set it to ready
+   * @brief Check whether the front frame is ready or not.
+   *
+   * @return true if the front frame is ready
    */
-  void SetImageFrameReady( TextureManager::TextureId textureId );
+  bool IsFrontReady() const;
 
   /**
-   * Get the texture set of the front frame.
-   * @return the texture set
+   * @brief Load the next batch of images
+   *
+   * @param[in] frameIndex starting frame index of batch to be loaded.
+   */
+  void LoadBatch(uint32_t frameIndex);
+
+  /**
+   * @brief Get the texture set of the front frame.
+   *
+   * @return the texture set of the front of Cache.
    */
   TextureSet GetFrontTextureSet() const;
 
   /**
-   * Get the texture id of the given index
+   * @brief Get the texture id of the given index
+   *
+   * @param[in] index index of the queue.
    */
-  TextureManager::TextureId GetCachedTextureId( int index ) const;
+  TextureManager::TextureId GetCachedTextureId(int index) const;
 
   /**
-   * Check if the front frame has become ready - if so, inform observer
+   * @brief Check if the front frame has become ready - if so, inform observer
+   *
    * @param[in] wasReady Readiness before call.
    */
-  void CheckFrontFrame( bool wasReady );
+  void CheckFrontFrame(bool wasReady);
 
 protected:
-  virtual void UploadComplete(
-    bool           loadSuccess,
-    int32_t        textureId,
-    TextureSet     textureSet,
-    bool           useAtlasing,
-    const Vector4& atlasRect );
+  /**
+   * @copydoc Toolkit::TextureUploadObserver::LoadComplete()
+   */
+  void LoadComplete(bool loadSuccess, TextureInformation textureInformation) override;
 
 private:
   /**
@@ -119,11 +137,12 @@ private:
    */
   struct ImageFrame
   {
-    unsigned int mUrlIndex;
-    bool mReady;
+    unsigned int mUrlIndex = 0u;
+    bool         mReady    = false;
   };
 
-  CircularQueue<ImageFrame> mQueue;
+  std::vector<UrlStore>&                 mImageUrls;
+  CircularQueue<ImageFrame>              mQueue;
 };
 
 } // namespace Internal