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
  23 namespace Dali
  24 {
  25
  26 namespace Integration
  27 {
  28   class Bitmap;
  29 }
  30
  31 struct ImageAttributes;
  32
  33 namespace TizenPlatform
  34 {
  35
  36 class ResourceLoadingClient;
  37
  38 namespace Gif
  39 {
  40 const unsigned char MAGIC_BYTE_1 = 0x47;
  41 const unsigned char MAGIC_BYTE_2 = 0x49;
  42 } // namespace Gif
  43
  44 /**
  45  * Loads the bitmap from a GIF file.  This function checks the header first
  46  * and if it is not a GIF file, then it returns straight away.
  47  * @note For animated GIFs, only the first image is displayed
  48  * @param[in]  fp      Pointer to the Image file
  49  * @param[in]  bitmap  The bitmap class where the decoded image will be stored
  50  * @param[in]  attributes  Describes the dimensions, pixel format and other details for loading the image data
  51  * @return  true if file decoded successfully, false otherwise
  52  */
  53 bool LoadBitmapFromGif( FILE *fp, Integration::Bitmap& bitmap, ImageAttributes& attributes, const ResourceLoadingClient& client );
  54
  55 /**
  56  * Loads the header of a GIF file and fills in the width and height appropriately.
  57  * @param[in]   fp      Pointer to the Image file
  58  * @param[in]  attributes  Describes the dimensions, pixel format and other details for loading the image data
  59  * @param[in/out]  width   Is set with the width of the image
  60  * @param[in/out]  height  Is set with the height of the image
  61  * @return true if the file's header was read successully, false otherwise
  62  */
  63 bool LoadGifHeader(FILE *fp, const ImageAttributes& attributes, unsigned int &width, unsigned int &height );
  64
  65 } // namespace TizenPlatform
  66
  67 } // namespace Dali
  68
  69 #endif // __DALI_TIZEN_PLATFORM_LOADER_GIF_H__