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