1 /*
2  * Copyright (c) 2024 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef FOUNDATION_ACE_FRAMEWORKS_BASE_IMAGE_ACE_IMAGE_PACKER_H
17 #define FOUNDATION_ACE_FRAMEWORKS_BASE_IMAGE_ACE_IMAGE_PACKER_H
18 
19 #include "base/memory/ace_type.h"
20 
21 namespace OHOS::Ace {
22 struct PackOption {
23     /**
24      * Specify the file format of the output image.
25      */
26     std::string format;
27     /**
28      * Hint to the compression quality, 0-100.
29      * Larger values indicate higher image quality but usually take up larger sizes.
30      */
31     uint8_t quality = 100;
32 
33     /**
34      * Hint to how many images will be packed into the image file.
35      */
36     uint32_t numberHint = 1;
37 };
38 class PixelMap;
39 
40 class ACE_EXPORT ImagePacker : public AceType {
41     DECLARE_ACE_TYPE(ImagePacker, AceType)
42 public:
43     static RefPtr<ImagePacker> Create();
44 
45     virtual uint32_t StartPacking(uint8_t* data, uint32_t maxSize, const PackOption& option) = 0;
46     virtual uint32_t StartPacking(const std::string& filePath, const PackOption& option) = 0;
47     virtual uint32_t AddImage(PixelMap& pixelMap) = 0;
48     virtual uint32_t FinalizePacking(int64_t& packedSize) = 0;
49 };
50 } // namespace OHOS::Ace
51 
52 #endif // FOUNDATION_ACE_FRAMEWORKS_BASE_IMAGE_ACE_IMAGE_PACKER_H
53