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