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