platform-abstractions/tizen/image-loaders/loader-gif.h

   1 #ifndef __DALI_TIZEN_PLATFORM_LOADER_GIF_H__
   2 #define __DALI_TIZEN_PLATFORM_LOADER_GIF_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 #include <cstdio>
  22 #include "image-loader-input.h"
  23
  24 namespace Dali
  25 {
  26
  27 namespace Integration
  28 {
  29   class Bitmap;
  30 }
  31
  32 struct ImageAttributes;
  33
  34 namespace TizenPlatform
  35 {
  36
  37 class ResourceLoadingClient;
  38
  39 namespace Gif
  40 {
  41 const unsigned char MAGIC_BYTE_1 = 0x47;
  42 const unsigned char MAGIC_BYTE_2 = 0x49;
  43 } // namespace Gif
  44
  45 /**
  46  * Loads the bitmap from a GIF file.  This function checks the header first
  47  * and if it is not a GIF file, then it returns straight away.
  48  * @note For animated GIFs, only the first image is displayed
  49  * @param[in]  fp      Pointer to the Image file
  50  * @param[in]  bitmap  The bitmap class where the decoded image will be stored
  51  * @param[in]  attributes  Describes the dimensions, pixel format and other details for loading the image data
  52  * @return  true if file decoded successfully, false otherwise
  53  */
  54 bool LoadBitmapFromGif( const ResourceLoadingClient& client, const ImageLoader::Input& input, Integration::Bitmap& bitmap );
  55
  56 /**
  57  * Loads the header of a GIF file and fills in the width and height appropriately.
  58  * @param[in]   fp      Pointer to the Image file
  59  * @param[in]  attributes  Describes the dimensions, pixel format and other details for loading the image data
  60  * @param[in/out]  width   Is set with the width of the image
  61  * @param[in/out]  height  Is set with the height of the image
  62  * @return true if the file's header was read successully, false otherwise
  63  */
  64 bool LoadGifHeader( const ImageLoader::Input& input, unsigned int& width, unsigned int& height );
  65
  66 } // namespace TizenPlatform
  67
  68 } // namespace Dali
  69
  70 #endif // __DALI_TIZEN_PLATFORM_LOADER_GIF_H__