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=d19fd091166eefebd4012da19442fc259dc0b1cb;hb=4464c30c30e68c6eee56cda1a201b22eb164fd20;hpb=fb0d31619217589b3da2a9bea27a4adad9d7380a 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 d19fd09..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) 2016 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,151 +19,277 @@ */ // EXTERNAL INCLUDES -#include +#include +#include #include +#include #include -#include +#include // INTERNAL INCLUDES +#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 * - * The following property is essential + * One of the following properties is mandatory * * | %Property Name | Type | * |------------------- |-------------------| * | url | STRING | + * | urls | ARRAY of STRING | + * + * The remaining properties are optional * | pixelArea | VECTOR4 | * | wrapModeU | INTEGER OR STRING | * | wrapModeV | INTEGER OR STRING | + * | cacheSize | INTEGER | + * | batchSize | INTEGER | + * | frameDelay | INTEGER | * - * where pixelArea is a rectangular area. + * pixelArea is a rectangular area. * In its Vector4 value, the first two elements indicate the top-left position of the area, * and the last two elements are the area width and height respectively. * If not specified, the default value is [0.0, 0.0, 1.0, 1.0], i.e. the entire area of the image. * - * where wrapModeU and wrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0. + * wrapModeU and wrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0. * Its value should be one of the following wrap mode: * "DEFAULT" * "CLAMP_TO_EDGE" * "REPEAT" * "MIRRORED_REPEAT" + * + * cacheSize is used with multiple images - it determines how many images are kept pre-loaded + * batchSize is used with multiple images - it determines how many images to load on each frame + * frameDelay is used with multiple images - it is the number of milliseconds between each frame */ -class AnimatedImageVisual : public Visual::Base, public ConnectionTracker +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] imageUrl The URL to svg resource to use + * @param[in] shaderFactory The ImageVisualShaderFactory object + * @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, const std::string& 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. + * + * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object + * @param[in] shaderFactory The ImageVisualShaderFactory object + * @param[in] imageUrls A Property::Array containing the URLs to the image resources + * @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); /** * @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 animated image resource to use */ - static AnimatedImageVisualPtr New( VisualFactoryCache& factoryCache, const std::string& 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; -protected: + /** + * @copydoc Visual::Base::CreateInstancePropertyMap + */ + void DoCreateInstancePropertyMap(Property::Map& map) const override; /** + * @copydoc Visual::Base::OnDoAction + */ + 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 ); + 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; /** - * @copydoc Visual::Base::DoSetOnStage + * Helper method to set individual values by index key. + * @param[in] index The index key of the value + * @param[in] value The value */ - virtual void DoSetOnStage( Actor& actor ); + void DoSetProperty(Property::Index index, const Property::Value& value); /** - * @copydoc Visual::Base::DoSetOffStage + * @copydoc Visual::Base::DoSetOnScene */ - virtual void DoSetOffStage( Actor& actor ); + void DoSetOnScene(Actor& actor) override; + + /** + * @copydoc Visual::Base::DoSetOffScene + */ + 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: + /** + * @brief Initialize the animated image variables. + * @param[in] imageUrl The url of the animated image + */ + void InitializeAnimatedImage(const VisualUrl& imageUrl); + + /** + * @brief Create image cache for animated image or image array. + */ + void CreateImageCache(); + + /** + * @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] firstInterval frame interval(ms) for the first frame. + */ + void StartFirstFrame(TextureSet& textureSet, uint32_t firstInterval); + + /** + * @brief Prepares the texture set for displaying + */ + void PrepareTextureSet(); /** - * Load the animated image and pack the frames into atlas. - * @return That atlas texture. + * @brief Set the image size from the texture set + * @param[in] textureSet The texture set to get the size from */ - Texture PrepareAnimatedImage(); + void SetImageSize(TextureSet& textureSet); /** - * Display the next frame. It is called when the mFrameDelayTimes ticks. + * @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, uint32_t interval) override; + + /** + * @brief Display the next frame. It is called when the mFrameDelayTimer ticks. + * @return true to ensure the timer continues running. */ bool DisplayNextFrame(); + /** + * @brief Set the state of loading fail of an image or a frame. + * @return TextureSet of broken image. + */ + 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; + ImageVisualShaderFactory& mImageVisualShaderFactory; + + // 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; + + // 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 + ImageDimensions mImageSize; - Timer mFrameDelayTimer; - Dali::Vector mTextureRectContainer; - Dali::Vector mFrameDelayContainer; - Vector4 mPixelArea; - std::string mImageUrl; + DevelAnimatedImageVisual::Action::Type mActionStatus; - ImageDimensions mImageSize; - uint32_t mCurrentFrameIndex; - Dali::WrapMode::Type mWrapModeU:3; - Dali::WrapMode::Type mWrapModeV:3; + Dali::WrapMode::Type mWrapModeU : 3; + Dali::WrapMode::Type mWrapModeV : 3; + DevelImageVisual::StopBehavior::Type mStopBehavior : 2; + bool mStartFirstFrame : 1; + bool mIsJumpTo : 1; }; } // namespace Internal