1 #ifndef DALI_TOOLKIT_INTERNAL_ROLLING_ANIMATED_IMAGE_CACHE_H
2 #define DALI_TOOLKIT_INTERNAL_ROLLING_ANIMATED_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.
21 #include <dali/devel-api/adaptor-framework/animated-image-loading.h>
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 Animated images, where the cache size
35 * is smaller than the total number of images.
37 * Frames are always ready, so the observer.FrameReady callback is never triggered;
38 * the FirstFrame and NextFrame APIs will always return a texture.
40 class RollingAnimatedImageCache : public ImageCache, public TextureUploadObserver
45 * @param[in] textureManager The texture manager
46 * @param[in] animatedImageLoader The loaded animated image
47 * @param[in] frameCount The number of frames in the animated image
48 * @param[in] observer FrameReady observer
49 * @param[in] cacheSize The size of the cache
50 * @param[in] batchSize The size of a batch to load
51 * @param[in] isSynchronousLoading The flag to define whether to load first frame synchronously
53 * This will start loading textures immediately, according to the
54 * batch and cache sizes.
56 RollingAnimatedImageCache( TextureManager& textureManager,
57 AnimatedImageLoading& animatedImageLoader,
59 ImageCache::FrameReadyObserver& observer,
62 bool isSynchronousLoading );
67 ~RollingAnimatedImageCache() override;
70 * Get the Nth frame. If it's not ready, this will trigger the
71 * sending of FrameReady() when the image becomes ready.
73 TextureSet Frame( uint32_t frameIndex ) override;
76 * Get the first frame. If it's not ready, this will trigger the
77 * sending of FrameReady() when the image becomes ready.
79 TextureSet FirstFrame() override;
82 * Get the next frame. If it's not ready, this will trigger the
83 * sending of FrameReady() when the image becomes ready.
85 TextureSet NextFrame() override;
88 * Get the interval of Nth frame.
90 uint32_t GetFrameInterval( uint32_t frameIndex ) const override;
93 * Get the current rendered frame index.
94 * If there isn't any loaded frame, returns -1.
96 int32_t GetCurrentFrameIndex() const override;
99 * Get total frame count of the animated image file.
101 int32_t GetTotalFrameCount() const override;
105 * @return true if the front frame is ready
107 bool IsFrontReady() const;
110 * Request to Load a frame
112 void RequestFrameLoading( uint32_t frameIndex );
115 * Load the next batch of images
120 * Find the matching image frame, and set it to ready
122 void SetImageFrameReady( TextureManager::TextureId textureId );
125 * Get the texture set of the front frame.
126 * @return the texture set
128 TextureSet GetFrontTextureSet() const;
131 * Get the texture id of the given index
133 TextureManager::TextureId GetCachedTextureId( int index ) const;
136 * Check if the front frame has become ready - if so, inform observer
137 * @param[in] wasReady Readiness before call.
139 void CheckFrontFrame( bool wasReady );
145 TextureSet textureSet,
147 const Vector4& atlasRect,
148 bool preMultiplied ) override;
152 Devel::PixelBuffer pixelBuffer,
153 const VisualUrl& url,
154 bool preMultiplied ) override;
158 * Secondary class to hold readiness and index into url
162 unsigned int mFrameNumber = 0u;
166 Dali::AnimatedImageLoading mAnimatedImageLoading;
167 uint32_t mFrameCount;
170 std::vector<UrlStore> mImageUrls;
171 std::vector<int32_t> mIntervals;
172 std::vector<uint32_t> mLoadWaitingQueue;
173 CircularQueue<ImageFrame> mQueue;
174 bool mIsSynchronousLoading;
178 } // namespace Internal
180 } // namespace Toolkit
184 #endif //DALI_TOOLKIT_INTERNAL_ROLLING_ANIMATED_IMAGE_CACHE_H