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/bitmap-loader.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.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   mPixels(),
 262   mPixelArea( FULL_TEXTURE_RECT ),
 263   mPlacementActor(),
 264   mImageUrl( imageUrl ),
 265   mAlphaMaskUrl(),
 266   mDesiredSize( size ),
 267   mTextureId( TextureManager::INVALID_TEXTURE_ID ),
 268   mAlphaMaskId( TextureManager::INVALID_TEXTURE_ID ),
 269   mFittingMode( fittingMode ),
 270   mSamplingMode( samplingMode ),
 271   mWrapModeU( WrapMode::DEFAULT ),
 272   mWrapModeV( WrapMode::DEFAULT ),
 273   mAttemptAtlasing( false ),
 274   mTextureLoading( false )
 275 {
 276 }
 277
 278 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
 279 : Visual::Base( factoryCache ),
 280   mImage( image ),
 281   mPixels(),
 282   mPixelArea( FULL_TEXTURE_RECT ),
 283   mPlacementActor(),
 284   mImageUrl(),
 285   mAlphaMaskUrl(),
 286   mDesiredSize(),
 287   mTextureId( TextureManager::INVALID_TEXTURE_ID ),
 288   mAlphaMaskId( TextureManager::INVALID_TEXTURE_ID ),
 289   mFittingMode( FittingMode::DEFAULT ),
 290   mSamplingMode( SamplingMode::DEFAULT ),
 291   mWrapModeU( WrapMode::DEFAULT ),
 292   mWrapModeV( WrapMode::DEFAULT ),
 293   mAttemptAtlasing( false ),
 294   mTextureLoading( false )
 295 {
 296 }
 297
 298 ImageVisual::~ImageVisual()
 299 {
 300   if( mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
 301   {
 302     TextureManager& textureManager = mFactoryCache.GetTextureManager();
 303     textureManager.Remove( mAlphaMaskId );
 304   }
 305 }
 306
 307 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
 308 {
 309   // Url is already received in constructor
 310   for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
 311   {
 312     KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
 313     if( keyValue.first.type == Property::Key::INDEX )
 314     {
 315       DoSetProperty( keyValue.first.indexKey, keyValue.second );
 316     }
 317     else
 318     {
 319       if( keyValue.first == IMAGE_FITTING_MODE )
 320       {
 321         DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
 322       }
 323       else if( keyValue.first == IMAGE_SAMPLING_MODE )
 324       {
 325         DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
 326       }
 327       else if( keyValue.first == IMAGE_DESIRED_WIDTH )
 328       {
 329         DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
 330       }
 331       else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
 332       {
 333         DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
 334       }
 335       else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
 336       {
 337         DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
 338       }
 339       else if( keyValue.first == IMAGE_WRAP_MODE_U )
 340       {
 341         DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
 342       }
 343       else if( keyValue.first == IMAGE_WRAP_MODE_V )
 344       {
 345         DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
 346       }
 347       else if( keyValue.first == SYNCHRONOUS_LOADING )
 348       {
 349         DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
 350       }
 351       else if ( keyValue.first == IMAGE_ATLASING )
 352       {
 353         DoSetProperty( Toolkit::DevelImageVisual::Property::ATLASING, keyValue.second );
 354       }
 355       else if ( keyValue.first == ALPHA_MASK_URL )
 356       {
 357         DoSetProperty( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
 358       }
 359     }
 360   }
 361
 362   if( mAlphaMaskUrl.IsValid() )
 363   {
 364     // Immediately trigger the alpha mask loading (it may just get a cached value)
 365     TextureManager& textureManager = mFactoryCache.GetTextureManager();
 366     mAlphaMaskId = textureManager.RequestMaskLoad( mAlphaMaskUrl );
 367   }
 368
 369   if( ( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING ) && mImageUrl.IsValid() )
 370   {
 371     // if sync loading is required, the loading should start
 372     // immediately when new image url is set or the actor is off stage
 373     // ( for on-stage actor with image url unchanged, resource loading
 374     // is already finished )
 375     LoadResourceSynchronously();
 376   }
 377 }
 378
 379 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
 380 {
 381   switch( index )
 382   {
 383     case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
 384     {
 385       bool sync;
 386       if( value.Get( sync ) )
 387       {
 388         if( sync )
 389         {
 390           mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 391         }
 392         else
 393         {
 394           mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 395         }
 396       }
 397       else
 398       {
 399         DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
 400       }
 401       break;
 402     }
 403
 404     case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
 405     {
 406       float desiredWidth;
 407       if( value.Get( desiredWidth ) )
 408       {
 409         mDesiredSize.SetWidth( desiredWidth );
 410       }
 411       else
 412       {
 413         DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
 414       }
 415       break;
 416     }
 417
 418     case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
 419     {
 420       float desiredHeight;
 421       if( value.Get( desiredHeight ) )
 422       {
 423         mDesiredSize.SetHeight( desiredHeight );
 424       }
 425       else
 426       {
 427         DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
 428       }
 429       break;
 430     }
 431
 432     case Toolkit::ImageVisual::Property::FITTING_MODE:
 433     {
 434       int fittingMode;
 435       Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
 436       mFittingMode = Dali::FittingMode::Type( fittingMode );
 437       break;
 438     }
 439
 440     case Toolkit::ImageVisual::Property::SAMPLING_MODE:
 441     {
 442       int samplingMode;
 443       Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
 444       mSamplingMode = Dali::SamplingMode::Type( samplingMode );
 445       break;
 446     }
 447
 448     case Toolkit::ImageVisual::Property::PIXEL_AREA:
 449     {
 450       value.Get( mPixelArea );
 451       break;
 452     }
 453
 454     case Toolkit::ImageVisual::Property::WRAP_MODE_U:
 455     {
 456       int wrapMode;
 457       Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
 458       mWrapModeU = Dali::WrapMode::Type( wrapMode );
 459       break;
 460     }
 461
 462     case Toolkit::ImageVisual::Property::WRAP_MODE_V:
 463     {
 464       int wrapMode;
 465       Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
 466       mWrapModeV = Dali::WrapMode::Type( wrapMode );
 467       break;
 468     }
 469
 470     case Toolkit::DevelImageVisual::Property::ATLASING:
 471     {
 472       bool atlasing = false;
 473       mAttemptAtlasing = value.Get( atlasing );
 474     }
 475
 476     case Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL:
 477     {
 478       std::string alphaUrl;
 479       if( value.Get( alphaUrl ) )
 480       {
 481         mAlphaMaskUrl = VisualUrl( alphaUrl );
 482       }
 483     }
 484   }
 485 }
 486
 487 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
 488 {
 489   if(mImage)
 490   {
 491     naturalSize.x = mImage.GetWidth();
 492     naturalSize.y = mImage.GetHeight();
 493     return;
 494   }
 495   else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
 496   {
 497     naturalSize.x = mDesiredSize.GetWidth();
 498     naturalSize.y = mDesiredSize.GetHeight();
 499     return;
 500   }
 501   else if( mImageUrl.IsValid() && mImageUrl.GetLocation() == VisualUrl::LOCAL )
 502   {
 503     ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
 504
 505     if( dimensions != ImageDimensions( 0, 0 ) )
 506     {
 507       naturalSize.x = dimensions.GetWidth();
 508       naturalSize.y = dimensions.GetHeight();
 509     }
 510     else
 511     {
 512       Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
 513
 514       naturalSize.x = brokenImage.GetWidth();
 515       naturalSize.y = brokenImage.GetWidth();
 516     }
 517     return;
 518   }
 519
 520   naturalSize = Vector2::ZERO;
 521 }
 522
 523 void ImageVisual::CreateRenderer( TextureSet& textureSet )
 524 {
 525   Geometry geometry;
 526   Shader shader;
 527
 528   if( !mImpl->mCustomShader )
 529   {
 530     geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
 531
 532     shader = GetImageShader( mFactoryCache,
 533                              mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
 534                              mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
 535   }
 536   else
 537   {
 538     geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
 539     if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
 540     {
 541       shader = GetImageShader( mFactoryCache, false, true );
 542     }
 543     else
 544     {
 545       shader  = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
 546                              mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
 547                              mImpl->mCustomShader->mHints );
 548       if( mImpl->mCustomShader->mVertexShader.empty() )
 549       {
 550         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 551       }
 552     }
 553   }
 554
 555   shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_ON ); // Set default to align
 556
 557   mImpl->mRenderer = Renderer::New( geometry, shader );
 558   if( textureSet )
 559   {
 560     mImpl->mRenderer.SetTextures( textureSet );
 561   }
 562   // else still waiting for texture load to finish.
 563
 564   //Register transform properties
 565   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 566 }
 567
 568 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
 569 {
 570   Geometry geometry;
 571   Shader shader;
 572
 573   std::string fragmentShader;
 574   const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
 575   const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
 576
 577   if( fragmentPreFix )
 578   {
 579     fragmentShader = fragmentPreFix;
 580     fragmentShader += "\n";
 581   }
 582
 583   if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
 584   {
 585     fragmentShader += mImpl->mCustomShader->mFragmentShader;
 586   }
 587   else
 588   {
 589     fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
 590   }
 591
 592   if( customSamplerTypename )
 593   {
 594     fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
 595   }
 596
 597   if( !mImpl->mCustomShader )
 598   {
 599     geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
 600
 601     shader  = Shader::New( VERTEX_SHADER, fragmentShader );
 602     shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 603   }
 604   else
 605   {
 606     geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
 607     shader  = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
 608                            fragmentShader,
 609                            mImpl->mCustomShader->mHints );
 610     if( mImpl->mCustomShader->mVertexShader.empty() )
 611     {
 612       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 613     }
 614   }
 615
 616   mImpl->mRenderer = Renderer::New( geometry, shader );
 617
 618   //Register transform properties
 619   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 620 }
 621
 622
 623 bool ImageVisual::IsSynchronousResourceLoading() const
 624 {
 625   return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 626 }
 627
 628 void ImageVisual::LoadResourceSynchronously()
 629 {
 630   if( mImageUrl.IsValid() )
 631   {
 632     BitmapLoader loader = BitmapLoader::New( mImageUrl.GetUrl(), mDesiredSize, mFittingMode, mSamplingMode );
 633     loader.Load();
 634     mPixels = loader.GetPixelData();
 635     mTextureLoading = false;
 636   }
 637 }
 638
 639 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing )
 640 {
 641   TextureSet textureSet;
 642
 643   mTextureLoading = false;
 644
 645   textureRect = FULL_TEXTURE_RECT;
 646   if( synchronousLoading )
 647   {
 648     if( !mPixels )
 649     {
 650       // use broken image
 651       textureSet = TextureSet::New();
 652       TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
 653     }
 654     else
 655     {
 656       if( attemptAtlasing )
 657       {
 658         textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
 659         mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
 660       }
 661       if( !textureSet ) // big image, no atlasing or atlasing failed
 662       {
 663         mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 664         Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
 665                                         mPixels.GetWidth(), mPixels.GetHeight() );
 666         texture.Upload( mPixels );
 667         textureSet = TextureSet::New();
 668         textureSet.SetTexture( 0u, texture );
 669       }
 670     }
 671   }
 672   else
 673   {
 674     if( attemptAtlasing )
 675     {
 676       textureSet = mFactoryCache.GetAtlasManager()->Add( textureRect, mImageUrl.GetUrl(), mDesiredSize, mFittingMode, true, this );
 677       mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
 678       mTextureLoading = true;
 679     }
 680     if( !textureSet ) // big image, no atlasing or atlasing failed
 681     {
 682       mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 683       TextureManager& textureManager = mFactoryCache.GetTextureManager();
 684       if( mAlphaMaskId == TextureManager::INVALID_TEXTURE_ID )
 685       {
 686         mTextureId = textureManager.RequestLoad( mImageUrl, mDesiredSize, mFittingMode,
 687                                                  mSamplingMode, TextureManager::NO_ATLAS, this );
 688       }
 689       else
 690       {
 691         mTextureId = textureManager.RequestLoad( mImageUrl, mAlphaMaskId, mDesiredSize,
 692                                                  mFittingMode, mSamplingMode,
 693                                                  TextureManager::NO_ATLAS, this );
 694       }
 695
 696       TextureManager::LoadState loadState = textureManager.GetTextureState( mTextureId );
 697
 698       mTextureLoading = ( loadState == TextureManager::LOADING );
 699
 700       if( loadState == TextureManager::UPLOADED )
 701       {
 702         // UploadComplete has already been called - keep the same texture set
 703         textureSet = textureManager.GetTextureSet(mTextureId);
 704       }
 705     }
 706   }
 707
 708   if( ! (mImpl->mFlags & Impl::IS_ATLASING_APPLIED) && textureSet )
 709   {
 710     Sampler sampler = Sampler::New();
 711     sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
 712     textureSet.SetSampler( 0u, sampler );
 713   }
 714
 715   return textureSet;
 716 }
 717
 718 void ImageVisual::InitializeRenderer()
 719 {
 720   mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 721
 722   if( ! mImpl->mCustomShader && mImageUrl.GetLocation() == VisualUrl::LOCAL )
 723   {
 724     bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
 725
 726     Vector4 atlasRect;
 727     // texture set has to be created first as we need to know if atlasing succeeded or not
 728     // when selecting the shader
 729     TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), mAttemptAtlasing );
 730     CreateRenderer( textures );
 731
 732     if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
 733     {
 734       mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
 735       if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
 736       {
 737         Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
 738         wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
 739         mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
 740       }
 741     }
 742   }
 743   else
 744   {
 745     // for custom shader or remote image, atlas is not applied
 746     Vector4 atlasRect; // ignored in this case
 747     TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), false );
 748     CreateRenderer( textures );
 749   }
 750 }
 751
 752 void ImageVisual::InitializeRenderer( const Image& image )
 753 {
 754   // don't reuse CreateTextureSet
 755   TextureSet textures = TextureSet::New();
 756
 757   NativeImage nativeImage = NativeImage::DownCast( image );
 758   if( nativeImage )
 759   {
 760     CreateNativeImageRenderer( nativeImage );
 761     DALI_ASSERT_DEBUG( textures );
 762     mImpl->mRenderer.SetTextures( textures );
 763   }
 764   else
 765   {
 766     // reuse existing code for regular images
 767     CreateRenderer( textures );
 768   }
 769   ApplyImageToSampler( image );
 770 }
 771
 772 void ImageVisual::DoSetOnStage( Actor& actor )
 773 {
 774   if( mImageUrl.IsValid() )
 775   {
 776     InitializeRenderer();
 777   }
 778   else if ( mImage )
 779   {
 780     InitializeRenderer( mImage );
 781   }
 782
 783   if ( !mImpl->mRenderer )
 784   {
 785     return;
 786   }
 787
 788   mPlacementActor = actor;
 789   // Search the Actor tree to find if Layer UI behaviour set.
 790   Layer layer = actor.GetLayer();
 791   if ( layer && layer.GetBehavior() == Layer::LAYER_3D )
 792   {
 793      // Layer 3D set, do not align pixels
 794      mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
 795   }
 796
 797   if( mPixelArea != FULL_TEXTURE_RECT )
 798   {
 799     mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
 800   }
 801
 802   if( mTextureLoading == false )
 803   {
 804     actor.AddRenderer( mImpl->mRenderer );
 805     mPlacementActor.Reset();
 806
 807     // Image loaded and ready to display
 808     ResourceReady();
 809   }
 810 }
 811
 812 void ImageVisual::DoSetOffStage( Actor& actor )
 813 {
 814   // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
 815
 816   //If we own the image then make sure we release it when we go off stage
 817   actor.RemoveRenderer( mImpl->mRenderer);
 818   if( mImageUrl.IsValid() )
 819   {
 820     RemoveTexture( mImageUrl.GetUrl() );
 821     mImage.Reset();
 822   }
 823   mTextureLoading = false;
 824   mImpl->mRenderer.Reset();
 825   mPlacementActor.Reset();
 826 }
 827
 828 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
 829 {
 830   map.Clear();
 831   map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
 832
 833   bool sync = IsSynchronousResourceLoading();
 834   map.Insert( SYNCHRONOUS_LOADING, sync );
 835   if( mImageUrl.IsValid() )
 836   {
 837     map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
 838     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
 839     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
 840   }
 841   else if( mImage )
 842   {
 843     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
 844     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
 845
 846     ResourceImage resourceImage = ResourceImage::DownCast(mImage);
 847     if( resourceImage )
 848     {
 849       map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
 850     }
 851   }
 852
 853   map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
 854   map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
 855
 856   map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
 857   map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
 858   map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
 859
 860   map.Insert( Toolkit::DevelImageVisual::Property::ATLASING, mAttemptAtlasing );
 861   map.Insert( Toolkit::DevelImageVisual::Property::ALPHA_MASK_URL, mAlphaMaskUrl.GetUrl() );
 862 }
 863
 864 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
 865 {
 866   map.Clear();
 867   map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
 868   if( mImageUrl.IsValid() )
 869   {
 870     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
 871     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
 872   }
 873   else if( mImage )
 874   {
 875     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
 876     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
 877   }
 878 }
 879
 880 void ImageVisual::OnSetTransform()
 881 {
 882   if( mImpl->mRenderer )
 883   {
 884     mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 885   }
 886 }
 887
 888 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
 889 {
 890   Shader shader;
 891   if( atlasing )
 892   {
 893     if( defaultTextureWrapping )
 894     {
 895       shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
 896       if( !shader )
 897       {
 898         shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
 899         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 900         factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
 901       }
 902     }
 903     else
 904     {
 905       shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
 906       if( !shader )
 907       {
 908         shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
 909         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 910         factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
 911       }
 912     }
 913   }
 914   else
 915   {
 916     shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
 917     if( !shader )
 918     {
 919       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
 920       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 921       factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
 922     }
 923   }
 924
 925   return shader;
 926 }
 927
 928 void ImageVisual::ApplyImageToSampler( const Image& image )
 929 {
 930   if( image )
 931   {
 932     TextureSet textureSet = mImpl->mRenderer.GetTextures();
 933     DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
 934
 935     TextureSetImage( textureSet, 0u, image );
 936     Sampler sampler = Sampler::New();
 937     sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
 938     textureSet.SetSampler( 0u, sampler );
 939   }
 940 }
 941
 942 // From existing atlas manager
 943 void ImageVisual::UploadCompleted()
 944 {
 945   // Texture has been uploaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
 946   Actor actor = mPlacementActor.GetHandle();
 947   if( actor )
 948   {
 949     actor.AddRenderer( mImpl->mRenderer );
 950
 951     // reset the weak handle so that the renderer only get added to actor once
 952     mPlacementActor.Reset();
 953   }
 954   mTextureLoading = false;
 955 }
 956
 957 // From Texture Manager
 958 void ImageVisual::UploadComplete( bool loadingSuccess, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle )
 959 {
 960   Actor actor = mPlacementActor.GetHandle();
 961   if( actor )
 962   {
 963     if( mImpl->mRenderer )
 964     {
 965       actor.AddRenderer( mImpl->mRenderer );
 966       // reset the weak handle so that the renderer only get added to actor once
 967       mPlacementActor.Reset();
 968
 969       if( loadingSuccess )
 970       {
 971         Sampler sampler = Sampler::New();
 972         sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
 973         textureSet.SetSampler( 0u, sampler );
 974         mImpl->mRenderer.SetTextures(textureSet);
 975       }
 976       else
 977       {
 978         Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
 979
 980         textureSet = TextureSet::New();
 981         mImpl->mRenderer.SetTextures( textureSet );
 982
 983         ApplyImageToSampler( brokenImage );
 984       }
 985       // Image loaded and ready to display
 986       ResourceReady();
 987     }
 988   }
 989   mTextureLoading = false;
 990 }
 991
 992 void ImageVisual::RemoveTexture(const std::string& url)
 993 {
 994   if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
 995   {
 996     mFactoryCache.GetTextureManager().Remove( mTextureId );
 997     mTextureId = TextureManager::INVALID_TEXTURE_ID;
 998   }
 999   else
1000   {
1001     Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
1002     Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
1003     if( index != Property::INVALID_INDEX )
1004     {
1005       Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
1006       atlasRectValue.Get( atlasRect );
1007     }
1008
1009     TextureSet textureSet = mImpl->mRenderer.GetTextures();
1010     mImpl->mRenderer.Reset();
1011
1012     if( index != Property::INVALID_INDEX )
1013     {
1014       mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
1015     }
1016   }
1017 }
1018
1019 } // namespace Internal
1020
1021 } // namespace Toolkit
1022
1023 } // namespace Dali