Trigger svg loading early
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / svg / svg-rasterize-thread.cpp
index 75286ca..c6e0a2c 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.
@@ -19,8 +19,8 @@
 #include "svg-rasterize-thread.h"
 
 // EXTERNAL INCLUDES
-#include <dali/devel-api/adaptor-framework/thread-settings.h>
 #include <dali/devel-api/adaptor-framework/file-loader.h>
+#include <dali/devel-api/adaptor-framework/thread-settings.h>
 #include <dali/integration-api/adaptor-framework/adaptor.h>
 #include <dali/integration-api/debug.h>
 
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 namespace Internal
 {
-
-RasterizingTask::RasterizingTask( SvgVisual* svgRenderer, VectorImageRenderer vectorRenderer, const VisualUrl& url, float dpi, unsigned int width, unsigned int height, bool loaded)
-: mSvgVisual( svgRenderer ),
-  mVectorRenderer( vectorRenderer ),
-  mUrl( url ),
-  mDpi( dpi ),
-  mWidth( width ),
-  mHeight( height ),
-  mLoaded( loaded )
+SvgTask::SvgTask(SvgVisual* svgVisual, VectorImageRenderer vectorRenderer)
+: mSvgVisual(svgVisual),
+  mVectorRenderer(vectorRenderer),
+  mHasSucceeded(false)
 {
-
 }
 
-RasterizingTask::~RasterizingTask()
+SvgVisual* SvgTask::GetSvgVisual() const
 {
+  return mSvgVisual.Get();
 }
 
-void RasterizingTask::Load()
+PixelData SvgTask::GetPixelData() const
 {
-  if(!mLoaded && !mUrl.IsLocalResource())
-  {
-    Dali::Vector<uint8_t> remoteBuffer;
-    if(!Dali::FileLoader::DownloadFileSynchronously(mUrl.GetUrl(), remoteBuffer))
-    {
-      DALI_LOG_ERROR("RasterizingTask::Load: Failed to download file! [%s]\n", mUrl.GetUrl().c_str());
-      return;
-    }
+  return PixelData();
+}
 
-    remoteBuffer.PushBack('\0');
+bool SvgTask::HasSucceeded() const
+{
+  return mHasSucceeded;
+}
 
-    if(!mVectorRenderer.Load(remoteBuffer, mDpi))
-    {
-      DALI_LOG_ERROR("RasterizingTask::Load:Failed to load data! [%s]\n", mUrl.GetUrl().c_str());
-      return;
-    }
+SvgLoadingTask::SvgLoadingTask(SvgVisual* svgVisual, VectorImageRenderer vectorRenderer, const VisualUrl& url, float dpi)
+: SvgTask(svgVisual, vectorRenderer),
+  mUrl(url),
+  mDpi(dpi)
+{
+}
 
-    mLoaded = true;
-  }
+SvgLoadingTask::~SvgLoadingTask()
+{
 }
 
-void RasterizingTask::Rasterize()
+void SvgLoadingTask::Process()
 {
-  if(mWidth <= 0u || mHeight <= 0u)
+  if(mVectorRenderer.IsLoaded())
   {
-    DALI_LOG_ERROR("RasterizingTask::Rasterize: Size is zero!\n");
+    // Already loaded
+    mHasSucceeded = true;
     return;
   }
 
-  Devel::PixelBuffer pixelBuffer = Devel::PixelBuffer::New(mWidth, mHeight, Dali::Pixel::RGBA8888);
+  Dali::Vector<uint8_t> buffer;
 
-  uint32_t defaultWidth, defaultHeight;
-  mVectorRenderer.GetDefaultSize(defaultWidth, defaultHeight);
+  if(!mUrl.IsLocalResource())
+  {
+    if(!Dali::FileLoader::DownloadFileSynchronously(mUrl.GetUrl(), buffer))
+    {
+      DALI_LOG_ERROR("Failed to download file! [%s]\n", mUrl.GetUrl().c_str());
+      return;
+    }
+  }
+  else
+  {
+    if(!Dali::FileLoader::ReadFile(mUrl.GetUrl(), buffer))
+    {
+      DALI_LOG_ERROR("Failed to read file! [%s]\n", mUrl.GetUrl().c_str());
+      return;
+    }
+  }
 
-  float scaleX = static_cast<float>(mWidth) / static_cast<float>(defaultWidth);
-  float scaleY = static_cast<float>(mHeight) / static_cast<float>(defaultHeight);
-  float scale  = scaleX < scaleY ? scaleX : scaleY;
+  buffer.PushBack('\0');
 
-  if(!mVectorRenderer.Rasterize(pixelBuffer, scale))
+  if(!mVectorRenderer.Load(buffer, mDpi))
   {
-    DALI_LOG_ERROR("RasterizingTask::Rasterize: Rasterize is failed! [%s]\n", mUrl.GetUrl().c_str());
+    DALI_LOG_ERROR("Failed to load data! [%s]\n", mUrl.GetUrl().c_str());
     return;
   }
 
-  mPixelData = Devel::PixelBuffer::Convert(pixelBuffer);
+  mHasSucceeded = true;
 }
 
-VectorImageRenderer RasterizingTask::GetVectorRenderer() const
+SvgRasterizingTask::SvgRasterizingTask(SvgVisual* svgVisual, VectorImageRenderer vectorRenderer, unsigned int width, unsigned int height)
+: SvgTask(svgVisual, vectorRenderer),
+  mWidth(width),
+  mHeight(height)
 {
-  return mVectorRenderer;
 }
 
-bool RasterizingTask::IsLoaded() const
+SvgRasterizingTask::~SvgRasterizingTask()
 {
-  return mLoaded;
 }
 
-SvgVisual* RasterizingTask::GetSvgVisual() const
+void SvgRasterizingTask::Process()
 {
-  return mSvgVisual.Get();
+  if(!mVectorRenderer.IsLoaded())
+  {
+    DALI_LOG_ERROR("File is not loaded!\n");
+    return;
+  }
+
+  Devel::PixelBuffer pixelBuffer = mVectorRenderer.Rasterize(mWidth, mHeight);
+  if(!pixelBuffer)
+  {
+    DALI_LOG_ERROR("Rasterize is failed!\n");
+    return;
+  }
+
+  mPixelData    = Devel::PixelBuffer::Convert(pixelBuffer);
+  mHasSucceeded = true;
 }
 
-PixelData RasterizingTask::GetPixelData() const
+PixelData SvgRasterizingTask::GetPixelData() const
 {
   return mPixelData;
 }
 
-SvgRasterizeThread::SvgRasterizeThread( EventThreadCallback* trigger )
-: mTrigger( std::unique_ptr< EventThreadCallback >(trigger) ),
-  mLogFactory( Dali::Adaptor::Get().GetLogFactory() ),
-  mIsThreadWaiting( false )
+SvgRasterizeThread::SvgRasterizeThread()
+: mTrigger(new EventThreadCallback(MakeCallback(this, &SvgRasterizeThread::ApplyRasterizedSVGToSampler))),
+  mLogFactory(Dali::Adaptor::Get().GetLogFactory()),
+  mIsThreadWaiting(false),
+  mProcessorRegistered(false)
 {
 }
 
 SvgRasterizeThread::~SvgRasterizeThread()
 {
+  if(mProcessorRegistered)
+  {
+    Adaptor::Get().UnregisterProcessor(*this);
+  }
 }
 
-void SvgRasterizeThread::TerminateThread( SvgRasterizeThread*& thread )
+void SvgRasterizeThread::TerminateThread(SvgRasterizeThread*& thread)
 {
-  if( thread )
+  if(thread)
   {
     // add an empty task would stop the thread from conditional wait.
-    thread->AddTask( RasterizingTaskPtr() );
+    thread->AddTask(SvgTaskPtr());
     // stop the thread
     thread->Join();
     // delete the thread
@@ -146,118 +170,110 @@ void SvgRasterizeThread::TerminateThread( SvgRasterizeThread*& thread )
   }
 }
 
-void SvgRasterizeThread::AddTask( RasterizingTaskPtr task )
+void SvgRasterizeThread::AddTask(SvgTaskPtr task)
 {
   bool wasEmpty = false;
 
   {
     // Lock while adding task to the queue
-    ConditionalWait::ScopedLock lock( mConditionalWait );
+    ConditionalWait::ScopedLock lock(mConditionalWait);
     wasEmpty = mRasterizeTasks.empty();
-    if( !wasEmpty && task != NULL)
+    if(!wasEmpty && task)
     {
       // Remove the tasks with the same renderer.
       // Older task which waiting to rasterize and apply the svg to the same renderer is expired.
-      for( std::vector< RasterizingTaskPtr >::iterator it = mRasterizeTasks.begin(), endIt = mRasterizeTasks.end(); it != endIt; ++it )
+      // Rasterizing task only, loading task is not duplicated.
+      for(std::vector<SvgTaskPtr>::iterator it = mRasterizeTasks.begin(), endIt = mRasterizeTasks.end(); it != endIt; ++it)
       {
-        if( (*it) && (*it)->GetSvgVisual() == task->GetSvgVisual() )
+        if((*it) && (*it)->GetSvgVisual() == task->GetSvgVisual())
         {
-          mRasterizeTasks.erase( it );
-          break;
+          SvgRasterizingTask* oldTask = dynamic_cast<SvgRasterizingTask*>(it->Get());
+          SvgRasterizingTask* newTask = dynamic_cast<SvgRasterizingTask*>(task.Get());
+          if(oldTask && newTask)
+          {
+            mRasterizeTasks.erase(it);
+            break;
+          }
         }
       }
     }
-    mRasterizeTasks.push_back( task );
+    mRasterizeTasks.push_back(task);
+
+    if(!mProcessorRegistered)
+    {
+      Adaptor::Get().RegisterProcessor(*this);
+      mProcessorRegistered = true;
+    }
   }
 
-  if( wasEmpty)
+  if(wasEmpty)
   {
     // wake up the image loading thread
     mConditionalWait.Notify();
   }
 }
 
-RasterizingTaskPtr SvgRasterizeThread::NextCompletedTask()
+SvgTaskPtr SvgRasterizeThread::NextCompletedTask()
 {
   // Lock while popping task out from the queue
-  Mutex::ScopedLock lock( mMutex );
+  Mutex::ScopedLock lock(mMutex);
 
-  if( mCompletedTasks.empty() )
+  if(mCompletedTasks.empty())
   {
-    return RasterizingTaskPtr();
+    return SvgTaskPtr();
   }
 
-  std::vector< RasterizingTaskPtr >::iterator next = mCompletedTasks.begin();
-  RasterizingTaskPtr nextTask = *next;
-  mCompletedTasks.erase( next );
+  std::vector<SvgTaskPtr>::iterator next     = mCompletedTasks.begin();
+  SvgTaskPtr                        nextTask = *next;
+  mCompletedTasks.erase(next);
 
   return nextTask;
 }
 
-void SvgRasterizeThread::RemoveTask( SvgVisual* visual )
+void SvgRasterizeThread::RemoveTask(SvgVisual* visual)
 {
   // Lock while remove task from the queue
-  ConditionalWait::ScopedLock lock( mConditionalWait );
-  if( !mRasterizeTasks.empty() )
+  ConditionalWait::ScopedLock lock(mConditionalWait);
+  if(!mRasterizeTasks.empty())
   {
-    for( std::vector< RasterizingTaskPtr >::iterator it = mRasterizeTasks.begin(), endIt = mRasterizeTasks.end(); it != endIt; ++it )
+    for(std::vector<SvgTaskPtr>::iterator it = mRasterizeTasks.begin(), endIt = mRasterizeTasks.end(); it != endIt; ++it)
     {
-      if( (*it) &&  (*it)->GetSvgVisual() == visual )
+      if((*it) && (*it)->GetSvgVisual() == visual)
       {
-        mRasterizeTasks.erase( it );
-        break;
+        mRasterizeTasks.erase(it);
       }
     }
   }
-}
-
-void SvgRasterizeThread::DeleteImage( VectorImageRenderer vectorRenderer )
-{
-  // Lock while adding image to the delete queue
-  ConditionalWait::ScopedLock lock( mConditionalWait );
 
-  if( mIsThreadWaiting ) // no rasterization is ongoing, save to delete
-  {
-    // TODO: what?
-  }
-  else // wait to delete until current rasterization completed.
-  {
-    mDeleteSvg.PushBack( &vectorRenderer );
-  }
+  UnregisterProcessor();
 }
 
-RasterizingTaskPtr SvgRasterizeThread::NextTaskToProcess()
+SvgTaskPtr SvgRasterizeThread::NextTaskToProcess()
 {
   // Lock while popping task out from the queue
-  ConditionalWait::ScopedLock lock( mConditionalWait );
-
-  // Delete the image here to make sure that it is not used in the nsvgRasterize()
-  if( !mDeleteSvg.Empty() )
-  {
-    mDeleteSvg.Clear();
-  }
+  ConditionalWait::ScopedLock lock(mConditionalWait);
 
   // conditional wait
-  while( mRasterizeTasks.empty() )
+  while(mRasterizeTasks.empty())
   {
     mIsThreadWaiting = true;
-    mConditionalWait.Wait( lock );
+    mConditionalWait.Wait(lock);
   }
   mIsThreadWaiting = false;
 
   // pop out the next task from the queue
-  std::vector< RasterizingTaskPtr >::iterator next = mRasterizeTasks.begin();
-  RasterizingTaskPtr nextTask = *next;
-  mRasterizeTasks.erase( next );
+  std::vector<SvgTaskPtr>::iterator next     = mRasterizeTasks.begin();
+  SvgTaskPtr                        nextTask = *next;
+  mRasterizeTasks.erase(next);
 
   return nextTask;
 }
 
-void SvgRasterizeThread::AddCompletedTask( RasterizingTaskPtr task )
+void SvgRasterizeThread::AddCompletedTask(SvgTaskPtr task)
 {
   // Lock while adding task to the queue
-  Mutex::ScopedLock lock( mMutex );
-  mCompletedTasks.push_back( task );
+  Mutex::ScopedLock lock(mMutex);
+  mCompletedTasks.push_back(task);
 
   // wake up the main thread
   mTrigger->Trigger();
@@ -265,14 +281,40 @@ void SvgRasterizeThread::AddCompletedTask( RasterizingTaskPtr task )
 
 void SvgRasterizeThread::Run()
 {
-  SetThreadName( "SVGThread" );
+  SetThreadName("SVGThread");
   mLogFactory.InstallLogFunction();
 
-  while( RasterizingTaskPtr task = NextTaskToProcess() )
+  while(SvgTaskPtr task = NextTaskToProcess())
   {
-    task->Load( );
-    task->Rasterize( );
-    AddCompletedTask( task );
+    task->Process();
+    AddCompletedTask(task);
+  }
+}
+
+void SvgRasterizeThread::ApplyRasterizedSVGToSampler()
+{
+  while(SvgTaskPtr task = NextCompletedTask())
+  {
+    task->GetSvgVisual()->ApplyRasterizedImage(task->GetPixelData(), task->HasSucceeded());
+  }
+
+  UnregisterProcessor();
+}
+
+void SvgRasterizeThread::Process(bool postProcessor)
+{
+  ApplyRasterizedSVGToSampler();
+}
+
+void SvgRasterizeThread::UnregisterProcessor()
+{
+  if(mProcessorRegistered)
+  {
+    if(mRasterizeTasks.empty() && mCompletedTasks.empty())
+    {
+      Adaptor::Get().UnregisterProcessor(*this);
+      mProcessorRegistered = false;
+    }
   }
 }