Cleanup for removal of ImageAttributes from public API
[platform/core/uifw/dali-adaptor.git] / platform-abstractions / tizen / image-loaders / loader-jpeg.h
1 #ifndef __DALI_TIZEN_PLATFORM_LOADER_JPEG_H__
2 #define __DALI_TIZEN_PLATFORM_LOADER_JPEG_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 <stdio.h>
22 #include <dali/public-api/common/vector-wrapper.h>
23 #include <dali/public-api/images/pixel.h>
24 #include "image-encoder.h"
25 #include "image-loader-input.h"
26
27 namespace Dali
28 {
29
30 namespace Integration
31 {
32   class Bitmap;
33 }
34
35 struct ImageAttributes;
36
37 namespace TizenPlatform
38 {
39
40 class ResourceLoadingClient;
41
42 namespace Jpeg
43 {
44 const unsigned char MAGIC_BYTE_1 = 0xFF;
45 const unsigned char MAGIC_BYTE_2 = 0xD8;
46 } // namespace Jpeg
47
48 /**
49  * Loads the bitmap from an JPEG file.  This function checks the header first
50  * and if it is not a JPEG file, then it returns straight away.
51  * @param[in]  fp      Pointer to the Image file
52  * @param[in]  bitmap  The bitmap class where the decoded image will be stored
53  * @param[in]  attributes  Describes the dimensions, pixel format and other details for loading the image data
54  * @return  true if file decoded successfully, false otherwise
55  */
56 bool LoadBitmapFromJpeg( const ResourceLoadingClient& client, const ImageLoader::Input& input, Integration::Bitmap& bitmap );
57
58 /**
59  * Loads the header of a JPEG file and fills in the width and height appropriately.
60  * If the width and height are set on entry, it will set the width and height
61  * to the closest scaled size (exactly as will be loaded by LoadBitmapFromJpeg with the same
62  * attributes)
63  * @param[in]   fp      Pointer to the Image file
64  * @param[in]  attributes  Describes the dimensions, pixel format and other details for loading the image data
65  * @param[in/out]  width   Is set with the width of the image
66  * @param[in/out]  height  Is set with the height of the image
67  * @return true if the file's header was read successully, false otherwise
68  */
69 bool LoadJpegHeader( const ImageLoader::Input& input, unsigned int& width, unsigned int& height );
70
71 /**
72  * Encode raw pixel data to JPEG format.
73  * @param[in]  pixelBuffer    Pointer to raw pixel data to be encoded
74  * @param[out] encodedPixels  Encoded pixel data. Existing contents will be overwritten
75  * @param[in]  width          Image width
76  * @param[in]  height         Image height
77  * @param[in]  pixelFormat    Input pixel format (must be Pixel::RGB888)
78  * @param[in]  quality        JPEG quality on usual 1 to 100 scale.
79  */
80 bool EncodeToJpeg(const unsigned char* pixelBuffer, std::vector< unsigned char >& encodedPixels, std::size_t width, std::size_t height, Pixel::Format pixelFormat, unsigned quality = 80);
81
82 } // namespace TizenPlatform
83
84 } // namespace Dali
85
86 #endif // __DALI_TIZEN_PLATFORM_LOADER_JPEG_H__