dali-toolkit/internal/visuals/image/batch-image-visual.cpp

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include "batch-image-visual.h"
  20
  21 // EXTERNAL HEADER
  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>
  26 #include <dali/devel-api/adaptor-framework/bitmap-loader.h>
  27 #include <dali/devel-api/rendering/renderer-devel.h>
  28 #include <dali/public-api/images/pixel-data.h>
  29 #include <dali/public-api/rendering/texture.h>
  30 #include <dali/public-api/rendering/texture-set.h>
  31 #include <dali/public-api/rendering/texture-set.h>
  32
  33 // INTERNAL HEADER
  34 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
  35 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
  36 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
  37 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  38 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  39 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  40 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  41 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
  42
  43 namespace Dali
  44 {
  45
  46 namespace Toolkit
  47 {
  48
  49 namespace Internal
  50 {
  51
  52 namespace
  53 {
  54 const char HTTP_URL[] = "http://";
  55 const char HTTPS_URL[] = "https://";
  56
  57 // Properties:
  58 const char * const DESIRED_WIDTH( "desiredWidth" );
  59 const char * const DESIRED_HEIGHT( "desiredHeight" );
  60
  61 const Vector4 FULL_TEXTURE_RECT( 0.f, 0.f, 1.f, 1.f );
  62
  63 // The shader used for batched rendering. It uses interleaved data for
  64 // attributes. Limitation is that all batched renderers will share same set of uniforms.
  65 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
  66   attribute mediump vec2 aPosition;\n
  67   attribute mediump vec2 aTexCoord;\n
  68   uniform mediump mat4 uMvpMatrix;\n
  69   varying mediump vec2 vTexCoord;\n
  70   \n
  71   void main()\n
  72   {\n
  73     vTexCoord = aTexCoord;\n
  74     gl_Position = uMvpMatrix * vec4( aPosition, 0.0, 1.0 );\n
  75   }\n
  76 );
  77
  78 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
  79   varying mediump vec2 vTexCoord;\n
  80   uniform sampler2D sTexture;\n
  81   uniform lowp vec4 uColor;\n
  82   uniform lowp float uAlphaBlending; // Set to 1.0 for conventional alpha blending; if pre-multiplied alpha blending, set to 0.0
  83   \n
  84   void main()\n
  85   {\n
  86     gl_FragColor = texture2D( sTexture, vTexCoord ) * vec4( uColor.rgb*max( uAlphaBlending, uColor.a ), uColor.a );\n
  87   }\n
  88 );
  89
  90 } // unnamed namespace
  91
  92 BatchImageVisualPtr BatchImageVisual::New( VisualFactoryCache& factoryCache, const std::string& url, const Property::Map& properties )
  93 {
  94   BatchImageVisualPtr visual = new BatchImageVisual( factoryCache );
  95   visual->mImageUrl = url;
  96   visual->SetProperties( properties );
  97
  98   return visual;
  99 }
 100
 101 BatchImageVisual::BatchImageVisual( VisualFactoryCache& factoryCache )
 102 : Visual::Base( factoryCache ),
 103   mImageUrl(""),
 104   mDesiredSize()
 105 {
 106 }
 107
 108 BatchImageVisual::~BatchImageVisual()
 109 {
 110 }
 111
 112 void BatchImageVisual::DoSetProperties( const Property::Map& propertyMap )
 113 {
 114   // url already passed in constructor
 115
 116   int desiredWidth = 0;
 117   Property::Value* desiredWidthValue = propertyMap.Find( Dali::Toolkit::ImageVisual::Property::DESIRED_WIDTH, DESIRED_WIDTH );
 118   if( desiredWidthValue )
 119   {
 120     desiredWidthValue->Get( desiredWidth );
 121   }
 122
 123   int desiredHeight = 0;
 124   Property::Value* desiredHeightValue = propertyMap.Find( Dali::Toolkit::ImageVisual::Property::DESIRED_HEIGHT, DESIRED_HEIGHT );
 125   if( desiredHeightValue )
 126   {
 127     desiredHeightValue->Get( desiredHeight );
 128   }
 129
 130   mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
 131 }
 132
 133 void BatchImageVisual::GetNaturalSize( Vector2& naturalSize )
 134 {
 135   if( mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0 )
 136   {
 137     naturalSize.x = mDesiredSize.GetWidth();
 138     naturalSize.y = mDesiredSize.GetHeight();
 139     return;
 140   }
 141   else if( !mImageUrl.empty() )
 142   {
 143     ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
 144     naturalSize.x = dimentions.GetWidth();
 145     naturalSize.y = dimentions.GetHeight();
 146     return;
 147   }
 148
 149   naturalSize = Vector2::ZERO;
 150 }
 151
 152 void BatchImageVisual::InitializeRenderer( const std::string& imageUrl )
 153 {
 154   if( imageUrl.empty() )
 155   {
 156     return;
 157   }
 158
 159   mImageUrl = imageUrl;
 160   mImpl->mRenderer.Reset();
 161   mAtlasRect = FULL_TEXTURE_RECT;
 162
 163   if( !mImpl->mCustomShader &&
 164       ( strncasecmp( imageUrl.c_str(),HTTP_URL,  sizeof( HTTP_URL )  -1 ) != 0 ) && // Ignore remote images
 165       ( strncasecmp( imageUrl.c_str(), HTTPS_URL, sizeof( HTTPS_URL ) -1 ) != 0 ) )
 166   {
 167     if( !mImpl->mRenderer )
 168     {
 169       TextureSet textureSet = mFactoryCache.GetAtlasManager()->Add(
 170             mAtlasRect,
 171             imageUrl,
 172             mDesiredSize );
 173
 174       // If image doesn't fit the atlas, create new texture set with texture that
 175       // is used as whole.
 176       if( !textureSet )
 177       {
 178         BitmapLoader loader = BitmapLoader::New( imageUrl, mDesiredSize );
 179         loader.Load();
 180         Dali::PixelData pixelData = loader.GetPixelData();
 181         Texture texture = Texture::New( TextureType::TEXTURE_2D,
 182                                         pixelData.GetPixelFormat(),
 183                                         pixelData.GetWidth(),
 184                                         pixelData.GetHeight() );
 185         texture.Upload( pixelData );
 186         textureSet = TextureSet::New();
 187         textureSet.SetTexture( 0, texture );
 188         mAtlasRect = FULL_TEXTURE_RECT;
 189       }
 190
 191       Geometry geometry = mFactoryCache.CreateBatchQuadGeometry( mAtlasRect );
 192       Shader shader( GetBatchShader( mFactoryCache ) );
 193       mImpl->mRenderer = Renderer::New( geometry, shader );
 194       mImpl->mRenderer.SetTextures( textureSet );
 195
 196       // Turn batching on, to send message it must be on stage.
 197       mImpl->mRenderer.SetProperty( Dali::DevelRenderer::Property::BATCHING_ENABLED, true );
 198     }
 199     mImpl->mFlags |= Impl::IS_FROM_CACHE;
 200   }
 201 }
 202
 203 void BatchImageVisual::DoSetOnStage( Actor& actor )
 204 {
 205   if( !mImageUrl.empty() )
 206   {
 207     InitializeRenderer( mImageUrl );
 208   }
 209   // Turn batching on, to send message it must be on stage
 210   mImpl->mRenderer.SetProperty( Dali::DevelRenderer::Property::BATCHING_ENABLED, true );
 211
 212   actor.AddRenderer( mImpl->mRenderer );
 213 }
 214
 215 void BatchImageVisual::DoSetOffStage( Actor& actor )
 216 {
 217   actor.RemoveRenderer( mImpl->mRenderer );
 218
 219   // If we own the image then make sure we release it when we go off stage
 220   if( !mImageUrl.empty() )
 221   {
 222     CleanCache( mImageUrl );
 223   }
 224   else
 225   {
 226     mImpl->mRenderer.Reset();
 227   }
 228 }
 229
 230 void BatchImageVisual::DoCreatePropertyMap( Property::Map& map ) const
 231 {
 232   map.Clear();
 233   map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
 234
 235   if( !mImageUrl.empty() )
 236   {
 237     map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl );
 238     map.Insert( Toolkit::ImageVisual::Property::BATCHING_ENABLED, true );
 239     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
 240     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
 241   }
 242 }
 243
 244 Shader BatchImageVisual::GetBatchShader( VisualFactoryCache& factoryCache )
 245 {
 246   Shader shader = factoryCache.GetShader( VisualFactoryCache::BATCH_IMAGE_SHADER );
 247   if( !shader )
 248   {
 249     shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
 250     factoryCache.SaveShader( VisualFactoryCache::BATCH_IMAGE_SHADER, shader );
 251   }
 252   return shader;
 253 }
 254
 255 void BatchImageVisual::CleanCache(const std::string& url)
 256 {
 257   TextureSet textureSet = mImpl->mRenderer.GetTextures();
 258   mImpl->mRenderer.Reset();
 259   if( mFactoryCache.CleanRendererCache( url ) )
 260   {
 261     mFactoryCache.GetAtlasManager()->Remove( textureSet, mAtlasRect );
 262   }
 263 }
 264
 265 void BatchImageVisual::OnSetTransform()
 266 {
 267   if( mImpl->mRenderer )
 268   {
 269     //Register transform properties
 270     mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 271   }
 272 }
 273
 274 } // namespace Internal
 275
 276 } // namespace Toolkit
 277
 278 } // namespace Dali