2 * Copyright (c) 2022 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-rasterize-thread.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/adaptor-framework/file-loader.h>
31 #include <dali/devel-api/common/stage.h>
32 #include <dali/integration-api/debug.h>
42 const int CUSTOM_PROPERTY_COUNT(6); // atlas + corner/border
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));
53 svgVisual->SetProperties(properties);
54 svgVisual->Initialize();
58 SvgVisualPtr SvgVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl)
60 SvgVisualPtr svgVisual(new SvgVisual(factoryCache, shaderFactory, imageUrl));
62 svgVisual->Initialize();
66 SvgVisual::SvgVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl)
67 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::SVG),
68 mImageVisualShaderFactory(shaderFactory),
69 mAtlasRect(FULL_TEXTURE_RECT),
71 mVectorRenderer(VectorImageRenderer::New()),
75 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()
87 void SvgVisual::OnInitialize()
89 Shader shader = GenerateShader();
90 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
91 mImpl->mRenderer = VisualRenderer::New(geometry, shader);
92 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
95 void SvgVisual::DoSetProperties(const Property::Map& propertyMap)
97 // url already passed in from constructor
98 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
100 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
101 if(keyValue.first.type == Property::Key::INDEX)
103 DoSetProperty(keyValue.first.indexKey, keyValue.second);
105 else if(keyValue.first == IMAGE_ATLASING)
107 DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
109 else if(keyValue.first == SYNCHRONOUS_LOADING)
111 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
116 void SvgVisual::DoSetProperty(Property::Index index, const Property::Value& value)
120 case Toolkit::ImageVisual::Property::ATLASING:
122 value.Get(mAttemptAtlasing);
125 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
132 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
136 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
141 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
148 void SvgVisual::DoSetOnScene(Actor& actor)
150 TextureSet textureSet = TextureSet::New();
151 mImpl->mRenderer.SetTextures(textureSet);
153 // Register transform properties
154 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
156 // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
158 // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
159 mPlacementActor = actor;
163 Vector2 imageSize = Vector2::ZERO;
164 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
165 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
166 actor.AddRenderer(mImpl->mRenderer);
168 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
172 if(mImpl->mEventObserver)
174 // SVG visual needs it's size set before it can be rasterized hence request relayout once on stage
175 mImpl->mEventObserver->RelayoutRequest(*this);
180 void SvgVisual::DoSetOffScene(Actor& actor)
182 mFactoryCache.GetSVGRasterizationThread()->RemoveTask(this);
184 actor.RemoveRenderer(mImpl->mRenderer);
185 mPlacementActor.Reset();
187 // Reset the visual size to zero so that when adding the actor back to stage the SVG rasterization is forced
188 mRasterizedSize = Vector2::ZERO;
191 void SvgVisual::GetNaturalSize(Vector2& naturalSize)
193 if(mLoadFailed && mImpl->mRenderer)
195 // Load failed, use broken image size
196 auto textureSet = mImpl->mRenderer.GetTextures();
197 if(textureSet && textureSet.GetTextureCount())
199 auto texture = textureSet.GetTexture(0);
202 naturalSize.x = texture.GetWidth();
203 naturalSize.y = texture.GetHeight();
210 naturalSize.x = mDefaultWidth;
211 naturalSize.y = mDefaultHeight;
215 void SvgVisual::DoCreatePropertyMap(Property::Map& map) const
218 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::SVG);
219 if(mImageUrl.IsValid())
221 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
222 map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
224 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, IsSynchronousLoadingRequired());
227 void SvgVisual::DoCreateInstancePropertyMap(Property::Map& map) const
232 void SvgVisual::EnablePreMultipliedAlpha(bool preMultiplied)
234 // Make always enable pre multiplied alpha whether preMultiplied value is false.
237 DALI_LOG_WARNING("Note : SvgVisual cannot disable PreMultipliedAlpha\n");
241 void SvgVisual::Load()
243 // load remote resource on svg rasterize thread.
244 if(mImageUrl.IsLocalResource())
246 Dali::Vector<uint8_t> buffer;
247 if(Dali::FileLoader::ReadFile(mImageUrl.GetUrl(), buffer))
249 buffer.PushBack('\0');
251 Vector2 dpi = Stage::GetCurrent().GetDpi();
252 float meanDpi = (dpi.height + dpi.width) * 0.5f;
253 if(!mVectorRenderer.Load(buffer, meanDpi))
256 DALI_LOG_ERROR("SvgVisual::Load: Failed to load file! [%s]\n", mImageUrl.GetUrl().c_str());
259 mVectorRenderer.GetDefaultSize(mDefaultWidth, mDefaultHeight);
264 DALI_LOG_ERROR("SvgVisual::Load: Failed to read file! [%s]\n", mImageUrl.GetUrl().c_str());
269 void SvgVisual::AddRasterizationTask(const Vector2& size)
273 unsigned int width = static_cast<unsigned int>(size.width);
274 unsigned int height = static_cast<unsigned int>(size.height);
276 Vector2 dpi = Stage::GetCurrent().GetDpi();
277 float meanDpi = (dpi.height + dpi.width) * 0.5f;
279 RasterizingTaskPtr newTask = new RasterizingTask(this, mVectorRenderer, mImageUrl, meanDpi, width, height);
280 if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
283 newTask->Rasterize();
284 ApplyRasterizedImage(newTask->GetVectorRenderer(), newTask->GetPixelData(), newTask->IsLoaded());
288 mFactoryCache.GetSVGRasterizationThread()->AddTask(newTask);
293 void SvgVisual::ApplyRasterizedImage(VectorImageRenderer vectorRenderer, PixelData rasterizedPixelData, bool isLoaded)
295 if(isLoaded && rasterizedPixelData && IsOnScene())
297 if(mDefaultWidth == 0 || mDefaultHeight == 0)
299 mVectorRenderer.GetDefaultSize(mDefaultWidth, mDefaultHeight);
302 mRasterizedSize.x = static_cast<float>(rasterizedPixelData.GetWidth());
303 mRasterizedSize.y = static_cast<float>(rasterizedPixelData.GetHeight());
305 TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
306 if(mImpl->mFlags & Impl::IS_ATLASING_APPLIED)
308 mFactoryCache.GetAtlasManager()->Remove(currentTextureSet, mAtlasRect);
311 TextureSet textureSet;
313 if(mAttemptAtlasing && !mImpl->mCustomShader)
316 textureSet = mFactoryCache.GetAtlasManager()->Add(atlasRect, rasterizedPixelData);
317 if(textureSet) // atlasing
319 if(textureSet != currentTextureSet)
321 mImpl->mRenderer.SetTextures(textureSet);
323 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, atlasRect);
324 mAtlasRect = atlasRect;
325 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
329 if(!textureSet) // no atlasing - mAttemptAtlasing is false or adding to atlas is failed
331 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D, Pixel::RGBA8888, rasterizedPixelData.GetWidth(), rasterizedPixelData.GetHeight());
332 texture.Upload(rasterizedPixelData);
333 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
335 if(mAtlasRect == FULL_TEXTURE_RECT)
337 textureSet = currentTextureSet;
341 textureSet = TextureSet::New();
342 mImpl->mRenderer.SetTextures(textureSet);
344 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT);
345 mAtlasRect = FULL_TEXTURE_RECT;
350 textureSet.SetTexture(0, texture);
354 // Rasterized pixels are uploaded to texture. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
355 Actor actor = mPlacementActor.GetHandle();
358 actor.AddRenderer(mImpl->mRenderer);
359 // reset the weak handle so that the renderer only get added to actor once
360 mPlacementActor.Reset();
363 // Svg loaded and ready to display
364 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
366 else if(!isLoaded || !rasterizedPixelData)
370 Actor actor = mPlacementActor.GetHandle();
373 Vector2 imageSize = Vector2::ZERO;
374 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
375 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
376 actor.AddRenderer(mImpl->mRenderer);
379 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
383 void SvgVisual::OnSetTransform()
385 Vector2 visualSize = mImpl->mTransform.GetVisualSize(mImpl->mControlSize);
387 if(IsOnScene() && !mLoadFailed)
389 if(visualSize != mRasterizedSize || mDefaultWidth == 0 || mDefaultHeight == 0)
391 AddRasterizationTask(visualSize);
392 mRasterizedSize = visualSize;
398 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
402 void SvgVisual::UpdateShader()
406 Shader shader = GenerateShader();
407 mImpl->mRenderer.SetShader(shader);
411 Shader SvgVisual::GenerateShader() const
414 if(!mImpl->mCustomShader)
416 shader = mImageVisualShaderFactory.GetShader(
418 ImageVisualShaderFeature::FeatureBuilder()
419 .EnableTextureAtlas(mAttemptAtlasing)
420 .EnableRoundedCorner(IsRoundedCornerRequired())
421 .EnableBorderline(IsBorderlineRequired()));
425 shader = Shader::New(mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource().data() : mImpl->mCustomShader->mVertexShader,
426 mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource().data() : mImpl->mCustomShader->mFragmentShader,
427 mImpl->mCustomShader->mHints);
429 shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
434 } // namespace Internal
436 } // namespace Toolkit