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