[dali_2.1.40] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / animated-image / fixed-image-cache.cpp
index d71ee94..7cb6ce3 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * 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.
 // INTERNAL HEADERS
 #include <dali-toolkit/internal/visuals/image-atlas-manager.h> // For ImageAtlasManagerPtr
 
+// EXTERNAL HEADERS
+#include <dali/integration-api/debug.h>
+
 namespace Dali
 {
 namespace Toolkit
 {
 namespace Internal
 {
-
 namespace
 {
-const bool ENABLE_ORIENTATION_CORRECTION( true );
+constexpr bool     ENABLE_ORIENTATION_CORRECTION(true);
+constexpr uint32_t FIRST_FRAME_INDEX = 0u;
 } // namespace
 
-FixedImageCache::FixedImageCache(
-  TextureManager& textureManager, UrlList& urlList, ImageCache::FrameReadyObserver& observer,
-  unsigned int batchSize )
-: ImageCache( textureManager, observer, batchSize ),
-  mImageUrls( urlList ),
-  mFront(0u)
-{
-  mReadyFlags.reserve( mImageUrls.size() );
-  LoadBatch();
+FixedImageCache::FixedImageCache(TextureManager&                     textureManager,
+                                 UrlList&                            urlList,
+                                 TextureManager::MaskingDataPointer& maskingData,
+                                 ImageCache::FrameReadyObserver&     observer,
+                                 uint32_t                            batchSize,
+                                 uint32_t                            interval)
+: ImageCache(textureManager, maskingData, observer, batchSize, interval),
+  mImageUrls(urlList),
+  mFront(FIRST_FRAME_INDEX)
+{
+  mReadyFlags.reserve(mImageUrls.size());
 }
 
 FixedImageCache::~FixedImageCache()
 {
-  if( mTextureManagerAlive )
-  {
-    for( std::size_t i = 0; i < mImageUrls.size() ; ++i )
-    {
-      mTextureManager.Remove( mImageUrls[i].mTextureId, this );
-    }
-  }
+  ClearCache();
 }
 
-TextureSet FixedImageCache::Frame( uint32_t frameIndex )
+TextureSet FixedImageCache::Frame(uint32_t frameIndex)
 {
-  while( frameIndex > mFront )
+  TextureSet textureSet;
+  if(frameIndex >= mImageUrls.size())
   {
-    NextFrame();
+    DALI_LOG_ERROR("Wrong frameIndex requested.\n");
+    return textureSet;
   }
-  mFront = frameIndex;
 
-  TextureSet textureSet;
-  if( IsFrontReady() == true )
+  while(mReadyFlags.size() < mImageUrls.size() &&
+        (frameIndex > mFront || mReadyFlags.empty()))
   {
-    textureSet = GetFrontTextureSet();
+    ++mFront;
+    LoadBatch();
   }
-  else
+
+  mFront = frameIndex;
+
+  if(IsFrontReady() && mLoadState != TextureManager::LoadState::LOAD_FAILED)
   {
-    mWaitingForReadyFrame = true;
+    textureSet = GetFrontTextureSet();
   }
 
   return textureSet;
@@ -77,150 +81,130 @@ TextureSet FixedImageCache::Frame( uint32_t frameIndex )
 
 TextureSet FixedImageCache::FirstFrame()
 {
-  TextureSet textureSet = GetFrontTextureSet();
-
-  if( ! textureSet )
-  {
-    mWaitingForReadyFrame = true;
-  }
+  TextureSet textureSet = Frame(FIRST_FRAME_INDEX);
 
   return textureSet;
 }
 
-TextureSet FixedImageCache::NextFrame()
+uint32_t FixedImageCache::GetFrameInterval(uint32_t frameIndex) const
 {
-  TextureSet textureSet;
-  ++mFront;
-  mFront %= mImageUrls.size();
+  return mInterval;
+}
 
-  if( IsFrontReady() == true )
-  {
-    textureSet = GetFrontTextureSet();
-  }
-  else
-  {
-    mWaitingForReadyFrame = true;
-  }
-  LoadBatch();
+int32_t FixedImageCache::GetCurrentFrameIndex() const
+{
+  return static_cast<int32_t>(mFront);
+}
 
-  return textureSet;
+int32_t FixedImageCache::GetTotalFrameCount() const
+{
+  return mImageUrls.size();
 }
 
 bool FixedImageCache::IsFrontReady() const
 {
-  return ( mReadyFlags.size() > 0 && mReadyFlags[mFront] == true );
+  return (mReadyFlags.size() > 0 && mReadyFlags[mFront] == true);
 }
 
 void FixedImageCache::LoadBatch()
 {
   // Try and load up to mBatchSize images, until the cache is filled.
-  // Once the cache is filled, mUrlIndex exceeds mImageUrls size and
-  // no more images are loaded.
-  bool frontFrameReady = IsFrontReady();
-
-  for( unsigned int i=0; i< mBatchSize && mUrlIndex < mImageUrls.size(); ++i )
+  // Once the cache is filled, no more images are loaded.
+  for(unsigned int i = 0; i < mBatchSize && mReadyFlags.size() < mImageUrls.size(); ++i)
   {
-    std::string& url = mImageUrls[ mUrlIndex ].mUrl;
+    uint32_t   frameIndex = mReadyFlags.size();
+    VisualUrl& url        = mImageUrls[frameIndex].mUrl;
 
     mReadyFlags.push_back(false);
 
-    // Note, if the image is already loaded, then UploadComplete will get called
+    // Note, if the image is already loaded, then LoadComplete will get called
     // from within this method. This means it won't yet have a texture id, so we
-    // need to account for this inside the UploadComplete method using mRequestingLoad.
+    // need to account for this inside the LoadComplete method using mRequestingLoad.
     mRequestingLoad = true;
-
-    bool synchronousLoading = false;
-    bool atlasingStatus = false;
-    bool loadingStatus = false;
-    TextureManager::MaskingDataPointer maskInfo = nullptr;
-    AtlasUploadObserver* atlasObserver = nullptr;
-    ImageAtlasManagerPtr imageAtlasManager = nullptr;
-    Vector4 textureRect;
+    mLoadState      = TextureManager::LoadState::LOADING;
+
+    bool                  synchronousLoading = false;
+    bool                  atlasingStatus     = false;
+    bool                  loadingStatus      = false;
+    AtlasUploadObserver*  atlasObserver      = nullptr;
+    ImageAtlasManagerPtr  imageAtlasManager  = nullptr;
+    Vector4               textureRect;
     Dali::ImageDimensions textureRectSize;
-    auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
-
-    mTextureManager.LoadTexture(
-      url, ImageDimensions(), FittingMode::SCALE_TO_FILL,
-      SamplingMode::BOX_THEN_LINEAR, maskInfo,
-      synchronousLoading, mImageUrls[ mUrlIndex ].mTextureId, textureRect, textureRectSize,
-      atlasingStatus, loadingStatus, Dali::WrapMode::Type::DEFAULT,
-      Dali::WrapMode::Type::DEFAULT, this,
-      atlasObserver, imageAtlasManager, ENABLE_ORIENTATION_CORRECTION, TextureManager::ReloadPolicy::CACHED,
-      preMultiply );
-
-    if( loadingStatus == false )  // not loading, means it's already ready.
-    {
-      SetImageFrameReady( mImageUrls[ mUrlIndex ].mTextureId );
-    }
+    auto                  preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
+
+    mTextureManager.LoadTexture(url, ImageDimensions(), FittingMode::SCALE_TO_FILL, SamplingMode::BOX_THEN_LINEAR, mMaskingData, synchronousLoading, mImageUrls[frameIndex].mTextureId, textureRect, textureRectSize, atlasingStatus, loadingStatus, this, atlasObserver, imageAtlasManager, ENABLE_ORIENTATION_CORRECTION, TextureManager::ReloadPolicy::CACHED, preMultiply);
     mRequestingLoad = false;
-    ++mUrlIndex;
   }
-
-  CheckFrontFrame( frontFrameReady );
 }
 
-void FixedImageCache::SetImageFrameReady( TextureManager::TextureId textureId )
+TextureSet FixedImageCache::GetFrontTextureSet() const
 {
-  for( std::size_t i = 0; i < mImageUrls.size() ; ++i )
+  TextureSet textureSet = mTextureManager.GetTextureSet(mImageUrls[mFront].mTextureId);
+  if(textureSet)
   {
-    if( mImageUrls[i].mTextureId == textureId )
-    {
-      mReadyFlags[i] = true;
-      break;
-    }
+    Sampler sampler = Sampler::New();
+    sampler.SetWrapMode(Dali::WrapMode::Type::DEFAULT, Dali::WrapMode::Type::DEFAULT);
+    textureSet.SetSampler(0u, sampler);
   }
+  return textureSet;
 }
 
-TextureSet FixedImageCache::GetFrontTextureSet() const
+void FixedImageCache::CheckFrontFrame(bool wasReady)
 {
-  return mTextureManager.GetTextureSet( mImageUrls[mFront].mTextureId );
+  if(wasReady == false && IsFrontReady())
+  {
+    mObserver.FrameReady(GetFrontTextureSet(), mInterval);
+  }
 }
 
-void FixedImageCache::CheckFrontFrame( bool wasReady )
+void FixedImageCache::ClearCache()
 {
-  if( mWaitingForReadyFrame && wasReady == false && IsFrontReady() )
+  if(mTextureManagerAlive)
   {
-    mWaitingForReadyFrame = false;
-    mObserver.FrameReady( GetFrontTextureSet() );
+    for(std::size_t i = 0; i < mImageUrls.size(); ++i)
+    {
+      mTextureManager.Remove(mImageUrls[i].mTextureId, this);
+      mImageUrls[i].mTextureId = TextureManager::INVALID_TEXTURE_ID;
+    }
+  }
+  mReadyFlags.clear();
+  mLoadState = TextureManager::LoadState::NOT_STARTED;
+  if(mMaskingData)
+  {
+    mMaskingData->mAlphaMaskId = TextureManager::INVALID_TEXTURE_ID;
   }
 }
 
-void FixedImageCache::UploadComplete(
-  bool           loadSuccess,
-  int32_t        textureId,
-  TextureSet     textureSet,
-  bool           useAtlasing,
-  const Vector4& atlasRect,
-  bool           preMultiplied)
+void FixedImageCache::LoadComplete(bool loadSuccess, TextureInformation textureInformation)
 {
-  bool frontFrameReady = IsFrontReady();
-
-  if( ! mRequestingLoad )
+  if(loadSuccess)
   {
-    SetImageFrameReady( textureId );
-
-    CheckFrontFrame( frontFrameReady );
+    mLoadState           = TextureManager::LoadState::LOAD_FINISHED;
+    bool frontFrameReady = IsFrontReady();
+    if(!mRequestingLoad)
+    {
+      for(std::size_t i = 0; i < mImageUrls.size(); ++i)
+      {
+        if(mImageUrls[i].mTextureId == textureInformation.textureId)
+        {
+          mReadyFlags[i] = true;
+          break;
+        }
+      }
+    }
+    else
+    {
+      mReadyFlags.back() = true;
+    }
+    CheckFrontFrame(frontFrameReady);
   }
   else
   {
-    // UploadComplete has been called from within RequestLoad. TextureManager must
-    // therefore already have the texture cached, so make the texture ready.
-    // (Use the last texture, as the texture id hasn't been assigned yet)
-    mReadyFlags.back() = true;
+    mLoadState = TextureManager::LoadState::LOAD_FAILED;
+    mObserver.FrameReady(TextureSet(), 0);
   }
 }
 
-void FixedImageCache::LoadComplete(
-  bool loadSuccess,
-  Devel::PixelBuffer pixelBuffer,
-  const VisualUrl& url,
-  bool preMultiplied )
-{
-  // LoadComplete is called if this TextureUploadObserver requested to load
-  // an image that will be returned as a type of PixelBuffer by using a method
-  // TextureManager::LoadPixelBuffer.
-}
-
 } //namespace Internal
 } //namespace Toolkit
 } //namespace Dali
\ No newline at end of file