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%2Fanimated-image-visual.h;h=4acb736ab7c9665f648c8745ae3bab7c5b73f452;hp=b5fbb2e7d4a1d739128bb884a59804cb3760d478;hb=4464c30c30e68c6eee56cda1a201b22eb164fd20;hpb=70cda53a32b66bcc77619835cc06049635043d91 diff --git a/dali-toolkit/internal/visuals/animated-image/animated-image-visual.h b/dali-toolkit/internal/visuals/animated-image/animated-image-visual.h index b5fbb2e..4acb736 100644 --- a/dali-toolkit/internal/visuals/animated-image/animated-image-visual.h +++ b/dali-toolkit/internal/visuals/animated-image/animated-image-visual.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_ANIMATED_IMAGE_VISUAL_H /* - * Copyright (c) 2018 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 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. @@ -19,31 +19,29 @@ */ // EXTERNAL INCLUDES +#include +#include #include #include #include #include -#include -#include // INTERNAL INCLUDES +#include +#include +#include #include #include -#include -#include namespace Dali { - namespace Toolkit { - namespace Internal { - class ImageVisualShaderFactory; class AnimatedImageVisual; -typedef IntrusivePtr< AnimatedImageVisual > AnimatedImageVisualPtr; +typedef IntrusivePtr AnimatedImageVisualPtr; /** * The visual which renders an animated image @@ -84,19 +82,17 @@ class AnimatedImageVisual : public Visual::Base, public ConnectionTracker, public ImageCache::FrameReadyObserver { - public: - /** * @brief Create the animated image Visual using the image URL. * * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object * @param[in] shaderFactory The ImageVisualShaderFactory object - * @param[in] imageUrl The URL to gif resource to use + * @param[in] imageUrl The URL to animated image resource to use * @param[in] properties A Property::Map containing settings for this visual * @return A smart-pointer to the newly allocated visual. */ - static AnimatedImageVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties ); + static AnimatedImageVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties); /** * @brief Create the animated image Visual using image URLs. @@ -107,7 +103,7 @@ public: * @param[in] properties A Property::Map containing settings for this visual * @return A smart-pointer to the newly allocated visual. */ - static AnimatedImageVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Property::Array& imageUrls, const Property::Map& properties ); + static AnimatedImageVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Property::Array& imageUrls, const Property::Map& properties); /** * @brief Create the animated image visual using the image URL. @@ -116,156 +112,184 @@ public: * @param[in] shaderFactory The ImageVisualShaderFactory object * @param[in] imageUrl The URL to animated image resource to use */ - static AnimatedImageVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl ); - -public: // from Visual + static AnimatedImageVisualPtr New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl); +public: // from Visual /** * @copydoc Visual::Base::GetNaturalSize */ - virtual void GetNaturalSize( Vector2& naturalSize ); + void GetNaturalSize(Vector2& naturalSize) override; /** * @copydoc Visual::Base::CreatePropertyMap */ - virtual void DoCreatePropertyMap( Property::Map& map ) const; + void DoCreatePropertyMap(Property::Map& map) const override; /** * @copydoc Visual::Base::CreateInstancePropertyMap */ - virtual void DoCreateInstancePropertyMap( Property::Map& map ) const; + void DoCreateInstancePropertyMap(Property::Map& map) const override; /** * @copydoc Visual::Base::OnDoAction */ - virtual void OnDoAction( const Dali::Property::Index actionName, const Dali::Property::Value& attributes ) override; + void OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes) override; protected: - /** * @brief Constructor. * * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object * @param[in] shaderFactory The ImageVisualShaderFactory object */ - AnimatedImageVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory ); + AnimatedImageVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory); /** * @brief A reference counted object may only be deleted by calling Unreference(). */ - virtual ~AnimatedImageVisual(); + ~AnimatedImageVisual() override; + + /** + * @copydoc Visual::Base::OnInitialize + */ + void OnInitialize() override; /** * @copydoc Visual::Base::DoSetProperties */ - virtual void DoSetProperties( const Property::Map& propertyMap ); + void DoSetProperties(const Property::Map& propertyMap) override; /** * Helper method to set individual values by index key. * @param[in] index The index key of the value * @param[in] value The value */ - void DoSetProperty( Property::Index index, const Property::Value& value ); + void DoSetProperty(Property::Index index, const Property::Value& value); /** - * @copydoc Visual::Base::DoSetOnStage + * @copydoc Visual::Base::DoSetOnScene */ - virtual void DoSetOnStage( Actor& actor ); + void DoSetOnScene(Actor& actor) override; /** - * @copydoc Visual::Base::DoSetOffStage + * @copydoc Visual::Base::DoSetOffScene */ - virtual void DoSetOffStage( Actor& actor ); + void DoSetOffScene(Actor& actor) override; /** * @copydoc Visual::Base::OnSetTransform */ - virtual void OnSetTransform(); + void OnSetTransform() override; + + /** + * @copydoc Visual::Base::UpdateShader + */ + void UpdateShader() override; + + /** + * @copydoc Visual::Base::GenerateShader + */ + Shader GenerateShader() const override; private: /** - * Creates the renderer for the animated image + * @brief Initialize the animated image variables. + * @param[in] imageUrl The url of the animated image */ - void CreateRenderer(); + void InitializeAnimatedImage(const VisualUrl& imageUrl); /** - * Starts the Load of the first batch of URLs + * @brief Create image cache for animated image or image array. */ - void LoadFirstBatch(); + void CreateImageCache(); /** - * Adds the texture set to the renderer, and the renderer to the + * @brief Adds the texture set to the renderer, and the renderer to the * placement actor, and starts the frame timer - * @param[in] textureSet The texture set to apply + * @param[in] textureSet The texture set to apply + * @param[in] firstInterval frame interval(ms) for the first frame. */ - void StartFirstFrame( TextureSet& textureSet ); + void StartFirstFrame(TextureSet& textureSet, uint32_t firstInterval); /** - * Prepares the texture set for displaying + * @brief Prepares the texture set for displaying */ - TextureSet PrepareTextureSet(); + void PrepareTextureSet(); /** - * Set the image size from the texture set + * @brief Set the image size from the texture set * @param[in] textureSet The texture set to get the size from */ - void SetImageSize( TextureSet& textureSet ); + void SetImageSize(TextureSet& textureSet); /** - * Called when the next frame is ready. + * @brief Called when the next frame is ready. * @param[in] textureSet the texture set to apply + * @param[in] interval interval(ms) for the frame */ - void FrameReady( TextureSet textureSet ); + void FrameReady(TextureSet textureSet, uint32_t interval) override; /** - * Display the next frame. It is called when the mFrameDelayTimer ticks. - * Returns true to ensure the timer continues running. + * @brief Display the next frame. It is called when the mFrameDelayTimer ticks. + * @return true to ensure the timer continues running. */ bool DisplayNextFrame(); /** - * Initialize the gif variables. - * @param[in] imageUrl The url of the animated gif + * @brief Set the state of loading fail of an image or a frame. + * @return TextureSet of broken image. */ - void InitializeGif( const VisualUrl& imageUrl ); + TextureSet SetLoadingFailed(); + + /** + * @brief Allocate mask data. + * This is allocated only once. + */ + void AllocateMaskData(); // Undefined - AnimatedImageVisual( const AnimatedImageVisual& animatedImageVisual ); + AnimatedImageVisual(const AnimatedImageVisual& animatedImageVisual); // Undefined - AnimatedImageVisual& operator=( const AnimatedImageVisual& animatedImageVisual ); + AnimatedImageVisual& operator=(const AnimatedImageVisual& animatedImageVisual); private: - - Timer mFrameDelayTimer; - WeakHandle mPlacementActor; + Timer mFrameDelayTimer; + WeakHandle mPlacementActor; ImageVisualShaderFactory& mImageVisualShaderFactory; - // Variables for GIF player - Dali::Vector mFrameDelayContainer; - Vector4 mPixelArea; - VisualUrl mImageUrl; - std::unique_ptr mGifLoading; // Only needed for animated gifs - uint32_t mCurrentFrameIndex; // Frame index into textureRects + // Variables for Animated Image player + Vector4 mPixelArea; + VisualUrl mImageUrl; + Dali::AnimatedImageLoading mAnimatedImageLoading; // Only needed for animated image + uint32_t mFrameIndexForJumpTo; // Frame index into textureRects + uint32_t mCurrentFrameIndex; // Variables for Multi-Image player ImageCache::UrlList* mImageUrls; - ImageCache* mImageCache; - uint16_t mCacheSize; - uint16_t mBatchSize; - uint16_t mFrameDelay; - int16_t mLoopCount; - int16_t mCurrentLoopIndex; - uint16_t mUrlIndex; + ImageCache* mImageCache; + uint16_t mCacheSize; + uint16_t mBatchSize; + uint16_t mFrameDelay; + int16_t mLoopCount; + int16_t mCurrentLoopIndex; + + // Variables for image visual properties. + Dali::Toolkit::ImageVisual::LoadPolicy::Type mLoadPolicy; + Dali::Toolkit::ImageVisual::ReleasePolicy::Type mReleasePolicy; + TextureManager::MaskingDataPointer mMaskingData; // Shared variables - uint32_t mFrameCount; // Number of frames + uint32_t mFrameCount; // Number of frames ImageDimensions mImageSize; - Dali::WrapMode::Type mWrapModeU:3; - Dali::WrapMode::Type mWrapModeV:3; - DevelAnimatedImageVisual::Action::Type mActionStatus:2; - bool mStartFirstFrame:1; + DevelAnimatedImageVisual::Action::Type mActionStatus; + + Dali::WrapMode::Type mWrapModeU : 3; + Dali::WrapMode::Type mWrapModeV : 3; + DevelImageVisual::StopBehavior::Type mStopBehavior : 2; + bool mStartFirstFrame : 1; + bool mIsJumpTo : 1; }; } // namespace Internal