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 "image-visual.h"
  20
  21 // EXTERNAL HEADER
  22 #include <cstring> // for strncasecmp
  23 #include <dali/public-api/images/resource-image.h>
  24 #include <dali/public-api/images/native-image.h>
  25 #include <dali/devel-api/images/atlas.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/scripting/enum-helper.h>
  29 #include <dali/devel-api/scripting/scripting.h>
  30 #include <dali/integration-api/debug.h>
  31
  32 // INTERNAL HEADER
  33 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
  34 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  35 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
  36 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  37 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  38 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
  39 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  40
  41 namespace Dali
  42 {
  43
  44 namespace Toolkit
  45 {
  46
  47 namespace Internal
  48 {
  49
  50 namespace
  51 {
  52 const char HTTP_URL[] = "http://";
  53 const char HTTPS_URL[] = "https://";
  54
  55 // property names
  56 const char * const IMAGE_FITTING_MODE( "fittingMode" );
  57 const char * const IMAGE_SAMPLING_MODE( "samplingMode" );
  58 const char * const IMAGE_DESIRED_WIDTH( "desiredWidth" );
  59 const char * const IMAGE_DESIRED_HEIGHT( "desiredHeight" );
  60 const char * const IMAGE_WRAP_MODE_U("wrapModeU");
  61 const char * const IMAGE_WRAP_MODE_V("wrapModeV");
  62 const char * const SYNCHRONOUS_LOADING( "synchronousLoading" );
  63 const char * const BATCHING_ENABLED( "batchingEnabled" );
  64
  65 // fitting modes
  66 DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE )
  67 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SHRINK_TO_FIT )
  68 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SCALE_TO_FILL )
  69 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_WIDTH )
  70 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_HEIGHT )
  71 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, DEFAULT )
  72 DALI_ENUM_TO_STRING_TABLE_END( FITTING_MODE )
  73
  74 // sampling modes
  75 DALI_ENUM_TO_STRING_TABLE_BEGIN( SAMPLING_MODE )
  76 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX )
  77 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NEAREST )
  78 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, LINEAR )
  79 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_NEAREST )
  80 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_LINEAR )
  81 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NO_FILTER )
  82 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, DONT_CARE )
  83 DALI_ENUM_TO_STRING_TABLE_END( SAMPLING_MODE )
  84
  85 // wrap modes
  86 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
  87 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
  88 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
  89 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
  90 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
  91 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
  92
  93 const std::string PIXEL_AREA_UNIFORM_NAME = "pixelArea";
  94 const std::string WRAP_MODE_UNIFORM_NAME = "wrapMode";
  95
  96 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
  97
  98 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
  99
 100 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
 101   attribute mediump vec2 aPosition;\n
 102   uniform mediump mat4 uMvpMatrix;\n
 103   uniform mediump vec3 uSize;\n
 104   uniform mediump vec4 pixelArea;
 105   varying mediump vec2 vTexCoord;\n
 106   \n
 107   void main()\n
 108   {\n
 109     mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
 110     vertexPosition.xyz *= uSize;\n
 111     vertexPosition = uMvpMatrix * vertexPosition;\n
 112     \n
 113     vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
 114     gl_Position = vertexPosition;\n
 115   }\n
 116 );
 117
 118 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
 119   varying mediump vec2 vTexCoord;\n
 120   uniform sampler2D sTexture;\n
 121   uniform lowp vec4 uColor;\n
 122   \n
 123   void main()\n
 124   {\n
 125     gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor;\n
 126   }\n
 127 );
 128
 129 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
 130     varying mediump vec2 vTexCoord;\n
 131     uniform sampler2D sTexture;\n
 132     uniform mediump vec4 uAtlasRect;\n
 133     uniform lowp vec4 uColor;\n
 134     \n
 135     void main()\n
 136     {\n
 137       mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
 138       gl_FragColor = texture2D( sTexture, texCoord ) * uColor;\n
 139     }\n
 140 );
 141
 142 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
 143     varying mediump vec2 vTexCoord;\n
 144     uniform sampler2D sTexture;\n
 145     uniform mediump vec4 uAtlasRect;\n
 146     // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
 147     uniform lowp vec2 wrapMode;\n
 148     uniform lowp vec4 uColor;\n
 149     \n
 150     mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
 151     {\n
 152       mediump float coord;\n
 153       if( wrap > 1.5 )\n // REFLECT
 154         coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
 155       else \n// warp == 0 or 1
 156         coord = mix(coordinate, fract( coordinate ), wrap);\n
 157       return clamp( mix(range.x, range.y, coord), range.x, range.y );
 158     }\n
 159     \n
 160     void main()\n
 161     {\n
 162       mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
 163                                     wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
 164       gl_FragColor = texture2D( sTexture, texCoord ) * uColor;\n
 165     }\n
 166 );
 167
 168 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
 169 {
 170   Geometry geometry;
 171
 172   if( gridSize == ImageDimensions( 1, 1 ) )
 173   {
 174     geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
 175     if( !geometry )
 176     {
 177       geometry =  VisualFactoryCache::CreateQuadGeometry();
 178       factoryCache.SaveGeometry( VisualFactoryCache::QUAD_GEOMETRY, geometry );
 179     }
 180   }
 181   else
 182   {
 183     geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
 184   }
 185
 186   return geometry;
 187 }
 188
 189 } //unnamed namespace
 190
 191 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache )
 192 : Visual::Base( factoryCache ),
 193   mPixelArea( FULL_TEXTURE_RECT ),
 194   mDesiredSize(),
 195   mFittingMode( FittingMode::DEFAULT ),
 196   mSamplingMode( SamplingMode::DEFAULT ),
 197   mWrapModeU( WrapMode::DEFAULT ),
 198   mWrapModeV( WrapMode::DEFAULT ),
 199   mNativeFragmentShaderCode( ),
 200   mNativeImageFlag( false )
 201 {
 202 }
 203
 204 ImageVisual::~ImageVisual()
 205 {
 206 }
 207
 208 void ImageVisual::DoInitialize( Actor& actor, const Property::Map& propertyMap )
 209 {
 210   std::string oldImageUrl = mImageUrl;
 211
 212   Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
 213   if( imageURLValue )
 214   {
 215     imageURLValue->Get( mImageUrl );
 216     if( !mImageUrl.empty() )
 217     {
 218       mImage.Reset();
 219     }
 220
 221     Property::Value* fittingValue = propertyMap.Find( Toolkit::ImageVisual::Property::FITTING_MODE, IMAGE_FITTING_MODE );
 222     if( fittingValue )
 223     {
 224       Scripting::GetEnumerationProperty( *fittingValue, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, mFittingMode );
 225     }
 226
 227     Property::Value* samplingValue = propertyMap.Find( Toolkit::ImageVisual::Property::SAMPLING_MODE, IMAGE_SAMPLING_MODE );
 228     if( samplingValue )
 229     {
 230       Scripting::GetEnumerationProperty( *samplingValue, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, mSamplingMode );
 231     }
 232
 233     int desiredWidth = 0;
 234     Property::Value* desiredWidthValue = propertyMap.Find( Toolkit::ImageVisual::Property::DESIRED_WIDTH, IMAGE_DESIRED_WIDTH );
 235     if( desiredWidthValue )
 236     {
 237       desiredWidthValue->Get( desiredWidth );
 238     }
 239
 240     int desiredHeight = 0;
 241     Property::Value* desiredHeightValue = propertyMap.Find( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, IMAGE_DESIRED_HEIGHT );
 242     if( desiredHeightValue )
 243     {
 244       desiredHeightValue->Get( desiredHeight );
 245     }
 246
 247     Property::Value* pixelAreaValue = propertyMap.Find( Toolkit::ImageVisual::Property::PIXEL_AREA, PIXEL_AREA_UNIFORM_NAME );
 248     if( pixelAreaValue )
 249     {
 250       pixelAreaValue->Get( mPixelArea );
 251     }
 252
 253     Property::Value* wrapModeValueU = propertyMap.Find( Toolkit::ImageVisual::Property::WRAP_MODE_U, IMAGE_WRAP_MODE_U );
 254     if( wrapModeValueU )
 255     {
 256       Scripting::GetEnumerationProperty( *wrapModeValueU, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, mWrapModeU );
 257     }
 258
 259     Property::Value* wrapModeValueV = propertyMap.Find( Toolkit::ImageVisual::Property::WRAP_MODE_V, IMAGE_WRAP_MODE_V );
 260     if( wrapModeValueV )
 261     {
 262       Scripting::GetEnumerationProperty( *wrapModeValueV, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, mWrapModeV );
 263     }
 264
 265     mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
 266   }
 267
 268   Property::Value* syncLoading = propertyMap.Find( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, SYNCHRONOUS_LOADING );
 269   if( syncLoading )
 270   {
 271     bool sync;
 272     syncLoading->Get( sync );
 273     if( sync )
 274     {
 275       mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 276     }
 277     else
 278     {
 279       mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 280     }
 281   }
 282
 283   // if sync loading is required, the loading should start immediately when new image url is set or the actor is off stage
 284   // ( for on-stage actor with image url unchanged, resource loading is already finished)
 285   if( ( !mImpl->mRenderer || imageURLValue) && IsSynchronousResourceLoading() )
 286   {
 287     DoSynchronousResourceLoading();
 288   }
 289
 290   // remove old renderer if exit
 291   if( mImpl->mRenderer )
 292   {
 293     if( actor ) //remove old renderer from actor
 294     {
 295       actor.RemoveRenderer( mImpl->mRenderer );
 296     }
 297     if( !oldImageUrl.empty() ) //clean old renderer from cache
 298     {
 299       CleanCache( oldImageUrl );
 300     }
 301   }
 302
 303   NativeImage nativeImage = NativeImage::DownCast( mImage );
 304
 305   if( nativeImage )
 306   {
 307     SetNativeFragmentShaderCode( nativeImage );
 308   }
 309
 310   // if actor is on stage, create new renderer and apply to actor
 311   if( actor && actor.OnStage() )
 312   {
 313     SetOnStage( actor );
 314   }
 315 }
 316
 317 void ImageVisual::GetNaturalSize( Vector2& naturalSize ) const
 318 {
 319   if(mImage)
 320   {
 321     naturalSize.x = mImage.GetWidth();
 322     naturalSize.y = mImage.GetHeight();
 323     return;
 324   }
 325   else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
 326   {
 327     naturalSize.x = mDesiredSize.GetWidth();
 328     naturalSize.y = mDesiredSize.GetHeight();
 329     return;
 330   }
 331   else if( !mImageUrl.empty() )
 332   {
 333     ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
 334     naturalSize.x = dimentions.GetWidth();
 335     naturalSize.y = dimentions.GetHeight();
 336     return;
 337   }
 338
 339   naturalSize = Vector2::ZERO;
 340 }
 341
 342 Renderer ImageVisual::CreateRenderer() const
 343 {
 344   Geometry geometry;
 345   Shader shader;
 346
 347   // If mImage is nativeImage with custom sampler or prefix, mNativeFragmentShaderCode will be applied.
 348   // Renderer can't be shared between NativeImage and other image types.
 349   if( !mNativeFragmentShaderCode.empty() )
 350   {
 351     return CreateNativeImageRenderer();
 352   }
 353
 354   if( !mImpl->mCustomShader )
 355   {
 356     geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
 357
 358     shader = GetImageShader( mFactoryCache,
 359                              mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
 360                              mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
 361   }
 362   else
 363   {
 364     geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
 365     if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
 366     {
 367       shader = GetImageShader(mFactoryCache, false, true);
 368     }
 369     else
 370     {
 371       shader  = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
 372                              mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
 373                              mImpl->mCustomShader->mHints );
 374       if( mImpl->mCustomShader->mVertexShader.empty() )
 375       {
 376         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 377       }
 378     }
 379   }
 380
 381   Renderer renderer = Renderer::New( geometry, shader );
 382
 383   return renderer;
 384 }
 385
 386 Renderer ImageVisual::CreateNativeImageRenderer() const
 387 {
 388   Geometry geometry;
 389   Shader shader;
 390
 391   if( !mImpl->mCustomShader )
 392   {
 393     geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
 394
 395     shader  = Shader::New( VERTEX_SHADER, mNativeFragmentShaderCode );
 396     shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 397   }
 398   else
 399   {
 400     geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
 401     shader  = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
 402                            mNativeFragmentShaderCode,
 403                            mImpl->mCustomShader->mHints );
 404     if( mImpl->mCustomShader->mVertexShader.empty() )
 405     {
 406       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 407     }
 408   }
 409
 410   TextureSet textureSet = TextureSet::New();
 411   Renderer renderer = Renderer::New( geometry, shader );
 412   renderer.SetTextures( textureSet );
 413   return renderer;
 414 }
 415
 416
 417 bool ImageVisual::IsSynchronousResourceLoading() const
 418 {
 419   return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 420 }
 421
 422 void ImageVisual::DoSynchronousResourceLoading()
 423 {
 424   if( !mImageUrl.empty() )
 425   {
 426     BitmapLoader loader = BitmapLoader::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
 427     loader.Load();
 428     mPixels = loader.GetPixelData();
 429   }
 430 }
 431
 432 Image ImageVisual::LoadImage( const std::string& url, bool synchronousLoading )
 433 {
 434   if( synchronousLoading )
 435   {
 436     if( !mPixels )
 437     {
 438       // use broken image
 439       return VisualFactoryCache::GetBrokenVisualImage();
 440     }
 441     Atlas image = Atlas::New( mPixels.GetWidth(), mPixels.GetHeight(), mPixels.GetPixelFormat() );
 442     image.Upload( mPixels, 0, 0 );
 443     return image;
 444   }
 445   else
 446   {
 447     ResourceImage resourceImage = Dali::ResourceImage::New( url, mDesiredSize, mFittingMode, mSamplingMode );
 448     resourceImage.LoadingFinishedSignal().Connect( this, &ImageVisual::OnImageLoaded );
 449     return resourceImage;
 450   }
 451 }
 452
 453 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading )
 454 {
 455   TextureSet textureSet;
 456   textureRect = FULL_TEXTURE_RECT;
 457   if( synchronousLoading )
 458   {
 459     if( !mPixels )
 460     {
 461       // use broken image
 462       textureSet = TextureSet::New();
 463       TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
 464     }
 465     else
 466     {
 467       textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
 468       mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
 469       if( !textureSet ) // big image, no atlasing
 470       {
 471         mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 472         Atlas image = Atlas::New( mPixels.GetWidth(), mPixels.GetHeight(), mPixels.GetPixelFormat() );
 473         image.Upload( mPixels, 0, 0 );
 474         textureSet = TextureSet::New();
 475         TextureSetImage( textureSet, 0u, image );
 476       }
 477     }
 478   }
 479   else
 480   {
 481     textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, url, mDesiredSize, mFittingMode, mSamplingMode );
 482     mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
 483     if( !textureSet ) // big image, no atlasing
 484     {
 485       mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 486       ResourceImage resourceImage = Dali::ResourceImage::New( url, mDesiredSize, mFittingMode, mSamplingMode );
 487       resourceImage.LoadingFinishedSignal().Connect( this, &ImageVisual::OnImageLoaded );
 488       textureSet = TextureSet::New();
 489       TextureSetImage( textureSet, 0u, resourceImage );
 490     }
 491   }
 492
 493   if( !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
 494   {
 495     Sampler sampler = Sampler::New();
 496     sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
 497     textureSet.SetSampler( 0u, sampler );
 498   }
 499
 500   return textureSet;
 501 }
 502
 503 void ImageVisual::InitializeRenderer( const std::string& imageUrl )
 504 {
 505   if( imageUrl.empty() )
 506   {
 507     return;
 508   }
 509
 510   mImageUrl = imageUrl;
 511   mImpl->mRenderer.Reset();
 512
 513   if( !mImpl->mCustomShader &&
 514       ( strncasecmp( imageUrl.c_str(), HTTP_URL,  sizeof(HTTP_URL)  -1 ) != 0 ) && // ignore remote images
 515       ( strncasecmp( imageUrl.c_str(), HTTPS_URL, sizeof(HTTPS_URL) -1 ) != 0 ) )
 516   {
 517     bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
 518     bool cacheable =  defaultWrapMode &&  mPixelArea == FULL_TEXTURE_RECT;
 519
 520     mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
 521     if( cacheable ) // fetch the renderer from cache if exist
 522     {
 523       mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
 524       mImpl->mFlags |= Impl::IS_FROM_CACHE;
 525     }
 526
 527     if( !mImpl->mRenderer ) // new renderer is needed
 528     {
 529       Vector4 atlasRect;
 530       TextureSet textureSet = CreateTextureSet(atlasRect, imageUrl, IsSynchronousResourceLoading() );
 531       Geometry geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
 532       Shader shader( GetImageShader(mFactoryCache, mImpl->mFlags & Impl::IS_ATLASING_APPLIED, defaultWrapMode) );
 533       mImpl->mRenderer = Renderer::New( geometry, shader );
 534       mImpl->mRenderer.SetTextures( textureSet );
 535
 536       if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
 537       {
 538         mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
 539         if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
 540         {
 541           Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
 542           wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
 543           mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
 544         }
 545       }
 546
 547       // save the renderer to cache only when default wrap mode and default pixel area is used
 548       if( cacheable )
 549       {
 550         mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
 551       }
 552     }
 553   }
 554   else
 555   {
 556     // for custom shader or remote image, renderer is not cached and atlas is not applied
 557     mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
 558     mImpl->mRenderer = CreateRenderer();
 559     Image image = LoadImage( imageUrl, IsSynchronousResourceLoading() );
 560     ApplyImageToSampler( image );
 561   }
 562 }
 563
 564 void ImageVisual::InitializeRenderer( const Image& image )
 565 {
 566   mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
 567
 568   mImpl->mRenderer = CreateRenderer();
 569
 570   if( image )
 571   {
 572     ApplyImageToSampler( image );
 573   }
 574 }
 575
 576 void ImageVisual::DoSetOnStage( Actor& actor )
 577 {
 578   if( !mImageUrl.empty() )
 579   {
 580     InitializeRenderer( mImageUrl );
 581   }
 582   else
 583   {
 584     InitializeRenderer( mImage );
 585   }
 586
 587   if( mPixelArea != FULL_TEXTURE_RECT )
 588   {
 589     mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
 590   }
 591 }
 592
 593 void ImageVisual::DoSetOffStage( Actor& actor )
 594 {
 595   //If we own the image then make sure we release it when we go off stage
 596   if( !mImageUrl.empty() )
 597   {
 598     actor.RemoveRenderer( mImpl->mRenderer );
 599     CleanCache(mImageUrl);
 600     mImage.Reset();
 601   }
 602   else
 603   {
 604     actor.RemoveRenderer( mImpl->mRenderer );
 605     mImpl->mRenderer.Reset();
 606   }
 607 }
 608
 609 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
 610 {
 611   map.Clear();
 612   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
 613
 614   bool sync = IsSynchronousResourceLoading();
 615   map.Insert( SYNCHRONOUS_LOADING, sync );
 616   if( !mImageUrl.empty() )
 617   {
 618     map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl );
 619     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
 620     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
 621   }
 622   else if( mImage )
 623   {
 624     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
 625     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
 626
 627     ResourceImage resourceImage = ResourceImage::DownCast(mImage);
 628     if( resourceImage )
 629     {
 630       map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
 631     }
 632   }
 633
 634   map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
 635   map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
 636
 637   map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
 638   map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
 639   map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
 640 }
 641
 642 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
 643 {
 644   Shader shader;
 645   if( atlasing )
 646   {
 647     if( defaultTextureWrapping )
 648     {
 649       shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
 650       if( !shader )
 651       {
 652         shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
 653         factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
 654       }
 655     }
 656     else
 657     {
 658       shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
 659       if( !shader )
 660       {
 661         shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
 662         factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
 663       }
 664     }
 665   }
 666   else
 667   {
 668     shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
 669     if( !shader )
 670     {
 671       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
 672       factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
 673     }
 674   }
 675   shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 676   return shader;
 677 }
 678
 679 void ImageVisual::SetImage( Actor& actor, const std::string& imageUrl, ImageDimensions size, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode )
 680 {
 681   if( mImageUrl != imageUrl )
 682   {
 683     std::string oldImageUrl = mImageUrl;
 684     mImageUrl = imageUrl;
 685     mDesiredSize = size;
 686     mFittingMode = fittingMode;
 687     mSamplingMode = samplingMode;
 688     mImage.Reset();
 689
 690     if( IsSynchronousResourceLoading() )
 691     {
 692       DoSynchronousResourceLoading();
 693     }
 694
 695     if( mImpl->mRenderer )
 696     {
 697       if( GetIsFromCache() ) // if renderer is from cache, remove the old one
 698       {
 699         //remove old renderer
 700         if( actor )
 701         {
 702           actor.RemoveRenderer( mImpl->mRenderer );
 703         }
 704
 705         //clean the cache
 706         if( !oldImageUrl.empty() )
 707         {
 708           CleanCache(oldImageUrl);
 709         }
 710
 711         if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
 712         {
 713           SetOnStage(actor);
 714         }
 715       }
 716       else // if renderer is not from cache, reuse the same renderer and only change the texture
 717       {
 718         Image image = LoadImage( imageUrl, IsSynchronousResourceLoading() );
 719         ApplyImageToSampler( image );
 720       }
 721     }
 722   }
 723 }
 724
 725 void ImageVisual::SetImage( Actor& actor, const Image& image )
 726 {
 727   if( mImage != image )
 728   {
 729     NativeImage newNativeImage = NativeImage::DownCast( image );
 730     bool newRendererFlag = true;
 731
 732     if( newNativeImage && !mNativeImageFlag )
 733     {
 734       SetNativeFragmentShaderCode( newNativeImage );
 735     }
 736
 737     if( ( newNativeImage && mNativeImageFlag ) || ( !newNativeImage && !mNativeImageFlag ) )
 738     {
 739       newRendererFlag = false;
 740     }
 741
 742     if( newNativeImage )
 743     {
 744       mNativeImageFlag = true;
 745     }
 746     else
 747     {
 748       mNativeFragmentShaderCode.clear();
 749       mNativeImageFlag = false;
 750     }
 751
 752     mImage = image;
 753
 754     if( mImpl->mRenderer )
 755     {
 756       // if renderer is from cache, remove the old one, and create new renderer
 757       if( GetIsFromCache() )
 758       {
 759         //remove old renderer
 760         if( actor )
 761         {
 762           actor.RemoveRenderer( mImpl->mRenderer );
 763         }
 764
 765         //clean the cache
 766         if( !mImageUrl.empty() )
 767         {
 768           CleanCache(mImageUrl);
 769         }
 770         mImageUrl.clear();
 771
 772         if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
 773         {
 774           SetOnStage(actor);
 775         }
 776       }
 777       // if input image is nativeImage and mImage is regular image or the reverse, remove the old one, and create new renderer
 778       else if( newRendererFlag )
 779       {
 780         //remove old renderer
 781         if( actor )
 782         {
 783           actor.RemoveRenderer( mImpl->mRenderer );
 784         }
 785
 786         if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
 787         {
 788           SetOnStage(actor);
 789         }
 790       }
 791       else // if renderer is not from cache, reuse the same renderer and only change the texture
 792       {
 793         ApplyImageToSampler( image );
 794       }
 795     }
 796
 797     mImageUrl.clear();
 798     mDesiredSize = ImageDimensions();
 799     mFittingMode = FittingMode::DEFAULT;
 800     mSamplingMode = SamplingMode::DEFAULT;
 801   }
 802 }
 803
 804 void ImageVisual::ApplyImageToSampler( const Image& image )
 805 {
 806   if( image )
 807   {
 808     TextureSet textureSet = mImpl->mRenderer.GetTextures();
 809     if( !textureSet )
 810     {
 811       textureSet = TextureSet::New();
 812       mImpl->mRenderer.SetTextures( textureSet );
 813     }
 814     TextureSetImage( textureSet, 0u, image );
 815     Sampler sampler = Sampler::New();
 816     sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
 817     textureSet.SetSampler( 0u, sampler );
 818   }
 819 }
 820
 821 void ImageVisual::OnImageLoaded( ResourceImage image )
 822 {
 823   if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
 824   {
 825     Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
 826     if( mImpl->mRenderer )
 827     {
 828       ApplyImageToSampler( brokenImage );
 829     }
 830   }
 831 }
 832
 833 void ImageVisual::CleanCache(const std::string& url)
 834 {
 835   TextureSet textureSet = mImpl->mRenderer.GetTextures();
 836
 837   Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
 838   Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
 839   if( index != Property::INVALID_INDEX )
 840   {
 841     Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
 842     atlasRectValue.Get( atlasRect );
 843   }
 844
 845   mImpl->mRenderer.Reset();
 846   if( mFactoryCache.CleanRendererCache( url ) && index != Property::INVALID_INDEX )
 847   {
 848     mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
 849   }
 850 }
 851
 852 void ImageVisual::SetNativeFragmentShaderCode( Dali::NativeImage& nativeImage )
 853 {
 854   const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
 855   const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
 856
 857   if( fragmentPreFix )
 858   {
 859     mNativeFragmentShaderCode = fragmentPreFix;
 860     mNativeFragmentShaderCode += "\n";
 861   }
 862
 863   if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
 864   {
 865     mNativeFragmentShaderCode += mImpl->mCustomShader->mFragmentShader;
 866   }
 867   else
 868   {
 869     mNativeFragmentShaderCode += FRAGMENT_SHADER_NO_ATLAS;
 870   }
 871
 872   if( customSamplerTypename )
 873   {
 874     mNativeFragmentShaderCode.replace( mNativeFragmentShaderCode.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
 875   }
 876 }
 877
 878 } // namespace Internal
 879
 880 } // namespace Toolkit
 881
 882 } // namespace Dali