1 #ifndef DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H
2 #define DALI_TOOLKIT_INTERNAL_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/texture-manager/texture-upload-observer.h>
30 class ImageCache : public TextureManager::LifecycleObserver
34 * Observer class to inform when the next image is ready
36 class FrameReadyObserver
40 * Informs observer when the next texture set is ready to display
41 * @param[in] textureSet The ready texture set
43 virtual void FrameReady(TextureSet textureSet) = 0;
48 TextureManager::TextureId mTextureId = TextureManager::INVALID_TEXTURE_ID;
55 typedef std::vector<UrlStore> UrlList;
60 * @param[in] textureManager The texture manager
61 * @param[in] urlList List of urls to cache
62 * @param[in] observer FrameReady observer
63 * @param[in] batchSize The size of a batch to load
65 * This will start loading textures immediately, according to the
66 * batch and cache sizes. The cache is as large as the number of urls.
68 ImageCache(TextureManager& textureManager,
69 ImageCache::FrameReadyObserver& observer,
70 unsigned int batchSize);
72 virtual ~ImageCache();
75 * Get the first frame. If it's not ready, this will trigger the
76 * sending of FrameReady() when the image becomes ready.
78 virtual TextureSet FirstFrame() = 0;
81 * Get the next frame. If it's not ready, this will trigger the
82 * sending of FrameReady() when the image becomes ready.
84 virtual TextureSet NextFrame() = 0;
87 * Get the Nth frame. If it's not ready, this will trigger the
88 * sending of FrameReady() when the image becomes ready.
90 virtual TextureSet Frame(uint32_t frameIndex) = 0;
93 * Get the interval of Nth frame.
95 virtual uint32_t GetFrameInterval(uint32_t frameIndex) const = 0;
98 * Get the current rendered frame index.
99 * If there isn't any loaded frame, returns -1.
101 virtual int32_t GetCurrentFrameIndex() const = 0;
104 * Get total frame count of the animated image file.
106 virtual int32_t GetTotalFrameCount() const = 0;
110 * Called before the texture manager is destroyed.
112 void TextureManagerDestroyed() final;
115 TextureManager& mTextureManager;
116 FrameReadyObserver& mObserver;
117 unsigned int mBatchSize;
118 unsigned int mUrlIndex;
119 bool mWaitingForReadyFrame : 1;
120 bool mRequestingLoad : 1;
121 bool mTextureManagerAlive : 1;
124 } //namespace Internal
125 } //namespace Toolkit
128 #endif // DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H