dali-toolkit/internal/visuals/animated-image/rolling-image-cache.cpp

   1 /*
   2  * Copyright (c) 2020 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 // CLASS HEADER
  18 #include <dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h>
  19
  20 // INTERNAL HEADERS
  21 #include <dali-toolkit/internal/visuals/image-atlas-manager.h> // For ImageAtlasManagerPtr
  22 #include <dali/integration-api/debug.h>
  23
  24 // EXTERNAL HEADERS
  25
  26 namespace
  27 {
  28 #if defined(DEBUG_ENABLED)
  29 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
  30
  31 #define LOG_CACHE                                                       \
  32   {                                                                     \
  33     std::ostringstream oss;                                             \
  34     oss<<"Size:"<<mQueue.Count()<<" [ ";                                \
  35     for(std::size_t _i=0; _i<mQueue.Count(); ++_i)                      \
  36     {                                                                   \
  37       oss<<_i<<                                                         \
  38         "={ tex:"<<mImageUrls[mQueue[_i].mUrlIndex].mTextureId<<        \
  39         " urlId:"<<mQueue[_i].mUrlIndex<<                               \
  40         " rdy:"<<(mQueue[_i].mReady?"T":"F")<< "}, ";                   \
  41     }                                                                   \
  42     oss<<" ]"<<std::endl;                                               \
  43     DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"%s",oss.str().c_str()); \
  44   }
  45
  46 #else
  47   #define LOG_CACHE
  48 #endif
  49
  50 const bool ENABLE_ORIENTATION_CORRECTION( true );
  51
  52 }
  53
  54 namespace Dali
  55 {
  56 namespace Toolkit
  57 {
  58 namespace Internal
  59 {
  60
  61 RollingImageCache::RollingImageCache(
  62   TextureManager& textureManager, UrlList& urlList, ImageCache::FrameReadyObserver& observer,
  63   uint16_t cacheSize, uint16_t batchSize )
  64 : ImageCache( textureManager, observer, batchSize ),
  65   mImageUrls( urlList ),
  66   mQueue( cacheSize )
  67 {
  68   LoadBatch();
  69 }
  70
  71 RollingImageCache::~RollingImageCache()
  72 {
  73   if( mTextureManagerAlive )
  74   {
  75     while( !mQueue.IsEmpty() )
  76     {
  77       ImageFrame imageFrame = mQueue.PopFront();
  78       mTextureManager.Remove( mImageUrls[ imageFrame.mUrlIndex ].mTextureId, this );
  79     }
  80   }
  81 }
  82
  83 TextureSet RollingImageCache::Frame( uint32_t frameIndex )
  84 {
  85   // If a frame of frameIndex is not loaded, clear the queue and remove all loaded textures.
  86   if( mImageUrls[ frameIndex ].mTextureId == TextureManager::INVALID_TEXTURE_ID )
  87   {
  88     mUrlIndex = frameIndex;
  89     while( !mQueue.IsEmpty() )
  90     {
  91       ImageFrame imageFrame = mQueue.PopFront();
  92       mTextureManager.Remove( mImageUrls[ imageFrame.mUrlIndex ].mTextureId, this );
  93       mImageUrls[ imageFrame.mUrlIndex ].mTextureId = TextureManager::INVALID_TEXTURE_ID;
  94     }
  95     LoadBatch();
  96   }
  97   // If the frame is already loaded, remove previous frames of the frame in the queue
  98   // and load new frames amount of removed frames.
  99   else
 100   {
 101     bool popExist = false;
 102     while( !mQueue.IsEmpty() && mQueue.Front().mUrlIndex != frameIndex )
 103     {
 104       ImageFrame imageFrame = mQueue.PopFront();
 105       mTextureManager.Remove( mImageUrls[ imageFrame.mUrlIndex ].mTextureId, this );
 106       mImageUrls[ imageFrame.mUrlIndex ].mTextureId = TextureManager::INVALID_TEXTURE_ID;
 107       popExist = true;
 108     }
 109     if( popExist )
 110     {
 111       mUrlIndex = ( mQueue.Back().mUrlIndex + 1 ) % mImageUrls.size();
 112       LoadBatch();
 113     }
 114   }
 115
 116   TextureSet textureSet;
 117   if( IsFrontReady() == true )
 118   {
 119     textureSet = GetFrontTextureSet();
 120   }
 121   else
 122   {
 123     mWaitingForReadyFrame = true;
 124   }
 125
 126   return textureSet;
 127 }
 128
 129 TextureSet RollingImageCache::FirstFrame()
 130 {
 131   return Frame( 0u );
 132 }
 133
 134 TextureSet RollingImageCache::NextFrame()
 135 {
 136   TextureSet textureSet;
 137
 138   ImageFrame imageFrame = mQueue.PopFront();
 139   mTextureManager.Remove( mImageUrls[ imageFrame.mUrlIndex ].mTextureId, this );
 140   mImageUrls[ imageFrame.mUrlIndex ].mTextureId = TextureManager::INVALID_TEXTURE_ID;
 141
 142   LoadBatch();
 143
 144   if( IsFrontReady() == true )
 145   {
 146     textureSet = GetFrontTextureSet();
 147   }
 148   else
 149   {
 150     mWaitingForReadyFrame = true;
 151   }
 152
 153   return textureSet;
 154 }
 155
 156 bool RollingImageCache::IsFrontReady() const
 157 {
 158   return ( !mQueue.IsEmpty() && mQueue.Front().mReady );
 159 }
 160
 161 void RollingImageCache::LoadBatch()
 162 {
 163   // Try and load up to mBatchSize images, until the cache is filled.
 164   // Once the cache is filled, as frames progress, the old frame is
 165   // cleared, but not erased, and another image is loaded
 166   bool frontFrameReady = IsFrontReady();
 167
 168   for( unsigned int i=0; i< mBatchSize && !mQueue.IsFull(); ++i )
 169   {
 170     ImageFrame imageFrame;
 171
 172     std::string& url = mImageUrls[ mUrlIndex ].mUrl;
 173     imageFrame.mUrlIndex = mUrlIndex;
 174     imageFrame.mReady = false;
 175
 176     ++mUrlIndex;
 177     mUrlIndex %= mImageUrls.size();
 178
 179     mQueue.PushBack( imageFrame );
 180
 181     // Note, if the image is already loaded, then UploadComplete will get called
 182     // from within this method. This means it won't yet have a texture id, so we
 183     // need to account for this inside the UploadComplete method using mRequestingLoad.
 184     mRequestingLoad = true;
 185
 186     bool synchronousLoading = false;
 187     bool atlasingStatus = false;
 188     bool loadingStatus = false;
 189     TextureManager::MaskingDataPointer maskInfo = nullptr;
 190     AtlasUploadObserver* atlasObserver = nullptr;
 191     ImageAtlasManagerPtr imageAtlasManager = nullptr;
 192     Vector4 textureRect;
 193     Dali::ImageDimensions textureRectSize;
 194     auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
 195
 196     mTextureManager.LoadTexture(
 197       url, ImageDimensions(), FittingMode::SCALE_TO_FILL,
 198       SamplingMode::BOX_THEN_LINEAR, maskInfo,
 199       synchronousLoading, mImageUrls[ imageFrame.mUrlIndex ].mTextureId, textureRect, textureRectSize,
 200       atlasingStatus, loadingStatus, Dali::WrapMode::Type::DEFAULT,
 201       Dali::WrapMode::Type::DEFAULT, this,
 202       atlasObserver, imageAtlasManager, ENABLE_ORIENTATION_CORRECTION, TextureManager::ReloadPolicy::CACHED,
 203       preMultiply );
 204
 205     mRequestingLoad = false;
 206   }
 207
 208   CheckFrontFrame( frontFrameReady );
 209 }
 210
 211 void RollingImageCache::SetImageFrameReady( TextureManager::TextureId textureId )
 212 {
 213   for( std::size_t i = 0; i < mQueue.Count() ; ++i )
 214   {
 215     if( GetCachedTextureId(i) == textureId )
 216     {
 217       mQueue[i].mReady = true;
 218       break;
 219     }
 220   }
 221 }
 222
 223 TextureSet RollingImageCache::GetFrontTextureSet() const
 224 {
 225   TextureManager::TextureId textureId = GetCachedTextureId( 0 );
 226   return mTextureManager.GetTextureSet( textureId );
 227 }
 228
 229 TextureManager::TextureId RollingImageCache::GetCachedTextureId( int index ) const
 230 {
 231   return mImageUrls[ mQueue[ index ].mUrlIndex ].mTextureId;
 232 }
 233
 234 void RollingImageCache::CheckFrontFrame( bool wasReady )
 235 {
 236   if( mWaitingForReadyFrame && wasReady == false && IsFrontReady() )
 237   {
 238     mWaitingForReadyFrame = false;
 239     mObserver.FrameReady( GetFrontTextureSet() );
 240   }
 241 }
 242
 243 void RollingImageCache::UploadComplete(
 244   bool           loadSuccess,
 245   int32_t        textureId,
 246   TextureSet     textureSet,
 247   bool           useAtlasing,
 248   const Vector4& atlasRect,
 249   bool           preMultiplied )
 250 {
 251   DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::UploadComplete(textureId:%d) start\n", textureId);
 252   LOG_CACHE;
 253
 254   bool frontFrameReady = IsFrontReady();
 255
 256   if( ! mRequestingLoad )
 257   {
 258     SetImageFrameReady( textureId );
 259
 260     CheckFrontFrame( frontFrameReady );
 261   }
 262   else
 263   {
 264     // UploadComplete has been called from within RequestLoad. TextureManager must
 265     // therefore already have the texture cached, so make the texture ready.
 266     // (Use the last texture, as the texture id hasn't been assigned yet)
 267     mQueue.Back().mReady = true;
 268   }
 269
 270   LOG_CACHE;
 271 }
 272
 273 void RollingImageCache::LoadComplete(
 274   bool loadSuccess,
 275   Devel::PixelBuffer pixelBuffer,
 276   const VisualUrl& url,
 277   bool preMultiplied )
 278 {
 279   // LoadComplete is called if this TextureUploadObserver requested to load
 280   // an image that will be returned as a type of PixelBuffer by using a method
 281   // TextureManager::LoadPixelBuffer.
 282 }
 283
 284 } //namespace Internal
 285 } //namespace Toolkit
 286 } //namespace Dali