X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fvisuals%2Fimage%2Fimage-visual.cpp;h=82f7fd14cb34450513ea055a55f5211a802f59d9;hp=27c91e2d8eba7463acddc800b1b8a32cd40b3dc3;hb=a0031834b728e9f87f39be2e191f145b7b98fa86;hpb=d375dceca213569317d81d17cd2d2a4b45122cda diff --git a/dali-toolkit/internal/visuals/image/image-visual.cpp b/dali-toolkit/internal/visuals/image/image-visual.cpp index 27c91e2..82f7fd1 100644 --- a/dali-toolkit/internal/visuals/image/image-visual.cpp +++ b/dali-toolkit/internal/visuals/image/image-visual.cpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2017 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. @@ -21,10 +21,10 @@ // EXTERNAL HEADERS #include // for strlen() #include +#include #include #include #include -#include #include #include #include @@ -32,9 +32,8 @@ // INTERNAL HEADERS #include -#include -#include -#include +#include +#include #include #include #include @@ -62,6 +61,7 @@ const char * const IMAGE_DESIRED_WIDTH( "desiredWidth" ); const char * const IMAGE_DESIRED_HEIGHT( "desiredHeight" ); const char * const SYNCHRONOUS_LOADING( "synchronousLoading" ); const char * const IMAGE_ATLASING("atlasing"); +const char * const ALPHA_MASK_URL("alphaMaskUrl"); // fitting modes DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE ) @@ -91,6 +91,13 @@ DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT ) DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT ) DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE ) +// release policies +DALI_ENUM_TO_STRING_TABLE_BEGIN( RELEASE_POLICY ) +DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::ReleasePolicy, DETACHED ) +DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::ReleasePolicy, DESTROYED ) +DALI_ENUM_TO_STRING_WITH_SCOPE( DevelImageVisual::ReleasePolicy, NEVER ) +DALI_ENUM_TO_STRING_TABLE_END( RELEASE_POLICY ) + const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f); const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D"; @@ -257,41 +264,63 @@ ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, Dali::SamplingMode::Type samplingMode ) : Visual::Base( factoryCache ), mImage(), - mPixels(), mPixelArea( FULL_TEXTURE_RECT ), mPlacementActor(), mImageUrl( imageUrl ), + mMaskingData( ), mDesiredSize( size ), mTextureId( TextureManager::INVALID_TEXTURE_ID ), mFittingMode( fittingMode ), mSamplingMode( samplingMode ), mWrapModeU( WrapMode::DEFAULT ), mWrapModeV( WrapMode::DEFAULT ), + mReleasePolicy( DevelImageVisual::ReleasePolicy::DETACHED ), mAttemptAtlasing( false ), - mTextureLoading( false ) + mLoading( false ) { } ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image ) : Visual::Base( factoryCache ), mImage( image ), - mPixels(), mPixelArea( FULL_TEXTURE_RECT ), mPlacementActor(), mImageUrl(), + mMaskingData( ), mDesiredSize(), mTextureId( TextureManager::INVALID_TEXTURE_ID ), mFittingMode( FittingMode::DEFAULT ), mSamplingMode( SamplingMode::DEFAULT ), mWrapModeU( WrapMode::DEFAULT ), mWrapModeV( WrapMode::DEFAULT ), + mReleasePolicy( DevelImageVisual::ReleasePolicy::DESTROYED ), mAttemptAtlasing( false ), - mTextureLoading( false ) + mLoading( false ) { } ImageVisual::~ImageVisual() { + if( Stage::IsInstalled() ) + { + if( mMaskingData ) + { + // TextureManager could have been deleted before the actor that contains this + // ImageVisual is destroyed (e.g. due to stage shutdown). Ensure the stage + // is still valid before accessing texture manager. + if( mMaskingData->mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID ) + { + TextureManager& textureManager = mFactoryCache.GetTextureManager(); + textureManager.Remove( mMaskingData->mAlphaMaskId ); + } + } + + // ImageVisual destroyed so remove texture unless ReleasePolicy is set to never release + if( ( mTextureId != TextureManager::INVALID_TEXTURE_ID ) && ( mReleasePolicy != DevelImageVisual::ReleasePolicy::NEVER ) ) + { + RemoveTexture(); + } + } } void ImageVisual::DoSetProperties( const Property::Map& propertyMap ) @@ -338,21 +367,28 @@ void ImageVisual::DoSetProperties( const Property::Map& propertyMap ) { DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second ); } - else if ( keyValue.first == IMAGE_ATLASING ) + else if( keyValue.first == IMAGE_ATLASING ) + { + DoSetProperty( Toolkit::ImageVisual::Property::ATLASING, keyValue.second ); + } + else if( keyValue.first == ALPHA_MASK_URL ) + { + DoSetProperty( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second ); + } + else if( keyValue.first == MASK_CONTENT_SCALE_NAME ) + { + DoSetProperty( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second ); + } + else if( keyValue.first == CROP_TO_MASK_NAME ) { - DoSetProperty( Toolkit::DevelImageVisual::Property::ATLASING, keyValue.second ); + DoSetProperty( Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second ); + } + else if( keyValue.first == RELEASE_POLICY_NAME ) + { + DoSetProperty( Toolkit::DevelImageVisual::Property::RELEASE_POLICY, keyValue.second ); } } } - - if( ( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING ) && mImageUrl.IsValid() ) - { - // if sync loading is required, the loading should start - // immediately when new image url is set or the actor is off stage - // ( for on-stage actor with image url unchanged, resource loading - // is already finished ) - LoadResourceSynchronously(); - } } void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value ) @@ -446,11 +482,64 @@ void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& v break; } - case Toolkit::DevelImageVisual::Property::ATLASING: + case Toolkit::ImageVisual::Property::ATLASING: { bool atlasing = false; mAttemptAtlasing = value.Get( atlasing ); + break; + } + + case Toolkit::ImageVisual::Property::ALPHA_MASK_URL: + { + std::string alphaUrl; + if( value.Get( alphaUrl ) ) + { + AllocateMaskData(); + // Immediately trigger the alpha mask loading (it may just get a cached value) + mMaskingData->mAlphaMaskUrl = alphaUrl; + TextureManager& textureManager = mFactoryCache.GetTextureManager(); + mMaskingData->mAlphaMaskId = textureManager.RequestMaskLoad( alphaUrl ); + } + break; + } + + case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE: + { + float scale; + if( value.Get( scale ) ) + { + AllocateMaskData(); + mMaskingData->mContentScaleFactor = scale; + } + break; } + + case Toolkit::ImageVisual::Property::CROP_TO_MASK: + { + bool crop=false; + if( value.Get( crop ) ) + { + AllocateMaskData(); + mMaskingData->mCropToMask = crop; + } + break; + } + + case Toolkit::DevelImageVisual::Property::RELEASE_POLICY: + { + int releasePolicy; + Scripting::GetEnumerationProperty( value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy ); + mReleasePolicy = DevelImageVisual::ReleasePolicy::Type( releasePolicy ); + break; + } + } +} + +void ImageVisual::AllocateMaskData() +{ + if( !mMaskingData ) + { + mMaskingData.reset(new TextureManager::MaskingData()); } } @@ -468,13 +557,51 @@ void ImageVisual::GetNaturalSize( Vector2& naturalSize ) naturalSize.y = mDesiredSize.GetHeight(); return; } - else if( mImageUrl.IsValid() && mImageUrl.GetLocation() == VisualUrl::LOCAL ) + else if( mImpl->mRenderer ) // Check if we have a loaded image { - ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() ); - naturalSize.x = dimensions.GetWidth(); - naturalSize.y = dimensions.GetHeight(); + auto textureSet = mImpl->mRenderer.GetTextures(); + + if( textureSet ) + { + auto texture = textureSet.GetTexture(0); + naturalSize.x = texture.GetWidth(); + naturalSize.y = texture.GetHeight(); + return; + } + } + + if( mMaskingData != NULL && mMaskingData->mAlphaMaskUrl.IsValid() && + mMaskingData->mCropToMask ) + { + ImageDimensions dimensions = Dali::GetClosestImageSize( mMaskingData->mAlphaMaskUrl.GetUrl() ); + if( dimensions != ImageDimensions( 0, 0 ) ) + { + naturalSize.x = dimensions.GetWidth(); + naturalSize.y = dimensions.GetHeight(); + } return; } + else if( mImageUrl.IsValid() ) + { + if( mImageUrl.GetProtocolType() == VisualUrl::LOCAL ) + { + ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() ); + + if( dimensions != ImageDimensions( 0, 0 ) ) + { + naturalSize.x = dimensions.GetWidth(); + naturalSize.y = dimensions.GetHeight(); + } + else + { + Image brokenImage = VisualFactoryCache::GetBrokenVisualImage(); + + naturalSize.x = brokenImage.GetWidth(); + naturalSize.y = brokenImage.GetWidth(); + } + return; + } + } naturalSize = Vector2::ZERO; } @@ -511,7 +638,10 @@ void ImageVisual::CreateRenderer( TextureSet& textureSet ) } } - shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_ON ); // Set default to align + // Set pixel align off as default. + // ToDo: Pixel align causes issues such as rattling image animation. + // We should trun it off until issues are resolved + shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF ); mImpl->mRenderer = Renderer::New( geometry, shader ); if( textureSet ) @@ -584,105 +714,42 @@ bool ImageVisual::IsSynchronousResourceLoading() const return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING; } -void ImageVisual::LoadResourceSynchronously() -{ - if( mImageUrl.IsValid() ) - { - BitmapLoader loader = BitmapLoader::New( mImageUrl.GetUrl(), mDesiredSize, mFittingMode, mSamplingMode ); - loader.Load(); - mPixels = loader.GetPixelData(); - mTextureLoading = false; - } -} - -TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing ) -{ - TextureSet textureSet; - - mTextureLoading = false; - - textureRect = FULL_TEXTURE_RECT; - if( synchronousLoading ) - { - if( !mPixels ) - { - // use broken image - textureSet = TextureSet::New(); - TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() ); - } - else - { - if( attemptAtlasing ) - { - textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels ); - mImpl->mFlags |= Impl::IS_ATLASING_APPLIED; - } - if( !textureSet ) // big image, no atlasing or atlasing failed - { - mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED; - Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(), - mPixels.GetWidth(), mPixels.GetHeight() ); - texture.Upload( mPixels ); - textureSet = TextureSet::New(); - textureSet.SetTexture( 0u, texture ); - } - } - } - else - { - if( attemptAtlasing ) - { - textureSet = mFactoryCache.GetAtlasManager()->Add( textureRect, mImageUrl.GetUrl(), mDesiredSize, mFittingMode, true, this ); - mImpl->mFlags |= Impl::IS_ATLASING_APPLIED; - mTextureLoading = true; - } - if( !textureSet ) // big image, no atlasing or atlasing failed - { - mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED; - TextureManager& textureManager = mFactoryCache.GetTextureManager(); - mTextureId = textureManager.RequestLoad( mImageUrl, mDesiredSize, mFittingMode, - mSamplingMode, TextureManager::NO_ATLAS, this ); - - TextureManager::LoadState loadState = textureManager.GetTextureState( mTextureId ); - - mTextureLoading = ( loadState == TextureManager::LOADING ); - - if( loadState == TextureManager::UPLOADED ) - { - // UploadComplete has already been called - keep the same texture set - textureSet = textureManager.GetTextureSet(mTextureId); - } - } - } - - if( ! (mImpl->mFlags & Impl::IS_ATLASING_APPLIED) && textureSet ) - { - Sampler sampler = Sampler::New(); - sampler.SetWrapMode( mWrapModeU, mWrapModeV ); - textureSet.SetSampler( 0u, sampler ); - } - - return textureSet; -} - +/* +( VisualUrl& url, Dali::ImageDimensions desiredSize, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode, + ImageVisual::MaskingData* maskInfo, bool synchronousLoading, + TextureManager::TextureId textureId, Vector4& textureRect, bool& atlasingStatus, bool& loadingStatus + */ void ImageVisual::InitializeRenderer() { mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED; - if( ! mImpl->mCustomShader && mImageUrl.GetLocation() == VisualUrl::LOCAL ) + TextureManager& textureManager = mFactoryCache.GetTextureManager(); + + if( ! mImpl->mCustomShader && mImageUrl.GetProtocolType() == VisualUrl::LOCAL ) { bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE; Vector4 atlasRect; + + auto attemptAtlasing = mAttemptAtlasing; + // texture set has to be created first as we need to know if atlasing succeeded or not // when selecting the shader - TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), mAttemptAtlasing ); + TextureSet textures = + textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode, + mMaskingData, IsSynchronousResourceLoading(), mTextureId, + atlasRect, attemptAtlasing, mLoading, mWrapModeU, + mWrapModeV, this, this, mFactoryCache.GetAtlasManager()); + if(attemptAtlasing) + { + mImpl->mFlags |= Impl::IS_ATLASING_APPLIED; + } CreateRenderer( textures ); if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas { mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect ); - if( !defaultWrapMode ) // custom wrap mode, renderer is not cached. + if( !defaultWrapMode ) // custom wrap mode { Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE); wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) ); @@ -692,19 +759,23 @@ void ImageVisual::InitializeRenderer() } else { + auto attemptAtlasing = false; // for custom shader or remote image, atlas is not applied Vector4 atlasRect; // ignored in this case - TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), false ); + TextureSet textures = + textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode, + mMaskingData, IsSynchronousResourceLoading(), mTextureId, + atlasRect, attemptAtlasing, mLoading, mWrapModeU, mWrapModeV, this, + nullptr, nullptr); // no atlasing + DALI_ASSERT_DEBUG(attemptAtlasing == false); CreateRenderer( textures ); } } void ImageVisual::InitializeRenderer( const Image& image ) { - // don't reuse CreateTextureSet TextureSet textures = TextureSet::New(); - // Renderer can't be shared if mImage is NativeImage NativeImage nativeImage = NativeImage::DownCast( image ); if( nativeImage ) { @@ -726,12 +797,12 @@ void ImageVisual::DoSetOnStage( Actor& actor ) { InitializeRenderer(); } - else if ( mImage ) + else if( mImage ) { InitializeRenderer( mImage ); } - if ( !mImpl->mRenderer ) + if( !mImpl->mRenderer ) { return; } @@ -739,7 +810,7 @@ void ImageVisual::DoSetOnStage( Actor& actor ) mPlacementActor = actor; // Search the Actor tree to find if Layer UI behaviour set. Layer layer = actor.GetLayer(); - if ( layer && layer.GetBehavior() == Layer::LAYER_3D ) + if( layer && layer.GetBehavior() == Layer::LAYER_3D ) { // Layer 3D set, do not align pixels mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF ); @@ -750,7 +821,7 @@ void ImageVisual::DoSetOnStage( Actor& actor ) mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea ); } - if( mTextureLoading == false ) + if( mLoading == false ) { actor.AddRenderer( mImpl->mRenderer ); mPlacementActor.Reset(); @@ -764,14 +835,19 @@ void ImageVisual::DoSetOffStage( Actor& actor ) { // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage) - //If we own the image then make sure we release it when we go off stage + // Image release is dependent on the ReleasePolicy, renderer is destroyed. actor.RemoveRenderer( mImpl->mRenderer); + if( mReleasePolicy == DevelImageVisual::ReleasePolicy::DETACHED ) + { + RemoveTexture(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas + } + if( mImageUrl.IsValid() ) { - RemoveTexture( mImageUrl.GetUrl() ); + // Legacy support for deprecated Dali::Image mImage.Reset(); } - mTextureLoading = false; + mLoading = false; mImpl->mRenderer.Reset(); mPlacementActor.Reset(); } @@ -779,7 +855,7 @@ void ImageVisual::DoSetOffStage( Actor& actor ) void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const { map.Clear(); - map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE ); + map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE ); bool sync = IsSynchronousResourceLoading(); map.Insert( SYNCHRONOUS_LOADING, sync ); @@ -808,13 +884,22 @@ void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU ); map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV ); - map.Insert( Toolkit::DevelImageVisual::Property::ATLASING, mAttemptAtlasing ); + map.Insert( Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing ); + if( mMaskingData != NULL ) + { + map.Insert( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl() ); + map.Insert( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor ); + map.Insert( Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask ); + } + + map.Insert( Toolkit::DevelImageVisual::Property::RELEASE_POLICY, mReleasePolicy ); + } void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const { map.Clear(); - map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE ); + map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE ); if( mImageUrl.IsValid() ) { map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() ); @@ -901,11 +986,11 @@ void ImageVisual::UploadCompleted() // reset the weak handle so that the renderer only get added to actor once mPlacementActor.Reset(); } - mTextureLoading = false; + mLoading = false; } // From Texture Manager -void ImageVisual::UploadComplete( bool loadingSuccess, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle ) +void ImageVisual::UploadComplete( bool loadingSuccess, int32_t textureId, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle ) { Actor actor = mPlacementActor.GetHandle(); if( actor ) @@ -926,16 +1011,20 @@ void ImageVisual::UploadComplete( bool loadingSuccess, TextureSet textureSet, bo else { Image brokenImage = VisualFactoryCache::GetBrokenVisualImage(); + + textureSet = TextureSet::New(); + mImpl->mRenderer.SetTextures( textureSet ); + ApplyImageToSampler( brokenImage ); } // Image loaded and ready to display ResourceReady(); } } - mTextureLoading = false; + mLoading = false; } -void ImageVisual::RemoveTexture(const std::string& url) +void ImageVisual::RemoveTexture() { if( mTextureId != TextureManager::INVALID_TEXTURE_ID ) {