dali/devel-api/adaptor-framework/image-loader-input.h

   1 #ifndef DALI_TIZEN_PLATFORM_IMAGE_LOADER_INPUT_H
   2 #define DALI_TIZEN_PLATFORM_IMAGE_LOADER_INPUT_H
   3
   4 /*
   5  * Copyright (c) 2022 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 // EXTERNAL INCLUDES
  21 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  22 #include <dali/integration-api/bitmap.h>
  23 #include <dali/public-api/images/image-operations.h>
  24 #include <cstdio>
  25
  26 // INTERNAL INCLUDES
  27
  28 namespace Dali
  29 {
  30 namespace ImageLoader
  31 {
  32 /**
  33  * @brief A simple immutable struct to bundle together parameters for scaling an image.
  34  */
  35 class ScalingParameters
  36 {
  37 public:
  38   ScalingParameters(ImageDimensions dimensions = ImageDimensions(), FittingMode::Type fittingMode = FittingMode::DEFAULT, SamplingMode::Type samplingMode = SamplingMode::DEFAULT)
  39   : dimensions(dimensions),
  40     scalingMode(fittingMode),
  41     samplingMode(samplingMode)
  42   {
  43   }
  44   const ImageDimensions    dimensions;
  45   const FittingMode::Type  scalingMode;
  46   const SamplingMode::Type samplingMode;
  47 };
  48
  49 /**
  50    * @brief Bundle-up the data pushed into an image loader.
  51    */
  52 struct Input
  53 {
  54   Input(FILE* file, ScalingParameters scalingParameters = ScalingParameters(), bool reorientationRequested = true)
  55   : file(file),
  56     scalingParameters(scalingParameters),
  57     reorientationRequested(reorientationRequested)
  58   {
  59   }
  60   FILE*             file;
  61   ScalingParameters scalingParameters;
  62   bool              reorientationRequested;
  63 };
  64
  65 using LoadBitmapFunction       = bool (*)(const Dali::ImageLoader::Input& input, Dali::Devel::PixelBuffer& pixelData);
  66 using LoadPlanesFunction       = bool (*)(const Dali::ImageLoader::Input& input, std::vector<Dali::Devel::PixelBuffer>& pixelBuffers);
  67 using LoadBitmapHeaderFunction = bool (*)(const Dali::ImageLoader::Input& input, unsigned int& width, unsigned int& height);
  68
  69 /**
  70  * Stores the magic bytes, and the loader and header functions used for each image loader.
  71  */
  72 struct BitmapLoader
  73 {
  74   unsigned char                      magicByte1;    ///< The first byte in the file should be this
  75   unsigned char                      magicByte2;    ///< The second byte in the file should be this
  76   LoadBitmapFunction                 loader;        ///< The function which decodes the file
  77   LoadPlanesFunction                 planeLoader;   ///< The function which decodes the file to each plane
  78   LoadBitmapHeaderFunction           header;        ///< The function which decodes the header of the file
  79   Dali::Integration::Bitmap::Profile profile;       ///< The kind of bitmap to be created
  80                                                     ///  (addressable packed pixels or an opaque compressed blob).
  81 };
  82
  83 } // namespace ImageLoader
  84 } // namespace Dali
  85
  86 #endif // DALI_TIZEN_PLATFORM_IMAGE_LOADER_INPUT_H