dali-toolkit/internal/visuals/image/image-visual.cpp

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