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