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

   1 /*
   2  * Copyright (c) 2022 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 "animated-image-visual.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/adaptor-framework/image-loading.h>
  23 #include <dali/integration-api/debug.h>
  24 #include <dali/public-api/rendering/decorated-visual-renderer.h>
  25 #include <memory>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/devel-api/image-loader/image-atlas.h>
  29 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
  30 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
  31 #include <dali-toolkit/internal/visuals/animated-image/fixed-image-cache.h>
  32 #include <dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h>
  33 #include <dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h>
  34 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
  35 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  36 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  37 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
  38 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  39 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
  40 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  41
  42 namespace Dali
  43 {
  44 namespace Toolkit
  45 {
  46 namespace Internal
  47 {
  48 namespace
  49 {
  50 const int CUSTOM_PROPERTY_COUNT(5); // ltr, wrap, pixel area, crop to mask, mask texture ratio
  51
  52 // fitting modes
  53 DALI_ENUM_TO_STRING_TABLE_BEGIN(FITTING_MODE)
  54   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, SHRINK_TO_FIT)
  55   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, SCALE_TO_FILL)
  56   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, FIT_WIDTH)
  57   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, FIT_HEIGHT)
  58   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, DEFAULT)
  59 DALI_ENUM_TO_STRING_TABLE_END(FITTING_MODE)
  60
  61 // sampling modes
  62 DALI_ENUM_TO_STRING_TABLE_BEGIN(SAMPLING_MODE)
  63   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX)
  64   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, NEAREST)
  65   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, LINEAR)
  66   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX_THEN_NEAREST)
  67   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX_THEN_LINEAR)
  68   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, NO_FILTER)
  69   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, DONT_CARE)
  70 DALI_ENUM_TO_STRING_TABLE_END(SAMPLING_MODE)
  71
  72 // stop behavior
  73 DALI_ENUM_TO_STRING_TABLE_BEGIN(STOP_BEHAVIOR)
  74   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, CURRENT_FRAME)
  75   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, FIRST_FRAME)
  76   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::DevelImageVisual::StopBehavior, LAST_FRAME)
  77 DALI_ENUM_TO_STRING_TABLE_END(STOP_BEHAVIOR)
  78
  79 // wrap modes
  80 DALI_ENUM_TO_STRING_TABLE_BEGIN(WRAP_MODE)
  81   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, DEFAULT)
  82   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, CLAMP_TO_EDGE)
  83   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, REPEAT)
  84   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, MIRRORED_REPEAT)
  85 DALI_ENUM_TO_STRING_TABLE_END(WRAP_MODE)
  86
  87 // load policies
  88 DALI_ENUM_TO_STRING_TABLE_BEGIN(LOAD_POLICY)
  89   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, IMMEDIATE)
  90   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, ATTACHED)
  91 DALI_ENUM_TO_STRING_TABLE_END(LOAD_POLICY)
  92
  93 // release policies
  94 DALI_ENUM_TO_STRING_TABLE_BEGIN(RELEASE_POLICY)
  95   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DETACHED)
  96   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DESTROYED)
  97   DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, NEVER)
  98 DALI_ENUM_TO_STRING_TABLE_END(RELEASE_POLICY)
  99
 100 static constexpr uint32_t SINGLE_IMAGE_COUNT = 1u;
 101 static constexpr uint32_t FIRST_FRAME_INDEX  = 0u;
 102 static constexpr uint16_t MINIMUM_CACHESIZE  = 1;
 103 static constexpr Vector4  FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
 104 static constexpr auto     LOOP_FOREVER = -1;
 105 static constexpr auto     FIRST_LOOP   = 0u;
 106
 107 constexpr uint32_t TEXTURE_COUNT_FOR_GPU_ALPHA_MASK = 2u;
 108
 109 #if defined(DEBUG_ENABLED)
 110 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
 111 #endif
 112 } // namespace
 113
 114 /**
 115  * Multi-image  Flow of execution
 116  *
 117  *   | New
 118  *   |   DoSetProperties()
 119  *   |   OnInitialize()
 120  *   |     CreateImageCache()
 121  *   |
 122  *   | DoSetOnScene()
 123  *   |   PrepareTextureSet()
 124  *   |     cache->FirstFrame()
 125  *   |
 126  *   | FrameReady(textureSet)
 127  *   |   StartFirstFrame:
 128  *   |     actor.AddRenderer
 129  *   |     start timer
 130  *   |   mRenderer.SetTextures(textureSet)
 131  *   |
 132  *   | Timer ticks
 133  *   |   DisplayNextFrame()
 134  *   |     if front frame is ready,
 135  *   |       mRenderer.SetTextures( front frame's texture )
 136  *   |     else
 137  *   |       Waiting for frame ready.
 138  *   |
 139  *   | FrameReady(textureSet)
 140  *   |   mRenderer.SetTextures(textureSet)
 141  *   V
 142  *  Time
 143  */
 144
 145 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties)
 146 {
 147   AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory, ImageDimensions()));
 148   visual->InitializeAnimatedImage(imageUrl);
 149   visual->SetProperties(properties);
 150
 151   visual->Initialize();
 152
 153   return visual;
 154 }
 155
 156 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Property::Array& imageUrls, const Property::Map& properties)
 157 {
 158   AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory, ImageDimensions()));
 159   visual->mImageUrls = new ImageCache::UrlList();
 160   visual->mImageUrls->reserve(imageUrls.Count());
 161
 162   for(unsigned int i = 0; i < imageUrls.Count(); ++i)
 163   {
 164     ImageCache::UrlStore urlStore;
 165     urlStore.mTextureId = TextureManager::INVALID_TEXTURE_ID;
 166     urlStore.mUrl       = imageUrls[i].Get<std::string>();
 167     visual->mImageUrls->push_back(urlStore);
 168   }
 169   visual->mFrameCount = imageUrls.Count();
 170   visual->SetProperties(properties);
 171
 172   visual->Initialize();
 173
 174   return visual;
 175 }
 176
 177 AnimatedImageVisualPtr AnimatedImageVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size)
 178 {
 179   AnimatedImageVisualPtr visual(new AnimatedImageVisual(factoryCache, shaderFactory, size));
 180   visual->InitializeAnimatedImage(imageUrl);
 181
 182   visual->Initialize();
 183
 184   return visual;
 185 }
 186
 187 void AnimatedImageVisual::InitializeAnimatedImage(const VisualUrl& imageUrl)
 188 {
 189   mImageUrl             = imageUrl;
 190   mAnimatedImageLoading = AnimatedImageLoading::New(imageUrl.GetUrl(), imageUrl.IsLocalResource());
 191 }
 192
 193 void AnimatedImageVisual::CreateImageCache()
 194 {
 195   DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::CreateImageCache()  batchSize:%d  cacheSize:%d\n", mBatchSize, mCacheSize);
 196
 197   TextureManager& textureManager = mFactoryCache.GetTextureManager();
 198
 199   if(mAnimatedImageLoading)
 200   {
 201     mImageCache = new RollingAnimatedImageCache(textureManager, mDesiredSize, mFittingMode, mSamplingMode, mAnimatedImageLoading, mMaskingData, *this, mCacheSize, mBatchSize, mWrapModeU, mWrapModeV, IsSynchronousLoadingRequired(), mFactoryCache.GetPreMultiplyOnLoad());
 202   }
 203   else if(mImageUrls)
 204   {
 205     // Ensure the batch size and cache size are no bigger than the number of URLs,
 206     // and that the cache is at least as big as the batch size.
 207     uint16_t numUrls   = mImageUrls->size();
 208     uint16_t batchSize = std::max(std::min(mBatchSize, numUrls), MINIMUM_CACHESIZE);
 209     uint16_t cacheSize = std::max(std::min(std::max(batchSize, mCacheSize), numUrls), MINIMUM_CACHESIZE);
 210     if(cacheSize < numUrls)
 211     {
 212       mImageCache = new RollingImageCache(textureManager, mDesiredSize, mFittingMode, mSamplingMode, *mImageUrls, mMaskingData, *this, cacheSize, batchSize, mFrameDelay);
 213     }
 214     else
 215     {
 216       mImageCache = new FixedImageCache(textureManager, mDesiredSize, mFittingMode, mSamplingMode, *mImageUrls, mMaskingData, *this, batchSize, mFrameDelay);
 217     }
 218   }
 219
 220   if(!mImageCache)
 221   {
 222     DALI_LOG_ERROR("mImageCache is null\n");
 223   }
 224 }
 225
 226 AnimatedImageVisual::AnimatedImageVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, ImageDimensions desiredSize)
 227 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::ANIMATED_IMAGE),
 228   mFrameDelayTimer(),
 229   mPlacementActor(),
 230   mImageVisualShaderFactory(shaderFactory),
 231   mPixelArea(FULL_TEXTURE_RECT),
 232   mImageUrl(),
 233   mAnimatedImageLoading(),
 234   mFrameIndexForJumpTo(0),
 235   mCurrentFrameIndex(FIRST_FRAME_INDEX),
 236   mImageUrls(NULL),
 237   mImageCache(NULL),
 238   mCacheSize(2),
 239   mBatchSize(2),
 240   mFrameDelay(100),
 241   mLoopCount(LOOP_FOREVER),
 242   mCurrentLoopIndex(FIRST_LOOP),
 243   mLoadPolicy(Toolkit::ImageVisual::LoadPolicy::ATTACHED),
 244   mReleasePolicy(Toolkit::ImageVisual::ReleasePolicy::DETACHED),
 245   mMaskingData(),
 246   mDesiredSize(desiredSize),
 247   mFrameCount(0),
 248   mImageSize(),
 249   mActionStatus(DevelAnimatedImageVisual::Action::PLAY),
 250   mWrapModeU(WrapMode::DEFAULT),
 251   mWrapModeV(WrapMode::DEFAULT),
 252   mFittingMode(FittingMode::SCALE_TO_FILL),
 253   mSamplingMode(SamplingMode::BOX_THEN_LINEAR),
 254   mStopBehavior(DevelImageVisual::StopBehavior::CURRENT_FRAME),
 255   mStartFirstFrame(false),
 256   mIsJumpTo(false)
 257 {
 258   EnablePreMultipliedAlpha(mFactoryCache.GetPreMultiplyOnLoad());
 259 }
 260
 261 AnimatedImageVisual::~AnimatedImageVisual()
 262 {
 263   // AnimatedImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
 264   // If this is animated image, clear cache. Else if this is single frame image, this is affected be release policy.
 265   if(mFrameCount > SINGLE_IMAGE_COUNT || mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER)
 266   {
 267     mImageCache->ClearCache();
 268   }
 269   delete mImageCache;
 270   delete mImageUrls;
 271 }
 272
 273 void AnimatedImageVisual::GetNaturalSize(Vector2& naturalSize)
 274 {
 275   if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
 276   {
 277     naturalSize.x = mDesiredSize.GetWidth();
 278     naturalSize.y = mDesiredSize.GetHeight();
 279     return;
 280   }
 281
 282   naturalSize = Vector2::ZERO;
 283   if(mImageSize.GetWidth() == 0 && mImageSize.GetHeight() == 0)
 284   {
 285     if(mMaskingData && mMaskingData->mAlphaMaskUrl.IsValid() &&
 286        mMaskingData->mCropToMask)
 287     {
 288       ImageDimensions dimensions = Dali::GetClosestImageSize(mMaskingData->mAlphaMaskUrl.GetUrl());
 289       if(dimensions != ImageDimensions(0, 0))
 290       {
 291         mImageSize    = dimensions;
 292         naturalSize.x = dimensions.GetWidth();
 293         naturalSize.y = dimensions.GetHeight();
 294         return;
 295       }
 296     }
 297
 298     if(mImageUrl.IsValid())
 299     {
 300       mImageSize = mAnimatedImageLoading.GetImageSize();
 301     }
 302     else if(mImageUrls && mImageUrls->size() > 0)
 303     {
 304       mImageSize = Dali::GetClosestImageSize((*mImageUrls)[0].mUrl.GetUrl());
 305     }
 306   }
 307
 308   naturalSize.width  = mImageSize.GetWidth();
 309   naturalSize.height = mImageSize.GetHeight();
 310 }
 311
 312 void AnimatedImageVisual::DoCreatePropertyMap(Property::Map& map) const
 313 {
 314   map.Clear();
 315
 316   bool sync = IsSynchronousLoadingRequired();
 317   map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
 318
 319   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE);
 320
 321   if(mImageUrl.IsValid())
 322   {
 323     map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
 324   }
 325   if(mImageUrls != NULL && !mImageUrls->empty())
 326   {
 327     Property::Array urls;
 328     for(unsigned int i = 0; i < mImageUrls->size(); ++i)
 329     {
 330       urls.Add((*mImageUrls)[i].mUrl.GetUrl());
 331     }
 332     Property::Value value(const_cast<Property::Array&>(urls));
 333     map.Insert(Toolkit::ImageVisual::Property::URL, value);
 334   }
 335
 336   map.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea);
 337   map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU);
 338   map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV);
 339
 340   map.Insert(Toolkit::ImageVisual::Property::BATCH_SIZE, static_cast<int>(mBatchSize));
 341   map.Insert(Toolkit::ImageVisual::Property::CACHE_SIZE, static_cast<int>(mCacheSize));
 342   map.Insert(Toolkit::ImageVisual::Property::FRAME_DELAY, static_cast<int>(mFrameDelay));
 343   map.Insert(Toolkit::DevelImageVisual::Property::LOOP_COUNT, static_cast<int>(mLoopCount));
 344   map.Insert(Toolkit::DevelImageVisual::Property::CURRENT_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>(mImageCache->GetCurrentFrameIndex()) : -1);
 345   map.Insert(Toolkit::DevelImageVisual::Property::TOTAL_FRAME_NUMBER, (mImageCache) ? static_cast<int32_t>((mAnimatedImageLoading) ? mAnimatedImageLoading.GetImageCount() : mImageCache->GetTotalFrameCount()) : -1);
 346
 347   map.Insert(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, mStopBehavior);
 348
 349   if(mMaskingData != nullptr)
 350   {
 351     map.Insert(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl());
 352     map.Insert(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor);
 353     map.Insert(Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask);
 354     map.Insert(Toolkit::DevelImageVisual::Property::MASKING_TYPE, mMaskingData->mPreappliedMasking ? DevelImageVisual::MaskingType::MASKING_ON_LOADING : DevelImageVisual::MaskingType::MASKING_ON_RENDERING);
 355   }
 356
 357   map.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy);
 358   map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
 359   map.Insert(Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode);
 360   map.Insert(Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode);
 361   map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
 362   map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
 363 }
 364
 365 void AnimatedImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
 366 {
 367   map.Clear();
 368   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::ANIMATED_IMAGE);
 369   if(mImageUrl.IsValid())
 370   {
 371     map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
 372     map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
 373   }
 374 }
 375
 376 void AnimatedImageVisual::OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes)
 377 {
 378   // Make not set any action when the resource status is already failed.
 379   if(mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::FAILED)
 380   {
 381     return;
 382   }
 383
 384   // Check if action is valid for this visual type and perform action if possible
 385   switch(actionId)
 386   {
 387     case DevelAnimatedImageVisual::Action::PAUSE:
 388     {
 389       // Pause will be executed on next timer tick
 390       mActionStatus = DevelAnimatedImageVisual::Action::PAUSE;
 391       break;
 392     }
 393     case DevelAnimatedImageVisual::Action::PLAY:
 394     {
 395       if(mFrameDelayTimer && IsOnScene() && mActionStatus != DevelAnimatedImageVisual::Action::PLAY)
 396       {
 397         mFrameDelayTimer.Start();
 398       }
 399       mActionStatus = DevelAnimatedImageVisual::Action::PLAY;
 400       break;
 401     }
 402     case DevelAnimatedImageVisual::Action::STOP:
 403     {
 404       // STOP reset functionality will actually be done in a future change
 405       // Stop will be executed on next timer tick
 406       mActionStatus     = DevelAnimatedImageVisual::Action::STOP;
 407       mCurrentLoopIndex = FIRST_LOOP;
 408       if(IsOnScene())
 409       {
 410         DisplayNextFrame();
 411       }
 412       break;
 413     }
 414     case DevelAnimatedImageVisual::Action::JUMP_TO:
 415     {
 416       int32_t frameNumber;
 417       if(attributes.Get(frameNumber))
 418       {
 419         if(frameNumber < 0 || frameNumber >= static_cast<int32_t>(mFrameCount))
 420         {
 421           DALI_LOG_ERROR("Invalid frame index used.\n");
 422         }
 423         else
 424         {
 425           mIsJumpTo            = true;
 426           mFrameIndexForJumpTo = frameNumber;
 427           if(IsOnScene())
 428           {
 429             DisplayNextFrame();
 430           }
 431         }
 432       }
 433       break;
 434     }
 435   }
 436 }
 437
 438 void AnimatedImageVisual::DoSetProperties(const Property::Map& propertyMap)
 439 {
 440   // url[s] already passed in from constructor
 441   for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
 442   {
 443     KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
 444     if(keyValue.first.type == Property::Key::INDEX)
 445     {
 446       DoSetProperty(keyValue.first.indexKey, keyValue.second);
 447     }
 448     else
 449     {
 450       if(keyValue.first == PIXEL_AREA_UNIFORM_NAME)
 451       {
 452         DoSetProperty(Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second);
 453       }
 454       else if(keyValue.first == IMAGE_WRAP_MODE_U)
 455       {
 456         DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second);
 457       }
 458       else if(keyValue.first == IMAGE_WRAP_MODE_V)
 459       {
 460         DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second);
 461       }
 462       else if(keyValue.first == BATCH_SIZE_NAME)
 463       {
 464         DoSetProperty(Toolkit::ImageVisual::Property::BATCH_SIZE, keyValue.second);
 465       }
 466       else if(keyValue.first == CACHE_SIZE_NAME)
 467       {
 468         DoSetProperty(Toolkit::ImageVisual::Property::CACHE_SIZE, keyValue.second);
 469       }
 470       else if(keyValue.first == FRAME_DELAY_NAME)
 471       {
 472         DoSetProperty(Toolkit::ImageVisual::Property::FRAME_DELAY, keyValue.second);
 473       }
 474       else if(keyValue.first == LOOP_COUNT_NAME)
 475       {
 476         DoSetProperty(Toolkit::DevelImageVisual::Property::LOOP_COUNT, keyValue.second);
 477       }
 478       else if(keyValue.first == STOP_BEHAVIOR_NAME)
 479       {
 480         DoSetProperty(Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR, keyValue.second);
 481       }
 482       else if(keyValue.first == ALPHA_MASK_URL)
 483       {
 484         DoSetProperty(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second);
 485       }
 486       else if(keyValue.first == MASK_CONTENT_SCALE_NAME)
 487       {
 488         DoSetProperty(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second);
 489       }
 490       else if(keyValue.first == CROP_TO_MASK_NAME)
 491       {
 492         DoSetProperty(Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second);
 493       }
 494       else if(keyValue.first == MASKING_TYPE_NAME)
 495       {
 496         DoSetProperty(Toolkit::DevelImageVisual::Property::MASKING_TYPE, keyValue.second);
 497       }
 498       else if(keyValue.first == LOAD_POLICY_NAME)
 499       {
 500         DoSetProperty(Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second);
 501       }
 502       else if(keyValue.first == RELEASE_POLICY_NAME)
 503       {
 504         DoSetProperty(Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second);
 505       }
 506       else if(keyValue.first == SYNCHRONOUS_LOADING)
 507       {
 508         DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
 509       }
 510       else if(keyValue.first == IMAGE_FITTING_MODE)
 511       {
 512         DoSetProperty(Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second);
 513       }
 514       else if(keyValue.first == IMAGE_SAMPLING_MODE)
 515       {
 516         DoSetProperty(Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second);
 517       }
 518       else if(keyValue.first == IMAGE_DESIRED_WIDTH)
 519       {
 520         DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
 521       }
 522       else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
 523       {
 524         DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
 525       }
 526     }
 527   }
 528   // Load image immediately if LOAD_POLICY requires it
 529   if(mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE)
 530   {
 531     PrepareTextureSet();
 532   }
 533 }
 534
 535 void AnimatedImageVisual::DoSetProperty(Property::Index        index,
 536                                         const Property::Value& value)
 537 {
 538   switch(index)
 539   {
 540     case Toolkit::ImageVisual::Property::PIXEL_AREA:
 541     {
 542       value.Get(mPixelArea);
 543       break;
 544     }
 545     case Toolkit::ImageVisual::Property::WRAP_MODE_U:
 546     {
 547       int wrapMode = 0;
 548       if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
 549       {
 550         mWrapModeU = Dali::WrapMode::Type(wrapMode);
 551       }
 552       else
 553       {
 554         mWrapModeU = Dali::WrapMode::Type::DEFAULT;
 555       }
 556       break;
 557     }
 558     case Toolkit::ImageVisual::Property::WRAP_MODE_V:
 559     {
 560       int wrapMode = 0;
 561       if(Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode))
 562       {
 563         mWrapModeV = Dali::WrapMode::Type(wrapMode);
 564       }
 565       else
 566       {
 567         mWrapModeV = Dali::WrapMode::Type::DEFAULT;
 568       }
 569       break;
 570     }
 571
 572     case Toolkit::ImageVisual::Property::BATCH_SIZE:
 573     {
 574       int batchSize;
 575       if(value.Get(batchSize))
 576       {
 577         if(batchSize < 2)
 578         {
 579           DALI_LOG_ERROR("The minimum value of batch size is 2.");
 580         }
 581         else
 582         {
 583           mBatchSize = batchSize;
 584         }
 585       }
 586       break;
 587     }
 588
 589     case Toolkit::ImageVisual::Property::CACHE_SIZE:
 590     {
 591       int cacheSize;
 592       if(value.Get(cacheSize))
 593       {
 594         if(cacheSize < 2)
 595         {
 596           DALI_LOG_ERROR("The minimum value of cache size is 2.");
 597         }
 598         else
 599         {
 600           mCacheSize = cacheSize;
 601         }
 602       }
 603       break;
 604     }
 605
 606     case Toolkit::ImageVisual::Property::FRAME_DELAY:
 607     {
 608       int frameDelay;
 609       if(value.Get(frameDelay))
 610       {
 611         mFrameDelay = frameDelay;
 612         if(mImageCache)
 613         {
 614           mImageCache->SetInterval(static_cast<uint32_t>(mFrameDelay));
 615         }
 616       }
 617       break;
 618     }
 619
 620     case Toolkit::DevelImageVisual::Property::LOOP_COUNT:
 621     {
 622       int loopCount;
 623       if(value.Get(loopCount))
 624       {
 625         mLoopCount = loopCount;
 626       }
 627       break;
 628     }
 629
 630     case Toolkit::DevelImageVisual::Property::STOP_BEHAVIOR:
 631     {
 632       int32_t stopBehavior = mStopBehavior;
 633       if(Scripting::GetEnumerationProperty(value, STOP_BEHAVIOR_TABLE, STOP_BEHAVIOR_TABLE_COUNT, stopBehavior))
 634       {
 635         mStopBehavior = DevelImageVisual::StopBehavior::Type(stopBehavior);
 636       }
 637       break;
 638     }
 639
 640     case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
 641     {
 642       bool sync = false;
 643       value.Get(sync);
 644       if(sync)
 645       {
 646         mImpl->mFlags |= Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 647       }
 648       else
 649       {
 650         mImpl->mFlags &= ~Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 651       }
 652       break;
 653     }
 654
 655     case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
 656     {
 657       std::string alphaUrl = "";
 658       if(value.Get(alphaUrl))
 659       {
 660         AllocateMaskData();
 661         mMaskingData->mAlphaMaskUrl = alphaUrl;
 662       }
 663       break;
 664     }
 665
 666     case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
 667     {
 668       float scale = 1.0f;
 669       if(value.Get(scale))
 670       {
 671         AllocateMaskData();
 672         mMaskingData->mContentScaleFactor = scale;
 673       }
 674       break;
 675     }
 676
 677     case Toolkit::ImageVisual::Property::CROP_TO_MASK:
 678     {
 679       bool crop = false;
 680       if(value.Get(crop))
 681       {
 682         AllocateMaskData();
 683         mMaskingData->mCropToMask = crop;
 684       }
 685       break;
 686     }
 687
 688     case Toolkit::DevelImageVisual::Property::MASKING_TYPE:
 689     {
 690       int maskingType = 0;
 691       if(value.Get(maskingType))
 692       {
 693         AllocateMaskData();
 694         mMaskingData->mPreappliedMasking = Toolkit::DevelImageVisual::MaskingType::Type(maskingType) == Toolkit::DevelImageVisual::MaskingType::MASKING_ON_LOADING ? true : false;
 695       }
 696       break;
 697     }
 698
 699     case Toolkit::ImageVisual::Property::RELEASE_POLICY:
 700     {
 701       int releasePolicy = 0;
 702       Scripting::GetEnumerationProperty(value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy);
 703       mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type(releasePolicy);
 704       break;
 705     }
 706
 707     case Toolkit::ImageVisual::Property::LOAD_POLICY:
 708     {
 709       int loadPolicy = 0;
 710       Scripting::GetEnumerationProperty(value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy);
 711       mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type(loadPolicy);
 712       break;
 713     }
 714
 715     case Toolkit::ImageVisual::Property::FITTING_MODE:
 716     {
 717       int fittingMode = 0;
 718       Scripting::GetEnumerationProperty(value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode);
 719       mFittingMode = Dali::FittingMode::Type(fittingMode);
 720       break;
 721     }
 722
 723     case Toolkit::ImageVisual::Property::SAMPLING_MODE:
 724     {
 725       int samplingMode = 0;
 726       Scripting::GetEnumerationProperty(value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode);
 727       mSamplingMode = Dali::SamplingMode::Type(samplingMode);
 728       break;
 729     }
 730
 731     case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
 732     {
 733       float desiredWidth = 0.0f;
 734       if(value.Get(desiredWidth))
 735       {
 736         mDesiredSize.SetWidth(desiredWidth);
 737       }
 738       else
 739       {
 740         DALI_LOG_ERROR("AnimatedImageVisual: desiredWidth property has incorrect type\n");
 741       }
 742       break;
 743     }
 744
 745     case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
 746     {
 747       float desiredHeight = 0.0f;
 748       if(value.Get(desiredHeight))
 749       {
 750         mDesiredSize.SetHeight(desiredHeight);
 751       }
 752       else
 753       {
 754         DALI_LOG_ERROR("AnimatedImageVisual: desiredHeight property has incorrect type\n");
 755       }
 756       break;
 757     }
 758   }
 759 }
 760
 761 void AnimatedImageVisual::DoSetOnScene(Actor& actor)
 762 {
 763   mStartFirstFrame = true;
 764   mPlacementActor  = actor;
 765   PrepareTextureSet();
 766 }
 767
 768 void AnimatedImageVisual::DoSetOffScene(Actor& actor)
 769 {
 770   DALI_ASSERT_DEBUG((bool)mImpl->mRenderer && "There should always be a renderer whilst on stage");
 771
 772   if(mFrameDelayTimer)
 773   {
 774     mFrameDelayTimer.Stop();
 775     mFrameDelayTimer.Reset();
 776   }
 777
 778   actor.RemoveRenderer(mImpl->mRenderer);
 779   if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
 780   {
 781     mImageCache->ClearCache(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
 782     mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
 783
 784     TextureSet textureSet = TextureSet::New();
 785     mImpl->mRenderer.SetTextures(textureSet);
 786   }
 787
 788   mPlacementActor.Reset();
 789   mStartFirstFrame   = false;
 790   mCurrentFrameIndex = FIRST_FRAME_INDEX;
 791   mCurrentLoopIndex  = FIRST_LOOP;
 792 }
 793
 794 void AnimatedImageVisual::OnSetTransform()
 795 {
 796   if(mImpl->mRenderer)
 797   {
 798     mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 799   }
 800 }
 801
 802 void AnimatedImageVisual::UpdateShader()
 803 {
 804   if(mImpl->mRenderer)
 805   {
 806     Shader shader = GenerateShader();
 807     mImpl->mRenderer.SetShader(shader);
 808   }
 809 }
 810
 811 Shader AnimatedImageVisual::GenerateShader() const
 812 {
 813   bool   defaultWrapMode                 = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
 814   bool   requiredAlphaMaskingOnRendering = (mMaskingData && !mMaskingData->mMaskImageLoadingFailed) ? !mMaskingData->mPreappliedMasking : false;
 815   Shader shader;
 816   shader = mImageVisualShaderFactory.GetShader(
 817     mFactoryCache,
 818     ImageVisualShaderFeature::FeatureBuilder()
 819       .ApplyDefaultTextureWrapMode(defaultWrapMode)
 820       .EnableRoundedCorner(IsRoundedCornerRequired())
 821       .EnableBorderline(IsBorderlineRequired())
 822       .EnableAlphaMaskingOnRendering(requiredAlphaMaskingOnRendering));
 823   return shader;
 824 }
 825
 826 void AnimatedImageVisual::OnInitialize()
 827 {
 828   CreateImageCache();
 829
 830   bool   defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
 831   Shader shader          = GenerateShader();
 832
 833   Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
 834
 835   mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
 836   mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
 837
 838   // Register transform properties
 839   mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 840
 841   if(!defaultWrapMode) // custom wrap mode
 842   {
 843     Vector2 wrapMode(mWrapModeU - WrapMode::CLAMP_TO_EDGE, mWrapModeV - WrapMode::CLAMP_TO_EDGE);
 844     wrapMode.Clamp(Vector2::ZERO, Vector2(2.f, 2.f));
 845     mImpl->mRenderer.RegisterProperty(WRAP_MODE_UNIFORM_NAME, wrapMode);
 846   }
 847
 848   if(mPixelArea != FULL_TEXTURE_RECT)
 849   {
 850     mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
 851   }
 852
 853   if(mMaskingData)
 854   {
 855     mImpl->mRenderer.RegisterProperty(CROP_TO_MASK_NAME, static_cast<float>(mMaskingData->mCropToMask));
 856   }
 857
 858   // Enable PreMultipliedAlpha if it need premultiplied
 859   auto preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader
 860                              ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
 861                              : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
 862   EnablePreMultipliedAlpha(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
 863 }
 864
 865 void AnimatedImageVisual::StartFirstFrame(TextureSet& textureSet, uint32_t firstInterval)
 866 {
 867   DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::StartFirstFrame()\n");
 868
 869   mStartFirstFrame = false;
 870   if(mImpl->mRenderer)
 871   {
 872     mImpl->mRenderer.SetTextures(textureSet);
 873     CheckMaskTexture();
 874
 875     Actor actor = mPlacementActor.GetHandle();
 876     if(actor)
 877     {
 878       actor.AddRenderer(mImpl->mRenderer);
 879       mPlacementActor.Reset();
 880     }
 881   }
 882
 883   if(mImpl->mResourceStatus != Toolkit::Visual::ResourceStatus::FAILED)
 884   {
 885     if(mFrameCount > SINGLE_IMAGE_COUNT)
 886     {
 887       mFrameDelayTimer = Timer::New(firstInterval);
 888       mFrameDelayTimer.TickSignal().Connect(this, &AnimatedImageVisual::DisplayNextFrame);
 889       mFrameDelayTimer.Start();
 890     }
 891
 892     DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::READY)\n");
 893     ResourceReady(Toolkit::Visual::ResourceStatus::READY);
 894   }
 895
 896   mCurrentFrameIndex = FIRST_FRAME_INDEX;
 897 }
 898
 899 void AnimatedImageVisual::PrepareTextureSet()
 900 {
 901   TextureSet textureSet;
 902   if(mImageCache)
 903   {
 904     textureSet = mImageCache->FirstFrame();
 905   }
 906
 907   // Check whether synchronous loading is true or false for the first frame.
 908   if(textureSet)
 909   {
 910     SetImageSize(textureSet);
 911   }
 912 }
 913
 914 void AnimatedImageVisual::SetImageSize(TextureSet& textureSet)
 915 {
 916   if(textureSet)
 917   {
 918     Texture texture = textureSet.GetTexture(0);
 919     if(texture)
 920     {
 921       mImageSize.SetWidth(texture.GetWidth());
 922       mImageSize.SetHeight(texture.GetHeight());
 923     }
 924
 925     if(textureSet.GetTextureCount() > 1u && mMaskingData && mMaskingData->mCropToMask)
 926     {
 927       Texture maskTexture = textureSet.GetTexture(1);
 928       if(maskTexture)
 929       {
 930         mImageSize.SetWidth(std::min(static_cast<uint32_t>(mImageSize.GetWidth() * mMaskingData->mContentScaleFactor), maskTexture.GetWidth()));
 931         mImageSize.SetHeight(std::min(static_cast<uint32_t>(mImageSize.GetHeight() * mMaskingData->mContentScaleFactor), maskTexture.GetHeight()));
 932
 933         float   textureWidth  = std::max(static_cast<float>(texture.GetWidth() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
 934         float   textureHeight = std::max(static_cast<float>(texture.GetHeight() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
 935         Vector2 textureRatio(std::min(static_cast<float>(maskTexture.GetWidth()), textureWidth) / textureWidth,
 936                              std::min(static_cast<float>(maskTexture.GetHeight()), textureHeight) / textureHeight);
 937         mImpl->mRenderer.RegisterProperty(MASK_TEXTURE_RATIO_NAME, textureRatio);
 938       }
 939     }
 940   }
 941 }
 942
 943 void AnimatedImageVisual::FrameReady(TextureSet textureSet, uint32_t interval)
 944 {
 945   // When image visual requested to load new frame to mImageCache and it is failed.
 946   if(!mImageCache || !textureSet)
 947   {
 948     textureSet = SetLoadingFailed();
 949   }
 950   SetImageSize(textureSet);
 951
 952   if(mStartFirstFrame)
 953   {
 954     mFrameCount = mImageCache->GetTotalFrameCount();
 955     StartFirstFrame(textureSet, interval);
 956   }
 957   else
 958   {
 959     if(mImpl->mRenderer)
 960     {
 961       if(mFrameDelayTimer && interval > 0u)
 962       {
 963         mFrameDelayTimer.SetInterval(interval);
 964       }
 965       mImpl->mRenderer.SetTextures(textureSet);
 966       CheckMaskTexture();
 967     }
 968   }
 969 }
 970
 971 bool AnimatedImageVisual::DisplayNextFrame()
 972 {
 973   TextureSet textureSet;
 974   bool       continueTimer = false;
 975
 976   if(mImageCache)
 977   {
 978     uint32_t frameIndex = mImageCache->GetCurrentFrameIndex();
 979
 980     if(mIsJumpTo)
 981     {
 982       mIsJumpTo  = false;
 983       frameIndex = mFrameIndexForJumpTo;
 984     }
 985     else if(mActionStatus == DevelAnimatedImageVisual::Action::PAUSE)
 986     {
 987       return false;
 988     }
 989     else if(mActionStatus == DevelAnimatedImageVisual::Action::STOP)
 990     {
 991       mCurrentLoopIndex = FIRST_LOOP;
 992       if(mStopBehavior == DevelImageVisual::StopBehavior::FIRST_FRAME)
 993       {
 994         frameIndex = FIRST_FRAME_INDEX;
 995       }
 996       else if(mStopBehavior == DevelImageVisual::StopBehavior::LAST_FRAME)
 997       {
 998         frameIndex = mFrameCount - 1;
 999       }
1000       else
1001       {
1002         return false; // Do not draw already rendered scene twice.
1003       }
1004     }
1005     else
1006     {
1007       if(mFrameCount > SINGLE_IMAGE_COUNT)
1008       {
1009         frameIndex++;
1010         if(frameIndex >= mFrameCount)
1011         {
1012           frameIndex = FIRST_FRAME_INDEX;
1013           ++mCurrentLoopIndex;
1014         }
1015
1016         if(mLoopCount >= 0 && mCurrentLoopIndex >= mLoopCount)
1017         {
1018           // This will stop timer
1019           mActionStatus = DevelAnimatedImageVisual::Action::STOP;
1020           return DisplayNextFrame();
1021         }
1022       }
1023     }
1024
1025     DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "AnimatedImageVisual::DisplayNextFrame(this:%p) CurrentFrameIndex:%d\n", this, frameIndex);
1026
1027     textureSet = mImageCache->Frame(frameIndex);
1028
1029     if(textureSet)
1030     {
1031       SetImageSize(textureSet);
1032       if(mImpl->mRenderer)
1033       {
1034         mImpl->mRenderer.SetTextures(textureSet);
1035         CheckMaskTexture();
1036       }
1037       mFrameDelayTimer.SetInterval(mImageCache->GetFrameInterval(frameIndex));
1038     }
1039
1040     mCurrentFrameIndex = frameIndex;
1041     continueTimer      = (mActionStatus == DevelAnimatedImageVisual::Action::PLAY && textureSet) ? true : false;
1042   }
1043
1044   return continueTimer;
1045 }
1046
1047 TextureSet AnimatedImageVisual::SetLoadingFailed()
1048 {
1049   DALI_LOG_INFO(gAnimImgLogFilter, Debug::Concise, "ResourceReady(ResourceStatus::FAILED)\n");
1050   ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
1051
1052   Actor   actor     = mPlacementActor.GetHandle();
1053   Vector2 imageSize = Vector2::ZERO;
1054   if(actor)
1055   {
1056     imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
1057   }
1058   mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
1059   TextureSet textureSet = mImpl->mRenderer.GetTextures();
1060
1061   if(mFrameDelayTimer)
1062   {
1063     mFrameDelayTimer.Stop();
1064     mFrameDelayTimer.Reset();
1065   }
1066
1067   SetImageSize(textureSet);
1068
1069   return textureSet;
1070 }
1071
1072 void AnimatedImageVisual::AllocateMaskData()
1073 {
1074   if(!mMaskingData)
1075   {
1076     mMaskingData.reset(new TextureManager::MaskingData());
1077   }
1078 }
1079
1080 void AnimatedImageVisual::CheckMaskTexture()
1081 {
1082   if(mMaskingData && !mMaskingData->mPreappliedMasking)
1083   {
1084     bool       maskLoadFailed = true;
1085     TextureSet textures       = mImpl->mRenderer.GetTextures();
1086     if(textures && textures.GetTextureCount() >= TEXTURE_COUNT_FOR_GPU_ALPHA_MASK)
1087     {
1088       maskLoadFailed = false;
1089     }
1090     if(mMaskingData->mMaskImageLoadingFailed != maskLoadFailed)
1091     {
1092       mMaskingData->mMaskImageLoadingFailed = maskLoadFailed;
1093       UpdateShader();
1094     }
1095   }
1096 }
1097
1098 } // namespace Internal
1099
1100 } // namespace Toolkit
1101
1102 } // namespace Dali