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());
102 DALI_LOG_RELEASE_INFO("SvgVisual is destructed: %p\n", this);
105 void SvgVisual::OnInitialize()
107 Shader shader = GenerateShader();
108 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
109 mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
110 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
112 Vector2 dpi = Stage::GetCurrent().GetDpi();
113 float meanDpi = (dpi.height + dpi.width) * 0.5f;
115 EncodedImageBuffer encodedImageBuffer;
117 if(mImageUrl.IsBufferResource())
119 // Increase reference count of External Resources :
120 // EncodedImageBuffer.
121 // Reference count will be decreased at destructor of the visual.
122 TextureManager& textureManager = mFactoryCache.GetTextureManager();
123 textureManager.UseExternalResource(mImageUrl.GetUrl());
125 encodedImageBuffer = textureManager.GetEncodedImageBuffer(mImageUrl.GetUrl());
128 mLoadingTask = new SvgLoadingTask(mVectorRenderer, mImageUrl, encodedImageBuffer, meanDpi, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
130 if(IsSynchronousLoadingRequired() && (mImageUrl.IsLocalResource() || mImageUrl.IsBufferResource()))
132 mLoadingTask->Process();
133 if(!mLoadingTask->HasSucceeded())
137 mLoadingTask.Reset(); // We don't need it anymore.
141 Dali::AsyncTaskManager::Get().AddTask(mLoadingTask);
145 void SvgVisual::DoSetProperties(const Property::Map& propertyMap)
147 // url already passed in from constructor
148 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
150 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
151 if(keyValue.first.type == Property::Key::INDEX)
153 DoSetProperty(keyValue.first.indexKey, keyValue.second);
155 else if(keyValue.first == IMAGE_ATLASING)
157 DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
159 else if(keyValue.first == SYNCHRONOUS_LOADING)
161 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
163 else if(keyValue.first == IMAGE_DESIRED_WIDTH)
165 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
167 else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
169 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
174 void SvgVisual::DoSetProperty(Property::Index index, const Property::Value& value)
178 case Toolkit::ImageVisual::Property::ATLASING:
180 value.Get(mAttemptAtlasing);
183 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
190 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
194 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
199 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
203 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
205 int32_t desiredWidth = 0;
206 if(value.Get(desiredWidth))
208 mDesiredSize.SetWidth(desiredWidth);
212 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
214 int32_t desiredHeight = 0;
215 if(value.Get(desiredHeight))
217 mDesiredSize.SetHeight(desiredHeight);
224 void SvgVisual::DoSetOnScene(Actor& actor)
226 TextureSet textureSet = TextureSet::New();
227 mImpl->mRenderer.SetTextures(textureSet);
229 // Register transform properties
230 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
232 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
234 // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
235 mPlacementActor = actor;
239 Vector2 imageSize = Vector2::ZERO;
240 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
241 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
242 actor.AddRenderer(mImpl->mRenderer);
244 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
248 if(mImpl->mEventObserver)
250 // SVG visual needs it's size set before it can be rasterized hence request relayout once on stage
251 mImpl->mEventObserver->RelayoutRequest(*this);
256 void SvgVisual::DoSetOffScene(Actor& actor)
258 // Remove rasterizing task
261 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
262 mRasterizingTask.Reset();
265 actor.RemoveRenderer(mImpl->mRenderer);
266 mPlacementActor.Reset();
268 // Reset the visual size to zero so that when adding the actor back to stage the SVG rasterization is forced
269 mRasterizedSize = Vector2::ZERO;
272 void SvgVisual::GetNaturalSize(Vector2& naturalSize)
274 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
276 naturalSize.x = mDesiredSize.GetWidth();
277 naturalSize.y = mDesiredSize.GetHeight();
279 else if(mLoadFailed && mImpl->mRenderer)
281 // Load failed, use broken image size
282 auto textureSet = mImpl->mRenderer.GetTextures();
283 if(textureSet && textureSet.GetTextureCount())
285 auto texture = textureSet.GetTexture(0);
288 naturalSize.x = texture.GetWidth();
289 naturalSize.y = texture.GetHeight();
296 naturalSize.x = mDefaultWidth;
297 naturalSize.y = mDefaultHeight;
301 void SvgVisual::DoCreatePropertyMap(Property::Map& map) const
304 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::SVG);
305 if(mImageUrl.IsValid())
307 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
308 map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
310 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, IsSynchronousLoadingRequired());
311 map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
312 map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
315 void SvgVisual::DoCreateInstancePropertyMap(Property::Map& map) const
320 void SvgVisual::EnablePreMultipliedAlpha(bool preMultiplied)
322 // Make always enable pre multiplied alpha whether preMultiplied value is false.
325 DALI_LOG_WARNING("Note : SvgVisual cannot disable PreMultipliedAlpha\n");
329 void SvgVisual::AddRasterizationTask(const Vector2& size)
333 // Remove previous task
336 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
337 mRasterizingTask.Reset();
340 unsigned int width = static_cast<unsigned int>(size.width);
341 unsigned int height = static_cast<unsigned int>(size.height);
343 mRasterizingTask = new SvgRasterizingTask(mVectorRenderer, width, height, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
346 reinterpret_cast<SvgRasterizingTask*>(mRasterizingTask.Get())->SetUrl(mImageUrl);
349 if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
351 mRasterizingTask->Process();
352 ApplyRasterizedImage(mRasterizingTask);
353 mRasterizingTask.Reset(); // We don't need it anymore.
357 Dali::AsyncTaskManager::Get().AddTask(mRasterizingTask);
362 void SvgVisual::ApplyRasterizedImage(SvgTaskPtr task)
364 if(DALI_UNLIKELY(mImpl == nullptr))
366 DALI_LOG_ERROR("Fatal error!! already destroyed object callback called! SvgVisual : %p, task : %p\n", this, task.Get());
370 if(task->HasSucceeded())
372 PixelData rasterizedPixelData = task->GetPixelData();
373 if(mDefaultWidth == 0 || mDefaultHeight == 0)
375 task->GetRenderer().GetDefaultSize(mDefaultWidth, mDefaultHeight);
378 // We don't need to keep tasks anymore. reset now.
379 if(task == mLoadingTask)
381 mLoadingTask.Reset();
383 if(task == mRasterizingTask)
385 mRasterizingTask.Reset();
388 // Rasterization success
389 if(rasterizedPixelData && IsOnScene())
391 mRasterizedSize.x = static_cast<float>(rasterizedPixelData.GetWidth());
392 mRasterizedSize.y = static_cast<float>(rasterizedPixelData.GetHeight());
394 TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
395 if(mImpl->mFlags & Impl::IS_ATLASING_APPLIED)
397 mFactoryCache.GetAtlasManager()->Remove(currentTextureSet, mAtlasRect);
400 TextureSet textureSet;
402 if(mAttemptAtlasing && !mImpl->mCustomShader)
405 textureSet = mFactoryCache.GetAtlasManager()->Add(atlasRect, rasterizedPixelData);
406 if(textureSet) // atlasing
408 if(textureSet != currentTextureSet)
410 mImpl->mRenderer.SetTextures(textureSet);
412 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, atlasRect);
413 mAtlasRect = atlasRect;
414 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
418 if(!textureSet) // no atlasing - mAttemptAtlasing is false or adding to atlas is failed
420 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, Pixel::RGBA8888, rasterizedPixelData.GetWidth(), rasterizedPixelData.GetHeight());
421 texture.Upload(rasterizedPixelData);
422 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
424 if(mAtlasRect == FULL_TEXTURE_RECT)
426 textureSet = currentTextureSet;
430 textureSet = TextureSet::New();
431 mImpl->mRenderer.SetTextures(textureSet);
433 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT);
434 mAtlasRect = FULL_TEXTURE_RECT;
439 textureSet.SetTexture(0, texture);
443 // Rasterized pixels are uploaded to texture. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
444 Actor actor = mPlacementActor.GetHandle();
447 actor.AddRenderer(mImpl->mRenderer);
448 // reset the weak handle so that the renderer only get added to actor once
449 mPlacementActor.Reset();
452 // Svg loaded and ready to display
453 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
456 else if(!mLoadFailed)
460 // Remove rasterizing task if we requested before.
463 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
464 mRasterizingTask.Reset();
467 // We don't need to keep tasks anymore. reset now.
468 if(task == mLoadingTask)
470 mLoadingTask.Reset();
473 Actor actor = mPlacementActor.GetHandle();
476 Vector2 imageSize = Vector2::ZERO;
477 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
478 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
479 actor.AddRenderer(mImpl->mRenderer);
482 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
486 void SvgVisual::OnSetTransform()
488 if(IsOnScene() && !mLoadFailed)
491 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
494 size = Vector2(mDesiredSize.GetWidth(), mDesiredSize.GetHeight());
499 size = mImpl->mTransform.GetVisualSize(mImpl->mControlSize);
502 if(size != mRasterizedSize || mDefaultWidth == 0 || mDefaultHeight == 0)
504 mRasterizedSize = size;
505 AddRasterizationTask(size);
511 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
515 void SvgVisual::UpdateShader()
519 Shader shader = GenerateShader();
520 mImpl->mRenderer.SetShader(shader);
524 Shader SvgVisual::GenerateShader() const
527 if(!mImpl->mCustomShader)
529 shader = mImageVisualShaderFactory.GetShader(
531 ImageVisualShaderFeatureBuilder()
532 .EnableTextureAtlas(mAttemptAtlasing)
533 .EnableRoundedCorner(IsRoundedCornerRequired())
534 .EnableBorderline(IsBorderlineRequired()));
538 shader = Shader::New(mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource().data() : mImpl->mCustomShader->mVertexShader,
539 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource().data() : mImpl->mCustomShader->mFragmentShader,
540 mImpl->mCustomShader->mHints);
542 shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
547 } // namespace Internal
549 } // namespace Toolkit