Updated all header files to new format
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / animated-image / image-cache.h
index 5061d76..f21d707 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H
 
 /*
- * Copyright (c) 2017 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,8 +18,8 @@
  */
 
 // EXTERNAL INCLUDES
+#include <dali-toolkit/internal/visuals/texture-manager-impl.h>
 #include <dali-toolkit/internal/visuals/texture-upload-observer.h>
-#include <dali-toolkit/internal/visuals/texture-manager.h>
 
 namespace Dali
 {
@@ -27,8 +27,7 @@ namespace Toolkit
 {
 namespace Internal
 {
-
-class ImageCache : public TextureUploadObserver
+class ImageCache : public TextureManager::LifecycleObserver
 {
 public:
   /**
@@ -41,13 +40,13 @@ public:
      * Informs observer when the next texture set is ready to display
      * @param[in] textureSet The ready texture set
      */
-    virtual void FrameReady( TextureSet textureSet ) = 0;
+    virtual void FrameReady(TextureSet textureSet) = 0;
   };
 
   struct UrlStore
   {
-    TextureManager::TextureId mTextureId;
-    std::string mUrl;
+    TextureManager::TextureId mTextureId = TextureManager::INVALID_TEXTURE_ID;
+    std::string               mUrl;
   };
 
   /**
@@ -66,10 +65,9 @@ public:
    * This will start loading textures immediately, according to the
    * batch and cache sizes. The cache is as large as the number of urls.
    */
-  ImageCache( TextureManager&                 textureManager,
-              UrlList&                        urlList,
-              ImageCache::FrameReadyObserver& observer,
-              unsigned int                    batchSize );
+  ImageCache(TextureManager&                 textureManager,
+             ImageCache::FrameReadyObserver& observer,
+             unsigned int                    batchSize);
 
   virtual ~ImageCache();
 
@@ -82,18 +80,45 @@ public:
   /**
    * 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() = 0;
 
+  /**
+   * Get the Nth frame. If it's not ready, this will trigger the
+   * sending of FrameReady() when the image becomes ready.
+   */
+  virtual TextureSet Frame(uint32_t frameIndex) = 0;
+
+  /**
+   * Get the interval of Nth frame.
+   */
+  virtual uint32_t GetFrameInterval(uint32_t frameIndex) const = 0;
+
+  /**
+   * Get the current rendered frame index.
+   * If there isn't any loaded frame, returns -1.
+   */
+  virtual int32_t GetCurrentFrameIndex() const = 0;
+
+  /**
+   * Get total frame count of the animated image file.
+   */
+  virtual int32_t GetTotalFrameCount() const = 0;
+
+private:
+  /**
+   * Called before the texture manager is destroyed.
+   */
+  void TextureManagerDestroyed() final;
+
 protected:
-  TextureManager&        mTextureManager;
-  FrameReadyObserver&    mObserver;
-  std::vector<UrlStore>& mImageUrls;
-  unsigned int           mBatchSize;
-  unsigned int           mUrlIndex;
-  bool                   mWaitingForReadyFrame:1;
-  bool                   mRequestingLoad:1;
+  TextureManager&     mTextureManager;
+  FrameReadyObserver& mObserver;
+  unsigned int        mBatchSize;
+  unsigned int        mUrlIndex;
+  bool                mWaitingForReadyFrame : 1;
+  bool                mRequestingLoad : 1;
+  bool                mTextureManagerAlive : 1;
 };
 
 } //namespace Internal