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);
98 void SvgVisual::OnInitialize()
100 Shader shader = GenerateShader();
101 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
102 mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
103 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
105 Vector2 dpi = Stage::GetCurrent().GetDpi();
106 float meanDpi = (dpi.height + dpi.width) * 0.5f;
108 mLoadingTask = new SvgLoadingTask(mVectorRenderer, mImageUrl, meanDpi, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
110 if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
112 mLoadingTask->Process();
113 if(!mLoadingTask->HasSucceeded())
117 mLoadingTask.Reset(); // We don't need it anymore.
121 Dali::AsyncTaskManager::Get().AddTask(mLoadingTask);
125 void SvgVisual::DoSetProperties(const Property::Map& propertyMap)
127 // url already passed in from constructor
128 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
130 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
131 if(keyValue.first.type == Property::Key::INDEX)
133 DoSetProperty(keyValue.first.indexKey, keyValue.second);
135 else if(keyValue.first == IMAGE_ATLASING)
137 DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
139 else if(keyValue.first == SYNCHRONOUS_LOADING)
141 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
143 else if(keyValue.first == IMAGE_DESIRED_WIDTH)
145 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
147 else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
149 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
154 void SvgVisual::DoSetProperty(Property::Index index, const Property::Value& value)
158 case Toolkit::ImageVisual::Property::ATLASING:
160 value.Get(mAttemptAtlasing);
163 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
170 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
174 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
179 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
183 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
185 int32_t desiredWidth = 0;
186 if(value.Get(desiredWidth))
188 mDesiredSize.SetWidth(desiredWidth);
192 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
194 int32_t desiredHeight = 0;
195 if(value.Get(desiredHeight))
197 mDesiredSize.SetHeight(desiredHeight);
204 void SvgVisual::DoSetOnScene(Actor& actor)
206 TextureSet textureSet = TextureSet::New();
207 mImpl->mRenderer.SetTextures(textureSet);
209 // Register transform properties
210 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
212 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
214 // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
215 mPlacementActor = actor;
219 Vector2 imageSize = Vector2::ZERO;
220 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
221 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
222 actor.AddRenderer(mImpl->mRenderer);
224 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
228 if(mImpl->mEventObserver)
230 // SVG visual needs it's size set before it can be rasterized hence request relayout once on stage
231 mImpl->mEventObserver->RelayoutRequest(*this);
236 void SvgVisual::DoSetOffScene(Actor& actor)
238 // Remove rasterizing task
241 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
242 mRasterizingTask.Reset();
245 actor.RemoveRenderer(mImpl->mRenderer);
246 mPlacementActor.Reset();
248 // Reset the visual size to zero so that when adding the actor back to stage the SVG rasterization is forced
249 mRasterizedSize = Vector2::ZERO;
252 void SvgVisual::GetNaturalSize(Vector2& naturalSize)
254 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
256 naturalSize.x = mDesiredSize.GetWidth();
257 naturalSize.y = mDesiredSize.GetHeight();
259 else if(mLoadFailed && mImpl->mRenderer)
261 // Load failed, use broken image size
262 auto textureSet = mImpl->mRenderer.GetTextures();
263 if(textureSet && textureSet.GetTextureCount())
265 auto texture = textureSet.GetTexture(0);
268 naturalSize.x = texture.GetWidth();
269 naturalSize.y = texture.GetHeight();
276 naturalSize.x = mDefaultWidth;
277 naturalSize.y = mDefaultHeight;
281 void SvgVisual::DoCreatePropertyMap(Property::Map& map) const
284 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::SVG);
285 if(mImageUrl.IsValid())
287 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
288 map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
290 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, IsSynchronousLoadingRequired());
291 map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
292 map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
295 void SvgVisual::DoCreateInstancePropertyMap(Property::Map& map) const
300 void SvgVisual::EnablePreMultipliedAlpha(bool preMultiplied)
302 // Make always enable pre multiplied alpha whether preMultiplied value is false.
305 DALI_LOG_WARNING("Note : SvgVisual cannot disable PreMultipliedAlpha\n");
309 void SvgVisual::AddRasterizationTask(const Vector2& size)
313 // Remove previous task
316 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
317 mRasterizingTask.Reset();
320 unsigned int width = static_cast<unsigned int>(size.width);
321 unsigned int height = static_cast<unsigned int>(size.height);
323 mRasterizingTask = new SvgRasterizingTask(mVectorRenderer, width, height, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
326 reinterpret_cast<SvgRasterizingTask*>(mRasterizingTask.Get())->SetUrl(mImageUrl);
329 if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
331 mRasterizingTask->Process();
332 ApplyRasterizedImage(mRasterizingTask);
333 mRasterizingTask.Reset(); // We don't need it anymore.
337 Dali::AsyncTaskManager::Get().AddTask(mRasterizingTask);
342 void SvgVisual::ApplyRasterizedImage(SvgTaskPtr task)
344 if(DALI_UNLIKELY(mImpl == nullptr))
346 DALI_LOG_ERROR("Fatal error!! already destroyed object callback called! SvgVisual : %p, url : %s, task : %p\n", this, mImageUrl.GetUrl().c_str(), task.Get());
350 if(task->HasSucceeded())
352 PixelData rasterizedPixelData = task->GetPixelData();
353 if(mDefaultWidth == 0 || mDefaultHeight == 0)
355 task->GetRenderer().GetDefaultSize(mDefaultWidth, mDefaultHeight);
358 // We don't need to keep tasks anymore. reset now.
359 if(task == mLoadingTask)
361 mLoadingTask.Reset();
363 if(task == mRasterizingTask)
365 mRasterizingTask.Reset();
368 // Rasterization success
369 if(rasterizedPixelData && IsOnScene())
371 mRasterizedSize.x = static_cast<float>(rasterizedPixelData.GetWidth());
372 mRasterizedSize.y = static_cast<float>(rasterizedPixelData.GetHeight());
374 TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
375 if(mImpl->mFlags & Impl::IS_ATLASING_APPLIED)
377 mFactoryCache.GetAtlasManager()->Remove(currentTextureSet, mAtlasRect);
380 TextureSet textureSet;
382 if(mAttemptAtlasing && !mImpl->mCustomShader)
385 textureSet = mFactoryCache.GetAtlasManager()->Add(atlasRect, rasterizedPixelData);
386 if(textureSet) // atlasing
388 if(textureSet != currentTextureSet)
390 mImpl->mRenderer.SetTextures(textureSet);
392 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, atlasRect);
393 mAtlasRect = atlasRect;
394 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
398 if(!textureSet) // no atlasing - mAttemptAtlasing is false or adding to atlas is failed
400 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, Pixel::RGBA8888, rasterizedPixelData.GetWidth(), rasterizedPixelData.GetHeight());
401 texture.Upload(rasterizedPixelData);
402 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
404 if(mAtlasRect == FULL_TEXTURE_RECT)
406 textureSet = currentTextureSet;
410 textureSet = TextureSet::New();
411 mImpl->mRenderer.SetTextures(textureSet);
413 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT);
414 mAtlasRect = FULL_TEXTURE_RECT;
419 textureSet.SetTexture(0, texture);
423 // Rasterized pixels are uploaded to texture. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
424 Actor actor = mPlacementActor.GetHandle();
427 actor.AddRenderer(mImpl->mRenderer);
428 // reset the weak handle so that the renderer only get added to actor once
429 mPlacementActor.Reset();
432 // Svg loaded and ready to display
433 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
436 else if(!mLoadFailed)
440 // Remove rasterizing task if we requested before.
443 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
444 mRasterizingTask.Reset();
447 // We don't need to keep tasks anymore. reset now.
448 if(task == mLoadingTask)
450 mLoadingTask.Reset();
453 Actor actor = mPlacementActor.GetHandle();
456 Vector2 imageSize = Vector2::ZERO;
457 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
458 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
459 actor.AddRenderer(mImpl->mRenderer);
462 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
466 void SvgVisual::OnSetTransform()
468 if(IsOnScene() && !mLoadFailed)
471 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
474 size = Vector2(mDesiredSize.GetWidth(), mDesiredSize.GetHeight());
479 size = mImpl->mTransform.GetVisualSize(mImpl->mControlSize);
482 if(size != mRasterizedSize || mDefaultWidth == 0 || mDefaultHeight == 0)
484 mRasterizedSize = size;
485 AddRasterizationTask(size);
491 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
495 void SvgVisual::UpdateShader()
499 Shader shader = GenerateShader();
500 mImpl->mRenderer.SetShader(shader);
504 Shader SvgVisual::GenerateShader() const
507 if(!mImpl->mCustomShader)
509 shader = mImageVisualShaderFactory.GetShader(
511 ImageVisualShaderFeatureBuilder()
512 .EnableTextureAtlas(mAttemptAtlasing)
513 .EnableRoundedCorner(IsRoundedCornerRequired())
514 .EnableBorderline(IsBorderlineRequired()));
518 shader = Shader::New(mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource().data() : mImpl->mCustomShader->mVertexShader,
519 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource().data() : mImpl->mCustomShader->mFragmentShader,
520 mImpl->mCustomShader->mHints);
522 shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
527 } // namespace Internal
529 } // namespace Toolkit