2 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #ifndef DALI_ADAPTOR_TET_IMAGE_LOADERS_H
19 #define DALI_ADAPTOR_TET_IMAGE_LOADERS_H
21 #include <dali/dali.h>
22 #include <dali/devel-api/adaptor-framework/image-loader-input.h>
23 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
24 #include <dali/integration-api/bitmap.h>
26 // Simple structure to close the file when finished with it.
29 AutoCloseFile(FILE* fp);
34 /// Structure to hold image details and the reference buffer.
40 * @param[in] _name The name of the image to open. The reference buffer file should have the same name appended with ".buffer".
41 * @param[in] _width The width of the image.
42 * @param[in] _height The height of the image.
44 ImageDetails(const char* const _name, unsigned int _width, unsigned int _height);
47 * Sometimes an image reports an incorrect size in the header than what it actually is. In such a
48 * scenario, this constructor should be used.
50 * @param[in] _name The name of the image to open. The reference buffer file should have the same name appended with ".buffer".
51 * @param[in] _width The width of the image.
52 * @param[in] _height The height of the image.
53 * @param[in] _reportedWidth The reported width of the image by reading the header.
54 * @param[in] _reportedHeight The reported height of the image by reading the header.
56 ImageDetails(const char* const _name, unsigned int _width, unsigned int _height, unsigned int _reportedWidth, unsigned int _reportedHeight);
66 unsigned int reportedWidth;
67 unsigned int reportedHeight;
68 unsigned int refBufferSize;
69 Dali::Integration::PixelBuffer* refBuffer;
73 * Loads the reference buffer file.
79 * A structure storing the methods that should be called when reading an image's header and when
80 * reading the bitmap from the image file.
84 typedef bool (*LoadBitmapFunction)(const Dali::ImageLoader::Input& input, Dali::Devel::PixelBuffer&);
85 typedef bool (*LoadBitmapHeaderFunction)(const Dali::ImageLoader::Input& input, unsigned int& width, unsigned int& height);
87 LoadFunctions(LoadBitmapHeaderFunction _header, LoadBitmapFunction _loader);
88 LoadBitmapHeaderFunction header;
89 LoadBitmapFunction loader;
92 // Helper method to test each image file.
94 * Use this method to test the header and and bitmap loading of each image.
95 * The loaded bitmap is then checked with the reference bitmap in ImageDetails.
97 * @param[in] image The image details.
98 * @param[in] functions The loader functions that need to be called.
99 * @param[in] bitmapProfile Whether or not the bitmap is raw
101 void TestImageLoading(const ImageDetails& image, const LoadFunctions& functions, Dali::Integration::Bitmap::Profile bitmapProfile = Dali::Integration::Bitmap::BITMAP_2D_PACKED_PIXELS);
104 * Helper method to compare the resultant loaded image data of the specified image with a golden master data.
106 * @param[in] image The image to load
107 * @param[in] functions The functions to use to load the image
108 * @param[in] master Golden master data to compare the resultant loaded image with
110 void CompareLoadedImageData(const ImageDetails& image, const LoadFunctions& functions, const uint32_t* master);
113 * Helper function which should be used when first creating a reference buffer file.
114 * Set output file to a file in the /tmp/ directory e.g:
115 * DumpImageBufferToTempFile( "images/pattern.gif" , "/tmp/pattern.gif.buffer" );
117 * @param[in] filename The path of the image file.
118 * @param[in] targetFilename The path of where the buffer should be written to. This should ideally be in the "/tmp" folder.
119 * @param[in] functions The loader functions to call.
121 void DumpImageBufferToTempFile(std::string filename, std::string targetFilename, const LoadFunctions& functions);
123 #endif // DALI_ADAPTOR_TET_IMAGE_LOADERS_H