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/svg/svg-task.h>
25 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
26 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
27 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
30 #include <dali/devel-api/common/stage.h>
31 #include <dali/integration-api/debug.h>
32 #include <dali/public-api/rendering/decorated-visual-renderer.h>
42 const int CUSTOM_PROPERTY_COUNT(1); // atlas
45 const Dali::Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
49 SvgVisualPtr SvgVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties)
51 SvgVisualPtr svgVisual(new SvgVisual(factoryCache, shaderFactory, imageUrl, ImageDimensions{}));
52 svgVisual->SetProperties(properties);
53 svgVisual->Initialize();
57 SvgVisualPtr SvgVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size)
59 SvgVisualPtr svgVisual(new SvgVisual(factoryCache, shaderFactory, imageUrl, size));
60 svgVisual->Initialize();
64 SvgVisual::SvgVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size)
65 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::SVG),
66 mImageVisualShaderFactory(shaderFactory),
67 mAtlasRect(FULL_TEXTURE_RECT),
69 mVectorRenderer(VectorImageRenderer::New()),
73 mRasterizedSize(Vector2::ZERO),
76 mAttemptAtlasing(false)
78 // the rasterized image is with pre-multiplied alpha format
79 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
82 SvgVisual::~SvgVisual()
84 if(Stage::IsInstalled())
88 Dali::AsyncTaskManager::Get().RemoveTask(mLoadingTask);
92 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
97 void SvgVisual::OnInitialize()
99 Shader shader = GenerateShader();
100 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
101 mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
102 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
104 Vector2 dpi = Stage::GetCurrent().GetDpi();
105 float meanDpi = (dpi.height + dpi.width) * 0.5f;
107 mLoadingTask = new SvgLoadingTask(mVectorRenderer, mImageUrl, meanDpi, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
109 if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
111 mLoadingTask->Process();
112 if(!mLoadingTask->HasSucceeded())
116 mLoadingTask.Reset(); // We don't need it anymore.
120 Dali::AsyncTaskManager::Get().AddTask(mLoadingTask);
124 void SvgVisual::DoSetProperties(const Property::Map& propertyMap)
126 // url already passed in from constructor
127 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
129 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
130 if(keyValue.first.type == Property::Key::INDEX)
132 DoSetProperty(keyValue.first.indexKey, keyValue.second);
134 else if(keyValue.first == IMAGE_ATLASING)
136 DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
138 else if(keyValue.first == SYNCHRONOUS_LOADING)
140 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
142 else if(keyValue.first == IMAGE_DESIRED_WIDTH)
144 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
146 else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
148 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
153 void SvgVisual::DoSetProperty(Property::Index index, const Property::Value& value)
157 case Toolkit::ImageVisual::Property::ATLASING:
159 value.Get(mAttemptAtlasing);
162 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
169 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
173 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
178 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
182 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
184 int32_t desiredWidth = 0;
185 if(value.Get(desiredWidth))
187 mDesiredSize.SetWidth(desiredWidth);
191 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
193 int32_t desiredHeight = 0;
194 if(value.Get(desiredHeight))
196 mDesiredSize.SetHeight(desiredHeight);
203 void SvgVisual::DoSetOnScene(Actor& actor)
205 TextureSet textureSet = TextureSet::New();
206 mImpl->mRenderer.SetTextures(textureSet);
208 // Register transform properties
209 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
211 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
213 // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
214 mPlacementActor = actor;
218 Vector2 imageSize = Vector2::ZERO;
219 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
220 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
221 actor.AddRenderer(mImpl->mRenderer);
223 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
227 if(mImpl->mEventObserver)
229 // SVG visual needs it's size set before it can be rasterized hence request relayout once on stage
230 mImpl->mEventObserver->RelayoutRequest(*this);
235 void SvgVisual::DoSetOffScene(Actor& actor)
237 // Remove loading & rasterizing task
240 Dali::AsyncTaskManager::Get().RemoveTask(mLoadingTask);
241 mLoadingTask.Reset();
245 Dali::AsyncTaskManager::Get().RemoveTask(mRasterizingTask);
246 mRasterizingTask.Reset();
249 actor.RemoveRenderer(mImpl->mRenderer);
250 mPlacementActor.Reset();
252 // Reset the visual size to zero so that when adding the actor back to stage the SVG rasterization is forced
253 mRasterizedSize = Vector2::ZERO;
256 void SvgVisual::GetNaturalSize(Vector2& naturalSize)
258 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
260 naturalSize.x = mDesiredSize.GetWidth();
261 naturalSize.y = mDesiredSize.GetHeight();
263 else if(mLoadFailed && mImpl->mRenderer)
265 // Load failed, use broken image size
266 auto textureSet = mImpl->mRenderer.GetTextures();
267 if(textureSet && textureSet.GetTextureCount())
269 auto texture = textureSet.GetTexture(0);
272 naturalSize.x = texture.GetWidth();
273 naturalSize.y = texture.GetHeight();
280 naturalSize.x = mDefaultWidth;
281 naturalSize.y = mDefaultHeight;
285 void SvgVisual::DoCreatePropertyMap(Property::Map& map) const
288 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::SVG);
289 if(mImageUrl.IsValid())
291 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
292 map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
294 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, IsSynchronousLoadingRequired());
295 map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
296 map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
299 void SvgVisual::DoCreateInstancePropertyMap(Property::Map& map) const
304 void SvgVisual::EnablePreMultipliedAlpha(bool preMultiplied)
306 // Make always enable pre multiplied alpha whether preMultiplied value is false.
309 DALI_LOG_WARNING("Note : SvgVisual cannot disable PreMultipliedAlpha\n");
313 void SvgVisual::AddRasterizationTask(const Vector2& size)
317 unsigned int width = static_cast<unsigned int>(size.width);
318 unsigned int height = static_cast<unsigned int>(size.height);
320 mRasterizingTask = new SvgRasterizingTask(mVectorRenderer, width, height, MakeCallback(this, &SvgVisual::ApplyRasterizedImage));
322 if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
324 mRasterizingTask->Process();
325 ApplyRasterizedImage(mRasterizingTask);
326 mRasterizingTask.Reset(); // We don't need it anymore.
330 Dali::AsyncTaskManager::Get().AddTask(mRasterizingTask);
335 void SvgVisual::ApplyRasterizedImage(SvgTaskPtr task)
337 if(task->HasSucceeded())
339 PixelData rasterizedPixelData = task->GetPixelData();
340 if(mDefaultWidth == 0 || mDefaultHeight == 0)
342 task->GetRenderer().GetDefaultSize(mDefaultWidth, mDefaultHeight);
345 // Rasterization success
346 if(rasterizedPixelData && IsOnScene())
348 mRasterizedSize.x = static_cast<float>(rasterizedPixelData.GetWidth());
349 mRasterizedSize.y = static_cast<float>(rasterizedPixelData.GetHeight());
351 TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
352 if(mImpl->mFlags & Impl::IS_ATLASING_APPLIED)
354 mFactoryCache.GetAtlasManager()->Remove(currentTextureSet, mAtlasRect);
357 TextureSet textureSet;
359 if(mAttemptAtlasing && !mImpl->mCustomShader)
362 textureSet = mFactoryCache.GetAtlasManager()->Add(atlasRect, rasterizedPixelData);
363 if(textureSet) // atlasing
365 if(textureSet != currentTextureSet)
367 mImpl->mRenderer.SetTextures(textureSet);
369 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, atlasRect);
370 mAtlasRect = atlasRect;
371 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
375 if(!textureSet) // no atlasing - mAttemptAtlasing is false or adding to atlas is failed
377 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, Pixel::RGBA8888, rasterizedPixelData.GetWidth(), rasterizedPixelData.GetHeight());
378 texture.Upload(rasterizedPixelData);
379 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
381 if(mAtlasRect == FULL_TEXTURE_RECT)
383 textureSet = currentTextureSet;
387 textureSet = TextureSet::New();
388 mImpl->mRenderer.SetTextures(textureSet);
390 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT);
391 mAtlasRect = FULL_TEXTURE_RECT;
396 textureSet.SetTexture(0, texture);
400 // Rasterized pixels are uploaded to texture. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
401 Actor actor = mPlacementActor.GetHandle();
404 actor.AddRenderer(mImpl->mRenderer);
405 // reset the weak handle so that the renderer only get added to actor once
406 mPlacementActor.Reset();
409 // Svg loaded and ready to display
410 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
413 else if(!mLoadFailed)
417 Actor actor = mPlacementActor.GetHandle();
420 Vector2 imageSize = Vector2::ZERO;
421 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
422 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
423 actor.AddRenderer(mImpl->mRenderer);
426 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
429 // We don't need to keep tasks anymore. reset now.
430 if(task == mLoadingTask)
432 mLoadingTask.Reset();
434 if(task == mRasterizingTask)
436 mRasterizingTask.Reset();
440 void SvgVisual::OnSetTransform()
442 if(IsOnScene() && !mLoadFailed)
445 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
448 size = Vector2(mDesiredSize.GetWidth(), mDesiredSize.GetHeight());
453 size = mImpl->mTransform.GetVisualSize(mImpl->mControlSize);
456 if(size != mRasterizedSize || mDefaultWidth == 0 || mDefaultHeight == 0)
458 mRasterizedSize = size;
459 AddRasterizationTask(size);
465 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
469 void SvgVisual::UpdateShader()
473 Shader shader = GenerateShader();
474 mImpl->mRenderer.SetShader(shader);
478 Shader SvgVisual::GenerateShader() const
481 if(!mImpl->mCustomShader)
483 shader = mImageVisualShaderFactory.GetShader(
485 ImageVisualShaderFeature::FeatureBuilder()
486 .EnableTextureAtlas(mAttemptAtlasing)
487 .EnableRoundedCorner(IsRoundedCornerRequired())
488 .EnableBorderline(IsBorderlineRequired()));
492 shader = Shader::New(mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource().data() : mImpl->mCustomShader->mVertexShader,
493 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource().data() : mImpl->mCustomShader->mFragmentShader,
494 mImpl->mCustomShader->mHints);
496 shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
501 } // namespace Internal
503 } // namespace Toolkit