2 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "loader-jpeg.h"
20 #include <dali/integration-api/bitmap.h>
21 #include "platform-capabilities.h"
22 #include "image-operations.h"
25 #include <libexif/exif-data.h>
26 #include <libexif/exif-loader.h>
27 #include <libexif/exif-tag.h>
28 #include <turbojpeg.h>
35 using Integration::Bitmap;
37 namespace TizenPlatform
42 const unsigned DECODED_PIXEL_SIZE = 3;
43 const TJPF DECODED_PIXEL_LIBJPEG_TYPE = TJPF_RGB;
45 /** Transformations that can be applied to decoded pixels to respect exif orientation
46 * codes in image headers */
49 JPGFORM_NONE = 1, /* no transformation 0th-Row = top & 0th-Column = left */
50 JPGFORM_FLIP_H, /* horizontal flip 0th-Row = top & 0th-Column = right */
51 JPGFORM_FLIP_V, /* vertical flip 0th-Row = bottom & 0th-Column = right*/
52 JPGFORM_TRANSPOSE, /* transpose across UL-to-LR axis 0th-Row = bottom & 0th-Column = left*/
53 JPGFORM_TRANSVERSE,/* transpose across UR-to-LL axis 0th-Row = left & 0th-Column = top*/
54 JPGFORM_ROT_90, /* 90-degree clockwise rotation 0th-Row = right & 0th-Column = top*/
55 JPGFORM_ROT_180, /* 180-degree rotation 0th-Row = right & 0th-Column = bottom*/
56 JPGFORM_ROT_270 /* 270-degree clockwise (or 90 ccw) 0th-Row = left & 0th-Column = bottom*/
67 * @brief Error handling bookeeping for the JPEG Turbo library's
68 * setjmp/longjmp simulated exceptions.
70 struct JpegErrorState {
71 struct jpeg_error_mgr errorManager;
76 * @brief Called by the JPEG library when it hits an error.
77 * We jump out of the library so our loader code can return an error.
79 void JpegErrorHandler ( j_common_ptr cinfo )
81 DALI_LOG_ERROR( "JpegErrorHandler(): libjpeg-turbo fatal error in JPEG decoding.\n" );
82 /* cinfo->err really points to a JpegErrorState struct, so coerce pointer */
83 JpegErrorState * myerr = reinterpret_cast<JpegErrorState *>( cinfo->err );
85 /* Return control to the setjmp point */
86 longjmp( myerr->jumpBuffer, 1 );
89 void JpegOutputMessageHandler( j_common_ptr cinfo )
91 /* Stop libjpeg from printing to stderr - Do Nothing */
95 * LibJPEG Turbo tjDecompress2 API doesn't distinguish between errors that still allow
96 * the JPEG to be displayed and fatal errors.
98 bool IsJpegErrorFatal( const std::string& errorMessage )
100 if( ( errorMessage.find("Corrupt JPEG data") != std::string::npos ) ||
101 ( errorMessage.find("Invalid SOS parameters") != std::string::npos ) )
109 /** Simple struct to ensure xif data is deleted. */
112 ExifAutoPtr( ExifData* data)
118 exif_data_free( mData);
123 /** simple class to enforce clean-up of JPEG structures. */
126 AutoJpg(const tjhandle jpgHandle)
133 // clean up JPG resources
137 tjhandle GetHandle() const
143 AutoJpg( const AutoJpg& ); //< not defined
144 AutoJpg& operator= ( const AutoJpg& ); //< not defined
147 }; // struct AutoJpg;
149 /** RAII wrapper to free memory allocated by the jpeg-turbo library. */
152 AutoJpgMem(unsigned char * const tjMem)
162 unsigned char * Get() const
168 AutoJpgMem( const AutoJpgMem& ); //< not defined
169 AutoJpgMem& operator= ( const AutoJpgMem& ); //< not defined
171 unsigned char * const mTjMem;
174 // Workaround to avoid exceeding the maximum texture size
175 const int MAX_TEXTURE_WIDTH = 4096;
176 const int MAX_TEXTURE_HEIGHT = 4096;
180 bool JpegRotate90 (unsigned char *buffer, int width, int height, int bpp);
181 bool JpegRotate180(unsigned char *buffer, int width, int height, int bpp);
182 bool JpegRotate270(unsigned char *buffer, int width, int height, int bpp);
183 JPGFORM_CODE ConvertExifOrientation(ExifData* exifData);
184 bool TransformSize( int requiredWidth, int requiredHeight,
185 FittingMode::Type fittingMode, SamplingMode::Type samplingMode,
186 JPGFORM_CODE transform,
187 int& preXformImageWidth, int& preXformImageHeight,
188 int& postXformImageWidth, int& postXformImageHeight );
190 bool LoadJpegHeader( FILE *fp, unsigned int &width, unsigned int &height )
192 // using libjpeg API to avoid having to read the whole file in a buffer
193 struct jpeg_decompress_struct cinfo;
194 struct JpegErrorState jerr;
195 cinfo.err = jpeg_std_error( &jerr.errorManager );
197 jerr.errorManager.output_message = JpegOutputMessageHandler;
198 jerr.errorManager.error_exit = JpegErrorHandler;
200 // On error exit from the JPEG lib, control will pass via JpegErrorHandler
201 // into this branch body for cleanup and error return:
202 if(setjmp(jerr.jumpBuffer))
204 jpeg_destroy_decompress(&cinfo);
208 // jpeg_create_decompress internally uses C casts
209 #pragma GCC diagnostic push
210 #pragma GCC diagnostic ignored "-Wold-style-cast"
211 jpeg_create_decompress( &cinfo );
212 #pragma GCC diagnostic pop
214 jpeg_stdio_src( &cinfo, fp );
216 // Check header to see if it is JPEG file
217 if( jpeg_read_header( &cinfo, TRUE ) != JPEG_HEADER_OK )
220 jpeg_destroy_decompress( &cinfo );
224 width = cinfo.image_width;
225 height = cinfo.image_height;
227 jpeg_destroy_decompress( &cinfo );
231 bool LoadBitmapFromJpeg( const ImageLoader::Input& input, Integration::Bitmap& bitmap )
234 FILE* const fp = input.file;
236 if( fseek(fp,0,SEEK_END) )
238 DALI_LOG_ERROR("Error seeking to end of file\n");
242 long positionIndicator = ftell(fp);
243 unsigned int jpegBufferSize = 0u;
244 if( positionIndicator > -1L )
246 jpegBufferSize = static_cast<unsigned int>(positionIndicator);
249 if( 0u == jpegBufferSize )
254 if( fseek(fp, 0, SEEK_SET) )
256 DALI_LOG_ERROR("Error seeking to start of file\n");
260 Vector<unsigned char> jpegBuffer;
263 jpegBuffer.Resize( jpegBufferSize );
267 DALI_LOG_ERROR( "Could not allocate temporary memory to hold JPEG file of size %uMB.\n", jpegBufferSize / 1048576U );
270 unsigned char * const jpegBufferPtr = jpegBuffer.Begin();
272 // Pull the compressed JPEG image bytes out of a file and into memory:
273 if( fread( jpegBufferPtr, 1, jpegBufferSize, fp ) != jpegBufferSize )
275 DALI_LOG_WARNING("Error on image file read.\n");
279 if( fseek(fp, 0, SEEK_SET) )
281 DALI_LOG_ERROR("Error seeking to start of file\n");
284 AutoJpg autoJpg(tjInitDecompress());
286 if(autoJpg.GetHandle() == NULL)
288 DALI_LOG_ERROR("%s\n", tjGetErrorStr());
292 JPGFORM_CODE transform = JPGFORM_NONE;
294 if( input.reorientationRequested )
296 ExifAutoPtr exifData( exif_data_new_from_data(jpegBufferPtr, jpegBufferSize) );
299 transform = ConvertExifOrientation(exifData.mData);
303 // Push jpeg data in memory buffer through TurboJPEG decoder to make a raw pixel array:
304 int chrominanceSubsampling = -1;
305 int preXformImageWidth = 0, preXformImageHeight = 0;
306 if( tjDecompressHeader2( autoJpg.GetHandle(), jpegBufferPtr, jpegBufferSize, &preXformImageWidth, &preXformImageHeight, &chrominanceSubsampling ) == -1 )
308 DALI_LOG_ERROR("%s\n", tjGetErrorStr());
309 // Do not set width and height to 0 or return early as this sometimes fails only on determining subsampling type.
312 if(preXformImageWidth == 0 || preXformImageHeight == 0)
314 DALI_LOG_WARNING("Invalid Image!\n");
318 int requiredWidth = input.scalingParameters.dimensions.GetWidth();
319 int requiredHeight = input.scalingParameters.dimensions.GetHeight();
321 // If transform is a 90 or 270 degree rotation, the logical width and height
322 // request from the client needs to be adjusted to account by effectively
323 // rotating that too, and the final width and height need to be swapped:
324 int postXformImageWidth = preXformImageWidth;
325 int postXformImageHeight = preXformImageHeight;
328 int scaledPreXformWidth = preXformImageWidth;
329 int scaledPreXformHeight = preXformImageHeight;
330 int scaledPostXformWidth = postXformImageWidth;
331 int scaledPostXformHeight = postXformImageHeight;
333 TransformSize( requiredWidth, requiredHeight,
334 input.scalingParameters.scalingMode,
335 input.scalingParameters.samplingMode,
337 scaledPreXformWidth, scaledPreXformHeight,
338 scaledPostXformWidth, scaledPostXformHeight );
340 // Allocate a bitmap and decompress the jpeg buffer into its pixel buffer:
342 unsigned char * const bitmapPixelBuffer = bitmap.GetPackedPixelsProfile()->ReserveBuffer(Pixel::RGB888, scaledPostXformWidth, scaledPostXformHeight);
344 if( tjDecompress2( autoJpg.GetHandle(), jpegBufferPtr, jpegBufferSize, bitmapPixelBuffer, scaledPreXformWidth, 0, scaledPreXformHeight, DECODED_PIXEL_LIBJPEG_TYPE, flags ) == -1 )
346 std::string errorString = tjGetErrorStr();
348 if( IsJpegErrorFatal( errorString ) )
350 DALI_LOG_ERROR("%s\n", errorString.c_str());
355 DALI_LOG_WARNING("%s\n", errorString.c_str());
359 const unsigned int bufferWidth = GetTextureDimension( scaledPreXformWidth );
360 const unsigned int bufferHeight = GetTextureDimension( scaledPreXformHeight );
370 // 3 orientation changes for a camera held perpendicular to the ground or upside-down:
371 case JPGFORM_ROT_180:
373 result = JpegRotate180(bitmapPixelBuffer, bufferWidth, bufferHeight, DECODED_PIXEL_SIZE);
376 case JPGFORM_ROT_270:
378 result = JpegRotate270(bitmapPixelBuffer, bufferWidth, bufferHeight, DECODED_PIXEL_SIZE);
383 result = JpegRotate90(bitmapPixelBuffer, bufferWidth, bufferHeight, DECODED_PIXEL_SIZE);
386 /// Less-common orientation changes, since they don't correspond to a camera's
387 // physical orientation:
390 case JPGFORM_TRANSPOSE:
391 case JPGFORM_TRANSVERSE:
393 DALI_LOG_WARNING( "Unsupported JPEG Orientation transformation: %x.\n", transform );
400 ///@Todo: Move all these rotation functions to portable/image-operations and take "Jpeg" out of their names.
401 bool JpegRotate90(unsigned char *buffer, int width, int height, int bpp)
403 int w, iw, ih, hw = 0;
407 Vector<unsigned char> data;
408 data.Resize(width * height * bpp);
409 unsigned char *dataPtr = data.Begin();
410 memcpy(dataPtr, buffer, width * height * bpp);
420 RGB888Type* to = reinterpret_cast<RGB888Type*>(buffer) + iw - 1;
421 RGB888Type* from = reinterpret_cast<RGB888Type*>( dataPtr );
423 for(ix = iw; -- ix >= 0;)
425 for(iy = ih; -- iy >= 0; ++from )
444 bool JpegRotate180(unsigned char *buffer, int width, int height, int bpp)
446 int ix, iw, ih, hw = 0;
457 RGB888Type* to = reinterpret_cast<RGB888Type*>(buffer) ;
458 RGB888Type* from = reinterpret_cast<RGB888Type*>( buffer ) + hw - 1;
459 for(; --ix >= (hw / 2); ++to, --from)
477 bool JpegRotate270(unsigned char *buffer, int width, int height, int bpp)
479 int w, iw, ih, hw = 0;
484 Vector<unsigned char> data;
485 data.Resize(width * height * bpp);
486 unsigned char *dataPtr = data.Begin();
487 memcpy(dataPtr, buffer, width * height * bpp);
497 RGB888Type* to = reinterpret_cast<RGB888Type*>(buffer) + hw - iw;
498 RGB888Type* from = reinterpret_cast<RGB888Type*>( dataPtr );
502 for(ix = iw; -- ix >= 0;)
504 for(iy = ih; -- iy >= 0;)
523 bool EncodeToJpeg( const unsigned char* const pixelBuffer, Vector< unsigned char >& encodedPixels,
524 const std::size_t width, const std::size_t height, const Pixel::Format pixelFormat, unsigned quality )
529 DALI_LOG_ERROR("Null input buffer\n");
533 // Translate pixel format enum:
534 int jpegPixelFormat = -1;
536 switch( pixelFormat )
540 jpegPixelFormat = TJPF_RGB;
543 case Pixel::RGBA8888:
546 jpegPixelFormat = TJPF_RGBX;
549 case Pixel::BGRA8888:
552 jpegPixelFormat = TJPF_BGRX;
557 DALI_LOG_ERROR( "Unsupported pixel format for encoding to JPEG.\n" );
562 // Assert quality is in the documented allowable range of the jpeg-turbo lib:
563 DALI_ASSERT_DEBUG( quality >= 1 );
564 DALI_ASSERT_DEBUG( quality <= 100 );
574 // Initialise a JPEG codec:
575 AutoJpg autoJpg( tjInitCompress() );
577 if( autoJpg.GetHandle() == NULL )
579 DALI_LOG_ERROR( "JPEG Compressor init failed: %s\n", tjGetErrorStr() );
583 // Run the compressor:
584 unsigned char* dstBuffer = NULL;
585 unsigned long dstBufferSize = 0;
588 if( tjCompress2( autoJpg.GetHandle(), const_cast<unsigned char*>(pixelBuffer), width, 0, height, jpegPixelFormat, &dstBuffer, &dstBufferSize, TJSAMP_444, quality, flags ) )
590 DALI_LOG_ERROR("JPEG Compression failed: %s\n", tjGetErrorStr());
594 // Safely wrap the jpeg codec's buffer in case we are about to throw, then
595 // save the pixels to a persistent buffer that we own and let our cleaner
596 // class clean up the buffer as it goes out of scope:
597 AutoJpgMem cleaner( dstBuffer );
598 encodedPixels.Resize( dstBufferSize );
599 memcpy( encodedPixels.Begin(), dstBuffer, dstBufferSize );
605 JPGFORM_CODE ConvertExifOrientation(ExifData* exifData)
607 JPGFORM_CODE transform = JPGFORM_NONE;
608 ExifEntry * const entry = exif_data_get_entry(exifData, EXIF_TAG_ORIENTATION);
612 orientation = exif_get_short(entry->data, exif_data_get_byte_order(entry->parent->parent));
613 switch( orientation )
617 transform = JPGFORM_NONE;
622 transform = JPGFORM_FLIP_H;
627 transform = JPGFORM_FLIP_V;
632 transform = JPGFORM_TRANSPOSE;
637 transform = JPGFORM_TRANSVERSE;
642 transform = JPGFORM_ROT_90;
647 transform = JPGFORM_ROT_180;
652 transform = JPGFORM_ROT_270;
657 // Try to keep loading the file, but let app developer know there was something fishy:
658 DALI_LOG_WARNING( "Incorrect/Unknown Orientation setting found in EXIF header of JPEG image (%x). Orientation setting will be ignored.\n", entry );
666 bool TransformSize( int requiredWidth, int requiredHeight,
667 FittingMode::Type fittingMode, SamplingMode::Type samplingMode,
668 JPGFORM_CODE transform,
669 int& preXformImageWidth, int& preXformImageHeight,
670 int& postXformImageWidth, int& postXformImageHeight )
674 if( transform == JPGFORM_ROT_90 || transform == JPGFORM_ROT_270 )
676 std::swap( requiredWidth, requiredHeight );
677 std::swap( postXformImageWidth, postXformImageHeight );
680 // Apply the special rules for when there are one or two zeros in requested dimensions:
681 const ImageDimensions correctedDesired = Internal::Platform::CalculateDesiredDimensions( ImageDimensions( postXformImageWidth, postXformImageHeight), ImageDimensions( requiredWidth, requiredHeight ) );
682 requiredWidth = correctedDesired.GetWidth();
683 requiredHeight = correctedDesired.GetHeight();
685 // Rescale image during decode using one of the decoder's built-in rescaling
686 // ratios (expected to be powers of 2), keeping the final image at least as
687 // wide and high as was requested:
690 tjscalingfactor* factors = tjGetScalingFactors( &numFactors );
691 if( factors == NULL )
693 DALI_LOG_WARNING("TurboJpeg tjGetScalingFactors error!\n");
698 // Internal jpeg downscaling is the same as our BOX_X sampling modes so only
699 // apply it if the application requested one of those:
700 // (use a switch case here so this code will fail to compile if other modes are added)
701 bool downscale = true;
702 switch( samplingMode )
704 case SamplingMode::BOX:
705 case SamplingMode::BOX_THEN_NEAREST:
706 case SamplingMode::BOX_THEN_LINEAR:
707 case SamplingMode::DONT_CARE:
712 case SamplingMode::NO_FILTER:
713 case SamplingMode::NEAREST:
714 case SamplingMode::LINEAR:
721 int scaleFactorIndex( 0 );
724 // Find nearest supported scaling factor (factors are in sequential order, getting smaller)
725 for( int i = 1; i < numFactors; ++i )
727 bool widthLessRequired = TJSCALED( postXformImageWidth, factors[i]) < requiredWidth;
728 bool heightLessRequired = TJSCALED( postXformImageHeight, factors[i]) < requiredHeight;
729 // If either scaled dimension is smaller than the desired one, we were done at the last iteration
730 if ( (fittingMode == FittingMode::SCALE_TO_FILL) && (widthLessRequired || heightLessRequired) )
734 // If both dimensions are smaller than the desired one, we were done at the last iteration:
735 if ( (fittingMode == FittingMode::SHRINK_TO_FIT) && ( widthLessRequired && heightLessRequired ) )
739 // If the width is smaller than the desired one, we were done at the last iteration:
740 if ( fittingMode == FittingMode::FIT_WIDTH && widthLessRequired )
744 // If the width is smaller than the desired one, we were done at the last iteration:
745 if ( fittingMode == FittingMode::FIT_HEIGHT && heightLessRequired )
749 // This factor stays is within our fitting mode constraint so remember it:
750 scaleFactorIndex = i;
754 // Regardless of requested size, downscale to avoid exceeding the maximum texture size:
755 for( int i = scaleFactorIndex; i < numFactors; ++i )
757 // Continue downscaling to below maximum texture size (if possible)
758 scaleFactorIndex = i;
760 if( TJSCALED(postXformImageWidth, (factors[i])) < MAX_TEXTURE_WIDTH &&
761 TJSCALED(postXformImageHeight, (factors[i])) < MAX_TEXTURE_HEIGHT )
763 // Current scale-factor downscales to below maximum texture size
768 // We have finally chosen the scale-factor, return width/height values
769 if( scaleFactorIndex > 0 )
771 preXformImageWidth = TJSCALED(preXformImageWidth, (factors[scaleFactorIndex]));
772 preXformImageHeight = TJSCALED(preXformImageHeight, (factors[scaleFactorIndex]));
773 postXformImageWidth = TJSCALED(postXformImageWidth, (factors[scaleFactorIndex]));
774 postXformImageHeight = TJSCALED(postXformImageHeight, (factors[scaleFactorIndex]));
781 ExifData* LoadExifData( FILE* fp )
783 ExifData* exifData=NULL;
784 ExifLoader* exifLoader;
785 unsigned char dataBuffer[1024];
787 if( fseek( fp, 0, SEEK_SET ) )
789 DALI_LOG_ERROR("Error seeking to start of file\n");
793 exifLoader = exif_loader_new ();
797 int size = fread( dataBuffer, 1, sizeof( dataBuffer ), fp );
802 if( ! exif_loader_write( exifLoader, dataBuffer, size ) )
808 exifData = exif_loader_get_data( exifLoader );
809 exif_loader_unref( exifLoader );
815 bool LoadJpegHeader( const ImageLoader::Input& input, unsigned int& width, unsigned int& height )
817 unsigned int requiredWidth = input.scalingParameters.dimensions.GetWidth();
818 unsigned int requiredHeight = input.scalingParameters.dimensions.GetHeight();
819 FILE* const fp = input.file;
821 bool success = false;
822 if( requiredWidth == 0 && requiredHeight == 0 )
824 success = LoadJpegHeader( fp, width, height );
828 // Double check we get the same width/height from the header
829 unsigned int headerWidth;
830 unsigned int headerHeight;
831 if( LoadJpegHeader( fp, headerWidth, headerHeight ) )
833 JPGFORM_CODE transform = JPGFORM_NONE;
835 if( input.reorientationRequested )
837 ExifAutoPtr exifData( LoadExifData( fp ) );
840 transform = ConvertExifOrientation(exifData.mData);
843 int preXformImageWidth = headerWidth;
844 int preXformImageHeight = headerHeight;
845 int postXformImageWidth = headerWidth;
846 int postXformImageHeight = headerHeight;
848 success = TransformSize( requiredWidth, requiredHeight, input.scalingParameters.scalingMode, input.scalingParameters.samplingMode, transform, preXformImageWidth, preXformImageHeight, postXformImageWidth, postXformImageHeight );
851 width = postXformImageWidth;
852 height = postXformImageHeight;
859 height = headerHeight;
867 } // namespace TizenPlatform