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