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 <dali-toolkit/internal/visuals/svg/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 if(mImageUrl.IsBufferResource())
98 TextureManager& textureManager = mFactoryCache.GetTextureManager();
99 textureManager.RemoveEncodedImageBuffer(mImageUrl.GetUrl());
104 void SvgVisual::OnInitialize()
106 Shader shader = GenerateShader();
107 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
108 mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
109 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
111 Vector2 dpi = Stage::GetCurrent().GetDpi();
112 float meanDpi = (dpi.height + dpi.width) * 0.5f;
114 EncodedImageBuffer encodedImageBuffer;
116 if(mImageUrl.IsBufferResource())
118 // Increase reference count of External Resources :
119 // EncodedImageBuffer.
120 // Reference count will be decreased at destructor of the visual.
121 TextureManager& textureManager = mFactoryCache.GetTextureManager();
122 textureManager.UseExternalResource(mImageUrl.GetUrl());
124 encodedImageBuffer = textureManager.GetEncodedImageBuffer(mImageUrl.GetUrl());
127 mLoadingTask = new SvgLoadingTask(mVectorRenderer, mImageUrl, encodedImageBuffer, meanDpi, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
129 if(IsSynchronousLoadingRequired() && (mImageUrl.IsLocalResource() || mImageUrl.IsBufferResource()))
131 mLoadingTask->Process();
132 if(!mLoadingTask->HasSucceeded())
136 mLoadingTask.Reset(); // We don't need it anymore.
140 Dali::AsyncTaskManager::Get().AddTask(mLoadingTask);
144 void SvgVisual::DoSetProperties(const Property::Map& propertyMap)
146 // url already passed in from constructor
147 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
149 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
150 if(keyValue.first.type == Property::Key::INDEX)
152 DoSetProperty(keyValue.first.indexKey, keyValue.second);
154 else if(keyValue.first == IMAGE_ATLASING)
156 DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
158 else if(keyValue.first == SYNCHRONOUS_LOADING)
160 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
162 else if(keyValue.first == IMAGE_DESIRED_WIDTH)
164 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
166 else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
168 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
173 void SvgVisual::DoSetProperty(Property::Index index, const Property::Value& value)
177 case Toolkit::ImageVisual::Property::ATLASING:
179 value.Get(mAttemptAtlasing);
182 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
189 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
193 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
198 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
202 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
204 int32_t desiredWidth = 0;
205 if(value.Get(desiredWidth))
207 mDesiredSize.SetWidth(desiredWidth);
211 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
213 int32_t desiredHeight = 0;
214 if(value.Get(desiredHeight))
216 mDesiredSize.SetHeight(desiredHeight);
223 void SvgVisual::DoSetOnScene(Actor& actor)
225 TextureSet textureSet = TextureSet::New();
226 mImpl->mRenderer.SetTextures(textureSet);
228 // Register transform properties
229 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
231 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
233 // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
234 mPlacementActor = actor;
238 Vector2 imageSize = Vector2::ZERO;
239 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
240 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
241 actor.AddRenderer(mImpl->mRenderer);
243 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
247 if(mImpl->mEventObserver)
249 // SVG visual needs it's size set before it can be rasterized hence request relayout once on stage
250 mImpl->mEventObserver->RelayoutRequest(*this);
255 void SvgVisual::DoSetOffScene(Actor& actor)
257 // Remove rasterizing task
260 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
261 mRasterizingTask.Reset();
264 actor.RemoveRenderer(mImpl->mRenderer);
265 mPlacementActor.Reset();
267 // Reset the visual size to zero so that when adding the actor back to stage the SVG rasterization is forced
268 mRasterizedSize = Vector2::ZERO;
271 void SvgVisual::GetNaturalSize(Vector2& naturalSize)
273 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
275 naturalSize.x = mDesiredSize.GetWidth();
276 naturalSize.y = mDesiredSize.GetHeight();
278 else if(mLoadFailed && mImpl->mRenderer)
280 // Load failed, use broken image size
281 auto textureSet = mImpl->mRenderer.GetTextures();
282 if(textureSet && textureSet.GetTextureCount())
284 auto texture = textureSet.GetTexture(0);
287 naturalSize.x = texture.GetWidth();
288 naturalSize.y = texture.GetHeight();
295 naturalSize.x = mDefaultWidth;
296 naturalSize.y = mDefaultHeight;
300 void SvgVisual::DoCreatePropertyMap(Property::Map& map) const
303 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::SVG);
304 if(mImageUrl.IsValid())
306 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
307 map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
309 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, IsSynchronousLoadingRequired());
310 map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
311 map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
314 void SvgVisual::DoCreateInstancePropertyMap(Property::Map& map) const
319 void SvgVisual::EnablePreMultipliedAlpha(bool preMultiplied)
321 // Make always enable pre multiplied alpha whether preMultiplied value is false.
324 DALI_LOG_WARNING("Note : SvgVisual cannot disable PreMultipliedAlpha\n");
328 void SvgVisual::AddRasterizationTask(const Vector2& size)
332 // Remove previous task
335 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
336 mRasterizingTask.Reset();
339 unsigned int width = static_cast<unsigned int>(size.width);
340 unsigned int height = static_cast<unsigned int>(size.height);
342 mRasterizingTask = new SvgRasterizingTask(mVectorRenderer, width, height, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
345 reinterpret_cast<SvgRasterizingTask*>(mRasterizingTask.Get())->SetUrl(mImageUrl);
348 if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
350 mRasterizingTask->Process();
351 ApplyRasterizedImage(mRasterizingTask);
352 mRasterizingTask.Reset(); // We don't need it anymore.
356 Dali::AsyncTaskManager::Get().AddTask(mRasterizingTask);
361 void SvgVisual::ApplyRasterizedImage(SvgTaskPtr task)
363 if(DALI_UNLIKELY(mImpl == nullptr))
365 DALI_LOG_ERROR("Fatal error!! already destroyed object callback called! SvgVisual : %p, url : %s, task : %p\n", this, mImageUrl.GetUrl().c_str(), task.Get());
369 if(task->HasSucceeded())
371 PixelData rasterizedPixelData = task->GetPixelData();
372 if(mDefaultWidth == 0 || mDefaultHeight == 0)
374 task->GetRenderer().GetDefaultSize(mDefaultWidth, mDefaultHeight);
377 // We don't need to keep tasks anymore. reset now.
378 if(task == mLoadingTask)
380 mLoadingTask.Reset();
382 if(task == mRasterizingTask)
384 mRasterizingTask.Reset();
387 // Rasterization success
388 if(rasterizedPixelData && IsOnScene())
390 mRasterizedSize.x = static_cast<float>(rasterizedPixelData.GetWidth());
391 mRasterizedSize.y = static_cast<float>(rasterizedPixelData.GetHeight());
393 TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
394 if(mImpl->mFlags & Impl::IS_ATLASING_APPLIED)
396 mFactoryCache.GetAtlasManager()->Remove(currentTextureSet, mAtlasRect);
399 TextureSet textureSet;
401 if(mAttemptAtlasing && !mImpl->mCustomShader)
404 textureSet = mFactoryCache.GetAtlasManager()->Add(atlasRect, rasterizedPixelData);
405 if(textureSet) // atlasing
407 if(textureSet != currentTextureSet)
409 mImpl->mRenderer.SetTextures(textureSet);
411 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, atlasRect);
412 mAtlasRect = atlasRect;
413 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
417 if(!textureSet) // no atlasing - mAttemptAtlasing is false or adding to atlas is failed
419 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, Pixel::RGBA8888, rasterizedPixelData.GetWidth(), rasterizedPixelData.GetHeight());
420 texture.Upload(rasterizedPixelData);
421 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
423 if(mAtlasRect == FULL_TEXTURE_RECT)
425 textureSet = currentTextureSet;
429 textureSet = TextureSet::New();
430 mImpl->mRenderer.SetTextures(textureSet);
432 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT);
433 mAtlasRect = FULL_TEXTURE_RECT;
438 textureSet.SetTexture(0, texture);
442 // Rasterized pixels are uploaded to texture. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
443 Actor actor = mPlacementActor.GetHandle();
446 actor.AddRenderer(mImpl->mRenderer);
447 // reset the weak handle so that the renderer only get added to actor once
448 mPlacementActor.Reset();
451 // Svg loaded and ready to display
452 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
455 else if(!mLoadFailed)
459 // Remove rasterizing task if we requested before.
462 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
463 mRasterizingTask.Reset();
466 // We don't need to keep tasks anymore. reset now.
467 if(task == mLoadingTask)
469 mLoadingTask.Reset();
472 Actor actor = mPlacementActor.GetHandle();
475 Vector2 imageSize = Vector2::ZERO;
476 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
477 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
478 actor.AddRenderer(mImpl->mRenderer);
481 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
485 void SvgVisual::OnSetTransform()
487 if(IsOnScene() && !mLoadFailed)
490 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
493 size = Vector2(mDesiredSize.GetWidth(), mDesiredSize.GetHeight());
498 size = mImpl->mTransform.GetVisualSize(mImpl->mControlSize);
501 if(size != mRasterizedSize || mDefaultWidth == 0 || mDefaultHeight == 0)
503 mRasterizedSize = size;
504 AddRasterizationTask(size);
510 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
514 void SvgVisual::UpdateShader()
518 Shader shader = GenerateShader();
519 mImpl->mRenderer.SetShader(shader);
523 Shader SvgVisual::GenerateShader() const
526 if(!mImpl->mCustomShader)
528 shader = mImageVisualShaderFactory.GetShader(
530 ImageVisualShaderFeatureBuilder()
531 .EnableTextureAtlas(mAttemptAtlasing)
532 .EnableRoundedCorner(IsRoundedCornerRequired())
533 .EnableBorderline(IsBorderlineRequired()));
537 shader = Shader::New(mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource().data() : mImpl->mCustomShader->mVertexShader,
538 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource().data() : mImpl->mCustomShader->mFragmentShader,
539 mImpl->mCustomShader->mHints);
541 shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
546 } // namespace Internal
548 } // namespace Toolkit