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
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
52 * This will start loading textures immediately, according to the
53 * batch and cache sizes.
55 RollingAnimatedImageCache( TextureManager& textureManager,
56 AnimatedImageLoading& animatedImageLoader,
58 ImageCache::FrameReadyObserver& observer,
65 virtual ~RollingAnimatedImageCache();
68 * Get the Nth frame. If it's not ready, this will trigger the
69 * sending of FrameReady() when the image becomes ready.
71 TextureSet Frame( uint32_t frameIndex ) override;
74 * Get the first frame. If it's not ready, this will trigger the
75 * sending of FrameReady() when the image becomes ready.
77 TextureSet FirstFrame() override;
80 * Get the interval of Nth frame.
82 uint32_t GetFrameInterval( uint32_t frameIndex ) override;
86 * @return true if the front frame is ready
88 bool IsFrontReady() const;
91 * Load the next batch of images
96 * Get the texture set of the front frame.
97 * @return the texture set
99 TextureSet GetFrontTextureSet() const;
102 * Get the texture id of the given index
104 TextureManager::TextureId GetCachedTextureId( int index ) const;
108 * Secondary class to hold readiness and index into url
112 unsigned int mFrameNumber = 0u;
115 Dali::AnimatedImageLoading& mAnimatedImageLoading;
116 uint32_t mFrameCount;
118 std::vector<UrlStore> mImageUrls;
120 CircularQueue<ImageFrame> mQueue;
123 } // namespace Internal
125 } // namespace Toolkit
129 #endif //DALI_TOOLKIT_INTERNAL_ROLLING_ANIMATED_IMAGE_CACHE_H