2 * Copyright (c) 2017 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/public-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/devel-api/controls/control-devel.h>
34 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
35 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
37 namespace //Unnamed namespace
42 //Todo: make these properties instead of constants
43 const unsigned int GAUSSIAN_BLUR_DEFAULT_NUM_SAMPLES = 11;
44 const unsigned int GAUSSIAN_BLUR_NUM_SAMPLES_INCREMENTATION = 10;
45 const float GAUSSIAN_BLUR_BELL_CURVE_WIDTH = 4.5f;
46 const float GAUSSIAN_BLUR_BELL_CURVE_WIDTH_INCREMENTATION = 5.f;
47 const Pixel::Format GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT = Pixel::RGBA8888;
48 const float GAUSSIAN_BLUR_DOWNSAMPLE_WIDTH_SCALE = 0.5f;
49 const float GAUSSIAN_BLUR_DOWNSAMPLE_HEIGHT_SCALE = 0.5f;
51 const char* ALPHA_UNIFORM_NAME( "uAlpha" );
52 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
53 varying mediump vec2 vTexCoord;\n
54 uniform sampler2D sTexture;\n
55 uniform lowp vec4 uColor;\n
56 uniform lowp float uAlpha;\n
60 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor;\n
61 gl_FragColor.a *= uAlpha;
66 * 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.
68 struct ActorOpacityConstraint
70 ActorOpacityConstraint(int totalImageNum, int currentImageIdx)
72 float rangeLength = 1.f / static_cast<float>( totalImageNum );
73 float index = static_cast<float>( currentImageIdx );
74 mRange = Vector2( index*rangeLength, (index+1.f)*rangeLength );
77 void operator()( float& current, const PropertyInputContainer& inputs )
79 float blurStrength = inputs[0]->GetFloat();
80 if(blurStrength < mRange.x)
84 else if(blurStrength > mRange.y)
90 current = ( blurStrength - mRange.x) / ( mRange.y - mRange.x );
111 const unsigned int DEFAULT_BLUR_LEVEL(5u); ///< The default blur level when creating SuperBlurView from the type registry
115 return Toolkit::SuperBlurView::New( DEFAULT_BLUR_LEVEL );
118 // Setup properties, signals and actions using the type-registry.
119 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::SuperBlurView, Toolkit::Control, Create )
121 DALI_PROPERTY_REGISTRATION( Toolkit, SuperBlurView, "image", MAP, IMAGE )
123 DALI_TYPE_REGISTRATION_END()
125 } // unnamed namespace
127 SuperBlurView::SuperBlurView( unsigned int blurLevels )
128 : Control( ControlBehaviour( DISABLE_SIZE_NEGOTIATION | DISABLE_STYLE_CHANGE_SIGNALS ) ),
129 mTargetSize( Vector2::ZERO ),
130 mBlurStrengthPropertyIndex(Property::INVALID_INDEX),
131 mBlurLevels( blurLevels ),
132 mResourcesCleared( true )
134 DALI_ASSERT_ALWAYS( mBlurLevels > 0 && " Minimal blur level is one, otherwise no blur is needed" );
135 mGaussianBlurView.assign( blurLevels, Toolkit::GaussianBlurView() );
136 mBlurredImage.assign( blurLevels, FrameBufferImage() );
137 mVisuals.assign( blurLevels+1, Toolkit::Visual::Base() );
140 SuperBlurView::~SuperBlurView()
144 Toolkit::SuperBlurView SuperBlurView::New( unsigned int blurLevels )
146 //Create the implementation
147 IntrusivePtr<SuperBlurView> superBlurView( new SuperBlurView( blurLevels ) );
149 //Pass ownership to CustomActor via derived handle
150 Toolkit::SuperBlurView handle( *superBlurView );
152 // Second-phase init of the implementation
153 // This can only be done after the CustomActor connection has been made...
154 superBlurView->Initialize();
159 void SuperBlurView::OnInitialize()
161 mBlurStrengthPropertyIndex = Self().RegisterProperty( "blurStrength", 0.f );
164 void SuperBlurView::SetImage(Image inputImage)
166 mInputImage = inputImage;
167 if( mTargetSize == Vector2::ZERO )
174 Actor self( Self() );
176 mVisuals[0] = Toolkit::VisualFactory::Get().CreateVisual( mInputImage );
177 DevelControl::RegisterVisual( *this, 0, mVisuals[0] ); // Will clean up previously registered visuals for this index.
178 mVisuals[0].SetDepthIndex(0);
179 // custom shader is not applied on the original image.
181 BlurImage( 0, inputImage);
182 for(unsigned int i=1; i<mBlurLevels;i++)
184 BlurImage( i, mBlurredImage[i-1]);
187 mResourcesCleared = false;
190 Image SuperBlurView::GetImage()
195 Property::Index SuperBlurView::GetBlurStrengthPropertyIndex() const
197 return mBlurStrengthPropertyIndex;
200 void SuperBlurView::SetBlurStrength( float blurStrength )
202 Self().SetProperty(mBlurStrengthPropertyIndex, blurStrength);
205 float SuperBlurView::GetCurrentBlurStrength() const
208 (Self().GetProperty( mBlurStrengthPropertyIndex )).Get(blurStrength);
213 Toolkit::SuperBlurView::SuperBlurViewSignal& SuperBlurView::BlurFinishedSignal()
215 return mBlurFinishedSignal;
218 Image SuperBlurView::GetBlurredImage( unsigned int level )
220 DALI_ASSERT_ALWAYS( level>0 && level<=mBlurLevels );
221 return mBlurredImage[level-1];
224 void SuperBlurView::BlurImage( unsigned int idx, Image image )
226 DALI_ASSERT_ALWAYS( mGaussianBlurView.size()>idx );
227 mGaussianBlurView[idx] = Toolkit::GaussianBlurView::New( GAUSSIAN_BLUR_DEFAULT_NUM_SAMPLES+GAUSSIAN_BLUR_NUM_SAMPLES_INCREMENTATION*idx,
228 GAUSSIAN_BLUR_BELL_CURVE_WIDTH + GAUSSIAN_BLUR_BELL_CURVE_WIDTH_INCREMENTATION*static_cast<float>(idx),
229 GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT,
230 GAUSSIAN_BLUR_DOWNSAMPLE_WIDTH_SCALE, GAUSSIAN_BLUR_DOWNSAMPLE_HEIGHT_SCALE, true );
231 mGaussianBlurView[idx].SetParentOrigin(ParentOrigin::CENTER);
232 mGaussianBlurView[idx].SetSize(mTargetSize);
233 Stage::GetCurrent().Add( mGaussianBlurView[idx] );
234 mGaussianBlurView[idx].SetUserImageAndOutputRenderTarget( image, mBlurredImage[idx] );
235 mGaussianBlurView[idx].ActivateOnce();
236 if( idx == mBlurLevels-1 )
238 mGaussianBlurView[idx].FinishedSignal().Connect( this, &SuperBlurView::OnBlurViewFinished );
242 void SuperBlurView::OnBlurViewFinished( Toolkit::GaussianBlurView blurView )
245 Toolkit::SuperBlurView handle( GetOwner() );
246 mBlurFinishedSignal.Emit( handle );
249 void SuperBlurView::ClearBlurResource()
251 if( !mResourcesCleared )
253 DALI_ASSERT_ALWAYS( mGaussianBlurView.size() == mBlurLevels && "must synchronize the GaussianBlurView group if blur levels got changed " );
254 for(unsigned int i=0; i<mBlurLevels;i++)
256 Stage::GetCurrent().Remove( mGaussianBlurView[i] );
257 mGaussianBlurView[i].Deactivate();
259 mResourcesCleared = true;
262 void SuperBlurView::SetShaderEffect( Toolkit::Visual::Base& visual )
264 Property::Map shaderMap;
265 std::stringstream verterShaderString;
266 shaderMap[ "fragmentShader" ] = FRAGMENT_SHADER;
268 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
269 visualImpl.SetCustomShader( shaderMap );
272 void SuperBlurView::OnSizeSet( const Vector3& targetSize )
274 if( mTargetSize != Vector2(targetSize) )
276 mTargetSize = Vector2(targetSize);
279 for( unsigned int i = 1; i <= mBlurLevels; i++ )
281 float exponent = static_cast<float>(i);
282 mBlurredImage[i-1] = FrameBufferImage::New( mTargetSize.width/std::pow(2.f,exponent) , mTargetSize.height/std::pow(2.f,exponent),
283 GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT );
285 mVisuals[i] = Toolkit::VisualFactory::Get().CreateVisual( mBlurredImage[i - 1] );
286 DevelControl::RegisterVisual( *this, i, mVisuals[i] ); // Will clean up existing visual with same index.
287 mVisuals[i].SetDepthIndex( i );
288 SetShaderEffect( mVisuals[i] );
293 SetImage( mInputImage );
297 Control::OnSizeSet( targetSize );
300 void SuperBlurView::OnStageConnection( int depth )
302 if( mTargetSize == Vector2::ZERO )
307 // Exception to the rule, chaining up first ensures visuals have SetOnStage called to create their renderers
308 Control::OnStageConnection( depth );
311 for(unsigned int i=0; i<=mBlurLevels;i++)
313 // Note that the renderer indices are depending on the order they been added to the actor
314 // which might be different from the blur level of its texture.
315 // We can check the depth index of the renderer to know which blurred image it renders.
316 // All visuals WILL have renderers at this point as we are simply creating visuals with an Image handle.
317 Renderer renderer = self.GetRendererAt( i );
318 int depthIndex = renderer.GetProperty<int>(Renderer::Property::DEPTH_INDEX);
321 Property::Index index = renderer.RegisterProperty( ALPHA_UNIFORM_NAME, 0.f );
322 Constraint constraint = Constraint::New<float>( renderer, index, ActorOpacityConstraint(mBlurLevels, depthIndex-1) );
323 constraint.AddSource( Source( self, mBlurStrengthPropertyIndex ) );
329 Vector3 SuperBlurView::GetNaturalSize()
333 return Vector3( mInputImage.GetWidth(), mInputImage.GetHeight(), 0.f );
335 return Vector3::ZERO;
338 void SuperBlurView::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
340 Toolkit::SuperBlurView superBlurView = Toolkit::SuperBlurView::DownCast( Dali::BaseHandle( object ) );
344 SuperBlurView& superBlurViewImpl( GetImpl( superBlurView ) );
346 if( propertyIndex == Toolkit::SuperBlurView::Property::IMAGE )
348 Dali::Image image = Scripting::NewImage( value );
351 superBlurViewImpl.SetImage( image );
355 DALI_LOG_ERROR( "Cannot create image from property value\n" );
361 Property::Value SuperBlurView::GetProperty( BaseObject* object, Property::Index propertyIndex )
363 Property::Value value;
365 Toolkit::SuperBlurView blurView = Toolkit::SuperBlurView::DownCast( Dali::BaseHandle( object ) );
369 SuperBlurView& superBlurViewImpl( GetImpl( blurView ) );
371 if( propertyIndex == Toolkit::SuperBlurView::Property::IMAGE )
374 Image inputImage = superBlurViewImpl.GetImage();
377 Scripting::CreatePropertyMap( inputImage, map );
379 value = Property::Value( map );
386 } // namespace Internal
388 } // namespace Toolkit