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 * @brief Informs observer when the next texture set is ready to display
41 * @param[in] textureSet The ready texture set
42 * @param[in] interval interval(ms) for the frame
44 virtual void FrameReady(TextureSet textureSet, uint32_t interval) = 0;
49 TextureManager::TextureId mTextureId = TextureManager::INVALID_TEXTURE_ID;
56 typedef std::vector<UrlStore> UrlList;
61 * @param[in] textureManager The texture manager
62 * @param[in] urlList List of urls to cache
63 * @param[in] observer FrameReady observer
64 * @param[in] maskingData Masking data to be applied.
65 * @param[in] batchSize The size of a batch to load
66 * @param[in] interval Time interval(ms) between each frame
68 * This will start loading textures immediately, according to the
69 * batch and cache sizes. The cache is as large as the number of urls.
71 ImageCache(TextureManager& textureManager,
72 TextureManager::MaskingDataPointer& maskingData,
73 ImageCache::FrameReadyObserver& observer,
77 virtual ~ImageCache();
80 * @brief Get the first frame. If it's not ready, this will trigger the
81 * sending of FrameReady() when the image becomes ready.
83 * @return TextureSet of the first frame.
85 virtual TextureSet FirstFrame() = 0;
88 * @brief Get the Nth frame. If it's not ready, this will trigger the
89 * sending of FrameReady() when the image becomes ready.
91 * @param[in] frameIndex required frame index to be returned.
92 * @return TextureSet of the frame index.
94 virtual TextureSet Frame(uint32_t frameIndex) = 0;
97 * @brief Get the interval(ms) of Nth frame.
99 * @param[in] frameIndex frame index to get frame interval.
100 * @return Time interval in millisecond between frames of frameIndex and frameIndex + 1.
102 virtual uint32_t GetFrameInterval(uint32_t frameIndex) const = 0;
105 * @brief Get the current rendered frame index.
106 * If there isn't any loaded frame, returns -1.
108 * @return Frame index of currently showing frame.
110 virtual int32_t GetCurrentFrameIndex() const = 0;
113 * @brief Get total frame count of the animated image file.
115 * @return Total frame count of the animated image file.
117 virtual int32_t GetTotalFrameCount() const = 0;
120 * @brief Clears animated image cache and remove loaded textures.
122 virtual void ClearCache() = 0;
125 * @brief Set default interval(ms) between each frame.
127 * @param[in] interval time interval in millisecond to be used as default interval.
129 virtual void SetInterval(uint32_t interval);
133 * @brief Called before the texture manager is destroyed.
135 void TextureManagerDestroyed() final;
137 void AllocateMaskData();
140 TextureManager& mTextureManager;
141 FrameReadyObserver& mObserver;
142 TextureManager::MaskingDataPointer& mMaskingData;
145 TextureManager::LoadState mLoadState;
146 bool mRequestingLoad : 1;
147 bool mTextureManagerAlive : 1;
150 } // namespace Internal
151 } // namespace Toolkit
154 #endif // DALI_TOOLKIT_INTERNAL_IMAGE_CACHE_H