2 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include "rolling-gif-image-cache.h"
23 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
24 #include <dali-toolkit/internal/visuals/image-atlas-manager.h> // For ImageAtlasManagerPtr
25 #include <dali/integration-api/debug.h>
29 #if defined(DEBUG_ENABLED)
30 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
34 std::ostringstream oss; \
35 oss<<"Size:"<<mQueue.Count()<<" [ "; \
36 for(std::size_t _i=0; _i<mQueue.Count(); ++_i) \
39 "={ frm#: " << mQueue[_i].mFrameNumber << \
40 " tex: " << mImageUrls[mQueue[_i].mFrameNumber].mTextureId<<"}, "; \
42 oss<<" ]"<<std::endl; \
43 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"%s",oss.str().c_str()); \
50 const bool ENABLE_ORIENTATION_CORRECTION( true );
61 RollingGifImageCache::RollingGifImageCache(
62 TextureManager& textureManager, GifLoading& gifLoading, uint32_t frameCount, ImageCache::FrameReadyObserver& observer,
63 uint16_t cacheSize, uint16_t batchSize )
64 : ImageCache( textureManager, observer, batchSize ),
65 mGifLoading( gifLoading ),
66 mFrameCount( frameCount ),
68 mCacheSize( cacheSize ),
71 mImageUrls.resize( mFrameCount );
75 RollingGifImageCache::~RollingGifImageCache()
77 if( mTextureManagerAlive )
79 while( !mQueue.IsEmpty() )
81 ImageFrame imageFrame = mQueue.PopFront();
82 Dali::Toolkit::TextureManager::RemoveTexture( mImageUrls[ imageFrame.mFrameNumber ].mUrl );
87 TextureSet RollingGifImageCache::Frame( uint32_t frameIndex )
89 // If a frame of frameIndex is not loaded, clear the queue and remove all loaded textures.
90 if( mImageUrls[ frameIndex ].mTextureId == TextureManager::INVALID_TEXTURE_ID )
92 mFrameIndex = frameIndex;
93 while( !mQueue.IsEmpty() )
95 ImageFrame imageFrame = mQueue.PopFront();
96 Dali::Toolkit::TextureManager::RemoveTexture( mImageUrls[ imageFrame.mFrameNumber ].mUrl );
97 mImageUrls[ imageFrame.mFrameNumber ].mTextureId = TextureManager::INVALID_TEXTURE_ID;
101 // If the frame is already loaded, remove previous frames of the frame in the queue
102 // and load new frames amount of removed frames.
105 bool popExist = false;
106 while( !mQueue.IsEmpty() && mQueue.Front().mFrameNumber != frameIndex )
108 ImageFrame imageFrame = mQueue.PopFront();
109 Dali::Toolkit::TextureManager::RemoveTexture( mImageUrls[ imageFrame.mFrameNumber ].mUrl );
110 mImageUrls[ imageFrame.mFrameNumber ].mTextureId = TextureManager::INVALID_TEXTURE_ID;
115 mFrameIndex = ( mQueue.Back().mFrameNumber + 1 ) % mFrameCount;
120 return GetFrontTextureSet();
123 TextureSet RollingGifImageCache::FirstFrame()
128 TextureSet RollingGifImageCache::NextFrame()
130 ImageFrame imageFrame = mQueue.PopFront();
131 Dali::Toolkit::TextureManager::RemoveTexture( mImageUrls[ imageFrame.mFrameNumber ].mUrl );
132 mImageUrls[ imageFrame.mFrameNumber ].mTextureId = TextureManager::INVALID_TEXTURE_ID;
136 return GetFrontTextureSet();
139 bool RollingGifImageCache::IsFrontReady() const
141 return ( !mQueue.IsEmpty() );
144 void RollingGifImageCache::LoadBatch()
146 // Try and load up to mBatchSize images, until the cache is filled.
147 // Once the cache is filled, as frames progress, the old frame is
148 // removed, and another frame is loaded
150 std::vector<Dali::PixelData> pixelDataList;
152 // Get the smallest number of frames we need to load
153 int batchSize = std::min( std::size_t(mBatchSize), mCacheSize - mQueue.Count() );
154 DALI_LOG_INFO( gAnimImgLogFilter, Debug::Concise, "RollingGifImageCache::LoadBatch() mFrameIndex:%d batchSize:%d\n", mFrameIndex, batchSize );
156 if( mGifLoading.LoadNextNFrames( mFrameIndex, batchSize, pixelDataList) )
158 unsigned int pixelDataListCount = pixelDataList.size();
160 for( unsigned int i = 0; i < pixelDataListCount && !mQueue.IsFull(); ++i )
162 ImageFrame imageFrame;
164 // create the texture for uploading the pixel data
165 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D,
166 pixelDataList[i].GetPixelFormat(),
167 pixelDataList[i].GetWidth(),
168 pixelDataList[i].GetHeight() );
170 texture.Upload( pixelDataList[i] );
172 mImageUrls[ mUrlIndex ].mUrl = Dali::Toolkit::TextureManager::AddTexture(texture);
173 imageFrame.mFrameNumber = mUrlIndex;
176 mUrlIndex %= mImageUrls.size();
178 mQueue.PushBack( imageFrame );
180 bool synchronousLoading = false;
181 bool atlasingStatus = false;
182 bool loadingStatus = false;
183 TextureManager::MaskingDataPointer maskInfo = nullptr;
184 AtlasUploadObserver* atlasObserver = nullptr;
185 ImageAtlasManagerPtr imageAtlasManager = nullptr;
187 Dali::ImageDimensions textureRectSize;
188 auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
190 mTextureManager.LoadTexture(
191 mImageUrls[ imageFrame.mFrameNumber ].mUrl, ImageDimensions(), FittingMode::SCALE_TO_FILL,
192 SamplingMode::BOX_THEN_LINEAR, maskInfo,
193 synchronousLoading, mImageUrls[ imageFrame.mFrameNumber ].mTextureId, textureRect, textureRectSize,
194 atlasingStatus, loadingStatus, Dali::WrapMode::Type::DEFAULT,
195 Dali::WrapMode::Type::DEFAULT, NULL,
196 atlasObserver, imageAtlasManager, ENABLE_ORIENTATION_CORRECTION, TextureManager::ReloadPolicy::CACHED, preMultiply );
199 mFrameIndex += batchSize;
200 mFrameIndex %= mFrameCount;
206 TextureSet RollingGifImageCache::GetFrontTextureSet() const
208 DALI_LOG_INFO( gAnimImgLogFilter, Debug::Concise, "RollingGifImageCache::GetFrontTextureSet() FrameNumber:%d\n", mQueue[ 0 ].mFrameNumber );
210 TextureManager::TextureId textureId = GetCachedTextureId( 0 );
211 return mTextureManager.GetTextureSet( textureId );
214 TextureManager::TextureId RollingGifImageCache::GetCachedTextureId( int index ) const
216 return mImageUrls[ mQueue[ index ].mFrameNumber ].mTextureId;
219 } //namespace Internal
220 } //namespace Toolkit