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