Updated all header files to new format
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / animated-image / rolling-image-cache.h
index c20586f..1fcbe88 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_ROLLING_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.
@@ -19,9 +19,9 @@
 
 // EXTERNAL INCLUDES
 
-#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/common/circular-queue.h>
 
 namespace Dali
 {
@@ -29,7 +29,6 @@ namespace Toolkit
 {
 namespace Internal
 {
-
 /**
  * Class to manage a rolling cache of images, where the cache size
  * is smaller than the total number of images.
@@ -48,11 +47,11 @@ public:
    * 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);
 
   /**
    * Destructor
@@ -63,7 +62,7 @@ public:
    * 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
@@ -80,7 +79,7 @@ public:
   /**
    * Get the interval of Nth frame.
    */
-  uint32_t GetFrameInterval( uint32_t frameIndex ) const override;
+  uint32_t GetFrameInterval(uint32_t frameIndex) const override;
 
   /**
    * Get the current rendered frame index.
@@ -88,6 +87,11 @@ public:
    */
   int32_t GetCurrentFrameIndex() const override;
 
+  /**
+   * Get total frame count of the animated image file.
+   */
+  int32_t GetTotalFrameCount() const override;
+
 private:
   /**
    * @return true if the front frame is ready
@@ -102,7 +106,7 @@ private:
   /**
    * Find the matching image frame, and set it to ready
    */
-  void SetImageFrameReady( TextureManager::TextureId textureId );
+  void SetImageFrameReady(TextureManager::TextureId textureId);
 
   /**
    * Get the texture set of the front frame.
@@ -113,13 +117,13 @@ 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 );
+  void CheckFrontFrame(bool wasReady);
 
 protected:
   void UploadComplete(
@@ -128,13 +132,13 @@ protected:
     TextureSet     textureSet,
     bool           useAtlasing,
     const Vector4& atlasRect,
-    bool           preMultiplied ) override;
+    bool           preMultiplied) override;
 
   void LoadComplete(
-    bool loadSuccess,
+    bool               loadSuccess,
     Devel::PixelBuffer pixelBuffer,
-    const VisualUrl& url,
-    bool preMultiplied ) override;
+    const VisualUrl&   url,
+    bool               preMultiplied) override;
 
 private:
   /**
@@ -143,10 +147,10 @@ private:
   struct ImageFrame
   {
     unsigned int mUrlIndex = 0u;
-    bool mReady = false;
+    bool         mReady    = false;
   };
 
-  std::vector<UrlStore>& mImageUrls;
+  std::vector<UrlStore>&    mImageUrls;
   CircularQueue<ImageFrame> mQueue;
 };