(AnimatedVectorImageVisual) Prevent properties from being updated during rendering

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / animated-vector-image / vector-rasterize-thread.cpp

diff --git a/dali-toolkit/internal/visuals/animated-vector-image/vector-rasterize-thread.cpp b/dali-toolkit/internal/visuals/animated-vector-image/vector-rasterize-thread.cpp
index 49477ea..da46e1e 100644 (file)
--- a/dali-toolkit/internal/visuals/animated-vector-image/vector-rasterize-thread.cpp
+++ b/dali-toolkit/internal/visuals/animated-vector-image/vector-rasterize-thread.cpp
@@ -22,8 +22,8 @@
 #include <dali/devel-api/adaptor-framework/thread-settings.h>
 #include <dali/integration-api/adaptors/adaptor.h>
 #include <dali/integration-api/debug.h>
-
-// INTERNAL INCLUDES
+#include <chrono>
+#include <thread>
 
 namespace Dali
 {
@@ -38,23 +38,34 @@ namespace
 {
 
 constexpr auto LOOP_FOREVER = -1;
+constexpr auto NANOSECONDS_PER_SECOND( 1e+9 );
 
 #if defined(DEBUG_ENABLED)
 Debug::Filter* gVectorAnimationLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_VECTOR_ANIMATION" );
 #endif
 
+inline void ResetToStart( bool& updated, uint32_t& value, uint32_t startValue, ConditionalWait& conditionalWait )
+{
+  ConditionalWait::ScopedLock lock( conditionalWait );
+  if( !updated )
+  {
+    value = startValue;
+  }
+}
+
 } // unnamed namespace
 
 VectorRasterizeThread::VectorRasterizeThread( const std::string& url )
 : mUrl( url ),
   mVectorRenderer(),
   mConditionalWait(),
-  mMutex(),
   mResourceReadyTrigger(),
   mAnimationFinishedTrigger(),
   mPlayRange( 0.0f, 1.0f ),
   mPlayState( DevelImageVisual::PlayState::STOPPED ),
+  mFrameDurationNanoSeconds( 0 ),
   mProgress( 0.0f ),
+  mFrameRate( 60.0f ),
   mCurrentFrame( 0 ),
   mTotalFrame( 0 ),
   mStartFrame( 0 ),
@@ -66,6 +77,7 @@ VectorRasterizeThread::VectorRasterizeThread( const std::string& url )
   mNeedRender( false ),
   mDestroyThread( false ),
   mResourceReady( false ),
+  mCurrentFrameUpdated( false ),
   mLogFactory( Dali::Adaptor::Get().GetLogFactory() )
 {
   mVectorRenderer = VectorAnimationRenderer::New( mUrl );
@@ -96,7 +108,7 @@ void VectorRasterizeThread::Run()
   //TODO: check the return value
   StartRender();
 
-  while( IsThreadReady() )
+  while( !mDestroyThread )
   {
     Rasterize();
   }
@@ -146,10 +158,6 @@ void VectorRasterizeThread::StopAnimation()
   {
     mPlayState = DevelImageVisual::PlayState::STOPPED;
 
-    // Reset the current frame and the current loop
-    mCurrentFrame = mStartFrame;
-    mCurrentLoop = 0;
-
     DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorRasterizeThread::StopAnimation: Stop\n" );
   }
 }
@@ -197,9 +205,6 @@ void VectorRasterizeThread::SetLoopCount( int32_t count )
     ConditionalWait::ScopedLock lock( mConditionalWait );
 
     mLoopCount = count;
-
-    // Reset progress
-    mCurrentLoop = 0;
   }
 }
 
@@ -236,12 +241,14 @@ void VectorRasterizeThread::SetPlayRange( Vector2 range )
         {
           mCurrentFrame = mStartFrame;
 
+          mCurrentFrameUpdated = true;
           mResourceReady = false;
         }
         else if( mEndFrame < mCurrentFrame )
         {
           mCurrentFrame = mEndFrame;
 
+          mCurrentFrameUpdated = true;
           mResourceReady = false;
         }
       }
@@ -265,6 +272,7 @@ void VectorRasterizeThread::SetCurrentProgress( float progress )
     if( mTotalFrame != 0 )
     {
       mCurrentFrame = static_cast< uint32_t >( mTotalFrame * progress + 0.5f );
+      mCurrentFrameUpdated = true;
     }
 
     mResourceReady = false;
@@ -288,21 +296,6 @@ bool VectorRasterizeThread::IsResourceReady() const
   return mResourceReady;
 }
 
-bool VectorRasterizeThread::IsThreadReady()
-{
-  ConditionalWait::ScopedLock lock( mConditionalWait );
-
-  if( mPlayState != DevelImageVisual::PlayState::PLAYING && !mNeedRender && !mDestroyThread )
-  {
-    DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorRasterizeThread::IsThreadReady: Wait\n" );
-
-    mConditionalWait.Wait( lock );
-  }
-
-  // Keep the thread alive if this thread is NOT to be destroyed
-  return !mDestroyThread;
-}
-
 bool VectorRasterizeThread::StartRender()
 {
   //TODO: check the return value
@@ -315,71 +308,99 @@ bool VectorRasterizeThread::StartRender()
 
   mCurrentFrame = std::max( static_cast< uint32_t >( mTotalFrame * mProgress + 0.5f ), mStartFrame );
 
-  DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorRasterizeThread::StartRender: Renderer is started [%d (%d, %d)]\n", mTotalFrame, mStartFrame, mEndFrame );
+  mFrameRate = mVectorRenderer.GetFrameRate();
+  mFrameDurationNanoSeconds = NANOSECONDS_PER_SECOND / mFrameRate;
+
+  DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorRasterizeThread::StartRender: Renderer is started [%d, %f fps]\n", mTotalFrame, mFrameRate );
 
   return true;
 }
 
 void VectorRasterizeThread::Rasterize()
 {
-  DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorRasterizeThread::Rasterize: [%d]\n", mCurrentFrame );
-
-  bool needRender, resourceReady;
+  bool resourceReady;
+  uint32_t currentFrame, startFrame, endFrame;
+  int32_t loopCount;
+  DevelImageVisual::PlayState playState;
 
   {
     ConditionalWait::ScopedLock lock( mConditionalWait );
-    needRender = mNeedRender;
+
+    if( mPlayState != DevelImageVisual::PlayState::PLAYING && !mNeedRender && !mDestroyThread )
+    {
+      DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorRasterizeThread::Rasterize: Wait\n" );
+
+      if( mPlayState == DevelImageVisual::PlayState::STOPPED )
+      {
+        // Reset the current frame and the current loop
+        mCurrentFrame = mStartFrame;
+        mCurrentLoop = 0;
+      }
+      mConditionalWait.Wait( lock );
+    }
+
     resourceReady = mResourceReady;
+    currentFrame = mCurrentFrame++;
+    startFrame = mStartFrame;
+    endFrame = mEndFrame;
+    loopCount = mLoopCount;
+    playState = mPlayState;
+
+    mNeedRender = false;
+    mResourceReady = true;
+    mCurrentFrameUpdated = false;
   }
 
+  auto currentFrameStartTime = std::chrono::system_clock::now();
+
   // Rasterize
-  mVectorRenderer.Render( mCurrentFrame );
+  mVectorRenderer.Render( currentFrame );
 
-  if( mPlayState == DevelImageVisual::PlayState::PLAYING )
+  if( playState == DevelImageVisual::PlayState::PLAYING )
   {
-    if( ++mCurrentFrame >= mEndFrame )
+    if( currentFrame >= endFrame )
     {
-      if( mLoopCount < 0 )
+      if( loopCount < 0 )
       {
         // repeat forever
-        mCurrentFrame = mStartFrame;
+        ResetToStart( mCurrentFrameUpdated, mCurrentFrame, startFrame, mConditionalWait );  // If the current frame is changed in the event thread, don't overwrite it.
       }
       else
       {
         mCurrentLoop++;
-        if( mCurrentLoop >= mLoopCount )
+        if( mCurrentLoop >= loopCount )
         {
-          // Animation is finished
           mPlayState = DevelImageVisual::PlayState::STOPPED;
 
-          // Reset the current frame and the current loop
-          mCurrentFrame = mStartFrame;
-          mCurrentLoop = 0;
-
+          // Animation is finished
           mAnimationFinishedTrigger->Trigger();
 
           DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorRasterizeThread::Rasterize: Animation is finished\n" );
         }
         else
         {
-          mCurrentFrame = mStartFrame;
+          ResetToStart( mCurrentFrameUpdated, mCurrentFrame, startFrame, mConditionalWait );
         }
       }
     }
   }
 
-  if( needRender )
-  {
-    mNeedRender = false;
-  }
-
   if( !resourceReady )
   {
     DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorRasterizeThread::Rasterize: Resource ready trigger\n" );
 
     mResourceReadyTrigger->Trigger();
-    mResourceReady = true;
   }
+
+  auto timeToSleepUntil = currentFrameStartTime + std::chrono::nanoseconds( mFrameDurationNanoSeconds );
+
+#if defined(DEBUG_ENABLED)
+  auto sleepDuration = std::chrono::duration_cast< std::chrono::milliseconds >( timeToSleepUntil - std::chrono::system_clock::now() );
+
+  DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "VectorRasterizeThread::Rasterize: [current = %d, sleep duration = %lld]\n", mCurrentFrame, sleepDuration.count() );
+#endif
+
+  std::this_thread::sleep_until( timeToSleepUntil );
 }
 
 } // namespace Internal