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