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/visual-properties-devel.h>
  30 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
  31 #include <dali-toolkit/devel-api/visuals/animated-vector-image-visual-signals-devel.h>
  32 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
  33 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  34 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  35 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  36
  37 namespace Dali
  38 {
  39
  40 namespace Toolkit
  41 {
  42
  43 namespace Internal
  44 {
  45
  46 namespace
  47 {
  48
  49 const Dali::Vector4 FULL_TEXTURE_RECT( 0.f, 0.f, 1.f, 1.f );
  50
  51 } // unnamed namespace
  52
  53 AnimatedVectorImageVisualPtr AnimatedVectorImageVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties )
  54 {
  55   AnimatedVectorImageVisualPtr visual( new AnimatedVectorImageVisual( factoryCache, shaderFactory, imageUrl ) );
  56   visual->SetProperties( properties );
  57
  58   return visual;
  59 }
  60
  61 AnimatedVectorImageVisualPtr AnimatedVectorImageVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl )
  62 {
  63   AnimatedVectorImageVisualPtr visual( new AnimatedVectorImageVisual( factoryCache, shaderFactory, imageUrl ) );
  64
  65   return visual;
  66 }
  67
  68 AnimatedVectorImageVisual::AnimatedVectorImageVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl )
  69 : Visual::Base( factoryCache ),
  70   mImageVisualShaderFactory( shaderFactory ),
  71   mUrl( imageUrl ),
  72   mVectorRasterizeThread( imageUrl.GetUrl() ),
  73   mVisualSize(),
  74   mPlacementActor(),
  75   mActionStatus( DevelAnimatedVectorImageVisual::Action::STOP )
  76 {
  77   // the rasterized image is with pre-multiplied alpha format
  78   mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
  79
  80   mVectorRasterizeThread.SetResourceReadyCallback( new EventThreadCallback( MakeCallback( this, &AnimatedVectorImageVisual::OnResourceReady ) ) );
  81   mVectorRasterizeThread.SetAnimationFinishedCallback( new EventThreadCallback( MakeCallback( this, &AnimatedVectorImageVisual::OnAnimationFinished ) ) );
  82
  83   mVectorRasterizeThread.Start();
  84 }
  85
  86 AnimatedVectorImageVisual::~AnimatedVectorImageVisual()
  87 {
  88 }
  89
  90 void AnimatedVectorImageVisual::GetNaturalSize( Vector2& naturalSize )
  91 {
  92   naturalSize = mVisualSize;
  93 }
  94
  95 void AnimatedVectorImageVisual::DoCreatePropertyMap( Property::Map& map ) const
  96 {
  97   map.Clear();
  98   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE );
  99   if( mUrl.IsValid() )
 100   {
 101     map.Insert( Toolkit::ImageVisual::Property::URL, mUrl.GetUrl() );
 102   }
 103   map.Insert( Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast< int >( mVectorRasterizeThread.GetLoopCount() ) );
 104   map.Insert( Toolkit::DevelImageVisual::Property::PLAY_RANGE, static_cast< Vector2 >( mVectorRasterizeThread.GetPlayRange() ) );
 105   map.Insert( Toolkit::DevelImageVisual::Property::PLAY_STATE, static_cast< int >( mVectorRasterizeThread.GetPlayState() ) );
 106 }
 107
 108 void AnimatedVectorImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
 109 {
 110   // Do nothing
 111 }
 112
 113 void AnimatedVectorImageVisual::DoSetProperties( const Property::Map& propertyMap )
 114 {
 115   // url already passed in from constructor
 116   for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
 117   {
 118     KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
 119     if( keyValue.first.type == Property::Key::INDEX )
 120     {
 121       DoSetProperty( keyValue.first.indexKey, keyValue.second );
 122     }
 123     else
 124     {
 125        if( keyValue.first == LOOP_COUNT_NAME )
 126        {
 127           DoSetProperty( Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second );
 128        }
 129        else if( keyValue.first == PLAY_RANGE_NAME )
 130        {
 131           DoSetProperty( Toolkit::DevelImageVisual::Property::PLAY_RANGE, keyValue.second );
 132        }
 133     }
 134   }
 135 }
 136
 137 void AnimatedVectorImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
 138 {
 139   switch(index)
 140   {
 141     case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
 142     {
 143       int32_t loopCount;
 144       if( value.Get( loopCount ) )
 145       {
 146         mVectorRasterizeThread.SetLoopCount( loopCount );
 147       }
 148       break;
 149     }
 150     case Toolkit::DevelImageVisual::Property::PLAY_RANGE:
 151     {
 152       Vector2 range;
 153       if( value.Get( range ) )
 154       {
 155         mVectorRasterizeThread.SetPlayRange( range );
 156       }
 157       break;
 158     }
 159   }
 160 }
 161
 162 void AnimatedVectorImageVisual::DoSetOnStage( Actor& actor )
 163 {
 164   Shader shader;
 165
 166   if( mImpl->mCustomShader )
 167   {
 168     shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource() : mImpl->mCustomShader->mVertexShader,
 169                           mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource() : mImpl->mCustomShader->mFragmentShader,
 170                           mImpl->mCustomShader->mHints );
 171
 172     shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 173   }
 174   else
 175   {
 176     shader = mImageVisualShaderFactory.GetShader( mFactoryCache, false, true );
 177   }
 178
 179   Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
 180
 181   mImpl->mRenderer = Renderer::New( geometry, shader );
 182
 183   TextureSet textureSet = TextureSet::New();
 184   mImpl->mRenderer.SetTextures( textureSet );
 185
 186   // Register transform properties
 187   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 188
 189   // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
 190
 191   // Hold the weak handle of the placement actor and delay the adding of renderer until the rasterization is finished.
 192   mPlacementActor = actor;
 193
 194   mVectorRasterizeThread.SetRenderer( mImpl->mRenderer );
 195 }
 196
 197 void AnimatedVectorImageVisual::DoSetOffStage( Actor& actor )
 198 {
 199   mVectorRasterizeThread.PauseAnimation();
 200
 201   mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
 202
 203   if( mImpl->mRenderer )
 204   {
 205     mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
 206
 207     actor.RemoveRenderer( mImpl->mRenderer );
 208     mImpl->mRenderer.Reset();
 209   }
 210
 211   mPlacementActor.Reset();
 212
 213   // Reset the visual size to zero so that when adding the actor back to stage the rasterization is forced
 214   mVisualSize = Vector2::ZERO;
 215 }
 216
 217 void AnimatedVectorImageVisual::OnSetTransform()
 218 {
 219   Vector2 visualSize = mImpl->mTransform.GetVisualSize( mImpl->mControlSize );
 220
 221   if( IsOnStage() )
 222   {
 223     if( visualSize != mVisualSize )
 224     {
 225       mVisualSize = visualSize;
 226
 227       uint32_t width = static_cast< uint32_t >( visualSize.width );
 228       uint32_t height = static_cast< uint32_t >( visualSize.height );
 229
 230       mVectorRasterizeThread.SetSize( width, height );
 231     }
 232
 233     if( mActionStatus == DevelAnimatedVectorImageVisual::Action::PLAY )
 234     {
 235       mVectorRasterizeThread.PlayAnimation();
 236
 237       mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
 238     }
 239     else
 240     {
 241       // Render one frame
 242       mVectorRasterizeThread.RenderFrame();
 243     }
 244
 245     if( mVectorRasterizeThread.IsResourceReady() )
 246     {
 247       Actor actor = mPlacementActor.GetHandle();
 248       if( actor )
 249       {
 250         actor.AddRenderer( mImpl->mRenderer );
 251         mPlacementActor.Reset();
 252       }
 253
 254       ResourceReady( Toolkit::Visual::ResourceStatus::READY );
 255     }
 256   }
 257 }
 258
 259 void AnimatedVectorImageVisual::OnDoAction( const Property::Index actionId, const Property::Value& attributes )
 260 {
 261   // Check if action is valid for this visual type and perform action if possible
 262   switch( actionId )
 263   {
 264     case DevelAnimatedVectorImageVisual::Action::PLAY:
 265     {
 266       if( IsOnStage() )
 267       {
 268         mVectorRasterizeThread.PlayAnimation();
 269
 270         mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY );
 271       }
 272       mActionStatus = DevelAnimatedVectorImageVisual::Action::PLAY;
 273       break;
 274     }
 275     case DevelAnimatedVectorImageVisual::Action::PAUSE:
 276     {
 277       mVectorRasterizeThread.PauseAnimation();
 278
 279       if( mImpl->mRenderer )
 280       {
 281         mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
 282       }
 283
 284       mActionStatus = DevelAnimatedVectorImageVisual::Action::PAUSE;
 285       break;
 286     }
 287     case DevelAnimatedVectorImageVisual::Action::STOP:
 288     {
 289       if( mVectorRasterizeThread.GetPlayState() != DevelImageVisual::PlayState::STOPPED )
 290       {
 291         mVectorRasterizeThread.StopAnimation();
 292
 293         OnAnimationFinished();
 294       }
 295       mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
 296       break;
 297     }
 298   }
 299 }
 300
 301 void AnimatedVectorImageVisual::OnResourceReady()
 302 {
 303   // If weak handle is holding a placement actor, it is the time to add the renderer to actor.
 304   Actor actor = mPlacementActor.GetHandle();
 305   if( actor )
 306   {
 307     actor.AddRenderer( mImpl->mRenderer );
 308     // reset the weak handle so that the renderer only get added to actor once
 309     mPlacementActor.Reset();
 310   }
 311
 312   ResourceReady( Toolkit::Visual::ResourceStatus::READY );
 313 }
 314
 315 void AnimatedVectorImageVisual::OnAnimationFinished()
 316 {
 317   if( mImpl->mEventObserver )
 318   {
 319     mImpl->mEventObserver->NotifyVisualEvent( *this, DevelAnimatedVectorImageVisual::Signal::ANIMATION_FINISHED );
 320   }
 321
 322   mActionStatus = DevelAnimatedVectorImageVisual::Action::STOP;
 323
 324   if( mImpl->mRenderer )
 325   {
 326     mImpl->mRenderer.SetProperty( DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED );
 327   }
 328 }
 329
 330 } // namespace Internal
 331
 332 } // namespace Toolkit
 333
 334 } // namespace Dali