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