platform-abstractions/portable/image-operations.cpp

   1 /*
   2  * Copyright (c) 2017 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 #include "image-operations.h"
  19
  20 // EXTERNAL INCLUDES
  21 #include <cstring>
  22 #include <stddef.h>
  23 #include <cmath>
  24 #include <limits>
  25 #include <dali/integration-api/debug.h>
  26 #include <dali/public-api/common/dali-vector.h>
  27 #include <dali/public-api/math/vector2.h>
  28 #include <resampler.h>
  29
  30 // INTERNAL INCLUDES
  31
  32 namespace Dali
  33 {
  34 namespace Internal
  35 {
  36 namespace Platform
  37 {
  38
  39 namespace
  40 {
  41
  42 // The BORDER_FILL_VALUE is a single byte value that is used for horizontal and vertical borders.
  43 // A value of 0x00 gives us transparency for pixel buffers with an alpha channel, or black otherwise.
  44 // We can optionally use a Vector4 color here, but at reduced fill speed.
  45 const uint8_t BORDER_FILL_VALUE( 0x00 );
  46 // A maximum size limit for newly created bitmaps. ( 1u << 16 ) - 1 is chosen as we are using 16bit words for dimensions.
  47 const unsigned int MAXIMUM_TARGET_BITMAP_SIZE( ( 1u << 16 ) - 1 );
  48
  49 // Constants used by the ImageResampler.
  50 const float DEFAULT_SOURCE_GAMMA = 1.75f;   ///< Default source gamma value used in the Resampler() function. Partial gamma correction looks better on mips. Set to 1.0 to disable gamma correction.
  51 const float FILTER_SCALE = 1.f;             ///< Default filter scale value used in the Resampler() function. Filter scale - values < 1.0 cause aliasing, but create sharper looking mips.
  52 const Resampler::Filter FILTER_TYPE = Resampler::LANCZOS4; ///< Default filter used in the Resampler() function. Possible Lanczos filters are: lanczos3, lanczos4, lanczos6, lanczos12
  53
  54 using Integration::Bitmap;
  55 using Integration::BitmapPtr;
  56 typedef unsigned char PixelBuffer;
  57
  58 /**
  59  * @brief 4 byte pixel structure.
  60  */
  61 struct Pixel4Bytes
  62 {
  63   uint8_t r;
  64   uint8_t g;
  65   uint8_t b;
  66   uint8_t a;
  67 } __attribute__((packed, aligned(4))); //< Tell the compiler it is okay to use a single 32 bit load.
  68
  69 /**
  70  * @brief RGB888 pixel structure.
  71  */
  72 struct Pixel3Bytes
  73 {
  74   uint8_t r;
  75   uint8_t g;
  76   uint8_t b;
  77 } __attribute__((packed, aligned(1)));
  78
  79 /**
  80  * @brief RGB565 pixel typedefed from a short.
  81  *
  82  * Access fields by manual shifting and masking.
  83  */
  84 typedef uint16_t PixelRGB565;
  85
  86 /**
  87  * @brief a Pixel composed of two independent byte components.
  88  */
  89 struct Pixel2Bytes
  90 {
  91   uint8_t l;
  92   uint8_t a;
  93 } __attribute__((packed, aligned(2))); //< Tell the compiler it is okay to use a single 16 bit load.
  94
  95
  96 #if defined(DEBUG_ENABLED)
  97 /**
  98  * Disable logging of image operations or make it verbose from the commandline
  99  * as follows (e.g., for dali demo app):
 100  * <code>
 101  * LOG_IMAGE_OPERATIONS=0 dali-demo #< off
 102  * LOG_IMAGE_OPERATIONS=3 dali-demo #< on, verbose
 103  * </code>
 104  */
 105 Debug::Filter* gImageOpsLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_IMAGE_OPERATIONS" );
 106 #endif
 107
 108 /** @return The greatest even number less than or equal to the argument. */
 109 inline unsigned int EvenDown( const unsigned int a )
 110 {
 111   const unsigned int evened = a & ~1u;
 112   return evened;
 113 }
 114
 115 /**
 116  * @brief Log bad parameters.
 117  */
 118 void ValidateScalingParameters( const unsigned int inputWidth,
 119                                 const unsigned int inputHeight,
 120                                 const unsigned int desiredWidth,
 121                                 const unsigned int desiredHeight )
 122 {
 123   if( desiredWidth > inputWidth || desiredHeight > inputHeight )
 124   {
 125     DALI_LOG_INFO( gImageOpsLogFilter, Dali::Integration::Log::Verbose, "Upscaling not supported (%u, %u -> %u, %u).\n", inputWidth, inputHeight, desiredWidth, desiredHeight );
 126   }
 127
 128   if( desiredWidth == 0u || desiredHeight == 0u )
 129   {
 130     DALI_LOG_INFO( gImageOpsLogFilter, Dali::Integration::Log::Verbose, "Downscaling to a zero-area target is pointless.\n" );
 131   }
 132
 133   if( inputWidth == 0u || inputHeight == 0u )
 134   {
 135     DALI_LOG_INFO( gImageOpsLogFilter, Dali::Integration::Log::Verbose, "Zero area images cannot be scaled\n" );
 136   }
 137 }
 138
 139 /**
 140  * @brief Do debug assertions common to all scanline halving functions.
 141  * @note Inline and in anon namespace so should boil away in release builds.
 142  */
 143 inline void DebugAssertScanlineParameters( const uint8_t * const pixels, const unsigned int width )
 144 {
 145   DALI_ASSERT_DEBUG( pixels && "Null pointer." );
 146   DALI_ASSERT_DEBUG( width > 1u && "Can't average fewer than two pixels." );
 147   DALI_ASSERT_DEBUG( width < 131072u && "Unusually wide image: are you sure you meant to pass that value in?" );
 148 }
 149
 150 /**
 151  * @brief Assertions on params to functions averaging pairs of scanlines.
 152  * @note Inline as intended to boil away in release.
 153  */
 154 inline void DebugAssertDualScanlineParameters( const uint8_t * const scanline1,
 155                                                const uint8_t * const scanline2,
 156                                                uint8_t* const outputScanline,
 157                                                const size_t widthInComponents )
 158 {
 159   DALI_ASSERT_DEBUG( scanline1 && "Null pointer." );
 160   DALI_ASSERT_DEBUG( scanline2 && "Null pointer." );
 161   DALI_ASSERT_DEBUG( outputScanline && "Null pointer." );
 162   DALI_ASSERT_DEBUG( ((scanline1 >= scanline2 + widthInComponents) || (scanline2 >= scanline1 + widthInComponents )) && "Scanlines alias." );
 163   DALI_ASSERT_DEBUG( ((outputScanline >= (scanline2 + widthInComponents)) || (scanline2 >= (scanline1 + widthInComponents))) && "Scanline 2 aliases output." );
 164 }
 165
 166 /**
 167  * @brief Converts a scaling mode to the definition of which dimensions matter when box filtering as a part of that mode.
 168  */
 169 BoxDimensionTest DimensionTestForScalingMode( FittingMode::Type fittingMode )
 170 {
 171   BoxDimensionTest dimensionTest;
 172   dimensionTest = BoxDimensionTestEither;
 173
 174   switch( fittingMode )
 175   {
 176     // Shrink to fit attempts to make one or zero dimensions smaller than the
 177     // desired dimensions and one or two dimensions exactly the same as the desired
 178     // ones, so as long as one dimension is larger than the desired size, box
 179     // filtering can continue even if the second dimension is smaller than the
 180     // desired dimensions:
 181     case FittingMode::SHRINK_TO_FIT:
 182     {
 183       dimensionTest = BoxDimensionTestEither;
 184       break;
 185     }
 186     // Scale to fill mode keeps both dimensions at least as large as desired:
 187     case FittingMode::SCALE_TO_FILL:
 188     {
 189       dimensionTest = BoxDimensionTestBoth;
 190       break;
 191     }
 192     // Y dimension is irrelevant when downscaling in FIT_WIDTH mode:
 193     case FittingMode::FIT_WIDTH:
 194     {
 195       dimensionTest = BoxDimensionTestX;
 196       break;
 197     }
 198     // X Dimension is ignored by definition in FIT_HEIGHT mode:
 199     case FittingMode::FIT_HEIGHT:
 200     {
 201       dimensionTest = BoxDimensionTestY;
 202       break;
 203     }
 204   }
 205
 206   return dimensionTest;
 207 }
 208
 209 /**
 210  * @brief Work out the dimensions for a uniform scaling of the input to map it
 211  * into the target while effecting ShinkToFit scaling mode.
 212  */
 213 ImageDimensions FitForShrinkToFit( ImageDimensions target, ImageDimensions source )
 214 {
 215   // Scale the input by the least extreme of the two dimensions:
 216   const float widthScale  = target.GetX() / float(source.GetX());
 217   const float heightScale = target.GetY() / float(source.GetY());
 218   const float scale = widthScale < heightScale ? widthScale : heightScale;
 219
 220   // Do no scaling at all if the result would increase area:
 221   if( scale >= 1.0f )
 222   {
 223     return source;
 224   }
 225
 226   return ImageDimensions( source.GetX() * scale + 0.5f, source.GetY() * scale + 0.5f );
 227 }
 228
 229 /**
 230  * @brief Work out the dimensions for a uniform scaling of the input to map it
 231  * into the target while effecting SCALE_TO_FILL scaling mode.
 232  * @note An image scaled into the output dimensions will need either top and
 233  * bottom or left and right to be cropped away unless the source was pre-cropped
 234  * to match the destination aspect ratio.
 235  */
 236 ImageDimensions FitForScaleToFill( ImageDimensions target, ImageDimensions source )
 237 {
 238   DALI_ASSERT_DEBUG( source.GetX() > 0 && source.GetY() > 0  && "Zero-area rectangles should not be passed-in" );
 239   // Scale the input by the least extreme of the two dimensions:
 240   const float widthScale  = target.GetX() / float(source.GetX());
 241   const float heightScale = target.GetY() / float(source.GetY());
 242   const float scale = widthScale > heightScale ? widthScale : heightScale;
 243
 244   // Do no scaling at all if the result would increase area:
 245   if( scale >= 1.0f )
 246   {
 247     return source;
 248   }
 249
 250   return ImageDimensions( source.GetX() * scale + 0.5f, source.GetY() * scale + 0.5f );
 251 }
 252
 253 /**
 254  * @brief Work out the dimensions for a uniform scaling of the input to map it
 255  * into the target while effecting FIT_WIDTH scaling mode.
 256  */
 257 ImageDimensions FitForFitWidth( ImageDimensions target, ImageDimensions source )
 258 {
 259   DALI_ASSERT_DEBUG( source.GetX() > 0 && "Cant fit a zero-dimension rectangle." );
 260   const float scale  = target.GetX() / float(source.GetX());
 261
 262   // Do no scaling at all if the result would increase area:
 263   if( scale >= 1.0f )
 264   {
 265    return source;
 266   }
 267   return ImageDimensions( source.GetX() * scale + 0.5f, source.GetY() * scale + 0.5f );
 268 }
 269
 270 /**
 271  * @brief Work out the dimensions for a uniform scaling of the input to map it
 272  * into the target while effecting FIT_HEIGHT scaling mode.
 273  */
 274 ImageDimensions FitForFitHeight( ImageDimensions target, ImageDimensions source )
 275 {
 276   DALI_ASSERT_DEBUG( source.GetY() > 0 && "Cant fit a zero-dimension rectangle." );
 277   const float scale = target.GetY() / float(source.GetY());
 278
 279   // Do no scaling at all if the result would increase area:
 280   if( scale >= 1.0f )
 281   {
 282     return source;
 283   }
 284
 285   return ImageDimensions( source.GetX() * scale + 0.5f, source.GetY() * scale + 0.5f );
 286 }
 287
 288 /**
 289  * @brief Generate the rectangle to use as the target of a pixel sampling pass
 290  * (e.g., nearest or linear).
 291  */
 292 ImageDimensions FitToScalingMode( ImageDimensions requestedSize, ImageDimensions sourceSize, FittingMode::Type fittingMode )
 293 {
 294   ImageDimensions fitDimensions;
 295   switch( fittingMode )
 296   {
 297     case FittingMode::SHRINK_TO_FIT:
 298     {
 299       fitDimensions = FitForShrinkToFit( requestedSize, sourceSize );
 300       break;
 301     }
 302     case FittingMode::SCALE_TO_FILL:
 303     {
 304       fitDimensions = FitForScaleToFill( requestedSize, sourceSize );
 305       break;
 306     }
 307     case FittingMode::FIT_WIDTH:
 308     {
 309       fitDimensions = FitForFitWidth( requestedSize, sourceSize );
 310       break;
 311     }
 312     case FittingMode::FIT_HEIGHT:
 313     {
 314       fitDimensions = FitForFitHeight( requestedSize, sourceSize );
 315       break;
 316     }
 317   }
 318
 319   return fitDimensions;
 320 }
 321
 322 /**
 323  * @brief Calculate the number of lines on the X and Y axis that need to be
 324  * either added or removed with repect to the specified fitting mode.
 325  * (e.g., nearest or linear).
 326  * @param[in]     sourceSize      The size of the source image
 327  * @param[in]     fittingMode     The fitting mode to use
 328  * @param[in/out] requestedSize   The target size that the image will be fitted to.
 329  *                                If the source image is smaller than the requested size, the source is not scaled up.
 330  *                                So we reduce the target size while keeping aspect by lowering resolution.
 331  * @param[out]    scanlinesToCrop The number of scanlines to remove from the image (can be negative to represent Y borders required)
 332  * @param[out]    columnsToCrop   The number of columns to remove from the image (can be negative to represent X borders required)
 333  */
 334 void CalculateBordersFromFittingMode(  ImageDimensions sourceSize, FittingMode::Type fittingMode, ImageDimensions& requestedSize, int& scanlinesToCrop, int& columnsToCrop )
 335 {
 336   const unsigned int sourceWidth( sourceSize.GetWidth() );
 337   const unsigned int sourceHeight( sourceSize.GetHeight() );
 338   const float targetAspect( static_cast< float >( requestedSize.GetWidth() ) / static_cast< float >( requestedSize.GetHeight() ) );
 339   int finalWidth = 0;
 340   int finalHeight = 0;
 341
 342   switch( fittingMode )
 343   {
 344     case FittingMode::FIT_WIDTH:
 345     {
 346       finalWidth = sourceWidth;
 347       finalHeight = static_cast< float >( sourceWidth ) / targetAspect;
 348
 349       columnsToCrop = 0;
 350       scanlinesToCrop = -( finalHeight - sourceHeight );
 351       break;
 352     }
 353
 354     case FittingMode::FIT_HEIGHT:
 355     {
 356       finalWidth = static_cast< float >( sourceHeight ) * targetAspect;
 357       finalHeight = sourceHeight;
 358
 359       columnsToCrop = -( finalWidth - sourceWidth );
 360       scanlinesToCrop = 0;
 361       break;
 362     }
 363
 364     case FittingMode::SHRINK_TO_FIT:
 365     {
 366       const float sourceAspect( static_cast< float >( sourceWidth ) / static_cast< float >( sourceHeight ) );
 367       if( sourceAspect > targetAspect )
 368       {
 369         finalWidth = sourceWidth;
 370         finalHeight = static_cast< float >( sourceWidth ) / targetAspect;
 371
 372         columnsToCrop = 0;
 373         scanlinesToCrop = -( finalHeight - sourceHeight );
 374       }
 375       else
 376       {
 377         finalWidth = static_cast< float >( sourceHeight ) * targetAspect;
 378         finalHeight = sourceHeight;
 379
 380         columnsToCrop = -( finalWidth - sourceWidth );
 381         scanlinesToCrop = 0;
 382       }
 383       break;
 384     }
 385
 386     case FittingMode::SCALE_TO_FILL:
 387     {
 388       const float sourceAspect( static_cast< float >( sourceWidth ) / static_cast< float >( sourceHeight ) );
 389       if( sourceAspect > targetAspect )
 390       {
 391         finalWidth = static_cast< float >( sourceHeight ) * targetAspect;
 392         finalHeight = sourceHeight;
 393
 394         columnsToCrop = -( finalWidth - sourceWidth );
 395         scanlinesToCrop = 0;
 396       }
 397       else
 398       {
 399         finalWidth = sourceWidth;
 400         finalHeight = static_cast< float >( sourceWidth ) / targetAspect;
 401
 402         columnsToCrop = 0;
 403         scanlinesToCrop = -( finalHeight - sourceHeight );
 404       }
 405       break;
 406     }
 407   }
 408
 409   requestedSize.SetWidth( finalWidth );
 410   requestedSize.SetHeight( finalHeight );
 411 }
 412
 413 /**
 414  * @brief Construct a bitmap with format and dimensions requested.
 415  */
 416 BitmapPtr MakeEmptyBitmap( Pixel::Format pixelFormat, unsigned int width, unsigned int height )
 417 {
 418   DALI_ASSERT_DEBUG( Pixel::GetBytesPerPixel(pixelFormat) && "Compressed formats not supported." );
 419
 420   // Allocate a pixel buffer to hold the image passed in:
 421   Integration::BitmapPtr newBitmap = Integration::Bitmap::New( Integration::Bitmap::BITMAP_2D_PACKED_PIXELS, ResourcePolicy::OWNED_DISCARD );
 422   newBitmap->GetPackedPixelsProfile()->ReserveBuffer( pixelFormat, width, height, width, height );
 423   return newBitmap;
 424 }
 425
 426 /**
 427  * @brief Construct a bitmap object from a copy of the pixel array passed in.
 428  */
 429 BitmapPtr MakeBitmap( const uint8_t * const pixels, Pixel::Format pixelFormat, unsigned int width, unsigned int height )
 430 {
 431   DALI_ASSERT_DEBUG( pixels && "Null bitmap buffer to copy." );
 432
 433   // Allocate a pixel buffer to hold the image passed in:
 434   Integration::BitmapPtr newBitmap = MakeEmptyBitmap( pixelFormat, width, height );
 435
 436   // Copy over the pixels from the downscaled image that was generated in-place in the pixel buffer of the input bitmap:
 437   memcpy( newBitmap->GetBuffer(), pixels, width * height * Pixel::GetBytesPerPixel( pixelFormat ) );
 438   return newBitmap;
 439 }
 440
 441 /**
 442  * @brief Work out the desired width and height, accounting for zeros.
 443  *
 444  * @param[in] bitmapWidth Width of image before processing.
 445  * @param[in] bitmapHeight Height of image before processing.
 446  * @param[in] requestedWidth Width of area to scale image into. Can be zero.
 447  * @param[in] requestedHeight Height of area to scale image into. Can be zero.
 448  * @return Dimensions of area to scale image into after special rules are applied.
 449  */
 450 ImageDimensions CalculateDesiredDimensions( unsigned int bitmapWidth, unsigned int bitmapHeight, unsigned int requestedWidth, unsigned int requestedHeight )
 451 {
 452   // If no dimensions have been requested, default to the source ones:
 453   if( requestedWidth == 0 && requestedHeight == 0 )
 454   {
 455     return ImageDimensions( bitmapWidth, bitmapHeight );
 456   }
 457
 458   // If both dimensions have values requested, use them both:
 459   if( requestedWidth != 0 && requestedHeight != 0 )
 460   {
 461     return ImageDimensions( requestedWidth, requestedHeight );
 462   }
 463
 464   // Only one of the dimensions has been requested. Calculate the other from
 465   // the requested one and the source image aspect ratio:
 466   if( requestedWidth != 0 )
 467   {
 468     return ImageDimensions( requestedWidth, bitmapHeight / float(bitmapWidth) * requestedWidth + 0.5f );
 469   }
 470   return ImageDimensions( bitmapWidth / float(bitmapHeight) * requestedHeight + 0.5f, requestedHeight );
 471 }
 472
 473 } // namespace - unnamed
 474
 475 ImageDimensions CalculateDesiredDimensions( ImageDimensions rawDimensions, ImageDimensions requestedDimensions )
 476 {
 477   return CalculateDesiredDimensions( rawDimensions.GetWidth(), rawDimensions.GetHeight(), requestedDimensions.GetWidth(), requestedDimensions.GetHeight() ) ;
 478 }
 479
 480 /**
 481  * @brief Apply cropping and padding for specified fitting mode.
 482  *
 483  * Once the bitmap has been (optionally) downscaled to an appropriate size, this method performs alterations
 484  * based on the fitting mode.
 485  *
 486  * This will add vertical or horizontal borders if necessary.
 487  * Crop the source image data vertically or horizontally if necessary.
 488  * The aspect of the source image is preserved.
 489  * If the source image is smaller than the desired size, the algorithm will modify the the newly created
 490  *   bitmaps dimensions to only be as large as necessary, as a memory saving optimization. This will cause
 491  *   GPU scaling to be performed at render time giving the same result with less texture traversal.
 492  *
 493  * @param[in] bitmap            The source bitmap to perform modifications on.
 494  * @param[in] desiredDimensions The target dimensions to aim to fill based on the fitting mode.
 495  * @param[in] fittingMode       The fitting mode to use.
 496  *
 497  * @return                      A new bitmap with the padding and cropping required for fitting mode applied.
 498  *                              If no modification is needed or possible, the passed in bitmap is returned.
 499  */
 500 Integration::BitmapPtr CropAndPadForFittingMode( Integration::BitmapPtr bitmap, ImageDimensions desiredDimensions, FittingMode::Type fittingMode );
 501
 502 /**
 503  * @brief Adds horizontal or vertical borders to the source image.
 504  *
 505  * @param[in] targetPixels     The destination image pointer to draw the borders on.
 506  * @param[in] bytesPerPixel    The number of bytes per pixel of the target pixel buffer.
 507  * @param[in] targetDimensions The dimensions of the destination image.
 508  * @param[in] padDimensions    The columns and scanlines to pad with borders.
 509  */
 510 void AddBorders( PixelBuffer *targetPixels, const unsigned int bytesPerPixel, const ImageDimensions targetDimensions, const ImageDimensions padDimensions );
 511
 512 BitmapPtr ApplyAttributesToBitmap( BitmapPtr bitmap, ImageDimensions dimensions, FittingMode::Type fittingMode, SamplingMode::Type samplingMode )
 513 {
 514   if( bitmap )
 515   {
 516     // Calculate the desired box, accounting for a possible zero component:
 517     const ImageDimensions desiredDimensions  = CalculateDesiredDimensions( bitmap->GetImageWidth(), bitmap->GetImageHeight(), dimensions.GetWidth(), dimensions.GetHeight() );
 518
 519     // If a different size than the raw one has been requested, resize the image
 520     // maximally using a repeated box filter without making it smaller than the
 521     // requested size in either dimension:
 522     bitmap = DownscaleBitmap( *bitmap, desiredDimensions, fittingMode, samplingMode );
 523
 524     // Cut the bitmap according to the desired width and height so that the
 525     // resulting bitmap has the same aspect ratio as the desired dimensions.
 526     // Add crop and add borders if necessary depending on fitting mode.
 527     if( bitmap && bitmap->GetPackedPixelsProfile() )
 528     {
 529       bitmap = CropAndPadForFittingMode( bitmap, desiredDimensions, fittingMode );
 530     }
 531
 532     // Examine the image pixels remaining after cropping and scaling to see if all
 533     // are opaque, allowing faster rendering, or some have non-1.0 alpha:
 534     if( bitmap && bitmap->GetPackedPixelsProfile() && Pixel::HasAlpha( bitmap->GetPixelFormat() ) )
 535     {
 536       bitmap->GetPackedPixelsProfile()->TestForTransparency();
 537     }
 538   }
 539
 540   return bitmap;
 541 }
 542
 543 BitmapPtr CropAndPadForFittingMode( BitmapPtr bitmap, ImageDimensions desiredDimensions, FittingMode::Type fittingMode )
 544 {
 545   const unsigned int inputWidth = bitmap->GetImageWidth();
 546   const unsigned int inputHeight = bitmap->GetImageHeight();
 547
 548   if( desiredDimensions.GetWidth() < 1u || desiredDimensions.GetHeight() < 1u )
 549   {
 550     DALI_LOG_WARNING( "Image scaling aborted as desired dimensions too small (%u, %u).\n", desiredDimensions.GetWidth(), desiredDimensions.GetHeight() );
 551   }
 552   else if( inputWidth != desiredDimensions.GetWidth() || inputHeight != desiredDimensions.GetHeight() )
 553   {
 554     // Calculate any padding or cropping that needs to be done based on the fitting mode.
 555     // Note: If the desired size is larger than the original image, the desired size will be
 556     // reduced while maintaining the aspect, in order to save unnecessary memory usage.
 557     int scanlinesToCrop = 0;
 558     int columnsToCrop = 0;
 559
 560     CalculateBordersFromFittingMode( ImageDimensions( inputWidth, inputHeight ), fittingMode, desiredDimensions, scanlinesToCrop, columnsToCrop );
 561
 562     unsigned int desiredWidth( desiredDimensions.GetWidth() );
 563     unsigned int desiredHeight( desiredDimensions.GetHeight() );
 564
 565     // Action the changes by making a new bitmap with the central part of the loaded one if required.
 566     if( scanlinesToCrop != 0 || columnsToCrop != 0 )
 567     {
 568       // Split the adding and removing of scanlines and columns into separate variables,
 569       // so we can use one piece of generic code to action the changes.
 570       unsigned int scanlinesToPad = 0;
 571       unsigned int columnsToPad = 0;
 572       if( scanlinesToCrop < 0 )
 573       {
 574         scanlinesToPad = -scanlinesToCrop;
 575         scanlinesToCrop = 0;
 576       }
 577       if( columnsToCrop < 0 )
 578       {
 579         columnsToPad = -columnsToCrop;
 580         columnsToCrop = 0;
 581       }
 582
 583       // If there is no filtering, then the final image size can become very large, exit if larger than maximum.
 584       if( ( desiredWidth > MAXIMUM_TARGET_BITMAP_SIZE ) || ( desiredHeight > MAXIMUM_TARGET_BITMAP_SIZE ) ||
 585           ( columnsToPad > MAXIMUM_TARGET_BITMAP_SIZE ) || ( scanlinesToPad > MAXIMUM_TARGET_BITMAP_SIZE ) )
 586       {
 587         DALI_LOG_WARNING( "Image scaling aborted as final dimensions too large (%u, %u).\n", desiredWidth, desiredHeight );
 588         return bitmap;
 589       }
 590
 591       // Create a new bitmap with the desired size.
 592       BitmapPtr croppedBitmap = Integration::Bitmap::New( Integration::Bitmap::BITMAP_2D_PACKED_PIXELS, ResourcePolicy::OWNED_DISCARD );
 593       Integration::Bitmap::PackedPixelsProfile *packedView = croppedBitmap->GetPackedPixelsProfile();
 594       DALI_ASSERT_DEBUG( packedView );
 595       const Pixel::Format pixelFormat = bitmap->GetPixelFormat();
 596       packedView->ReserveBuffer( pixelFormat, desiredWidth, desiredHeight, desiredWidth, desiredHeight );
 597
 598       // Add some pre-calculated offsets to the bitmap pointers so this is not done within a loop.
 599       // The cropping is added to the source pointer, and the padding is added to the destination.
 600       const unsigned int bytesPerPixel = Pixel::GetBytesPerPixel( pixelFormat );
 601       const PixelBuffer * const sourcePixels = bitmap->GetBuffer() + ( ( ( ( scanlinesToCrop / 2 ) * inputWidth ) + ( columnsToCrop / 2 ) ) * bytesPerPixel );
 602       PixelBuffer * const targetPixels = croppedBitmap->GetBuffer();
 603       PixelBuffer * const targetPixelsActive = targetPixels + ( ( ( ( scanlinesToPad / 2 ) * desiredWidth ) + ( columnsToPad / 2 ) ) * bytesPerPixel );
 604       DALI_ASSERT_DEBUG( sourcePixels && targetPixels );
 605
 606       // Copy the image data to the new bitmap.
 607       // Optimize to a single memcpy if the left and right edges don't need a crop or a pad.
 608       unsigned int outputSpan( desiredWidth * bytesPerPixel );
 609       if( columnsToCrop == 0 && columnsToPad == 0 )
 610       {
 611         memcpy( targetPixelsActive, sourcePixels, ( desiredHeight - scanlinesToPad ) * outputSpan );
 612       }
 613       else
 614       {
 615         // The width needs to change (due to either a crop or a pad), so we copy a scanline at a time.
 616         // Precalculate any constants to optimize the inner loop.
 617         const unsigned int inputSpan( inputWidth * bytesPerPixel );
 618         const unsigned int copySpan( ( desiredWidth - columnsToPad ) * bytesPerPixel );
 619         const unsigned int scanlinesToCopy( desiredHeight - scanlinesToPad );
 620
 621         for( unsigned int y = 0; y < scanlinesToCopy; ++y )
 622         {
 623           memcpy( &targetPixelsActive[ y * outputSpan ], &sourcePixels[ y * inputSpan ], copySpan );
 624         }
 625       }
 626
 627       // Add vertical or horizontal borders to the final image (if required).
 628       desiredDimensions.SetWidth( desiredWidth );
 629       desiredDimensions.SetHeight( desiredHeight );
 630       AddBorders( croppedBitmap->GetBuffer(), bytesPerPixel, desiredDimensions, ImageDimensions( columnsToPad, scanlinesToPad ) );
 631       // Overwrite the loaded bitmap with the cropped version
 632       bitmap = croppedBitmap;
 633     }
 634   }
 635
 636   return bitmap;
 637 }
 638
 639 void AddBorders( PixelBuffer *targetPixels, const unsigned int bytesPerPixel, const ImageDimensions targetDimensions, const ImageDimensions padDimensions )
 640 {
 641   // Assign ints for faster access.
 642   unsigned int desiredWidth( targetDimensions.GetWidth() );
 643   unsigned int desiredHeight( targetDimensions.GetHeight() );
 644   unsigned int columnsToPad( padDimensions.GetWidth() );
 645   unsigned int scanlinesToPad( padDimensions.GetHeight() );
 646   unsigned int outputSpan( desiredWidth * bytesPerPixel );
 647
 648   // Add letterboxing (symmetrical borders) if needed.
 649   if( scanlinesToPad > 0 )
 650   {
 651     // Add a top border. Note: This is (deliberately) rounded down if padding is an odd number.
 652     memset( targetPixels, BORDER_FILL_VALUE, ( scanlinesToPad / 2 ) * outputSpan );
 653
 654     // We subtract scanlinesToPad/2 from scanlinesToPad so that we have the correct
 655     // offset for odd numbers (as the top border is 1 pixel smaller in these cases.
 656     unsigned int bottomBorderHeight = scanlinesToPad - ( scanlinesToPad / 2 );
 657
 658     // Bottom border.
 659     memset( &targetPixels[ ( desiredHeight - bottomBorderHeight ) * outputSpan ], BORDER_FILL_VALUE, bottomBorderHeight * outputSpan );
 660   }
 661   else if( columnsToPad > 0 )
 662   {
 663     // Add a left and right border.
 664     // Left:
 665     // Pre-calculate span size outside of loop.
 666     unsigned int leftBorderSpanWidth( ( columnsToPad / 2 ) * bytesPerPixel );
 667     for( unsigned int y = 0; y < desiredHeight; ++y )
 668     {
 669       memset( &targetPixels[ y * outputSpan ], BORDER_FILL_VALUE, leftBorderSpanWidth );
 670     }
 671
 672     // Right:
 673     // Pre-calculate the initial x offset as it is always the same for a small optimization.
 674     // We subtract columnsToPad/2 from columnsToPad so that we have the correct
 675     // offset for odd numbers (as the left border is 1 pixel smaller in these cases.
 676     unsigned int rightBorderWidth = columnsToPad - ( columnsToPad / 2 );
 677     PixelBuffer * const destPixelsRightBorder( targetPixels + ( ( desiredWidth - rightBorderWidth ) * bytesPerPixel ) );
 678     unsigned int rightBorderSpanWidth = rightBorderWidth * bytesPerPixel;
 679
 680     for( unsigned int y = 0; y < desiredHeight; ++y )
 681     {
 682       memset( &destPixelsRightBorder[ y * outputSpan ], BORDER_FILL_VALUE, rightBorderSpanWidth );
 683     }
 684   }
 685 }
 686
 687 Integration::BitmapPtr DownscaleBitmap( Integration::Bitmap& bitmap,
 688                                         ImageDimensions desired,
 689                                         FittingMode::Type fittingMode,
 690                                         SamplingMode::Type samplingMode )
 691 {
 692   // Source dimensions as loaded from resources (e.g. filesystem):
 693   const unsigned int bitmapWidth  = bitmap.GetImageWidth();
 694   const unsigned int bitmapHeight = bitmap.GetImageHeight();
 695   // Desired dimensions (the rectangle to fit the source image to):
 696   const unsigned int desiredWidth = desired.GetWidth();
 697   const unsigned int desiredHeight = desired.GetHeight();
 698
 699   BitmapPtr outputBitmap( &bitmap );
 700
 701   // If a different size than the raw one has been requested, resize the image:
 702   if( bitmap.GetPackedPixelsProfile() &&
 703       (desiredWidth > 0.0f) && (desiredHeight > 0.0f) &&
 704       ((desiredWidth < bitmapWidth) || (desiredHeight < bitmapHeight)) )
 705   {
 706     const Pixel::Format pixelFormat = bitmap.GetPixelFormat();
 707
 708     // Do the fast power of 2 iterated box filter to get to roughly the right side if the filter mode requests that:
 709     unsigned int shrunkWidth = -1, shrunkHeight = -1;
 710     DownscaleInPlacePow2( bitmap.GetBuffer(), pixelFormat, bitmapWidth, bitmapHeight, desiredWidth, desiredHeight, fittingMode, samplingMode, shrunkWidth, shrunkHeight );
 711
 712     // Work out the dimensions of the downscaled bitmap, given the scaling mode and desired dimensions:
 713     const ImageDimensions filteredDimensions = FitToScalingMode( ImageDimensions( desiredWidth, desiredHeight ), ImageDimensions( shrunkWidth, shrunkHeight ), fittingMode );
 714     const unsigned int filteredWidth = filteredDimensions.GetWidth();
 715     const unsigned int filteredHeight = filteredDimensions.GetHeight();
 716
 717     // Run a filter to scale down the bitmap if it needs it:
 718     bool filtered = false;
 719     if( filteredWidth < shrunkWidth || filteredHeight < shrunkHeight )
 720     {
 721       if( samplingMode == SamplingMode::LINEAR || samplingMode == SamplingMode::BOX_THEN_LINEAR ||
 722           samplingMode == SamplingMode::NEAREST || samplingMode == SamplingMode::BOX_THEN_NEAREST )
 723       {
 724         outputBitmap = MakeEmptyBitmap( pixelFormat, filteredWidth, filteredHeight );
 725         if( outputBitmap )
 726         {
 727           if( samplingMode == SamplingMode::LINEAR || samplingMode == SamplingMode::BOX_THEN_LINEAR )
 728           {
 729             LinearSample( bitmap.GetBuffer(), ImageDimensions(shrunkWidth, shrunkHeight), pixelFormat, outputBitmap->GetBuffer(), filteredDimensions );
 730           }
 731           else
 732           {
 733             PointSample( bitmap.GetBuffer(), shrunkWidth, shrunkHeight, pixelFormat, outputBitmap->GetBuffer(), filteredWidth, filteredHeight );
 734           }
 735           filtered = true;
 736         }
 737       }
 738     }
 739     // Copy out the 2^x downscaled, box-filtered pixels if no secondary filter (point or linear) was applied:
 740     if( filtered == false && ( shrunkWidth < bitmapWidth || shrunkHeight < bitmapHeight ) )
 741     {
 742       outputBitmap = MakeBitmap( bitmap.GetBuffer(), pixelFormat, shrunkWidth, shrunkHeight );
 743     }
 744   }
 745
 746   return outputBitmap;
 747 }
 748
 749 namespace
 750 {
 751 /**
 752  * @brief Returns whether to keep box filtering based on whether downscaled dimensions will overshoot the desired ones aty the next step.
 753  * @param test Which combination of the two dimensions matter for terminating the filtering.
 754  * @param scaledWidth The width of the current downscaled image.
 755  * @param scaledHeight The height of the current downscaled image.
 756  * @param desiredWidth The target width for the downscaling.
 757  * @param desiredHeight The target height for the downscaling.
 758  */
 759 bool ContinueScaling( BoxDimensionTest test, unsigned int scaledWidth, unsigned int scaledHeight, unsigned int desiredWidth, unsigned int desiredHeight )
 760 {
 761   bool keepScaling = false;
 762   const unsigned int nextWidth = scaledWidth >> 1u;
 763   const unsigned int nextHeight = scaledHeight >> 1u;
 764
 765   if( nextWidth >= 1u && nextHeight >= 1u )
 766   {
 767     switch( test )
 768     {
 769       case BoxDimensionTestEither:
 770       {
 771         keepScaling = nextWidth >= desiredWidth || nextHeight >= desiredHeight;
 772         break;
 773       }
 774       case BoxDimensionTestBoth:
 775       {
 776         keepScaling = nextWidth >= desiredWidth && nextHeight >= desiredHeight;
 777         break;
 778       }
 779       case BoxDimensionTestX:
 780       {
 781         keepScaling = nextWidth >= desiredWidth;
 782         break;
 783       }
 784       case BoxDimensionTestY:
 785       {
 786         keepScaling = nextHeight >= desiredHeight;
 787         break;
 788       }
 789     }
 790   }
 791
 792   return keepScaling;
 793 }
 794
 795 /**
 796  * @brief A shared implementation of the overall iterative box filter
 797  * downscaling algorithm.
 798  *
 799  * Specialise this for particular pixel formats by supplying the number of bytes
 800  * per pixel and two functions: one for averaging pairs of neighbouring pixels
 801  * on a single scanline, and a second for averaging pixels at corresponding
 802  * positions on different scanlines.
 803  **/
 804 template<
 805   int BYTES_PER_PIXEL,
 806   void (*HalveScanlineInPlace)( unsigned char * const pixels, const unsigned int width ),
 807   void (*AverageScanlines) ( const unsigned char * const scanline1, const unsigned char * const __restrict__ scanline2, unsigned char* const outputScanline, const unsigned int width )
 808 >
 809 void DownscaleInPlacePow2Generic( unsigned char * const pixels,
 810                                   const unsigned int inputWidth,
 811                                   const unsigned int inputHeight,
 812                                   const unsigned int desiredWidth,
 813                                   const unsigned int desiredHeight,
 814                                   BoxDimensionTest dimensionTest,
 815                                   unsigned& outWidth,
 816                                   unsigned& outHeight )
 817 {
 818   if( pixels == 0 )
 819   {
 820     return;
 821   }
 822   ValidateScalingParameters( inputWidth, inputHeight, desiredWidth, desiredHeight );
 823
 824   // Scale the image until it would be smaller than desired, stopping if the
 825   // resulting height or width would be less than 1:
 826   unsigned int scaledWidth = inputWidth, scaledHeight = inputHeight;
 827   while( ContinueScaling( dimensionTest, scaledWidth, scaledHeight, desiredWidth, desiredHeight ) )
 828   {
 829     const unsigned int lastWidth = scaledWidth;
 830     scaledWidth  >>= 1u;
 831     scaledHeight >>= 1u;
 832
 833     DALI_LOG_INFO( gImageOpsLogFilter, Dali::Integration::Log::Verbose, "Scaling to %u\t%u.\n", scaledWidth, scaledHeight );
 834
 835     const unsigned int lastScanlinePair = scaledHeight - 1;
 836
 837     // Scale pairs of scanlines until any spare one at the end is dropped:
 838     for( unsigned int y = 0; y <= lastScanlinePair; ++y )
 839     {
 840       // Scale two scanlines horizontally:
 841       HalveScanlineInPlace( &pixels[y * 2 * lastWidth * BYTES_PER_PIXEL], lastWidth );
 842       HalveScanlineInPlace( &pixels[(y * 2 + 1) * lastWidth * BYTES_PER_PIXEL], lastWidth );
 843
 844       // Scale vertical pairs of pixels while the last two scanlines are still warm in
 845       // the CPU cache(s):
 846       // Note, better access patterns for cache-coherence are possible for very large
 847       // images but even a 4k wide RGB888 image will use just 24kB of cache (4k pixels
 848       // * 3 Bpp * 2 scanlines) for two scanlines on the first iteration.
 849       AverageScanlines(
 850           &pixels[y * 2 * lastWidth * BYTES_PER_PIXEL],
 851           &pixels[(y * 2 + 1) * lastWidth * BYTES_PER_PIXEL],
 852           &pixels[y * scaledWidth * BYTES_PER_PIXEL],
 853           scaledWidth );
 854     }
 855   }
 856
 857   ///@note: we could finish off with one of two mutually exclusive passes, one squashing horizontally as far as possible, and the other vertically, if we knew a following cpu point or bilinear filter would restore the desired aspect ratio.
 858   outWidth = scaledWidth;
 859   outHeight = scaledHeight;
 860 }
 861
 862 }
 863
 864 void HalveScanlineInPlaceRGB888( unsigned char * const pixels, const unsigned int width )
 865 {
 866   DebugAssertScanlineParameters( pixels, width );
 867
 868   const unsigned int lastPair = EvenDown( width - 2 );
 869
 870   for( unsigned int pixel = 0, outPixel = 0; pixel <= lastPair; pixel += 2, ++outPixel )
 871   {
 872     // Load all the byte pixel components we need:
 873     const unsigned int c11 = pixels[pixel * 3];
 874     const unsigned int c12 = pixels[pixel * 3 + 1];
 875     const unsigned int c13 = pixels[pixel * 3 + 2];
 876     const unsigned int c21 = pixels[pixel * 3 + 3];
 877     const unsigned int c22 = pixels[pixel * 3 + 4];
 878     const unsigned int c23 = pixels[pixel * 3 + 5];
 879
 880     // Save the averaged byte pixel components:
 881     pixels[outPixel * 3]     = AverageComponent( c11, c21 );
 882     pixels[outPixel * 3 + 1] = AverageComponent( c12, c22 );
 883     pixels[outPixel * 3 + 2] = AverageComponent( c13, c23 );
 884   }
 885 }
 886
 887 void HalveScanlineInPlaceRGBA8888( unsigned char * const pixels, const unsigned int width )
 888 {
 889   DebugAssertScanlineParameters( pixels, width );
 890   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(pixels) & 3u) == 0u) && "Pointer should be 4-byte aligned for performance on some platforms." );
 891
 892   uint32_t* const alignedPixels = reinterpret_cast<uint32_t*>(pixels);
 893
 894   const unsigned int lastPair = EvenDown( width - 2 );
 895
 896   for( unsigned int pixel = 0, outPixel = 0; pixel <= lastPair; pixel += 2, ++outPixel )
 897   {
 898     const uint32_t averaged = AveragePixelRGBA8888( alignedPixels[pixel], alignedPixels[pixel + 1] );
 899     alignedPixels[outPixel] = averaged;
 900   }
 901 }
 902
 903 void HalveScanlineInPlaceRGB565( unsigned char * pixels, unsigned int width )
 904 {
 905   DebugAssertScanlineParameters( pixels, width );
 906   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(pixels) & 1u) == 0u) && "Pointer should be 2-byte aligned for performance on some platforms." );
 907
 908   uint16_t* const alignedPixels = reinterpret_cast<uint16_t*>(pixels);
 909
 910   const unsigned int lastPair = EvenDown( width - 2 );
 911
 912   for( unsigned int pixel = 0, outPixel = 0; pixel <= lastPair; pixel += 2, ++outPixel )
 913   {
 914     const uint32_t averaged = AveragePixelRGB565( alignedPixels[pixel], alignedPixels[pixel + 1] );
 915     alignedPixels[outPixel] = averaged;
 916   }
 917 }
 918
 919 void HalveScanlineInPlace2Bytes( unsigned char * const pixels, const unsigned int width )
 920 {
 921   DebugAssertScanlineParameters( pixels, width );
 922
 923   const unsigned int lastPair = EvenDown( width - 2 );
 924
 925   for( unsigned int pixel = 0, outPixel = 0; pixel <= lastPair; pixel += 2, ++outPixel )
 926   {
 927     // Load all the byte pixel components we need:
 928     const unsigned int c11 = pixels[pixel * 2];
 929     const unsigned int c12 = pixels[pixel * 2 + 1];
 930     const unsigned int c21 = pixels[pixel * 2 + 2];
 931     const unsigned int c22 = pixels[pixel * 2 + 3];
 932
 933     // Save the averaged byte pixel components:
 934     pixels[outPixel * 2]     = AverageComponent( c11, c21 );
 935     pixels[outPixel * 2 + 1] = AverageComponent( c12, c22 );
 936   }
 937 }
 938
 939 void HalveScanlineInPlace1Byte( unsigned char * const pixels, const unsigned int width )
 940 {
 941   DebugAssertScanlineParameters( pixels, width );
 942
 943   const unsigned int lastPair = EvenDown( width - 2 );
 944
 945   for( unsigned int pixel = 0, outPixel = 0; pixel <= lastPair; pixel += 2, ++outPixel )
 946   {
 947     // Load all the byte pixel components we need:
 948     const unsigned int c1 = pixels[pixel];
 949     const unsigned int c2 = pixels[pixel + 1];
 950
 951     // Save the averaged byte pixel component:
 952     pixels[outPixel] = AverageComponent( c1, c2 );
 953   }
 954 }
 955
 956 /**
 957  * @ToDo: Optimise for ARM using a 4 bytes at a time loop wrapped around the single ARMV6 instruction: UHADD8  R4, R0, R5. Note, this is not neon. It runs in the normal integer pipeline so there is no downside like a stall moving between integer and copro, or extra power for clocking-up the idle copro.
 958  * if (widthInComponents >= 7) { word32* aligned1 = scanline1 + 3 & 3; word32* aligned1_end = scanline1 + widthInPixels & 3; while(aligned1 < aligned1_end) { UHADD8  *aligned1++, *aligned2++, *alignedoutput++ } .. + 0 to 3 spare pixels at each end.
 959  */
 960 void AverageScanlines1( const unsigned char * const scanline1,
 961                         const unsigned char * const __restrict__ scanline2,
 962                         unsigned char* const outputScanline,
 963                         const unsigned int width )
 964 {
 965   DebugAssertDualScanlineParameters( scanline1, scanline2, outputScanline, width );
 966
 967   for( unsigned int component = 0; component < width; ++component )
 968   {
 969     outputScanline[component] = AverageComponent( scanline1[component], scanline2[component] );
 970   }
 971 }
 972
 973 void AverageScanlines2( const unsigned char * const scanline1,
 974                         const unsigned char * const __restrict__ scanline2,
 975                         unsigned char* const outputScanline,
 976                         const unsigned int width )
 977 {
 978   DebugAssertDualScanlineParameters( scanline1, scanline2, outputScanline, width * 2 );
 979
 980   for( unsigned int component = 0; component < width * 2; ++component )
 981   {
 982     outputScanline[component] = AverageComponent( scanline1[component], scanline2[component] );
 983   }
 984 }
 985
 986 void AverageScanlines3( const unsigned char * const scanline1,
 987                         const unsigned char * const __restrict__ scanline2,
 988                         unsigned char* const outputScanline,
 989                         const unsigned int width )
 990 {
 991   DebugAssertDualScanlineParameters( scanline1, scanline2, outputScanline, width * 3 );
 992
 993   for( unsigned int component = 0; component < width * 3; ++component )
 994   {
 995     outputScanline[component] = AverageComponent( scanline1[component], scanline2[component] );
 996   }
 997 }
 998
 999 void AverageScanlinesRGBA8888( const unsigned char * const scanline1,
1000                                const unsigned char * const __restrict__ scanline2,
1001                                unsigned char * const outputScanline,
1002                                const unsigned int width )
1003 {
1004   DebugAssertDualScanlineParameters( scanline1, scanline2, outputScanline, width * 4 );
1005   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(scanline1) & 3u) == 0u) && "Pointer should be 4-byte aligned for performance on some platforms." );
1006   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(scanline2) & 3u) == 0u) && "Pointer should be 4-byte aligned for performance on some platforms." );
1007   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(outputScanline) & 3u) == 0u) && "Pointer should be 4-byte aligned for performance on some platforms." );
1008
1009   const uint32_t* const alignedScanline1 = reinterpret_cast<const uint32_t*>(scanline1);
1010   const uint32_t* const alignedScanline2 = reinterpret_cast<const uint32_t*>(scanline2);
1011   uint32_t* const alignedOutput = reinterpret_cast<uint32_t*>(outputScanline);
1012
1013   for( unsigned int pixel = 0; pixel < width; ++pixel )
1014   {
1015     alignedOutput[pixel] = AveragePixelRGBA8888( alignedScanline1[pixel], alignedScanline2[pixel] );
1016   }
1017 }
1018
1019 void AverageScanlinesRGB565( const unsigned char * const scanline1,
1020                              const unsigned char * const __restrict__ scanline2,
1021                              unsigned char * const outputScanline,
1022                              const unsigned int width )
1023 {
1024   DebugAssertDualScanlineParameters( scanline1, scanline2, outputScanline, width * 2 );
1025   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(scanline1) & 1u) == 0u) && "Pointer should be 2-byte aligned for performance on some platforms." );
1026   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(scanline2) & 1u) == 0u) && "Pointer should be 2-byte aligned for performance on some platforms." );
1027   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(outputScanline) & 1u) == 0u) && "Pointer should be 2-byte aligned for performance on some platforms." );
1028
1029   const uint16_t* const alignedScanline1 = reinterpret_cast<const uint16_t*>(scanline1);
1030   const uint16_t* const alignedScanline2 = reinterpret_cast<const uint16_t*>(scanline2);
1031   uint16_t* const alignedOutput = reinterpret_cast<uint16_t*>(outputScanline);
1032
1033   for( unsigned int pixel = 0; pixel < width; ++pixel )
1034   {
1035     alignedOutput[pixel] = AveragePixelRGB565( alignedScanline1[pixel], alignedScanline2[pixel] );
1036   }
1037 }
1038
1039 /// Dispatch to pixel format appropriate box filter downscaling functions.
1040 void DownscaleInPlacePow2( unsigned char * const pixels,
1041                            Pixel::Format pixelFormat,
1042                            unsigned int inputWidth,
1043                            unsigned int inputHeight,
1044                            unsigned int desiredWidth,
1045                            unsigned int desiredHeight,
1046                            FittingMode::Type fittingMode,
1047                            SamplingMode::Type samplingMode,
1048                            unsigned& outWidth,
1049                            unsigned& outHeight )
1050 {
1051   outWidth = inputWidth;
1052   outHeight = inputHeight;
1053   // Perform power of 2 iterated 4:1 box filtering if the requested filter mode requires it:
1054   if( samplingMode == SamplingMode::BOX || samplingMode == SamplingMode::BOX_THEN_NEAREST || samplingMode == SamplingMode::BOX_THEN_LINEAR )
1055   {
1056     // Check the pixel format is one that is supported:
1057     if( pixelFormat == Pixel::RGBA8888 || pixelFormat == Pixel::RGB888 || pixelFormat == Pixel::RGB565 || pixelFormat == Pixel::LA88 || pixelFormat == Pixel::L8 || pixelFormat == Pixel::A8 )
1058     {
1059       const BoxDimensionTest dimensionTest = DimensionTestForScalingMode( fittingMode );
1060
1061       if( pixelFormat == Pixel::RGBA8888 )
1062       {
1063         Internal::Platform::DownscaleInPlacePow2RGBA8888( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1064       }
1065       else if( pixelFormat == Pixel::RGB888 )
1066       {
1067         Internal::Platform::DownscaleInPlacePow2RGB888( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1068       }
1069       else if( pixelFormat == Pixel::RGB565 )
1070       {
1071         Internal::Platform::DownscaleInPlacePow2RGB565( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1072       }
1073       else if( pixelFormat == Pixel::LA88 )
1074       {
1075         Internal::Platform::DownscaleInPlacePow2ComponentPair( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1076       }
1077       else if( pixelFormat == Pixel::L8  || pixelFormat == Pixel::A8 )
1078       {
1079         Internal::Platform::DownscaleInPlacePow2SingleBytePerPixel( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1080       }
1081       else
1082       {
1083         DALI_ASSERT_DEBUG( false == "Inner branch conditions don't match outer branch." );
1084       }
1085     }
1086   }
1087   else
1088   {
1089     DALI_LOG_INFO( gImageOpsLogFilter, Dali::Integration::Log::Verbose, "Bitmap was not shrunk: unsupported pixel format: %u.\n", unsigned(pixelFormat) );
1090   }
1091 }
1092
1093 void DownscaleInPlacePow2RGB888( unsigned char *pixels,
1094                                  unsigned int inputWidth,
1095                                  unsigned int inputHeight,
1096                                  unsigned int desiredWidth,
1097                                  unsigned int desiredHeight,
1098                                  BoxDimensionTest dimensionTest,
1099                                  unsigned& outWidth,
1100                                  unsigned& outHeight )
1101 {
1102   DownscaleInPlacePow2Generic<3, HalveScanlineInPlaceRGB888, AverageScanlines3>( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1103 }
1104
1105 void DownscaleInPlacePow2RGBA8888( unsigned char * pixels,
1106                                    unsigned int inputWidth,
1107                                    unsigned int inputHeight,
1108                                    unsigned int desiredWidth,
1109                                    unsigned int desiredHeight,
1110                                    BoxDimensionTest dimensionTest,
1111                                    unsigned& outWidth,
1112                                    unsigned& outHeight )
1113 {
1114   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(pixels) & 3u) == 0u) && "Pointer should be 4-byte aligned for performance on some platforms." );
1115   DownscaleInPlacePow2Generic<4, HalveScanlineInPlaceRGBA8888, AverageScanlinesRGBA8888>( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1116 }
1117
1118 void DownscaleInPlacePow2RGB565( unsigned char * pixels,
1119                                  unsigned int inputWidth,
1120                                  unsigned int inputHeight,
1121                                  unsigned int desiredWidth,
1122                                  unsigned int desiredHeight,
1123                                  BoxDimensionTest dimensionTest,
1124                                  unsigned int& outWidth,
1125                                  unsigned int& outHeight )
1126 {
1127   DownscaleInPlacePow2Generic<2, HalveScanlineInPlaceRGB565, AverageScanlinesRGB565>( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1128 }
1129
1130 /**
1131  * @copydoc DownscaleInPlacePow2RGB888
1132  *
1133  * For 2-byte formats such as lum8alpha8, but not packed 16 bit formats like RGB565.
1134  */
1135 void DownscaleInPlacePow2ComponentPair( unsigned char *pixels,
1136                                         unsigned int inputWidth,
1137                                         unsigned int inputHeight,
1138                                         unsigned int desiredWidth,
1139                                         unsigned int desiredHeight,
1140                                         BoxDimensionTest dimensionTest,
1141                                         unsigned& outWidth,
1142                                         unsigned& outHeight )
1143 {
1144   DownscaleInPlacePow2Generic<2, HalveScanlineInPlace2Bytes, AverageScanlines2>( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1145 }
1146
1147 void DownscaleInPlacePow2SingleBytePerPixel( unsigned char * pixels,
1148                                              unsigned int inputWidth,
1149                                              unsigned int inputHeight,
1150                                              unsigned int desiredWidth,
1151                                              unsigned int desiredHeight,
1152                                              BoxDimensionTest dimensionTest,
1153                                              unsigned int& outWidth,
1154                                              unsigned int& outHeight )
1155 {
1156   DownscaleInPlacePow2Generic<1, HalveScanlineInPlace1Byte, AverageScanlines1>( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1157 }
1158
1159 namespace
1160 {
1161
1162 /**
1163  * @brief Point sample an image to a new resolution (like GL_NEAREST).
1164  *
1165  * Template is used purely as a type-safe code generator in this one
1166  * compilation unit. Generated code is inlined into type-specific wrapper
1167  * functions below which are exported to rest of module.
1168  */
1169 template<typename PIXEL>
1170 inline void PointSampleAddressablePixels( const uint8_t * inPixels,
1171                                    unsigned int inputWidth,
1172                                    unsigned int inputHeight,
1173                                    uint8_t * outPixels,
1174                                    unsigned int desiredWidth,
1175                                    unsigned int desiredHeight )
1176 {
1177   DALI_ASSERT_DEBUG( ((desiredWidth <= inputWidth && desiredHeight <= inputHeight) ||
1178       outPixels >= inPixels + inputWidth * inputHeight * sizeof(PIXEL) || outPixels <= inPixels - desiredWidth * desiredHeight * sizeof(PIXEL)) &&
1179       "The input and output buffers must not overlap for an upscaling.");
1180   DALI_ASSERT_DEBUG( reinterpret_cast< uint64_t >( inPixels )  % sizeof(PIXEL) == 0 && "Pixel pointers need to be aligned to the size of the pixels (E.g., 4 bytes for RGBA, 2 bytes for RGB565, ...)." );
1181   DALI_ASSERT_DEBUG( reinterpret_cast< uint64_t >( outPixels ) % sizeof(PIXEL) == 0 && "Pixel pointers need to be aligned to the size of the pixels (E.g., 4 bytes for RGBA, 2 bytes for RGB565, ...)." );
1182
1183   if( inputWidth < 1u || inputHeight < 1u || desiredWidth < 1u || desiredHeight < 1u )
1184   {
1185     return;
1186   }
1187   const PIXEL* const inAligned = reinterpret_cast<const PIXEL*>(inPixels);
1188   PIXEL* const       outAligned = reinterpret_cast<PIXEL*>(outPixels);
1189   const unsigned int deltaX = (inputWidth  << 16u) / desiredWidth;
1190   const unsigned int deltaY = (inputHeight << 16u) / desiredHeight;
1191
1192   unsigned int inY = 0;
1193   for( unsigned int outY = 0; outY < desiredHeight; ++outY )
1194   {
1195     // Round fixed point y coordinate to nearest integer:
1196     const unsigned int integerY = (inY + (1u << 15u)) >> 16u;
1197     const PIXEL* const inScanline = &inAligned[inputWidth * integerY];
1198     PIXEL* const outScanline = &outAligned[desiredWidth * outY];
1199
1200     DALI_ASSERT_DEBUG( integerY < inputHeight );
1201     DALI_ASSERT_DEBUG( reinterpret_cast<const uint8_t*>(inScanline) < ( inPixels + inputWidth * inputHeight * sizeof(PIXEL) ) );
1202     DALI_ASSERT_DEBUG( reinterpret_cast<uint8_t*>(outScanline) < ( outPixels + desiredWidth * desiredHeight * sizeof(PIXEL) ) );
1203
1204     unsigned int inX = 0;
1205     for( unsigned int outX = 0; outX < desiredWidth; ++outX )
1206     {
1207       // Round the fixed-point x coordinate to an integer:
1208       const unsigned int integerX = (inX + (1u << 15u)) >> 16u;
1209       const PIXEL* const inPixelAddress = &inScanline[integerX];
1210       const PIXEL pixel = *inPixelAddress;
1211       outScanline[outX] = pixel;
1212       inX += deltaX;
1213     }
1214     inY += deltaY;
1215   }
1216 }
1217
1218 }
1219
1220 // RGBA8888
1221 void PointSample4BPP( const unsigned char * inPixels,
1222                       unsigned int inputWidth,
1223                       unsigned int inputHeight,
1224                       unsigned char * outPixels,
1225                       unsigned int desiredWidth,
1226                       unsigned int desiredHeight )
1227 {
1228   PointSampleAddressablePixels<uint32_t>( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1229 }
1230
1231 // RGB565, LA88
1232 void PointSample2BPP( const unsigned char * inPixels,
1233                       unsigned int inputWidth,
1234                       unsigned int inputHeight,
1235                       unsigned char * outPixels,
1236                       unsigned int desiredWidth,
1237                       unsigned int desiredHeight )
1238 {
1239   PointSampleAddressablePixels<uint16_t>( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1240 }
1241
1242 // L8, A8
1243 void PointSample1BPP( const unsigned char * inPixels,
1244                       unsigned int inputWidth,
1245                       unsigned int inputHeight,
1246                       unsigned char * outPixels,
1247                       unsigned int desiredWidth,
1248                       unsigned int desiredHeight )
1249 {
1250   PointSampleAddressablePixels<uint8_t>( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1251 }
1252
1253 /* RGB888
1254  * RGB888 is a special case as its pixels are not aligned addressable units.
1255  */
1256 void PointSample3BPP( const uint8_t * inPixels,
1257                       unsigned int inputWidth,
1258                       unsigned int inputHeight,
1259                       uint8_t * outPixels,
1260                       unsigned int desiredWidth,
1261                       unsigned int desiredHeight )
1262 {
1263   if( inputWidth < 1u || inputHeight < 1u || desiredWidth < 1u || desiredHeight < 1u )
1264   {
1265     return;
1266   }
1267   const unsigned int BYTES_PER_PIXEL = 3;
1268
1269   // Generate fixed-point 16.16 deltas in input image coordinates:
1270   const unsigned int deltaX = (inputWidth  << 16u) / desiredWidth;
1271   const unsigned int deltaY = (inputHeight << 16u) / desiredHeight;
1272
1273   // Step through output image in whole integer pixel steps while tracking the
1274   // corresponding locations in the input image using 16.16 fixed-point
1275   // coordinates:
1276   unsigned int inY = 0; //< 16.16 fixed-point input image y-coord.
1277   for( unsigned int outY = 0; outY < desiredHeight; ++outY )
1278   {
1279     const unsigned int integerY = (inY + (1u << 15u)) >> 16u;
1280     const uint8_t* const inScanline = &inPixels[inputWidth * integerY * BYTES_PER_PIXEL];
1281     uint8_t* const outScanline = &outPixels[desiredWidth * outY * BYTES_PER_PIXEL];
1282     unsigned int inX = 0; //< 16.16 fixed-point input image x-coord.
1283
1284     for( unsigned int outX = 0; outX < desiredWidth * BYTES_PER_PIXEL; outX += BYTES_PER_PIXEL )
1285     {
1286       // Round the fixed-point input coordinate to the address of the input pixel to sample:
1287       const unsigned int integerX = (inX + (1u << 15u)) >> 16u;
1288       const uint8_t* const inPixelAddress = &inScanline[integerX * BYTES_PER_PIXEL];
1289
1290       // Issue loads for all pixel color components up-front:
1291       const unsigned int c0 = inPixelAddress[0];
1292       const unsigned int c1 = inPixelAddress[1];
1293       const unsigned int c2 = inPixelAddress[2];
1294       ///@ToDo: Optimise - Benchmark one 32bit load that will be unaligned 2/3 of the time + 3 rotate and masks, versus these three aligned byte loads, versus using an RGB packed, aligned(1) struct and letting compiler pick a strategy.
1295
1296       // Output the pixel components:
1297       outScanline[outX]     = c0;
1298       outScanline[outX + 1] = c1;
1299       outScanline[outX + 2] = c2;
1300
1301       // Increment the fixed-point input coordinate:
1302       inX += deltaX;
1303     }
1304
1305     inY += deltaY;
1306   }
1307 }
1308
1309 // Dispatch to a format-appropriate point sampling function:
1310 void PointSample( const unsigned char * inPixels,
1311                   unsigned int inputWidth,
1312                   unsigned int inputHeight,
1313                   Pixel::Format pixelFormat,
1314                   unsigned char * outPixels,
1315                   unsigned int desiredWidth,
1316                   unsigned int desiredHeight )
1317 {
1318   // Check the pixel format is one that is supported:
1319   if( pixelFormat == Pixel::RGBA8888 || pixelFormat == Pixel::RGB888 || pixelFormat == Pixel::RGB565 || pixelFormat == Pixel::LA88 || pixelFormat == Pixel::L8 || pixelFormat == Pixel::A8 )
1320   {
1321     if( pixelFormat == Pixel::RGB888 )
1322     {
1323       PointSample3BPP( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1324     }
1325     else if( pixelFormat == Pixel::RGBA8888 )
1326     {
1327       PointSample4BPP( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1328     }
1329     else if( pixelFormat == Pixel::RGB565 || pixelFormat == Pixel::LA88 )
1330     {
1331       PointSample2BPP( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1332     }
1333     else if( pixelFormat == Pixel::L8  || pixelFormat == Pixel::A8 )
1334     {
1335       PointSample1BPP( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1336     }
1337     else
1338     {
1339       DALI_ASSERT_DEBUG( false == "Inner branch conditions don't match outer branch." );
1340     }
1341   }
1342   else
1343   {
1344     DALI_LOG_INFO( gImageOpsLogFilter, Dali::Integration::Log::Verbose, "Bitmap was not point sampled: unsupported pixel format: %u.\n", unsigned(pixelFormat) );
1345   }
1346 }
1347
1348 // Linear sampling group below
1349
1350 namespace
1351 {
1352
1353 /** @brief Blend 4 pixels together using horizontal and vertical weights. */
1354 inline uint8_t BilinearFilter1BPPByte( uint8_t tl, uint8_t tr, uint8_t bl, uint8_t br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical )
1355 {
1356   return BilinearFilter1Component( tl, tr, bl, br, fractBlendHorizontal, fractBlendVertical );
1357 }
1358
1359 /** @copydoc BilinearFilter1BPPByte */
1360 inline Pixel2Bytes BilinearFilter2Bytes( Pixel2Bytes tl, Pixel2Bytes tr, Pixel2Bytes bl, Pixel2Bytes br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical )
1361 {
1362   Pixel2Bytes pixel;
1363   pixel.l = BilinearFilter1Component( tl.l, tr.l, bl.l, br.l, fractBlendHorizontal, fractBlendVertical );
1364   pixel.a = BilinearFilter1Component( tl.a, tr.a, bl.a, br.a, fractBlendHorizontal, fractBlendVertical );
1365   return pixel;
1366 }
1367
1368 /** @copydoc BilinearFilter1BPPByte */
1369 inline Pixel3Bytes BilinearFilterRGB888( Pixel3Bytes tl, Pixel3Bytes tr, Pixel3Bytes bl, Pixel3Bytes br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical )
1370 {
1371   Pixel3Bytes pixel;
1372   pixel.r = BilinearFilter1Component( tl.r, tr.r, bl.r, br.r, fractBlendHorizontal, fractBlendVertical );
1373   pixel.g = BilinearFilter1Component( tl.g, tr.g, bl.g, br.g, fractBlendHorizontal, fractBlendVertical );
1374   pixel.b = BilinearFilter1Component( tl.b, tr.b, bl.b, br.b, fractBlendHorizontal, fractBlendVertical );
1375   return pixel;
1376 }
1377
1378 /** @copydoc BilinearFilter1BPPByte */
1379 inline PixelRGB565 BilinearFilterRGB565( PixelRGB565 tl, PixelRGB565 tr, PixelRGB565 bl, PixelRGB565 br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical )
1380 {
1381   const PixelRGB565 pixel = (BilinearFilter1Component( tl >> 11u, tr >> 11u, bl >> 11u, br >> 11u, fractBlendHorizontal, fractBlendVertical ) << 11u) +
1382                             (BilinearFilter1Component( (tl >> 5u) & 63u, (tr >> 5u) & 63u, (bl >> 5u) & 63u, (br >> 5u) & 63u, fractBlendHorizontal, fractBlendVertical ) << 5u) +
1383                              BilinearFilter1Component( tl & 31u, tr & 31u, bl & 31u, br & 31u, fractBlendHorizontal, fractBlendVertical );
1384   return pixel;
1385 }
1386
1387 /** @copydoc BilinearFilter1BPPByte */
1388 inline Pixel4Bytes BilinearFilter4Bytes( Pixel4Bytes tl, Pixel4Bytes tr, Pixel4Bytes bl, Pixel4Bytes br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical )
1389 {
1390   Pixel4Bytes pixel;
1391   pixel.r = BilinearFilter1Component( tl.r, tr.r, bl.r, br.r, fractBlendHorizontal, fractBlendVertical );
1392   pixel.g = BilinearFilter1Component( tl.g, tr.g, bl.g, br.g, fractBlendHorizontal, fractBlendVertical );
1393   pixel.b = BilinearFilter1Component( tl.b, tr.b, bl.b, br.b, fractBlendHorizontal, fractBlendVertical );
1394   pixel.a = BilinearFilter1Component( tl.a, tr.a, bl.a, br.a, fractBlendHorizontal, fractBlendVertical );
1395   return pixel;
1396 }
1397
1398 /**
1399  * @brief Generic version of bilinear sampling image resize function.
1400  * @note Limited to one compilation unit and exposed through type-specific
1401  * wrapper functions below.
1402  */
1403 template<
1404   typename PIXEL,
1405   PIXEL (*BilinearFilter) ( PIXEL tl, PIXEL tr, PIXEL bl, PIXEL br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical ),
1406   bool DEBUG_ASSERT_ALIGNMENT
1407 >
1408 inline void LinearSampleGeneric( const unsigned char * __restrict__ inPixels,
1409                        ImageDimensions inputDimensions,
1410                        unsigned char * __restrict__ outPixels,
1411                        ImageDimensions desiredDimensions )
1412 {
1413   const unsigned int inputWidth = inputDimensions.GetWidth();
1414   const unsigned int inputHeight = inputDimensions.GetHeight();
1415   const unsigned int desiredWidth = desiredDimensions.GetWidth();
1416   const unsigned int desiredHeight = desiredDimensions.GetHeight();
1417
1418   DALI_ASSERT_DEBUG( ((outPixels >= inPixels + inputWidth   * inputHeight   * sizeof(PIXEL)) ||
1419                       (inPixels >= outPixels + desiredWidth * desiredHeight * sizeof(PIXEL))) &&
1420                      "Input and output buffers cannot overlap.");
1421   if( DEBUG_ASSERT_ALIGNMENT )
1422   {
1423     DALI_ASSERT_DEBUG( reinterpret_cast< uint64_t >( inPixels )  % sizeof(PIXEL) == 0 && "Pixel pointers need to be aligned to the size of the pixels (E.g., 4 bytes for RGBA, 2 bytes for RGB565, ...)." );
1424     DALI_ASSERT_DEBUG( reinterpret_cast< uint64_t >( outPixels) % sizeof(PIXEL) == 0 && "Pixel pointers need to be aligned to the size of the pixels (E.g., 4 bytes for RGBA, 2 bytes for RGB565, ...)." );
1425   }
1426
1427   if( inputWidth < 1u || inputHeight < 1u || desiredWidth < 1u || desiredHeight < 1u )
1428   {
1429     return;
1430   }
1431   const PIXEL* const inAligned = reinterpret_cast<const PIXEL*>(inPixels);
1432   PIXEL* const       outAligned = reinterpret_cast<PIXEL*>(outPixels);
1433   const unsigned int deltaX = (inputWidth  << 16u) / desiredWidth;
1434   const unsigned int deltaY = (inputHeight << 16u) / desiredHeight;
1435
1436   unsigned int inY = 0;
1437   for( unsigned int outY = 0; outY < desiredHeight; ++outY )
1438   {
1439     PIXEL* const outScanline = &outAligned[desiredWidth * outY];
1440
1441     // Find the two scanlines to blend and the weight to blend with:
1442     const unsigned int integerY1 = inY >> 16u;
1443     const unsigned int integerY2 = integerY1 >= inputHeight ? integerY1 : integerY1 + 1;
1444     const unsigned int inputYWeight = inY & 65535u;
1445
1446     DALI_ASSERT_DEBUG( integerY1 < inputHeight );
1447     DALI_ASSERT_DEBUG( integerY2 < inputHeight );
1448
1449     const PIXEL* const inScanline1 = &inAligned[inputWidth * integerY1];
1450     const PIXEL* const inScanline2 = &inAligned[inputWidth * integerY2];
1451
1452     unsigned int inX = 0;
1453     for( unsigned int outX = 0; outX < desiredWidth; ++outX )
1454     {
1455       // Work out the two pixel scanline offsets for this cluster of four samples:
1456       const unsigned int integerX1 = inX >> 16u;
1457       const unsigned int integerX2 = integerX1 >= inputWidth ? integerX1 : integerX1 + 1;
1458
1459       // Execute the loads:
1460       const PIXEL pixel1 = inScanline1[integerX1];
1461       const PIXEL pixel2 = inScanline2[integerX1];
1462       const PIXEL pixel3 = inScanline1[integerX2];
1463       const PIXEL pixel4 = inScanline2[integerX2];
1464       ///@ToDo Optimise - for 1 and 2  and 4 byte types to execute a single 2, 4, or 8 byte load per pair (caveat clamping) and let half of them be unaligned.
1465
1466       // Weighted bilinear filter:
1467       const unsigned int inputXWeight = inX & 65535u;
1468       outScanline[outX] = BilinearFilter( pixel1, pixel3, pixel2, pixel4, inputXWeight, inputYWeight );
1469
1470       inX += deltaX;
1471     }
1472     inY += deltaY;
1473   }
1474 }
1475
1476 }
1477
1478 // Format-specific linear scaling instantiations:
1479
1480 void LinearSample1BPP( const unsigned char * __restrict__ inPixels,
1481                        ImageDimensions inputDimensions,
1482                        unsigned char * __restrict__ outPixels,
1483                        ImageDimensions desiredDimensions )
1484 {
1485   LinearSampleGeneric<uint8_t, BilinearFilter1BPPByte, false>( inPixels, inputDimensions, outPixels, desiredDimensions );
1486 }
1487
1488 void LinearSample2BPP( const unsigned char * __restrict__ inPixels,
1489                        ImageDimensions inputDimensions,
1490                        unsigned char * __restrict__ outPixels,
1491                        ImageDimensions desiredDimensions )
1492 {
1493   LinearSampleGeneric<Pixel2Bytes, BilinearFilter2Bytes, true>( inPixels, inputDimensions, outPixels, desiredDimensions );
1494 }
1495
1496 void LinearSampleRGB565( const unsigned char * __restrict__ inPixels,
1497                        ImageDimensions inputDimensions,
1498                        unsigned char * __restrict__ outPixels,
1499                        ImageDimensions desiredDimensions )
1500 {
1501   LinearSampleGeneric<PixelRGB565, BilinearFilterRGB565, true>( inPixels, inputDimensions, outPixels, desiredDimensions );
1502 }
1503
1504 void LinearSample3BPP( const unsigned char * __restrict__ inPixels,
1505                        ImageDimensions inputDimensions,
1506                        unsigned char * __restrict__ outPixels,
1507                        ImageDimensions desiredDimensions )
1508 {
1509   LinearSampleGeneric<Pixel3Bytes, BilinearFilterRGB888, false>( inPixels, inputDimensions, outPixels, desiredDimensions );
1510 }
1511
1512 void LinearSample4BPP( const unsigned char * __restrict__ inPixels,
1513                        ImageDimensions inputDimensions,
1514                        unsigned char * __restrict__ outPixels,
1515                        ImageDimensions desiredDimensions )
1516 {
1517   LinearSampleGeneric<Pixel4Bytes, BilinearFilter4Bytes, true>( inPixels, inputDimensions, outPixels, desiredDimensions );
1518 }
1519
1520 void LanczosSample4BPP( const unsigned char * __restrict__ inPixels,
1521                         ImageDimensions inputDimensions,
1522                         unsigned char * __restrict__ outPixels,
1523                         ImageDimensions desiredDimensions )
1524 {
1525   // Got from the test.cpp of the ImageResampler lib.
1526   const float ONE_DIV_255 = 1.0f / 255.0f;
1527   const int MAX_UNSIGNED_CHAR = std::numeric_limits<uint8_t>::max();
1528   const int LINEAR_TO_SRGB_TABLE_SIZE = 4096;
1529   const int ALPHA_CHANNEL = 3;
1530   const int NUMBER_OF_CHANNELS = 4;
1531
1532   float srgbToLinear[MAX_UNSIGNED_CHAR + 1];
1533   for( int i = 0; i <= MAX_UNSIGNED_CHAR; ++i )
1534   {
1535     srgbToLinear[i] = pow( static_cast<float>( i ) * ONE_DIV_255, DEFAULT_SOURCE_GAMMA );
1536   }
1537
1538   unsigned char linearToSrgb[LINEAR_TO_SRGB_TABLE_SIZE];
1539
1540   const float invLinearToSrgbTableSize = 1.0f / static_cast<float>( LINEAR_TO_SRGB_TABLE_SIZE );
1541   const float invSourceGamma = 1.0f / DEFAULT_SOURCE_GAMMA;
1542
1543   for( int i = 0; i < LINEAR_TO_SRGB_TABLE_SIZE; ++i )
1544   {
1545     int k = static_cast<int>( 255.0f * pow( static_cast<float>( i ) * invLinearToSrgbTableSize, invSourceGamma ) + 0.5f );
1546     if( k < 0 )
1547     {
1548       k = 0;
1549     }
1550     else if( k > MAX_UNSIGNED_CHAR )
1551     {
1552       k = MAX_UNSIGNED_CHAR;
1553     }
1554     linearToSrgb[i] = static_cast<unsigned char>( k );
1555   }
1556
1557   Resampler* resamplers[NUMBER_OF_CHANNELS] = { 0 };
1558   Vector<float> samples[NUMBER_OF_CHANNELS];
1559
1560   const int srcWidth = inputDimensions.GetWidth();
1561   const int srcHeight = inputDimensions.GetHeight();
1562   const int dstWidth = desiredDimensions.GetWidth();
1563   const int dstHeight = desiredDimensions.GetHeight();
1564
1565   // Now create a Resampler instance for each component to process. The first instance will create new contributor tables, which are shared by the resamplers
1566   // used for the other components (a memory and slight cache efficiency optimization).
1567   resamplers[0] = new Resampler( srcWidth,
1568                                  srcHeight,
1569                                  dstWidth,
1570                                  dstHeight,
1571                                  Resampler::BOUNDARY_CLAMP,
1572                                  0.0f,           // sample_low,
1573                                  1.0f,           // sample_high. Clamp output samples to specified range, or disable clamping if sample_low >= sample_high.
1574                                  FILTER_TYPE,    // The type of filter. Currently Lanczos.
1575                                  NULL,           // Pclist_x,
1576                                  NULL,           // Pclist_y. Optional pointers to contributor lists from another instance of a Resampler.
1577                                  FILTER_SCALE,   // src_x_ofs,
1578                                  FILTER_SCALE ); // src_y_ofs. Offset input image by specified amount (fractional values okay).
1579   samples[0].Resize( srcWidth );
1580   for( int i = 1; i < NUMBER_OF_CHANNELS; ++i )
1581   {
1582     resamplers[i] = new Resampler( srcWidth,
1583                                    srcHeight,
1584                                    dstWidth,
1585                                    dstHeight,
1586                                    Resampler::BOUNDARY_CLAMP,
1587                                    0.0f,
1588                                    1.0f,
1589                                    FILTER_TYPE,
1590                                    resamplers[0]->get_clist_x(),
1591                                    resamplers[0]->get_clist_y(),
1592                                    FILTER_SCALE,
1593                                    FILTER_SCALE );
1594     samples[i].Resize( srcWidth );
1595   }
1596
1597   const int srcPitch = srcWidth * NUMBER_OF_CHANNELS;
1598   const int dstPitch = dstWidth * NUMBER_OF_CHANNELS;
1599   int dstY = 0;
1600
1601   for( int srcY = 0; srcY < srcHeight; ++srcY )
1602   {
1603     const unsigned char* pSrc = &inPixels[srcY * srcPitch];
1604
1605     for( int x = 0; x < srcWidth; ++x )
1606     {
1607       for( int c = 0; c < NUMBER_OF_CHANNELS; ++c )
1608       {
1609         if( c == ALPHA_CHANNEL )
1610         {
1611           samples[c][x] = *pSrc++ * ONE_DIV_255;
1612         }
1613         else
1614         {
1615           samples[c][x] = srgbToLinear[*pSrc++];
1616         }
1617       }
1618     }
1619
1620     for( int c = 0; c < NUMBER_OF_CHANNELS; ++c )
1621     {
1622       if( !resamplers[c]->put_line( &samples[c][0] ) )
1623       {
1624         DALI_ASSERT_DEBUG( !"Out of memory" );
1625       }
1626     }
1627
1628     for(;;)
1629     {
1630       int compIndex;
1631       for( compIndex = 0; compIndex < NUMBER_OF_CHANNELS; ++compIndex )
1632       {
1633         const float* pOutputSamples = resamplers[compIndex]->get_line();
1634         if( !pOutputSamples )
1635         {
1636           break;
1637         }
1638
1639         const bool isAlphaChannel = ( compIndex == ALPHA_CHANNEL );
1640         DALI_ASSERT_DEBUG( dstY < dstHeight );
1641         unsigned char* pDst = &outPixels[dstY * dstPitch + compIndex];
1642
1643         for( int x = 0; x < dstWidth; ++x )
1644         {
1645           if( isAlphaChannel )
1646           {
1647             int c = static_cast<int>( 255.0f * pOutputSamples[x] + 0.5f );
1648             if( c < 0 )
1649             {
1650               c = 0;
1651             }
1652             else if( c > MAX_UNSIGNED_CHAR )
1653             {
1654               c = MAX_UNSIGNED_CHAR;
1655             }
1656             *pDst = static_cast<unsigned char>( c );
1657           }
1658           else
1659           {
1660             int j = static_cast<int>( LINEAR_TO_SRGB_TABLE_SIZE * pOutputSamples[x] + 0.5f );
1661             if( j < 0 )
1662             {
1663               j = 0;
1664             }
1665             else if( j >= LINEAR_TO_SRGB_TABLE_SIZE )
1666             {
1667               j = LINEAR_TO_SRGB_TABLE_SIZE - 1;
1668             }
1669             *pDst = linearToSrgb[j];
1670           }
1671
1672           pDst += NUMBER_OF_CHANNELS;
1673         }
1674       }
1675       if( compIndex < NUMBER_OF_CHANNELS )
1676       {
1677         break;
1678       }
1679
1680       ++dstY;
1681     }
1682   }
1683
1684   // Delete the resamplers.
1685   for( int i = 0; i < NUMBER_OF_CHANNELS; ++i )
1686   {
1687     delete resamplers[i];
1688   }
1689 }
1690
1691 // Dispatch to a format-appropriate linear sampling function:
1692 void LinearSample( const unsigned char * __restrict__ inPixels,
1693                    ImageDimensions inDimensions,
1694                    Pixel::Format pixelFormat,
1695                    unsigned char * __restrict__ outPixels,
1696                    ImageDimensions outDimensions )
1697 {
1698   // Check the pixel format is one that is supported:
1699   if( pixelFormat == Pixel::RGB888 || pixelFormat == Pixel::RGBA8888 || pixelFormat == Pixel::L8 || pixelFormat == Pixel::A8 || pixelFormat == Pixel::LA88 || pixelFormat == Pixel::RGB565 )
1700   {
1701     if( pixelFormat == Pixel::RGB888 )
1702     {
1703       LinearSample3BPP( inPixels, inDimensions, outPixels, outDimensions );
1704     }
1705     else if( pixelFormat == Pixel::RGBA8888 )
1706     {
1707       LinearSample4BPP( inPixels, inDimensions, outPixels, outDimensions );
1708     }
1709     else if( pixelFormat == Pixel::L8 || pixelFormat == Pixel::A8 )
1710     {
1711       LinearSample1BPP( inPixels, inDimensions, outPixels, outDimensions );
1712     }
1713     else if( pixelFormat == Pixel::LA88 )
1714     {
1715       LinearSample2BPP( inPixels, inDimensions, outPixels, outDimensions );
1716     }
1717     else if ( pixelFormat == Pixel::RGB565 )
1718     {
1719       LinearSampleRGB565( inPixels, inDimensions, outPixels, outDimensions );
1720     }
1721     else
1722     {
1723       DALI_ASSERT_DEBUG( false == "Inner branch conditions don't match outer branch." );
1724     }
1725   }
1726   else
1727   {
1728     DALI_LOG_INFO( gImageOpsLogFilter, Dali::Integration::Log::Verbose, "Bitmap was not linear sampled: unsupported pixel format: %u.\n", unsigned(pixelFormat) );
1729   }
1730 }
1731
1732 } /* namespace Platform */
1733 } /* namespace Internal */
1734 } /* namespace Dali */