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.
17 #include "image-loader.h"
19 #include <dali/devel-api/common/ref-counted-dali-vector.h>
20 #include <dali/integration-api/bitmap.h>
21 #include <dali/integration-api/debug.h>
23 #include "loader-astc.h"
24 #include "loader-bmp.h"
25 #include "loader-gif.h"
26 #include "loader-ico.h"
27 #include "loader-jpeg.h"
28 #include "loader-ktx.h"
29 #include "loader-png.h"
30 #include "loader-wbmp.h"
31 #include "image-operations.h"
32 #include "image-loader-input.h"
33 #include "portable/file-reader.h"
35 using namespace Dali::Integration;
39 namespace TizenPlatform
44 typedef bool (*LoadBitmapFunction)( const ImageLoader::Input& input, Integration::Bitmap& bitmap );
45 typedef bool (*LoadBitmapHeaderFunction)( const ImageLoader::Input& input, unsigned int& width, unsigned int& height );
47 #if defined(DEBUG_ENABLED)
48 Integration::Log::Filter* gLogFilter = Debug::Filter::New( Debug::Concise, false, "LOG_IMAGE_LOADING" );
52 * Stores the magic bytes, and the loader and header functions used for each image loader.
56 unsigned char magicByte1; ///< The first byte in the file should be this
57 unsigned char magicByte2; ///< The second byte in the file should be this
58 LoadBitmapFunction loader; ///< The function which decodes the file
59 LoadBitmapHeaderFunction header; ///< The function which decodes the header of the file
60 Bitmap::Profile profile; ///< The kind of bitmap to be created
61 /// (addressable packed pixels or an opaque compressed blob).
65 * Enum for file formats, has to be in sync with BITMAP_LOADER_LOOKUP_TABLE
69 // Unknown file format
72 // formats that use magic bytes
80 FORMAT_MAGIC_BYTE_COUNT,
82 // formats after this one do not use magic bytes
83 FORMAT_WBMP = FORMAT_MAGIC_BYTE_COUNT,
88 * A lookup table containing all the bitmap loaders with the appropriate information.
89 * Has to be in sync with enum FileFormats
91 const BitmapLoader BITMAP_LOADER_LOOKUP_TABLE[FORMAT_TOTAL_COUNT] =
93 { Png::MAGIC_BYTE_1, Png::MAGIC_BYTE_2, LoadBitmapFromPng, LoadPngHeader, Bitmap::BITMAP_2D_PACKED_PIXELS },
94 { Jpeg::MAGIC_BYTE_1, Jpeg::MAGIC_BYTE_2, LoadBitmapFromJpeg, LoadJpegHeader, Bitmap::BITMAP_2D_PACKED_PIXELS },
95 { Bmp::MAGIC_BYTE_1, Bmp::MAGIC_BYTE_2, LoadBitmapFromBmp, LoadBmpHeader, Bitmap::BITMAP_2D_PACKED_PIXELS },
96 { Gif::MAGIC_BYTE_1, Gif::MAGIC_BYTE_2, LoadBitmapFromGif, LoadGifHeader, Bitmap::BITMAP_2D_PACKED_PIXELS },
97 { Ktx::MAGIC_BYTE_1, Ktx::MAGIC_BYTE_2, LoadBitmapFromKtx, LoadKtxHeader, Bitmap::BITMAP_COMPRESSED },
98 { Astc::MAGIC_BYTE_1, Astc::MAGIC_BYTE_2, LoadBitmapFromAstc, LoadAstcHeader, Bitmap::BITMAP_COMPRESSED },
99 { Ico::MAGIC_BYTE_1, Ico::MAGIC_BYTE_2, LoadBitmapFromIco, LoadIcoHeader, Bitmap::BITMAP_2D_PACKED_PIXELS },
100 { 0x0, 0x0, LoadBitmapFromWbmp, LoadWbmpHeader, Bitmap::BITMAP_2D_PACKED_PIXELS },
103 const unsigned int MAGIC_LENGTH = 2;
106 * This code tries to predict the file format from the filename to help with format picking.
108 struct FormatExtension
110 const std::string extension;
114 const FormatExtension FORMAT_EXTENSIONS[] =
116 { ".png", FORMAT_PNG },
117 { ".jpg", FORMAT_JPEG },
118 { ".bmp", FORMAT_BMP },
119 { ".gif", FORMAT_GIF },
120 { ".ktx", FORMAT_KTX },
121 { ".astc", FORMAT_ASTC },
122 { ".ico", FORMAT_ICO },
123 { ".wbmp", FORMAT_WBMP }
126 const unsigned int FORMAT_EXTENSIONS_COUNT = sizeof(FORMAT_EXTENSIONS) / sizeof(FormatExtension);
128 FileFormats GetFormatHint( const std::string& filename )
130 FileFormats format = FORMAT_UNKNOWN;
132 for ( unsigned int i = 0; i < FORMAT_EXTENSIONS_COUNT; ++i )
134 unsigned int length = FORMAT_EXTENSIONS[i].extension.size();
135 if ( ( filename.size() > length ) &&
136 ( 0 == filename.compare( filename.size() - length, length, FORMAT_EXTENSIONS[i].extension ) ) )
138 format = FORMAT_EXTENSIONS[i].format;
147 * Checks the magic bytes of the file first to determine which Image decoder to use to decode the
149 * @param[in] fp The file to decode
150 * @param[in] format Hint about what format to try first
151 * @param[out] loader Set with the function to use to decode the image
152 * @param[out] header Set with the function to use to decode the header
153 * @param[out] profile The kind of bitmap to hold the bits loaded for the bitmap.
154 * @return true, if we can decode the image, false otherwise
156 bool GetBitmapLoaderFunctions( FILE *fp,
158 LoadBitmapFunction& loader,
159 LoadBitmapHeaderFunction& header,
160 Bitmap::Profile& profile )
162 unsigned char magic[MAGIC_LENGTH];
163 size_t read = fread(magic, sizeof(unsigned char), MAGIC_LENGTH, fp);
165 // Reset to the start of the file.
166 if( fseek(fp, 0, SEEK_SET) )
168 DALI_LOG_ERROR("Error seeking to start of file\n");
171 if (read != MAGIC_LENGTH)
176 bool loaderFound = false;
177 const BitmapLoader *lookupPtr = BITMAP_LOADER_LOOKUP_TABLE;
178 ImageLoader::Input defaultInput( fp );
180 // try hinted format first
181 if ( format != FORMAT_UNKNOWN )
183 lookupPtr = BITMAP_LOADER_LOOKUP_TABLE + format;
184 if ( format >= FORMAT_MAGIC_BYTE_COUNT ||
185 ( lookupPtr->magicByte1 == magic[0] && lookupPtr->magicByte2 == magic[1] ) )
187 unsigned int width = 0;
188 unsigned int height = 0;
189 loaderFound = lookupPtr->header( fp, width, height );
193 // then try to get a match with formats that have magic bytes
194 if ( false == loaderFound )
196 for ( lookupPtr = BITMAP_LOADER_LOOKUP_TABLE;
197 lookupPtr < BITMAP_LOADER_LOOKUP_TABLE + FORMAT_MAGIC_BYTE_COUNT;
200 if ( lookupPtr->magicByte1 == magic[0] && lookupPtr->magicByte2 == magic[1] )
202 // to seperate ico file format and wbmp file format
203 unsigned int width = 0;
204 unsigned int height = 0;
205 loaderFound = lookupPtr->header(fp, width, height);
214 // finally try formats that do not use magic bytes
215 if ( false == loaderFound )
217 for ( lookupPtr = BITMAP_LOADER_LOOKUP_TABLE + FORMAT_MAGIC_BYTE_COUNT;
218 lookupPtr < BITMAP_LOADER_LOOKUP_TABLE + FORMAT_TOTAL_COUNT;
221 // to seperate ico file format and wbmp file format
222 unsigned int width = 0;
223 unsigned int height = 0;
224 loaderFound = lookupPtr->header(fp, width, height);
232 // if a loader was found set the outputs
235 loader = lookupPtr->loader;
236 header = lookupPtr->header;
237 profile = lookupPtr->profile;
240 // Reset to the start of the file.
241 if( fseek(fp, 0, SEEK_SET) )
243 DALI_LOG_ERROR("Error seeking to start of file\n");
249 } // anonymous namespace
252 namespace ImageLoader
255 bool ConvertStreamToBitmap( const BitmapResourceType& resource, std::string path, FILE * const fp, BitmapPtr& ptr )
257 DALI_LOG_TRACE_METHOD( gLogFilter );
260 BitmapPtr bitmap = 0;
264 LoadBitmapFunction function;
265 LoadBitmapHeaderFunction header;
266 Bitmap::Profile profile;
268 if ( GetBitmapLoaderFunctions( fp,
269 GetFormatHint( path ),
274 bitmap = Bitmap::New( profile, ResourcePolicy::OWNED_DISCARD );
276 DALI_LOG_SET_OBJECT_STRING( bitmap, path );
277 const ScalingParameters scalingParameters( resource.size, resource.scalingMode, resource.samplingMode );
278 const ImageLoader::Input input( fp, scalingParameters, resource.orientationCorrection );
280 // Run the image type decoder:
281 result = function( input, *bitmap );
285 DALI_LOG_WARNING( "Unable to convert %s\n", path.c_str() );
289 bitmap = Internal::Platform::ApplyAttributesToBitmap( bitmap, resource.size, resource.scalingMode, resource.samplingMode );
293 DALI_LOG_WARNING( "Image Decoder for %s unavailable\n", path.c_str() );
297 ptr.Reset( bitmap.Get() );
301 ResourcePointer LoadImageSynchronously( const Integration::BitmapResourceType& resource, const std::string& path )
303 ResourcePointer result;
304 BitmapPtr bitmap = 0;
306 Internal::Platform::FileReader fileReader( path );
307 FILE * const fp = fileReader.GetFile();
310 bool success = ConvertStreamToBitmap( resource, path, fp, bitmap );
311 if( success && bitmap )
313 result.Reset(bitmap.Get());
319 ///@ToDo: Rename GetClosestImageSize() functions. Make them use the orientation correction and scaling information. Requires jpeg loader to tell us about reorientation. [Is there still a requirement for this functionality at all?]
320 ImageDimensions GetClosestImageSize( const std::string& filename,
321 ImageDimensions size,
322 FittingMode::Type fittingMode,
323 SamplingMode::Type samplingMode,
324 bool orientationCorrection )
326 unsigned int width = 0;
327 unsigned int height = 0;
329 Internal::Platform::FileReader fileReader( filename );
330 FILE *fp = fileReader.GetFile();
333 LoadBitmapFunction loaderFunction;
334 LoadBitmapHeaderFunction headerFunction;
335 Bitmap::Profile profile;
337 if ( GetBitmapLoaderFunctions( fp,
338 GetFormatHint(filename),
343 const ImageLoader::Input input( fp, ScalingParameters( size, fittingMode, samplingMode ), orientationCorrection );
345 const bool read_res = headerFunction( input, width, height );
348 DALI_LOG_WARNING("Image Decoder failed to read header for %s\n", filename.c_str());
353 DALI_LOG_WARNING("Image Decoder for %s unavailable\n", filename.c_str());
356 return ImageDimensions( width, height );
359 ImageDimensions GetClosestImageSize( Integration::ResourcePointer resourceBuffer,
360 ImageDimensions size,
361 FittingMode::Type fittingMode,
362 SamplingMode::Type samplingMode,
363 bool orientationCorrection )
365 unsigned int width = 0;
366 unsigned int height = 0;
368 // Get the blob of binary data that we need to decode:
369 DALI_ASSERT_DEBUG( resourceBuffer );
370 Dali::RefCountedVector<uint8_t>* const encodedBlob = reinterpret_cast<Dali::RefCountedVector<uint8_t>*>( resourceBuffer.Get() );
372 if( encodedBlob != 0 )
374 if( encodedBlob->GetVector().Size() )
376 // Open a file handle on the memory buffer:
377 Internal::Platform::FileReader fileReader( encodedBlob->GetVector() );
378 FILE *fp = fileReader.GetFile();
381 LoadBitmapFunction loaderFunction;
382 LoadBitmapHeaderFunction headerFunction;
383 Bitmap::Profile profile;
385 if ( GetBitmapLoaderFunctions( fp,
391 const ImageLoader::Input input( fp, ScalingParameters( size, fittingMode, samplingMode ), orientationCorrection );
392 const bool read_res = headerFunction( input, width, height );
395 DALI_LOG_WARNING( "Image Decoder failed to read header for resourceBuffer\n" );
401 return ImageDimensions( width, height );