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/public-api/images/native-image.h>
25 #include <dali/integration-api/debug.h>
28 #include <dali-toolkit/internal/controls/renderers/renderer-factory-impl.h>
29 #include <dali-toolkit/internal/controls/renderers/renderer-factory-cache.h>
30 #include <dali-toolkit/internal/controls/renderers/control-renderer-impl.h>
31 #include <dali-toolkit/internal/controls/renderers/control-renderer-data-impl.h>
32 #include <dali-toolkit/internal/controls/renderers/image-atlas-manager.h>
45 const char HTTP_URL[] = "http://";
46 const char HTTPS_URL[] = "https://";
48 const char * const RENDERER_TYPE("rendererType");
49 const char * const RENDERER_TYPE_VALUE("image");
52 const char * const IMAGE_URL_NAME( "imageUrl" );
53 const char * const IMAGE_FITTING_MODE( "imageFittingMode" );
54 const char * const IMAGE_SAMPLING_MODE( "imageSamplingMode" );
55 const char * const IMAGE_DESIRED_WIDTH( "imageDesiredWidth" );
56 const char * const IMAGE_DESIRED_HEIGHT( "imageDesiredHeight" );
59 const char * const SHRINK_TO_FIT("shrinkToFit");
60 const char * const SCALE_TO_FILL("scaleToFill");
61 const char * const FIT_WIDTH("fitWidth");
62 const char * const FIT_HEIGHT("fitHeight");
63 const char * const DEFAULT("default");
66 const char * const BOX("box");
67 const char * const NEAREST("nearest");
68 const char * const LINEAR("linear");
69 const char * const BOX_THEN_NEAREST("boxThenNearest");
70 const char * const BOX_THEN_LINEAR("boxThenLinear");
71 const char * const NO_FILTER("noFilter");
72 const char * const DONT_CARE("dontCare");
74 const std::string TEXTURE_UNIFORM_NAME = "sTexture";
75 const std::string ATLAS_RECT_UNIFORM_NAME = "uAtlasRect";
76 const std::string PIXEL_AREA_UNIFORM_NAME = "pixelArea";
78 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
80 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
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
108 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor;\n
112 Geometry CreateGeometry( RendererFactoryCache& factoryCache, ImageDimensions gridSize )
116 if( gridSize == ImageDimensions( 1, 1 ) )
118 geometry = factoryCache.GetGeometry( RendererFactoryCache::QUAD_GEOMETRY );
121 geometry = RendererFactoryCache::CreateQuadGeometry();
122 factoryCache.SaveGeometry( RendererFactoryCache::QUAD_GEOMETRY, geometry );
127 geometry = RendererFactoryCache::CreateGridGeometry( gridSize );
133 } //unnamed namespace
135 ImageRenderer::ImageRenderer( RendererFactoryCache& factoryCache, ImageAtlasManager& atlasManager )
136 : ControlRenderer( factoryCache ),
137 mAtlasManager( atlasManager ),
139 mFittingMode( FittingMode::DEFAULT ),
140 mSamplingMode( SamplingMode::DEFAULT ),
141 mNativeFragmentShaderCode( ),
142 mNativeImageFlag( false )
146 ImageRenderer::~ImageRenderer()
150 void ImageRenderer::DoInitialize( Actor& actor, const Property::Map& propertyMap )
152 std::string oldImageUrl = mImageUrl;
154 Property::Value* imageURLValue = propertyMap.Find( IMAGE_URL_NAME );
157 imageURLValue->Get( mImageUrl );
158 if( !mImageUrl.empty() )
163 Property::Value* fittingValue = propertyMap.Find( IMAGE_FITTING_MODE );
167 fittingValue->Get( fitting );
169 mFittingMode = FittingMode::DEFAULT;
170 if( fitting == SHRINK_TO_FIT )
172 mFittingMode = FittingMode::SHRINK_TO_FIT;
174 else if( fitting == SCALE_TO_FILL )
176 mFittingMode = FittingMode::SCALE_TO_FILL;
178 else if( fitting == FIT_WIDTH )
180 mFittingMode = FittingMode::FIT_WIDTH;
182 else if( fitting == FIT_HEIGHT )
184 mFittingMode = FittingMode::FIT_HEIGHT;
186 else if( fitting == DEFAULT )
188 mFittingMode = FittingMode::DEFAULT;
192 DALI_ASSERT_ALWAYS("Unknown fitting mode");
196 Property::Value* samplingValue = propertyMap.Find( IMAGE_SAMPLING_MODE );
199 std::string sampling;
200 samplingValue->Get( sampling );
202 mSamplingMode = SamplingMode::DEFAULT;
203 if( sampling == BOX )
205 mSamplingMode = SamplingMode::BOX;
207 else if( sampling == NEAREST )
209 mSamplingMode = SamplingMode::NEAREST;
211 else if( sampling == LINEAR )
213 mSamplingMode = SamplingMode::LINEAR;
215 else if( sampling == BOX_THEN_NEAREST )
217 mSamplingMode = SamplingMode::BOX_THEN_NEAREST;
219 else if( sampling == BOX_THEN_LINEAR )
221 mSamplingMode = SamplingMode::BOX_THEN_LINEAR;
223 else if( sampling == NO_FILTER )
225 mSamplingMode = SamplingMode::NO_FILTER;
227 else if( sampling == DONT_CARE )
229 mSamplingMode = SamplingMode::DONT_CARE;
231 else if( sampling == DEFAULT )
233 mSamplingMode = SamplingMode::DEFAULT;
237 DALI_ASSERT_ALWAYS("Unknown sampling mode");
241 int desiredWidth = 0;
242 Property::Value* desiredWidthValue = propertyMap.Find( IMAGE_DESIRED_WIDTH );
243 if( desiredWidthValue )
245 desiredWidthValue->Get( desiredWidth );
248 int desiredHeight = 0;
249 Property::Value* desiredHeightValue = propertyMap.Find( IMAGE_DESIRED_HEIGHT );
250 if( desiredHeightValue )
252 desiredHeightValue->Get( desiredHeight );
255 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
258 // remove old renderer if exit
259 if( mImpl->mRenderer )
261 if( actor ) //remove old renderer from actor
263 actor.RemoveRenderer( mImpl->mRenderer );
265 if( !oldImageUrl.empty() ) //clean old renderer from cache
267 CleanCache( oldImageUrl );
271 NativeImage nativeImage = NativeImage::DownCast( mImage );
275 SetNativeFragmentShaderCode( nativeImage );
278 // if actor is on stage, create new renderer and apply to actor
279 if( actor && actor.OnStage() )
285 void ImageRenderer::SetSize( const Vector2& size )
287 ControlRenderer::SetSize( size );
290 void ImageRenderer::GetNaturalSize( Vector2& naturalSize ) const
294 naturalSize.x = mImage.GetWidth();
295 naturalSize.y = mImage.GetHeight();
298 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
300 naturalSize.x = mDesiredSize.GetWidth();
301 naturalSize.y = mDesiredSize.GetHeight();
304 else if( !mImageUrl.empty() )
306 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
307 naturalSize.x = dimentions.GetWidth();
308 naturalSize.y = dimentions.GetHeight();
312 naturalSize = Vector2::ZERO;
315 void ImageRenderer::SetClipRect( const Rect<int>& clipRect )
317 ControlRenderer::SetClipRect( clipRect );
320 void ImageRenderer::SetOffset( const Vector2& offset )
324 Renderer ImageRenderer::CreateRenderer() const
329 // If mImage is nativeImage with custom sampler or prefix, mNativeFragmentShaderCode will be applied.
330 // Renderer can't be shared between NativeImage and other image types.
331 if( !mNativeFragmentShaderCode.empty() )
333 return CreateNativeImageRenderer();
336 if( !mImpl->mCustomShader )
338 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
340 shader = GetImageShader(mFactoryCache);
344 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
345 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
347 shader = GetImageShader(mFactoryCache);
351 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
352 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER : mImpl->mCustomShader->mFragmentShader,
353 mImpl->mCustomShader->mHints );
354 if( mImpl->mCustomShader->mVertexShader.empty() )
356 shader.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
357 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
362 Material material = Material::New( shader );
363 return Renderer::New( geometry, material );
366 Renderer ImageRenderer::CreateNativeImageRenderer() const
371 if( !mImpl->mCustomShader )
373 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
375 shader = Shader::New( VERTEX_SHADER, mNativeFragmentShaderCode );
376 shader.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
377 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
381 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
382 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
384 shader = Shader::New( VERTEX_SHADER, mNativeFragmentShaderCode );
388 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
389 mNativeFragmentShaderCode,
390 mImpl->mCustomShader->mHints );
391 if( mImpl->mCustomShader->mVertexShader.empty() )
393 shader.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
394 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
399 Material material = Material::New( shader );
400 return Renderer::New( geometry, material );
403 void ImageRenderer::InitializeRenderer( const std::string& imageUrl )
405 if( imageUrl.empty() )
410 mImageUrl = imageUrl;
411 mImpl->mRenderer.Reset();
413 if( !mImpl->mCustomShader &&
414 ( strncasecmp( imageUrl.c_str(), HTTP_URL, sizeof(HTTP_URL) -1 ) != 0 ) && // ignore remote images
415 ( strncasecmp( imageUrl.c_str(), HTTPS_URL, sizeof(HTTPS_URL) -1 ) != 0 ) )
417 mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
418 if( !mImpl->mRenderer )
421 Material material = mAtlasManager.Add(atlasRect, imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
424 Geometry geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
425 mImpl->mRenderer = Renderer::New( geometry, material );
426 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
428 else // big image, atlasing is not applied
430 mImpl->mRenderer = CreateRenderer();
432 ResourceImage image = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
433 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
434 Material material = mImpl->mRenderer.GetMaterial();
435 material.AddTexture( image, TEXTURE_UNIFORM_NAME );
438 mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
441 mImpl->mFlags |= Impl::IS_FROM_CACHE;
445 // for custom shader or remote image, renderer is not cached and atlas is not applied
447 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
448 mImpl->mRenderer = CreateRenderer();
449 ResourceImage resourceImage = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
450 resourceImage.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
451 ApplyImageToSampler( resourceImage );
455 void ImageRenderer::InitializeRenderer( const Image& image )
457 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
459 mImpl->mRenderer = CreateRenderer();
463 ApplyImageToSampler( image );
468 void ImageRenderer::DoSetOnStage( Actor& actor )
470 if( !mImageUrl.empty() )
472 InitializeRenderer( mImageUrl );
476 InitializeRenderer( mImage );
481 void ImageRenderer::DoSetOffStage( Actor& actor )
483 //If we own the image then make sure we release it when we go off stage
484 if( !mImageUrl.empty() )
486 actor.RemoveRenderer( mImpl->mRenderer );
487 CleanCache(mImageUrl);
492 actor.RemoveRenderer( mImpl->mRenderer );
493 mImpl->mRenderer.Reset();
497 void ImageRenderer::DoCreatePropertyMap( Property::Map& map ) const
500 map.Insert( RENDERER_TYPE, RENDERER_TYPE_VALUE );
501 if( !mImageUrl.empty() )
503 map.Insert( IMAGE_URL_NAME, mImageUrl );
504 map.Insert( IMAGE_DESIRED_WIDTH, mDesiredSize.GetWidth() );
505 map.Insert( IMAGE_DESIRED_HEIGHT, mDesiredSize.GetHeight() );
509 map.Insert( IMAGE_DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
510 map.Insert( IMAGE_DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
512 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
515 map.Insert( IMAGE_URL_NAME, resourceImage.GetUrl() );
519 switch( mFittingMode )
521 case Dali::FittingMode::FIT_HEIGHT:
523 map.Insert( IMAGE_FITTING_MODE, FIT_HEIGHT );
526 case Dali::FittingMode::FIT_WIDTH:
528 map.Insert( IMAGE_FITTING_MODE, FIT_WIDTH );
531 case Dali::FittingMode::SCALE_TO_FILL:
533 map.Insert( IMAGE_FITTING_MODE, SCALE_TO_FILL );
536 case Dali::FittingMode::SHRINK_TO_FIT:
538 map.Insert( IMAGE_FITTING_MODE, SHRINK_TO_FIT );
543 map.Insert( IMAGE_FITTING_MODE, DEFAULT );
548 switch( mSamplingMode )
550 case Dali::SamplingMode::BOX:
552 map.Insert( IMAGE_SAMPLING_MODE, BOX );
555 case Dali::SamplingMode::NEAREST:
557 map.Insert( IMAGE_SAMPLING_MODE, NEAREST );
560 case Dali::SamplingMode::LINEAR:
562 map.Insert( IMAGE_SAMPLING_MODE, LINEAR );
565 case Dali::SamplingMode::BOX_THEN_LINEAR:
567 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_LINEAR );
570 case Dali::SamplingMode::BOX_THEN_NEAREST:
572 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_NEAREST );
575 case Dali::SamplingMode::NO_FILTER:
577 map.Insert( IMAGE_SAMPLING_MODE, NO_FILTER );
580 case Dali::SamplingMode::DONT_CARE:
582 map.Insert( IMAGE_SAMPLING_MODE, DONT_CARE );
587 map.Insert( IMAGE_SAMPLING_MODE, DEFAULT );
593 Shader ImageRenderer::GetImageShader( RendererFactoryCache& factoryCache )
595 Shader shader = factoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
598 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
599 factoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, shader );
600 shader.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
601 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
606 void ImageRenderer::SetImage( Actor& actor, const std::string& imageUrl, ImageDimensions size, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode )
608 if( mImageUrl != imageUrl )
610 std::string oldImageUrl = mImageUrl;
611 mImageUrl = imageUrl;
613 mFittingMode = fittingMode;
614 mSamplingMode = samplingMode;
617 if( mImpl->mRenderer )
619 if( GetIsFromCache() ) // if renderer is from cache, remove the old one
621 //remove old renderer
624 actor.RemoveRenderer( mImpl->mRenderer );
628 if( !oldImageUrl.empty() )
630 CleanCache(oldImageUrl);
633 if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
638 else // if renderer is not from cache, reuse the same renderer and only change the texture
640 ResourceImage image = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
641 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
642 ApplyImageToSampler( image );
648 void ImageRenderer::SetImage( Actor& actor, const Image& image )
650 if( mImage != image )
652 NativeImage newNativeImage = NativeImage::DownCast( image );
653 bool newRendererFlag = true;
655 if( newNativeImage && !mNativeImageFlag )
657 SetNativeFragmentShaderCode( newNativeImage );
660 if( ( newNativeImage && mNativeImageFlag ) || ( !newNativeImage && !mNativeImageFlag ) )
662 newRendererFlag = false;
667 mNativeImageFlag = true;
671 mNativeFragmentShaderCode.clear();
672 mNativeImageFlag = false;
677 if( mImpl->mRenderer )
679 // if renderer is from cache, remove the old one, and create new renderer
680 if( GetIsFromCache() )
682 //remove old renderer
685 actor.RemoveRenderer( mImpl->mRenderer );
689 if( !mImageUrl.empty() )
691 CleanCache(mImageUrl);
695 if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
700 // if input image is nativeImage and mImage is regular image or the reverse, remove the old one, and create new renderer
701 else if( newRendererFlag )
703 //remove old renderer
706 actor.RemoveRenderer( mImpl->mRenderer );
709 if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
714 else // if renderer is not from cache, reuse the same renderer and only change the texture
716 ApplyImageToSampler( image );
721 mDesiredSize = ImageDimensions();
722 mFittingMode = FittingMode::DEFAULT;
723 mSamplingMode = SamplingMode::DEFAULT;
727 void ImageRenderer::ApplyImageToSampler( const Image& image )
731 Material material = mImpl->mRenderer.GetMaterial();
734 int index = material.GetTextureIndex( TEXTURE_UNIFORM_NAME );
737 material.SetTextureImage( index, image );
741 material.AddTexture( image, TEXTURE_UNIFORM_NAME );
746 void ImageRenderer::OnImageLoaded( ResourceImage image )
748 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
750 Image brokenImage = RendererFactory::GetBrokenRendererImage();
751 if( mImpl->mRenderer )
753 ApplyImageToSampler( brokenImage );
758 void ImageRenderer::CleanCache(const std::string& url)
760 Material material = mImpl->mRenderer.GetMaterial();
762 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
763 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
764 if( index != Property::INVALID_INDEX )
766 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
767 atlasRectValue.Get( atlasRect );
770 mImpl->mRenderer.Reset();
771 if( mFactoryCache.CleanRendererCache( url ) && index != Property::INVALID_INDEX )
773 mAtlasManager.Remove( material, atlasRect );
777 void ImageRenderer::SetNativeFragmentShaderCode( Dali::NativeImage& nativeImage )
779 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
780 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
784 mNativeFragmentShaderCode = fragmentPreFix;
785 mNativeFragmentShaderCode += "\n";
788 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
790 mNativeFragmentShaderCode += mImpl->mCustomShader->mFragmentShader;
794 mNativeFragmentShaderCode += FRAGMENT_SHADER;
797 if( customSamplerTypename )
799 mNativeFragmentShaderCode.replace( mNativeFragmentShaderCode.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
804 } // namespace Internal
806 } // namespace Toolkit