2 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "super-blur-view-impl.h"
23 #include <dali/public-api/animation/constraint.h>
24 #include <dali/devel-api/common/stage.h>
25 #include <dali/public-api/object/property-map.h>
26 #include <dali/public-api/object/type-registry.h>
27 #include <dali/public-api/object/type-registry-helper.h>
28 #include <dali/public-api/rendering/renderer.h>
29 #include <dali/devel-api/scripting/scripting.h>
30 #include <dali/integration-api/debug.h>
33 #include <dali-toolkit/public-api/image-loader/sync-image-loader.h>
34 #include <dali-toolkit/devel-api/controls/control-devel.h>
35 #include <dali-toolkit/internal/controls/control/control-renderers.h>
36 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
37 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
38 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
40 namespace //Unnamed namespace
45 //Todo: make these properties instead of constants
46 const unsigned int GAUSSIAN_BLUR_DEFAULT_NUM_SAMPLES = 11;
47 const unsigned int GAUSSIAN_BLUR_NUM_SAMPLES_INCREMENTATION = 10;
48 const float GAUSSIAN_BLUR_BELL_CURVE_WIDTH = 4.5f;
49 const float GAUSSIAN_BLUR_BELL_CURVE_WIDTH_INCREMENTATION = 5.f;
50 const Pixel::Format GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT = Pixel::RGBA8888;
51 const float GAUSSIAN_BLUR_DOWNSAMPLE_WIDTH_SCALE = 0.5f;
52 const float GAUSSIAN_BLUR_DOWNSAMPLE_HEIGHT_SCALE = 0.5f;
54 const char* ALPHA_UNIFORM_NAME( "uAlpha" );
55 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
56 varying mediump vec2 vTexCoord;\n
57 uniform sampler2D sTexture;\n
58 uniform lowp vec4 uColor;\n
59 uniform lowp float uAlpha;\n
63 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor;\n
64 gl_FragColor.a *= uAlpha;
69 * The constraint is used to blend the group of blurred images continuously with a unified blur strength property value which ranges from zero to one.
71 struct ActorOpacityConstraint
73 ActorOpacityConstraint(int totalImageNum, int currentImageIdx)
75 float rangeLength = 1.f / static_cast<float>( totalImageNum );
76 float index = static_cast<float>( currentImageIdx );
77 mRange = Vector2( index*rangeLength, (index+1.f)*rangeLength );
80 void operator()( float& current, const PropertyInputContainer& inputs )
82 float blurStrength = inputs[0]->GetFloat();
83 if(blurStrength < mRange.x)
87 else if(blurStrength > mRange.y)
93 current = ( blurStrength - mRange.x) / ( mRange.y - mRange.x );
114 const unsigned int DEFAULT_BLUR_LEVEL(5u); ///< The default blur level when creating SuperBlurView from the type registry
118 return Toolkit::SuperBlurView::New( DEFAULT_BLUR_LEVEL );
121 // Setup properties, signals and actions using the type-registry.
122 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::SuperBlurView, Toolkit::Control, Create )
124 DALI_PROPERTY_REGISTRATION( Toolkit, SuperBlurView, "imageUrl", STRING, IMAGE_URL )
126 DALI_TYPE_REGISTRATION_END()
128 } // unnamed namespace
130 SuperBlurView::SuperBlurView( unsigned int blurLevels )
131 : Control( ControlBehaviour( DISABLE_SIZE_NEGOTIATION | DISABLE_STYLE_CHANGE_SIGNALS ) ),
132 mTargetSize( Vector2::ZERO ),
133 mBlurStrengthPropertyIndex(Property::INVALID_INDEX),
134 mBlurLevels( blurLevels ),
135 mResourcesCleared( true )
137 DALI_ASSERT_ALWAYS( mBlurLevels > 0 && " Minimal blur level is one, otherwise no blur is needed" );
138 mGaussianBlurView.assign( blurLevels, Toolkit::GaussianBlurView() );
139 mBlurredImage.assign( blurLevels, FrameBuffer() );
140 mRenderers.assign( blurLevels+1, Dali::Renderer() );
142 DevelControl::SetAccessibilityConstructor( Self(), []( Dali::Actor actor ) {
143 return std::unique_ptr< Dali::Accessibility::Accessible >(
144 new Control::Impl::AccessibleImpl( actor, Dali::Accessibility::Role::FILLER ) );
148 SuperBlurView::~SuperBlurView()
152 Toolkit::SuperBlurView SuperBlurView::New( unsigned int blurLevels )
154 //Create the implementation
155 IntrusivePtr<SuperBlurView> superBlurView( new SuperBlurView( blurLevels ) );
157 //Pass ownership to CustomActor via derived handle
158 Toolkit::SuperBlurView handle( *superBlurView );
160 // Second-phase init of the implementation
161 // This can only be done after the CustomActor connection has been made...
162 superBlurView->Initialize();
167 void SuperBlurView::OnInitialize()
169 Actor self( Self() );
171 mBlurStrengthPropertyIndex = self.RegisterProperty( "blurStrength", 0.f );
174 void SuperBlurView::SetTexture( Texture texture )
176 mInputTexture = texture;
178 if( mTargetSize == Vector2::ZERO )
185 Actor self( Self() );
187 BlurTexture( 0, mInputTexture );
188 SetRendererTexture( mRenderers[0], texture );
191 for(; i<mBlurLevels; i++)
193 BlurTexture( i, mBlurredImage[i-1].GetColorTexture() );
194 SetRendererTexture( mRenderers[i], mBlurredImage[i-1] );
197 SetRendererTexture( mRenderers[i], mBlurredImage[i-1] );
199 mResourcesCleared = false;
202 Property::Index SuperBlurView::GetBlurStrengthPropertyIndex() const
204 return mBlurStrengthPropertyIndex;
207 void SuperBlurView::SetBlurStrength( float blurStrength )
209 Self().SetProperty(mBlurStrengthPropertyIndex, blurStrength);
212 float SuperBlurView::GetCurrentBlurStrength() const
215 (Self().GetProperty( mBlurStrengthPropertyIndex )).Get(blurStrength);
220 Toolkit::SuperBlurView::SuperBlurViewSignal& SuperBlurView::BlurFinishedSignal()
222 return mBlurFinishedSignal;
225 Texture SuperBlurView::GetBlurredTexture( unsigned int level )
227 DALI_ASSERT_ALWAYS( level>0 && level<=mBlurLevels );
229 FrameBuffer frameBuffer = mBlurredImage[level-1];
231 return frameBuffer.GetColorTexture();
234 void SuperBlurView::BlurTexture( unsigned int idx, Texture texture )
236 DALI_ASSERT_ALWAYS( mGaussianBlurView.size()>idx );
237 mGaussianBlurView[idx] = Toolkit::GaussianBlurView::New( GAUSSIAN_BLUR_DEFAULT_NUM_SAMPLES+GAUSSIAN_BLUR_NUM_SAMPLES_INCREMENTATION*idx,
238 GAUSSIAN_BLUR_BELL_CURVE_WIDTH + GAUSSIAN_BLUR_BELL_CURVE_WIDTH_INCREMENTATION*static_cast<float>(idx),
239 GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT,
240 GAUSSIAN_BLUR_DOWNSAMPLE_WIDTH_SCALE, GAUSSIAN_BLUR_DOWNSAMPLE_HEIGHT_SCALE, true );
241 mGaussianBlurView[idx].SetProperty( Actor::Property::PARENT_ORIGIN,ParentOrigin::CENTER );
242 mGaussianBlurView[idx].SetProperty( Actor::Property::SIZE, mTargetSize );
243 Stage::GetCurrent().Add( mGaussianBlurView[idx] );
245 mGaussianBlurView[idx].SetUserImageAndOutputRenderTarget( texture, mBlurredImage[idx] );
247 mGaussianBlurView[idx].ActivateOnce();
248 if( idx == mBlurLevels-1 )
250 mGaussianBlurView[idx].FinishedSignal().Connect( this, &SuperBlurView::OnBlurViewFinished );
254 void SuperBlurView::OnBlurViewFinished( Toolkit::GaussianBlurView blurView )
257 Toolkit::SuperBlurView handle( GetOwner() );
258 mBlurFinishedSignal.Emit( handle );
261 void SuperBlurView::ClearBlurResource()
263 if( !mResourcesCleared )
265 DALI_ASSERT_ALWAYS( mGaussianBlurView.size() == mBlurLevels && "must synchronize the GaussianBlurView group if blur levels got changed " );
266 for(unsigned int i=0; i<mBlurLevels;i++)
268 Stage::GetCurrent().Remove( mGaussianBlurView[i] );
269 mGaussianBlurView[i].Deactivate();
271 mResourcesCleared = true;
275 void SuperBlurView::OnSizeSet( const Vector3& targetSize )
277 if( mTargetSize != Vector2(targetSize) )
279 mTargetSize = Vector2(targetSize);
282 for( unsigned int i = 1; i <= mBlurLevels; i++ )
284 float exponent = static_cast<float>(i);
286 unsigned int width = mTargetSize.width/std::pow(2.f,exponent);
287 unsigned int height = mTargetSize.height/std::pow(2.f,exponent);
289 mBlurredImage[i-1] = FrameBuffer::New( width, height, FrameBuffer::Attachment::NONE );
290 Texture texture = Texture::New( TextureType::TEXTURE_2D, GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT, unsigned(width), unsigned(height) );
291 mBlurredImage[i-1].AttachColorTexture( texture );
296 SetTexture( mInputTexture );
300 Control::OnSizeSet( targetSize );
303 void SuperBlurView::OnSceneConnection( int depth )
305 if( mTargetSize == Vector2::ZERO )
310 // Exception to the rule, chaining up first ensures visuals have SetOnScene called to create their renderers
311 Control::OnSceneConnection( depth );
315 for(unsigned int i=0; i<mBlurLevels+1;i++)
317 mRenderers[i] = CreateRenderer( BASIC_VERTEX_SOURCE, FRAGMENT_SHADER );
318 mRenderers[i].SetProperty( Dali::Renderer::Property::DEPTH_INDEX, (int)i );
319 self.AddRenderer( mRenderers[i] );
323 Renderer renderer = mRenderers[i];
324 Property::Index index = renderer.RegisterProperty( ALPHA_UNIFORM_NAME, 0.f );
325 Constraint constraint = Constraint::New<float>( renderer, index, ActorOpacityConstraint(mBlurLevels, i-1) );
326 constraint.AddSource( Source( self, mBlurStrengthPropertyIndex ) );
333 SetRendererTexture( mRenderers[0], mInputTexture );
335 for(; i<mBlurLevels; i++)
337 SetRendererTexture( mRenderers[i], mBlurredImage[i-1] );
339 SetRendererTexture( mRenderers[i], mBlurredImage[i-1] );
343 void SuperBlurView::OnSceneDisconnection()
345 for(unsigned int i=0; i<mBlurLevels+1;i++)
347 Self().RemoveRenderer( mRenderers[i] );
348 mRenderers[i].Reset();
351 Control::OnSceneDisconnection();
354 Vector3 SuperBlurView::GetNaturalSize()
358 return Vector3( mInputTexture.GetWidth(), mInputTexture.GetHeight(), 0.f );
360 return Vector3::ZERO;
363 void SuperBlurView::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
365 Toolkit::SuperBlurView superBlurView = Toolkit::SuperBlurView::DownCast( Dali::BaseHandle( object ) );
369 SuperBlurView& superBlurViewImpl( GetImpl( superBlurView ) );
371 if( propertyIndex == Toolkit::SuperBlurView::Property::IMAGE_URL )
373 value.Get( superBlurViewImpl.mUrl );
375 PixelData pixels = SyncImageLoader::Load( superBlurViewImpl.mUrl );
379 Texture texture = Texture::New( TextureType::TEXTURE_2D, pixels.GetPixelFormat(), pixels.GetWidth(), pixels.GetHeight() );
380 texture.Upload( pixels, 0, 0, 0, 0, pixels.GetWidth(), pixels.GetHeight() );
382 superBlurViewImpl.SetTexture( texture );
386 DALI_LOG_ERROR( "Cannot create image from property value\n" );
392 Property::Value SuperBlurView::GetProperty( BaseObject* object, Property::Index propertyIndex )
394 Property::Value value;
396 Toolkit::SuperBlurView blurView = Toolkit::SuperBlurView::DownCast( Dali::BaseHandle( object ) );
400 SuperBlurView& superBlurViewImpl( GetImpl( blurView ) );
402 if( propertyIndex == Toolkit::SuperBlurView::Property::IMAGE_URL )
404 value = superBlurViewImpl.mUrl;
411 } // namespace Internal
413 } // namespace Toolkit