automated-tests/src/dali-adaptor-internal/image-loaders.h

   1 /*
   2  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 #ifndef __DALI_ADAPTOR_TET_IMAGE_LOADERS_H_
  19 #define __DALI_ADAPTOR_TET_IMAGE_LOADERS_H_
  20
  21 #include <dali/dali.h>
  22 #include <dali/integration-api/bitmap.h>
  23 #include "platform-abstractions/tizen/image-loaders/image-loader-input.h"
  24
  25 // Simple structure to close the file when finished with it.
  26 struct AutoCloseFile
  27 {
  28   AutoCloseFile( FILE *fp );
  29   ~AutoCloseFile();
  30   FILE* filePtr;
  31 };
  32
  33 /// Structure to hold image details and the reference buffer.
  34 struct ImageDetails
  35 {
  36   /**
  37    * Normal Constructor.
  38    *
  39    * @param[in]  _name    The name of the image to open.  The reference buffer file should have the same name appended with ".buffer".
  40    * @param[in]  _width   The width of the image.
  41    * @param[in]  _height  The height of the image.
  42    */
  43   ImageDetails( const char * const _name, unsigned int _width, unsigned int _height );
  44
  45   /**
  46    * Sometimes an image reports an incorrect size in the header than what it actually is. In such a
  47    * scenario, this constructor should be used.
  48    *
  49    * @param[in]  _name            The name of the image to open.  The reference buffer file should have the same name appended with ".buffer".
  50    * @param[in]  _width           The width of the image.
  51    * @param[in]  _height          The height of the image.
  52    * @param[in]  _reportedWidth   The reported width of the image by reading the header.
  53    * @param[in]  _reportedHeight  The reported height of the image by reading the header.
  54    */
  55   ImageDetails( const char * const _name, unsigned int _width, unsigned int _height, unsigned int _reportedWidth, unsigned int _reportedHeight );
  56
  57   /**
  58    * Destructor
  59    */
  60   ~ImageDetails();
  61
  62
  63   std::string name;
  64   unsigned int width;
  65   unsigned int height;
  66   unsigned int reportedWidth;
  67   unsigned int reportedHeight;
  68   unsigned int refBufferSize;
  69   Dali::PixelBuffer* refBuffer;
  70
  71 private:
  72
  73   /**
  74    * Loads the reference buffer file.
  75    */
  76   void LoadBuffer();
  77 };
  78
  79 /**
  80  * A structure storing the methods that should be called when reading an image's header and when
  81  * reading the bitmap from the image file.
  82  */
  83 struct LoadFunctions
  84 {
  85   typedef bool (*LoadBitmapFunction)( const Dali::TizenPlatform::ImageLoader::Input& input, Dali::Integration::Bitmap& );
  86   typedef bool (*LoadBitmapHeaderFunction)( const Dali::TizenPlatform::ImageLoader::Input& input, unsigned int& width, unsigned int& height );
  87
  88   LoadFunctions( LoadBitmapHeaderFunction _header, LoadBitmapFunction _loader );
  89   LoadBitmapHeaderFunction header;
  90   LoadBitmapFunction loader;
  91 };
  92
  93 // Helper method to test each image file.
  94 /**
  95  * Use this method to test the header and and bitmap loading of each image.
  96  * The loaded bitmap is then checked with the reference bitmap in ImageDetails.
  97  *
  98  * @param[in]  image         The image details.
  99  * @param[in]  functions     The loader functions that need to be called.
 100  * @param[in]  bitmapProfile Whether or not the bitmap is raw
 101  */
 102 void TestImageLoading( const ImageDetails& image, const LoadFunctions& functions, Dali::Integration::Bitmap::Profile bitmapProfile = Dali::Integration::Bitmap::BITMAP_2D_PACKED_PIXELS );
 103
 104 /**
 105  * Helper method to compare the resultant loaded image data of the specified image with a golden master data.
 106  *
 107  * @param[in] image         The image to load
 108  * @param[in] functions     The functions to use to load the image
 109  * @param[in] master        Golden master data to compare the resultant loaded image with
 110  */
 111 void CompareLoadedImageData( const ImageDetails& image, const LoadFunctions& functions, const uint32_t* master );
 112
 113 /**
 114  * Helper function which should be used when first creating a reference buffer file.
 115  * Set output file to a file in the /tmp/ directory e.g:
 116  *   DumpImageBufferToTempFile( "images/pattern.gif" , "/tmp/pattern.gif.buffer" );
 117  *
 118  * @param[in]  filename        The path of the image file.
 119  * @param[in]  targetFilename  The path of where the buffer should be written to.  This should ideally be in the "/tmp" folder.
 120  * @param[in]  functions       The loader functions to call.
 121  */
 122 void DumpImageBufferToTempFile( std::string filename, std::string targetFilename, const LoadFunctions& functions );
 123
 124 #endif // __DALI_ADAPTOR_TET_IMAGE_LOADERS_H_