1 #ifndef DALI_TOOLKIT_INTERNAL_ROLLING_IMAGE_CACHE_H
2 #define DALI_TOOLKIT_INTERNAL_ROLLING_IMAGE_CACHE_H
5 * Copyright (c) 2021 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.
22 #include <dali-toolkit/internal/visuals/animated-image/image-cache.h>
23 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
24 #include <dali/devel-api/common/circular-queue.h>
33 * Class to manage a rolling cache of images, where the cache size
34 * is smaller than the total number of images.
36 class RollingImageCache : public ImageCache, public TextureUploadObserver
41 * @param[in] textureManager The texture manager
42 * @param[in] urlList List of urls to cache
43 * @param[in] observer FrameReady observer
44 * @param[in] cacheSize The size of the cache
45 * @param[in] batchSize The size of a batch to load
47 * This will start loading textures immediately, according to the
48 * batch and cache sizes.
50 RollingImageCache(TextureManager& textureManager,
52 ImageCache::FrameReadyObserver& observer,
59 ~RollingImageCache() override;
62 * Get the Nth frame. If it's not ready, this will trigger the
63 * sending of FrameReady() when the image becomes ready.
65 TextureSet Frame(uint32_t frameIndex) override;
68 * Get the first frame. If it's not ready, this will trigger the
69 * sending of FrameReady() when the image becomes ready.
71 TextureSet FirstFrame() override;
74 * Get the next frame. If it's not ready, this will trigger the
75 * sending of FrameReady() when the image becomes ready.
77 TextureSet NextFrame() override;
80 * Get the interval of Nth frame.
82 uint32_t GetFrameInterval(uint32_t frameIndex) const override;
85 * Get the current rendered frame index.
86 * If there isn't any loaded frame, returns -1.
88 int32_t GetCurrentFrameIndex() const override;
91 * Get total frame count of the animated image file.
93 int32_t GetTotalFrameCount() const override;
97 * @return true if the front frame is ready
99 bool IsFrontReady() const;
102 * Load the next batch of images
107 * Find the matching image frame, and set it to ready
109 void SetImageFrameReady(TextureManager::TextureId textureId);
112 * Get the texture set of the front frame.
113 * @return the texture set
115 TextureSet GetFrontTextureSet() const;
118 * Get the texture id of the given index
120 TextureManager::TextureId GetCachedTextureId(int index) const;
123 * Check if the front frame has become ready - if so, inform observer
124 * @param[in] wasReady Readiness before call.
126 void CheckFrontFrame(bool wasReady);
129 void LoadComplete(bool loadSuccess, TextureInformation textureInformation) override;
133 * Secondary class to hold readiness and index into url
137 unsigned int mUrlIndex = 0u;
141 std::vector<UrlStore>& mImageUrls;
142 CircularQueue<ImageFrame> mQueue;
145 } // namespace Internal
146 } // namespace Toolkit