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 <resource-loader/debug/resource-loader-debug.h>
23 #include "platform-capabilities.h"
26 #include <libexif/exif-data.h>
27 #include <libexif/exif-loader.h>
28 #include <libexif/exif-tag.h>
29 #include <turbojpeg.h>
37 using Integration::Bitmap;
39 namespace TizenPlatform
44 const unsigned DECODED_PIXEL_SIZE = 3;
45 const TJPF DECODED_PIXEL_LIBJPEG_TYPE = TJPF_RGB;
47 /** Transformations that can be applied to decoded pixels to respect exif orientation
48 * codes in image headers */
51 JPGFORM_NONE = 1, /* no transformation 0th-Row = top & 0th-Column = left */
52 JPGFORM_FLIP_H, /* horizontal flip 0th-Row = top & 0th-Column = right */
53 JPGFORM_FLIP_V, /* vertical flip 0th-Row = bottom & 0th-Column = right*/
54 JPGFORM_TRANSPOSE, /* transpose across UL-to-LR axis 0th-Row = bottom & 0th-Column = left*/
55 JPGFORM_TRANSVERSE,/* transpose across UR-to-LL axis 0th-Row = left & 0th-Column = top*/
56 JPGFORM_ROT_90, /* 90-degree clockwise rotation 0th-Row = right & 0th-Column = top*/
57 JPGFORM_ROT_180, /* 180-degree rotation 0th-Row = right & 0th-Column = bottom*/
58 JPGFORM_ROT_270 /* 270-degree clockwise (or 90 ccw) 0th-Row = left & 0th-Column = bottom*/
69 * @brief Error handling bookeeping for the JPEG Turbo library's
70 * setjmp/longjmp simulated exceptions.
72 struct JpegErrorState {
73 struct jpeg_error_mgr errorManager;
78 * @brief Called by the JPEG library when it hits an error.
79 * We jump out of the library so our loader code can return an error.
81 void JpegErrorHandler ( j_common_ptr cinfo )
83 DALI_LOG_ERROR( "JpegErrorHandler(): libjpeg-turbo fatal error in JPEG decoding.\n" );
84 /* cinfo->err really points to a JpegErrorState struct, so coerce pointer */
85 JpegErrorState * myerr = reinterpret_cast<JpegErrorState *>( cinfo->err );
87 /* Return control to the setjmp point */
88 longjmp( myerr->jumpBuffer, 1 );
91 void JpegOutputMessageHandler( j_common_ptr cinfo )
93 /* Stop libjpeg from printing to stderr - Do Nothing */
96 /** Simple struct to ensure xif data is deleted. */
99 ExifAutoPtr( ExifData* data)
105 exif_data_free( mData);
110 /** simple class to enforce clean-up of JPEG structures. */
113 AutoJpg(const tjhandle jpgHandle)
120 // clean up JPG resources
124 tjhandle GetHandle() const
130 AutoJpg( const AutoJpg& ); //< not defined
131 AutoJpg& operator= ( const AutoJpg& ); //< not defined
134 }; // struct AutoJpg;
136 /** RAII wrapper to free memory allocated by the jpeg-turbo library. */
139 AutoJpgMem(unsigned char * const tjMem)
149 unsigned char * Get() const
155 AutoJpgMem( const AutoJpgMem& ); //< not defined
156 AutoJpgMem& operator= ( const AutoJpgMem& ); //< not defined
158 unsigned char * const mTjMem;
161 // Workaround to avoid exceeding the maximum texture size
162 const int MAX_TEXTURE_WIDTH = 4096;
163 const int MAX_TEXTURE_HEIGHT = 4096;
167 bool JpegRotate90 (unsigned char *buffer, int width, int height, int bpp);
168 bool JpegRotate180(unsigned char *buffer, int width, int height, int bpp);
169 bool JpegRotate270(unsigned char *buffer, int width, int height, int bpp);
170 JPGFORM_CODE ConvertExifOrientation(ExifData* exifData);
171 bool TransformSize( int requiredWidth, int requiredHeight, JPGFORM_CODE transform,
172 int& preXformImageWidth, int& preXformImageHeight,
173 int& postXformImageWidth, int& postXformImageHeight );
175 bool LoadJpegHeader( FILE *fp, unsigned int &width, unsigned int &height )
177 // using libjpeg API to avoid having to read the whole file in a buffer
178 struct jpeg_decompress_struct cinfo;
179 struct JpegErrorState jerr;
180 cinfo.err = jpeg_std_error( &jerr.errorManager );
182 jerr.errorManager.output_message = JpegOutputMessageHandler;
183 jerr.errorManager.error_exit = JpegErrorHandler;
185 // On error exit from the JPEG lib, control will pass via JpegErrorHandler
186 // into this branch body for cleanup and error return:
187 if(setjmp(jerr.jumpBuffer))
189 jpeg_destroy_decompress(&cinfo);
193 jpeg_create_decompress( &cinfo );
195 jpeg_stdio_src( &cinfo, fp );
197 // Check header to see if it is JPEG file
198 if( jpeg_read_header( &cinfo, TRUE ) != JPEG_HEADER_OK )
201 jpeg_destroy_decompress( &cinfo );
205 width = cinfo.image_width;
206 height = cinfo.image_height;
208 jpeg_destroy_decompress( &cinfo );
212 bool LoadBitmapFromJpeg( const ResourceLoadingClient& client, const ImageLoader::Input& input, Integration::Bitmap& bitmap )
215 FILE* const fp = input.file;
217 if( fseek(fp,0,SEEK_END) )
219 DALI_LOG_ERROR("Error seeking to end of file\n");
223 long positionIndicator = ftell(fp);
224 unsigned int jpegBufferSize = 0u;
225 if( positionIndicator > -1L )
227 jpegBufferSize = static_cast<unsigned int>(positionIndicator);
230 if( 0u == jpegBufferSize )
235 if( fseek(fp, 0, SEEK_SET) )
237 DALI_LOG_ERROR("Error seeking to start of file\n");
241 std::vector<unsigned char> jpegBuffer(0);
244 jpegBuffer.reserve( jpegBufferSize );
248 DALI_LOG_ERROR( "Could not allocate temporary memory to hold JPEG file of size %uMB.\n", jpegBufferSize / 1048576U );
251 unsigned char * const jpegBufferPtr = &jpegBuffer[0];
253 // Pull the compressed JPEG image bytes out of a file and into memory:
254 if( fread( jpegBufferPtr, 1, jpegBufferSize, fp ) != jpegBufferSize )
256 DALI_LOG_WARNING("Error on image file read.");
260 if( fseek(fp, 0, SEEK_SET) )
262 DALI_LOG_ERROR("Error seeking to start of file\n");
265 // Allow early cancellation between the load and the decompress:
266 client.InterruptionPoint();
268 AutoJpg autoJpg(tjInitDecompress());
270 if(autoJpg.GetHandle() == NULL)
272 DALI_LOG_ERROR("%s\n", tjGetErrorStr());
276 JPGFORM_CODE transform = JPGFORM_NONE;
278 if( input.reorientationRequested )
280 ExifAutoPtr exifData( exif_data_new_from_data(jpegBufferPtr, jpegBufferSize) );
283 transform = ConvertExifOrientation(exifData.mData);
287 // Push jpeg data in memory buffer through TurboJPEG decoder to make a raw pixel array:
288 int chrominanceSubsampling = -1;
289 int preXformImageWidth = 0, preXformImageHeight = 0;
290 if( tjDecompressHeader2( autoJpg.GetHandle(), jpegBufferPtr, jpegBufferSize, &preXformImageWidth, &preXformImageHeight, &chrominanceSubsampling ) == -1 )
292 DALI_LOG_ERROR("%s\n", tjGetErrorStr());
293 // Do not set width and height to 0 or return early as this sometimes fails only on determining subsampling type.
296 if(preXformImageWidth == 0 || preXformImageHeight == 0)
298 DALI_LOG_WARNING("Invalid Image!");
302 int requiredWidth = input.scalingParameters.dimensions.GetWidth();
303 int requiredHeight = input.scalingParameters.dimensions.GetHeight();
305 // If transform is a 90 or 270 degree rotation, the logical width and height
306 // request from the client needs to be adjusted to account by effectively
307 // rotating that too, and the final width and height need to be swapped:
308 int postXformImageWidth = preXformImageWidth;
309 int postXformImageHeight = preXformImageHeight;
312 int scaledPreXformWidth = preXformImageWidth;
313 int scaledPreXformHeight = preXformImageHeight;
314 int scaledPostXformWidth = postXformImageWidth;
315 int scaledPostXformHeight = postXformImageHeight;
317 TransformSize( requiredWidth, requiredHeight, transform,
318 scaledPreXformWidth, scaledPreXformHeight,
319 scaledPostXformWidth, scaledPostXformHeight );
321 // Allocate a bitmap and decompress the jpeg buffer into its pixel buffer:
323 unsigned char * const bitmapPixelBuffer = bitmap.GetPackedPixelsProfile()->ReserveBuffer(Pixel::RGB888, scaledPostXformWidth, scaledPostXformHeight);
325 // Allow early cancellation before decoding:
326 client.InterruptionPoint();
328 const int pitch = scaledPreXformWidth * DECODED_PIXEL_SIZE;
329 if( tjDecompress2( autoJpg.GetHandle(), jpegBufferPtr, jpegBufferSize, bitmapPixelBuffer, scaledPreXformWidth, pitch, scaledPreXformHeight, DECODED_PIXEL_LIBJPEG_TYPE, flags ) == -1 )
331 DALI_LOG_ERROR("%s\n", tjGetErrorStr());
335 const unsigned int bufferWidth = GetTextureDimension( scaledPreXformWidth );
336 const unsigned int bufferHeight = GetTextureDimension( scaledPreXformHeight );
338 if( transform != JPGFORM_NONE )
340 // Allow early cancellation before shuffling pixels around on the CPU:
341 client.InterruptionPoint();
349 case JPGFORM_TRANSPOSE:
350 case JPGFORM_TRANSVERSE: ///!ToDo: None of these are supported!
352 DALI_LOG_WARNING( "Unsupported JPEG Orientation transformation: %x.\n", transform );
360 case JPGFORM_ROT_180:
362 result = JpegRotate180(bitmapPixelBuffer, bufferWidth, bufferHeight, DECODED_PIXEL_SIZE);
365 case JPGFORM_ROT_270:
367 result = JpegRotate270(bitmapPixelBuffer, bufferWidth, bufferHeight, DECODED_PIXEL_SIZE);
372 result = JpegRotate90(bitmapPixelBuffer, bufferWidth, bufferHeight, DECODED_PIXEL_SIZE);
379 ///@Todo: Move all these rotation functions to portable/image-operations and take "Jpeg" out of their names.
380 bool JpegRotate90(unsigned char *buffer, int width, int height, int bpp)
382 int w, iw, ih, hw = 0;
386 std::vector<unsigned char> data(width * height * bpp);
387 unsigned char *dataPtr = &data[0];
388 memcpy(dataPtr, buffer, width * height * bpp);
398 RGB888Type* to = reinterpret_cast<RGB888Type*>(buffer) + iw - 1;
399 RGB888Type* from = reinterpret_cast<RGB888Type*>( dataPtr );
401 for(ix = iw; -- ix >= 0;)
403 for(iy = ih; -- iy >= 0; ++from )
422 bool JpegRotate180(unsigned char *buffer, int width, int height, int bpp)
424 int ix, iw, ih, hw = 0;
435 RGB888Type* to = reinterpret_cast<RGB888Type*>(buffer) ;
436 RGB888Type* from = reinterpret_cast<RGB888Type*>( buffer ) + hw - 1;
437 for(; --ix >= (hw / 2); ++to, --from)
455 bool JpegRotate270(unsigned char *buffer, int width, int height, int bpp)
457 int w, iw, ih, hw = 0;
462 std::vector<unsigned char> data(width * height * bpp);
463 unsigned char *dataPtr = &data[0];
464 memcpy(dataPtr, buffer, width * height * bpp);
474 RGB888Type* to = reinterpret_cast<RGB888Type*>(buffer) + hw - iw;
475 RGB888Type* from = reinterpret_cast<RGB888Type*>( dataPtr );
479 for(ix = iw; -- ix >= 0;)
481 for(iy = ih; -- iy >= 0;)
500 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)
504 DALI_LOG_ERROR("Null input buffer\n");
508 // Translate pixel format enum:
509 int jpegPixelFormat = -1;
511 switch( pixelFormat )
515 jpegPixelFormat = TJPF_RGB;
518 case Pixel::RGBA8888:
521 jpegPixelFormat = TJPF_RGBX;
524 case Pixel::BGRA8888:
527 jpegPixelFormat = TJPF_BGRX;
532 DALI_LOG_ERROR( "Unsupported pixel format for encoding to JPEG." );
537 // Assert quality is in the documented allowable range of the jpeg-turbo lib:
538 DALI_ASSERT_DEBUG( quality >= 1 );
539 DALI_ASSERT_DEBUG( quality <= 100 );
549 // Initialise a JPEG codec:
550 AutoJpg autoJpg( tjInitCompress() );
552 if( autoJpg.GetHandle() == NULL )
554 DALI_LOG_ERROR( "JPEG Compressor init failed: %s\n", tjGetErrorStr() );
558 // Run the compressor:
559 unsigned char* dstBuffer = NULL;
560 unsigned long dstBufferSize = 0;
563 if( tjCompress2( autoJpg.GetHandle(), const_cast<unsigned char*>(pixelBuffer), width, 0, height, jpegPixelFormat, &dstBuffer, &dstBufferSize, TJSAMP_444, quality, flags ) )
565 DALI_LOG_ERROR("JPEG Compression failed: %s\n", tjGetErrorStr());
569 // Safely wrap the jpeg codec's buffer in case we are about to throw, then
570 // save the pixels to a persistent buffer that we own and let our cleaner
571 // class clean up the buffer as it goes out of scope:
572 AutoJpgMem cleaner(dstBuffer);
573 encodedPixels.resize(dstBufferSize);
574 memcpy(&encodedPixels[0], dstBuffer, dstBufferSize);
580 JPGFORM_CODE ConvertExifOrientation(ExifData* exifData)
582 JPGFORM_CODE transform = JPGFORM_NONE;
583 ExifEntry * const entry = exif_data_get_entry(exifData, EXIF_TAG_ORIENTATION);
587 orientation = exif_get_short(entry->data, exif_data_get_byte_order(entry->parent->parent));
588 switch( orientation )
592 transform = JPGFORM_NONE;
597 transform = JPGFORM_FLIP_H;
602 transform = JPGFORM_FLIP_V;
607 transform = JPGFORM_TRANSPOSE;
612 transform = JPGFORM_TRANSVERSE;
617 transform = JPGFORM_ROT_90;
622 transform = JPGFORM_ROT_180;
627 transform = JPGFORM_ROT_270;
632 // Try to keep loading the file, but let app developer know there was something fishy:
633 DALI_LOG_WARNING( "Incorrect/Unknown Orientation setting found in EXIF header of JPEG image (%x). Orientation setting will be ignored.", entry );
641 bool TransformSize( int requiredWidth, int requiredHeight, JPGFORM_CODE transform,
642 int& preXformImageWidth, int& preXformImageHeight,
643 int& postXformImageWidth, int& postXformImageHeight )
647 if( transform == JPGFORM_ROT_90 || transform == JPGFORM_ROT_270 )
649 std::swap( requiredWidth, requiredHeight );
650 std::swap( postXformImageWidth, postXformImageHeight );
653 // Rescale image during decode using one of the decoder's built-in rescaling
654 // ratios (expected to be powers of 2), keeping the final image at least as
655 // wide and high as was requested:
658 tjscalingfactor* factors = tjGetScalingFactors( &numFactors );
659 if( factors == NULL )
661 DALI_LOG_WARNING("TurboJpeg tjGetScalingFactors error!");
666 // Find nearest supported scaling factor (factors are in sequential order, getting smaller)
667 int scaleFactorIndex( 0 );
668 for( int i = 1; i < numFactors; ++i )
670 // if requested width or height set to 0, ignore value
671 // TJSCALED performs an integer-based ceil operation on (dim*factor)
672 if( (requiredWidth && TJSCALED(postXformImageWidth , (factors[i])) > requiredWidth) ||
673 (requiredHeight && TJSCALED(postXformImageHeight, (factors[i])) > requiredHeight) )
675 scaleFactorIndex = i;
679 // This scaling would result in an image that was smaller than requested in both
680 // dimensions, so stop at the previous entry.
685 // Workaround for libjpeg-turbo problem adding a green line on one edge
686 // when downscaling to 1/8 in each dimension. Prefer not to scale to less than
687 // 1/4 in each dimension:
688 if( 2 < scaleFactorIndex )
690 scaleFactorIndex = 2;
691 DALI_LOG_INFO( gLoaderFilter, Debug::General, "Down-scaling requested for image limited to 1/4.\n" );
694 // Regardless of requested size, downscale to avoid exceeding the maximum texture size
695 for( int i = scaleFactorIndex; i < numFactors; ++i )
697 // Continue downscaling to below maximum texture size (if possible)
698 scaleFactorIndex = i;
700 if( TJSCALED(postXformImageWidth, (factors[i])) < MAX_TEXTURE_WIDTH &&
701 TJSCALED(postXformImageHeight, (factors[i])) < MAX_TEXTURE_HEIGHT )
703 // Current scale-factor downscales to below maximum texture size
708 // We have finally chosen the scale-factor, return width/height values
709 if( scaleFactorIndex > 0 )
711 preXformImageWidth = TJSCALED(preXformImageWidth, (factors[scaleFactorIndex]));
712 preXformImageHeight = TJSCALED(preXformImageHeight, (factors[scaleFactorIndex]));
713 postXformImageWidth = TJSCALED(postXformImageWidth, (factors[scaleFactorIndex]));
714 postXformImageHeight = TJSCALED(postXformImageHeight, (factors[scaleFactorIndex]));
721 ExifData* LoadExifData( FILE* fp )
723 ExifData* exifData=NULL;
724 ExifLoader* exifLoader;
725 unsigned char dataBuffer[1024];
727 if( fseek( fp, 0, SEEK_SET ) )
729 DALI_LOG_ERROR("Error seeking to start of file\n");
733 exifLoader = exif_loader_new ();
737 int size = fread( dataBuffer, 1, sizeof( dataBuffer ), fp );
742 if( ! exif_loader_write( exifLoader, dataBuffer, size ) )
748 exifData = exif_loader_get_data( exifLoader );
749 exif_loader_unref( exifLoader );
755 bool LoadJpegHeader( const ImageLoader::Input& input, unsigned int& width, unsigned int& height )
757 unsigned int requiredWidth = input.scalingParameters.dimensions.GetWidth();
758 unsigned int requiredHeight = input.scalingParameters.dimensions.GetHeight();
759 FILE* const fp = input.file;
761 bool success = false;
762 if( requiredWidth == 0 && requiredHeight == 0 )
764 success = LoadJpegHeader( fp, width, height );
768 // Double check we get the same width/height from the header
769 unsigned int headerWidth;
770 unsigned int headerHeight;
771 if( LoadJpegHeader( fp, headerWidth, headerHeight ) )
773 JPGFORM_CODE transform = JPGFORM_NONE;
775 if( input.reorientationRequested )
777 ExifAutoPtr exifData( LoadExifData( fp ) );
780 transform = ConvertExifOrientation(exifData.mData);
783 int preXformImageWidth = headerWidth;
784 int preXformImageHeight = headerHeight;
785 int postXformImageWidth = headerWidth;
786 int postXformImageHeight = headerHeight;
788 success = TransformSize(requiredWidth, requiredHeight, transform, preXformImageWidth, preXformImageHeight, postXformImageWidth, postXformImageHeight);
791 width = postXformImageWidth;
792 height = postXformImageHeight;
799 height = headerHeight;
807 } // namespace TizenPlatform