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] isSynchronousLoading The flag to define whether to load first frame synchronously
52 * This will start loading textures immediately, according to the
53 * batch and cache sizes.
55 RollingAnimatedImageCache(TextureManager& textureManager,
56 AnimatedImageLoading& animatedImageLoading,
57 TextureManager::MaskingDataPointer& maskingData,
58 ImageCache::FrameReadyObserver& observer,
61 bool isSynchronousLoading);
66 ~RollingAnimatedImageCache() override;
69 * @copydoc Internal::ImageCache::Frame()
71 TextureSet Frame(uint32_t frameIndex) override;
74 * @copydoc Internal::ImageCache::FirstFrame()
76 TextureSet FirstFrame() override;
79 * @copydoc Internal::ImageCache::GetFrameInterval()
81 uint32_t GetFrameInterval(uint32_t frameIndex) const override;
84 * @copydoc Internal::ImageCache::GetCurrentFrameIndex()
86 int32_t GetCurrentFrameIndex() const override;
89 * @copydoc Internal::ImageCache::GetTotalFrameCount()
91 int32_t GetTotalFrameCount() const override;
94 * @copydoc Internal::ImageCache::ClearCache()
96 void ClearCache() override;
100 * @brief Check whether the front frame is ready or not.
102 * @return true if the front frame is ready
104 bool IsFrontReady() const;
107 * @brief Request to Load a frame
109 * @param[in] frameIndex index of frame to be loaded.
110 * @param[in] synchronousLoading true if the frame should be loaded synchronously
112 * @return the texture set currently loaded.
114 TextureSet RequestFrameLoading(uint32_t frameIndex, bool synchronousLoading);
117 * @brief Load the next batch of images
119 * @param[in] frameIndex starting frame index of batch to be loaded.
121 void LoadBatch(uint32_t frameIndex);
124 * @brief Find the matching image frame, and set it to ready
126 * @param[in] textureId texture id to be marked as ready.
128 void SetImageFrameReady(TextureManager::TextureId textureId);
131 * @brief Get the texture set of the front frame.
133 * @return the texture set of the front of Cache.
135 TextureSet GetFrontTextureSet() const;
138 * @brief Get the texture id of the given index
140 * @param[in] index index of the queue.
142 TextureManager::TextureId GetCachedTextureId(int index) const;
145 * @brief Make the loaded frame ready and notify it to the texture upload observer
147 * @param[in] loadSuccess whether the loading is succeded or not.
148 * @param[in] textureSet textureSet for this frame.
149 * @param[in] interval interval between this frame and next frame.
151 void MakeFrameReady(bool loadSuccess, TextureSet textureSet, uint32_t interval);
154 * @brief Pop front entity of Cache.
156 void PopFrontCache();
160 * @copydoc Toolkit::TextureUploadObserver::LoadComplete()
162 void LoadComplete(bool loadSuccess, TextureInformation textureInformation) override;
166 * Secondary class to hold readiness and index into url
170 uint32_t mFrameNumber = 0u;
174 Dali::AnimatedImageLoading mAnimatedImageLoading;
175 uint32_t mFrameCount;
176 uint32_t mFrameIndex;
178 std::vector<UrlStore> mImageUrls;
179 std::vector<int32_t> mIntervals;
180 std::vector<uint32_t> mLoadWaitingQueue;
181 CircularQueue<ImageFrame> mQueue;
182 bool mIsSynchronousLoading;
185 } // namespace Internal
187 } // namespace Toolkit
191 #endif //DALI_TOOLKIT_INTERNAL_ROLLING_ANIMATED_IMAGE_CACHE_H