Automatically dis/connect registered visuals to stage
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / svg / svg-visual.cpp
1 /*
2  * Copyright (c) 2016 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/atlas.h>
26 #include <dali/devel-api/images/texture-set-image.h>
27 #include <dali/integration-api/debug.h>
28
29 // INTERNAL INCLUDES
30 #include <dali-toolkit/public-api/visuals/image-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 const Dali::Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
45 }
46
47 namespace Dali
48 {
49
50 namespace Toolkit
51 {
52
53 namespace Internal
54 {
55
56 SvgVisual::SvgVisual( VisualFactoryCache& factoryCache )
57 : Visual::Base( factoryCache ),
58   mAtlasRect( FULL_TEXTURE_RECT ),
59   mParsedImage( NULL )
60 {
61   // the rasterized image is with pre-multiplied alpha format
62   mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
63 }
64
65 SvgVisual::~SvgVisual()
66 {
67   if( mParsedImage )
68   {
69     nsvgDelete( mParsedImage );
70   }
71 }
72
73 void SvgVisual::DoInitialize( Actor& actor, const Property::Map& propertyMap )
74 {
75   Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
76   if( imageURLValue )
77   {
78     std::string imageUrl;
79     if( imageURLValue->Get( imageUrl ) )
80     {
81       SetImage( imageUrl );
82     }
83     else
84     {
85       DALI_LOG_ERROR( "The property '%s' is not a string\n", IMAGE_URL_NAME );
86     }
87   }
88 }
89
90 void SvgVisual::DoSetOnStage( Actor& actor )
91 {
92   Shader shader = ImageVisual::GetImageShader( mFactoryCache, true, true );
93   Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
94   if( !geometry )
95   {
96     geometry =  mFactoryCache.CreateQuadGeometry();
97     mFactoryCache.SaveGeometry( VisualFactoryCache::QUAD_GEOMETRY, geometry );
98   }
99   TextureSet textureSet = TextureSet::New();
100   mImpl->mRenderer = Renderer::New( geometry, shader );
101   mImpl->mRenderer.SetTextures( textureSet );
102
103   if( mImpl->mSize != Vector2::ZERO && mParsedImage )
104   {
105     AddRasterizationTask( mImpl->mSize );
106   }
107
108   // Hold the weak handle of the placement actor and delay the adding of renderer until the svg rasterization is finished.
109   mPlacementActor = actor;
110 }
111
112 void SvgVisual::DoSetOffStage( Actor& actor )
113 {
114   mFactoryCache.GetSVGRasterizationThread()->RemoveTask( this );
115
116   actor.RemoveRenderer( mImpl->mRenderer );
117   mImpl->mRenderer.Reset();
118   mPlacementActor.Reset();
119 }
120
121 void SvgVisual::GetNaturalSize( Vector2& naturalSize ) const
122 {
123   if( mParsedImage )
124   {
125     naturalSize.x = mParsedImage->width;
126     naturalSize.y = mParsedImage->height;
127   }
128   else
129   {
130     naturalSize = Vector2::ZERO;
131   }
132 }
133
134 void SvgVisual::SetSize( const Vector2& size )
135 {
136   if(mImpl->mSize != size && mParsedImage && GetIsOnStage() )
137   {
138     AddRasterizationTask( size );
139   }
140   mImpl->mSize = size;
141 }
142
143 void SvgVisual::DoCreatePropertyMap( Property::Map& map ) const
144 {
145   map.Clear();
146   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
147   if( !mImageUrl.empty() )
148   {
149     map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl );
150   }
151 }
152
153 void SvgVisual::SetImage( const std::string& imageUrl, ImageDimensions size )
154 {
155   if( mImageUrl != imageUrl )
156   {
157     mImageUrl = imageUrl;
158
159     NSVGimage* parsedImageOld = mParsedImage;
160
161     Vector2 dpi = Stage::GetCurrent().GetDpi();
162     float meanDpi = (dpi.height + dpi.width) * 0.5f;
163     mParsedImage = nsvgParseFromFile(mImageUrl.c_str(), UNITS, meanDpi);
164
165     if( size.GetWidth() != 0u && size.GetHeight() != 0u)
166     {
167       mImpl->mSize.x = size.GetWidth();
168       mImpl->mSize.y = size.GetHeight();
169     }
170
171     if( mImpl->mSize != Vector2::ZERO && GetIsOnStage() )
172     {
173       AddRasterizationTask( mImpl->mSize );
174     }
175
176     mFactoryCache.GetSVGRasterizationThread()->DeleteImage( parsedImageOld );
177   }
178 }
179
180 void SvgVisual::AddRasterizationTask( const Vector2& size )
181 {
182   if( mImpl->mRenderer && mParsedImage )
183   {
184     unsigned int width = static_cast<unsigned int>(size.width);
185     unsigned int height = static_cast<unsigned int>( size.height );
186     BufferImage image = BufferImage::New( width, height, Pixel::RGBA8888);
187
188     RasterizingTaskPtr newTask = new RasterizingTask( this, mParsedImage, width, height );
189     mFactoryCache.GetSVGRasterizationThread()->AddTask( newTask );
190   }
191 }
192
193 void SvgVisual::ApplyRasterizedImage( PixelData rasterizedPixelData )
194 {
195   if( GetIsOnStage()  )
196   {
197     TextureSet currentTextureSet = mImpl->mRenderer.GetTextures();
198     if( mAtlasRect != FULL_TEXTURE_RECT )
199     {
200       mFactoryCache.GetAtlasManager()->Remove( currentTextureSet, mAtlasRect );
201     }
202
203     Vector4 atlasRect;
204     TextureSet textureSet = mFactoryCache.GetAtlasManager()->Add(atlasRect, rasterizedPixelData );
205     if( textureSet ) // atlasing
206     {
207       if( textureSet != currentTextureSet )
208       {
209         mImpl->mRenderer.SetTextures( textureSet );
210       }
211       mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
212       mAtlasRect = atlasRect;
213       mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
214     }
215     else // no atlasing
216     {
217       Atlas texture = Atlas::New( rasterizedPixelData.GetWidth(), rasterizedPixelData.GetHeight() );
218       texture.Upload( rasterizedPixelData, 0, 0 );
219       mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
220
221       if( mAtlasRect == FULL_TEXTURE_RECT )
222       {
223         textureSet = currentTextureSet;
224       }
225       else
226       {
227         textureSet = TextureSet::New();
228         mImpl->mRenderer.SetTextures( textureSet );
229
230         mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
231         mAtlasRect = FULL_TEXTURE_RECT;
232       }
233
234       if( textureSet )
235       {
236         TextureSetImage( textureSet, 0u, texture );
237       }
238     }
239
240     // Rasterized pixels are uploaded to texture. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
241     Actor actor = mPlacementActor.GetHandle();
242     if( actor )
243     {
244       actor.AddRenderer( mImpl->mRenderer );
245       // reset the weak handle so that the renderer only get added to actor once
246       mPlacementActor.Reset();
247     }
248   }
249 }
250
251
252 } // namespace Internal
253
254 } // namespace Toolkit
255
256 } // namespace Dali