Refactoring TextureUploadObserver.

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

diff --git a/dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h b/dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h
index 503f65e..e1d201b 100644 (file)
--- a/dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h
+++ b/dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_ROLLING_ANIMATED_IMAGE_CACHE_H
 
 /*
- * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 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,10 @@
  */
 
 // EXTERNAL INCLUDES
-#include <dali/devel-api/adaptor-framework/animated-image-loading.h>
-#include <dali/devel-api/common/circular-queue.h>
 #include <dali-toolkit/internal/visuals/animated-image/image-cache.h>
 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
+#include <dali/devel-api/adaptor-framework/animated-image-loading.h>
+#include <dali/devel-api/common/circular-queue.h>
 
 namespace Dali
 {
@@ -29,7 +29,6 @@ namespace Toolkit
 {
 namespace Internal
 {
-
 /**
  * Class to manage a rolling cache of Animated images, where the cache size
  * is smaller than the total number of images.
@@ -37,7 +36,7 @@ namespace Internal
  * Frames are always ready, so the observer.FrameReady callback is never triggered;
  * the FirstFrame and NextFrame APIs will always return a texture.
  */
-class RollingAnimatedImageCache : public ImageCache
+class RollingAnimatedImageCache : public ImageCache, public TextureUploadObserver
 {
 public:
   /**
@@ -48,27 +47,29 @@ 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] isSynchronousLoading The flag to define whether to load first frame synchronously
    *
    * This will start loading textures immediately, according to the
    * batch and cache sizes.
    */
-  RollingAnimatedImageCache( TextureManager&                 textureManager,
-                        AnimatedImageLoading&           animatedImageLoader,
-                        uint32_t                        frameCount,
-                        ImageCache::FrameReadyObserver& observer,
-                        uint16_t                        cacheSize,
-                        uint16_t                        batchSize );
+  RollingAnimatedImageCache(TextureManager&                 textureManager,
+                            AnimatedImageLoading&           animatedImageLoader,
+                            uint32_t                        frameCount,
+                            ImageCache::FrameReadyObserver& observer,
+                            uint16_t                        cacheSize,
+                            uint16_t                        batchSize,
+                            bool                            isSynchronousLoading);
 
   /**
    * Destructor
    */
-  virtual ~RollingAnimatedImageCache();
+  ~RollingAnimatedImageCache() override;
 
   /**
    * Get the Nth frame. If it's not ready, this will trigger the
    * sending of FrameReady() when the image becomes ready.
    */
-  TextureSet Frame( uint32_t frameIndex ) override;
+  TextureSet Frame(uint32_t frameIndex) override;
 
   /**
    * Get the first frame. If it's not ready, this will trigger the
@@ -77,9 +78,26 @@ public:
   TextureSet FirstFrame() override;
 
   /**
+   * Get the next frame. If it's not ready, this will trigger the
+   * sending of FrameReady() when the image becomes ready.
+   */
+  TextureSet NextFrame() override;
+
+  /**
    * Get the interval of Nth frame.
    */
-  uint32_t GetFrameInterval( uint32_t frameIndex ) override;
+  uint32_t GetFrameInterval(uint32_t frameIndex) const override;
+
+  /**
+   * Get the current rendered frame index.
+   * If there isn't any loaded frame, returns -1.
+   */
+  int32_t GetCurrentFrameIndex() const override;
+
+  /**
+   * Get total frame count of the animated image file.
+   */
+  int32_t GetTotalFrameCount() const override;
 
 private:
   /**
@@ -88,11 +106,21 @@ private:
   bool IsFrontReady() const;
 
   /**
+   * Request to Load a frame
+   */
+  void RequestFrameLoading(uint32_t frameIndex);
+
+  /**
    * Load the next batch of images
    */
   void LoadBatch();
 
   /**
+   * Find the matching image frame, and set it to ready
+   */
+  void SetImageFrameReady(TextureManager::TextureId textureId);
+
+  /**
    * Get the texture set of the front frame.
    * @return the texture set
    */
@@ -101,7 +129,16 @@ private:
   /**
    * Get the texture id of the given index
    */
-  TextureManager::TextureId GetCachedTextureId( int index ) const;
+  TextureManager::TextureId GetCachedTextureId(int index) const;
+
+  /**
+   * Check if the front frame has become ready - if so, inform observer
+   * @param[in] wasReady Readiness before call.
+   */
+  void CheckFrontFrame(bool wasReady);
+
+protected:
+  void LoadComplete(bool loadSuccess, TextureInformation textureInformation) override;
 
 private:
   /**
@@ -110,14 +147,19 @@ private:
   struct ImageFrame
   {
     unsigned int mFrameNumber = 0u;
+    bool         mReady       = false;
   };
 
-  Dali::AnimatedImageLoading& mAnimatedImageLoading;
+  Dali::AnimatedImageLoading mAnimatedImageLoading;
   uint32_t                   mFrameCount;
   int                        mFrameIndex;
+  int                        mCacheSize;
   std::vector<UrlStore>      mImageUrls;
-  uint16_t                   mCacheSize;
+  std::vector<int32_t>       mIntervals;
+  std::vector<uint32_t>      mLoadWaitingQueue;
   CircularQueue<ImageFrame>  mQueue;
+  bool                       mIsSynchronousLoading;
+  bool                       mOnLoading;
 };
 
 } // namespace Internal