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