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 <dali-toolkit/internal/visuals/animated-image/rolling-image-cache.h>
21 #include <dali-toolkit/internal/visuals/image-atlas-manager.h> // For ImageAtlasManagerPtr
22 #include <dali/integration-api/debug.h>
28 #if defined(DEBUG_ENABLED)
29 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
33 std::ostringstream oss; \
34 oss<<"Size:"<<mQueue.Count()<<" [ "; \
35 for(std::size_t _i=0; _i<mQueue.Count(); ++_i) \
38 "={ tex:"<<mImageUrls[mQueue[_i].mUrlIndex].mTextureId<< \
39 " urlId:"<<mQueue[_i].mUrlIndex<< \
40 " rdy:"<<(mQueue[_i].mReady?"T":"F")<< "}, "; \
42 oss<<" ]"<<std::endl; \
43 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"%s",oss.str().c_str()); \
50 const bool ENABLE_ORIENTATION_CORRECTION( true );
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 ),
71 RollingImageCache::~RollingImageCache()
73 if( mTextureManagerAlive )
75 while( !mQueue.IsEmpty() )
77 ImageFrame imageFrame = mQueue.PopFront();
78 mTextureManager.Remove( mImageUrls[ imageFrame.mUrlIndex ].mTextureId, this );
83 TextureSet RollingImageCache::Frame( uint32_t frameIndex )
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 )
88 mUrlIndex = frameIndex;
89 while( !mQueue.IsEmpty() )
91 ImageFrame imageFrame = mQueue.PopFront();
92 mTextureManager.Remove( mImageUrls[ imageFrame.mUrlIndex ].mTextureId, this );
93 mImageUrls[ imageFrame.mUrlIndex ].mTextureId = TextureManager::INVALID_TEXTURE_ID;
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.
101 bool popExist = false;
102 while( !mQueue.IsEmpty() && mQueue.Front().mUrlIndex != frameIndex )
104 ImageFrame imageFrame = mQueue.PopFront();
105 mTextureManager.Remove( mImageUrls[ imageFrame.mUrlIndex ].mTextureId, this );
106 mImageUrls[ imageFrame.mUrlIndex ].mTextureId = TextureManager::INVALID_TEXTURE_ID;
111 mUrlIndex = ( mQueue.Back().mUrlIndex + 1 ) % mImageUrls.size();
116 TextureSet textureSet;
117 if( IsFrontReady() == true )
119 textureSet = GetFrontTextureSet();
123 mWaitingForReadyFrame = true;
129 TextureSet RollingImageCache::FirstFrame()
134 uint32_t RollingImageCache::GetFrameInterval( uint32_t frameIndex )
139 bool RollingImageCache::IsFrontReady() const
141 return ( !mQueue.IsEmpty() && mQueue.Front().mReady );
144 void RollingImageCache::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 // cleared, but not erased, and another image is loaded
149 bool frontFrameReady = IsFrontReady();
151 for( unsigned int i=0; i< mBatchSize && !mQueue.IsFull(); ++i )
153 ImageFrame imageFrame;
155 std::string& url = mImageUrls[ mUrlIndex ].mUrl;
156 imageFrame.mUrlIndex = mUrlIndex;
157 imageFrame.mReady = false;
160 mUrlIndex %= mImageUrls.size();
162 mQueue.PushBack( imageFrame );
164 // Note, if the image is already loaded, then UploadComplete will get called
165 // from within this method. This means it won't yet have a texture id, so we
166 // need to account for this inside the UploadComplete method using mRequestingLoad.
167 mRequestingLoad = true;
169 bool synchronousLoading = false;
170 bool atlasingStatus = false;
171 bool loadingStatus = false;
172 TextureManager::MaskingDataPointer maskInfo = nullptr;
173 AtlasUploadObserver* atlasObserver = nullptr;
174 ImageAtlasManagerPtr imageAtlasManager = nullptr;
176 Dali::ImageDimensions textureRectSize;
177 auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
179 mTextureManager.LoadTexture(
180 url, ImageDimensions(), FittingMode::SCALE_TO_FILL,
181 SamplingMode::BOX_THEN_LINEAR, maskInfo,
182 synchronousLoading, mImageUrls[ imageFrame.mUrlIndex ].mTextureId, textureRect, textureRectSize,
183 atlasingStatus, loadingStatus, Dali::WrapMode::Type::DEFAULT,
184 Dali::WrapMode::Type::DEFAULT, this,
185 atlasObserver, imageAtlasManager, ENABLE_ORIENTATION_CORRECTION, TextureManager::ReloadPolicy::CACHED,
188 mRequestingLoad = false;
191 CheckFrontFrame( frontFrameReady );
194 void RollingImageCache::SetImageFrameReady( TextureManager::TextureId textureId )
196 for( std::size_t i = 0; i < mQueue.Count() ; ++i )
198 if( GetCachedTextureId(i) == textureId )
200 mQueue[i].mReady = true;
206 TextureSet RollingImageCache::GetFrontTextureSet() const
208 TextureManager::TextureId textureId = GetCachedTextureId( 0 );
209 return mTextureManager.GetTextureSet( textureId );
212 TextureManager::TextureId RollingImageCache::GetCachedTextureId( int index ) const
214 return mImageUrls[ mQueue[ index ].mUrlIndex ].mTextureId;
217 void RollingImageCache::CheckFrontFrame( bool wasReady )
219 if( mWaitingForReadyFrame && wasReady == false && IsFrontReady() )
221 mWaitingForReadyFrame = false;
222 mObserver.FrameReady( GetFrontTextureSet() );
226 void RollingImageCache::UploadComplete(
229 TextureSet textureSet,
231 const Vector4& atlasRect,
234 DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"AnimatedImageVisual::UploadComplete(textureId:%d) start\n", textureId);
237 bool frontFrameReady = IsFrontReady();
239 if( ! mRequestingLoad )
241 SetImageFrameReady( textureId );
243 CheckFrontFrame( frontFrameReady );
247 // UploadComplete has been called from within RequestLoad. TextureManager must
248 // therefore already have the texture cached, so make the texture ready.
249 // (Use the last texture, as the texture id hasn't been assigned yet)
250 mQueue.Back().mReady = true;
256 void RollingImageCache::LoadComplete(
258 Devel::PixelBuffer pixelBuffer,
259 const VisualUrl& url,
262 // LoadComplete is called if this TextureUploadObserver requested to load
263 // an image that will be returned as a type of PixelBuffer by using a method
264 // TextureManager::LoadPixelBuffer.
267 } //namespace Internal
268 } //namespace Toolkit