2 * Copyright (c) 2014 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 "resource-loading-client.h"
21 #include <dali/integration-api/bitmap.h>
22 #include <dali/public-api/images/image-attributes.h>
23 #include <resource-loader/debug/resource-loader-debug.h>
24 #include "platform-capabilities.h"
27 #include <libexif/exif-data.h>
28 #include <libexif/exif-loader.h>
29 #include <libexif/exif-tag.h>
30 #include <turbojpeg.h>
38 using Integration::Bitmap;
40 namespace TizenPlatform
45 const unsigned DECODED_PIXEL_SIZE = 3;
46 const TJPF DECODED_PIXEL_LIBJPEG_TYPE = TJPF_RGB;
48 /** Transformations that can be applied to decoded pixels to respect exif orientation
49 * codes in image headers */
52 JPGFORM_NONE = 1, /* no transformation 0th-Row = top & 0th-Column = left */
53 JPGFORM_FLIP_H, /* horizontal flip 0th-Row = top & 0th-Column = right */
54 JPGFORM_FLIP_V, /* vertical flip 0th-Row = bottom & 0th-Column = right*/
55 JPGFORM_TRANSPOSE, /* transpose across UL-to-LR axis 0th-Row = bottom & 0th-Column = left*/
56 JPGFORM_TRANSVERSE,/* transpose across UR-to-LL axis 0th-Row = left & 0th-Column = top*/
57 JPGFORM_ROT_90, /* 90-degree clockwise rotation 0th-Row = right & 0th-Column = top*/
58 JPGFORM_ROT_180, /* 180-degree rotation 0th-Row = right & 0th-Column = bottom*/
59 JPGFORM_ROT_270 /* 270-degree clockwise (or 90 ccw) 0th-Row = left & 0th-Column = bottom*/
89 * @brief Error handling bookeeping for the JPEG Turbo library's
90 * setjmp/longjmp simulated exceptions.
92 struct JpegErrorState {
93 struct jpeg_error_mgr errorManager;
98 * @brief Called by the JPEG library when it hits an error.
99 * We jump out of the library so our loader code can return an error.
101 void JpegErrorHandler ( j_common_ptr cinfo )
103 DALI_LOG_ERROR( "JpegErrorHandler(): libjpeg-turbo fatal error in JPEG decoding.\n" );
104 /* cinfo->err really points to a JpegErrorState struct, so coerce pointer */
105 JpegErrorState * myerr = reinterpret_cast<JpegErrorState *>( cinfo->err );
107 /* Return control to the setjmp point */
108 longjmp( myerr->jumpBuffer, 1 );
111 void JpegOutputMessageHandler( j_common_ptr cinfo )
113 /* Stop libjpeg from printing to stderr - Do Nothing */
116 /** Simple struct to ensure xif data is deleted. */
119 ExifAutoPtr( ExifData* data)
125 exif_data_free( mData);
130 /** simple class to enforce clean-up of JPEG structures. */
133 AutoJpg(const tjhandle jpgHandle)
140 // clean up JPG resources
144 tjhandle GetHandle() const
150 AutoJpg( const AutoJpg& ); //< not defined
151 AutoJpg& operator= ( const AutoJpg& ); //< not defined
154 }; // struct AutoJpg;
156 /** RAII wrapper to free memory allocated by the jpeg-turbo library. */
159 AutoJpgMem(unsigned char * const tjMem)
169 unsigned char * Get() const
175 AutoJpgMem( const AutoJpgMem& ); //< not defined
176 AutoJpgMem& operator= ( const AutoJpgMem& ); //< not defined
178 unsigned char * const mTjMem;
181 // Workaround to avoid exceeding the maximum texture size
182 const int MAX_TEXTURE_WIDTH = 4096;
183 const int MAX_TEXTURE_HEIGHT = 4096;
187 bool JpegRotate90 (unsigned char *buffer, int width, int height, int bpp);
188 bool JpegRotate180(unsigned char *buffer, int width, int height, int bpp);
189 bool JpegRotate270(unsigned char *buffer, int width, int height, int bpp);
190 JPGFORM_CODE ConvertExifOrientation(ExifData* exifData);
191 bool TransformSize( int requiredWidth, int requiredHeight, JPGFORM_CODE transform,
192 int& preXformImageWidth, int& preXformImageHeight,
193 int& postXformImageWidth, int& postXformImageHeight );
195 bool LoadJpegHeader( FILE *fp, unsigned int &width, unsigned int &height )
197 // using libjpeg API to avoid having to read the whole file in a buffer
198 struct jpeg_decompress_struct cinfo;
199 struct JpegErrorState jerr;
200 cinfo.err = jpeg_std_error( &jerr.errorManager );
202 jerr.errorManager.output_message = JpegOutputMessageHandler;
203 jerr.errorManager.error_exit = JpegErrorHandler;
205 // On error exit from the JPEG lib, control will pass via JpegErrorHandler
206 // into this branch body for cleanup and error return:
207 if(setjmp(jerr.jumpBuffer))
209 jpeg_destroy_decompress(&cinfo);
213 jpeg_create_decompress( &cinfo );
215 jpeg_stdio_src( &cinfo, fp );
217 // Check header to see if it is JPEG file
218 if( jpeg_read_header( &cinfo, TRUE ) != JPEG_HEADER_OK )
221 jpeg_destroy_decompress( &cinfo );
225 width = cinfo.image_width;
226 height = cinfo.image_height;
228 jpeg_destroy_decompress( &cinfo );
232 bool LoadBitmapFromJpeg( FILE *fp, Bitmap& bitmap, ImageAttributes& attributes, const ResourceLoadingClient& client )
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 std::vector<unsigned char> jpegBuffer(0);
263 jpegBuffer.reserve( 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[0];
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.");
279 if( fseek(fp, 0, SEEK_SET) )
281 DALI_LOG_ERROR("Error seeking to start of file\n");
284 // Allow early cancellation between the load and the decompress:
285 client.InterruptionPoint();
287 AutoJpg autoJpg(tjInitDecompress());
289 if(autoJpg.GetHandle() == NULL)
291 DALI_LOG_ERROR("%s\n", tjGetErrorStr());
295 JPGFORM_CODE transform = JPGFORM_NONE;
297 if( attributes.GetOrientationCorrection() )
299 ExifAutoPtr exifData( exif_data_new_from_data(jpegBufferPtr, jpegBufferSize) );
302 transform = ConvertExifOrientation(exifData.mData);
306 // Push jpeg data in memory buffer through TurboJPEG decoder to make a raw pixel array:
307 int chrominanceSubsampling = -1;
308 int preXformImageWidth = 0, preXformImageHeight = 0;
309 if( tjDecompressHeader2( autoJpg.GetHandle(), jpegBufferPtr, jpegBufferSize, &preXformImageWidth, &preXformImageHeight, &chrominanceSubsampling ) == -1 )
311 DALI_LOG_ERROR("%s\n", tjGetErrorStr());
312 // Do not set width and height to 0 or return early as this sometimes fails only on determining subsampling type.
315 if(preXformImageWidth == 0 || preXformImageHeight == 0)
317 DALI_LOG_WARNING("Invalid Image!");
321 int requiredWidth = attributes.GetWidth();
322 int requiredHeight = attributes.GetHeight();
324 // If transform is a 90 or 270 degree rotation, the logical width and height
325 // request from the client needs to be adjusted to account by effectively
326 // rotating that too, and the final width and height need to be swapped:
327 int postXformImageWidth = preXformImageWidth;
328 int postXformImageHeight = preXformImageHeight;
331 int scaledPreXformWidth = preXformImageWidth;
332 int scaledPreXformHeight = preXformImageHeight;
333 int scaledPostXformWidth = postXformImageWidth;
334 int scaledPostXformHeight = postXformImageHeight;
336 TransformSize( requiredWidth, requiredHeight, transform,
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 // Allow early cancellation before decoding:
345 client.InterruptionPoint();
347 const int pitch = scaledPreXformWidth * DECODED_PIXEL_SIZE;
348 if( tjDecompress2( autoJpg.GetHandle(), jpegBufferPtr, jpegBufferSize, bitmapPixelBuffer, scaledPreXformWidth, pitch, scaledPreXformHeight, DECODED_PIXEL_LIBJPEG_TYPE, flags ) == -1 )
350 DALI_LOG_ERROR("%s\n", tjGetErrorStr());
354 attributes.SetSize( scaledPostXformWidth, scaledPostXformHeight );
356 const unsigned int bufferWidth = GetTextureDimension( scaledPreXformWidth );
357 const unsigned int bufferHeight = GetTextureDimension( scaledPreXformHeight );
359 if( transform != JPGFORM_NONE )
361 // Allow early cancellation before shuffling pixels around on the CPU:
362 client.InterruptionPoint();
370 case JPGFORM_TRANSPOSE:
371 case JPGFORM_TRANSVERSE: ///!ToDo: None of these are supported!
373 DALI_LOG_WARNING( "Unsupported JPEG Orientation transformation: %x.\n", transform );
381 case JPGFORM_ROT_180:
383 result = JpegRotate180(bitmapPixelBuffer, bufferWidth, bufferHeight, DECODED_PIXEL_SIZE);
386 case JPGFORM_ROT_270:
388 result = JpegRotate270(bitmapPixelBuffer, bufferWidth, bufferHeight, DECODED_PIXEL_SIZE);
393 result = JpegRotate90(bitmapPixelBuffer, bufferWidth, bufferHeight, DECODED_PIXEL_SIZE);
400 bool JpegRotate90(unsigned char *buffer, int width, int height, int bpp)
402 int w, iw, ih, hw = 0;
406 std::vector<unsigned char> data(width * height * bpp);
407 unsigned char *dataPtr = &data[0];
408 memcpy(dataPtr, buffer, width * height * bpp);
418 RGB888Type* to = reinterpret_cast<RGB888Type*>(buffer) + iw - 1;
419 RGB888Type* from = reinterpret_cast<RGB888Type*>( dataPtr );
421 for(ix = iw; -- ix >= 0;)
423 for(iy = ih; -- iy >= 0; ++from )
442 bool JpegRotate180(unsigned char *buffer, int width, int height, int bpp)
444 int ix, iw, ih, hw = 0;
455 RGB888Type* to = reinterpret_cast<RGB888Type*>(buffer) ;
456 RGB888Type* from = reinterpret_cast<RGB888Type*>( buffer ) + hw - 1;
457 for(; --ix >= (hw / 2); ++to, --from)
475 bool JpegRotate270(unsigned char *buffer, int width, int height, int bpp)
477 int w, iw, ih, hw = 0;
482 std::vector<unsigned char> data(width * height * bpp);
483 unsigned char *dataPtr = &data[0];
484 memcpy(dataPtr, buffer, width * height * bpp);
494 RGB888Type* to = reinterpret_cast<RGB888Type*>(buffer) + hw - iw;
495 RGB888Type* from = reinterpret_cast<RGB888Type*>( dataPtr );
499 for(ix = iw; -- ix >= 0;)
501 for(iy = ih; -- iy >= 0;)
520 bool EncodeToJpeg( const unsigned char* const pixelBuffer, std::vector< unsigned char >& encodedPixels, const std::size_t width, const std::size_t height, const Pixel::Format pixelFormat, unsigned quality)
524 DALI_LOG_ERROR("Null input buffer\n");
528 // Translate pixel format enum:
529 int jpegPixelFormat = -1;
531 switch( pixelFormat )
535 jpegPixelFormat = TJPF_RGB;
538 case Pixel::RGBA8888:
541 jpegPixelFormat = TJPF_RGBX;
544 case Pixel::BGRA8888:
547 jpegPixelFormat = TJPF_BGRX;
552 DALI_LOG_ERROR( "Unsupported pixel format for encoding to JPEG." );
557 // Assert quality is in the documented allowable range of the jpeg-turbo lib:
558 DALI_ASSERT_DEBUG( quality >= 1 );
559 DALI_ASSERT_DEBUG( quality <= 100 );
569 // Initialise a JPEG codec:
570 AutoJpg autoJpg( tjInitCompress() );
572 if( autoJpg.GetHandle() == NULL )
574 DALI_LOG_ERROR( "JPEG Compressor init failed: %s\n", tjGetErrorStr() );
578 // Run the compressor:
579 unsigned char* dstBuffer = NULL;
580 unsigned long dstBufferSize = 0;
583 if( tjCompress2( autoJpg.GetHandle(), const_cast<unsigned char*>(pixelBuffer), width, 0, height, jpegPixelFormat, &dstBuffer, &dstBufferSize, TJSAMP_444, quality, flags ) )
585 DALI_LOG_ERROR("JPEG Compression failed: %s\n", tjGetErrorStr());
589 // Safely wrap the jpeg codec's buffer in case we are about to throw, then
590 // save the pixels to a persistent buffer that we own and let our cleaner
591 // class clean up the buffer as it goes out of scope:
592 AutoJpgMem cleaner(dstBuffer);
593 encodedPixels.resize(dstBufferSize);
594 memcpy(&encodedPixels[0], dstBuffer, dstBufferSize);
600 JPGFORM_CODE ConvertExifOrientation(ExifData* exifData)
602 JPGFORM_CODE transform = JPGFORM_NONE;
603 ExifEntry * const entry = exif_data_get_entry(exifData, EXIF_TAG_ORIENTATION);
607 orientation = exif_get_short(entry->data, exif_data_get_byte_order(entry->parent->parent));
608 switch( orientation )
612 transform = JPGFORM_NONE;
617 transform = JPGFORM_FLIP_H;
622 transform = JPGFORM_FLIP_V;
627 transform = JPGFORM_TRANSPOSE;
632 transform = JPGFORM_TRANSVERSE;
637 transform = JPGFORM_ROT_90;
642 transform = JPGFORM_ROT_180;
647 transform = JPGFORM_ROT_270;
652 // Try to keep loading the file, but let app developer know there was something fishy:
653 DALI_LOG_WARNING( "Incorrect/Unknown Orientation setting found in EXIF header of JPEG image (%x). Orientation setting will be ignored.", entry );
661 bool TransformSize( int requiredWidth, int requiredHeight, JPGFORM_CODE transform,
662 int& preXformImageWidth, int& preXformImageHeight,
663 int& postXformImageWidth, int& postXformImageHeight )
667 if( transform == JPGFORM_ROT_90 || transform == JPGFORM_ROT_270 )
669 std::swap( requiredWidth, requiredHeight );
670 std::swap( postXformImageWidth, postXformImageHeight );
673 // Rescale image during decode using one of the decoder's built-in rescaling
674 // ratios (expected to be powers of 2), keeping the final image at least as
675 // wide and high as was requested:
678 tjscalingfactor* factors = tjGetScalingFactors( &numFactors );
679 if( factors == NULL )
681 DALI_LOG_WARNING("TurboJpeg tjGetScalingFactors error!");
686 // Find nearest supported scaling factor (factors are in sequential order, getting smaller)
687 int scaleFactorIndex( 0 );
688 for( int i = 1; i < numFactors; ++i )
690 // if requested width or height set to 0, ignore value
691 // TJSCALED performs an integer-based ceil operation on (dim*factor)
692 if( (requiredWidth && TJSCALED(postXformImageWidth , (factors[i])) > requiredWidth) ||
693 (requiredHeight && TJSCALED(postXformImageHeight, (factors[i])) > requiredHeight) )
695 scaleFactorIndex = i;
699 // This scaling would result in an image that was smaller than requested in both
700 // dimensions, so stop at the previous entry.
705 // Workaround for libjpeg-turbo problem adding a green line on one edge
706 // when downscaling to 1/8 in each dimension. Prefer not to scale to less than
707 // 1/4 in each dimension:
708 if( 2 < scaleFactorIndex )
710 scaleFactorIndex = 2;
711 DALI_LOG_INFO( gLoaderFilter, Debug::General, "Down-scaling requested for image limited to 1/4.\n" );
714 // Regardless of requested size, downscale to avoid exceeding the maximum texture size
715 for( int i = scaleFactorIndex; i < numFactors; ++i )
717 // Continue downscaling to below maximum texture size (if possible)
718 scaleFactorIndex = i;
720 if( TJSCALED(postXformImageWidth, (factors[i])) < MAX_TEXTURE_WIDTH &&
721 TJSCALED(postXformImageHeight, (factors[i])) < MAX_TEXTURE_HEIGHT )
723 // Current scale-factor downscales to below maximum texture size
728 // We have finally chosen the scale-factor, return width/height values
729 if( scaleFactorIndex > 0 )
731 preXformImageWidth = TJSCALED(preXformImageWidth, (factors[scaleFactorIndex]));
732 preXformImageHeight = TJSCALED(preXformImageHeight, (factors[scaleFactorIndex]));
733 postXformImageWidth = TJSCALED(postXformImageWidth, (factors[scaleFactorIndex]));
734 postXformImageHeight = TJSCALED(postXformImageHeight, (factors[scaleFactorIndex]));
741 ExifData* LoadExifData( FILE* fp )
743 ExifData* exifData=NULL;
744 ExifLoader* exifLoader;
745 unsigned char dataBuffer[1024];
747 if( fseek( fp, 0, SEEK_SET ) )
749 DALI_LOG_ERROR("Error seeking to start of file\n");
753 exifLoader = exif_loader_new ();
757 int size = fread( dataBuffer, 1, sizeof( dataBuffer ), fp );
762 if( ! exif_loader_write( exifLoader, dataBuffer, size ) )
768 exifData = exif_loader_get_data( exifLoader );
769 exif_loader_unref( exifLoader );
775 bool LoadJpegHeader(FILE *fp, const ImageAttributes& attributes, unsigned int &width, unsigned int &height)
777 unsigned int requiredWidth = attributes.GetWidth();
778 unsigned int requiredHeight = attributes.GetHeight();
780 bool success = false;
781 if( requiredWidth == 0 && requiredHeight == 0 )
783 success = LoadJpegHeader( fp, width, height );
787 // Double check we get the same width/height from the header
788 unsigned int headerWidth;
789 unsigned int headerHeight;
790 if( LoadJpegHeader( fp, headerWidth, headerHeight ) )
792 JPGFORM_CODE transform = JPGFORM_NONE;
794 if( attributes.GetOrientationCorrection() )
796 ExifAutoPtr exifData( LoadExifData( fp ) );
799 transform = ConvertExifOrientation(exifData.mData);
802 int preXformImageWidth = headerWidth;
803 int preXformImageHeight = headerHeight;
804 int postXformImageWidth = headerWidth;
805 int postXformImageHeight = headerHeight;
807 success = TransformSize(requiredWidth, requiredHeight, transform, preXformImageWidth, preXformImageHeight, postXformImageWidth, postXformImageHeight);
810 width = postXformImageWidth;
811 height = postXformImageHeight;
818 height = headerHeight;
826 } // namespace TizenPlatform