dali/internal/render/gl-resources/bitmap-texture.cpp

   1 /*
   2  * Copyright (c) 2014 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 <dali/internal/render/gl-resources/bitmap-texture.h>
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/integration-api/debug.h>
  23 #include <dali/internal/render/common/vertex.h>
  24 #include <dali/internal/render/common/performance-monitor.h>
  25 #include <dali/internal/render/gl-resources/context.h>
  26 #include <dali/internal/render/gl-resources/texture-units.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Internal
  32 {
  33
  34 BitmapTexture::BitmapTexture(
  35   Integration::Bitmap* const bitmap,
  36   const Integration::Bitmap::PackedPixelsProfile * const bitmapPackedPixelsProfile,
  37   Context& context,
  38   ResourcePolicy::Discardable policy)
  39 : Texture( context,
  40            bitmapPackedPixelsProfile->GetBufferWidth(),
  41            bitmapPackedPixelsProfile->GetBufferHeight(),
  42            bitmap->GetImageWidth(),
  43            bitmap->GetImageHeight(),
  44            bitmap->GetPixelFormat()),
  45   mBitmap(bitmap),
  46   mClearPixels(false),
  47   mDiscardPolicy(policy)
  48 {
  49   DALI_LOG_TRACE_METHOD(Debug::Filter::gImage);
  50   DALI_LOG_SET_OBJECT_STRING(this, DALI_LOG_GET_OBJECT_STRING(bitmap));
  51 }
  52
  53 BitmapTexture::BitmapTexture(
  54   unsigned int width,
  55   unsigned int height,
  56   Pixel::Format pixelFormat,
  57   bool clearPixels,
  58   Context& context,
  59   ResourcePolicy::Discardable policy)
  60 : Texture( context,
  61            width, height,
  62            width, height,
  63            pixelFormat),
  64   mBitmap(NULL),
  65   mClearPixels(clearPixels),
  66   mDiscardPolicy(policy)
  67 {
  68   DALI_LOG_TRACE_METHOD(Debug::Filter::gImage);
  69 }
  70
  71 BitmapTexture::~BitmapTexture()
  72 {
  73   DALI_LOG_TRACE_METHOD(Debug::Filter::gImage);
  74
  75   // GlCleanup() should already have been called by TextureCache ensuring the resource is destroyed
  76   // on the render thread. (And avoiding a potentially problematic virtual call in the destructor)
  77 }
  78
  79 bool BitmapTexture::HasAlphaChannel() const
  80 {
  81   return Pixel::HasAlpha(mPixelFormat);
  82 }
  83
  84 bool BitmapTexture::IsFullyOpaque() const
  85 {
  86   if( mBitmap )
  87   {
  88     return mBitmap->IsFullyOpaque();
  89   }
  90   else
  91   {
  92     return ! HasAlphaChannel(); // Todo: amalgamate updated bitmap's IsFullyOpaque()
  93   }
  94 }
  95
  96 // Bitmap buffer has been changed. Upload changes to GPU.
  97 void BitmapTexture::AreaUpdated( const RectArea& updateArea, const unsigned char* pixels )
  98 {
  99   DALI_LOG_TRACE_METHOD(Debug::Filter::gImage);
 100   DALI_LOG_INFO(Debug::Filter::gGLResource, Debug::Verbose, "BitmapTexture::AreaUpdated()\n");
 101
 102   GLenum pixelFormat   = GL_RGBA;
 103   GLenum pixelDataType = GL_UNSIGNED_BYTE;
 104   Integration::ConvertToGlFormat(mPixelFormat, pixelDataType, pixelFormat);
 105
 106   mContext.ActiveTexture( TEXTURE_UNIT_UPLOAD );
 107
 108   mContext.Bind2dTexture(mId);
 109
 110   if( ! updateArea.IsEmpty() )
 111   {
 112     mContext.PixelStorei( GL_UNPACK_ALIGNMENT, 1 ); // We always use tightly packed data
 113     DALI_LOG_INFO( Debug::Filter::gImage, Debug::General, "Update x:%d y:%d w:%d h:%d\n",
 114                    updateArea.x, updateArea.y, updateArea.width ,updateArea.height );
 115
 116     const unsigned int pitchPixels = mWidth;
 117     const unsigned int pixelDepth = GetBytesPerPixel( mPixelFormat );
 118
 119     // If the width of the source update area is the same as the pitch, then can
 120     // copy the contents in a single contiguous TexSubImage call.
 121     if(updateArea.x == 0 && updateArea.width == pitchPixels)
 122     {
 123       pixels += updateArea.y * pitchPixels * pixelDepth;
 124       mContext.TexSubImage2D( GL_TEXTURE_2D,0, updateArea.x, updateArea.y,
 125                               updateArea.width, updateArea.height,
 126                               pixelFormat, pixelDataType, pixels );
 127     }
 128     else
 129     {
 130       // Otherwise the source buffer needs to be copied line at a time, as OpenGL ES
 131       // does not support source strides. (no GL_UNPACK_ROW_LENGTH supported)
 132       unsigned int yBottom = updateArea.y + updateArea.height;
 133       pixels += (updateArea.y * pitchPixels + updateArea.x) * pixelDepth;
 134
 135       for(unsigned int y = updateArea.y; y < yBottom; y++)
 136       {
 137         mContext.TexSubImage2D( GL_TEXTURE_2D,0, updateArea.x, y,
 138                                 updateArea.width, 1,
 139                                 pixelFormat, pixelDataType, pixels );
 140         pixels += pitchPixels * pixelDepth;
 141       }
 142     }
 143
 144     INCREASE_BY( PerformanceMonitor::TEXTURE_DATA_UPLOADED,
 145                  updateArea.Area()* GetBytesPerPixel( mPixelFormat ));
 146   }
 147 }
 148
 149 void BitmapTexture::AssignBitmap( bool generateTexture, const unsigned char* pixels )
 150 {
 151   DALI_LOG_TRACE_METHOD(Debug::Filter::gImage);
 152   DALI_LOG_INFO(Debug::Filter::gGLResource, Debug::Verbose, "BitmapTexture::AssignBitmap()\n");
 153
 154   GLenum pixelFormat = GL_RGBA;
 155   GLenum pixelDataType = GL_UNSIGNED_BYTE;
 156
 157   if( generateTexture )
 158   {
 159     mContext.GenTextures(1, &mId);
 160   }
 161   DALI_ASSERT_DEBUG( mId != 0 );
 162
 163   mContext.ActiveTexture( TEXTURE_UNIT_UPLOAD );
 164   mContext.Bind2dTexture(mId);
 165   Integration::ConvertToGlFormat(mPixelFormat, pixelDataType, pixelFormat);
 166
 167   mContext.PixelStorei(GL_UNPACK_ALIGNMENT, 1); // We always use tightly packed data
 168   mContext.TexImage2D(GL_TEXTURE_2D, 0, pixelFormat, mWidth, mHeight, 0, pixelFormat, pixelDataType, pixels);
 169   mContext.TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
 170   mContext.TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
 171
 172   INCREASE_BY( PerformanceMonitor::TEXTURE_DATA_UPLOADED, GetBytesPerPixel(mPixelFormat) * mWidth * mHeight );
 173 }
 174
 175 void BitmapTexture::Update( Integration::Bitmap* bitmap )
 176 {
 177   DALI_LOG_INFO( Debug::Filter::gGLResource, Debug::General, "BitmapTexture::Update(bitmap:%p )\n", bitmap );
 178   DALI_ASSERT_DEBUG( bitmap != 0 );
 179   if( !bitmap )
 180   {
 181     DALI_LOG_ERROR( "Passed a null bitmap to update this bitmap texture." );
 182     return;
 183   }
 184
 185   // Only Packed-pixel bitmaps are ever associated with BitmapTextures, so we should never be passed any other kind:
 186   const Integration::Bitmap::PackedPixelsProfile * const bitmapPackedPixels = bitmap->GetPackedPixelsProfile();
 187   DALI_ASSERT_DEBUG(bitmapPackedPixels);
 188   if( !bitmapPackedPixels )
 189   {
 190     ///! This should never happen.
 191     DALI_LOG_ERROR("Passed an incompatible bitmap type to update this bitmap texture.");
 192     return;
 193   }
 194   mBitmap = bitmap;
 195
 196   const unsigned char* pixels = mBitmap->GetBuffer();
 197
 198   // We should never have null pixel data here - resource manager has deliberately loaded/reloaded data
 199
 200   DALI_ASSERT_DEBUG( pixels != NULL );
 201
 202   if( NULL == pixels )
 203   {
 204     DALI_LOG_ERROR("BitmapTexture::Upload() - Bitmap has no pixel data.\n");
 205   }
 206   else if( mId != 0 )
 207   {
 208     if( mImageWidth == mBitmap->GetImageWidth() &&
 209         mImageHeight == mBitmap->GetImageHeight() &&
 210         mWidth  == bitmapPackedPixels->GetBufferWidth() &&
 211         mHeight == bitmapPackedPixels->GetBufferHeight() &&
 212         mPixelFormat == mBitmap->GetPixelFormat() ) // and size hasn't changed
 213     {
 214       RectArea area(0, 0, mImageWidth, mImageHeight);  // just update whole texture
 215       AreaUpdated( area, pixels );
 216       DiscardBitmapBuffer();
 217     }
 218     else // Otherwise, reload the pixel data
 219     {
 220       mImageWidth  = mBitmap->GetImageWidth();
 221       mImageHeight = mBitmap->GetImageHeight();
 222       mWidth       = bitmapPackedPixels->GetBufferWidth();
 223       mHeight      = bitmapPackedPixels->GetBufferHeight();
 224       mPixelFormat = mBitmap->GetPixelFormat();
 225
 226       AssignBitmap( false, pixels );
 227     }
 228   }
 229 }
 230
 231 void BitmapTexture::Update( Integration::Bitmap* srcBitmap, std::size_t xOffset, std::size_t yOffset )
 232 {
 233   if( NULL != srcBitmap )
 234   {
 235     GLenum pixelFormat   = GL_RGBA;
 236     GLenum pixelDataType = GL_UNSIGNED_BYTE;
 237     Integration::ConvertToGlFormat( mPixelFormat, pixelDataType, pixelFormat );
 238
 239     if( !mId )
 240     {
 241       mContext.GenTextures( 1, &mId );
 242
 243       mContext.ActiveTexture( TEXTURE_UNIT_UPLOAD );
 244       mContext.Bind2dTexture( mId );
 245       mContext.PixelStorei( GL_UNPACK_ALIGNMENT, 1 );
 246
 247       mContext.TexImage2D( GL_TEXTURE_2D, 0, pixelFormat, mWidth, mHeight, 0, pixelFormat, pixelDataType, NULL );
 248       mContext.TexParameteri( GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE );
 249       mContext.TexParameteri( GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE );
 250     }
 251     else
 252     {
 253       mContext.ActiveTexture( TEXTURE_UNIT_UPLOAD );
 254       mContext.Bind2dTexture( mId );
 255       mContext.PixelStorei( GL_UNPACK_ALIGNMENT, 1 );
 256     }
 257
 258     mContext.TexSubImage2D( GL_TEXTURE_2D, 0,
 259                             xOffset, yOffset,
 260                             srcBitmap->GetImageWidth(), srcBitmap->GetImageHeight(),
 261                             pixelFormat, pixelDataType, srcBitmap->GetBuffer() );
 262   }
 263 }
 264
 265 void BitmapTexture::UpdateArea( const RectArea& updateArea )
 266 {
 267   DALI_LOG_INFO(Debug::Filter::gGLResource, Debug::General, "BitmapTexture::UpdateArea()\n");
 268
 269   if( mBitmap != 0 )
 270   {
 271     const unsigned char* pixels = mBitmap->GetBuffer();
 272
 273     // Pixel data could be null if we've uploaded to GL and discarded the data.
 274
 275     if( NULL != pixels )
 276     {
 277       if( mId ) // If the texture is already bound
 278       {
 279         if( updateArea.IsEmpty() )
 280         {
 281           RectArea area;
 282           area.x = 0;
 283           area.y = 0;
 284           area.width = mImageWidth;
 285           area.height = mImageHeight;
 286           AreaUpdated( area, pixels );
 287         }
 288         else
 289         {
 290           AreaUpdated( updateArea, pixels );
 291         }
 292       }
 293     }
 294   }
 295 }
 296
 297 bool BitmapTexture::UpdateOnCreate()
 298 {
 299   return true;
 300 }
 301
 302 bool BitmapTexture::CreateGlTexture()
 303 {
 304   DALI_LOG_TRACE_METHOD(Debug::Filter::gImage);
 305   DALI_LOG_INFO(Debug::Filter::gImage, Debug::Verbose, "BitmapTexture::CreateGlTexture() Bitmap: %s\n", DALI_LOG_GET_OBJECT_C_STR(this));
 306
 307   if( mBitmap )
 308   {
 309     const unsigned char* pixels = mBitmap->GetBuffer();
 310
 311     // pixel data could be NULL here if we've had a context loss and we previously discarded
 312     // the pixel data on the previous upload. If it is null, then we shouldn't generate a
 313     // new GL Texture; leaving mId as zero. Eventually, the bitmap will get reloaded,
 314     // and pixels will become non-null.
 315
 316     if( NULL != pixels )
 317     {
 318       AssignBitmap( true, pixels );
 319       DiscardBitmapBuffer();
 320     }
 321   }
 322   else
 323   {
 324     const unsigned char* pixels = NULL;
 325     std::vector<unsigned char> pixelData;
 326     if( ( NULL == pixels ) && ( true == mClearPixels ) )
 327     {
 328       unsigned int size = mWidth * mHeight * Pixel::GetBytesPerPixel(mPixelFormat);
 329       pixelData.resize(size, 0);
 330       pixels = &pixelData[0];
 331     }
 332     AssignBitmap( true, pixels );
 333   }
 334
 335   return mId != 0;
 336 }
 337
 338 bool BitmapTexture::Init()
 339 {
 340   DALI_LOG_TRACE_METHOD(Debug::Filter::gImage);
 341   // mBitmap should be initialized by now
 342   return (mBitmap != 0);
 343 }
 344
 345 unsigned int BitmapTexture::GetWidth() const
 346 {
 347   unsigned int width = mWidth;
 348   if( mBitmap )
 349   {
 350     width = mBitmap->GetImageWidth();
 351   }
 352   return width;
 353 }
 354
 355 unsigned int BitmapTexture::GetHeight() const
 356 {
 357   unsigned int height = mHeight;
 358   if( mBitmap )
 359   {
 360     height = mBitmap->GetImageHeight();
 361   }
 362   return height;
 363 }
 364
 365 void BitmapTexture::DiscardBitmapBuffer()
 366 {
 367   DALI_LOG_INFO(Debug::Filter::gImage, Debug::General, "BitmapTexture::DiscardBitmapBuffer() DiscardPolicy: %s\n", mDiscardPolicy == ResourcePolicy::DISCARD?"DISCARD":"RETAIN");
 368
 369   if( ResourcePolicy::DISCARD == mDiscardPolicy )
 370   {
 371     DALI_LOG_INFO(Debug::Filter::gImage, Debug::General, "  Discarding bitmap\n");
 372     mBitmap->DiscardBuffer();
 373   }
 374 }
 375
 376
 377 } //namespace Internal
 378
 379 } //namespace Dali