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/graphics/builtin-shader-extern-gen.h>
36 #include <dali-toolkit/internal/controls/control/control-renderers.h>
37 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
38 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
39 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
41 namespace //Unnamed namespace
46 //Todo: make these properties instead of constants
47 const unsigned int GAUSSIAN_BLUR_DEFAULT_NUM_SAMPLES = 11;
48 const unsigned int GAUSSIAN_BLUR_NUM_SAMPLES_INCREMENTATION = 10;
49 const float GAUSSIAN_BLUR_BELL_CURVE_WIDTH = 4.5f;
50 const float GAUSSIAN_BLUR_BELL_CURVE_WIDTH_INCREMENTATION = 5.f;
51 const Pixel::Format GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT = Pixel::RGBA8888;
52 const float GAUSSIAN_BLUR_DOWNSAMPLE_WIDTH_SCALE = 0.5f;
53 const float GAUSSIAN_BLUR_DOWNSAMPLE_HEIGHT_SCALE = 0.5f;
55 const char* ALPHA_UNIFORM_NAME( "uAlpha" );
58 * 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.
60 struct ActorOpacityConstraint
62 ActorOpacityConstraint(int totalImageNum, int currentImageIdx)
64 float rangeLength = 1.f / static_cast<float>( totalImageNum );
65 float index = static_cast<float>( currentImageIdx );
66 mRange = Vector2( index*rangeLength, (index+1.f)*rangeLength );
69 void operator()( float& current, const PropertyInputContainer& inputs )
71 float blurStrength = inputs[0]->GetFloat();
72 if(blurStrength < mRange.x)
76 else if(blurStrength > mRange.y)
82 current = ( blurStrength - mRange.x) / ( mRange.y - mRange.x );
103 const unsigned int DEFAULT_BLUR_LEVEL(5u); ///< The default blur level when creating SuperBlurView from the type registry
107 return Toolkit::SuperBlurView::New( DEFAULT_BLUR_LEVEL );
110 // Setup properties, signals and actions using the type-registry.
111 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::SuperBlurView, Toolkit::Control, Create )
113 DALI_PROPERTY_REGISTRATION( Toolkit, SuperBlurView, "imageUrl", STRING, IMAGE_URL )
115 DALI_TYPE_REGISTRATION_END()
117 } // unnamed namespace
119 SuperBlurView::SuperBlurView( unsigned int blurLevels )
120 : Control( ControlBehaviour( DISABLE_SIZE_NEGOTIATION | DISABLE_STYLE_CHANGE_SIGNALS ) ),
121 mTargetSize( Vector2::ZERO ),
122 mBlurStrengthPropertyIndex(Property::INVALID_INDEX),
123 mBlurLevels( blurLevels ),
124 mResourcesCleared( true )
126 DALI_ASSERT_ALWAYS( mBlurLevels > 0 && " Minimal blur level is one, otherwise no blur is needed" );
127 mGaussianBlurView.assign( blurLevels, Toolkit::GaussianBlurView() );
128 mBlurredImage.assign( blurLevels, FrameBuffer() );
129 mRenderers.assign( blurLevels+1, Dali::Renderer() );
132 SuperBlurView::~SuperBlurView()
136 Toolkit::SuperBlurView SuperBlurView::New( unsigned int blurLevels )
138 //Create the implementation
139 IntrusivePtr<SuperBlurView> superBlurView( new SuperBlurView( blurLevels ) );
141 //Pass ownership to CustomActor via derived handle
142 Toolkit::SuperBlurView handle( *superBlurView );
144 // Second-phase init of the implementation
145 // This can only be done after the CustomActor connection has been made...
146 superBlurView->Initialize();
151 void SuperBlurView::OnInitialize()
153 Actor self( Self() );
155 mBlurStrengthPropertyIndex = self.RegisterProperty( "blurStrength", 0.f );
157 DevelControl::SetAccessibilityConstructor( self, []( Dali::Actor actor ) {
158 return std::unique_ptr< Dali::Accessibility::Accessible >(
159 new Control::Impl::AccessibleImpl( actor, Dali::Accessibility::Role::FILLER ) );
163 void SuperBlurView::SetTexture( Texture texture )
165 mInputTexture = texture;
167 if( mTargetSize == Vector2::ZERO )
174 Actor self( Self() );
176 BlurTexture( 0, mInputTexture );
177 SetRendererTexture( mRenderers[0], texture );
180 for(; i<mBlurLevels; i++)
182 BlurTexture( i, mBlurredImage[i-1].GetColorTexture() );
183 SetRendererTexture( mRenderers[i], mBlurredImage[i-1] );
186 SetRendererTexture( mRenderers[i], mBlurredImage[i-1] );
188 mResourcesCleared = false;
191 Property::Index SuperBlurView::GetBlurStrengthPropertyIndex() const
193 return mBlurStrengthPropertyIndex;
196 void SuperBlurView::SetBlurStrength( float blurStrength )
198 Self().SetProperty(mBlurStrengthPropertyIndex, blurStrength);
201 float SuperBlurView::GetCurrentBlurStrength() const
204 (Self().GetProperty( mBlurStrengthPropertyIndex )).Get(blurStrength);
209 Toolkit::SuperBlurView::SuperBlurViewSignal& SuperBlurView::BlurFinishedSignal()
211 return mBlurFinishedSignal;
214 Texture SuperBlurView::GetBlurredTexture( unsigned int level )
216 DALI_ASSERT_ALWAYS( level>0 && level<=mBlurLevels );
218 FrameBuffer frameBuffer = mBlurredImage[level-1];
220 return frameBuffer.GetColorTexture();
223 void SuperBlurView::BlurTexture( unsigned int idx, Texture texture )
225 DALI_ASSERT_ALWAYS( mGaussianBlurView.size()>idx );
226 mGaussianBlurView[idx] = Toolkit::GaussianBlurView::New( GAUSSIAN_BLUR_DEFAULT_NUM_SAMPLES+GAUSSIAN_BLUR_NUM_SAMPLES_INCREMENTATION*idx,
227 GAUSSIAN_BLUR_BELL_CURVE_WIDTH + GAUSSIAN_BLUR_BELL_CURVE_WIDTH_INCREMENTATION*static_cast<float>(idx),
228 GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT,
229 GAUSSIAN_BLUR_DOWNSAMPLE_WIDTH_SCALE, GAUSSIAN_BLUR_DOWNSAMPLE_HEIGHT_SCALE, true );
230 mGaussianBlurView[idx].SetProperty( Actor::Property::PARENT_ORIGIN,ParentOrigin::CENTER );
231 mGaussianBlurView[idx].SetProperty( Actor::Property::SIZE, mTargetSize );
232 Stage::GetCurrent().Add( mGaussianBlurView[idx] );
234 mGaussianBlurView[idx].SetUserImageAndOutputRenderTarget( texture, mBlurredImage[idx] );
236 mGaussianBlurView[idx].ActivateOnce();
237 if( idx == mBlurLevels-1 )
239 mGaussianBlurView[idx].FinishedSignal().Connect( this, &SuperBlurView::OnBlurViewFinished );
243 void SuperBlurView::OnBlurViewFinished( Toolkit::GaussianBlurView blurView )
246 Toolkit::SuperBlurView handle( GetOwner() );
247 mBlurFinishedSignal.Emit( handle );
250 void SuperBlurView::ClearBlurResource()
252 if( !mResourcesCleared )
254 DALI_ASSERT_ALWAYS( mGaussianBlurView.size() == mBlurLevels && "must synchronize the GaussianBlurView group if blur levels got changed " );
255 for(unsigned int i=0; i<mBlurLevels;i++)
257 Stage::GetCurrent().Remove( mGaussianBlurView[i] );
258 mGaussianBlurView[i].Deactivate();
260 mResourcesCleared = true;
264 void SuperBlurView::OnSizeSet( const Vector3& targetSize )
266 if( mTargetSize != Vector2(targetSize) )
268 mTargetSize = Vector2(targetSize);
271 for( unsigned int i = 1; i <= mBlurLevels; i++ )
273 float exponent = static_cast<float>(i);
275 unsigned int width = mTargetSize.width/std::pow(2.f,exponent);
276 unsigned int height = mTargetSize.height/std::pow(2.f,exponent);
278 mBlurredImage[i-1] = FrameBuffer::New( width, height, FrameBuffer::Attachment::NONE );
279 Texture texture = Texture::New( TextureType::TEXTURE_2D, GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT, unsigned(width), unsigned(height) );
280 mBlurredImage[i-1].AttachColorTexture( texture );
285 SetTexture( mInputTexture );
289 Control::OnSizeSet( targetSize );
292 void SuperBlurView::OnSceneConnection( int depth )
294 if( mTargetSize == Vector2::ZERO )
299 // Exception to the rule, chaining up first ensures visuals have SetOnScene called to create their renderers
300 Control::OnSceneConnection( depth );
304 for(unsigned int i=0; i<mBlurLevels+1;i++)
306 mRenderers[i] = CreateRenderer( BASIC_VERTEX_SOURCE, SHADER_SUPER_BLUR_VIEW_FRAG );
307 mRenderers[i].SetProperty( Dali::Renderer::Property::DEPTH_INDEX, (int)i );
308 self.AddRenderer( mRenderers[i] );
312 Renderer renderer = mRenderers[i];
313 Property::Index index = renderer.RegisterProperty( ALPHA_UNIFORM_NAME, 0.f );
314 Constraint constraint = Constraint::New<float>( renderer, index, ActorOpacityConstraint(mBlurLevels, i-1) );
315 constraint.AddSource( Source( self, mBlurStrengthPropertyIndex ) );
322 SetRendererTexture( mRenderers[0], mInputTexture );
324 for(; i<mBlurLevels; i++)
326 SetRendererTexture( mRenderers[i], mBlurredImage[i-1] );
328 SetRendererTexture( mRenderers[i], mBlurredImage[i-1] );
332 void SuperBlurView::OnSceneDisconnection()
334 for(unsigned int i=0; i<mBlurLevels+1;i++)
336 Self().RemoveRenderer( mRenderers[i] );
337 mRenderers[i].Reset();
340 Control::OnSceneDisconnection();
343 Vector3 SuperBlurView::GetNaturalSize()
347 return Vector3( mInputTexture.GetWidth(), mInputTexture.GetHeight(), 0.f );
349 return Vector3::ZERO;
352 void SuperBlurView::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
354 Toolkit::SuperBlurView superBlurView = Toolkit::SuperBlurView::DownCast( Dali::BaseHandle( object ) );
358 SuperBlurView& superBlurViewImpl( GetImpl( superBlurView ) );
360 if( propertyIndex == Toolkit::SuperBlurView::Property::IMAGE_URL )
362 value.Get( superBlurViewImpl.mUrl );
364 PixelData pixels = SyncImageLoader::Load( superBlurViewImpl.mUrl );
368 Texture texture = Texture::New( TextureType::TEXTURE_2D, pixels.GetPixelFormat(), pixels.GetWidth(), pixels.GetHeight() );
369 texture.Upload( pixels, 0, 0, 0, 0, pixels.GetWidth(), pixels.GetHeight() );
371 superBlurViewImpl.SetTexture( texture );
375 DALI_LOG_ERROR( "Cannot create image from property value\n" );
381 Property::Value SuperBlurView::GetProperty( BaseObject* object, Property::Index propertyIndex )
383 Property::Value value;
385 Toolkit::SuperBlurView blurView = Toolkit::SuperBlurView::DownCast( Dali::BaseHandle( object ) );
389 SuperBlurView& superBlurViewImpl( GetImpl( blurView ) );
391 if( propertyIndex == Toolkit::SuperBlurView::Property::IMAGE_URL )
393 value = superBlurViewImpl.mUrl;
400 } // namespace Internal
402 } // namespace Toolkit