2 * Copyright (c) 2023 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 "svg-visual.h"
22 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
23 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
24 #include <dali-toolkit/internal/visuals/image-visual-shader-feature-builder.h>
25 #include <dali-toolkit/internal/visuals/svg/svg-task.h>
26 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
27 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
28 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
31 #include <dali/devel-api/common/stage.h>
32 #include <dali/integration-api/debug.h>
33 #include <dali/public-api/rendering/decorated-visual-renderer.h>
43 const int CUSTOM_PROPERTY_COUNT(1); // atlas
46 const Dali::Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
50 SvgVisualPtr SvgVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties)
52 SvgVisualPtr svgVisual(new SvgVisual(factoryCache, shaderFactory, imageUrl, ImageDimensions{}));
53 svgVisual->SetProperties(properties);
54 svgVisual->Initialize();
58 SvgVisualPtr SvgVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size)
60 SvgVisualPtr svgVisual(new SvgVisual(factoryCache, shaderFactory, imageUrl, size));
61 svgVisual->Initialize();
65 SvgVisual::SvgVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size)
66 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::SVG),
67 mImageVisualShaderFactory(shaderFactory),
68 mAtlasRect(FULL_TEXTURE_RECT),
70 mVectorRenderer(VectorImageRenderer::New()),
74 mRasterizedSize(Vector2::ZERO),
77 mAttemptAtlasing(false)
79 // the rasterized image is with pre-multiplied alpha format
80 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
83 SvgVisual::~SvgVisual()
85 if(Stage::IsInstalled())
89 Dali::AsyncTaskManager::Get().RemoveTask(mLoadingTask);
93 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
96 DALI_LOG_RELEASE_INFO("SvgVisual is destructed: %p\n", this);
99 void SvgVisual::OnInitialize()
101 Shader shader = GenerateShader();
102 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
103 mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
104 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
106 Vector2 dpi = Stage::GetCurrent().GetDpi();
107 float meanDpi = (dpi.height + dpi.width) * 0.5f;
109 mLoadingTask = new SvgLoadingTask(mVectorRenderer, mImageUrl, meanDpi, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
111 if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
113 mLoadingTask->Process();
114 if(!mLoadingTask->HasSucceeded())
118 mLoadingTask.Reset(); // We don't need it anymore.
122 Dali::AsyncTaskManager::Get().AddTask(mLoadingTask);
126 void SvgVisual::DoSetProperties(const Property::Map& propertyMap)
128 // url already passed in from constructor
129 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
131 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
132 if(keyValue.first.type == Property::Key::INDEX)
134 DoSetProperty(keyValue.first.indexKey, keyValue.second);
136 else if(keyValue.first == IMAGE_ATLASING)
138 DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
140 else if(keyValue.first == SYNCHRONOUS_LOADING)
142 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
144 else if(keyValue.first == IMAGE_DESIRED_WIDTH)
146 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
148 else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
150 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
155 void SvgVisual::DoSetProperty(Property::Index index, const Property::Value& value)
159 case Toolkit::ImageVisual::Property::ATLASING:
161 value.Get(mAttemptAtlasing);
164 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
171 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
175 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
180 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
184 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
186 int32_t desiredWidth = 0;
187 if(value.Get(desiredWidth))
189 mDesiredSize.SetWidth(desiredWidth);
193 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
195 int32_t desiredHeight = 0;
196 if(value.Get(desiredHeight))
198 mDesiredSize.SetHeight(desiredHeight);
205 void SvgVisual::DoSetOnScene(Actor& actor)
207 TextureSet textureSet = TextureSet::New();
208 mImpl->mRenderer.SetTextures(textureSet);
210 // Register transform properties
211 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
213 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
215 // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
216 mPlacementActor = actor;
220 Vector2 imageSize = Vector2::ZERO;
221 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
222 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
223 actor.AddRenderer(mImpl->mRenderer);
225 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
229 if(mImpl->mEventObserver)
231 // SVG visual needs it's size set before it can be rasterized hence request relayout once on stage
232 mImpl->mEventObserver->RelayoutRequest(*this);
237 void SvgVisual::DoSetOffScene(Actor& actor)
239 // Remove rasterizing task
242 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
243 mRasterizingTask.Reset();
246 actor.RemoveRenderer(mImpl->mRenderer);
247 mPlacementActor.Reset();
249 // Reset the visual size to zero so that when adding the actor back to stage the SVG rasterization is forced
250 mRasterizedSize = Vector2::ZERO;
253 void SvgVisual::GetNaturalSize(Vector2& naturalSize)
255 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
257 naturalSize.x = mDesiredSize.GetWidth();
258 naturalSize.y = mDesiredSize.GetHeight();
260 else if(mLoadFailed && mImpl->mRenderer)
262 // Load failed, use broken image size
263 auto textureSet = mImpl->mRenderer.GetTextures();
264 if(textureSet && textureSet.GetTextureCount())
266 auto texture = textureSet.GetTexture(0);
269 naturalSize.x = texture.GetWidth();
270 naturalSize.y = texture.GetHeight();
277 naturalSize.x = mDefaultWidth;
278 naturalSize.y = mDefaultHeight;
282 void SvgVisual::DoCreatePropertyMap(Property::Map& map) const
285 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::SVG);
286 if(mImageUrl.IsValid())
288 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
289 map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
291 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, IsSynchronousLoadingRequired());
292 map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
293 map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
296 void SvgVisual::DoCreateInstancePropertyMap(Property::Map& map) const
301 void SvgVisual::EnablePreMultipliedAlpha(bool preMultiplied)
303 // Make always enable pre multiplied alpha whether preMultiplied value is false.
306 DALI_LOG_WARNING("Note : SvgVisual cannot disable PreMultipliedAlpha\n");
310 void SvgVisual::AddRasterizationTask(const Vector2& size)
314 // Remove previous task
317 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
318 mRasterizingTask.Reset();
321 unsigned int width = static_cast<unsigned int>(size.width);
322 unsigned int height = static_cast<unsigned int>(size.height);
324 mRasterizingTask = new SvgRasterizingTask(mVectorRenderer, width, height, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
327 reinterpret_cast<SvgRasterizingTask*>(mRasterizingTask.Get())->SetUrl(mImageUrl);
330 if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
332 mRasterizingTask->Process();
333 ApplyRasterizedImage(mRasterizingTask);
334 mRasterizingTask.Reset(); // We don't need it anymore.
338 Dali::AsyncTaskManager::Get().AddTask(mRasterizingTask);
343 void SvgVisual::ApplyRasterizedImage(SvgTaskPtr task)
345 if(DALI_UNLIKELY(mImpl == nullptr))
347 DALI_LOG_ERROR("Fatal error!! already destroyed object callback called! SvgVisual : %p, task : %p\n", this, task.Get());
351 if(task->HasSucceeded())
353 PixelData rasterizedPixelData = task->GetPixelData();
354 if(mDefaultWidth == 0 || mDefaultHeight == 0)
356 task->GetRenderer().GetDefaultSize(mDefaultWidth, mDefaultHeight);
359 // We don't need to keep tasks anymore. reset now.
360 if(task == mLoadingTask)
362 mLoadingTask.Reset();
364 if(task == mRasterizingTask)
366 mRasterizingTask.Reset();
369 // Rasterization success
370 if(rasterizedPixelData && IsOnScene())
372 mRasterizedSize.x = static_cast<float>(rasterizedPixelData.GetWidth());
373 mRasterizedSize.y = static_cast<float>(rasterizedPixelData.GetHeight());
375 TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
376 if(mImpl->mFlags & Impl::IS_ATLASING_APPLIED)
378 mFactoryCache.GetAtlasManager()->Remove(currentTextureSet, mAtlasRect);
381 TextureSet textureSet;
383 if(mAttemptAtlasing && !mImpl->mCustomShader)
386 textureSet = mFactoryCache.GetAtlasManager()->Add(atlasRect, rasterizedPixelData);
387 if(textureSet) // atlasing
389 if(textureSet != currentTextureSet)
391 mImpl->mRenderer.SetTextures(textureSet);
393 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, atlasRect);
394 mAtlasRect = atlasRect;
395 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
399 if(!textureSet) // no atlasing - mAttemptAtlasing is false or adding to atlas is failed
401 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, Pixel::RGBA8888, rasterizedPixelData.GetWidth(), rasterizedPixelData.GetHeight());
402 texture.Upload(rasterizedPixelData);
403 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
405 if(mAtlasRect == FULL_TEXTURE_RECT)
407 textureSet = currentTextureSet;
411 textureSet = TextureSet::New();
412 mImpl->mRenderer.SetTextures(textureSet);
414 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT);
415 mAtlasRect = FULL_TEXTURE_RECT;
420 textureSet.SetTexture(0, texture);
424 // Rasterized pixels are uploaded to texture. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
425 Actor actor = mPlacementActor.GetHandle();
428 actor.AddRenderer(mImpl->mRenderer);
429 // reset the weak handle so that the renderer only get added to actor once
430 mPlacementActor.Reset();
433 // Svg loaded and ready to display
434 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
437 else if(!mLoadFailed)
441 // Remove rasterizing task if we requested before.
444 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
445 mRasterizingTask.Reset();
448 // We don't need to keep tasks anymore. reset now.
449 if(task == mLoadingTask)
451 mLoadingTask.Reset();
454 Actor actor = mPlacementActor.GetHandle();
457 Vector2 imageSize = Vector2::ZERO;
458 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
459 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
460 actor.AddRenderer(mImpl->mRenderer);
463 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
467 void SvgVisual::OnSetTransform()
469 if(IsOnScene() && !mLoadFailed)
472 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
475 size = Vector2(mDesiredSize.GetWidth(), mDesiredSize.GetHeight());
480 size = mImpl->mTransform.GetVisualSize(mImpl->mControlSize);
483 if(size != mRasterizedSize || mDefaultWidth == 0 || mDefaultHeight == 0)
485 mRasterizedSize = size;
486 AddRasterizationTask(size);
492 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
496 void SvgVisual::UpdateShader()
500 Shader shader = GenerateShader();
501 mImpl->mRenderer.SetShader(shader);
505 Shader SvgVisual::GenerateShader() const
508 if(!mImpl->mCustomShader)
510 shader = mImageVisualShaderFactory.GetShader(
512 ImageVisualShaderFeatureBuilder()
513 .EnableTextureAtlas(mAttemptAtlasing)
514 .EnableRoundedCorner(IsRoundedCornerRequired())
515 .EnableBorderline(IsBorderlineRequired()));
519 shader = Shader::New(mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource().data() : mImpl->mCustomShader->mVertexShader,
520 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource().data() : mImpl->mCustomShader->mFragmentShader,
521 mImpl->mCustomShader->mHints);
523 shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
528 } // namespace Internal
530 } // namespace Toolkit