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