1 #ifndef DALI_TOOLKIT_INTERNAL_ROLLING_IMAGE_CACHE_H
2 #define DALI_TOOLKIT_INTERNAL_ROLLING_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/common/circular-queue.h>
32 * Class to manage a rolling cache of images, where the cache size
33 * is smaller than the total number of images.
35 class RollingImageCache : public ImageCache, public TextureUploadObserver
40 * @param[in] textureManager The texture manager
41 * @param[in] urlList List of urls to cache
42 * @param[in] observer FrameReady observer
43 * @param[in] cacheSize The size of the cache
44 * @param[in] batchSize The size of a batch to load
45 * @param[in] interval Time interval between each frame
47 * This will start loading textures immediately, according to the
48 * batch and cache sizes.
50 RollingImageCache(TextureManager& textureManager,
52 ImageCache::FrameReadyObserver& observer,
60 ~RollingImageCache() override;
63 * @copydoc Internal::ImageCache::Frame()
65 TextureSet Frame(uint32_t frameIndex) override;
68 * @copydoc Internal::ImageCache::FirstFrame()
70 TextureSet FirstFrame() override;
73 * @copydoc Internal::ImageCache::GetFrameInterval()
75 uint32_t GetFrameInterval(uint32_t frameIndex) const override;
78 * @copydoc Internal::ImageCache::GetCurrentFrameIndex()
80 int32_t GetCurrentFrameIndex() const override;
83 * @copydoc Internal::ImageCache::GetTotalFrameCount()
85 int32_t GetTotalFrameCount() const override;
88 * @copydoc Internal::ImageCache::ClearCache()
90 void ClearCache() override;
94 * @brief Check whether the front frame is ready or not.
96 * @return true if the front frame is ready
98 bool IsFrontReady() const;
101 * @brief Load the next batch of images
103 * @param[in] frameIndex starting frame index of batch to be loaded.
105 void LoadBatch(uint32_t frameIndex);
108 * @brief Get the texture set of the front frame.
110 * @return the texture set of the front of Cache.
112 TextureSet GetFrontTextureSet() const;
115 * @brief Get the texture id of the given index
117 * @param[in] index index of the queue.
119 TextureManager::TextureId GetCachedTextureId(int index) const;
122 * @brief Check if the front frame has become ready - if so, inform observer
124 * @param[in] wasReady Readiness before call.
126 void CheckFrontFrame(bool wasReady);
130 * @copydoc Toolkit::TextureUploadObserver::LoadComplete()
132 void LoadComplete(bool loadSuccess, TextureInformation textureInformation) override;
136 * Secondary class to hold readiness and index into url
140 unsigned int mUrlIndex = 0u;
144 std::vector<UrlStore>& mImageUrls;
145 CircularQueue<ImageFrame> mQueue;
148 } // namespace Internal
149 } // namespace Toolkit