dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.cpp

   1 /*
   2  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/stage.h>
  23 #include <dali/devel-api/rendering/renderer-devel.h>
  24 #include <dali/integration-api/debug.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
  28 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  29 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
  30 #include <dali-toolkit/devel-api/visuals/animated-vector-image-visual-signals-devel.h>
  31 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
  32 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  33 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  34 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  35
  36 namespace Dali
  37 {
  38
  39 namespace Toolkit
  40 {
  41
  42 namespace Internal
  43 {
  44
  45 namespace
  46 {
  47
  48 constexpr auto LOOP_FOREVER = -1;
  49
  50 const Dali::Vector4 FULL_TEXTURE_RECT( 0.f, 0.f, 1.f, 1.f );
  51
  52 // Flags for re-sending data to the rasterize thread
  53 enum Flags
  54 {
  55   RESEND_PLAY_RANGE    = 1 << 0,
  56   RESEND_LOOP_COUNT    = 1 << 1,
  57   RESEND_STOP_BEHAVIOR = 1 << 2,
  58   RESEND_LOOPING_MODE  = 1 << 3
  59 };
  60
  61 // stop behavior
  62 DALI_ENUM_TO_STRING_TABLE_BEGIN( STOP_BEHAVIOR )
  63 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, CURRENT_FRAME )
  64 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, FIRST_FRAME )
  65 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::StopBehavior, LAST_FRAME )
  66 DALI_ENUM_TO_STRING_TABLE_END( STOP_BEHAVIOR )
  67
  68 // looping mode
  69 DALI_ENUM_TO_STRING_TABLE_BEGIN( LOOPING_MODE )
  70 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::LoopingMode, RESTART )
  71 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::DevelImageVisual::LoopingMode, AUTO_REVERSE )
  72 DALI_ENUM_TO_STRING_TABLE_END( LOOPING_MODE )
  73
  74 #if defined(DEBUG_ENABLED)
  75 Debug::Filter* gVectorAnimationLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_VECTOR_ANIMATION" );
  76 #endif
  77
  78 } // unnamed namespace
  79
  80 AnimatedVectorImageVisualPtr AnimatedVectorImageVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties )
  81 {
  82   AnimatedVectorImageVisualPtr visual( new AnimatedVectorImageVisual( factoryCache, shaderFactory, imageUrl ) );
  83   visual->SetProperties( properties );
  84
  85   return visual;
  86 }
  87
  88 AnimatedVectorImageVisualPtr AnimatedVectorImageVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl )
  89 {
  90   AnimatedVectorImageVisualPtr visual( new AnimatedVectorImageVisual( factoryCache, shaderFactory, imageUrl ) );
  91
  92   return visual;
  93 }
  94
  95 AnimatedVectorImageVisual::AnimatedVectorImageVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl )
  96 : Visual::Base( factoryCache, Visual::FittingMode::FILL ),
  97   mImageVisualShaderFactory( shaderFactory ),
  98   mUrl( imageUrl ),
  99   mVectorRasterizeThread( imageUrl.GetUrl() ),
 100   mVisualSize(),
 101   mPlacementActor(),
 102   mLoopCount( LOOP_FOREVER ),
 103   mStartFrame( 0 ),
 104   mEndFrame( 0 ),
 105   mResendFlag( 0 ),
 106   mActionStatus( DevelAnimatedVectorImageVisual::Action::STOP ),
 107   mStopBehavior( DevelImageVisual::StopBehavior::CURRENT_FRAME ),
 108   mLoopingMode( DevelImageVisual::LoopingMode::RESTART )
 109 {
 110   // the rasterized image is with pre-multiplied alpha format
 111   mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
 112
 113   mVectorRasterizeThread.SetResourceReadyCallback( new EventThreadCallback( MakeCallback( this, &AnimatedVectorImageVisual::OnResourceReady ) ) );
 114   mVectorRasterizeThread.SetAnimationFinishedCallback( new EventThreadCallback( MakeCallback( this, &AnimatedVectorImageVisual::OnAnimationFinished ) ) );
 115
 116   mVectorRasterizeThread.Start();
 117 }
 118
 119 AnimatedVectorImageVisual::~AnimatedVectorImageVisual()
 120 {
 121 }
 122
 123 void AnimatedVectorImageVisual::GetNaturalSize( Vector2& naturalSize )
 124 {
 125   if( mImpl->mRenderer ) // Check if we have a rendered image
 126   {
 127     auto textureSet = mImpl->mRenderer.GetTextures();
 128     if( textureSet )
 129     {
 130       if( textureSet.GetTextureCount() > 0 )
 131       {
 132         auto texture = textureSet.GetTexture( 0 );
 133         naturalSize.x = texture.GetWidth();
 134         naturalSize.y = texture.GetHeight();
 135         return;
 136       }
 137     }
 138   }
 139
 140   uint32_t width, height;
 141   mVectorRasterizeThread.GetDefaultSize( width, height );
 142   naturalSize.x = width;
 143   naturalSize.y = height;
 144 }
 145
 146 void AnimatedVectorImageVisual::DoCreatePropertyMap( Property::Map& map ) const
 147 {
 148   map.Clear();
 149   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE );
 150   if( mUrl.IsValid() )
 151   {
 152     map.Insert( Toolkit::ImageVisual::Property::URL, mUrl.GetUrl() );
 153   }
 154   map.Insert( Toolkit::DevelImageVisual::Property::LOOP_COUNT, mLoopCount );
 155
 156   Property::Array playRange;
 157   playRange.PushBack( mStartFrame );
 158   playRange.PushBack( mEndFrame );
 159   map.Insert( Toolkit::DevelImageVisual::Property::PLAY_RANGE, playRange );
 160
 161   map.Insert( Toolkit::DevelImageVisual::Property::PLAY_STATE, static_cast< int >( mVectorRasterizeThread.GetPlayState() ) );
 162   map.Insert( Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, static_cast< int32_t >( mVectorRasterizeThread.GetCurrentFrameNumber() ) );
 163   map.Insert( Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, static_cast< int32_t >( mVectorRasterizeThread.GetTotalFrameNumber() ) );
 164
 165   map.Insert( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior );
 166   map.Insert( Toolkit::DevelImageVisual::Property::LOOPING_MODE, mLoopingMode );
 167 }
 168
 169 void AnimatedVectorImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
 170 {
 171   // Do nothing
 172 }
 173
 174 void AnimatedVectorImageVisual::DoSetProperties( const Property::Map& propertyMap )
 175 {
 176   // url already passed in from constructor
 177   for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
 178   {
 179     KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
 180     if( keyValue.first.type == Property::Key::INDEX )
 181     {
 182       DoSetProperty( keyValue.first.indexKey, keyValue.second );
 183     }
 184     else
 185     {
 186        if( keyValue.first == LOOP_COUNT_NAME )
 187        {
 188           DoSetProperty( Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second );
 189        }
 190        else if( keyValue.first == PLAY_RANGE_NAME )
 191        {
 192           DoSetProperty( Toolkit::DevelImageVisual::Property::PLAY_RANGE, keyValue.second );
 193        }
 194        else if( keyValue.first == STOP_BEHAVIOR_NAME )
 195        {
 196           DoSetProperty( Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second );
 197        }
 198        else if( keyValue.first == LOOPING_MODE_NAME )
 199        {
 200           DoSetProperty( Toolkit::DevelImageVisual::Property::LOOPING_MODE, keyValue.second );
 201        }
 202     }
 203   }
 204 }
 205
 206 void AnimatedVectorImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
 207 {
 208   switch(index)
 209   {
 210     case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
 211     {
 212       int32_t loopCount;
 213       if( value.Get( loopCount ) )
 214       {
 215         mLoopCount = loopCount;
 216         mResendFlag |= RESEND_LOOP_COUNT;
 217       }
 218       break;
 219     }
 220     case Toolkit::DevelImageVisual::Property::PLAY_RANGE:
 221     {
 222       Property::Array* array = value.GetArray();
 223       if( array )
 224       {
 225         size_t count = array->Count();
 226         if( count >= 2 )
 227         {
 228           int startFrame, endFrame;
 229           int totalFrame = mVectorRasterizeThread.GetTotalFrameNumber();
 230           array->GetElementAt( 0 ).Get( startFrame );
 231           array->GetElementAt( 1 ).Get( endFrame );
 232
 233           if( startFrame >= 0 && startFrame < totalFrame && endFrame >= 0 && endFrame < totalFrame )
 234           {
 235             mStartFrame = startFrame;
 236             mEndFrame = endFrame;
 237             mResendFlag |= RESEND_PLAY_RANGE;
 238           }
 239           else
 240           {
 241             DALI_LOG_ERROR( "Invalid play range [%d, %d / %d]\n", startFrame, endFrame, totalFrame );
 242           }
 243         }
 244       }
 245       break;
 246     }
 247     case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
 248     {
 249       int32_t stopBehavior;
 250       Scripting::GetEnumerationProperty( value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior );
 251       mStopBehavior = DevelImageVisual::StopBehavior::Type( stopBehavior );
 252       mResendFlag |= RESEND_STOP_BEHAVIOR;
 253       break;
 254     }
 255     case Toolkit::DevelImageVisual::Property::LOOPING_MODE:
 256     {
 257       int32_t loopingMode;
 258       Scripting::GetEnumerationProperty( value, LOOPING_MODE_TABLE, LOOPING_MODE_TABLE_COUNT, loopingMode );
 259       mLoopingMode = DevelImageVisual::LoopingMode::Type( loopingMode );
 260       mResendFlag |= RESEND_LOOPING_MODE;
 261       break;
 262     }
 263   }
 264 }
 265
 266 void AnimatedVectorImageVisual::DoSetOnStage( Actor& actor )
 267 {
 268   Shader shader;
 269
 270   if( mImpl->mCustomShader )
 271   {
 272     shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource() : mImpl->mCustomShader->mVertexShader,
 273                           mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource() : mImpl->mCustomShader->mFragmentShader,
 274                           mImpl->mCustomShader->mHints );
 275
 276     shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 277   }
 278   else
 279   {
 280     shader = mImageVisualShaderFactory.GetShader( mFactoryCache, false, true );
 281   }
 282
 283   Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
 284
 285   mImpl->mRenderer = Renderer::New( geometry, shader );
 286
 287   TextureSet textureSet = TextureSet::New();
 288   mImpl->mRenderer.SetTextures( textureSet );
 289
 290   // Register transform properties
 291   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 292
 293   // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
 294
 295   // Hold the weak handle of the placement actor and delay the adding of renderer until the rasterization is finished.
 296   mPlacementActor = actor;
 297
 298   mVectorRasterizeThread.SetRenderer( mImpl->mRenderer );
 299 }
 300
 301 void AnimatedVectorImageVisual::DoSetOffStage( Actor& actor )
 302 {
 303   mVectorRasterizeThread.PauseAnimation();
 304
 305   mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
 306
 307   if( mImpl->mRenderer )
 308   {
 309     mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
 310
 311     actor.RemoveRenderer( mImpl->mRenderer );
 312     mImpl->mRenderer.Reset();
 313   }
 314
 315   mPlacementActor.Reset();
 316
 317   // Reset the visual size to zero so that when adding the actor back to stage the rasterization is forced
 318   mVisualSize = Vector2::ZERO;
 319 }
 320
 321 void AnimatedVectorImageVisual::OnSetTransform()
 322 {
 323   Vector2 visualSize = mImpl->mTransform.GetVisualSize( mImpl->mControlSize );
 324
 325   if( IsOnStage() )
 326   {
 327     DALI_LOG_INFO( gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSetTransform: width = %f, height = %f\n", visualSize.width, visualSize.height );
 328
 329     if( visualSize != mVisualSize )
 330     {
 331       mVisualSize = visualSize;
 332
 333       uint32_t width = static_cast< uint32_t >( visualSize.width );
 334       uint32_t height = static_cast< uint32_t >( visualSize.height );
 335
 336       mVectorRasterizeThread.SetSize( width, height );
 337     }
 338
 339     SendAnimationData();
 340
 341     if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
 342     {
 343       mVectorRasterizeThread.PlayAnimation();
 344
 345       mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
 346     }
 347     else
 348     {
 349       // Render one frame
 350       mVectorRasterizeThread.RenderFrame();
 351     }
 352
 353     if( mVectorRasterizeThread.IsResourceReady() )
 354     {
 355       Actor actor = mPlacementActor.GetHandle();
 356       if( actor )
 357       {
 358         actor.AddRenderer( mImpl->mRenderer );
 359         mPlacementActor.Reset();
 360       }
 361
 362       ResourceReady( Toolkit::Visual::ResourceStatus::READY );
 363     }
 364   }
 365 }
 366
 367 void AnimatedVectorImageVisual::OnDoAction( const Property::Index actionId, const Property::Value& attributes )
 368 {
 369   // Check if action is valid for this visual type and perform action if possible
 370   switch( actionId )
 371   {
 372     case DevelAnimatedVectorImageVisual::Action::PLAY:
 373     {
 374       if( IsOnStage() && mVisualSize != Vector2::ZERO )
 375       {
 376         mVectorRasterizeThread.PlayAnimation();
 377
 378         mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
 379       }
 380       mActionStatus = DevelAnimatedVectorImageVisual::Action::PLAY;
 381       break;
 382     }
 383     case DevelAnimatedVectorImageVisual::Action::PAUSE:
 384     {
 385       mVectorRasterizeThread.PauseAnimation();
 386
 387       if( mImpl->mRenderer )
 388       {
 389         mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
 390       }
 391
 392       mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
 393       break;
 394     }
 395     case DevelAnimatedVectorImageVisual::Action::STOP:
 396     {
 397       if( mVectorRasterizeThread.GetPlayState() != DevelImageVisual::PlayState::STOPPED )
 398       {
 399         mVectorRasterizeThread.StopAnimation();
 400
 401         OnAnimationFinished();
 402       }
 403       mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
 404       break;
 405     }
 406     case DevelAnimatedVectorImageVisual::Action::JUMP_TO:
 407     {
 408       int32_t frameNumber;
 409       if( attributes.Get( frameNumber ) )
 410       {
 411         mVectorRasterizeThread.SetCurrentFrameNumber( frameNumber );
 412
 413         if( IsOnStage() && mVectorRasterizeThread.GetPlayState() != DevelImageVisual::PlayState::PLAYING )
 414         {
 415           mVectorRasterizeThread.RenderFrame();
 416           Stage::GetCurrent().KeepRendering( 0.0f );    // Trigger rendering
 417         }
 418       }
 419       break;
 420     }
 421     case DevelAnimatedVectorImageVisual::Action::UPDATE_PROPERTY:
 422     {
 423       Property::Map* map = attributes.GetMap();
 424       if( map )
 425       {
 426         DoSetProperties( *map );
 427
 428         SendAnimationData();
 429       }
 430       break;
 431     }
 432   }
 433 }
 434
 435 void AnimatedVectorImageVisual::OnResourceReady()
 436 {
 437   // If weak handle is holding a placement actor, it is the time to add the renderer to actor.
 438   Actor actor = mPlacementActor.GetHandle();
 439   if( actor )
 440   {
 441     actor.AddRenderer( mImpl->mRenderer );
 442     // reset the weak handle so that the renderer only get added to actor once
 443     mPlacementActor.Reset();
 444
 445     ResourceReady( Toolkit::Visual::ResourceStatus::READY );
 446   }
 447 }
 448
 449 void AnimatedVectorImageVisual::OnAnimationFinished()
 450 {
 451   if( mImpl->mEventObserver )
 452   {
 453     mImpl->mEventObserver->NotifyVisualEvent( *this, DevelAnimatedVectorImageVisual::Signal::ANIMATION_FINISHED );
 454   }
 455
 456   mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
 457
 458   if( mImpl->mRenderer )
 459   {
 460     mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
 461   }
 462 }
 463
 464 void AnimatedVectorImageVisual::SendAnimationData()
 465 {
 466   if( mResendFlag )
 467   {
 468     bool isPlaying = false;
 469     if( mVectorRasterizeThread.GetPlayState() == DevelImageVisual::PlayState::PLAYING )
 470     {
 471       mVectorRasterizeThread.PauseAnimation();
 472       isPlaying = true;
 473     }
 474
 475     if( mResendFlag & RESEND_LOOP_COUNT )
 476     {
 477       mVectorRasterizeThread.SetLoopCount( mLoopCount );
 478     }
 479
 480     if( mResendFlag & RESEND_PLAY_RANGE )
 481     {
 482       mVectorRasterizeThread.SetPlayRange( mStartFrame, mEndFrame );
 483     }
 484
 485     if( mResendFlag & RESEND_STOP_BEHAVIOR )
 486     {
 487       mVectorRasterizeThread.SetStopBehavior( mStopBehavior );
 488     }
 489
 490     if( mResendFlag & RESEND_LOOPING_MODE )
 491     {
 492       mVectorRasterizeThread.SetLoopingMode( mLoopingMode );
 493     }
 494
 495     if( IsOnStage() )
 496     {
 497       if( isPlaying )
 498       {
 499         mVectorRasterizeThread.PlayAnimation();
 500       }
 501       else
 502       {
 503         mVectorRasterizeThread.RenderFrame();
 504         Stage::GetCurrent().KeepRendering( 0.0f );
 505       }
 506     }
 507
 508     mResendFlag = 0;
 509   }
 510 }
 511
 512 } // namespace Internal
 513
 514 } // namespace Toolkit
 515
 516 } // namespace Dali