dali/internal/imaging/common/loader-pkm.h

   1 #ifndef DALI_TIZEN_PLATFORM_LOADER_PKM_H
   2 #define DALI_TIZEN_PLATFORM_LOADER_PKM_H
   3
   4 /*
   5  * Copyright (c) 2023 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 <dali/devel-api/adaptor-framework/image-loader-input.h>
  22
  23 namespace Dali
  24 {
  25 namespace Devel
  26 {
  27 class PixelBuffer;
  28 }
  29
  30 namespace TizenPlatform
  31 {
  32 class ResourceLoadingClient;
  33
  34 namespace Pkm
  35 {
  36 const unsigned char MAGIC_BYTE_1 = 0x50;
  37 const unsigned char MAGIC_BYTE_2 = 0x4B;
  38 } // namespace Pkm
  39
  40 /**
  41  * Loads a compressed bitmap image from a PKM file without decoding it.
  42  * This function checks the header first
  43  * and if it is not a PKM file, or the header contents are invalid, it will return a failure.
  44  * @param[in]  input  Information about the input image (including file pointer)
  45  * @param[out] bitmap The bitmap class where the decoded image will be stored
  46  * @return True if file loaded successfully, false otherwise
  47  */
  48 bool LoadBitmapFromPkm(const Dali::ImageLoader::Input& input, Dali::Devel::PixelBuffer& bitmap);
  49
  50 /**
  51  * Loads the header of a PKM file and fills in the width and height appropriately.
  52  * @param[in]  input  Information about the input image (including file pointer)
  53  * @param[out] width  Is set with the width of the image
  54  * @param[out] height Is set with the height of the image
  55  * @return            True if the header was read successfully, false otherwise
  56  */
  57 bool LoadPkmHeader(const Dali::ImageLoader::Input& input, unsigned int& width, unsigned int& height);
  58
  59 } // namespace TizenPlatform
  60
  61 } // namespace Dali
  62
  63 #endif // DALI_TIZEN_PLATFORM_LOADER_PKM_H