dali-toolkit/internal/visuals/image/image-visual.cpp

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