dali-toolkit/internal/visuals/animated-image/fixed-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/fixed-image-cache.h>
  19
  20 // INTERNAL HEADERS
  21 #include <dali-toolkit/internal/visuals/image-atlas-manager.h> // For ImageAtlasManagerPtr
  22
  23 namespace Dali
  24 {
  25 namespace Toolkit
  26 {
  27 namespace Internal
  28 {
  29
  30 namespace
  31 {
  32 const bool ENABLE_ORIENTATION_CORRECTION( true );
  33 } // namespace
  34
  35 FixedImageCache::FixedImageCache(
  36   TextureManager& textureManager, UrlList& urlList, ImageCache::FrameReadyObserver& observer,
  37   unsigned int batchSize )
  38 : ImageCache( textureManager, observer, batchSize ),
  39   mImageUrls( urlList ),
  40   mFront(0u)
  41 {
  42   mReadyFlags.reserve( mImageUrls.size() );
  43   LoadBatch();
  44 }
  45
  46 FixedImageCache::~FixedImageCache()
  47 {
  48   if( mTextureManagerAlive )
  49   {
  50     for( std::size_t i = 0; i < mImageUrls.size() ; ++i )
  51     {
  52       mTextureManager.Remove( mImageUrls[i].mTextureId, this );
  53     }
  54   }
  55 }
  56
  57 TextureSet FixedImageCache::Frame( uint32_t frameIndex )
  58 {
  59   while( frameIndex > mFront )
  60   {
  61     ++mFront;
  62     if( mFront >= mImageUrls.size() )
  63     {
  64       mFront = 0;
  65     }
  66     LoadBatch();
  67   }
  68
  69   mFront = frameIndex;
  70
  71   TextureSet textureSet;
  72   if( IsFrontReady() == true )
  73   {
  74     textureSet = GetFrontTextureSet();
  75   }
  76   else
  77   {
  78     mWaitingForReadyFrame = true;
  79   }
  80
  81   return textureSet;
  82 }
  83
  84 TextureSet FixedImageCache::FirstFrame()
  85 {
  86   TextureSet textureSet = GetFrontTextureSet();
  87
  88   if( ! textureSet )
  89   {
  90     mWaitingForReadyFrame = true;
  91   }
  92
  93   return textureSet;
  94 }
  95
  96 TextureSet FixedImageCache::NextFrame()
  97 {
  98   TextureSet textureSet = Frame((mFront + 1) % mImageUrls.size());
  99
 100   return textureSet;
 101 }
 102
 103 uint32_t FixedImageCache::GetFrameInterval( uint32_t frameIndex ) const
 104 {
 105   return 0u;
 106 }
 107
 108 int32_t FixedImageCache::GetCurrentFrameIndex() const
 109 {
 110   return static_cast<int32_t>(mFront);
 111 }
 112
 113 bool FixedImageCache::IsFrontReady() const
 114 {
 115   return ( mReadyFlags.size() > 0 && mReadyFlags[mFront] == true );
 116 }
 117
 118 void FixedImageCache::LoadBatch()
 119 {
 120   // Try and load up to mBatchSize images, until the cache is filled.
 121   // Once the cache is filled, mUrlIndex exceeds mImageUrls size and
 122   // no more images are loaded.
 123   bool frontFrameReady = IsFrontReady();
 124
 125   for( unsigned int i=0; i< mBatchSize && mUrlIndex < mImageUrls.size(); ++i )
 126   {
 127     std::string& url = mImageUrls[ mUrlIndex ].mUrl;
 128
 129     mReadyFlags.push_back(false);
 130
 131     // Note, if the image is already loaded, then UploadComplete will get called
 132     // from within this method. This means it won't yet have a texture id, so we
 133     // need to account for this inside the UploadComplete method using mRequestingLoad.
 134     mRequestingLoad = true;
 135
 136     bool synchronousLoading = false;
 137     bool atlasingStatus = false;
 138     bool loadingStatus = false;
 139     TextureManager::MaskingDataPointer maskInfo = nullptr;
 140     AtlasUploadObserver* atlasObserver = nullptr;
 141     ImageAtlasManagerPtr imageAtlasManager = nullptr;
 142     Vector4 textureRect;
 143     Dali::ImageDimensions textureRectSize;
 144     auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
 145
 146     mTextureManager.LoadTexture(
 147       url, ImageDimensions(), FittingMode::SCALE_TO_FILL,
 148       SamplingMode::BOX_THEN_LINEAR, maskInfo,
 149       synchronousLoading, mImageUrls[ mUrlIndex ].mTextureId, textureRect, textureRectSize,
 150       atlasingStatus, loadingStatus, Dali::WrapMode::Type::DEFAULT,
 151       Dali::WrapMode::Type::DEFAULT, this,
 152       atlasObserver, imageAtlasManager, ENABLE_ORIENTATION_CORRECTION, TextureManager::ReloadPolicy::CACHED,
 153       preMultiply );
 154
 155     if( loadingStatus == false )  // not loading, means it's already ready.
 156     {
 157       SetImageFrameReady( mImageUrls[ mUrlIndex ].mTextureId );
 158     }
 159     mRequestingLoad = false;
 160     ++mUrlIndex;
 161   }
 162
 163   CheckFrontFrame( frontFrameReady );
 164 }
 165
 166 void FixedImageCache::SetImageFrameReady( TextureManager::TextureId textureId )
 167 {
 168   for( std::size_t i = 0; i < mImageUrls.size() ; ++i )
 169   {
 170     if( mImageUrls[i].mTextureId == textureId )
 171     {
 172       mReadyFlags[i] = true;
 173       break;
 174     }
 175   }
 176 }
 177
 178 TextureSet FixedImageCache::GetFrontTextureSet() const
 179 {
 180   return mTextureManager.GetTextureSet( mImageUrls[mFront].mTextureId );
 181 }
 182
 183 void FixedImageCache::CheckFrontFrame( bool wasReady )
 184 {
 185   if( mWaitingForReadyFrame && wasReady == false && IsFrontReady() )
 186   {
 187     mWaitingForReadyFrame = false;
 188     mObserver.FrameReady( GetFrontTextureSet() );
 189   }
 190 }
 191
 192 void FixedImageCache::UploadComplete(
 193   bool           loadSuccess,
 194   int32_t        textureId,
 195   TextureSet     textureSet,
 196   bool           useAtlasing,
 197   const Vector4& atlasRect,
 198   bool           preMultiplied)
 199 {
 200   bool frontFrameReady = IsFrontReady();
 201
 202   if( ! mRequestingLoad )
 203   {
 204     SetImageFrameReady( textureId );
 205
 206     CheckFrontFrame( frontFrameReady );
 207   }
 208   else
 209   {
 210     // UploadComplete has been called from within RequestLoad. TextureManager must
 211     // therefore already have the texture cached, so make the texture ready.
 212     // (Use the last texture, as the texture id hasn't been assigned yet)
 213     mReadyFlags.back() = true;
 214   }
 215 }
 216
 217 void FixedImageCache::LoadComplete(
 218   bool loadSuccess,
 219   Devel::PixelBuffer pixelBuffer,
 220   const VisualUrl& url,
 221   bool preMultiplied )
 222 {
 223   // LoadComplete is called if this TextureUploadObserver requested to load
 224   // an image that will be returned as a type of PixelBuffer by using a method
 225   // TextureManager::LoadPixelBuffer.
 226 }
 227
 228 } //namespace Internal
 229 } //namespace Toolkit
 230 } //namespace Dali