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 ATLAS_RECT_UNIFORM_NAME = "uAtlasRect";
75 const std::string PIXEL_AREA_UNIFORM_NAME = "pixelArea";
77 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
79 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
81 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
82 attribute mediump vec2 aPosition;\n
83 uniform mediump mat4 uMvpMatrix;\n
84 uniform mediump vec3 uSize;\n
85 uniform mediump vec4 uAtlasRect;\n
86 uniform mediump vec4 pixelArea;
87 varying mediump vec2 vTexCoord;\n
91 mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
92 vertexPosition.xyz *= uSize;\n
93 vertexPosition = uMvpMatrix * vertexPosition;\n
95 vTexCoord = mix( uAtlasRect.xy, uAtlasRect.zw, pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) ) );\n
96 gl_Position = vertexPosition;\n
100 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
101 varying mediump vec2 vTexCoord;\n
102 uniform sampler2D sTexture;\n
103 uniform lowp vec4 uColor;\n
107 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor;\n
111 Geometry CreateGeometry( RendererFactoryCache& factoryCache, ImageDimensions gridSize )
115 if( gridSize == ImageDimensions( 1, 1 ) )
117 geometry = factoryCache.GetGeometry( RendererFactoryCache::QUAD_GEOMETRY );
120 geometry = RendererFactoryCache::CreateQuadGeometry();
121 factoryCache.SaveGeometry( RendererFactoryCache::QUAD_GEOMETRY, geometry );
126 geometry = RendererFactoryCache::CreateGridGeometry( gridSize );
132 } //unnamed namespace
134 ImageRenderer::ImageRenderer( RendererFactoryCache& factoryCache, ImageAtlasManager& atlasManager )
135 : ControlRenderer( factoryCache ),
136 mAtlasManager( atlasManager ),
138 mFittingMode( FittingMode::DEFAULT ),
139 mSamplingMode( SamplingMode::DEFAULT ),
140 mNativeFragmentShaderCode( ),
141 mNativeImageFlag( false )
145 ImageRenderer::~ImageRenderer()
149 void ImageRenderer::DoInitialize( Actor& actor, const Property::Map& propertyMap )
151 std::string oldImageUrl = mImageUrl;
153 Property::Value* imageURLValue = propertyMap.Find( IMAGE_URL_NAME );
156 imageURLValue->Get( mImageUrl );
157 if( !mImageUrl.empty() )
162 Property::Value* fittingValue = propertyMap.Find( IMAGE_FITTING_MODE );
166 fittingValue->Get( fitting );
168 mFittingMode = FittingMode::DEFAULT;
169 if( fitting == SHRINK_TO_FIT )
171 mFittingMode = FittingMode::SHRINK_TO_FIT;
173 else if( fitting == SCALE_TO_FILL )
175 mFittingMode = FittingMode::SCALE_TO_FILL;
177 else if( fitting == FIT_WIDTH )
179 mFittingMode = FittingMode::FIT_WIDTH;
181 else if( fitting == FIT_HEIGHT )
183 mFittingMode = FittingMode::FIT_HEIGHT;
185 else if( fitting == DEFAULT )
187 mFittingMode = FittingMode::DEFAULT;
191 DALI_ASSERT_ALWAYS("Unknown fitting mode");
195 Property::Value* samplingValue = propertyMap.Find( IMAGE_SAMPLING_MODE );
198 std::string sampling;
199 samplingValue->Get( sampling );
201 mSamplingMode = SamplingMode::DEFAULT;
202 if( sampling == BOX )
204 mSamplingMode = SamplingMode::BOX;
206 else if( sampling == NEAREST )
208 mSamplingMode = SamplingMode::NEAREST;
210 else if( sampling == LINEAR )
212 mSamplingMode = SamplingMode::LINEAR;
214 else if( sampling == BOX_THEN_NEAREST )
216 mSamplingMode = SamplingMode::BOX_THEN_NEAREST;
218 else if( sampling == BOX_THEN_LINEAR )
220 mSamplingMode = SamplingMode::BOX_THEN_LINEAR;
222 else if( sampling == NO_FILTER )
224 mSamplingMode = SamplingMode::NO_FILTER;
226 else if( sampling == DONT_CARE )
228 mSamplingMode = SamplingMode::DONT_CARE;
230 else if( sampling == DEFAULT )
232 mSamplingMode = SamplingMode::DEFAULT;
236 DALI_ASSERT_ALWAYS("Unknown sampling mode");
240 int desiredWidth = 0;
241 Property::Value* desiredWidthValue = propertyMap.Find( IMAGE_DESIRED_WIDTH );
242 if( desiredWidthValue )
244 desiredWidthValue->Get( desiredWidth );
247 int desiredHeight = 0;
248 Property::Value* desiredHeightValue = propertyMap.Find( IMAGE_DESIRED_HEIGHT );
249 if( desiredHeightValue )
251 desiredHeightValue->Get( desiredHeight );
254 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
257 // remove old renderer if exit
258 if( mImpl->mRenderer )
260 if( actor ) //remove old renderer from actor
262 actor.RemoveRenderer( mImpl->mRenderer );
264 if( !oldImageUrl.empty() ) //clean old renderer from cache
266 CleanCache( oldImageUrl );
270 NativeImage nativeImage = NativeImage::DownCast( mImage );
274 SetNativeFragmentShaderCode( nativeImage );
277 // if actor is on stage, create new renderer and apply to actor
278 if( actor && actor.OnStage() )
284 void ImageRenderer::SetSize( const Vector2& size )
286 ControlRenderer::SetSize( size );
289 void ImageRenderer::GetNaturalSize( Vector2& naturalSize ) const
293 naturalSize.x = mImage.GetWidth();
294 naturalSize.y = mImage.GetHeight();
297 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
299 naturalSize.x = mDesiredSize.GetWidth();
300 naturalSize.y = mDesiredSize.GetHeight();
303 else if( !mImageUrl.empty() )
305 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
306 naturalSize.x = dimentions.GetWidth();
307 naturalSize.y = dimentions.GetHeight();
311 naturalSize = Vector2::ZERO;
314 void ImageRenderer::SetClipRect( const Rect<int>& clipRect )
316 ControlRenderer::SetClipRect( clipRect );
319 void ImageRenderer::SetOffset( const Vector2& offset )
323 Renderer ImageRenderer::CreateRenderer() const
328 // If mImage is nativeImage with custom sampler or prefix, mNativeFragmentShaderCode will be applied.
329 // Renderer can't be shared between NativeImage and other image types.
330 if( !mNativeFragmentShaderCode.empty() )
332 return CreateNativeImageRenderer();
335 if( !mImpl->mCustomShader )
337 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
339 shader = GetImageShader(mFactoryCache);
343 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
344 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
346 shader = GetImageShader(mFactoryCache);
350 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
351 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER : mImpl->mCustomShader->mFragmentShader,
352 mImpl->mCustomShader->mHints );
353 if( mImpl->mCustomShader->mVertexShader.empty() )
355 shader.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
356 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
361 TextureSet textureSet = TextureSet::New();
363 Renderer renderer = Renderer::New( geometry, shader );
364 renderer.SetTextures( textureSet );
369 Renderer ImageRenderer::CreateNativeImageRenderer() const
374 if( !mImpl->mCustomShader )
376 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
378 shader = Shader::New( VERTEX_SHADER, mNativeFragmentShaderCode );
379 shader.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
380 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
384 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
385 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
387 shader = Shader::New( VERTEX_SHADER, mNativeFragmentShaderCode );
391 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
392 mNativeFragmentShaderCode,
393 mImpl->mCustomShader->mHints );
394 if( mImpl->mCustomShader->mVertexShader.empty() )
396 shader.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
397 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
402 TextureSet textureSet = TextureSet::New();
403 Renderer renderer = Renderer::New( geometry, shader );
404 renderer.SetTextures( textureSet );
409 void ImageRenderer::InitializeRenderer( const std::string& imageUrl )
411 if( imageUrl.empty() )
416 mImageUrl = imageUrl;
417 mImpl->mRenderer.Reset();
419 if( !mImpl->mCustomShader &&
420 ( strncasecmp( imageUrl.c_str(), HTTP_URL, sizeof(HTTP_URL) -1 ) != 0 ) && // ignore remote images
421 ( strncasecmp( imageUrl.c_str(), HTTPS_URL, sizeof(HTTPS_URL) -1 ) != 0 ) )
423 mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
424 if( !mImpl->mRenderer )
427 TextureSet textureSet = mAtlasManager.Add(atlasRect, imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
430 Geometry geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
431 Shader shader( GetImageShader(mFactoryCache) );
432 mImpl->mRenderer = Renderer::New( geometry, shader );
433 mImpl->mRenderer.SetTextures( textureSet );
434 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
436 else // big image, atlasing is not applied
438 mImpl->mRenderer = CreateRenderer();
440 ResourceImage image = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
441 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
442 TextureSet textureSet = mImpl->mRenderer.GetTextures();
443 textureSet.SetImage( 0u, image );
446 mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
449 mImpl->mFlags |= Impl::IS_FROM_CACHE;
453 // for custom shader or remote image, renderer is not cached and atlas is not applied
455 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
456 mImpl->mRenderer = CreateRenderer();
457 ResourceImage resourceImage = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
458 resourceImage.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
459 ApplyImageToSampler( resourceImage );
463 void ImageRenderer::InitializeRenderer( const Image& image )
465 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
467 mImpl->mRenderer = CreateRenderer();
471 ApplyImageToSampler( image );
476 void ImageRenderer::DoSetOnStage( Actor& actor )
478 if( !mImageUrl.empty() )
480 InitializeRenderer( mImageUrl );
484 InitializeRenderer( mImage );
489 void ImageRenderer::DoSetOffStage( Actor& actor )
491 //If we own the image then make sure we release it when we go off stage
492 if( !mImageUrl.empty() )
494 actor.RemoveRenderer( mImpl->mRenderer );
495 CleanCache(mImageUrl);
500 actor.RemoveRenderer( mImpl->mRenderer );
501 mImpl->mRenderer.Reset();
505 void ImageRenderer::DoCreatePropertyMap( Property::Map& map ) const
508 map.Insert( RENDERER_TYPE, RENDERER_TYPE_VALUE );
509 if( !mImageUrl.empty() )
511 map.Insert( IMAGE_URL_NAME, mImageUrl );
512 map.Insert( IMAGE_DESIRED_WIDTH, mDesiredSize.GetWidth() );
513 map.Insert( IMAGE_DESIRED_HEIGHT, mDesiredSize.GetHeight() );
517 map.Insert( IMAGE_DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
518 map.Insert( IMAGE_DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
520 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
523 map.Insert( IMAGE_URL_NAME, resourceImage.GetUrl() );
527 switch( mFittingMode )
529 case Dali::FittingMode::FIT_HEIGHT:
531 map.Insert( IMAGE_FITTING_MODE, FIT_HEIGHT );
534 case Dali::FittingMode::FIT_WIDTH:
536 map.Insert( IMAGE_FITTING_MODE, FIT_WIDTH );
539 case Dali::FittingMode::SCALE_TO_FILL:
541 map.Insert( IMAGE_FITTING_MODE, SCALE_TO_FILL );
544 case Dali::FittingMode::SHRINK_TO_FIT:
546 map.Insert( IMAGE_FITTING_MODE, SHRINK_TO_FIT );
551 map.Insert( IMAGE_FITTING_MODE, DEFAULT );
556 switch( mSamplingMode )
558 case Dali::SamplingMode::BOX:
560 map.Insert( IMAGE_SAMPLING_MODE, BOX );
563 case Dali::SamplingMode::NEAREST:
565 map.Insert( IMAGE_SAMPLING_MODE, NEAREST );
568 case Dali::SamplingMode::LINEAR:
570 map.Insert( IMAGE_SAMPLING_MODE, LINEAR );
573 case Dali::SamplingMode::BOX_THEN_LINEAR:
575 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_LINEAR );
578 case Dali::SamplingMode::BOX_THEN_NEAREST:
580 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_NEAREST );
583 case Dali::SamplingMode::NO_FILTER:
585 map.Insert( IMAGE_SAMPLING_MODE, NO_FILTER );
588 case Dali::SamplingMode::DONT_CARE:
590 map.Insert( IMAGE_SAMPLING_MODE, DONT_CARE );
595 map.Insert( IMAGE_SAMPLING_MODE, DEFAULT );
601 Shader ImageRenderer::GetImageShader( RendererFactoryCache& factoryCache )
603 Shader shader = factoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
606 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
607 factoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, shader );
608 shader.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, FULL_TEXTURE_RECT );
609 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
614 void ImageRenderer::SetImage( Actor& actor, const std::string& imageUrl, ImageDimensions size, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode )
616 if( mImageUrl != imageUrl )
618 std::string oldImageUrl = mImageUrl;
619 mImageUrl = imageUrl;
621 mFittingMode = fittingMode;
622 mSamplingMode = samplingMode;
625 if( mImpl->mRenderer )
627 if( GetIsFromCache() ) // if renderer is from cache, remove the old one
629 //remove old renderer
632 actor.RemoveRenderer( mImpl->mRenderer );
636 if( !oldImageUrl.empty() )
638 CleanCache(oldImageUrl);
641 if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
646 else // if renderer is not from cache, reuse the same renderer and only change the texture
648 ResourceImage image = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
649 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
650 ApplyImageToSampler( image );
656 void ImageRenderer::SetImage( Actor& actor, const Image& image )
658 if( mImage != image )
660 NativeImage newNativeImage = NativeImage::DownCast( image );
661 bool newRendererFlag = true;
663 if( newNativeImage && !mNativeImageFlag )
665 SetNativeFragmentShaderCode( newNativeImage );
668 if( ( newNativeImage && mNativeImageFlag ) || ( !newNativeImage && !mNativeImageFlag ) )
670 newRendererFlag = false;
675 mNativeImageFlag = true;
679 mNativeFragmentShaderCode.clear();
680 mNativeImageFlag = false;
685 if( mImpl->mRenderer )
687 // if renderer is from cache, remove the old one, and create new renderer
688 if( GetIsFromCache() )
690 //remove old renderer
693 actor.RemoveRenderer( mImpl->mRenderer );
697 if( !mImageUrl.empty() )
699 CleanCache(mImageUrl);
703 if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
708 // if input image is nativeImage and mImage is regular image or the reverse, remove the old one, and create new renderer
709 else if( newRendererFlag )
711 //remove old renderer
714 actor.RemoveRenderer( mImpl->mRenderer );
717 if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
722 else // if renderer is not from cache, reuse the same renderer and only change the texture
724 ApplyImageToSampler( image );
729 mDesiredSize = ImageDimensions();
730 mFittingMode = FittingMode::DEFAULT;
731 mSamplingMode = SamplingMode::DEFAULT;
735 void ImageRenderer::ApplyImageToSampler( const Image& image )
739 TextureSet textureSet = mImpl->mRenderer.GetTextures();
742 textureSet.SetImage( 0u, image );
747 void ImageRenderer::OnImageLoaded( ResourceImage image )
749 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
751 Image brokenImage = RendererFactory::GetBrokenRendererImage();
752 if( mImpl->mRenderer )
754 ApplyImageToSampler( brokenImage );
759 void ImageRenderer::CleanCache(const std::string& url)
761 TextureSet textureSet = mImpl->mRenderer.GetTextures();
763 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
764 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
765 if( index != Property::INVALID_INDEX )
767 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
768 atlasRectValue.Get( atlasRect );
771 mImpl->mRenderer.Reset();
772 if( mFactoryCache.CleanRendererCache( url ) && index != Property::INVALID_INDEX )
774 mAtlasManager.Remove( textureSet, atlasRect );
778 void ImageRenderer::SetNativeFragmentShaderCode( Dali::NativeImage& nativeImage )
780 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
781 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
785 mNativeFragmentShaderCode = fragmentPreFix;
786 mNativeFragmentShaderCode += "\n";
789 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
791 mNativeFragmentShaderCode += mImpl->mCustomShader->mFragmentShader;
795 mNativeFragmentShaderCode += FRAGMENT_SHADER;
798 if( customSamplerTypename )
800 mNativeFragmentShaderCode.replace( mNativeFragmentShaderCode.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
805 } // namespace Internal
807 } // namespace Toolkit