e8c47d63c91f26d4ce853df138b9e6b1396fa776
[platform/core/uifw/dali-adaptor.git] / 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 #include <image-loading.h>
30
31 // INTERNAL INCLUDES
32
33 namespace Dali
34 {
35 namespace Internal
36 {
37 namespace Platform
38 {
39
40 namespace
41 {
42
43 // The BORDER_FILL_VALUE is a single byte value that is used for horizontal and vertical borders.
44 // A value of 0x00 gives us transparency for pixel buffers with an alpha channel, or black otherwise.
45 // We can optionally use a Vector4 color here, but at reduced fill speed.
46 const uint8_t BORDER_FILL_VALUE( 0x00 );
47 // A maximum size limit for newly created bitmaps. ( 1u << 16 ) - 1 is chosen as we are using 16bit words for dimensions.
48 const unsigned int MAXIMUM_TARGET_BITMAP_SIZE( ( 1u << 16 ) - 1 );
49
50 // Constants used by the ImageResampler.
51 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.
52 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.
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   unsigned int maxSize = Dali::GetMaxTextureSize();
453
454   // If no dimensions have been requested, default to the source ones:
455   if( requestedWidth == 0 && requestedHeight == 0 )
456   {
457     return ImageDimensions( std::min( bitmapWidth, maxSize ), std::min( bitmapHeight, maxSize ) );
458   }
459
460   // If both dimensions have values requested, use them both:
461   if( requestedWidth != 0 && requestedHeight != 0 )
462   {
463     return ImageDimensions( std::min( requestedWidth, maxSize ), std::min( requestedHeight, maxSize ) );
464   }
465
466   // Only one of the dimensions has been requested. Calculate the other from
467   // the requested one and the source image aspect ratio:
468   if( requestedWidth != 0 )
469   {
470     requestedWidth = std::min( requestedWidth, maxSize );
471     return ImageDimensions( requestedWidth, bitmapHeight / float(bitmapWidth) * requestedWidth + 0.5f );
472   }
473
474   requestedHeight = std::min( requestedHeight, maxSize );
475   return ImageDimensions( bitmapWidth / float(bitmapHeight) * requestedHeight + 0.5f, requestedHeight );
476 }
477
478 } // namespace - unnamed
479
480 ImageDimensions CalculateDesiredDimensions( ImageDimensions rawDimensions, ImageDimensions requestedDimensions )
481 {
482   return CalculateDesiredDimensions( rawDimensions.GetWidth(), rawDimensions.GetHeight(), requestedDimensions.GetWidth(), requestedDimensions.GetHeight() ) ;
483 }
484
485 /**
486  * @brief Apply cropping and padding for specified fitting mode.
487  *
488  * Once the bitmap has been (optionally) downscaled to an appropriate size, this method performs alterations
489  * based on the fitting mode.
490  *
491  * This will add vertical or horizontal borders if necessary.
492  * Crop the source image data vertically or horizontally if necessary.
493  * The aspect of the source image is preserved.
494  * If the source image is smaller than the desired size, the algorithm will modify the the newly created
495  *   bitmaps dimensions to only be as large as necessary, as a memory saving optimization. This will cause
496  *   GPU scaling to be performed at render time giving the same result with less texture traversal.
497  *
498  * @param[in] bitmap            The source bitmap to perform modifications on.
499  * @param[in] desiredDimensions The target dimensions to aim to fill based on the fitting mode.
500  * @param[in] fittingMode       The fitting mode to use.
501  *
502  * @return                      A new bitmap with the padding and cropping required for fitting mode applied.
503  *                              If no modification is needed or possible, the passed in bitmap is returned.
504  */
505 Integration::BitmapPtr CropAndPadForFittingMode( Integration::BitmapPtr bitmap, ImageDimensions desiredDimensions, FittingMode::Type fittingMode );
506
507 /**
508  * @brief Adds horizontal or vertical borders to the source image.
509  *
510  * @param[in] targetPixels     The destination image pointer to draw the borders on.
511  * @param[in] bytesPerPixel    The number of bytes per pixel of the target pixel buffer.
512  * @param[in] targetDimensions The dimensions of the destination image.
513  * @param[in] padDimensions    The columns and scanlines to pad with borders.
514  */
515 void AddBorders( PixelBuffer *targetPixels, const unsigned int bytesPerPixel, const ImageDimensions targetDimensions, const ImageDimensions padDimensions );
516
517 BitmapPtr ApplyAttributesToBitmap( BitmapPtr bitmap, ImageDimensions dimensions, FittingMode::Type fittingMode, SamplingMode::Type samplingMode )
518 {
519   if( bitmap )
520   {
521     // Calculate the desired box, accounting for a possible zero component:
522     const ImageDimensions desiredDimensions  = CalculateDesiredDimensions( bitmap->GetImageWidth(), bitmap->GetImageHeight(), dimensions.GetWidth(), dimensions.GetHeight() );
523
524     // If a different size than the raw one has been requested, resize the image
525     // maximally using a repeated box filter without making it smaller than the
526     // requested size in either dimension:
527     bitmap = DownscaleBitmap( *bitmap, desiredDimensions, fittingMode, samplingMode );
528
529     // Cut the bitmap according to the desired width and height so that the
530     // resulting bitmap has the same aspect ratio as the desired dimensions.
531     // Add crop and add borders if necessary depending on fitting mode.
532     if( bitmap && bitmap->GetPackedPixelsProfile() )
533     {
534       bitmap = CropAndPadForFittingMode( bitmap, desiredDimensions, fittingMode );
535     }
536
537     // Examine the image pixels remaining after cropping and scaling to see if all
538     // are opaque, allowing faster rendering, or some have non-1.0 alpha:
539     if( bitmap && bitmap->GetPackedPixelsProfile() && Pixel::HasAlpha( bitmap->GetPixelFormat() ) )
540     {
541       bitmap->GetPackedPixelsProfile()->TestForTransparency();
542     }
543   }
544
545   return bitmap;
546 }
547
548 BitmapPtr CropAndPadForFittingMode( BitmapPtr bitmap, ImageDimensions desiredDimensions, FittingMode::Type fittingMode )
549 {
550   const unsigned int inputWidth = bitmap->GetImageWidth();
551   const unsigned int inputHeight = bitmap->GetImageHeight();
552
553   if( desiredDimensions.GetWidth() < 1u || desiredDimensions.GetHeight() < 1u )
554   {
555     DALI_LOG_WARNING( "Image scaling aborted as desired dimensions too small (%u, %u).\n", desiredDimensions.GetWidth(), desiredDimensions.GetHeight() );
556   }
557   else if( inputWidth != desiredDimensions.GetWidth() || inputHeight != desiredDimensions.GetHeight() )
558   {
559     // Calculate any padding or cropping that needs to be done based on the fitting mode.
560     // Note: If the desired size is larger than the original image, the desired size will be
561     // reduced while maintaining the aspect, in order to save unnecessary memory usage.
562     int scanlinesToCrop = 0;
563     int columnsToCrop = 0;
564
565     CalculateBordersFromFittingMode( ImageDimensions( inputWidth, inputHeight ), fittingMode, desiredDimensions, scanlinesToCrop, columnsToCrop );
566
567     unsigned int desiredWidth( desiredDimensions.GetWidth() );
568     unsigned int desiredHeight( desiredDimensions.GetHeight() );
569
570     // Action the changes by making a new bitmap with the central part of the loaded one if required.
571     if( scanlinesToCrop != 0 || columnsToCrop != 0 )
572     {
573       // Split the adding and removing of scanlines and columns into separate variables,
574       // so we can use one piece of generic code to action the changes.
575       unsigned int scanlinesToPad = 0;
576       unsigned int columnsToPad = 0;
577       if( scanlinesToCrop < 0 )
578       {
579         scanlinesToPad = -scanlinesToCrop;
580         scanlinesToCrop = 0;
581       }
582       if( columnsToCrop < 0 )
583       {
584         columnsToPad = -columnsToCrop;
585         columnsToCrop = 0;
586       }
587
588       // If there is no filtering, then the final image size can become very large, exit if larger than maximum.
589       if( ( desiredWidth > MAXIMUM_TARGET_BITMAP_SIZE ) || ( desiredHeight > MAXIMUM_TARGET_BITMAP_SIZE ) ||
590           ( columnsToPad > MAXIMUM_TARGET_BITMAP_SIZE ) || ( scanlinesToPad > MAXIMUM_TARGET_BITMAP_SIZE ) )
591       {
592         DALI_LOG_WARNING( "Image scaling aborted as final dimensions too large (%u, %u).\n", desiredWidth, desiredHeight );
593         return bitmap;
594       }
595
596       // Create a new bitmap with the desired size.
597       BitmapPtr croppedBitmap = Integration::Bitmap::New( Integration::Bitmap::BITMAP_2D_PACKED_PIXELS, ResourcePolicy::OWNED_DISCARD );
598       Integration::Bitmap::PackedPixelsProfile *packedView = croppedBitmap->GetPackedPixelsProfile();
599       DALI_ASSERT_DEBUG( packedView );
600       const Pixel::Format pixelFormat = bitmap->GetPixelFormat();
601       packedView->ReserveBuffer( pixelFormat, desiredWidth, desiredHeight, desiredWidth, desiredHeight );
602
603       // Add some pre-calculated offsets to the bitmap pointers so this is not done within a loop.
604       // The cropping is added to the source pointer, and the padding is added to the destination.
605       const unsigned int bytesPerPixel = Pixel::GetBytesPerPixel( pixelFormat );
606       const PixelBuffer * const sourcePixels = bitmap->GetBuffer() + ( ( ( ( scanlinesToCrop / 2 ) * inputWidth ) + ( columnsToCrop / 2 ) ) * bytesPerPixel );
607       PixelBuffer * const targetPixels = croppedBitmap->GetBuffer();
608       PixelBuffer * const targetPixelsActive = targetPixels + ( ( ( ( scanlinesToPad / 2 ) * desiredWidth ) + ( columnsToPad / 2 ) ) * bytesPerPixel );
609       DALI_ASSERT_DEBUG( sourcePixels && targetPixels );
610
611       // Copy the image data to the new bitmap.
612       // Optimize to a single memcpy if the left and right edges don't need a crop or a pad.
613       unsigned int outputSpan( desiredWidth * bytesPerPixel );
614       if( columnsToCrop == 0 && columnsToPad == 0 )
615       {
616         memcpy( targetPixelsActive, sourcePixels, ( desiredHeight - scanlinesToPad ) * outputSpan );
617       }
618       else
619       {
620         // The width needs to change (due to either a crop or a pad), so we copy a scanline at a time.
621         // Precalculate any constants to optimize the inner loop.
622         const unsigned int inputSpan( inputWidth * bytesPerPixel );
623         const unsigned int copySpan( ( desiredWidth - columnsToPad ) * bytesPerPixel );
624         const unsigned int scanlinesToCopy( desiredHeight - scanlinesToPad );
625
626         for( unsigned int y = 0; y < scanlinesToCopy; ++y )
627         {
628           memcpy( &targetPixelsActive[ y * outputSpan ], &sourcePixels[ y * inputSpan ], copySpan );
629         }
630       }
631
632       // Add vertical or horizontal borders to the final image (if required).
633       desiredDimensions.SetWidth( desiredWidth );
634       desiredDimensions.SetHeight( desiredHeight );
635       AddBorders( croppedBitmap->GetBuffer(), bytesPerPixel, desiredDimensions, ImageDimensions( columnsToPad, scanlinesToPad ) );
636       // Overwrite the loaded bitmap with the cropped version
637       bitmap = croppedBitmap;
638     }
639   }
640
641   return bitmap;
642 }
643
644 void AddBorders( PixelBuffer *targetPixels, const unsigned int bytesPerPixel, const ImageDimensions targetDimensions, const ImageDimensions padDimensions )
645 {
646   // Assign ints for faster access.
647   unsigned int desiredWidth( targetDimensions.GetWidth() );
648   unsigned int desiredHeight( targetDimensions.GetHeight() );
649   unsigned int columnsToPad( padDimensions.GetWidth() );
650   unsigned int scanlinesToPad( padDimensions.GetHeight() );
651   unsigned int outputSpan( desiredWidth * bytesPerPixel );
652
653   // Add letterboxing (symmetrical borders) if needed.
654   if( scanlinesToPad > 0 )
655   {
656     // Add a top border. Note: This is (deliberately) rounded down if padding is an odd number.
657     memset( targetPixels, BORDER_FILL_VALUE, ( scanlinesToPad / 2 ) * outputSpan );
658
659     // We subtract scanlinesToPad/2 from scanlinesToPad so that we have the correct
660     // offset for odd numbers (as the top border is 1 pixel smaller in these cases.
661     unsigned int bottomBorderHeight = scanlinesToPad - ( scanlinesToPad / 2 );
662
663     // Bottom border.
664     memset( &targetPixels[ ( desiredHeight - bottomBorderHeight ) * outputSpan ], BORDER_FILL_VALUE, bottomBorderHeight * outputSpan );
665   }
666   else if( columnsToPad > 0 )
667   {
668     // Add a left and right border.
669     // Left:
670     // Pre-calculate span size outside of loop.
671     unsigned int leftBorderSpanWidth( ( columnsToPad / 2 ) * bytesPerPixel );
672     for( unsigned int y = 0; y < desiredHeight; ++y )
673     {
674       memset( &targetPixels[ y * outputSpan ], BORDER_FILL_VALUE, leftBorderSpanWidth );
675     }
676
677     // Right:
678     // Pre-calculate the initial x offset as it is always the same for a small optimization.
679     // We subtract columnsToPad/2 from columnsToPad so that we have the correct
680     // offset for odd numbers (as the left border is 1 pixel smaller in these cases.
681     unsigned int rightBorderWidth = columnsToPad - ( columnsToPad / 2 );
682     PixelBuffer * const destPixelsRightBorder( targetPixels + ( ( desiredWidth - rightBorderWidth ) * bytesPerPixel ) );
683     unsigned int rightBorderSpanWidth = rightBorderWidth * bytesPerPixel;
684
685     for( unsigned int y = 0; y < desiredHeight; ++y )
686     {
687       memset( &destPixelsRightBorder[ y * outputSpan ], BORDER_FILL_VALUE, rightBorderSpanWidth );
688     }
689   }
690 }
691
692 Integration::BitmapPtr DownscaleBitmap( Integration::Bitmap& bitmap,
693                                         ImageDimensions desired,
694                                         FittingMode::Type fittingMode,
695                                         SamplingMode::Type samplingMode )
696 {
697   // Source dimensions as loaded from resources (e.g. filesystem):
698   const unsigned int bitmapWidth  = bitmap.GetImageWidth();
699   const unsigned int bitmapHeight = bitmap.GetImageHeight();
700   // Desired dimensions (the rectangle to fit the source image to):
701   const unsigned int desiredWidth = desired.GetWidth();
702   const unsigned int desiredHeight = desired.GetHeight();
703
704   BitmapPtr outputBitmap( &bitmap );
705
706   // If a different size than the raw one has been requested, resize the image:
707   if( bitmap.GetPackedPixelsProfile() &&
708       (desiredWidth > 0.0f) && (desiredHeight > 0.0f) &&
709       ((desiredWidth < bitmapWidth) || (desiredHeight < bitmapHeight)) )
710   {
711     const Pixel::Format pixelFormat = bitmap.GetPixelFormat();
712
713     // Do the fast power of 2 iterated box filter to get to roughly the right side if the filter mode requests that:
714     unsigned int shrunkWidth = -1, shrunkHeight = -1;
715     DownscaleInPlacePow2( bitmap.GetBuffer(), pixelFormat, bitmapWidth, bitmapHeight, desiredWidth, desiredHeight, fittingMode, samplingMode, shrunkWidth, shrunkHeight );
716
717     // Work out the dimensions of the downscaled bitmap, given the scaling mode and desired dimensions:
718     const ImageDimensions filteredDimensions = FitToScalingMode( ImageDimensions( desiredWidth, desiredHeight ), ImageDimensions( shrunkWidth, shrunkHeight ), fittingMode );
719     const unsigned int filteredWidth = filteredDimensions.GetWidth();
720     const unsigned int filteredHeight = filteredDimensions.GetHeight();
721
722     // Run a filter to scale down the bitmap if it needs it:
723     bool filtered = false;
724     if( filteredWidth < shrunkWidth || filteredHeight < shrunkHeight )
725     {
726       if( samplingMode == SamplingMode::LINEAR || samplingMode == SamplingMode::BOX_THEN_LINEAR ||
727           samplingMode == SamplingMode::NEAREST || samplingMode == SamplingMode::BOX_THEN_NEAREST )
728       {
729         outputBitmap = MakeEmptyBitmap( pixelFormat, filteredWidth, filteredHeight );
730         if( outputBitmap )
731         {
732           if( samplingMode == SamplingMode::LINEAR || samplingMode == SamplingMode::BOX_THEN_LINEAR )
733           {
734             LinearSample( bitmap.GetBuffer(), ImageDimensions(shrunkWidth, shrunkHeight), pixelFormat, outputBitmap->GetBuffer(), filteredDimensions );
735           }
736           else
737           {
738             PointSample( bitmap.GetBuffer(), shrunkWidth, shrunkHeight, pixelFormat, outputBitmap->GetBuffer(), filteredWidth, filteredHeight );
739           }
740           filtered = true;
741         }
742       }
743     }
744     // Copy out the 2^x downscaled, box-filtered pixels if no secondary filter (point or linear) was applied:
745     if( filtered == false && ( shrunkWidth < bitmapWidth || shrunkHeight < bitmapHeight ) )
746     {
747       outputBitmap = MakeBitmap( bitmap.GetBuffer(), pixelFormat, shrunkWidth, shrunkHeight );
748     }
749   }
750
751   return outputBitmap;
752 }
753
754 namespace
755 {
756 /**
757  * @brief Returns whether to keep box filtering based on whether downscaled dimensions will overshoot the desired ones aty the next step.
758  * @param test Which combination of the two dimensions matter for terminating the filtering.
759  * @param scaledWidth The width of the current downscaled image.
760  * @param scaledHeight The height of the current downscaled image.
761  * @param desiredWidth The target width for the downscaling.
762  * @param desiredHeight The target height for the downscaling.
763  */
764 bool ContinueScaling( BoxDimensionTest test, unsigned int scaledWidth, unsigned int scaledHeight, unsigned int desiredWidth, unsigned int desiredHeight )
765 {
766   bool keepScaling = false;
767   const unsigned int nextWidth = scaledWidth >> 1u;
768   const unsigned int nextHeight = scaledHeight >> 1u;
769
770   if( nextWidth >= 1u && nextHeight >= 1u )
771   {
772     switch( test )
773     {
774       case BoxDimensionTestEither:
775       {
776         keepScaling = nextWidth >= desiredWidth || nextHeight >= desiredHeight;
777         break;
778       }
779       case BoxDimensionTestBoth:
780       {
781         keepScaling = nextWidth >= desiredWidth && nextHeight >= desiredHeight;
782         break;
783       }
784       case BoxDimensionTestX:
785       {
786         keepScaling = nextWidth >= desiredWidth;
787         break;
788       }
789       case BoxDimensionTestY:
790       {
791         keepScaling = nextHeight >= desiredHeight;
792         break;
793       }
794     }
795   }
796
797   return keepScaling;
798 }
799
800 /**
801  * @brief A shared implementation of the overall iterative box filter
802  * downscaling algorithm.
803  *
804  * Specialise this for particular pixel formats by supplying the number of bytes
805  * per pixel and two functions: one for averaging pairs of neighbouring pixels
806  * on a single scanline, and a second for averaging pixels at corresponding
807  * positions on different scanlines.
808  **/
809 template<
810   int BYTES_PER_PIXEL,
811   void (*HalveScanlineInPlace)( unsigned char * const pixels, const unsigned int width ),
812   void (*AverageScanlines) ( const unsigned char * const scanline1, const unsigned char * const __restrict__ scanline2, unsigned char* const outputScanline, const unsigned int width )
813 >
814 void DownscaleInPlacePow2Generic( unsigned char * const pixels,
815                                   const unsigned int inputWidth,
816                                   const unsigned int inputHeight,
817                                   const unsigned int desiredWidth,
818                                   const unsigned int desiredHeight,
819                                   BoxDimensionTest dimensionTest,
820                                   unsigned& outWidth,
821                                   unsigned& outHeight )
822 {
823   if( pixels == 0 )
824   {
825     return;
826   }
827   ValidateScalingParameters( inputWidth, inputHeight, desiredWidth, desiredHeight );
828
829   // Scale the image until it would be smaller than desired, stopping if the
830   // resulting height or width would be less than 1:
831   unsigned int scaledWidth = inputWidth, scaledHeight = inputHeight;
832   while( ContinueScaling( dimensionTest, scaledWidth, scaledHeight, desiredWidth, desiredHeight ) )
833   {
834     const unsigned int lastWidth = scaledWidth;
835     scaledWidth  >>= 1u;
836     scaledHeight >>= 1u;
837
838     DALI_LOG_INFO( gImageOpsLogFilter, Dali::Integration::Log::Verbose, "Scaling to %u\t%u.\n", scaledWidth, scaledHeight );
839
840     const unsigned int lastScanlinePair = scaledHeight - 1;
841
842     // Scale pairs of scanlines until any spare one at the end is dropped:
843     for( unsigned int y = 0; y <= lastScanlinePair; ++y )
844     {
845       // Scale two scanlines horizontally:
846       HalveScanlineInPlace( &pixels[y * 2 * lastWidth * BYTES_PER_PIXEL], lastWidth );
847       HalveScanlineInPlace( &pixels[(y * 2 + 1) * lastWidth * BYTES_PER_PIXEL], lastWidth );
848
849       // Scale vertical pairs of pixels while the last two scanlines are still warm in
850       // the CPU cache(s):
851       // Note, better access patterns for cache-coherence are possible for very large
852       // images but even a 4k wide RGB888 image will use just 24kB of cache (4k pixels
853       // * 3 Bpp * 2 scanlines) for two scanlines on the first iteration.
854       AverageScanlines(
855           &pixels[y * 2 * lastWidth * BYTES_PER_PIXEL],
856           &pixels[(y * 2 + 1) * lastWidth * BYTES_PER_PIXEL],
857           &pixels[y * scaledWidth * BYTES_PER_PIXEL],
858           scaledWidth );
859     }
860   }
861
862   ///@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.
863   outWidth = scaledWidth;
864   outHeight = scaledHeight;
865 }
866
867 }
868
869 void HalveScanlineInPlaceRGB888( unsigned char * const pixels, const unsigned int width )
870 {
871   DebugAssertScanlineParameters( pixels, width );
872
873   const unsigned int lastPair = EvenDown( width - 2 );
874
875   for( unsigned int pixel = 0, outPixel = 0; pixel <= lastPair; pixel += 2, ++outPixel )
876   {
877     // Load all the byte pixel components we need:
878     const unsigned int c11 = pixels[pixel * 3];
879     const unsigned int c12 = pixels[pixel * 3 + 1];
880     const unsigned int c13 = pixels[pixel * 3 + 2];
881     const unsigned int c21 = pixels[pixel * 3 + 3];
882     const unsigned int c22 = pixels[pixel * 3 + 4];
883     const unsigned int c23 = pixels[pixel * 3 + 5];
884
885     // Save the averaged byte pixel components:
886     pixels[outPixel * 3]     = AverageComponent( c11, c21 );
887     pixels[outPixel * 3 + 1] = AverageComponent( c12, c22 );
888     pixels[outPixel * 3 + 2] = AverageComponent( c13, c23 );
889   }
890 }
891
892 void HalveScanlineInPlaceRGBA8888( unsigned char * const pixels, const unsigned int width )
893 {
894   DebugAssertScanlineParameters( pixels, width );
895   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(pixels) & 3u) == 0u) && "Pointer should be 4-byte aligned for performance on some platforms." );
896
897   uint32_t* const alignedPixels = reinterpret_cast<uint32_t*>(pixels);
898
899   const unsigned int lastPair = EvenDown( width - 2 );
900
901   for( unsigned int pixel = 0, outPixel = 0; pixel <= lastPair; pixel += 2, ++outPixel )
902   {
903     const uint32_t averaged = AveragePixelRGBA8888( alignedPixels[pixel], alignedPixels[pixel + 1] );
904     alignedPixels[outPixel] = averaged;
905   }
906 }
907
908 void HalveScanlineInPlaceRGB565( unsigned char * pixels, unsigned int width )
909 {
910   DebugAssertScanlineParameters( pixels, width );
911   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(pixels) & 1u) == 0u) && "Pointer should be 2-byte aligned for performance on some platforms." );
912
913   uint16_t* const alignedPixels = reinterpret_cast<uint16_t*>(pixels);
914
915   const unsigned int lastPair = EvenDown( width - 2 );
916
917   for( unsigned int pixel = 0, outPixel = 0; pixel <= lastPair; pixel += 2, ++outPixel )
918   {
919     const uint32_t averaged = AveragePixelRGB565( alignedPixels[pixel], alignedPixels[pixel + 1] );
920     alignedPixels[outPixel] = averaged;
921   }
922 }
923
924 void HalveScanlineInPlace2Bytes( unsigned char * const pixels, const unsigned int width )
925 {
926   DebugAssertScanlineParameters( pixels, width );
927
928   const unsigned int lastPair = EvenDown( width - 2 );
929
930   for( unsigned int pixel = 0, outPixel = 0; pixel <= lastPair; pixel += 2, ++outPixel )
931   {
932     // Load all the byte pixel components we need:
933     const unsigned int c11 = pixels[pixel * 2];
934     const unsigned int c12 = pixels[pixel * 2 + 1];
935     const unsigned int c21 = pixels[pixel * 2 + 2];
936     const unsigned int c22 = pixels[pixel * 2 + 3];
937
938     // Save the averaged byte pixel components:
939     pixels[outPixel * 2]     = AverageComponent( c11, c21 );
940     pixels[outPixel * 2 + 1] = AverageComponent( c12, c22 );
941   }
942 }
943
944 void HalveScanlineInPlace1Byte( unsigned char * const pixels, const unsigned int width )
945 {
946   DebugAssertScanlineParameters( pixels, width );
947
948   const unsigned int lastPair = EvenDown( width - 2 );
949
950   for( unsigned int pixel = 0, outPixel = 0; pixel <= lastPair; pixel += 2, ++outPixel )
951   {
952     // Load all the byte pixel components we need:
953     const unsigned int c1 = pixels[pixel];
954     const unsigned int c2 = pixels[pixel + 1];
955
956     // Save the averaged byte pixel component:
957     pixels[outPixel] = AverageComponent( c1, c2 );
958   }
959 }
960
961 /**
962  * @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.
963  * 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.
964  */
965 void AverageScanlines1( const unsigned char * const scanline1,
966                         const unsigned char * const __restrict__ scanline2,
967                         unsigned char* const outputScanline,
968                         const unsigned int width )
969 {
970   DebugAssertDualScanlineParameters( scanline1, scanline2, outputScanline, width );
971
972   for( unsigned int component = 0; component < width; ++component )
973   {
974     outputScanline[component] = AverageComponent( scanline1[component], scanline2[component] );
975   }
976 }
977
978 void AverageScanlines2( const unsigned char * const scanline1,
979                         const unsigned char * const __restrict__ scanline2,
980                         unsigned char* const outputScanline,
981                         const unsigned int width )
982 {
983   DebugAssertDualScanlineParameters( scanline1, scanline2, outputScanline, width * 2 );
984
985   for( unsigned int component = 0; component < width * 2; ++component )
986   {
987     outputScanline[component] = AverageComponent( scanline1[component], scanline2[component] );
988   }
989 }
990
991 void AverageScanlines3( const unsigned char * const scanline1,
992                         const unsigned char * const __restrict__ scanline2,
993                         unsigned char* const outputScanline,
994                         const unsigned int width )
995 {
996   DebugAssertDualScanlineParameters( scanline1, scanline2, outputScanline, width * 3 );
997
998   for( unsigned int component = 0; component < width * 3; ++component )
999   {
1000     outputScanline[component] = AverageComponent( scanline1[component], scanline2[component] );
1001   }
1002 }
1003
1004 void AverageScanlinesRGBA8888( const unsigned char * const scanline1,
1005                                const unsigned char * const __restrict__ scanline2,
1006                                unsigned char * const outputScanline,
1007                                const unsigned int width )
1008 {
1009   DebugAssertDualScanlineParameters( scanline1, scanline2, outputScanline, width * 4 );
1010   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(scanline1) & 3u) == 0u) && "Pointer should be 4-byte aligned for performance on some platforms." );
1011   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(scanline2) & 3u) == 0u) && "Pointer should be 4-byte aligned for performance on some platforms." );
1012   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(outputScanline) & 3u) == 0u) && "Pointer should be 4-byte aligned for performance on some platforms." );
1013
1014   const uint32_t* const alignedScanline1 = reinterpret_cast<const uint32_t*>(scanline1);
1015   const uint32_t* const alignedScanline2 = reinterpret_cast<const uint32_t*>(scanline2);
1016   uint32_t* const alignedOutput = reinterpret_cast<uint32_t*>(outputScanline);
1017
1018   for( unsigned int pixel = 0; pixel < width; ++pixel )
1019   {
1020     alignedOutput[pixel] = AveragePixelRGBA8888( alignedScanline1[pixel], alignedScanline2[pixel] );
1021   }
1022 }
1023
1024 void AverageScanlinesRGB565( const unsigned char * const scanline1,
1025                              const unsigned char * const __restrict__ scanline2,
1026                              unsigned char * const outputScanline,
1027                              const unsigned int width )
1028 {
1029   DebugAssertDualScanlineParameters( scanline1, scanline2, outputScanline, width * 2 );
1030   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(scanline1) & 1u) == 0u) && "Pointer should be 2-byte aligned for performance on some platforms." );
1031   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(scanline2) & 1u) == 0u) && "Pointer should be 2-byte aligned for performance on some platforms." );
1032   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(outputScanline) & 1u) == 0u) && "Pointer should be 2-byte aligned for performance on some platforms." );
1033
1034   const uint16_t* const alignedScanline1 = reinterpret_cast<const uint16_t*>(scanline1);
1035   const uint16_t* const alignedScanline2 = reinterpret_cast<const uint16_t*>(scanline2);
1036   uint16_t* const alignedOutput = reinterpret_cast<uint16_t*>(outputScanline);
1037
1038   for( unsigned int pixel = 0; pixel < width; ++pixel )
1039   {
1040     alignedOutput[pixel] = AveragePixelRGB565( alignedScanline1[pixel], alignedScanline2[pixel] );
1041   }
1042 }
1043
1044 /// Dispatch to pixel format appropriate box filter downscaling functions.
1045 void DownscaleInPlacePow2( unsigned char * const pixels,
1046                            Pixel::Format pixelFormat,
1047                            unsigned int inputWidth,
1048                            unsigned int inputHeight,
1049                            unsigned int desiredWidth,
1050                            unsigned int desiredHeight,
1051                            FittingMode::Type fittingMode,
1052                            SamplingMode::Type samplingMode,
1053                            unsigned& outWidth,
1054                            unsigned& outHeight )
1055 {
1056   outWidth = inputWidth;
1057   outHeight = inputHeight;
1058   // Perform power of 2 iterated 4:1 box filtering if the requested filter mode requires it:
1059   if( samplingMode == SamplingMode::BOX || samplingMode == SamplingMode::BOX_THEN_NEAREST || samplingMode == SamplingMode::BOX_THEN_LINEAR )
1060   {
1061     // Check the pixel format is one that is supported:
1062     if( pixelFormat == Pixel::RGBA8888 || pixelFormat == Pixel::RGB888 || pixelFormat == Pixel::RGB565 || pixelFormat == Pixel::LA88 || pixelFormat == Pixel::L8 || pixelFormat == Pixel::A8 )
1063     {
1064       const BoxDimensionTest dimensionTest = DimensionTestForScalingMode( fittingMode );
1065
1066       if( pixelFormat == Pixel::RGBA8888 )
1067       {
1068         Internal::Platform::DownscaleInPlacePow2RGBA8888( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1069       }
1070       else if( pixelFormat == Pixel::RGB888 )
1071       {
1072         Internal::Platform::DownscaleInPlacePow2RGB888( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1073       }
1074       else if( pixelFormat == Pixel::RGB565 )
1075       {
1076         Internal::Platform::DownscaleInPlacePow2RGB565( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1077       }
1078       else if( pixelFormat == Pixel::LA88 )
1079       {
1080         Internal::Platform::DownscaleInPlacePow2ComponentPair( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1081       }
1082       else if( pixelFormat == Pixel::L8  || pixelFormat == Pixel::A8 )
1083       {
1084         Internal::Platform::DownscaleInPlacePow2SingleBytePerPixel( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1085       }
1086       else
1087       {
1088         DALI_ASSERT_DEBUG( false == "Inner branch conditions don't match outer branch." );
1089       }
1090     }
1091   }
1092   else
1093   {
1094     DALI_LOG_INFO( gImageOpsLogFilter, Dali::Integration::Log::Verbose, "Bitmap was not shrunk: unsupported pixel format: %u.\n", unsigned(pixelFormat) );
1095   }
1096 }
1097
1098 void DownscaleInPlacePow2RGB888( unsigned char *pixels,
1099                                  unsigned int inputWidth,
1100                                  unsigned int inputHeight,
1101                                  unsigned int desiredWidth,
1102                                  unsigned int desiredHeight,
1103                                  BoxDimensionTest dimensionTest,
1104                                  unsigned& outWidth,
1105                                  unsigned& outHeight )
1106 {
1107   DownscaleInPlacePow2Generic<3, HalveScanlineInPlaceRGB888, AverageScanlines3>( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1108 }
1109
1110 void DownscaleInPlacePow2RGBA8888( unsigned char * pixels,
1111                                    unsigned int inputWidth,
1112                                    unsigned int inputHeight,
1113                                    unsigned int desiredWidth,
1114                                    unsigned int desiredHeight,
1115                                    BoxDimensionTest dimensionTest,
1116                                    unsigned& outWidth,
1117                                    unsigned& outHeight )
1118 {
1119   DALI_ASSERT_DEBUG( ((reinterpret_cast<ptrdiff_t>(pixels) & 3u) == 0u) && "Pointer should be 4-byte aligned for performance on some platforms." );
1120   DownscaleInPlacePow2Generic<4, HalveScanlineInPlaceRGBA8888, AverageScanlinesRGBA8888>( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1121 }
1122
1123 void DownscaleInPlacePow2RGB565( unsigned char * pixels,
1124                                  unsigned int inputWidth,
1125                                  unsigned int inputHeight,
1126                                  unsigned int desiredWidth,
1127                                  unsigned int desiredHeight,
1128                                  BoxDimensionTest dimensionTest,
1129                                  unsigned int& outWidth,
1130                                  unsigned int& outHeight )
1131 {
1132   DownscaleInPlacePow2Generic<2, HalveScanlineInPlaceRGB565, AverageScanlinesRGB565>( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1133 }
1134
1135 /**
1136  * @copydoc DownscaleInPlacePow2RGB888
1137  *
1138  * For 2-byte formats such as lum8alpha8, but not packed 16 bit formats like RGB565.
1139  */
1140 void DownscaleInPlacePow2ComponentPair( unsigned char *pixels,
1141                                         unsigned int inputWidth,
1142                                         unsigned int inputHeight,
1143                                         unsigned int desiredWidth,
1144                                         unsigned int desiredHeight,
1145                                         BoxDimensionTest dimensionTest,
1146                                         unsigned& outWidth,
1147                                         unsigned& outHeight )
1148 {
1149   DownscaleInPlacePow2Generic<2, HalveScanlineInPlace2Bytes, AverageScanlines2>( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1150 }
1151
1152 void DownscaleInPlacePow2SingleBytePerPixel( unsigned char * pixels,
1153                                              unsigned int inputWidth,
1154                                              unsigned int inputHeight,
1155                                              unsigned int desiredWidth,
1156                                              unsigned int desiredHeight,
1157                                              BoxDimensionTest dimensionTest,
1158                                              unsigned int& outWidth,
1159                                              unsigned int& outHeight )
1160 {
1161   DownscaleInPlacePow2Generic<1, HalveScanlineInPlace1Byte, AverageScanlines1>( pixels, inputWidth, inputHeight, desiredWidth, desiredHeight, dimensionTest, outWidth, outHeight );
1162 }
1163
1164 namespace
1165 {
1166
1167 /**
1168  * @brief Point sample an image to a new resolution (like GL_NEAREST).
1169  *
1170  * Template is used purely as a type-safe code generator in this one
1171  * compilation unit. Generated code is inlined into type-specific wrapper
1172  * functions below which are exported to rest of module.
1173  */
1174 template<typename PIXEL>
1175 inline void PointSampleAddressablePixels( const uint8_t * inPixels,
1176                                    unsigned int inputWidth,
1177                                    unsigned int inputHeight,
1178                                    uint8_t * outPixels,
1179                                    unsigned int desiredWidth,
1180                                    unsigned int desiredHeight )
1181 {
1182   DALI_ASSERT_DEBUG( ((desiredWidth <= inputWidth && desiredHeight <= inputHeight) ||
1183       outPixels >= inPixels + inputWidth * inputHeight * sizeof(PIXEL) || outPixels <= inPixels - desiredWidth * desiredHeight * sizeof(PIXEL)) &&
1184       "The input and output buffers must not overlap for an upscaling.");
1185   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, ...)." );
1186   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, ...)." );
1187
1188   if( inputWidth < 1u || inputHeight < 1u || desiredWidth < 1u || desiredHeight < 1u )
1189   {
1190     return;
1191   }
1192   const PIXEL* const inAligned = reinterpret_cast<const PIXEL*>(inPixels);
1193   PIXEL* const       outAligned = reinterpret_cast<PIXEL*>(outPixels);
1194   const unsigned int deltaX = (inputWidth  << 16u) / desiredWidth;
1195   const unsigned int deltaY = (inputHeight << 16u) / desiredHeight;
1196
1197   unsigned int inY = 0;
1198   for( unsigned int outY = 0; outY < desiredHeight; ++outY )
1199   {
1200     // Round fixed point y coordinate to nearest integer:
1201     const unsigned int integerY = (inY + (1u << 15u)) >> 16u;
1202     const PIXEL* const inScanline = &inAligned[inputWidth * integerY];
1203     PIXEL* const outScanline = &outAligned[desiredWidth * outY];
1204
1205     DALI_ASSERT_DEBUG( integerY < inputHeight );
1206     DALI_ASSERT_DEBUG( reinterpret_cast<const uint8_t*>(inScanline) < ( inPixels + inputWidth * inputHeight * sizeof(PIXEL) ) );
1207     DALI_ASSERT_DEBUG( reinterpret_cast<uint8_t*>(outScanline) < ( outPixels + desiredWidth * desiredHeight * sizeof(PIXEL) ) );
1208
1209     unsigned int inX = 0;
1210     for( unsigned int outX = 0; outX < desiredWidth; ++outX )
1211     {
1212       // Round the fixed-point x coordinate to an integer:
1213       const unsigned int integerX = (inX + (1u << 15u)) >> 16u;
1214       const PIXEL* const inPixelAddress = &inScanline[integerX];
1215       const PIXEL pixel = *inPixelAddress;
1216       outScanline[outX] = pixel;
1217       inX += deltaX;
1218     }
1219     inY += deltaY;
1220   }
1221 }
1222
1223 }
1224
1225 // RGBA8888
1226 void PointSample4BPP( const unsigned char * inPixels,
1227                       unsigned int inputWidth,
1228                       unsigned int inputHeight,
1229                       unsigned char * outPixels,
1230                       unsigned int desiredWidth,
1231                       unsigned int desiredHeight )
1232 {
1233   PointSampleAddressablePixels<uint32_t>( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1234 }
1235
1236 // RGB565, LA88
1237 void PointSample2BPP( const unsigned char * inPixels,
1238                       unsigned int inputWidth,
1239                       unsigned int inputHeight,
1240                       unsigned char * outPixels,
1241                       unsigned int desiredWidth,
1242                       unsigned int desiredHeight )
1243 {
1244   PointSampleAddressablePixels<uint16_t>( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1245 }
1246
1247 // L8, A8
1248 void PointSample1BPP( const unsigned char * inPixels,
1249                       unsigned int inputWidth,
1250                       unsigned int inputHeight,
1251                       unsigned char * outPixels,
1252                       unsigned int desiredWidth,
1253                       unsigned int desiredHeight )
1254 {
1255   PointSampleAddressablePixels<uint8_t>( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1256 }
1257
1258 /* RGB888
1259  * RGB888 is a special case as its pixels are not aligned addressable units.
1260  */
1261 void PointSample3BPP( const uint8_t * inPixels,
1262                       unsigned int inputWidth,
1263                       unsigned int inputHeight,
1264                       uint8_t * outPixels,
1265                       unsigned int desiredWidth,
1266                       unsigned int desiredHeight )
1267 {
1268   if( inputWidth < 1u || inputHeight < 1u || desiredWidth < 1u || desiredHeight < 1u )
1269   {
1270     return;
1271   }
1272   const unsigned int BYTES_PER_PIXEL = 3;
1273
1274   // Generate fixed-point 16.16 deltas in input image coordinates:
1275   const unsigned int deltaX = (inputWidth  << 16u) / desiredWidth;
1276   const unsigned int deltaY = (inputHeight << 16u) / desiredHeight;
1277
1278   // Step through output image in whole integer pixel steps while tracking the
1279   // corresponding locations in the input image using 16.16 fixed-point
1280   // coordinates:
1281   unsigned int inY = 0; //< 16.16 fixed-point input image y-coord.
1282   for( unsigned int outY = 0; outY < desiredHeight; ++outY )
1283   {
1284     const unsigned int integerY = (inY + (1u << 15u)) >> 16u;
1285     const uint8_t* const inScanline = &inPixels[inputWidth * integerY * BYTES_PER_PIXEL];
1286     uint8_t* const outScanline = &outPixels[desiredWidth * outY * BYTES_PER_PIXEL];
1287     unsigned int inX = 0; //< 16.16 fixed-point input image x-coord.
1288
1289     for( unsigned int outX = 0; outX < desiredWidth * BYTES_PER_PIXEL; outX += BYTES_PER_PIXEL )
1290     {
1291       // Round the fixed-point input coordinate to the address of the input pixel to sample:
1292       const unsigned int integerX = (inX + (1u << 15u)) >> 16u;
1293       const uint8_t* const inPixelAddress = &inScanline[integerX * BYTES_PER_PIXEL];
1294
1295       // Issue loads for all pixel color components up-front:
1296       const unsigned int c0 = inPixelAddress[0];
1297       const unsigned int c1 = inPixelAddress[1];
1298       const unsigned int c2 = inPixelAddress[2];
1299       ///@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.
1300
1301       // Output the pixel components:
1302       outScanline[outX]     = c0;
1303       outScanline[outX + 1] = c1;
1304       outScanline[outX + 2] = c2;
1305
1306       // Increment the fixed-point input coordinate:
1307       inX += deltaX;
1308     }
1309
1310     inY += deltaY;
1311   }
1312 }
1313
1314 // Dispatch to a format-appropriate point sampling function:
1315 void PointSample( const unsigned char * inPixels,
1316                   unsigned int inputWidth,
1317                   unsigned int inputHeight,
1318                   Pixel::Format pixelFormat,
1319                   unsigned char * outPixels,
1320                   unsigned int desiredWidth,
1321                   unsigned int desiredHeight )
1322 {
1323   // Check the pixel format is one that is supported:
1324   if( pixelFormat == Pixel::RGBA8888 || pixelFormat == Pixel::RGB888 || pixelFormat == Pixel::RGB565 || pixelFormat == Pixel::LA88 || pixelFormat == Pixel::L8 || pixelFormat == Pixel::A8 )
1325   {
1326     if( pixelFormat == Pixel::RGB888 )
1327     {
1328       PointSample3BPP( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1329     }
1330     else if( pixelFormat == Pixel::RGBA8888 )
1331     {
1332       PointSample4BPP( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1333     }
1334     else if( pixelFormat == Pixel::RGB565 || pixelFormat == Pixel::LA88 )
1335     {
1336       PointSample2BPP( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1337     }
1338     else if( pixelFormat == Pixel::L8  || pixelFormat == Pixel::A8 )
1339     {
1340       PointSample1BPP( inPixels, inputWidth, inputHeight, outPixels, desiredWidth, desiredHeight );
1341     }
1342     else
1343     {
1344       DALI_ASSERT_DEBUG( false == "Inner branch conditions don't match outer branch." );
1345     }
1346   }
1347   else
1348   {
1349     DALI_LOG_INFO( gImageOpsLogFilter, Dali::Integration::Log::Verbose, "Bitmap was not point sampled: unsupported pixel format: %u.\n", unsigned(pixelFormat) );
1350   }
1351 }
1352
1353 // Linear sampling group below
1354
1355 namespace
1356 {
1357
1358 /** @brief Blend 4 pixels together using horizontal and vertical weights. */
1359 inline uint8_t BilinearFilter1BPPByte( uint8_t tl, uint8_t tr, uint8_t bl, uint8_t br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical )
1360 {
1361   return BilinearFilter1Component( tl, tr, bl, br, fractBlendHorizontal, fractBlendVertical );
1362 }
1363
1364 /** @copydoc BilinearFilter1BPPByte */
1365 inline Pixel2Bytes BilinearFilter2Bytes( Pixel2Bytes tl, Pixel2Bytes tr, Pixel2Bytes bl, Pixel2Bytes br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical )
1366 {
1367   Pixel2Bytes pixel;
1368   pixel.l = BilinearFilter1Component( tl.l, tr.l, bl.l, br.l, fractBlendHorizontal, fractBlendVertical );
1369   pixel.a = BilinearFilter1Component( tl.a, tr.a, bl.a, br.a, fractBlendHorizontal, fractBlendVertical );
1370   return pixel;
1371 }
1372
1373 /** @copydoc BilinearFilter1BPPByte */
1374 inline Pixel3Bytes BilinearFilterRGB888( Pixel3Bytes tl, Pixel3Bytes tr, Pixel3Bytes bl, Pixel3Bytes br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical )
1375 {
1376   Pixel3Bytes pixel;
1377   pixel.r = BilinearFilter1Component( tl.r, tr.r, bl.r, br.r, fractBlendHorizontal, fractBlendVertical );
1378   pixel.g = BilinearFilter1Component( tl.g, tr.g, bl.g, br.g, fractBlendHorizontal, fractBlendVertical );
1379   pixel.b = BilinearFilter1Component( tl.b, tr.b, bl.b, br.b, fractBlendHorizontal, fractBlendVertical );
1380   return pixel;
1381 }
1382
1383 /** @copydoc BilinearFilter1BPPByte */
1384 inline PixelRGB565 BilinearFilterRGB565( PixelRGB565 tl, PixelRGB565 tr, PixelRGB565 bl, PixelRGB565 br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical )
1385 {
1386   const PixelRGB565 pixel = (BilinearFilter1Component( tl >> 11u, tr >> 11u, bl >> 11u, br >> 11u, fractBlendHorizontal, fractBlendVertical ) << 11u) +
1387                             (BilinearFilter1Component( (tl >> 5u) & 63u, (tr >> 5u) & 63u, (bl >> 5u) & 63u, (br >> 5u) & 63u, fractBlendHorizontal, fractBlendVertical ) << 5u) +
1388                              BilinearFilter1Component( tl & 31u, tr & 31u, bl & 31u, br & 31u, fractBlendHorizontal, fractBlendVertical );
1389   return pixel;
1390 }
1391
1392 /** @copydoc BilinearFilter1BPPByte */
1393 inline Pixel4Bytes BilinearFilter4Bytes( Pixel4Bytes tl, Pixel4Bytes tr, Pixel4Bytes bl, Pixel4Bytes br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical )
1394 {
1395   Pixel4Bytes pixel;
1396   pixel.r = BilinearFilter1Component( tl.r, tr.r, bl.r, br.r, fractBlendHorizontal, fractBlendVertical );
1397   pixel.g = BilinearFilter1Component( tl.g, tr.g, bl.g, br.g, fractBlendHorizontal, fractBlendVertical );
1398   pixel.b = BilinearFilter1Component( tl.b, tr.b, bl.b, br.b, fractBlendHorizontal, fractBlendVertical );
1399   pixel.a = BilinearFilter1Component( tl.a, tr.a, bl.a, br.a, fractBlendHorizontal, fractBlendVertical );
1400   return pixel;
1401 }
1402
1403 /**
1404  * @brief Generic version of bilinear sampling image resize function.
1405  * @note Limited to one compilation unit and exposed through type-specific
1406  * wrapper functions below.
1407  */
1408 template<
1409   typename PIXEL,
1410   PIXEL (*BilinearFilter) ( PIXEL tl, PIXEL tr, PIXEL bl, PIXEL br, unsigned int fractBlendHorizontal, unsigned int fractBlendVertical ),
1411   bool DEBUG_ASSERT_ALIGNMENT
1412 >
1413 inline void LinearSampleGeneric( const unsigned char * __restrict__ inPixels,
1414                        ImageDimensions inputDimensions,
1415                        unsigned char * __restrict__ outPixels,
1416                        ImageDimensions desiredDimensions )
1417 {
1418   const unsigned int inputWidth = inputDimensions.GetWidth();
1419   const unsigned int inputHeight = inputDimensions.GetHeight();
1420   const unsigned int desiredWidth = desiredDimensions.GetWidth();
1421   const unsigned int desiredHeight = desiredDimensions.GetHeight();
1422
1423   DALI_ASSERT_DEBUG( ((outPixels >= inPixels + inputWidth   * inputHeight   * sizeof(PIXEL)) ||
1424                       (inPixels >= outPixels + desiredWidth * desiredHeight * sizeof(PIXEL))) &&
1425                      "Input and output buffers cannot overlap.");
1426   if( DEBUG_ASSERT_ALIGNMENT )
1427   {
1428     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, ...)." );
1429     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, ...)." );
1430   }
1431
1432   if( inputWidth < 1u || inputHeight < 1u || desiredWidth < 1u || desiredHeight < 1u )
1433   {
1434     return;
1435   }
1436   const PIXEL* const inAligned = reinterpret_cast<const PIXEL*>(inPixels);
1437   PIXEL* const       outAligned = reinterpret_cast<PIXEL*>(outPixels);
1438   const unsigned int deltaX = (inputWidth  << 16u) / desiredWidth;
1439   const unsigned int deltaY = (inputHeight << 16u) / desiredHeight;
1440
1441   unsigned int inY = 0;
1442   for( unsigned int outY = 0; outY < desiredHeight; ++outY )
1443   {
1444     PIXEL* const outScanline = &outAligned[desiredWidth * outY];
1445
1446     // Find the two scanlines to blend and the weight to blend with:
1447     const unsigned int integerY1 = inY >> 16u;
1448     const unsigned int integerY2 = integerY1 >= inputHeight ? integerY1 : integerY1 + 1;
1449     const unsigned int inputYWeight = inY & 65535u;
1450
1451     DALI_ASSERT_DEBUG( integerY1 < inputHeight );
1452     DALI_ASSERT_DEBUG( integerY2 < inputHeight );
1453
1454     const PIXEL* const inScanline1 = &inAligned[inputWidth * integerY1];
1455     const PIXEL* const inScanline2 = &inAligned[inputWidth * integerY2];
1456
1457     unsigned int inX = 0;
1458     for( unsigned int outX = 0; outX < desiredWidth; ++outX )
1459     {
1460       // Work out the two pixel scanline offsets for this cluster of four samples:
1461       const unsigned int integerX1 = inX >> 16u;
1462       const unsigned int integerX2 = integerX1 >= inputWidth ? integerX1 : integerX1 + 1;
1463
1464       // Execute the loads:
1465       const PIXEL pixel1 = inScanline1[integerX1];
1466       const PIXEL pixel2 = inScanline2[integerX1];
1467       const PIXEL pixel3 = inScanline1[integerX2];
1468       const PIXEL pixel4 = inScanline2[integerX2];
1469       ///@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.
1470
1471       // Weighted bilinear filter:
1472       const unsigned int inputXWeight = inX & 65535u;
1473       outScanline[outX] = BilinearFilter( pixel1, pixel3, pixel2, pixel4, inputXWeight, inputYWeight );
1474
1475       inX += deltaX;
1476     }
1477     inY += deltaY;
1478   }
1479 }
1480
1481 }
1482
1483 // Format-specific linear scaling instantiations:
1484
1485 void LinearSample1BPP( const unsigned char * __restrict__ inPixels,
1486                        ImageDimensions inputDimensions,
1487                        unsigned char * __restrict__ outPixels,
1488                        ImageDimensions desiredDimensions )
1489 {
1490   LinearSampleGeneric<uint8_t, BilinearFilter1BPPByte, false>( inPixels, inputDimensions, outPixels, desiredDimensions );
1491 }
1492
1493 void LinearSample2BPP( const unsigned char * __restrict__ inPixels,
1494                        ImageDimensions inputDimensions,
1495                        unsigned char * __restrict__ outPixels,
1496                        ImageDimensions desiredDimensions )
1497 {
1498   LinearSampleGeneric<Pixel2Bytes, BilinearFilter2Bytes, true>( inPixels, inputDimensions, outPixels, desiredDimensions );
1499 }
1500
1501 void LinearSampleRGB565( const unsigned char * __restrict__ inPixels,
1502                        ImageDimensions inputDimensions,
1503                        unsigned char * __restrict__ outPixels,
1504                        ImageDimensions desiredDimensions )
1505 {
1506   LinearSampleGeneric<PixelRGB565, BilinearFilterRGB565, true>( inPixels, inputDimensions, outPixels, desiredDimensions );
1507 }
1508
1509 void LinearSample3BPP( const unsigned char * __restrict__ inPixels,
1510                        ImageDimensions inputDimensions,
1511                        unsigned char * __restrict__ outPixels,
1512                        ImageDimensions desiredDimensions )
1513 {
1514   LinearSampleGeneric<Pixel3Bytes, BilinearFilterRGB888, false>( inPixels, inputDimensions, outPixels, desiredDimensions );
1515 }
1516
1517 void LinearSample4BPP( const unsigned char * __restrict__ inPixels,
1518                        ImageDimensions inputDimensions,
1519                        unsigned char * __restrict__ outPixels,
1520                        ImageDimensions desiredDimensions )
1521 {
1522   LinearSampleGeneric<Pixel4Bytes, BilinearFilter4Bytes, true>( inPixels, inputDimensions, outPixels, desiredDimensions );
1523 }
1524
1525
1526 void Resample( const unsigned char * __restrict__ inPixels,
1527                ImageDimensions inputDimensions,
1528                unsigned char * __restrict__ outPixels,
1529                ImageDimensions desiredDimensions,
1530                Resampler::Filter filterType,
1531                int numChannels, bool hasAlpha )
1532 {
1533   // Got from the test.cpp of the ImageResampler lib.
1534   const float ONE_DIV_255 = 1.0f / 255.0f;
1535   const int MAX_UNSIGNED_CHAR = std::numeric_limits<uint8_t>::max();
1536   const int LINEAR_TO_SRGB_TABLE_SIZE = 4096;
1537   const int ALPHA_CHANNEL = hasAlpha ? (numChannels-1) : 0;
1538
1539   static bool loadColorSpaces = true;
1540   static float srgbToLinear[MAX_UNSIGNED_CHAR + 1];
1541   static unsigned char linearToSrgb[LINEAR_TO_SRGB_TABLE_SIZE];
1542
1543   if( loadColorSpaces ) // Only create the color space conversions on the first execution
1544   {
1545     loadColorSpaces = false;
1546
1547     for( int i = 0; i <= MAX_UNSIGNED_CHAR; ++i )
1548     {
1549       srgbToLinear[i] = pow( static_cast<float>( i ) * ONE_DIV_255, DEFAULT_SOURCE_GAMMA );
1550     }
1551
1552     const float invLinearToSrgbTableSize = 1.0f / static_cast<float>( LINEAR_TO_SRGB_TABLE_SIZE );
1553     const float invSourceGamma = 1.0f / DEFAULT_SOURCE_GAMMA;
1554
1555     for( int i = 0; i < LINEAR_TO_SRGB_TABLE_SIZE; ++i )
1556     {
1557       int k = static_cast<int>( 255.0f * pow( static_cast<float>( i ) * invLinearToSrgbTableSize, invSourceGamma ) + 0.5f );
1558       if( k < 0 )
1559       {
1560         k = 0;
1561       }
1562       else if( k > MAX_UNSIGNED_CHAR )
1563       {
1564         k = MAX_UNSIGNED_CHAR;
1565       }
1566       linearToSrgb[i] = static_cast<unsigned char>( k );
1567     }
1568   }
1569
1570   Resampler* resamplers[numChannels];
1571   Vector<float> samples[numChannels];
1572
1573   const int srcWidth = inputDimensions.GetWidth();
1574   const int srcHeight = inputDimensions.GetHeight();
1575   const int dstWidth = desiredDimensions.GetWidth();
1576   const int dstHeight = desiredDimensions.GetHeight();
1577
1578   // Now create a Resampler instance for each component to process. The first instance will create new contributor tables, which are shared by the resamplers
1579   // used for the other components (a memory and slight cache efficiency optimization).
1580   resamplers[0] = new Resampler( srcWidth,
1581                                  srcHeight,
1582                                  dstWidth,
1583                                  dstHeight,
1584                                  Resampler::BOUNDARY_CLAMP,
1585                                  0.0f,           // sample_low,
1586                                  1.0f,           // sample_high. Clamp output samples to specified range, or disable clamping if sample_low >= sample_high.
1587                                  filterType,    // The type of filter.
1588                                  NULL,           // Pclist_x,
1589                                  NULL,           // Pclist_y. Optional pointers to contributor lists from another instance of a Resampler.
1590                                  FILTER_SCALE,   // src_x_ofs,
1591                                  FILTER_SCALE ); // src_y_ofs. Offset input image by specified amount (fractional values okay).
1592   samples[0].Resize( srcWidth );
1593   for( int i = 1; i < numChannels; ++i )
1594   {
1595     resamplers[i] = new Resampler( srcWidth,
1596                                    srcHeight,
1597                                    dstWidth,
1598                                    dstHeight,
1599                                    Resampler::BOUNDARY_CLAMP,
1600                                    0.0f,
1601                                    1.0f,
1602                                    filterType,
1603                                    resamplers[0]->get_clist_x(),
1604                                    resamplers[0]->get_clist_y(),
1605                                    FILTER_SCALE,
1606                                    FILTER_SCALE );
1607     samples[i].Resize( srcWidth );
1608   }
1609
1610   const int srcPitch = srcWidth * numChannels;
1611   const int dstPitch = dstWidth * numChannels;
1612   int dstY = 0;
1613
1614   for( int srcY = 0; srcY < srcHeight; ++srcY )
1615   {
1616     const unsigned char* pSrc = &inPixels[srcY * srcPitch];
1617
1618     for( int x = 0; x < srcWidth; ++x )
1619     {
1620       for( int c = 0; c < numChannels; ++c )
1621       {
1622         if( c == ALPHA_CHANNEL && hasAlpha )
1623         {
1624           samples[c][x] = *pSrc++ * ONE_DIV_255;
1625         }
1626         else
1627         {
1628           samples[c][x] = srgbToLinear[*pSrc++];
1629         }
1630       }
1631     }
1632
1633     for( int c = 0; c < numChannels; ++c )
1634     {
1635       if( !resamplers[c]->put_line( &samples[c][0] ) )
1636       {
1637         DALI_ASSERT_DEBUG( !"Out of memory" );
1638       }
1639     }
1640
1641     for(;;)
1642     {
1643       int compIndex;
1644       for( compIndex = 0; compIndex < numChannels; ++compIndex )
1645       {
1646         const float* pOutputSamples = resamplers[compIndex]->get_line();
1647         if( !pOutputSamples )
1648         {
1649           break;
1650         }
1651
1652         const bool isAlphaChannel = ( compIndex == ALPHA_CHANNEL && hasAlpha );
1653         DALI_ASSERT_DEBUG( dstY < dstHeight );
1654         unsigned char* pDst = &outPixels[dstY * dstPitch + compIndex];
1655
1656         for( int x = 0; x < dstWidth; ++x )
1657         {
1658           if( isAlphaChannel )
1659           {
1660             int c = static_cast<int>( 255.0f * pOutputSamples[x] + 0.5f );
1661             if( c < 0 )
1662             {
1663               c = 0;
1664             }
1665             else if( c > MAX_UNSIGNED_CHAR )
1666             {
1667               c = MAX_UNSIGNED_CHAR;
1668             }
1669             *pDst = static_cast<unsigned char>( c );
1670           }
1671           else
1672           {
1673             int j = static_cast<int>( LINEAR_TO_SRGB_TABLE_SIZE * pOutputSamples[x] + 0.5f );
1674             if( j < 0 )
1675             {
1676               j = 0;
1677             }
1678             else if( j >= LINEAR_TO_SRGB_TABLE_SIZE )
1679             {
1680               j = LINEAR_TO_SRGB_TABLE_SIZE - 1;
1681             }
1682             *pDst = linearToSrgb[j];
1683           }
1684
1685           pDst += numChannels;
1686         }
1687       }
1688       if( compIndex < numChannels )
1689       {
1690         break;
1691       }
1692
1693       ++dstY;
1694     }
1695   }
1696
1697   // Delete the resamplers.
1698   for( int i = 0; i < numChannels; ++i )
1699   {
1700     delete resamplers[i];
1701   }
1702 }
1703
1704 void LanczosSample4BPP( const unsigned char * __restrict__ inPixels,
1705                         ImageDimensions inputDimensions,
1706                         unsigned char * __restrict__ outPixels,
1707                         ImageDimensions desiredDimensions )
1708 {
1709   Resample( inPixels, inputDimensions, outPixels, desiredDimensions, Resampler::LANCZOS4, 4, true );
1710 }
1711
1712 void LanczosSample1BPP( const unsigned char * __restrict__ inPixels,
1713                         ImageDimensions inputDimensions,
1714                         unsigned char * __restrict__ outPixels,
1715                         ImageDimensions desiredDimensions )
1716 {
1717   // For L8 images
1718   Resample( inPixels, inputDimensions, outPixels, desiredDimensions, Resampler::LANCZOS4, 1, false );
1719 }
1720
1721 // Dispatch to a format-appropriate linear sampling function:
1722 void LinearSample( const unsigned char * __restrict__ inPixels,
1723                    ImageDimensions inDimensions,
1724                    Pixel::Format pixelFormat,
1725                    unsigned char * __restrict__ outPixels,
1726                    ImageDimensions outDimensions )
1727 {
1728   // Check the pixel format is one that is supported:
1729   if( pixelFormat == Pixel::RGB888 || pixelFormat == Pixel::RGBA8888 || pixelFormat == Pixel::L8 || pixelFormat == Pixel::A8 || pixelFormat == Pixel::LA88 || pixelFormat == Pixel::RGB565 )
1730   {
1731     if( pixelFormat == Pixel::RGB888 )
1732     {
1733       LinearSample3BPP( inPixels, inDimensions, outPixels, outDimensions );
1734     }
1735     else if( pixelFormat == Pixel::RGBA8888 )
1736     {
1737       LinearSample4BPP( inPixels, inDimensions, outPixels, outDimensions );
1738     }
1739     else if( pixelFormat == Pixel::L8 || pixelFormat == Pixel::A8 )
1740     {
1741       LinearSample1BPP( inPixels, inDimensions, outPixels, outDimensions );
1742     }
1743     else if( pixelFormat == Pixel::LA88 )
1744     {
1745       LinearSample2BPP( inPixels, inDimensions, outPixels, outDimensions );
1746     }
1747     else if ( pixelFormat == Pixel::RGB565 )
1748     {
1749       LinearSampleRGB565( inPixels, inDimensions, outPixels, outDimensions );
1750     }
1751     else
1752     {
1753       DALI_ASSERT_DEBUG( false == "Inner branch conditions don't match outer branch." );
1754     }
1755   }
1756   else
1757   {
1758     DALI_LOG_INFO( gImageOpsLogFilter, Dali::Integration::Log::Verbose, "Bitmap was not linear sampled: unsupported pixel format: %u.\n", unsigned(pixelFormat) );
1759   }
1760 }
1761
1762 } /* namespace Platform */
1763 } /* namespace Internal */
1764 } /* namespace Dali */