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-animated-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 RollingAnimatedImageCache::RollingAnimatedImageCache(
62 TextureManager& textureManager, AnimatedImageLoading& animatedImageLoading, uint32_t frameCount, ImageCache::FrameReadyObserver& observer,
63 uint16_t cacheSize, uint16_t batchSize )
64 : ImageCache( textureManager, observer, batchSize ),
65 mAnimatedImageLoading( animatedImageLoading ),
66 mFrameCount( frameCount ),
68 mCacheSize( cacheSize ),
71 mImageUrls.resize( mFrameCount );
75 RollingAnimatedImageCache::~RollingAnimatedImageCache()
77 if( mTextureManagerAlive )
79 while( IsFrontReady() )
81 ImageFrame imageFrame = mQueue.PopFront();
82 Dali::Toolkit::TextureManager::RemoveTexture( mImageUrls[ imageFrame.mFrameNumber ].mUrl );
87 TextureSet RollingAnimatedImageCache::Frame( uint32_t frameIndex )
89 bool popExist = false;
90 while( IsFrontReady() && mQueue.Front().mFrameNumber != frameIndex )
92 ImageFrame imageFrame = mQueue.PopFront();
93 Dali::Toolkit::TextureManager::RemoveTexture( mImageUrls[ imageFrame.mFrameNumber ].mUrl );
94 mImageUrls[ imageFrame.mFrameNumber ].mTextureId = TextureManager::INVALID_TEXTURE_ID;
97 if( popExist || mImageUrls[ frameIndex ].mTextureId == TextureManager::INVALID_TEXTURE_ID )
99 // If the frame of frameIndex was already loaded, load batch from the last frame of queue
102 mFrameIndex = ( mQueue.Back().mFrameNumber + 1 ) % mFrameCount;
104 // If the queue is empty, load batch from the frame of frameIndex
107 mFrameIndex = frameIndex;
112 return GetFrontTextureSet();
115 TextureSet RollingAnimatedImageCache::FirstFrame()
120 uint32_t RollingAnimatedImageCache::GetFrameInterval( uint32_t frameIndex )
123 return mAnimatedImageLoading.GetFrameInterval( frameIndex );
126 bool RollingAnimatedImageCache::IsFrontReady() const
128 return ( !mQueue.IsEmpty() );
131 void RollingAnimatedImageCache::LoadBatch()
133 // Try and load up to mBatchSize images, until the cache is filled.
134 // Once the cache is filled, as frames progress, the old frame is
135 // removed, and another frame is loaded
137 std::vector<Dali::PixelData> pixelDataList;
139 // Get the smallest number of frames we need to load
140 int batchSize = std::min( std::size_t(mBatchSize), mCacheSize - mQueue.Count() );
141 DALI_LOG_INFO( gAnimImgLogFilter, Debug::Concise, "RollingAnimatedImageCache::LoadBatch() mFrameIndex:%d batchSize:%d\n", mFrameIndex, batchSize );
142 if( mAnimatedImageLoading.LoadNextNFrames( mFrameIndex, batchSize, pixelDataList) )
144 unsigned int pixelDataListCount = pixelDataList.size();
146 for( unsigned int i = 0; i < pixelDataListCount && !mQueue.IsFull(); ++i )
148 ImageFrame imageFrame;
150 // create the texture for uploading the pixel data
151 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D,
152 pixelDataList[i].GetPixelFormat(),
153 pixelDataList[i].GetWidth(),
154 pixelDataList[i].GetHeight() );
156 texture.Upload( pixelDataList[i] );
158 mImageUrls[ mUrlIndex ].mUrl = Dali::Toolkit::TextureManager::AddTexture(texture);
159 imageFrame.mFrameNumber = mUrlIndex;
162 mUrlIndex %= mImageUrls.size();
164 mQueue.PushBack( imageFrame );
166 bool synchronousLoading = false;
167 bool atlasingStatus = false;
168 bool loadingStatus = false;
169 TextureManager::MaskingDataPointer maskInfo = nullptr;
170 AtlasUploadObserver* atlasObserver = nullptr;
171 ImageAtlasManagerPtr imageAtlasManager = nullptr;
173 Dali::ImageDimensions textureRectSize;
174 auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
176 mTextureManager.LoadTexture(
177 mImageUrls[ imageFrame.mFrameNumber ].mUrl, ImageDimensions(), FittingMode::SCALE_TO_FILL,
178 SamplingMode::BOX_THEN_LINEAR, maskInfo,
179 synchronousLoading, mImageUrls[ imageFrame.mFrameNumber ].mTextureId, textureRect, textureRectSize,
180 atlasingStatus, loadingStatus, Dali::WrapMode::Type::DEFAULT,
181 Dali::WrapMode::Type::DEFAULT, NULL,
182 atlasObserver, imageAtlasManager, ENABLE_ORIENTATION_CORRECTION, TextureManager::ReloadPolicy::CACHED, preMultiply );
185 mFrameIndex += batchSize;
186 mFrameIndex %= mFrameCount;
192 TextureSet RollingAnimatedImageCache::GetFrontTextureSet() const
194 DALI_LOG_INFO( gAnimImgLogFilter, Debug::Concise, "RollingAnimatedImageCache::GetFrontTextureSet() FrameNumber:%d\n", mQueue[ 0 ].mFrameNumber );
196 TextureManager::TextureId textureId = GetCachedTextureId( 0 );
197 return mTextureManager.GetTextureSet( textureId );
200 TextureManager::TextureId RollingAnimatedImageCache::GetCachedTextureId( int index ) const
202 return mImageUrls[ mQueue[ index ].mFrameNumber ].mTextureId;
205 } //namespace Internal
206 } //namespace Toolkit