1 #ifndef DALI_TOOLKIT_INTERNAL_ROLLING_IMAGE_CACHE_H
2 #define DALI_TOOLKIT_INTERNAL_ROLLING_IMAGE_CACHE_H
5 * Copyright (c) 2020 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/devel-api/common/circular-queue.h>
23 #include <dali-toolkit/internal/visuals/animated-image/image-cache.h>
24 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
34 * Class to manage a rolling cache of images, where the cache size
35 * is smaller than the total number of images.
37 class RollingImageCache : public ImageCache, public TextureUploadObserver
42 * @param[in] textureManager The texture manager
43 * @param[in] urlList List of urls to cache
44 * @param[in] observer FrameReady observer
45 * @param[in] cacheSize The size of the cache
46 * @param[in] batchSize The size of a batch to load
48 * This will start loading textures immediately, according to the
49 * batch and cache sizes.
51 RollingImageCache( TextureManager& textureManager,
53 ImageCache::FrameReadyObserver& observer,
60 ~RollingImageCache() override;
63 * Get the Nth frame. If it's not ready, this will trigger the
64 * sending of FrameReady() when the image becomes ready.
66 TextureSet Frame( uint32_t frameIndex ) override;
69 * Get the first frame. If it's not ready, this will trigger the
70 * sending of FrameReady() when the image becomes ready.
72 TextureSet FirstFrame() override;
75 * Get the next frame. If it's not ready, this will trigger the
76 * sending of FrameReady() when the image becomes ready.
78 TextureSet NextFrame() override;
81 * Get the interval of Nth frame.
83 uint32_t GetFrameInterval( uint32_t frameIndex ) override;
86 * Get the current rendered frame index.
87 * If there isn't any loaded frame, returns -1.
89 int32_t GetCurrentFrameIndex() override;
93 * @return true if the front frame is ready
95 bool IsFrontReady() const;
98 * Load the next batch of images
103 * Find the matching image frame, and set it to ready
105 void SetImageFrameReady( TextureManager::TextureId textureId );
108 * Get the texture set of the front frame.
109 * @return the texture set
111 TextureSet GetFrontTextureSet() const;
114 * Get the texture id of the given index
116 TextureManager::TextureId GetCachedTextureId( int index ) const;
119 * Check if the front frame has become ready - if so, inform observer
120 * @param[in] wasReady Readiness before call.
122 void CheckFrontFrame( bool wasReady );
128 TextureSet textureSet,
130 const Vector4& atlasRect,
131 bool preMultiplied ) override;
135 Devel::PixelBuffer pixelBuffer,
136 const VisualUrl& url,
137 bool preMultiplied ) override;
141 * Secondary class to hold readiness and index into url
145 unsigned int mUrlIndex = 0u;
149 std::vector<UrlStore>& mImageUrls;
150 CircularQueue<ImageFrame> mQueue;
153 } // namespace Internal
154 } // namespace Toolkit