Show the broken image in case of invalid svg files
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / svg / svg-visual.cpp
index 32ff3ea..ec19635 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #include "svg-visual.h"
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/third-party/nanosvg/nanosvg.h>
-#include <dali-toolkit/third-party/nanosvg/nanosvgrast.h>
 #include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h>
 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
-#include <dali/devel-api/adaptor-framework/file-loader.h>
+#include <dali-toolkit/public-api/visuals/image-visual-properties.h>
 
 // EXTERNAL INCLUDES
-#include <dali/public-api/common/stage.h>
+#include <dali/devel-api/common/stage.h>
+#include <dali/devel-api/adaptor-framework/file-loader.h>
 #include <dali/integration-api/debug.h>
 
 namespace Dali
@@ -44,8 +43,6 @@ namespace Internal
 namespace
 {
 // property name
-const char * const UNITS("px");
-
 const Dali::Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
 
 }
@@ -53,29 +50,32 @@ const Dali::Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
 SvgVisualPtr SvgVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties )
 {
   SvgVisualPtr svgVisual( new SvgVisual( factoryCache, shaderFactory, imageUrl ) );
-  svgVisual->ParseFromUrl( imageUrl );
-  svgVisual->SetProperties( properties );
-
+  svgVisual->Load();
+  svgVisual->SetProperties(properties);
+  svgVisual->Initialize();
   return svgVisual;
 }
 
 SvgVisualPtr SvgVisual::New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl )
 {
   SvgVisualPtr svgVisual( new SvgVisual( factoryCache, shaderFactory, imageUrl ) );
-  svgVisual->ParseFromUrl( imageUrl );
-
+  svgVisual->Load();
+  svgVisual->Initialize();
   return svgVisual;
 }
 
-SvgVisual::SvgVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl )
-: Visual::Base( factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::SVG ),
-  mImageVisualShaderFactory( shaderFactory ),
-  mAtlasRect( FULL_TEXTURE_RECT ),
-  mImageUrl( imageUrl ),
-  mParsedImage( NULL ),
+SvgVisual::SvgVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl)
+: Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::SVG),
+  mImageVisualShaderFactory(shaderFactory),
+  mAtlasRect(FULL_TEXTURE_RECT),
+  mImageUrl(imageUrl),
+  mVectorRenderer(VectorImageRenderer::New()),
+  mDefaultWidth(0),
+  mDefaultHeight(0),
   mPlacementActor(),
   mVisualSize(Vector2::ZERO),
-  mAttemptAtlasing( false )
+  mLoadFailed(false),
+  mAttemptAtlasing(false)
 {
   // the rasterized image is with pre-multiplied alpha format
   mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
@@ -83,10 +83,26 @@ SvgVisual::SvgVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory
 
 SvgVisual::~SvgVisual()
 {
-  if( mParsedImage )
+}
+
+void SvgVisual::OnInitialize()
+{
+  Shader shader;
+  if(!mImpl->mCustomShader)
+  {
+    shader = mImageVisualShaderFactory.GetShader(mFactoryCache, mAttemptAtlasing, true, IsRoundedCornerRequired());
+  }
+  else
   {
-    nsvgDelete( mParsedImage );
+    shader = Shader::New(mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource().data() : mImpl->mCustomShader->mVertexShader,
+                         mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource().data() : mImpl->mCustomShader->mFragmentShader,
+                         mImpl->mCustomShader->mHints);
+
+    shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
   }
+
+  Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
+  mImpl->mRenderer  = Renderer::New(geometry, shader);
 }
 
 void SvgVisual::DoSetProperties( const Property::Map& propertyMap )
@@ -142,25 +158,9 @@ void SvgVisual::DoSetProperty( Property::Index index, const Property::Value& val
   }
 }
 
-void SvgVisual::DoSetOnStage( Actor& actor )
+void SvgVisual::DoSetOnScene( Actor& actor )
 {
-  Shader shader;
-  if( !mImpl->mCustomShader )
-  {
-    shader = mImageVisualShaderFactory.GetShader( mFactoryCache, mAttemptAtlasing, true, false );
-  }
-  else
-  {
-    shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? mImageVisualShaderFactory.GetVertexShaderSource() : mImpl->mCustomShader->mVertexShader,
-                          mImpl->mCustomShader->mFragmentShader.empty() ? mImageVisualShaderFactory.GetFragmentShaderSource() : mImpl->mCustomShader->mFragmentShader,
-                          mImpl->mCustomShader->mHints );
-
-    shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
-  }
-
-  Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
   TextureSet textureSet = TextureSet::New();
-  mImpl->mRenderer = Renderer::New( geometry, shader );
   mImpl->mRenderer.SetTextures( textureSet );
 
   // Register transform properties
@@ -171,16 +171,27 @@ void SvgVisual::DoSetOnStage( Actor& actor )
   // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
   mPlacementActor = actor;
 
-  // SVG visual needs it's size set before it can be rasterized hence set ResourceReady once on stage
-  ResourceReady( Toolkit::Visual::ResourceStatus::READY );
+  if(mLoadFailed)
+  {
+    Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
+    textureSet.SetTexture(0u, brokenImage);
+
+    actor.AddRenderer(mImpl->mRenderer);
+
+    ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
+  }
+  else
+  {
+    // SVG visual needs it's size set before it can be rasterized hence set ResourceReady once on stage
+    ResourceReady(Toolkit::Visual::ResourceStatus::READY);
+  }
 }
 
-void SvgVisual::DoSetOffStage( Actor& actor )
+void SvgVisual::DoSetOffScene( Actor& actor )
 {
   mFactoryCache.GetSVGRasterizationThread()->RemoveTask( this );
 
   actor.RemoveRenderer( mImpl->mRenderer );
-  mImpl->mRenderer.Reset();
   mPlacementActor.Reset();
 
   // Reset the visual size to zero so that when adding the actor back to stage the SVG rasterization is forced
@@ -189,15 +200,8 @@ void SvgVisual::DoSetOffStage( Actor& actor )
 
 void SvgVisual::GetNaturalSize( Vector2& naturalSize )
 {
-  if( mParsedImage )
-  {
-    naturalSize.x = mParsedImage->width;
-    naturalSize.y = mParsedImage->height;
-  }
-  else
-  {
-    naturalSize = Vector2::ZERO;
-  }
+  naturalSize.x = mDefaultWidth;
+  naturalSize.y = mDefaultHeight;
 }
 
 void SvgVisual::DoCreatePropertyMap( Property::Map& map ) const
@@ -209,6 +213,7 @@ void SvgVisual::DoCreatePropertyMap( Property::Map& map ) const
     map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
     map.Insert( Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing );
   }
+  map.Insert( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, IsSynchronousLoadingRequired() );
 }
 
 void SvgVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
@@ -216,18 +221,30 @@ void SvgVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
   // Do nothing
 }
 
-void SvgVisual::ParseFromUrl( const VisualUrl& imageUrl )
+void SvgVisual::Load()
 {
-  mImageUrl = imageUrl;
-  if( mImageUrl.IsLocalResource() )
+  // load remote resource on svg rasterize thread.
+  if(mImageUrl.IsLocalResource())
   {
-    Vector2 dpi = Stage::GetCurrent().GetDpi();
-    float meanDpi = ( dpi.height + dpi.width ) * 0.5f;
-    Dali::Vector<char> buffer;
-    if ( Dali::FileLoader::ReadFile( mImageUrl.GetUrl(), buffer ) )
+    Dali::Vector<uint8_t> buffer;
+    if(Dali::FileLoader::ReadFile(mImageUrl.GetUrl(), buffer))
     {
-      buffer.PushBack( '\0' );
-      mParsedImage = nsvgParse( buffer.Begin(), UNITS, meanDpi );
+      buffer.PushBack('\0');
+
+      Vector2 dpi = Stage::GetCurrent().GetDpi();
+      float meanDpi = (dpi.height + dpi.width) * 0.5f;
+      if(!mVectorRenderer.Load(buffer, meanDpi))
+      {
+        mLoadFailed = true;
+        DALI_LOG_ERROR("SvgVisual::Load: Failed to load file! [%s]\n", mImageUrl.GetUrl().c_str());
+        return;
+      }
+      mVectorRenderer.GetDefaultSize(mDefaultWidth, mDefaultHeight);
+    }
+    else
+    {
+      mLoadFailed = true;
+      DALI_LOG_ERROR("SvgVisual::Load: Failed to read file! [%s]\n", mImageUrl.GetUrl().c_str());
     }
   }
 }
@@ -242,11 +259,12 @@ void SvgVisual::AddRasterizationTask( const Vector2& size )
     Vector2 dpi = Stage::GetCurrent().GetDpi();
     float meanDpi = ( dpi.height + dpi.width ) * 0.5f;
 
-    RasterizingTaskPtr newTask = new RasterizingTask( this, mParsedImage, mImageUrl, meanDpi, width, height );
-    if ( IsSynchronousLoadingRequired() )
+    RasterizingTaskPtr newTask = new RasterizingTask(this, mVectorRenderer, mImageUrl, meanDpi, width, height);
+    if(IsSynchronousLoadingRequired() && mImageUrl.IsLocalResource())
     {
+      newTask->Load();
       newTask->Rasterize();
-      ApplyRasterizedImage( newTask->GetParsedImage(), newTask->GetPixelData() );
+      ApplyRasterizedImage(newTask->GetVectorRenderer(), newTask->GetPixelData(), newTask->IsLoaded());
     }
     else
     {
@@ -255,14 +273,9 @@ void SvgVisual::AddRasterizationTask( const Vector2& size )
   }
 }
 
-void SvgVisual::ApplyRasterizedImage( NSVGimage* parsedSvg, PixelData rasterizedPixelData )
+void SvgVisual::ApplyRasterizedImage( VectorImageRenderer vectorRenderer, PixelData rasterizedPixelData, bool isLoaded )
 {
-  if( mParsedImage == NULL)
-  {
-    mParsedImage = parsedSvg;
-  }
-
-  if( mParsedImage && IsOnStage() )
+  if(isLoaded && rasterizedPixelData && IsOnScene())
   {
     TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
     if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED )
@@ -323,11 +336,22 @@ void SvgVisual::ApplyRasterizedImage( NSVGimage* parsedSvg, PixelData rasterized
       mPlacementActor.Reset();
     }
 
-   // Svg loaded and ready to display
-   ResourceReady( Toolkit::Visual::ResourceStatus::READY );
+    // Svg loaded and ready to display
+    ResourceReady( Toolkit::Visual::ResourceStatus::READY );
   }
-  else if( !mParsedImage )
+  else if(!isLoaded || !rasterizedPixelData)
   {
+    Actor actor = mPlacementActor.GetHandle();
+    if(actor)
+    {
+      TextureSet textureSet = mImpl->mRenderer.GetTextures();
+
+      Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
+      textureSet.SetTexture(0u, brokenImage);
+
+      actor.AddRenderer(mImpl->mRenderer);
+    }
+
     ResourceReady( Toolkit::Visual::ResourceStatus::FAILED );
   }
 }
@@ -336,7 +360,7 @@ void SvgVisual::OnSetTransform()
 {
   Vector2 visualSize = mImpl->mTransform.GetVisualSize( mImpl->mControlSize );
 
-  if( IsOnStage() )
+  if(IsOnScene() && !mLoadFailed)
   {
     if( visualSize != mVisualSize )
     {