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

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