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