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

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