1 #ifndef DALI_TOOLKIT_INTERNAL_ROLLING_ANIMATED_IMAGE_CACHE_H
2 #define DALI_TOOLKIT_INTERNAL_ROLLING_ANIMATED_IMAGE_CACHE_H
5 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 #include <dali-toolkit/internal/texture-manager/texture-manager-impl.h>
22 #include <dali-toolkit/internal/visuals/animated-image/image-cache.h>
23 #include <dali/devel-api/adaptor-framework/animated-image-loading.h>
24 #include <dali/devel-api/common/circular-queue.h>
33 * Class to manage a rolling cache of Animated images, where the cache size
34 * is smaller than the total number of images.
36 * Frames are always ready, so the observer.FrameReady callback is never triggered;
37 * the FirstFrame and NextFrame APIs will always return a texture.
39 class RollingAnimatedImageCache : public ImageCache, public TextureUploadObserver
44 * @param[in] textureManager The texture manager
45 * @param[in] animatedImageLoading The loaded animated image
46 * @param[in] maskingData Masking data to be applied.
47 * @param[in] observer FrameReady observer
48 * @param[in] cacheSize The size of the cache
49 * @param[in] batchSize The size of a batch to load
50 * @param[in] wrapModeU Horizontal Wrap mode
51 * @param[in] wrapModeV Vertical Wrap mode
52 * @param[in] isSynchronousLoading The flag to define whether to load first frame synchronously
53 * @param[in] preMultiplyOnLoad The flag if image's color should be multiplied by it's alpha
55 * This will start loading textures immediately, according to the
56 * batch and cache sizes.
58 RollingAnimatedImageCache(TextureManager& textureManager,
59 AnimatedImageLoading& animatedImageLoading,
60 TextureManager::MaskingDataPointer& maskingData,
61 ImageCache::FrameReadyObserver& observer,
64 const Dali::WrapMode::Type& wrapModeU,
65 const Dali::WrapMode::Type& wrapModeV,
66 bool isSynchronousLoading,
67 bool preMultiplyOnLoad);
72 ~RollingAnimatedImageCache() override;
75 * @copydoc Internal::ImageCache::Frame()
77 TextureSet Frame(uint32_t frameIndex) override;
80 * @copydoc Internal::ImageCache::FirstFrame()
82 TextureSet FirstFrame() override;
85 * @copydoc Internal::ImageCache::GetFrameInterval()
87 uint32_t GetFrameInterval(uint32_t frameIndex) const override;
90 * @copydoc Internal::ImageCache::GetCurrentFrameIndex()
92 int32_t GetCurrentFrameIndex() const override;
95 * @copydoc Internal::ImageCache::GetTotalFrameCount()
97 int32_t GetTotalFrameCount() const override;
100 * @copydoc Internal::ImageCache::ClearCache()
102 void ClearCache() override;
106 * @brief Check whether the front frame is ready or not.
108 * @return true if the front frame is ready
110 bool IsFrontReady() const;
113 * @brief Request to Load a frame
115 * @param[in] frameIndex index of frame to be loaded.
116 * @param[in] synchronousLoading true if the frame should be loaded synchronously
118 * @return the texture set currently loaded.
120 TextureSet RequestFrameLoading(uint32_t frameIndex, bool synchronousLoading);
123 * @brief Load the next batch of images
125 * @param[in] frameIndex starting frame index of batch to be loaded.
127 void LoadBatch(uint32_t frameIndex);
130 * @brief Find the matching image frame, and set it to ready
132 * @param[in] textureId texture id to be marked as ready.
134 void SetImageFrameReady(TextureManager::TextureId textureId);
137 * @brief Get the texture set of the front frame.
139 * @return the texture set of the front of Cache.
141 TextureSet GetFrontTextureSet() const;
144 * @brief Get the texture id of the given index
146 * @param[in] index index of the queue.
148 TextureManager::TextureId GetCachedTextureId(int index) const;
151 * @brief Make the loaded frame ready and notify it to the texture upload observer
153 * @param[in] loadSuccess whether the loading is succeded or not.
154 * @param[in] textureSet textureSet for this frame.
155 * @param[in] interval interval between this frame and next frame.
157 void MakeFrameReady(bool loadSuccess, TextureSet textureSet, uint32_t interval);
160 * @brief Pop front entity of Cache.
162 void PopFrontCache();
166 * @copydoc Toolkit::TextureUploadObserver::LoadComplete()
168 void LoadComplete(bool loadSuccess, TextureInformation textureInformation) override;
172 * Secondary class to hold readiness and index into url
176 uint32_t mFrameNumber = 0u;
179 std::vector<TextureManager::TextureId> mTextureIds;
182 Dali::AnimatedImageLoading mAnimatedImageLoading;
183 uint32_t mFrameCount;
184 uint32_t mFrameIndex;
186 std::vector<int32_t> mIntervals;
187 std::vector<uint32_t> mLoadWaitingQueue;
188 CircularQueue<ImageFrame> mQueue;
189 Dali::WrapMode::Type mWrapModeU : 3;
190 Dali::WrapMode::Type mWrapModeV : 3;
191 bool mIsSynchronousLoading;
192 bool mPreMultiplyOnLoad;
195 } // namespace Internal
197 } // namespace Toolkit
201 #endif //DALI_TOOLKIT_INTERNAL_ROLLING_ANIMATED_IMAGE_CACHE_H