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