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.
18 #include "loader-gif.h"
23 #include <dali/integration-api/debug.h>
24 #include <dali/integration-api/bitmap.h>
26 // We need to check if giflib has the new open and close API (including error parameter).
28 #define LIBGIF_VERSION_5_1_OR_ABOVE
33 using Integration::Bitmap;
34 using Dali::Integration::PixelBuffer;
36 namespace TizenPlatform
42 // simple class to enforce clean-up of GIF structures
45 AutoCleanupGif(GifFileType*& _gifInfo)
54 // clean up GIF resources
55 #ifdef LIBGIF_VERSION_5_1_OR_ABOVE
56 int errorCode = 0; //D_GIF_SUCCEEDED is 0
57 DGifCloseFile( gifInfo, &errorCode );
61 DALI_LOG_ERROR( "GIF Loader: DGifCloseFile Error. Code: %d\n", errorCode );
64 DGifCloseFile( gifInfo );
69 GifFileType*& gifInfo;
72 // Simple class to enforce clean-up of PixelBuffer
73 struct AutoDeleteBuffer
75 AutoDeleteBuffer( PixelBuffer* _buffer )
88 // Used in the GIF interlace algorithm to determine the starting byte and the increment required
92 unsigned int startingByte;
93 unsigned int incrementalByte;
96 // Used in the GIF interlace algorithm to determine the order and which location to read data from
98 const InterlacePair INTERLACE_PAIR_TABLE [] = {
99 { 0, 8 }, // Starting at 0, read every 8 bytes.
100 { 4, 8 }, // Starting at 4, read every 8 bytes.
101 { 2, 4 }, // Starting at 2, read every 4 bytes.
102 { 1, 2 }, // Starting at 1, read every 2 bytes.
104 const unsigned int INTERLACE_PAIR_TABLE_SIZE( sizeof( INTERLACE_PAIR_TABLE ) / sizeof( InterlacePair ) );
106 /// Function used by Gif_Lib to read from the image file.
107 int ReadDataFromGif(GifFileType *gifInfo, GifByteType *data, int length)
109 FILE *fp = reinterpret_cast<FILE*>(gifInfo->UserData);
110 return fread( data, sizeof( GifByteType ), length, fp);
113 /// Loads the GIF Header.
114 bool LoadGifHeader(FILE *fp, unsigned int &width, unsigned int &height, GifFileType** gifInfo)
116 int errorCode = 0; //D_GIF_SUCCEEDED is 0
118 #ifdef LIBGIF_VERSION_5_1_OR_ABOVE
119 *gifInfo = DGifOpen( reinterpret_cast<void*>(fp), ReadDataFromGif, &errorCode );
121 *gifInfo = DGifOpen( reinterpret_cast<void*>(fp), ReadDataFromGif );
124 if ( !(*gifInfo) || errorCode )
126 DALI_LOG_ERROR( "GIF Loader: DGifOpen Error. Code: %d\n", errorCode );
130 width = (*gifInfo)->SWidth;
131 height = (*gifInfo)->SHeight;
133 // No proper size in GIF.
134 if ( width <= 0 || height <= 0 )
142 /// Decode the GIF image.
143 bool DecodeImage( GifFileType* gifInfo, PixelBuffer* decodedData, const unsigned int width, const unsigned int height, const unsigned int bytesPerRow )
145 if ( gifInfo->Image.Interlace )
147 // If the image is interlaced, then use the GIF interlace algorithm to read the file appropriately.
149 const InterlacePair* interlacePairPtr( INTERLACE_PAIR_TABLE );
150 for ( unsigned int interlacePair = 0; interlacePair < INTERLACE_PAIR_TABLE_SIZE; ++interlacePair, ++interlacePairPtr )
152 for( unsigned int currentByte = interlacePairPtr->startingByte; currentByte < height; currentByte += interlacePairPtr->incrementalByte )
154 PixelBuffer* row = decodedData + currentByte * bytesPerRow;
155 if ( DGifGetLine( gifInfo, row, width ) == GIF_ERROR )
157 DALI_LOG_ERROR( "GIF Loader: Error reading Interlaced GIF\n" );
165 // Non-interlace does not require any erratic reading / jumping.
166 PixelBuffer* decodedDataPtr( decodedData );
168 for ( unsigned int row = 0; row < height; ++row )
170 if ( DGifGetLine( gifInfo, decodedDataPtr, width ) == GIF_ERROR)
172 DALI_LOG_ERROR( "GIF Loader: Error reading non-interlaced GIF\n" );
175 decodedDataPtr += bytesPerRow;
181 // Retrieves the colors used in the GIF image.
182 GifColorType* GetImageColors( SavedImage* image, GifFileType* gifInfo )
184 GifColorType* color( NULL );
185 if ( image->ImageDesc.ColorMap )
187 color = image->ImageDesc.ColorMap->Colors;
191 // if there is no color map for this image use the default one
192 color = gifInfo->SColorMap->Colors;
197 /// Called when we want to handle IMAGE_DESC_RECORD_TYPE
198 bool HandleImageDescriptionRecordType( Bitmap& bitmap, GifFileType* gifInfo, unsigned int width, unsigned int height, bool& finished )
200 if ( DGifGetImageDesc( gifInfo ) == GIF_ERROR )
202 DALI_LOG_ERROR( "GIF Loader: Error getting Image Description\n" );
206 // Ensure there is at least 1 image in the GIF.
207 if ( gifInfo->ImageCount < 1 )
209 DALI_LOG_ERROR( "GIF Loader: No Images\n" );
213 SavedImage* image( &gifInfo->SavedImages[ gifInfo->ImageCount - 1 ] );
214 const GifImageDesc& desc( image->ImageDesc );
216 // Create a buffer to store the decoded data.
217 PixelBuffer* decodedData( new PixelBuffer[ width * height * sizeof( GifPixelType ) ] );
218 AutoDeleteBuffer autoDeleteBuffer( decodedData );
220 const unsigned int bytesPerRow( width * sizeof( GifPixelType ) );
221 const unsigned int actualWidth( desc.Width );
222 const unsigned int actualHeight( desc.Height );
224 // Decode the GIF Image
225 if ( !DecodeImage( gifInfo, decodedData, actualWidth, actualHeight, bytesPerRow ) )
230 // Get the colormap for the GIF
231 GifColorType* color( GetImageColors( image, gifInfo ) );
233 // If it's an animated GIF, we still only read the first image
235 // Create and populate pixel buffer.
237 Pixel::Format pixelFormat( Pixel::RGB888 );
238 PixelBuffer *pixels = bitmap.GetPackedPixelsProfile()->ReserveBuffer( pixelFormat, actualWidth, actualHeight );
240 for (unsigned int row = 0; row < actualHeight; ++row)
242 for (unsigned int column = 0; column < actualWidth; ++column)
244 unsigned char index = decodedData[row * width + column];
246 pixels[0] = color[index].Red;
247 pixels[1] = color[index].Green;
248 pixels[2] = color[index].Blue;
258 /// Called when we want to handle EXTENSION_RECORD_TYPE
259 bool HandleExtensionRecordType( GifFileType* gifInfo )
262 image.ExtensionBlocks = NULL;
263 image.ExtensionBlockCount = 0;
264 GifByteType *extensionByte( NULL );
266 #ifdef LIBGIF_VERSION_5_1_OR_ABOVE
267 int *extensionBlockTypePointer = &image.ExtensionBlocks->Function;
269 int *extensionBlockTypePointer = &image.Function;
272 // Not really interested in the extensions so just skip them unless there is an error.
273 for ( int extRetCode = DGifGetExtension( gifInfo, extensionBlockTypePointer, &extensionByte );
274 extensionByte != NULL;
275 extRetCode = DGifGetExtensionNext( gifInfo, &extensionByte ) )
277 if ( extRetCode == GIF_ERROR )
279 DALI_LOG_ERROR( "GIF Loader: Error reading GIF Extension record.\n" );
287 } // unnamed namespace
289 bool LoadGifHeader( const ImageLoader::Input& input, unsigned int& width, unsigned int& height )
291 GifFileType* gifInfo = NULL;
292 AutoCleanupGif autoCleanupGif(gifInfo);
293 FILE* const fp = input.file;
295 return LoadGifHeader(fp, width, height, &gifInfo);
298 bool LoadBitmapFromGif( const ResourceLoadingClient& client, const ImageLoader::Input& input, Integration::Bitmap& bitmap )
300 FILE* const fp = input.file;
301 // Load the GIF Header file.
303 GifFileType* gifInfo( NULL );
304 unsigned int width( 0 );
305 unsigned int height( 0 );
306 if ( !LoadGifHeader( fp, width, height, &gifInfo ) )
310 AutoCleanupGif autoGif( gifInfo );
312 // Check each record in the GIF file.
314 bool finished( false );
315 GifRecordType recordType( UNDEFINED_RECORD_TYPE );
316 for ( int returnCode = DGifGetRecordType( gifInfo, &recordType );
317 !finished && recordType != TERMINATE_RECORD_TYPE;
318 returnCode = DGifGetRecordType( gifInfo, &recordType ) )
320 if ( returnCode == GIF_ERROR )
322 DALI_LOG_ERROR( "GIF Loader: Error getting Record Type\n" );
326 if( IMAGE_DESC_RECORD_TYPE == recordType )
328 if ( !HandleImageDescriptionRecordType( bitmap, gifInfo, width, height, finished ) )
333 else if ( EXTENSION_RECORD_TYPE == recordType )
335 if ( !HandleExtensionRecordType( gifInfo ))
345 } // namespace TizenPlatform