Register PixelArea property only if required.
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / image / image-visual.cpp
index 18cf2b4..49635e4 100644 (file)
@@ -27,6 +27,7 @@
 #include <dali/devel-api/scripting/scripting.h>
 #include <dali/integration-api/debug.h>
 #include <dali/public-api/actors/layer.h>
+#include <dali/public-api/adaptor-framework/async-task-manager.h>
 #include <dali/public-api/rendering/decorated-visual-renderer.h>
 #include <cstring> // for strlen()
 
@@ -200,6 +201,8 @@ ImageVisual::~ImageVisual()
     {
       RemoveTexture();
     }
+
+    ResetFastTrackLoadingTask();
   }
 }
 
@@ -283,6 +286,10 @@ void ImageVisual::DoSetProperties(const Property::Map& propertyMap)
       {
         DoSetProperty(Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, keyValue.second);
       }
+      else if(keyValue.first == FAST_TRACK_UPLOADING_NAME)
+      {
+        DoSetProperty(Toolkit::DevelImageVisual::Property::FAST_TRACK_UPLOADING, keyValue.second);
+      }
     }
   }
   // Load image immediately if LOAD_POLICY requires it
@@ -477,6 +484,16 @@ void ImageVisual::DoSetProperty(Property::Index index, const Property::Value& va
       }
       break;
     }
+
+    case Toolkit::DevelImageVisual::Property::FAST_TRACK_UPLOADING:
+    {
+      bool fastTrackUploading = false;
+      if(value.Get(fastTrackUploading))
+      {
+        mUseFastTrackUploading = fastTrackUploading;
+      }
+      break;
+    }
   }
 }
 
@@ -634,9 +651,76 @@ void ImageVisual::LoadTexture(bool& atlasing, Vector4& atlasRect, TextureSet& te
                              : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
 
   bool synchronousLoading = IsSynchronousLoadingRequired();
-  bool loadingStatus;
+  bool loadingStatus      = false;
 
-  textures = textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode, mMaskingData, synchronousLoading, mTextureId, atlasRect, mAtlasRectSize, atlasing, loadingStatus, textureObserver, atlasUploadObserver, atlasManager, mOrientationCorrection, forceReload, preMultiplyOnLoad);
+  // Remove previous loading task.
+  ResetFastTrackLoadingTask();
+
+  // Rare case. If someone call LoadTexture during fast track loading task running, (Ex : Action::RELOAD)
+  // we should remove previously added renderer now.
+  if(mRendererAdded)
+  {
+    Actor actor = mPlacementActor.GetHandle();
+    if(actor)
+    {
+      actor.RemoveRenderer(mImpl->mRenderer);
+      mRendererAdded = false;
+    }
+  }
+
+  /**
+   * @brief Check whether FastTrackUploading is avaliable or not.
+   * @return True if we can use fast track uploading feature. False otherwise.
+   */
+  auto IsFastTrackUploadingAvailable = [&]() {
+    if(mUseFastTrackUploading &&
+       mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::ATTACHED &&
+       mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED &&
+       forceReload == TextureManager::ReloadPolicy::CACHED &&
+       (mImageUrl.GetProtocolType() == VisualUrl::LOCAL || mImageUrl.GetProtocolType() == VisualUrl::REMOTE) &&
+       !synchronousLoading &&
+       !atlasing &&
+       !mImpl->mCustomShader &&
+       !(mMaskingData && mMaskingData->mAlphaMaskUrl.IsValid()))
+    {
+      return true;
+    }
+    else if(mUseFastTrackUploading)
+    {
+      DALI_LOG_DEBUG_INFO("FastTrack : Fail to load fast track. mUrl : [%s]%s%s%s%s%s%s%s%s\n",
+                          mImageUrl.GetUrl().c_str(),
+                          (mLoadPolicy != Toolkit::ImageVisual::LoadPolicy::ATTACHED) ? "/ mLoadPolicy != ATTACHED" : "",
+                          (mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::DETACHED) ? "/ mReleasePolicy != DETACHED" : "",
+                          (forceReload != TextureManager::ReloadPolicy::CACHED) ? "/ forceReload != CACHED" : "",
+                          (!(mImageUrl.GetProtocolType() == VisualUrl::LOCAL || mImageUrl.GetProtocolType() == VisualUrl::REMOTE)) ? "/ url is not image" : "",
+                          (synchronousLoading) ? "/ synchronousLoading" : "",
+                          (atlasing) ? "/ atlasing" : "",
+                          (mImpl->mCustomShader) ? "/ use customs shader" : "",
+                          (mMaskingData && mMaskingData->mAlphaMaskUrl.IsValid()) ? "/ use masking url" : "");
+    }
+    return false;
+  };
+
+  if(IsFastTrackUploadingAvailable())
+  {
+    // Enable PremultipliedAlpha first.
+    EnablePreMultipliedAlpha(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
+
+    // Set new TextureSet with fast track loading task
+    mFastTrackLoadingTask = new FastTrackLoadingTask(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode, mOrientationCorrection, preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD ? DevelAsyncImageLoader::PreMultiplyOnLoad::ON : DevelAsyncImageLoader::PreMultiplyOnLoad::OFF, MakeCallback(this, &ImageVisual::FastLoadComplete));
+
+    TextureSet textureSet = TextureSet::New();
+    textureSet.SetTexture(0u, mFastTrackLoadingTask->mTexture);
+    mImpl->mRenderer.SetTextures(textureSet);
+
+    Dali::AsyncTaskManager::Get().AddTask(mFastTrackLoadingTask);
+
+    mLoadState = TextureManager::LoadState::LOADING;
+  }
+  else
+  {
+    textures = textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode, mMaskingData, synchronousLoading, mTextureId, atlasRect, mAtlasRectSize, atlasing, loadingStatus, textureObserver, atlasUploadObserver, atlasManager, mOrientationCorrection, forceReload, preMultiplyOnLoad);
+  }
 
   if(textures)
   {
@@ -770,6 +854,7 @@ void ImageVisual::DoSetOnScene(Actor& actor)
   if(mLoadState == TextureManager::LoadState::LOAD_FINISHED)
   {
     actor.AddRenderer(mImpl->mRenderer);
+    mRendererAdded = true;
     mPlacementActor.Reset();
 
     // Image loaded and ready to display
@@ -780,6 +865,14 @@ void ImageVisual::DoSetOnScene(Actor& actor)
     ShowBrokenImage();
     ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
   }
+  else
+  {
+    if(mFastTrackLoadingTask)
+    {
+      actor.AddRenderer(mImpl->mRenderer);
+      mRendererAdded = true;
+    }
+  }
 }
 
 void ImageVisual::DoSetOffScene(Actor& actor)
@@ -788,6 +881,8 @@ void ImageVisual::DoSetOffScene(Actor& actor)
 
   // Image release is dependent on the ReleasePolicy, renderer is removed.
   actor.RemoveRenderer(mImpl->mRenderer);
+  mRendererAdded = false;
+
   if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
   {
     ResetRenderer();
@@ -830,6 +925,8 @@ void ImageVisual::DoCreatePropertyMap(Property::Map& map) const
   map.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy);
   map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
   map.Insert(Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, mOrientationCorrection);
+
+  map.Insert(Toolkit::DevelImageVisual::Property::FAST_TRACK_UPLOADING, mUseFastTrackUploading);
 }
 
 void ImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
@@ -885,6 +982,7 @@ void ImageVisual::UploadCompleted()
   {
     mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
     actor.AddRenderer(mImpl->mRenderer);
+    mRendererAdded = true;
     // reset the weak handle so that the renderer only get added to actor once
     mPlacementActor.Reset();
   }
@@ -894,6 +992,39 @@ void ImageVisual::UploadCompleted()
   mLoadState = TextureManager::LoadState::LOAD_FINISHED;
 }
 
+// From FastTrackLoadingTask
+void ImageVisual::FastLoadComplete(FastTrackLoadingTaskPtr task)
+{
+  Toolkit::Visual::ResourceStatus resourceStatus;
+
+  DALI_ASSERT_ALWAYS(mFastTrackLoadingTask == task && "Task was not canceled successfully!");
+  DALI_ASSERT_ALWAYS(mRendererAdded && "Some FastTrack logic missed!");
+
+  Actor actor = mPlacementActor.GetHandle();
+
+  if(mFastTrackLoadingTask && mFastTrackLoadingTask->mLoadSuccess)
+  {
+    resourceStatus = Toolkit::Visual::ResourceStatus::READY;
+    mLoadState     = TextureManager::LoadState::LOAD_FINISHED;
+
+    // Change premultiplied alpha flag after change renderer.
+    EnablePreMultipliedAlpha(mFastTrackLoadingTask->mPremultiplied);
+  }
+  else
+  {
+    resourceStatus = Toolkit::Visual::ResourceStatus::FAILED;
+    mLoadState     = TextureManager::LoadState::LOAD_FAILED;
+
+    // Change renderer as broken.
+    ShowBrokenImage();
+  }
+
+  mFastTrackLoadingTask.Reset();
+
+  // Signal to observers ( control ) that resources are ready. Must be all resources.
+  ResourceReady(resourceStatus);
+}
+
 // From Texture Manager
 void ImageVisual::LoadComplete(bool loadingSuccess, TextureInformation textureInformation)
 {
@@ -938,6 +1069,7 @@ void ImageVisual::LoadComplete(bool loadingSuccess, TextureInformation textureIn
       if(actor)
       {
         actor.AddRenderer(mImpl->mRenderer);
+        mRendererAdded = true;
         // reset the weak handle so that the renderer only get added to actor once
         mPlacementActor.Reset();
       }
@@ -1005,6 +1137,8 @@ void ImageVisual::RemoveTexture()
   }
   else
   {
+    ResetFastTrackLoadingTask();
+
     Vector4         atlasRect(0.f, 0.f, 1.f, 1.f);
     Property::Index index = mImpl->mRenderer.GetPropertyIndex(ATLAS_RECT_UNIFORM_NAME);
     if(index != Property::INVALID_INDEX)
@@ -1080,7 +1214,6 @@ Shader ImageVisual::GenerateShader() const
 {
   Shader shader;
 
-  bool       usesWholeTexture  = true;
   const bool useStandardShader = !mImpl->mCustomShader;
   const bool useNativeImage    = (mTextures && DevelTexture::IsNative(mTextures.GetTexture(0)));
 
@@ -1101,6 +1234,7 @@ Shader ImageVisual::GenerateShader() const
   }
   else
   {
+    bool             usesWholeTexture = true;
     std::string_view vertexShaderView;
     std::string_view fragmentShaderView;
 
@@ -1144,11 +1278,11 @@ Shader ImageVisual::GenerateShader() const
     {
       shader = Shader::New(vertexShaderView, fragmentShaderView, mImpl->mCustomShader->mHints);
     }
-  }
 
-  if(usesWholeTexture)
-  {
-    shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
+    if(usesWholeTexture)
+    {
+      shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
+    }
   }
 
   return shader;
@@ -1200,21 +1334,46 @@ void ImageVisual::ShowBrokenImage()
     {
       imageSize           = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
       mPlacementActorSize = imageSize;
+
+      if(mRendererAdded)
+      {
+        actor.RemoveRenderer(mImpl->mRenderer);
+        mRendererAdded = false;
+      }
     }
 
     mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
     if(actor)
     {
       actor.AddRenderer(mImpl->mRenderer);
+      mRendererAdded = true;
       mPlacementActor.Reset();
     }
   }
   else
   {
+    if(mRendererAdded)
+    {
+      Actor actor = mPlacementActor.GetHandle();
+      if(actor)
+      {
+        actor.RemoveRenderer(mImpl->mRenderer);
+        mRendererAdded = false;
+      }
+    }
     ResetRenderer();
   }
 }
 
+void ImageVisual::ResetFastTrackLoadingTask()
+{
+  if(mFastTrackLoadingTask)
+  {
+    Dali::AsyncTaskManager::Get().RemoveTask(mFastTrackLoadingTask);
+    mFastTrackLoadingTask.Reset();
+  }
+}
+
 } // namespace Internal
 
 } // namespace Toolkit