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/fixed-image-cache.h>
21 #include <dali-toolkit/internal/visuals/image-atlas-manager.h> // For ImageAtlasManagerPtr
32 const bool ENABLE_ORIENTATION_CORRECTION( true );
35 FixedImageCache::FixedImageCache(
36 TextureManager& textureManager, UrlList& urlList, ImageCache::FrameReadyObserver& observer,
37 unsigned int batchSize )
38 : ImageCache( textureManager, observer, batchSize ),
39 mImageUrls( urlList ),
42 mReadyFlags.reserve( mImageUrls.size() );
46 FixedImageCache::~FixedImageCache()
48 if( mTextureManagerAlive )
50 for( std::size_t i = 0; i < mImageUrls.size() ; ++i )
52 mTextureManager.Remove( mImageUrls[i].mTextureId, this );
57 TextureSet FixedImageCache::Frame( uint32_t frameIndex )
59 while( frameIndex > mFront )
65 TextureSet textureSet;
66 if( IsFrontReady() == true )
68 textureSet = GetFrontTextureSet();
72 mWaitingForReadyFrame = true;
78 TextureSet FixedImageCache::FirstFrame()
80 TextureSet textureSet = GetFrontTextureSet();
84 mWaitingForReadyFrame = true;
90 TextureSet FixedImageCache::NextFrame()
92 TextureSet textureSet;
94 mFront %= mImageUrls.size();
96 if( IsFrontReady() == true )
98 textureSet = GetFrontTextureSet();
102 mWaitingForReadyFrame = true;
109 bool FixedImageCache::IsFrontReady() const
111 return ( mReadyFlags.size() > 0 && mReadyFlags[mFront] == true );
114 void FixedImageCache::LoadBatch()
116 // Try and load up to mBatchSize images, until the cache is filled.
117 // Once the cache is filled, mUrlIndex exceeds mImageUrls size and
118 // no more images are loaded.
119 bool frontFrameReady = IsFrontReady();
121 for( unsigned int i=0; i< mBatchSize && mUrlIndex < mImageUrls.size(); ++i )
123 std::string& url = mImageUrls[ mUrlIndex ].mUrl;
125 mReadyFlags.push_back(false);
127 // Note, if the image is already loaded, then UploadComplete will get called
128 // from within this method. This means it won't yet have a texture id, so we
129 // need to account for this inside the UploadComplete method using mRequestingLoad.
130 mRequestingLoad = true;
132 bool synchronousLoading = false;
133 bool atlasingStatus = false;
134 bool loadingStatus = false;
135 TextureManager::MaskingDataPointer maskInfo = nullptr;
136 AtlasUploadObserver* atlasObserver = nullptr;
137 ImageAtlasManagerPtr imageAtlasManager = nullptr;
139 Dali::ImageDimensions textureRectSize;
140 auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
142 mTextureManager.LoadTexture(
143 url, ImageDimensions(), FittingMode::SCALE_TO_FILL,
144 SamplingMode::BOX_THEN_LINEAR, maskInfo,
145 synchronousLoading, mImageUrls[ mUrlIndex ].mTextureId, textureRect, textureRectSize,
146 atlasingStatus, loadingStatus, Dali::WrapMode::Type::DEFAULT,
147 Dali::WrapMode::Type::DEFAULT, this,
148 atlasObserver, imageAtlasManager, ENABLE_ORIENTATION_CORRECTION, TextureManager::ReloadPolicy::CACHED,
151 if( loadingStatus == false ) // not loading, means it's already ready.
153 SetImageFrameReady( mImageUrls[ mUrlIndex ].mTextureId );
155 mRequestingLoad = false;
159 CheckFrontFrame( frontFrameReady );
162 void FixedImageCache::SetImageFrameReady( TextureManager::TextureId textureId )
164 for( std::size_t i = 0; i < mImageUrls.size() ; ++i )
166 if( mImageUrls[i].mTextureId == textureId )
168 mReadyFlags[i] = true;
174 TextureSet FixedImageCache::GetFrontTextureSet() const
176 return mTextureManager.GetTextureSet( mImageUrls[mFront].mTextureId );
179 void FixedImageCache::CheckFrontFrame( bool wasReady )
181 if( mWaitingForReadyFrame && wasReady == false && IsFrontReady() )
183 mWaitingForReadyFrame = false;
184 mObserver.FrameReady( GetFrontTextureSet() );
188 void FixedImageCache::UploadComplete(
191 TextureSet textureSet,
193 const Vector4& atlasRect,
196 bool frontFrameReady = IsFrontReady();
198 if( ! mRequestingLoad )
200 SetImageFrameReady( textureId );
202 CheckFrontFrame( frontFrameReady );
206 // UploadComplete has been called from within RequestLoad. TextureManager must
207 // therefore already have the texture cached, so make the texture ready.
208 // (Use the last texture, as the texture id hasn't been assigned yet)
209 mReadyFlags.back() = true;
213 void FixedImageCache::LoadComplete(
215 Devel::PixelBuffer pixelBuffer,
216 const VisualUrl& url,
219 // LoadComplete is called if this TextureUploadObserver requested to load
220 // an image that will be returned as a type of PixelBuffer by using a method
221 // TextureManager::LoadPixelBuffer.
224 } //namespace Internal
225 } //namespace Toolkit