Fix SVG visual not adding rasterization task on on/off stage
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / svg / svg-visual.cpp
1 /*
2  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
3  *
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
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  *
16  */
17
18 // CLASS HEADER
19 #include "svg-visual.h"
20
21 // EXTERNAL INCLUDES
22 #include <dali/public-api/images/buffer-image.h>
23 #include <dali/public-api/common/stage.h>
24 #include <dali/public-api/math/vector4.h>
25 #include <dali/devel-api/images/texture-set-image.h>
26 #include <dali/integration-api/debug.h>
27
28 // INTERNAL INCLUDES
29 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
30 #include <dali-toolkit/public-api/visuals/visual-properties.h>
31 #include <dali-toolkit/third-party/nanosvg/nanosvg.h>
32 #include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h>
33 #include <dali-toolkit/internal/visuals/image/image-visual.h>
34 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
35 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
36 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
37 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
38
39
40 namespace
41 {
42 const char * const UNITS("px");
43
44 // property name
45 const char * const IMAGE_ATLASING( "atlasing" );
46
47 const Dali::Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
48 }
49
50 namespace Dali
51 {
52
53 namespace Toolkit
54 {
55
56 namespace Internal
57 {
58
59 SvgVisualPtr SvgVisual::New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl, const Property::Map& properties )
60 {
61   SvgVisualPtr svgVisual( new SvgVisual( factoryCache ) );
62   svgVisual->ParseFromUrl( imageUrl );
63   svgVisual->SetProperties( properties );
64
65   return svgVisual;
66 }
67
68 SvgVisualPtr SvgVisual::New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl )
69 {
70   SvgVisualPtr svgVisual( new SvgVisual( factoryCache ) );
71   svgVisual->ParseFromUrl( imageUrl );
72
73   return svgVisual;
74 }
75
76 SvgVisual::SvgVisual( VisualFactoryCache& factoryCache )
77 : Visual::Base( factoryCache, Visual::FittingMode::FILL ),
78   mAtlasRect( FULL_TEXTURE_RECT ),
79   mImageUrl( ),
80   mParsedImage( NULL ),
81   mPlacementActor(),
82   mVisualSize(Vector2::ZERO),
83   mAttemptAtlasing( false )
84 {
85   // the rasterized image is with pre-multiplied alpha format
86   mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
87 }
88
89 SvgVisual::~SvgVisual()
90 {
91   if( mParsedImage )
92   {
93     nsvgDelete( mParsedImage );
94   }
95 }
96
97 void SvgVisual::DoSetProperties( const Property::Map& propertyMap )
98 {
99   // url already passed in from constructor
100   for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
101   {
102     KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
103     if( keyValue.first.type == Property::Key::INDEX )
104     {
105       DoSetProperty( keyValue.first.indexKey, keyValue.second );
106     }
107     else if( keyValue.first == IMAGE_ATLASING )
108     {
109       DoSetProperty( Toolkit::ImageVisual::Property::ATLASING, keyValue.second );
110     }
111   }
112 }
113
114 void SvgVisual::DoSetProperty( Property::Index index, const Property::Value& value )
115 {
116   switch( index )
117   {
118     case Toolkit::ImageVisual::Property::ATLASING:
119     {
120       value.Get( mAttemptAtlasing );
121       break;
122     }
123   }
124 }
125
126 void SvgVisual::DoSetOnStage( Actor& actor )
127 {
128   Shader shader = ImageVisual::GetImageShader( mFactoryCache, mAttemptAtlasing, true );
129   Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
130   TextureSet textureSet = TextureSet::New();
131   mImpl->mRenderer = Renderer::New( geometry, shader );
132   mImpl->mRenderer.SetTextures( textureSet );
133
134   // Register transform properties
135   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
136
137   // Defer the rasterisation task until we get given a size (by Size Negotiation algorithm)
138
139   // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
140   mPlacementActor = actor;
141
142   // SVG visual needs it's size set before it can be rasterized hence set ResourceReady once on stage
143   ResourceReady( Toolkit::Visual::ResourceStatus::READY );
144 }
145
146 void SvgVisual::DoSetOffStage( Actor& actor )
147 {
148   mFactoryCache.GetSVGRasterizationThread()->RemoveTask( this );
149
150   actor.RemoveRenderer( mImpl->mRenderer );
151   mImpl->mRenderer.Reset();
152   mPlacementActor.Reset();
153
154   // Reset the visual size to zero so that when adding the actor back to stage the SVG rasterization is forced
155   mVisualSize = Vector2::ZERO;
156 }
157
158 void SvgVisual::GetNaturalSize( Vector2& naturalSize )
159 {
160   if( mParsedImage )
161   {
162     naturalSize.x = mParsedImage->width;
163     naturalSize.y = mParsedImage->height;
164   }
165   else
166   {
167     naturalSize = Vector2::ZERO;
168   }
169 }
170
171 void SvgVisual::DoCreatePropertyMap( Property::Map& map ) const
172 {
173   map.Clear();
174   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::SVG );
175   if( mImageUrl.IsValid() )
176   {
177     map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
178     map.Insert( Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing );
179   }
180 }
181
182 void SvgVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
183 {
184   // Do nothing
185 }
186
187 void SvgVisual::ParseFromUrl( const VisualUrl& imageUrl )
188 {
189   mImageUrl = imageUrl;
190   if( mImageUrl.IsLocalResource() )
191   {
192     Vector2 dpi = Stage::GetCurrent().GetDpi();
193     float meanDpi = (dpi.height + dpi.width) * 0.5f;
194     mParsedImage = nsvgParseFromFile( mImageUrl.GetUrl().c_str(), UNITS, meanDpi );
195   }
196 }
197
198 void SvgVisual::AddRasterizationTask( const Vector2& size )
199 {
200   if( mImpl->mRenderer && mParsedImage )
201   {
202     unsigned int width = static_cast<unsigned int>(size.width);
203     unsigned int height = static_cast<unsigned int>( size.height );
204
205     RasterizingTaskPtr newTask = new RasterizingTask( this, mParsedImage, width, height );
206     mFactoryCache.GetSVGRasterizationThread()->AddTask( newTask );
207   }
208 }
209
210 void SvgVisual::ApplyRasterizedImage( PixelData rasterizedPixelData )
211 {
212   if( IsOnStage()  )
213   {
214     TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
215     if( mImpl->mFlags |= Impl::IS_ATLASING_APPLIED )
216     {
217       mFactoryCache.GetAtlasManager()->Remove( currentTextureSet, mAtlasRect );
218     }
219
220     TextureSet textureSet;
221
222     if( mAttemptAtlasing )
223     {
224       Vector4 atlasRect;
225       textureSet = mFactoryCache.GetAtlasManager()->Add(atlasRect, rasterizedPixelData );
226       if( textureSet ) // atlasing
227       {
228         if( textureSet != currentTextureSet )
229         {
230           mImpl->mRenderer.SetTextures( textureSet );
231         }
232         mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
233         mAtlasRect = atlasRect;
234         mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
235       }
236     }
237
238     if( !textureSet ) // no atlasing - mAttemptAtlasing is false or adding to atlas is failed
239     {
240       Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, Pixel::RGBA8888,
241                                       rasterizedPixelData.GetWidth(), rasterizedPixelData.GetHeight() );
242       texture.Upload( rasterizedPixelData );
243       mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
244
245       if( mAtlasRect == FULL_TEXTURE_RECT )
246       {
247         textureSet = currentTextureSet;
248       }
249       else
250       {
251         textureSet = TextureSet::New();
252         mImpl->mRenderer.SetTextures( textureSet );
253
254         mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
255         mAtlasRect = FULL_TEXTURE_RECT;
256       }
257
258       if( textureSet )
259       {
260         textureSet.SetTexture( 0, texture );
261       }
262     }
263
264     // Rasterized pixels are uploaded to texture. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
265     Actor actor = mPlacementActor.GetHandle();
266     if( actor )
267     {
268       actor.AddRenderer( mImpl->mRenderer );
269       // reset the weak handle so that the renderer only get added to actor once
270       mPlacementActor.Reset();
271     }
272
273    // Svg loaded and ready to display
274    ResourceReady( Toolkit::Visual::ResourceStatus::READY );
275   }
276 }
277
278 void SvgVisual::OnSetTransform()
279 {
280   Vector2 visualSize = mImpl->mTransform.GetVisualSize( mImpl->mControlSize );
281
282   if( mParsedImage && IsOnStage() )
283   {
284     if( visualSize != mVisualSize )
285     {
286       AddRasterizationTask( visualSize );
287       mVisualSize = visualSize;
288     }
289   }
290 }
291
292 } // namespace Internal
293
294 } // namespace Toolkit
295
296 } // namespace Dali