Merge "Fix a crash in ImageVisual in case of an invalid image and changed to render...
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / image / image-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 <dali-toolkit/internal/visuals/image/image-visual.h>
20
21 // EXTERNAL HEADERS
22 #include <cstring> // for strlen()
23 #include <dali/public-api/actors/layer.h>
24 #include <dali/public-api/images/resource-image.h>
25 #include <dali/public-api/images/native-image.h>
26 #include <dali/devel-api/images/texture-set-image.h>
27 #include <dali/devel-api/adaptor-framework/bitmap-loader.h>
28 #include <dali/devel-api/adaptor-framework/image-loading.h>
29 #include <dali/devel-api/scripting/enum-helper.h>
30 #include <dali/devel-api/scripting/scripting.h>
31 #include <dali/integration-api/debug.h>
32
33 // INTERNAL HEADERS
34 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
35 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
36 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
37 #include <dali-toolkit/internal/visuals/texture-manager.h>
38 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
39 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
40 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
41 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
42 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
43 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
44 #include <dali-toolkit/internal/visuals/visual-url.h>
45
46 namespace Dali
47 {
48
49 namespace Toolkit
50 {
51
52 namespace Internal
53 {
54
55 namespace
56 {
57
58 // property names
59 const char * const IMAGE_FITTING_MODE( "fittingMode" );
60 const char * const IMAGE_SAMPLING_MODE( "samplingMode" );
61 const char * const IMAGE_DESIRED_WIDTH( "desiredWidth" );
62 const char * const IMAGE_DESIRED_HEIGHT( "desiredHeight" );
63 const char * const SYNCHRONOUS_LOADING( "synchronousLoading" );
64 const char * const IMAGE_ATLASING("atlasing");
65
66 // fitting modes
67 DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE )
68 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SHRINK_TO_FIT )
69 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SCALE_TO_FILL )
70 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_WIDTH )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_HEIGHT )
72 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, DEFAULT )
73 DALI_ENUM_TO_STRING_TABLE_END( FITTING_MODE )
74
75 // sampling modes
76 DALI_ENUM_TO_STRING_TABLE_BEGIN( SAMPLING_MODE )
77 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX )
78 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NEAREST )
79 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, LINEAR )
80 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_NEAREST )
81 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_LINEAR )
82 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NO_FILTER )
83 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, DONT_CARE )
84 DALI_ENUM_TO_STRING_TABLE_END( SAMPLING_MODE )
85
86 // wrap modes
87 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
88 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
89 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
90 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
91 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
92 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
93
94 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
95
96 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
97
98 const float PIXEL_ALIGN_ON = 1.0f;
99 const float PIXEL_ALIGN_OFF = 0.0f;
100
101 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
102   attribute mediump vec2 aPosition;\n
103   uniform mediump mat4 uModelMatrix;\n
104   uniform mediump mat4 uViewMatrix;\n
105   uniform mediump mat4 uProjection;\n
106   uniform mediump vec3 uSize;\n
107   uniform mediump vec4 pixelArea;
108   varying mediump vec2 vTexCoord;\n
109   uniform lowp float uPixelAligned;\n
110   \n
111   //Visual size and offset
112   uniform mediump vec2 offset;\n
113   uniform mediump vec2 size;\n
114   uniform mediump vec4 offsetSizeMode;\n
115   uniform mediump vec2 origin;\n
116   uniform mediump vec2 anchorPoint;\n
117 \n
118   vec4 ComputeVertexPosition()\n
119   {\n
120     vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
121     vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
122     return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
123   }\n
124 \n
125   void main()\n
126   {\n
127     mediump vec4 vertexPosition = uViewMatrix * uModelMatrix * ComputeVertexPosition();\n
128     vec4 alignedVertexPosition = vertexPosition;\n
129     alignedVertexPosition.xy = floor ( vertexPosition.xy );\n // Pixel alignment
130     vertexPosition = uProjection * mix( vertexPosition, alignedVertexPosition, uPixelAligned );\n
131     vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
132     gl_Position = vertexPosition;\n
133   }\n
134 );
135
136 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
137   varying mediump vec2 vTexCoord;\n
138   uniform sampler2D sTexture;\n
139   uniform lowp vec4 uColor;\n
140   uniform lowp vec3 mixColor;\n
141   uniform lowp float opacity;\n
142   uniform lowp float preMultipliedAlpha;\n
143   \n
144   lowp vec4 visualMixColor()\n
145   {\n
146     return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
147   }\n
148   void main()\n
149   {\n
150       gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * visualMixColor();\n
151   }\n
152 );
153
154 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
155     varying mediump vec2 vTexCoord;\n
156     uniform sampler2D sTexture;\n
157     uniform mediump vec4 uAtlasRect;\n
158     uniform lowp vec4 uColor;\n
159     uniform lowp vec3 mixColor;\n
160     uniform lowp float opacity;\n
161     uniform lowp float preMultipliedAlpha;\n
162     \n
163     lowp vec4 visualMixColor()\n
164     {\n
165         return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
166     }\n
167     \n
168     void main()\n
169     {\n
170         mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
171         gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
172      }\n
173 );
174
175 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
176     varying mediump vec2 vTexCoord;\n
177     uniform sampler2D sTexture;\n
178     uniform mediump vec4 uAtlasRect;\n
179     // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
180     uniform lowp vec2 wrapMode;\n
181     uniform lowp vec4 uColor;\n
182     uniform lowp vec3 mixColor;\n
183     uniform lowp float opacity;\n
184     uniform lowp float preMultipliedAlpha;\n
185     \n
186     mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
187     {\n
188       mediump float coord;\n
189       if( wrap > 1.5 )\n // REFLECT
190         coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
191       else \n// warp == 0 or 1
192         coord = mix(coordinate, fract( coordinate ), wrap);\n
193       return clamp( mix(range.x, range.y, coord), range.x, range.y );
194     }\n
195     \n
196     lowp vec4 visualMixColor()\n
197     {\n
198       return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
199     }\n
200     \n
201     void main()\n
202     {\n
203         mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
204                                       wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
205         gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
206     }\n
207 );
208
209 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
210 {
211   Geometry geometry;
212
213   if( gridSize == ImageDimensions( 1, 1 ) )
214   {
215     geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
216   }
217   else
218   {
219     geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
220   }
221
222   return geometry;
223 }
224
225 } // unnamed namespace
226
227 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
228                                  const VisualUrl& imageUrl,
229                                  const Property::Map& properties,
230                                  ImageDimensions size,
231                                  FittingMode::Type fittingMode,
232                                  Dali::SamplingMode::Type samplingMode )
233 {
234   ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
235   imageVisualPtr->SetProperties( properties );
236   return imageVisualPtr;
237 }
238
239 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
240                                  const VisualUrl& imageUrl,
241                                  ImageDimensions size,
242                                  FittingMode::Type fittingMode,
243                                  Dali::SamplingMode::Type samplingMode )
244 {
245   return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
246 }
247
248 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
249 {
250   return new ImageVisual( factoryCache, image );
251 }
252
253 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
254                           const VisualUrl& imageUrl,
255                           ImageDimensions size,
256                           FittingMode::Type fittingMode,
257                           Dali::SamplingMode::Type samplingMode )
258 : Visual::Base( factoryCache ),
259   mImage(),
260   mPixels(),
261   mPixelArea( FULL_TEXTURE_RECT ),
262   mPlacementActor(),
263   mImageUrl( imageUrl ),
264   mDesiredSize( size ),
265   mTextureId( TextureManager::INVALID_TEXTURE_ID ),
266   mFittingMode( fittingMode ),
267   mSamplingMode( samplingMode ),
268   mWrapModeU( WrapMode::DEFAULT ),
269   mWrapModeV( WrapMode::DEFAULT ),
270   mAttemptAtlasing( false ),
271   mTextureLoading( false )
272 {
273 }
274
275 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
276 : Visual::Base( factoryCache ),
277   mImage( image ),
278   mPixels(),
279   mPixelArea( FULL_TEXTURE_RECT ),
280   mPlacementActor(),
281   mImageUrl(),
282   mDesiredSize(),
283   mTextureId( TextureManager::INVALID_TEXTURE_ID ),
284   mFittingMode( FittingMode::DEFAULT ),
285   mSamplingMode( SamplingMode::DEFAULT ),
286   mWrapModeU( WrapMode::DEFAULT ),
287   mWrapModeV( WrapMode::DEFAULT ),
288   mAttemptAtlasing( false ),
289   mTextureLoading( false )
290 {
291 }
292
293 ImageVisual::~ImageVisual()
294 {
295 }
296
297 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
298 {
299   // Url is already received in constructor
300   for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
301   {
302     KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
303     if( keyValue.first.type == Property::Key::INDEX )
304     {
305       DoSetProperty( keyValue.first.indexKey, keyValue.second );
306     }
307     else
308     {
309       if( keyValue.first == IMAGE_FITTING_MODE )
310       {
311         DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
312       }
313       else if( keyValue.first == IMAGE_SAMPLING_MODE )
314       {
315         DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
316       }
317       else if( keyValue.first == IMAGE_DESIRED_WIDTH )
318       {
319         DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
320       }
321       else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
322       {
323         DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
324       }
325       else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
326       {
327         DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
328       }
329       else if( keyValue.first == IMAGE_WRAP_MODE_U )
330       {
331         DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
332       }
333       else if( keyValue.first == IMAGE_WRAP_MODE_V )
334       {
335         DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
336       }
337       else if( keyValue.first == SYNCHRONOUS_LOADING )
338       {
339         DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
340       }
341       else if ( keyValue.first == IMAGE_ATLASING )
342       {
343         DoSetProperty( Toolkit::DevelImageVisual::Property::ATLASING, keyValue.second );
344       }
345     }
346   }
347
348   if( ( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING ) && mImageUrl.IsValid() )
349   {
350     // if sync loading is required, the loading should start
351     // immediately when new image url is set or the actor is off stage
352     // ( for on-stage actor with image url unchanged, resource loading
353     // is already finished )
354     LoadResourceSynchronously();
355   }
356 }
357
358 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
359 {
360   switch( index )
361   {
362     case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
363     {
364       bool sync;
365       if( value.Get( sync ) )
366       {
367         if( sync )
368         {
369           mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
370         }
371         else
372         {
373           mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
374         }
375       }
376       else
377       {
378         DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
379       }
380       break;
381     }
382
383     case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
384     {
385       float desiredWidth;
386       if( value.Get( desiredWidth ) )
387       {
388         mDesiredSize.SetWidth( desiredWidth );
389       }
390       else
391       {
392         DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
393       }
394       break;
395     }
396
397     case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
398     {
399       float desiredHeight;
400       if( value.Get( desiredHeight ) )
401       {
402         mDesiredSize.SetHeight( desiredHeight );
403       }
404       else
405       {
406         DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
407       }
408       break;
409     }
410
411     case Toolkit::ImageVisual::Property::FITTING_MODE:
412     {
413       int fittingMode;
414       Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
415       mFittingMode = Dali::FittingMode::Type( fittingMode );
416       break;
417     }
418
419     case Toolkit::ImageVisual::Property::SAMPLING_MODE:
420     {
421       int samplingMode;
422       Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
423       mSamplingMode = Dali::SamplingMode::Type( samplingMode );
424       break;
425     }
426
427     case Toolkit::ImageVisual::Property::PIXEL_AREA:
428     {
429       value.Get( mPixelArea );
430       break;
431     }
432
433     case Toolkit::ImageVisual::Property::WRAP_MODE_U:
434     {
435       int wrapMode;
436       Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
437       mWrapModeU = Dali::WrapMode::Type( wrapMode );
438       break;
439     }
440
441     case Toolkit::ImageVisual::Property::WRAP_MODE_V:
442     {
443       int wrapMode;
444       Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
445       mWrapModeV = Dali::WrapMode::Type( wrapMode );
446       break;
447     }
448
449     case Toolkit::DevelImageVisual::Property::ATLASING:
450     {
451       bool atlasing = false;
452       mAttemptAtlasing = value.Get( atlasing );
453     }
454   }
455 }
456
457 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
458 {
459   if(mImage)
460   {
461     naturalSize.x = mImage.GetWidth();
462     naturalSize.y = mImage.GetHeight();
463     return;
464   }
465   else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
466   {
467     naturalSize.x = mDesiredSize.GetWidth();
468     naturalSize.y = mDesiredSize.GetHeight();
469     return;
470   }
471   else if( mImageUrl.IsValid() && mImageUrl.GetLocation() == VisualUrl::LOCAL )
472   {
473     ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
474
475     if( dimensions != ImageDimensions( 0, 0 ) )
476     {
477       naturalSize.x = dimensions.GetWidth();
478       naturalSize.y = dimensions.GetHeight();
479     }
480     else
481     {
482       Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
483
484       naturalSize.x = brokenImage.GetWidth();
485       naturalSize.y = brokenImage.GetWidth();
486     }
487     return;
488   }
489
490   naturalSize = Vector2::ZERO;
491 }
492
493 void ImageVisual::CreateRenderer( TextureSet& textureSet )
494 {
495   Geometry geometry;
496   Shader shader;
497
498   if( !mImpl->mCustomShader )
499   {
500     geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
501
502     shader = GetImageShader( mFactoryCache,
503                              mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
504                              mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
505   }
506   else
507   {
508     geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
509     if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
510     {
511       shader = GetImageShader( mFactoryCache, false, true );
512     }
513     else
514     {
515       shader  = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
516                              mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
517                              mImpl->mCustomShader->mHints );
518       if( mImpl->mCustomShader->mVertexShader.empty() )
519       {
520         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
521       }
522     }
523   }
524
525   shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_ON ); // Set default to align
526
527   mImpl->mRenderer = Renderer::New( geometry, shader );
528   if( textureSet )
529   {
530     mImpl->mRenderer.SetTextures( textureSet );
531   }
532   // else still waiting for texture load to finish.
533
534   //Register transform properties
535   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
536 }
537
538 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
539 {
540   Geometry geometry;
541   Shader shader;
542
543   std::string fragmentShader;
544   const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
545   const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
546
547   if( fragmentPreFix )
548   {
549     fragmentShader = fragmentPreFix;
550     fragmentShader += "\n";
551   }
552
553   if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
554   {
555     fragmentShader += mImpl->mCustomShader->mFragmentShader;
556   }
557   else
558   {
559     fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
560   }
561
562   if( customSamplerTypename )
563   {
564     fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
565   }
566
567   if( !mImpl->mCustomShader )
568   {
569     geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
570
571     shader  = Shader::New( VERTEX_SHADER, fragmentShader );
572     shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
573   }
574   else
575   {
576     geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
577     shader  = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
578                            fragmentShader,
579                            mImpl->mCustomShader->mHints );
580     if( mImpl->mCustomShader->mVertexShader.empty() )
581     {
582       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
583     }
584   }
585
586   mImpl->mRenderer = Renderer::New( geometry, shader );
587
588   //Register transform properties
589   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
590 }
591
592
593 bool ImageVisual::IsSynchronousResourceLoading() const
594 {
595   return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
596 }
597
598 void ImageVisual::LoadResourceSynchronously()
599 {
600   if( mImageUrl.IsValid() )
601   {
602     BitmapLoader loader = BitmapLoader::New( mImageUrl.GetUrl(), mDesiredSize, mFittingMode, mSamplingMode );
603     loader.Load();
604     mPixels = loader.GetPixelData();
605     mTextureLoading = false;
606   }
607 }
608
609 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing )
610 {
611   TextureSet textureSet;
612
613   mTextureLoading = false;
614
615   textureRect = FULL_TEXTURE_RECT;
616   if( synchronousLoading )
617   {
618     if( !mPixels )
619     {
620       // use broken image
621       textureSet = TextureSet::New();
622       TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
623     }
624     else
625     {
626       if( attemptAtlasing )
627       {
628         textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
629         mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
630       }
631       if( !textureSet ) // big image, no atlasing or atlasing failed
632       {
633         mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
634         Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
635                                         mPixels.GetWidth(), mPixels.GetHeight() );
636         texture.Upload( mPixels );
637         textureSet = TextureSet::New();
638         textureSet.SetTexture( 0u, texture );
639       }
640     }
641   }
642   else
643   {
644     if( attemptAtlasing )
645     {
646       textureSet = mFactoryCache.GetAtlasManager()->Add( textureRect, mImageUrl.GetUrl(), mDesiredSize, mFittingMode, true, this );
647       mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
648       mTextureLoading = true;
649     }
650     if( !textureSet ) // big image, no atlasing or atlasing failed
651     {
652       mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
653       TextureManager& textureManager = mFactoryCache.GetTextureManager();
654       mTextureId = textureManager.RequestLoad( mImageUrl, mDesiredSize, mFittingMode,
655                                                mSamplingMode, TextureManager::NO_ATLAS, this );
656
657       TextureManager::LoadState loadState = textureManager.GetTextureState( mTextureId );
658
659       mTextureLoading = ( loadState == TextureManager::LOADING );
660
661       if( loadState == TextureManager::UPLOADED )
662       {
663         // UploadComplete has already been called - keep the same texture set
664         textureSet = textureManager.GetTextureSet(mTextureId);
665       }
666     }
667   }
668
669   if( ! (mImpl->mFlags & Impl::IS_ATLASING_APPLIED) && textureSet )
670   {
671     Sampler sampler = Sampler::New();
672     sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
673     textureSet.SetSampler( 0u, sampler );
674   }
675
676   return textureSet;
677 }
678
679 void ImageVisual::InitializeRenderer()
680 {
681   mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
682
683   if( ! mImpl->mCustomShader && mImageUrl.GetLocation() == VisualUrl::LOCAL )
684   {
685     bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
686
687     Vector4 atlasRect;
688     // texture set has to be created first as we need to know if atlasing succeeded or not
689     // when selecting the shader
690     TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), mAttemptAtlasing );
691     CreateRenderer( textures );
692
693     if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
694     {
695       mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
696       if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
697       {
698         Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
699         wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
700         mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
701       }
702     }
703   }
704   else
705   {
706     // for custom shader or remote image, atlas is not applied
707     Vector4 atlasRect; // ignored in this case
708     TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), false );
709     CreateRenderer( textures );
710   }
711 }
712
713 void ImageVisual::InitializeRenderer( const Image& image )
714 {
715   // don't reuse CreateTextureSet
716   TextureSet textures = TextureSet::New();
717
718   NativeImage nativeImage = NativeImage::DownCast( image );
719   if( nativeImage )
720   {
721     CreateNativeImageRenderer( nativeImage );
722     DALI_ASSERT_DEBUG( textures );
723     mImpl->mRenderer.SetTextures( textures );
724   }
725   else
726   {
727     // reuse existing code for regular images
728     CreateRenderer( textures );
729   }
730   ApplyImageToSampler( image );
731 }
732
733 void ImageVisual::DoSetOnStage( Actor& actor )
734 {
735   if( mImageUrl.IsValid() )
736   {
737     InitializeRenderer();
738   }
739   else if ( mImage )
740   {
741     InitializeRenderer( mImage );
742   }
743
744   if ( !mImpl->mRenderer )
745   {
746     return;
747   }
748
749   mPlacementActor = actor;
750   // Search the Actor tree to find if Layer UI behaviour set.
751   Layer layer = actor.GetLayer();
752   if ( layer && layer.GetBehavior() == Layer::LAYER_3D )
753   {
754      // Layer 3D set, do not align pixels
755      mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
756   }
757
758   if( mPixelArea != FULL_TEXTURE_RECT )
759   {
760     mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
761   }
762
763   if( mTextureLoading == false )
764   {
765     actor.AddRenderer( mImpl->mRenderer );
766     mPlacementActor.Reset();
767
768     // Image loaded and ready to display
769     ResourceReady();
770   }
771 }
772
773 void ImageVisual::DoSetOffStage( Actor& actor )
774 {
775   // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
776
777   //If we own the image then make sure we release it when we go off stage
778   actor.RemoveRenderer( mImpl->mRenderer);
779   if( mImageUrl.IsValid() )
780   {
781     RemoveTexture( mImageUrl.GetUrl() );
782     mImage.Reset();
783   }
784   mTextureLoading = false;
785   mImpl->mRenderer.Reset();
786   mPlacementActor.Reset();
787 }
788
789 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
790 {
791   map.Clear();
792   map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
793
794   bool sync = IsSynchronousResourceLoading();
795   map.Insert( SYNCHRONOUS_LOADING, sync );
796   if( mImageUrl.IsValid() )
797   {
798     map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
799     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
800     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
801   }
802   else if( mImage )
803   {
804     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
805     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
806
807     ResourceImage resourceImage = ResourceImage::DownCast(mImage);
808     if( resourceImage )
809     {
810       map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
811     }
812   }
813
814   map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
815   map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
816
817   map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
818   map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
819   map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
820
821   map.Insert( Toolkit::DevelImageVisual::Property::ATLASING, mAttemptAtlasing );
822 }
823
824 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
825 {
826   map.Clear();
827   map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
828   if( mImageUrl.IsValid() )
829   {
830     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
831     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
832   }
833   else if( mImage )
834   {
835     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
836     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
837   }
838 }
839
840 void ImageVisual::OnSetTransform()
841 {
842   if( mImpl->mRenderer )
843   {
844     mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
845   }
846 }
847
848 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
849 {
850   Shader shader;
851   if( atlasing )
852   {
853     if( defaultTextureWrapping )
854     {
855       shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
856       if( !shader )
857       {
858         shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
859         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
860         factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
861       }
862     }
863     else
864     {
865       shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
866       if( !shader )
867       {
868         shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
869         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
870         factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
871       }
872     }
873   }
874   else
875   {
876     shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
877     if( !shader )
878     {
879       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
880       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
881       factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
882     }
883   }
884
885   return shader;
886 }
887
888 void ImageVisual::ApplyImageToSampler( const Image& image )
889 {
890   if( image )
891   {
892     TextureSet textureSet = mImpl->mRenderer.GetTextures();
893     DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
894
895     TextureSetImage( textureSet, 0u, image );
896     Sampler sampler = Sampler::New();
897     sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
898     textureSet.SetSampler( 0u, sampler );
899   }
900 }
901
902 // From existing atlas manager
903 void ImageVisual::UploadCompleted()
904 {
905   // Texture has been uploaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
906   Actor actor = mPlacementActor.GetHandle();
907   if( actor )
908   {
909     actor.AddRenderer( mImpl->mRenderer );
910
911     // reset the weak handle so that the renderer only get added to actor once
912     mPlacementActor.Reset();
913   }
914   mTextureLoading = false;
915 }
916
917 // From Texture Manager
918 void ImageVisual::UploadComplete( bool loadingSuccess, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle )
919 {
920   Actor actor = mPlacementActor.GetHandle();
921   if( actor )
922   {
923     if( mImpl->mRenderer )
924     {
925       actor.AddRenderer( mImpl->mRenderer );
926       // reset the weak handle so that the renderer only get added to actor once
927       mPlacementActor.Reset();
928
929       if( loadingSuccess )
930       {
931         Sampler sampler = Sampler::New();
932         sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
933         textureSet.SetSampler( 0u, sampler );
934         mImpl->mRenderer.SetTextures(textureSet);
935       }
936       else
937       {
938         Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
939
940         textureSet = TextureSet::New();
941         mImpl->mRenderer.SetTextures( textureSet );
942
943         ApplyImageToSampler( brokenImage );
944       }
945       // Image loaded and ready to display
946       ResourceReady();
947     }
948   }
949   mTextureLoading = false;
950 }
951
952 void ImageVisual::RemoveTexture(const std::string& url)
953 {
954   if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
955   {
956     mFactoryCache.GetTextureManager().Remove( mTextureId );
957     mTextureId = TextureManager::INVALID_TEXTURE_ID;
958   }
959   else
960   {
961     Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
962     Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
963     if( index != Property::INVALID_INDEX )
964     {
965       Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
966       atlasRectValue.Get( atlasRect );
967     }
968
969     TextureSet textureSet = mImpl->mRenderer.GetTextures();
970     mImpl->mRenderer.Reset();
971
972     if( index != Property::INVALID_INDEX )
973     {
974       mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
975     }
976   }
977 }
978
979 } // namespace Internal
980
981 } // namespace Toolkit
982
983 } // namespace Dali