Remove useless iteration when debug mode

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

diff --git a/dali-toolkit/internal/visuals/animated-image/image-cache.h b/dali-toolkit/internal/visuals/animated-image/image-cache.h
index 1d385c8..d3b6b0a 100644 (file)
--- a/dali-toolkit/internal/visuals/animated-image/image-cache.h
+++ b/dali-toolkit/internal/visuals/animated-image/image-cache.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H
 
 /*
- * Copyright (c) 2020 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,8 +18,8 @@
  */
 
 // EXTERNAL INCLUDES
-#include <dali-toolkit/internal/visuals/texture-upload-observer.h>
-#include <dali-toolkit/internal/visuals/texture-manager-impl.h>
+#include <dali-toolkit/internal/texture-manager/texture-manager-impl.h>
+#include <dali-toolkit/internal/texture-manager/texture-upload-observer.h>
 
 namespace Dali
 {
@@ -27,7 +27,6 @@ namespace Toolkit
 {
 namespace Internal
 {
-
 class ImageCache : public TextureManager::LifecycleObserver
 {
 public:
@@ -38,16 +37,17 @@ public:
   {
   public:
     /**
-     * Informs observer when the next texture set is ready to display
+     * @brief Informs observer when the next texture set is ready to display
      * @param[in] textureSet The ready texture set
+     * @param[in] interval interval(ms) for the frame
      */
-    virtual void FrameReady( TextureSet textureSet ) = 0;
+    virtual void FrameReady(TextureSet textureSet, uint32_t interval) = 0;
   };
 
   struct UrlStore
   {
     TextureManager::TextureId mTextureId = TextureManager::INVALID_TEXTURE_ID;
-    std::string mUrl;
+    VisualUrl                 mUrl;
   };
 
   /**
@@ -57,57 +57,98 @@ public:
 
 public:
   /**
-   * Constructor.
+   * @brief Constructor.
    * @param[in] textureManager The texture manager
    * @param[in] urlList List of urls to cache
    * @param[in] observer FrameReady observer
+   * @param[in] maskingData    Masking data to be applied.
    * @param[in] batchSize The size of a batch to load
+   * @param[in] interval Time interval(ms) between each frame
    *
    * 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,
-              ImageCache::FrameReadyObserver& observer,
-              unsigned int                    batchSize );
+  ImageCache(TextureManager&                     textureManager,
+             TextureManager::MaskingDataPointer& maskingData,
+             ImageCache::FrameReadyObserver&     observer,
+             uint32_t                            batchSize,
+             uint32_t                            interval);
 
   virtual ~ImageCache();
 
   /**
-   * Get the first frame. If it's not ready, this will trigger the
+   * @brief Get the first frame. If it's not ready, this will trigger the
    * sending of FrameReady() when the image becomes ready.
+   *
+   * @return TextureSet of the first frame.
    */
   virtual TextureSet FirstFrame() = 0;
 
   /**
-   * Get the Nth frame. If it's not ready, this will trigger the
+   * @brief Get the Nth frame. If it's not ready, this will trigger the
    * sending of FrameReady() when the image becomes ready.
+   *
+   * @param[in] frameIndex required frame index to be returned.
+   * @return TextureSet of the frame index.
    */
-  virtual TextureSet Frame( uint32_t frameIndex ) = 0;
+  virtual TextureSet Frame(uint32_t frameIndex) = 0;
 
   /**
-   * Get the interval of Nth frame.
+   * @brief Get the interval(ms) of Nth frame.
+   *
+   * @param[in] frameIndex frame index to get frame interval.
+   * @return Time interval in millisecond between frames of frameIndex and frameIndex + 1.
    */
-  virtual uint32_t GetFrameInterval( uint32_t frameIndex ) = 0;
+  virtual uint32_t GetFrameInterval(uint32_t frameIndex) const = 0;
 
-private:
+  /**
+   * @brief Get the current rendered frame index.
+   * If there isn't any loaded frame, returns -1.
+   *
+   * @return Frame index of currently showing frame.
+   */
+  virtual int32_t GetCurrentFrameIndex() const = 0;
 
   /**
-   * Called before the texture manager is destroyed.
+   * @brief Get total frame count of the animated image file.
+   *
+   * @return Total frame count of the animated image file.
+   */
+  virtual int32_t GetTotalFrameCount() const = 0;
+
+  /**
+   * @brief Clears animated image cache and remove loaded textures.
+   */
+  virtual void ClearCache() = 0;
+
+  /**
+   * @brief Set default interval(ms) between each frame.
+   *
+   * @param[in] interval time interval in millisecond to be used as default interval.
+   */
+  virtual void SetInterval(uint32_t interval);
+
+private:
+  /**
+   * @brief Called before the texture manager is destroyed.
    */
   void TextureManagerDestroyed() final;
 
+  void AllocateMaskData();
+
 protected:
-  TextureManager&        mTextureManager;
-  FrameReadyObserver&    mObserver;
-  unsigned int           mBatchSize;
-  unsigned int           mUrlIndex;
-  bool                   mWaitingForReadyFrame:1;
-  bool                   mRequestingLoad:1;
-  bool                   mTextureManagerAlive:1;
+  TextureManager&                     mTextureManager;
+  FrameReadyObserver&                 mObserver;
+  TextureManager::MaskingDataPointer& mMaskingData;
+  uint32_t                            mBatchSize;
+  uint32_t                            mInterval;
+  TextureManager::LoadState           mLoadState;
+  bool                                mRequestingLoad : 1;
+  bool                                mTextureManagerAlive : 1;
 };
 
-} //namespace Internal
-} //namespace Toolkit
-} //namespace Dali
+} // namespace Internal
+} // namespace Toolkit
+} // namespace Dali
 
 #endif // DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H