Add CURRENT_FRAME_NUMBER and TOTAL_FRAME_NUMBER properties to the AnimatedImageVisual
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / animated-image / rolling-image-cache.h
index 1aed961..f33a7b3 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_ROLLING_IMAGE_CACHE_H
 
 /*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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.
@@ -34,7 +34,7 @@ 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:
   /**
@@ -57,20 +57,41 @@ public:
   /**
    * Destructor
    */
-  virtual ~RollingImageCache();
+  ~RollingImageCache() 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;
 
   /**
    * Get the first frame. If it's not ready, this will trigger the
    * sending of FrameReady() when the image becomes ready.
    */
-  virtual TextureSet FirstFrame();
+  TextureSet FirstFrame() 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.
    */
-  virtual TextureSet NextFrame();
+  TextureSet NextFrame() override;
+
+  /**
+   * Get the interval of Nth frame.
+   */
+  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:
   /**
@@ -106,12 +127,19 @@ private:
   void CheckFrontFrame( bool wasReady );
 
 protected:
-  virtual void UploadComplete(
+  void UploadComplete(
     bool           loadSuccess,
     int32_t        textureId,
     TextureSet     textureSet,
     bool           useAtlasing,
-    const Vector4& atlasRect );
+    const Vector4& atlasRect,
+    bool           preMultiplied ) override;
+
+  void LoadComplete(
+    bool loadSuccess,
+    Devel::PixelBuffer pixelBuffer,
+    const VisualUrl& url,
+    bool preMultiplied ) override;
 
 private:
   /**
@@ -119,10 +147,11 @@ private:
    */
   struct ImageFrame
   {
-    unsigned int mUrlIndex;
-    bool mReady;
+    unsigned int mUrlIndex = 0u;
+    bool mReady = false;
   };
 
+  std::vector<UrlStore>& mImageUrls;
   CircularQueue<ImageFrame> mQueue;
 };