X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fvisuals%2Fanimated-image%2Frolling-animated-image-cache.h;h=8fed2d7c34d752698d05973dbd57677af9edd047;hp=8281c323f45a52fc9e3f85c152377b0babb91c1b;hb=e483020277e28cd5f93a93cf50119edaac49a9e9;hpb=3a2dfe800fe4ec8214f42b28b3851ea8b8ffc72b diff --git a/dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h b/dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h index 8281c32..8fed2d7 100644 --- a/dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h +++ b/dali-toolkit/internal/visuals/animated-image/rolling-animated-image-cache.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_ROLLING_ANIMATED_IMAGE_CACHE_H /* - * Copyright (c) 2020 Samsung Electronics Co., Ltd. + * Copyright (c) 2022 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,10 +18,10 @@ */ // EXTERNAL INCLUDES +#include +#include #include #include -#include -#include namespace Dali { @@ -29,7 +29,6 @@ namespace Toolkit { namespace Internal { - /** * Class to manage a rolling cache of Animated images, where the cache size * is smaller than the total number of images. @@ -41,100 +40,132 @@ class RollingAnimatedImageCache : public ImageCache, public TextureUploadObserve { public: /** - * Constructor. - * @param[in] textureManager The texture manager - * @param[in] animatedImageLoader The loaded animated image - * @param[in] frameCount The number of frames in the animated image - * @param[in] observer FrameReady observer - * @param[in] cacheSize The size of the cache - * @param[in] batchSize The size of a batch to load + * @brief Constructor. + * @param[in] textureManager The texture manager + * @param[in] animatedImageLoading The loaded animated image + * @param[in] maskingData Masking data to be applied. + * @param[in] observer FrameReady observer + * @param[in] cacheSize The size of the cache + * @param[in] batchSize The size of a batch to load + * @param[in] wrapModeU Horizontal Wrap mode + * @param[in] wrapModeV Vertical Wrap mode * @param[in] isSynchronousLoading The flag to define whether to load first frame synchronously + * @param[in] preMultiplyOnLoad The flag if image's color should be multiplied by it's alpha * * This will start loading textures immediately, according to the * batch and cache sizes. */ - RollingAnimatedImageCache( TextureManager& textureManager, - AnimatedImageLoading& animatedImageLoader, - uint32_t frameCount, - ImageCache::FrameReadyObserver& observer, - uint16_t cacheSize, - uint16_t batchSize, - bool isSynchronousLoading ); + RollingAnimatedImageCache(TextureManager& textureManager, + AnimatedImageLoading& animatedImageLoading, + TextureManager::MaskingDataPointer& maskingData, + ImageCache::FrameReadyObserver& observer, + uint16_t cacheSize, + uint16_t batchSize, + const Dali::WrapMode::Type& wrapModeU, + const Dali::WrapMode::Type& wrapModeV, + bool isSynchronousLoading, + bool preMultiplyOnLoad); /** - * Destructor + * @brief Destructor */ - virtual ~RollingAnimatedImageCache(); + ~RollingAnimatedImageCache() override; /** - * Get the Nth frame. If it's not ready, this will trigger the - * sending of FrameReady() when the image becomes ready. + * @copydoc Internal::ImageCache::Frame() */ - TextureSet Frame( uint32_t frameIndex ) override; + TextureSet Frame(uint32_t frameIndex) override; /** - * Get the first frame. If it's not ready, this will trigger the - * sending of FrameReady() when the image becomes ready. + * @copydoc Internal::ImageCache::FirstFrame() */ TextureSet FirstFrame() override; /** - * Get the interval of Nth frame. + * @copydoc Internal::ImageCache::GetFrameInterval() */ - uint32_t GetFrameInterval( uint32_t frameIndex ) override; + uint32_t GetFrameInterval(uint32_t frameIndex) const override; + + /** + * @copydoc Internal::ImageCache::GetCurrentFrameIndex() + */ + int32_t GetCurrentFrameIndex() const override; + + /** + * @copydoc Internal::ImageCache::GetTotalFrameCount() + */ + int32_t GetTotalFrameCount() const override; + + /** + * @copydoc Internal::ImageCache::ClearCache() + */ + void ClearCache() override; private: /** + * @brief Check whether the front frame is ready or not. + * * @return true if the front frame is ready */ bool IsFrontReady() const; /** - * Request to Load a frame + * @brief Request to Load a frame + * + * @param[in] frameIndex index of frame to be loaded. + * @param[in] synchronousLoading true if the frame should be loaded synchronously + * + * @return the texture set currently loaded. */ - void RequestFrameLoading( uint32_t frameIndex ); + TextureSet RequestFrameLoading(uint32_t frameIndex, bool synchronousLoading); /** - * Load the next batch of images + * @brief Load the next batch of images + * + * @param[in] frameIndex starting frame index of batch to be loaded. */ - void LoadBatch(); + void LoadBatch(uint32_t frameIndex); /** - * Find the matching image frame, and set it to ready + * @brief Find the matching image frame, and set it to ready + * + * @param[in] textureId texture id to be marked as ready. */ - void SetImageFrameReady( TextureManager::TextureId textureId ); + void SetImageFrameReady(TextureManager::TextureId textureId); /** - * Get the texture set of the front frame. - * @return the texture set + * @brief Get the texture set of the front frame. + * + * @return the texture set of the front of Cache. */ TextureSet GetFrontTextureSet() const; /** - * Get the texture id of the given index + * @brief Get the texture id of the given index + * + * @param[in] index index of the queue. */ - TextureManager::TextureId GetCachedTextureId( int index ) const; + TextureManager::TextureId GetCachedTextureId(int index) const; /** - * Check if the front frame has become ready - if so, inform observer - * @param[in] wasReady Readiness before call. + * @brief Make the loaded frame ready and notify it to the texture upload observer + * + * @param[in] loadSuccess whether the loading is succeded or not. + * @param[in] textureSet textureSet for this frame. + * @param[in] interval interval between this frame and next frame. */ - void CheckFrontFrame( bool wasReady ); + void MakeFrameReady(bool loadSuccess, TextureSet textureSet, uint32_t interval); + + /** + * @brief Pop front entity of Cache. + */ + void PopFrontCache(); protected: - void UploadComplete( - bool loadSuccess, - int32_t textureId, - TextureSet textureSet, - bool useAtlasing, - const Vector4& atlasRect, - bool preMultiplied ) override; - - void LoadComplete( - bool loadSuccess, - Devel::PixelBuffer pixelBuffer, - const VisualUrl& url, - bool preMultiplied ) override; + /** + * @copydoc Toolkit::TextureUploadObserver::LoadComplete() + */ + void LoadComplete(bool loadSuccess, TextureInformation textureInformation) override; private: /** @@ -142,19 +173,23 @@ private: */ struct ImageFrame { - unsigned int mFrameNumber = 0u; - bool mReady = false; + uint32_t mFrameNumber = 0u; + bool mReady = false; }; - - Dali::AnimatedImageLoading mAnimatedImageLoading; - uint32_t mFrameCount; - int mFrameIndex; - std::vector mImageUrls; - std::vector mIntervals; - std::vector mLoadWaitingQueue; - CircularQueue mQueue; - bool mIsSynchronousLoading; - bool mOnLoading; + std::vector mTextureIds; + + VisualUrl mImageUrl; + Dali::AnimatedImageLoading mAnimatedImageLoading; + uint32_t mFrameCount; + uint32_t mFrameIndex; + uint32_t mCacheSize; + std::vector mIntervals; + std::vector mLoadWaitingQueue; + CircularQueue mQueue; + Dali::WrapMode::Type mWrapModeU : 3; + Dali::WrapMode::Type mWrapModeV : 3; + bool mIsSynchronousLoading; + bool mPreMultiplyOnLoad; }; } // namespace Internal