2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
22 #include <dali/devel-api/adaptor-framework/window-devel.h>
23 #include <dali/devel-api/common/stage.h>
24 #include <dali/devel-api/rendering/renderer-devel.h>
25 #include <dali/integration-api/debug.h>
28 #include <dali-toolkit/devel-api/visuals/animated-vector-image-visual-signals-devel.h>
29 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
30 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-manager.h>
31 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
32 #include <dali-toolkit/internal/visuals/visual-base-data-impl.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/public-api/visuals/image-visual-properties.h>
36 #include <dali-toolkit/public-api/visuals/visual-properties.h>
46 const Dali::Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
49 DALI_ENUM_TO_STRING_TABLE_BEGIN(STOP_BEHAVIOR)
50 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, CURRENT_FRAME)
51 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, FIRST_FRAME)
52 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, LAST_FRAME)
53 DALI_ENUM_TO_STRING_TABLE_END(STOP_BEHAVIOR)
56 DALI_ENUM_TO_STRING_TABLE_BEGIN(LOOPING_MODE)
57 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::LoopingMode, RESTART)
58 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::LoopingMode, AUTO_REVERSE)
59 DALI_ENUM_TO_STRING_TABLE_END(LOOPING_MODE)
61 #if defined(DEBUG_ENABLED)
62 Debug::Filter* gVectorAnimationLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_VECTOR_ANIMATION");
65 } // unnamed namespace
67 AnimatedVectorImageVisualPtr AnimatedVectorImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties)
69 AnimatedVectorImageVisualPtr visual(new AnimatedVectorImageVisual(factoryCache, shaderFactory, imageUrl));
70 visual->SetProperties(properties);
75 AnimatedVectorImageVisualPtr AnimatedVectorImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl)
77 AnimatedVectorImageVisualPtr visual(new AnimatedVectorImageVisual(factoryCache, shaderFactory, imageUrl));
82 AnimatedVectorImageVisual::AnimatedVectorImageVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl)
83 : Visual::Base(factoryCache, Visual::FittingMode::FILL, static_cast<Toolkit::Visual::Type>(Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE)),
86 mVectorAnimationTask(new VectorAnimationTask(factoryCache, imageUrl.GetUrl())),
87 mImageVisualShaderFactory(shaderFactory),
89 mVisualScale(Vector2::ONE),
91 mPlayState(DevelImageVisual::PlayState::STOPPED),
92 mEventCallback(nullptr),
93 mRendererAdded(false),
95 mRedrawInScalingDown(true)
97 // the rasterized image is with pre-multiplied alpha format
98 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
100 mVectorAnimationTask->UploadCompletedSignal().Connect(this, &AnimatedVectorImageVisual::OnUploadCompleted);
101 mVectorAnimationTask->SetAnimationFinishedCallback(new EventThreadCallback(MakeCallback(this, &AnimatedVectorImageVisual::OnAnimationFinished)));
103 auto& vectorAnimationManager = mFactoryCache.GetVectorAnimationManager();
104 vectorAnimationManager.AddObserver(*this);
107 AnimatedVectorImageVisual::~AnimatedVectorImageVisual()
111 auto& vectorAnimationManager = mFactoryCache.GetVectorAnimationManager();
112 vectorAnimationManager.RemoveObserver(*this);
116 mFactoryCache.GetVectorAnimationManager().UnregisterEventCallback(mEventCallback);
119 // Finalize animation task and disconnect the signal in the main thread
120 mVectorAnimationTask->UploadCompletedSignal().Disconnect(this, &AnimatedVectorImageVisual::OnUploadCompleted);
121 mVectorAnimationTask->Finalize();
125 void AnimatedVectorImageVisual::VectorAnimationManagerDestroyed()
127 // Core is shutting down. Don't talk to the plugin any more.
128 mCoreShutdown = true;
131 void AnimatedVectorImageVisual::GetNaturalSize(Vector2& naturalSize)
133 if(mVisualSize != Vector2::ZERO)
135 naturalSize = mVisualSize;
139 uint32_t width, height;
140 mVectorAnimationTask->GetDefaultSize(width, height);
141 naturalSize.x = width;
142 naturalSize.y = height;
145 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::GetNaturalSize: w = %f, h = %f [%p]\n", naturalSize.width, naturalSize.height, this);
148 void AnimatedVectorImageVisual::DoCreatePropertyMap(Property::Map& map) const
151 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE);
154 map.Insert(Toolkit::ImageVisual::Property::URL, mUrl.GetUrl());
156 map.Insert(Toolkit::DevelImageVisual::Property::LOOP_COUNT, mAnimationData.loopCount);
158 uint32_t startFrame, endFrame;
159 mVectorAnimationTask->GetPlayRange(startFrame, endFrame);
161 Property::Array playRange;
162 playRange.PushBack(static_cast<int32_t>(startFrame));
163 playRange.PushBack(static_cast<int32_t>(endFrame));
164 map.Insert(Toolkit::DevelImageVisual::Property::PLAY_RANGE, playRange);
166 map.Insert(Toolkit::DevelImageVisual::Property::PLAY_STATE, static_cast<int32_t>(mPlayState));
167 map.Insert(Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, static_cast<int32_t>(mVectorAnimationTask->GetCurrentFrameNumber()));
168 map.Insert(Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, static_cast<int32_t>(mVectorAnimationTask->GetTotalFrameNumber()));
170 map.Insert(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mAnimationData.stopBehavior);
171 map.Insert(Toolkit::DevelImageVisual::Property::LOOPING_MODE, mAnimationData.loopingMode);
172 map.Insert(Toolkit::DevelImageVisual::Property::REDRAW_IN_SCALING_DOWN, mRedrawInScalingDown);
174 Property::Map layerInfo;
175 mVectorAnimationTask->GetLayerInfo(layerInfo);
176 map.Insert(Toolkit::DevelImageVisual::Property::CONTENT_INFO, layerInfo);
179 void AnimatedVectorImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
184 void AnimatedVectorImageVisual::DoSetProperties(const Property::Map& propertyMap)
186 // url already passed in from constructor
187 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
189 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
190 if(keyValue.first.type == Property::Key::INDEX)
192 DoSetProperty(keyValue.first.indexKey, keyValue.second);
196 if(keyValue.first == LOOP_COUNT_NAME)
198 DoSetProperty(Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second);
200 else if(keyValue.first == PLAY_RANGE_NAME)
202 DoSetProperty(Toolkit::DevelImageVisual::Property::PLAY_RANGE, keyValue.second);
204 else if(keyValue.first == STOP_BEHAVIOR_NAME)
206 DoSetProperty(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second);
208 else if(keyValue.first == LOOPING_MODE_NAME)
210 DoSetProperty(Toolkit::DevelImageVisual::Property::LOOPING_MODE, keyValue.second);
212 else if(keyValue.first == REDRAW_IN_SCALING_DOWN_NAME)
214 DoSetProperty(Toolkit::DevelImageVisual::Property::REDRAW_IN_SCALING_DOWN, keyValue.second);
219 TriggerVectorRasterization();
222 void AnimatedVectorImageVisual::DoSetProperty(Property::Index index, const Property::Value& value)
226 case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
229 if(value.Get(loopCount))
231 mAnimationData.loopCount = loopCount;
232 mAnimationData.resendFlag |= VectorAnimationTask::RESEND_LOOP_COUNT;
236 case Toolkit::DevelImageVisual::Property::PLAY_RANGE:
238 const Property::Array* array = value.GetArray();
241 mAnimationData.playRange = *array;
242 mAnimationData.resendFlag |= VectorAnimationTask::RESEND_PLAY_RANGE;
246 case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
248 int32_t stopBehavior = mAnimationData.stopBehavior;
249 if(Scripting::GetEnumerationProperty(value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior))
251 mAnimationData.stopBehavior = DevelImageVisual::StopBehavior::Type(stopBehavior);
252 mAnimationData.resendFlag |= VectorAnimationTask::RESEND_STOP_BEHAVIOR;
256 case Toolkit::DevelImageVisual::Property::LOOPING_MODE:
258 int32_t loopingMode = mAnimationData.loopingMode;
259 if(Scripting::GetEnumerationProperty(value, LOOPING_MODE_TABLE, LOOPING_MODE_TABLE_COUNT, loopingMode))
261 mAnimationData.loopingMode = DevelImageVisual::LoopingMode::Type(loopingMode);
262 mAnimationData.resendFlag |= VectorAnimationTask::RESEND_LOOPING_MODE;
266 case Toolkit::DevelImageVisual::Property::REDRAW_IN_SCALING_DOWN:
269 if(value.Get(redraw))
271 mRedrawInScalingDown = redraw;
278 void AnimatedVectorImageVisual::OnInitialize(void)
282 if(mImpl->mCustomShader)
284 shader = Shader::New(mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource().data() : mImpl->mCustomShader->mVertexShader,
285 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource().data() : mImpl->mCustomShader->mFragmentShader,
286 mImpl->mCustomShader->mHints);
288 shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
292 shader = mImageVisualShaderFactory.GetShader(mFactoryCache, false, true, IsRoundedCornerRequired());
295 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
297 mImpl->mRenderer = Renderer::New(geometry, shader);
299 TextureSet textureSet = TextureSet::New();
300 mImpl->mRenderer.SetTextures(textureSet);
302 // Register transform properties
303 mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
306 void AnimatedVectorImageVisual::DoSetOnScene(Actor& actor)
308 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
310 // Hold the weak handle of the placement actor and delay the adding of renderer until the rasterization is finished.
311 mPlacementActor = actor;
313 mVectorAnimationTask->SetRenderer(mImpl->mRenderer);
315 // Add property notification for scaling & size
316 mScaleNotification = actor.AddPropertyNotification(Actor::Property::WORLD_SCALE, StepCondition(0.1f, 1.0f));
317 mScaleNotification.NotifySignal().Connect(this, &AnimatedVectorImageVisual::OnScaleNotification);
319 mSizeNotification = actor.AddPropertyNotification(Actor::Property::SIZE, StepCondition(3.0f));
320 mSizeNotification.NotifySignal().Connect(this, &AnimatedVectorImageVisual::OnSizeNotification);
322 DevelActor::VisibilityChangedSignal(actor).Connect(this, &AnimatedVectorImageVisual::OnControlVisibilityChanged);
324 Window window = DevelWindow::Get(actor);
327 DevelWindow::VisibilityChangedSignal(window).Connect(this, &AnimatedVectorImageVisual::OnWindowVisibilityChanged);
330 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOnScene [%p]\n", this);
333 void AnimatedVectorImageVisual::DoSetOffScene(Actor& actor)
340 actor.RemoveRenderer(mImpl->mRenderer);
341 mRendererAdded = false;
344 // Remove property notification
345 actor.RemovePropertyNotification(mScaleNotification);
346 actor.RemovePropertyNotification(mSizeNotification);
348 DevelActor::VisibilityChangedSignal(actor).Disconnect(this, &AnimatedVectorImageVisual::OnControlVisibilityChanged);
350 Window window = DevelWindow::Get(actor);
353 DevelWindow::VisibilityChangedSignal(window).Disconnect(this, &AnimatedVectorImageVisual::OnWindowVisibilityChanged);
356 mPlacementActor.Reset();
358 // Reset the visual size to zero so that when adding the actor back to stage the rasterization is forced
359 mVisualSize = Vector2::ZERO;
360 mVisualScale = Vector2::ONE;
362 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::DoSetOffScene [%p]\n", this);
365 void AnimatedVectorImageVisual::OnSetTransform()
367 Vector2 visualSize = mImpl->mTransform.GetVisualSize(mImpl->mControlSize);
369 if(IsOnScene() && visualSize != mVisualSize)
371 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSetTransform: width = %f, height = %f [%p]\n", visualSize.width, visualSize.height, this);
373 mVisualSize = visualSize;
375 SetVectorImageSize();
377 if(mPlayState == DevelImageVisual::PlayState::PLAYING && mAnimationData.playState != DevelImageVisual::PlayState::PLAYING)
379 mAnimationData.playState = DevelImageVisual::PlayState::PLAYING;
380 mAnimationData.resendFlag |= VectorAnimationTask::RESEND_PLAY_STATE;
387 void AnimatedVectorImageVisual::OnDoAction(const Property::Index actionId, const Property::Value& attributes)
389 // Check if action is valid for this visual type and perform action if possible
392 case DevelAnimatedVectorImageVisual::Action::PLAY:
394 if(IsOnScene() && mVisualSize != Vector2::ZERO)
396 if(mAnimationData.playState != DevelImageVisual::PlayState::PLAYING)
398 mAnimationData.playState = DevelImageVisual::PlayState::PLAYING;
399 mAnimationData.resendFlag |= VectorAnimationTask::RESEND_PLAY_STATE;
402 mPlayState = DevelImageVisual::PlayState::PLAYING;
405 case DevelAnimatedVectorImageVisual::Action::PAUSE:
407 if(mAnimationData.playState == DevelImageVisual::PlayState::PLAYING)
409 mAnimationData.playState = DevelImageVisual::PlayState::PAUSED;
410 mAnimationData.resendFlag |= VectorAnimationTask::RESEND_PLAY_STATE;
412 mPlayState = DevelImageVisual::PlayState::PAUSED;
415 case DevelAnimatedVectorImageVisual::Action::STOP:
417 if(mAnimationData.playState != DevelImageVisual::PlayState::STOPPED)
419 mAnimationData.playState = DevelImageVisual::PlayState::STOPPED;
420 mAnimationData.resendFlag |= VectorAnimationTask::RESEND_PLAY_STATE;
422 mPlayState = DevelImageVisual::PlayState::STOPPED;
425 case DevelAnimatedVectorImageVisual::Action::JUMP_TO:
428 if(attributes.Get(frameNumber))
430 mAnimationData.currentFrame = frameNumber;
431 mAnimationData.resendFlag |= VectorAnimationTask::RESEND_CURRENT_FRAME;
435 case DevelAnimatedVectorImageVisual::Action::UPDATE_PROPERTY:
437 const Property::Map* map = attributes.GetMap();
440 DoSetProperties(*map);
446 TriggerVectorRasterization();
449 void AnimatedVectorImageVisual::OnUploadCompleted()
451 // If weak handle is holding a placement actor, it is the time to add the renderer to actor.
452 Actor actor = mPlacementActor.GetHandle();
453 if(actor && !mRendererAdded)
455 actor.AddRenderer(mImpl->mRenderer);
456 mRendererAdded = true;
458 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
460 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnUploadCompleted: Renderer is added [%p]\n", this);
464 void AnimatedVectorImageVisual::OnAnimationFinished()
466 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnAnimationFinished: action state = %d [%p]\n", mPlayState, this);
468 if(mPlayState != DevelImageVisual::PlayState::STOPPED)
470 mPlayState = DevelImageVisual::PlayState::STOPPED;
472 mAnimationData.playState = DevelImageVisual::PlayState::STOPPED;
474 if(mImpl->mEventObserver)
476 mImpl->mEventObserver->NotifyVisualEvent(*this, DevelAnimatedVectorImageVisual::Signal::ANIMATION_FINISHED);
482 mImpl->mRenderer.SetProperty(DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED);
486 void AnimatedVectorImageVisual::SendAnimationData()
488 if(mAnimationData.resendFlag)
490 mVectorAnimationTask->SetAnimationData(mAnimationData);
494 if(mAnimationData.playState == DevelImageVisual::PlayState::PLAYING)
496 mImpl->mRenderer.SetProperty(DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::CONTINUOUSLY);
500 mImpl->mRenderer.SetProperty(DevelRenderer::Property::RENDERING_BEHAVIOR, DevelRenderer::Rendering::IF_REQUIRED);
504 mAnimationData.resendFlag = 0;
508 void AnimatedVectorImageVisual::SetVectorImageSize()
510 uint32_t width = static_cast<uint32_t>(mVisualSize.width * mVisualScale.width);
511 uint32_t height = static_cast<uint32_t>(mVisualSize.height * mVisualScale.height);
513 mAnimationData.width = width;
514 mAnimationData.height = height;
515 mAnimationData.resendFlag |= VectorAnimationTask::RESEND_SIZE;
518 void AnimatedVectorImageVisual::StopAnimation()
520 if(mAnimationData.playState != DevelImageVisual::PlayState::STOPPED)
522 mAnimationData.playState = DevelImageVisual::PlayState::STOPPED;
523 mAnimationData.resendFlag |= VectorAnimationTask::RESEND_PLAY_STATE;
525 mPlayState = DevelImageVisual::PlayState::STOPPED;
529 void AnimatedVectorImageVisual::TriggerVectorRasterization()
531 if(!mEventCallback && !mCoreShutdown)
533 mEventCallback = MakeCallback(this, &AnimatedVectorImageVisual::OnProcessEvents);
534 auto& vectorAnimationManager = mFactoryCache.GetVectorAnimationManager();
535 vectorAnimationManager.RegisterEventCallback(mEventCallback);
536 Stage::GetCurrent().KeepRendering(0.0f); // Trigger event processing
540 void AnimatedVectorImageVisual::OnScaleNotification(PropertyNotification& source)
542 Actor actor = mPlacementActor.GetHandle();
545 Vector3 scale = actor.GetProperty<Vector3>(Actor::Property::WORLD_SCALE);
547 if(mRedrawInScalingDown || scale.width >= 1.0f || scale.height >= 1.0f)
549 mVisualScale.width = scale.width;
550 mVisualScale.height = scale.height;
552 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnScaleNotification: scale = %f, %f [%p]\n", mVisualScale.width, mVisualScale.height, this);
554 SetVectorImageSize();
557 Stage::GetCurrent().KeepRendering(0.0f); // Trigger event processing
562 void AnimatedVectorImageVisual::OnSizeNotification(PropertyNotification& source)
564 Actor actor = mPlacementActor.GetHandle();
567 Vector3 size = actor.GetCurrentProperty<Vector3>(Actor::Property::SIZE);
568 mVisualSize.width = size.width;
569 mVisualSize.height = size.height;
571 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnSizeNotification: size = %f, %f [%p]\n", mVisualSize.width, mVisualSize.height, this);
573 SetVectorImageSize();
576 Stage::GetCurrent().KeepRendering(0.0f); // Trigger event processing
580 void AnimatedVectorImageVisual::OnControlVisibilityChanged(Actor actor, bool visible, DevelActor::VisibilityChange::Type type)
585 TriggerVectorRasterization();
587 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnControlVisibilityChanged: invisibile. Pause animation [%p]\n", this);
591 void AnimatedVectorImageVisual::OnWindowVisibilityChanged(Window window, bool visible)
596 TriggerVectorRasterization();
598 DALI_LOG_INFO(gVectorAnimationLogFilter, Debug::Verbose, "AnimatedVectorImageVisual::OnWindowVisibilityChanged: invisibile. Pause animation [%p]\n", this);
602 void AnimatedVectorImageVisual::OnProcessEvents()
606 mEventCallback = nullptr; // The callback will be deleted in the VectorAnimationManager
609 } // namespace Internal
611 } // namespace Toolkit