2 * Copyright (c) 2015 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 "image-renderer.h"
22 #include <cstring> // for strncasecmp
23 #include <dali/public-api/images/resource-image.h>
24 #include <dali/integration-api/debug.h>
27 #include <dali-toolkit/internal/controls/renderers/renderer-factory-impl.h>
28 #include <dali-toolkit/internal/controls/renderers/renderer-factory-cache.h>
29 #include <dali-toolkit/internal/controls/renderers/control-renderer-impl.h>
30 #include <dali-toolkit/internal/controls/renderers/control-renderer-data-impl.h>
31 #include <dali-toolkit/internal/controls/renderers/image-atlas-manager.h>
44 const char HTTP_URL[] = "http://";
45 const char HTTPS_URL[] = "https://";
47 const char * const RENDERER_TYPE("rendererType");
48 const char * const RENDERER_TYPE_VALUE("imageRenderer");
51 const char * const IMAGE_URL_NAME( "imageUrl" );
52 const char * const IMAGE_FITTING_MODE( "imageFittingMode" );
53 const char * const IMAGE_SAMPLING_MODE( "imageSamplingMode" );
54 const char * const IMAGE_DESIRED_WIDTH( "imageDesiredWidth" );
55 const char * const IMAGE_DESIRED_HEIGHT( "imageDesiredHeight" );
58 const char * const SHRINK_TO_FIT("shrinkToFit");
59 const char * const SCALE_TO_FILL("scaleToFill");
60 const char * const FIT_WIDTH("fitWidth");
61 const char * const FIT_HEIGHT("fitHeight");
62 const char * const DEFAULT("default");
65 const char * const BOX("box");
66 const char * const NEAREST("nearest");
67 const char * const LINEAR("linear");
68 const char * const BOX_THEN_NEAREST("boxThenNearest");
69 const char * const BOX_THEN_LINEAR("boxThenLinear");
70 const char * const NO_FILTER("noFilter");
71 const char * const DONT_CARE("dontCare");
73 const std::string TEXTURE_UNIFORM_NAME = "sTexture";
74 const std::string ATLAS_RECT_UNIFORM_NAME = "uAtlasRect";
75 const std::string PIXEL_AREA_UNIFORM_NAME = "pixelArea";
77 // Set this uniform to 1.0 for conventional alpha blending; if pre-multiplied alpha blending, set this uniform to 0.0
78 const std::string ALPHA_BLENDING_UNIFORM_NAME = "uAlphaBlending";
80 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
82 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
83 attribute mediump vec2 aPosition;\n
84 uniform mediump mat4 uMvpMatrix;\n
85 uniform mediump vec3 uSize;\n
86 uniform mediump vec4 uAtlasRect;\n
87 uniform mediump vec4 pixelArea;
88 varying mediump vec2 vTexCoord;\n
92 mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
93 vertexPosition.xyz *= uSize;\n
94 vertexPosition = uMvpMatrix * vertexPosition;\n
96 vTexCoord = mix( uAtlasRect.xy, uAtlasRect.zw, pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) ) );\n
97 gl_Position = vertexPosition;\n
101 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
102 varying mediump vec2 vTexCoord;\n
103 uniform sampler2D sTexture;\n
104 uniform lowp vec4 uColor;\n
105 uniform lowp float uAlphaBlending; // Set to 1.0 for conventional alpha blending; if pre-multiplied alpha blending, set to 0.0
109 gl_FragColor = texture2D( sTexture, vTexCoord ) * vec4( uColor.rgb*max( uAlphaBlending, uColor.a ), uColor.a );\n
113 Geometry GenerateGeometry( const Vector< Vector2 >& vertices, const Vector< unsigned int >& indices )
115 Property::Map vertexFormat;
116 vertexFormat[ "aPosition" ] = Property::VECTOR2;
117 PropertyBuffer vertexPropertyBuffer = PropertyBuffer::New( vertexFormat, vertices.Size() );
118 if( vertices.Size() > 0 )
120 vertexPropertyBuffer.SetData( &vertices[ 0 ] );
123 Property::Map indexFormat;
124 indexFormat[ "indices" ] = Property::INTEGER;
125 PropertyBuffer indexPropertyBuffer = PropertyBuffer::New( indexFormat, indices.Size() );
126 if( indices.Size() > 0 )
128 indexPropertyBuffer.SetData( &indices[ 0 ] );
131 // Create the geometry object
132 Geometry geometry = Geometry::New();
133 geometry.AddVertexBuffer( vertexPropertyBuffer );
134 geometry.SetIndexBuffer( indexPropertyBuffer );
135 geometry.SetGeometryType( Geometry::TRIANGLE_STRIP );
140 Geometry CreateGeometry( RendererFactoryCache& factoryCache, ImageDimensions gridSize )
144 if( gridSize == ImageDimensions( 1, 1 ) )
146 geometry = factoryCache.GetGeometry( RendererFactoryCache::QUAD_GEOMETRY );
149 geometry = factoryCache.CreateQuadGeometry();
150 factoryCache.SaveGeometry( RendererFactoryCache::QUAD_GEOMETRY, geometry );
155 uint16_t gridWidth = gridSize.GetWidth();
156 uint16_t gridHeight = gridSize.GetHeight();
159 Vector< Vector2 > vertices;
160 vertices.Reserve( ( gridWidth + 1 ) * ( gridHeight + 1 ) );
162 for( int y = 0; y < gridHeight + 1; ++y )
164 for( int x = 0; x < gridWidth + 1; ++x )
166 vertices.PushBack( Vector2( (float)x/gridWidth - 0.5f, (float)y/gridHeight - 0.5f) );
171 Vector< unsigned int > indices;
172 indices.Reserve( (gridWidth+2)*gridHeight*2 - 2);
174 for( unsigned int row = 0u; row < gridHeight; ++row )
176 unsigned int rowStartIndex = row*(gridWidth+1u);
177 unsigned int nextRowStartIndex = rowStartIndex + gridWidth +1u;
179 if( row != 0u ) // degenerate index on non-first row
181 indices.PushBack( rowStartIndex );
184 for( unsigned int column = 0u; column < gridWidth+1u; column++) // main strip
186 indices.PushBack( rowStartIndex + column);
187 indices.PushBack( nextRowStartIndex + column);
190 if( row != gridHeight-1u ) // degenerate index on non-last row
192 indices.PushBack( nextRowStartIndex + gridWidth );
196 return GenerateGeometry( vertices, indices );
202 } //unnamed namespace
204 ImageRenderer::ImageRenderer( RendererFactoryCache& factoryCache, ImageAtlasManager& atlasManager )
205 : ControlRenderer( factoryCache ),
206 mAtlasManager( atlasManager ),
208 mFittingMode( FittingMode::DEFAULT ),
209 mSamplingMode( SamplingMode::DEFAULT ),
210 mIsAlphaPreMultiplied( false )
214 ImageRenderer::~ImageRenderer()
218 void ImageRenderer::DoInitialize( Actor& actor, const Property::Map& propertyMap )
220 std::string oldImageUrl = mImageUrl;
222 Property::Value* imageURLValue = propertyMap.Find( IMAGE_URL_NAME );
225 imageURLValue->Get( mImageUrl );
226 if( !mImageUrl.empty() )
231 Property::Value* fittingValue = propertyMap.Find( IMAGE_FITTING_MODE );
235 fittingValue->Get( fitting );
237 mFittingMode = FittingMode::DEFAULT;
238 if( fitting == SHRINK_TO_FIT )
240 mFittingMode = FittingMode::SHRINK_TO_FIT;
242 else if( fitting == SCALE_TO_FILL )
244 mFittingMode = FittingMode::SCALE_TO_FILL;
246 else if( fitting == FIT_WIDTH )
248 mFittingMode = FittingMode::FIT_WIDTH;
250 else if( fitting == FIT_HEIGHT )
252 mFittingMode = FittingMode::FIT_HEIGHT;
254 else if( fitting == DEFAULT )
256 mFittingMode = FittingMode::DEFAULT;
260 DALI_ASSERT_ALWAYS("Unknown fitting mode");
264 Property::Value* samplingValue = propertyMap.Find( IMAGE_SAMPLING_MODE );
267 std::string sampling;
268 samplingValue->Get( sampling );
270 mSamplingMode = SamplingMode::DEFAULT;
271 if( sampling == BOX )
273 mSamplingMode = SamplingMode::BOX;
275 else if( sampling == NEAREST )
277 mSamplingMode = SamplingMode::NEAREST;
279 else if( sampling == LINEAR )
281 mSamplingMode = SamplingMode::LINEAR;
283 else if( sampling == BOX_THEN_NEAREST )
285 mSamplingMode = SamplingMode::BOX_THEN_NEAREST;
287 else if( sampling == BOX_THEN_LINEAR )
289 mSamplingMode = SamplingMode::BOX_THEN_LINEAR;
291 else if( sampling == NO_FILTER )
293 mSamplingMode = SamplingMode::NO_FILTER;
295 else if( sampling == DONT_CARE )
297 mSamplingMode = SamplingMode::DONT_CARE;
299 else if( sampling == DEFAULT )
301 mSamplingMode = SamplingMode::DEFAULT;
305 DALI_ASSERT_ALWAYS("Unknown sampling mode");
309 int desiredWidth = 0;
310 Property::Value* desiredWidthValue = propertyMap.Find( IMAGE_DESIRED_WIDTH );
311 if( desiredWidthValue )
313 desiredWidthValue->Get( desiredWidth );
316 int desiredHeight = 0;
317 Property::Value* desiredHeightValue = propertyMap.Find( IMAGE_DESIRED_HEIGHT );
318 if( desiredHeightValue )
320 desiredHeightValue->Get( desiredHeight );
323 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
326 // remove old renderer if exit
327 if( mImpl->mRenderer )
329 if( actor ) //remove old renderer from actor
331 actor.RemoveRenderer( mImpl->mRenderer );
333 if( !oldImageUrl.empty() ) //clean old renderer from cache
335 CleanCache( oldImageUrl );
339 // if actor is on stage, create new renderer and apply to actor
340 if( actor && actor.OnStage() )
346 void ImageRenderer::SetSize( const Vector2& size )
348 ControlRenderer::SetSize( size );
351 void ImageRenderer::GetNaturalSize( Vector2& naturalSize ) const
355 naturalSize.x = mImage.GetWidth();
356 naturalSize.y = mImage.GetHeight();
359 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
361 naturalSize.x = mDesiredSize.GetWidth();
362 naturalSize.y = mDesiredSize.GetHeight();
365 else if( !mImageUrl.empty() )
367 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
368 naturalSize.x = dimentions.GetWidth();
369 naturalSize.y = dimentions.GetHeight();
373 naturalSize = Vector2::ZERO;
376 void ImageRenderer::SetClipRect( const Rect<int>& clipRect )
378 ControlRenderer::SetClipRect( clipRect );
381 void ImageRenderer::SetOffset( const Vector2& offset )
385 Renderer ImageRenderer::CreateRenderer() const
390 if( !mImpl->mCustomShader )
392 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
393 shader = GetImageShader(mFactoryCache);
397 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
398 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
400 shader = GetImageShader(mFactoryCache);
404 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
405 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER : mImpl->mCustomShader->mFragmentShader,
406 mImpl->mCustomShader->mHints );
407 if( mImpl->mCustomShader->mVertexShader.empty() )
409 shader.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
410 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
411 shader.RegisterProperty( ALPHA_BLENDING_UNIFORM_NAME, 1.f );
416 Material material = Material::New( shader );
417 return Renderer::New( geometry, material );
420 void ImageRenderer::InitializeRenderer( const std::string& imageUrl )
422 if( imageUrl.empty() )
427 mImageUrl = imageUrl;
428 mImpl->mRenderer.Reset();
430 if( !mImpl->mCustomShader &&
431 ( strncasecmp( imageUrl.c_str(), HTTP_URL, sizeof(HTTP_URL) -1 ) != 0 ) && // ignore remote images
432 ( strncasecmp( imageUrl.c_str(), HTTPS_URL, sizeof(HTTPS_URL) -1 ) != 0 ) )
434 mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
435 if( !mImpl->mRenderer )
438 Material material = mAtlasManager.Add(atlasRect, imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
441 Geometry geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
442 mImpl->mRenderer = Renderer::New( geometry, material );
443 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
445 else // big image, atlasing is not applied
447 mImpl->mRenderer = CreateRenderer();
449 ResourceImage image = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
450 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
451 Material material = mImpl->mRenderer.GetMaterial();
452 material.AddTexture( image, TEXTURE_UNIFORM_NAME );
455 mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
458 mImpl->mFlags |= Impl::IS_FROM_CACHE;
462 // for custom shader or remote image, renderer is not cached and atlas is not applied
464 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
465 mImpl->mRenderer = CreateRenderer();
466 ResourceImage resourceImage = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
467 resourceImage.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
468 ApplyImageToSampler( resourceImage );
472 void ImageRenderer::InitializeRenderer( const Image& image )
474 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
476 mImpl->mRenderer = CreateRenderer();
480 ApplyImageToSampler( image );
485 void ImageRenderer::DoSetOnStage( Actor& actor )
487 if( !mImageUrl.empty() )
489 InitializeRenderer( mImageUrl );
493 InitializeRenderer( mImage );
496 EnablePreMultipliedAlpha( mIsAlphaPreMultiplied );
499 void ImageRenderer::DoSetOffStage( Actor& actor )
501 //If we own the image then make sure we release it when we go off stage
502 if( !mImageUrl.empty() )
504 actor.RemoveRenderer( mImpl->mRenderer );
505 CleanCache(mImageUrl);
511 actor.RemoveRenderer( mImpl->mRenderer );
512 mImpl->mRenderer.Reset();
516 void ImageRenderer::DoCreatePropertyMap( Property::Map& map ) const
519 map.Insert( RENDERER_TYPE, RENDERER_TYPE_VALUE );
520 if( !mImageUrl.empty() )
522 map.Insert( IMAGE_URL_NAME, mImageUrl );
523 map.Insert( IMAGE_DESIRED_WIDTH, mDesiredSize.GetWidth() );
524 map.Insert( IMAGE_DESIRED_HEIGHT, mDesiredSize.GetHeight() );
528 map.Insert( IMAGE_DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
529 map.Insert( IMAGE_DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
531 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
534 map.Insert( IMAGE_URL_NAME, resourceImage.GetUrl() );
538 switch( mFittingMode )
540 case Dali::FittingMode::FIT_HEIGHT:
542 map.Insert( IMAGE_FITTING_MODE, FIT_HEIGHT );
545 case Dali::FittingMode::FIT_WIDTH:
547 map.Insert( IMAGE_FITTING_MODE, FIT_WIDTH );
550 case Dali::FittingMode::SCALE_TO_FILL:
552 map.Insert( IMAGE_FITTING_MODE, SCALE_TO_FILL );
555 case Dali::FittingMode::SHRINK_TO_FIT:
557 map.Insert( IMAGE_FITTING_MODE, SHRINK_TO_FIT );
562 map.Insert( IMAGE_FITTING_MODE, DEFAULT );
567 switch( mSamplingMode )
569 case Dali::SamplingMode::BOX:
571 map.Insert( IMAGE_SAMPLING_MODE, BOX );
574 case Dali::SamplingMode::NEAREST:
576 map.Insert( IMAGE_SAMPLING_MODE, NEAREST );
579 case Dali::SamplingMode::LINEAR:
581 map.Insert( IMAGE_SAMPLING_MODE, LINEAR );
584 case Dali::SamplingMode::BOX_THEN_LINEAR:
586 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_LINEAR );
589 case Dali::SamplingMode::BOX_THEN_NEAREST:
591 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_NEAREST );
594 case Dali::SamplingMode::NO_FILTER:
596 map.Insert( IMAGE_SAMPLING_MODE, NO_FILTER );
599 case Dali::SamplingMode::DONT_CARE:
601 map.Insert( IMAGE_SAMPLING_MODE, DONT_CARE );
606 map.Insert( IMAGE_SAMPLING_MODE, DEFAULT );
612 Shader ImageRenderer::GetImageShader( RendererFactoryCache& factoryCache )
614 Shader shader = factoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
617 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
618 factoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, shader );
619 shader.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
620 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
621 shader.RegisterProperty( ALPHA_BLENDING_UNIFORM_NAME, 1.f );
626 void ImageRenderer::SetImage( Actor& actor, const std::string& imageUrl, ImageDimensions size, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode )
628 if( mImageUrl != imageUrl )
630 std::string oldImageUrl = mImageUrl;
631 mImageUrl = imageUrl;
633 mFittingMode = fittingMode;
634 mSamplingMode = samplingMode;
637 if( mImpl->mRenderer )
639 if( GetIsFromCache() ) // if renderer is from cache, remove the old one
641 //remove old renderer
644 actor.RemoveRenderer( mImpl->mRenderer );
648 if( !oldImageUrl.empty() )
650 CleanCache(oldImageUrl);
653 if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
658 else // if renderer is not from cache, reuse the same renderer and only change the texture
660 ResourceImage image = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
661 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
662 ApplyImageToSampler( image );
668 void ImageRenderer::SetImage( Actor& actor, const Image& image )
670 if( mImage != image )
674 if( mImpl->mRenderer )
676 if( GetIsFromCache() ) // if renderer is from cache, remove the old one
678 //remove old renderer
681 actor.RemoveRenderer( mImpl->mRenderer );
685 if( !mImageUrl.empty() )
687 CleanCache(mImageUrl);
691 if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
696 else // if renderer is not from cache, reuse the same renderer and only change the texture
698 ApplyImageToSampler( image );
703 mDesiredSize = ImageDimensions();
704 mFittingMode = FittingMode::DEFAULT;
705 mSamplingMode = SamplingMode::DEFAULT;
709 void ImageRenderer::EnablePreMultipliedAlpha( bool preMultipled )
711 mIsAlphaPreMultiplied = preMultipled;
712 if( mImpl->mRenderer )
714 Material material = mImpl->mRenderer.GetMaterial();
718 material.SetBlendFunc( BlendingFactor::ONE, BlendingFactor::ONE_MINUS_SRC_ALPHA,
719 BlendingFactor::ONE, BlendingFactor::ONE );
720 if( !mImpl->mCustomShader || mImpl->mCustomShader->mVertexShader.empty())
722 material.RegisterProperty( ALPHA_BLENDING_UNIFORM_NAME, 0.f );
727 // using default blend func
728 material.SetBlendFunc( BlendingFactor::SRC_ALPHA, BlendingFactor::ONE_MINUS_SRC_ALPHA,
729 BlendingFactor::ONE, BlendingFactor::ONE_MINUS_SRC_ALPHA );
731 Property::Index index = material.GetPropertyIndex( ALPHA_BLENDING_UNIFORM_NAME );
732 if( index != Property::INVALID_INDEX ) // only set value when the property already exist on the Material
734 material.SetProperty( index, 1.f );
740 void ImageRenderer::ApplyImageToSampler( const Image& image )
744 Material material = mImpl->mRenderer.GetMaterial();
747 int index = material.GetTextureIndex( TEXTURE_UNIFORM_NAME );
750 material.SetTextureImage( index, image );
754 material.AddTexture( image, TEXTURE_UNIFORM_NAME );
759 void ImageRenderer::OnImageLoaded( ResourceImage image )
761 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
763 Image brokenImage = RendererFactory::GetBrokenRendererImage();
764 if( mImpl->mRenderer )
766 ApplyImageToSampler( brokenImage );
771 void ImageRenderer::CleanCache(const std::string& url)
773 Material material = mImpl->mRenderer.GetMaterial();
775 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
776 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
777 if( index != Property::INVALID_INDEX )
779 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
780 atlasRectValue.Get( atlasRect );
783 mImpl->mRenderer.Reset();
784 if( mFactoryCache.CleanRendererCache( url ) && index != Property::INVALID_INDEX )
786 mAtlasManager.Remove( material, atlasRect );
790 } // namespace Internal
792 } // namespace Toolkit