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     if( !geometry )
 189     {
 190       geometry =  VisualFactoryCache::CreateQuadGeometry();
 191       factoryCache.SaveGeometry( VisualFactoryCache::QUAD_GEOMETRY, geometry );
 192     }
 193   }
 194   else
 195   {
 196     geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
 197   }
 198
 199   return geometry;
 200 }
 201
 202 } // unnamed namespace
 203
 204 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
 205                                  const std::string& imageUrl,
 206                                  const Property::Map& properties,
 207                                  ImageDimensions size,
 208                                  FittingMode::Type fittingMode,
 209                                  Dali::SamplingMode::Type samplingMode )
 210 {
 211   ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
 212   imageVisualPtr->SetProperties( properties );
 213   return imageVisualPtr;
 214 }
 215
 216 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
 217                                  const std::string& imageUrl,
 218                                  ImageDimensions size,
 219                                  FittingMode::Type fittingMode,
 220                                  Dali::SamplingMode::Type samplingMode )
 221 {
 222   return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
 223 }
 224
 225 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
 226 {
 227   return new ImageVisual( factoryCache, image );
 228 }
 229
 230 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
 231                           const std::string& imageUrl,
 232                           ImageDimensions size,
 233                           FittingMode::Type fittingMode,
 234                           Dali::SamplingMode::Type samplingMode )
 235 : Visual::Base( factoryCache ),
 236   mImage(),
 237   mPixels(),
 238   mPixelArea( FULL_TEXTURE_RECT ),
 239   mPlacementActor(),
 240   mImageUrl( imageUrl ),
 241   mDesiredSize( size ),
 242   mFittingMode( fittingMode ),
 243   mSamplingMode( samplingMode ),
 244   mWrapModeU( WrapMode::DEFAULT ),
 245   mWrapModeV( WrapMode::DEFAULT )
 246 {
 247 }
 248
 249 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
 250 : Visual::Base( factoryCache ),
 251   mImage( image ),
 252   mPixels(),
 253   mPixelArea( FULL_TEXTURE_RECT ),
 254   mPlacementActor(),
 255   mImageUrl(),
 256   mDesiredSize(),
 257   mFittingMode( FittingMode::DEFAULT ),
 258   mSamplingMode( SamplingMode::DEFAULT ),
 259   mWrapModeU( WrapMode::DEFAULT ),
 260   mWrapModeV( WrapMode::DEFAULT )
 261 {
 262 }
 263
 264 ImageVisual::~ImageVisual()
 265 {
 266 }
 267
 268 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
 269 {
 270   // Url is already received in constructor
 271   Property::Value* fittingValue = propertyMap.Find( Toolkit::ImageVisual::Property::FITTING_MODE, IMAGE_FITTING_MODE );
 272   if( fittingValue )
 273   {
 274     int value;
 275     Scripting::GetEnumerationProperty( *fittingValue, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, value );
 276     mFittingMode = Dali::FittingMode::Type( value );
 277   }
 278
 279   Property::Value* samplingValue = propertyMap.Find( Toolkit::ImageVisual::Property::SAMPLING_MODE, IMAGE_SAMPLING_MODE );
 280   if( samplingValue )
 281   {
 282     int value;
 283     Scripting::GetEnumerationProperty( *samplingValue, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, value );
 284     mSamplingMode = Dali::SamplingMode::Type( value );
 285   }
 286
 287   // Use a variable to detect if the width or height have been modified by the property map.
 288   bool desiredSizeSpecified = false;
 289   int desiredWidth = 0;
 290   Property::Value* desiredWidthValue = propertyMap.Find( Toolkit::ImageVisual::Property::DESIRED_WIDTH, IMAGE_DESIRED_WIDTH );
 291   if( desiredWidthValue )
 292   {
 293     desiredWidthValue->Get( desiredWidth );
 294     desiredSizeSpecified = true;
 295   }
 296
 297   int desiredHeight = 0;
 298   Property::Value* desiredHeightValue = propertyMap.Find( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, IMAGE_DESIRED_HEIGHT );
 299   if( desiredHeightValue )
 300   {
 301     desiredHeightValue->Get( desiredHeight );
 302     desiredSizeSpecified = true;
 303   }
 304
 305   // Only update the desired size if specified in the property map.
 306   if( desiredSizeSpecified )
 307   {
 308     mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
 309   }
 310
 311   Property::Value* pixelAreaValue = propertyMap.Find( Toolkit::ImageVisual::Property::PIXEL_AREA, PIXEL_AREA_UNIFORM_NAME );
 312   if( pixelAreaValue )
 313   {
 314     pixelAreaValue->Get( mPixelArea );
 315   }
 316
 317   Property::Value* wrapModeValueU = propertyMap.Find( Toolkit::ImageVisual::Property::WRAP_MODE_U, IMAGE_WRAP_MODE_U );
 318   if( wrapModeValueU )
 319   {
 320     int value;
 321     Scripting::GetEnumerationProperty( *wrapModeValueU, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, value );
 322     mWrapModeU = Dali::WrapMode::Type( value );
 323   }
 324
 325   Property::Value* wrapModeValueV = propertyMap.Find( Toolkit::ImageVisual::Property::WRAP_MODE_V, IMAGE_WRAP_MODE_V );
 326   if( wrapModeValueV )
 327   {
 328     int value;
 329     Scripting::GetEnumerationProperty( *wrapModeValueV, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, value );
 330     mWrapModeV = Dali::WrapMode::Type( value );
 331   }
 332
 333   Property::Value* syncLoading = propertyMap.Find( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, SYNCHRONOUS_LOADING );
 334   if( syncLoading )
 335   {
 336     bool sync;
 337     syncLoading->Get( sync );
 338     if( sync )
 339     {
 340       mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 341       // if sync loading is required, the loading should start immediately when new image url is set or the actor is off stage
 342       // ( for on-stage actor with image url unchanged, resource loading is already finished)
 343       if( mImageUrl.size() > 0u )
 344       {
 345         LoadResourceSynchronously();
 346       }
 347     }
 348     else
 349     {
 350       mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 351     }
 352   }
 353 }
 354
 355 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
 356 {
 357   if(mImage)
 358   {
 359     naturalSize.x = mImage.GetWidth();
 360     naturalSize.y = mImage.GetHeight();
 361     return;
 362   }
 363   else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
 364   {
 365     naturalSize.x = mDesiredSize.GetWidth();
 366     naturalSize.y = mDesiredSize.GetHeight();
 367     return;
 368   }
 369   else if( !mImageUrl.empty() )
 370   {
 371     ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
 372     naturalSize.x = dimentions.GetWidth();
 373     naturalSize.y = dimentions.GetHeight();
 374     return;
 375   }
 376
 377   naturalSize = Vector2::ZERO;
 378 }
 379
 380 void ImageVisual::CreateRenderer( TextureSet& textures )
 381 {
 382   Geometry geometry;
 383   Shader shader;
 384
 385   if( !mImpl->mCustomShader )
 386   {
 387     geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
 388
 389     shader = GetImageShader( mFactoryCache,
 390                              mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
 391                              mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
 392   }
 393   else
 394   {
 395     geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
 396     if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
 397     {
 398       shader = GetImageShader( mFactoryCache, false, true );
 399     }
 400     else
 401     {
 402       shader  = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
 403                              mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
 404                              mImpl->mCustomShader->mHints );
 405       if( mImpl->mCustomShader->mVertexShader.empty() )
 406       {
 407         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 408       }
 409     }
 410   }
 411
 412   mImpl->mRenderer = Renderer::New( geometry, shader );
 413   DALI_ASSERT_DEBUG( textures );
 414   mImpl->mRenderer.SetTextures( textures );
 415
 416   //Register transform properties
 417   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 418 }
 419
 420 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
 421 {
 422   Geometry geometry;
 423   Shader shader;
 424
 425   std::string fragmentShader;
 426   const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
 427   const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
 428   if( fragmentPreFix )
 429   {
 430     fragmentShader = fragmentPreFix;
 431     fragmentShader += "\n";
 432   }
 433   if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
 434   {
 435     fragmentShader += mImpl->mCustomShader->mFragmentShader;
 436   }
 437   else
 438   {
 439     fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
 440   }
 441   if( customSamplerTypename )
 442   {
 443     fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
 444   }
 445
 446   if( !mImpl->mCustomShader )
 447   {
 448     geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
 449
 450     shader  = Shader::New( VERTEX_SHADER, fragmentShader );
 451     shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 452   }
 453   else
 454   {
 455     geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
 456     shader  = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
 457                            fragmentShader,
 458                            mImpl->mCustomShader->mHints );
 459     if( mImpl->mCustomShader->mVertexShader.empty() )
 460     {
 461       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 462     }
 463   }
 464
 465   mImpl->mRenderer = Renderer::New( geometry, shader );
 466
 467   //Register transform properties
 468   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 469 }
 470
 471
 472 bool ImageVisual::IsSynchronousResourceLoading() const
 473 {
 474   return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 475 }
 476
 477 void ImageVisual::LoadResourceSynchronously()
 478 {
 479   if( !mImageUrl.empty() )
 480   {
 481     BitmapLoader loader = BitmapLoader::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
 482     loader.Load();
 483     mPixels = loader.GetPixelData();
 484   }
 485 }
 486
 487 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading, bool attemptAtlasing )
 488 {
 489   TextureSet textureSet;
 490   textureRect = FULL_TEXTURE_RECT;
 491   if( synchronousLoading )
 492   {
 493     if( !mPixels )
 494     {
 495       // use broken image
 496       textureSet = TextureSet::New();
 497       TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
 498     }
 499     else
 500     {
 501       if( attemptAtlasing )
 502       {
 503         textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
 504         mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
 505       }
 506       if( !textureSet ) // big image, no atlasing or atlasing failed
 507       {
 508         mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 509         Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
 510                                         mPixels.GetWidth(), mPixels.GetHeight() );
 511         texture.Upload( mPixels );
 512         textureSet = TextureSet::New();
 513         textureSet.SetTexture( 0u, texture );
 514       }
 515     }
 516   }
 517   else
 518   {
 519     if( attemptAtlasing )
 520     {
 521       textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, url, mDesiredSize, mFittingMode, true, this );
 522       mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
 523     }
 524     if( !textureSet ) // big image, no atlasing or atlasing failed
 525     {
 526       mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 527       ResourceImage resourceImage = Dali::ResourceImage::New( url, mDesiredSize, mFittingMode, mSamplingMode );
 528       resourceImage.LoadingFinishedSignal().Connect( this, &ImageVisual::OnImageLoaded );
 529       textureSet = TextureSet::New();
 530       TextureSetImage( textureSet, 0u, resourceImage );
 531     }
 532   }
 533
 534   if( !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
 535   {
 536     Sampler sampler = Sampler::New();
 537     sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
 538     textureSet.SetSampler( 0u, sampler );
 539   }
 540   return textureSet;
 541 }
 542
 543 void ImageVisual::InitializeRenderer( const std::string& imageUrl )
 544 {
 545   mImageUrl = imageUrl;
 546   mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 547
 548   if( !mImpl->mCustomShader &&
 549       ( strncasecmp( imageUrl.c_str(), HTTP_URL,  sizeof(HTTP_URL)  -1 ) != 0 ) && // dont atlas remote images
 550       ( strncasecmp( imageUrl.c_str(), HTTPS_URL, sizeof(HTTPS_URL) -1 ) != 0 ) )
 551   {
 552     bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
 553     bool defaultTransform = mImpl->mTransform.mSize == Vector2::ONE &&
 554                             mImpl->mTransform.mOffset == Vector2::ZERO &&
 555                             mImpl->mTransform.mOffsetSizeMode == Vector4::ZERO &&
 556                             mImpl->mTransform.mOrigin == Toolkit::Align::CENTER &&
 557                             mImpl->mTransform.mAnchorPoint == Toolkit::Align::CENTER;
 558
 559     bool cacheable =  defaultWrapMode && defaultTransform &&  mPixelArea == FULL_TEXTURE_RECT;
 560
 561
 562     mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
 563     if( cacheable ) // fetch the renderer from cache if exist
 564     {
 565       mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
 566       mImpl->mFlags |= Impl::IS_FROM_CACHE;
 567     }
 568
 569     if( !mImpl->mRenderer ) // new renderer is needed
 570     {
 571       Vector4 atlasRect;
 572       // texture set has to be created first as we need to know if atlasing succeeded or not
 573       // when selecting the shader
 574       TextureSet textures = CreateTextureSet( atlasRect, imageUrl, IsSynchronousResourceLoading(), true );
 575       CreateRenderer( textures );
 576
 577       if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
 578       {
 579         mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
 580         if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
 581         {
 582           Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
 583           wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
 584           mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
 585         }
 586       }
 587
 588       // save the renderer to cache only when default wrap mode and default pixel area is used
 589       if( cacheable )
 590       {
 591         mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
 592       }
 593     }
 594   }
 595   else
 596   {
 597     // for custom shader or remote image, renderer is not cached and atlas is not applied
 598     mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
 599     Vector4 atlasRect; // ignored in this case
 600     TextureSet textures = CreateTextureSet( atlasRect, imageUrl, IsSynchronousResourceLoading(), false );
 601     CreateRenderer( textures );
 602   }
 603 }
 604
 605 void ImageVisual::InitializeRenderer( const Image& image )
 606 {
 607
 608   mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
 609
 610   // don't reuse CreateTextureSet
 611   TextureSet textures = TextureSet::New();
 612   // Renderer can't be shared if mImage is NativeImage
 613   NativeImage nativeImage = NativeImage::DownCast( image );
 614   if( nativeImage )
 615   {
 616     CreateNativeImageRenderer( nativeImage );
 617     DALI_ASSERT_DEBUG( textures );
 618     mImpl->mRenderer.SetTextures( textures );
 619   }
 620   else
 621   {
 622     // reuse existing code for regular images
 623     CreateRenderer( textures );
 624   }
 625   ApplyImageToSampler( image );
 626 }
 627
 628 void ImageVisual::UploadCompleted()
 629 {
 630   // Resource image is loaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
 631   Actor actor = mPlacementActor.GetHandle();
 632   if( actor )
 633   {
 634     actor.AddRenderer( mImpl->mRenderer );
 635     // reset the weak handle so that the renderer only get added to actor once
 636     mPlacementActor.Reset();
 637   }
 638 }
 639
 640 void ImageVisual::DoSetOnStage( Actor& actor )
 641 {
 642   if( !mImageUrl.empty() )
 643   {
 644     InitializeRenderer( mImageUrl );
 645   }
 646   else if ( mImage )
 647   {
 648     InitializeRenderer( mImage );
 649   }
 650
 651   if ( !mImpl->mRenderer)
 652   {
 653     return;
 654   }
 655
 656   mPlacementActor = actor;
 657
 658   if( mPixelArea != FULL_TEXTURE_RECT )
 659   {
 660     mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
 661   }
 662
 663   if( IsSynchronousResourceLoading() || !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
 664   {
 665     actor.AddRenderer( mImpl->mRenderer );
 666     mPlacementActor.Reset();
 667   }
 668 }
 669
 670 void ImageVisual::DoSetOffStage( Actor& actor )
 671 {
 672   // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
 673
 674   //If we own the image then make sure we release it when we go off stage
 675   actor.RemoveRenderer( mImpl->mRenderer);
 676   if( !mImageUrl.empty() )
 677   {
 678     CleanCache(mImageUrl);
 679     mImage.Reset();
 680   }
 681
 682   mImpl->mRenderer.Reset();
 683   mPlacementActor.Reset();
 684 }
 685
 686 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
 687 {
 688   map.Clear();
 689   map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
 690
 691   bool sync = IsSynchronousResourceLoading();
 692   map.Insert( SYNCHRONOUS_LOADING, sync );
 693   if( !mImageUrl.empty() )
 694   {
 695     map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl );
 696     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
 697     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
 698   }
 699   else if( mImage )
 700   {
 701     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
 702     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
 703
 704     ResourceImage resourceImage = ResourceImage::DownCast(mImage);
 705     if( resourceImage )
 706     {
 707       map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
 708     }
 709   }
 710
 711   map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
 712   map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
 713
 714   map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
 715   map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
 716   map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
 717 }
 718
 719 void ImageVisual::OnSetTransform()
 720 {
 721   if( mImpl->mRenderer )
 722   {
 723     mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 724   }
 725 }
 726
 727 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
 728 {
 729   Shader shader;
 730   if( atlasing )
 731   {
 732     if( defaultTextureWrapping )
 733     {
 734       shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
 735       if( !shader )
 736       {
 737         shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
 738         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 739         factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
 740       }
 741     }
 742     else
 743     {
 744       shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
 745       if( !shader )
 746       {
 747         shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
 748         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 749         factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
 750       }
 751     }
 752   }
 753   else
 754   {
 755     shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
 756     if( !shader )
 757     {
 758       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
 759       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 760       factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
 761     }
 762   }
 763
 764   return shader;
 765 }
 766
 767 void ImageVisual::ApplyImageToSampler( const Image& image )
 768 {
 769   if( image )
 770   {
 771     TextureSet textureSet = mImpl->mRenderer.GetTextures();
 772     DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
 773
 774     TextureSetImage( textureSet, 0u, image );
 775     Sampler sampler = Sampler::New();
 776     sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
 777     textureSet.SetSampler( 0u, sampler );
 778   }
 779 }
 780
 781 void ImageVisual::OnImageLoaded( ResourceImage image )
 782 {
 783   if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
 784   {
 785     Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
 786     if( mImpl->mRenderer )
 787     {
 788       ApplyImageToSampler( brokenImage );
 789     }
 790   }
 791 }
 792
 793 void ImageVisual::CleanCache(const std::string& url)
 794 {
 795   if( IsFromCache() )
 796   {
 797     Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
 798     Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
 799     if( index != Property::INVALID_INDEX )
 800     {
 801       Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
 802       atlasRectValue.Get( atlasRect );
 803     }
 804
 805     TextureSet textureSet = mImpl->mRenderer.GetTextures();
 806     mImpl->mRenderer.Reset();
 807     if( mFactoryCache.CleanRendererCache( url ) && index != Property::INVALID_INDEX )
 808     {
 809       mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
 810     }
 811   }
 812 }
 813
 814 } // namespace Internal
 815
 816 } // namespace Toolkit
 817
 818 } // namespace Dali