1/*
2 * Copyright (c) 2023 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 OHOS_HDI_DISPLAY_BUFFER_V1_1_IMETADATA_H
17#define OHOS_HDI_DISPLAY_BUFFER_V1_1_IMETADATA_H
18
19#include <stdint.h>
20#include <vector>
21#include <base/native_buffer.h>
22#include <hdf_base.h>
23#include <hdi_base.h>
24
25#ifndef HDI_BUFF_MAX_SIZE
26#define HDI_BUFF_MAX_SIZE (1024 * 200)
27#endif
28
29#ifndef HDI_CHECK_VALUE_RETURN
30#define HDI_CHECK_VALUE_RETURN(lv, compare, rv, ret) do { \
31    if ((lv) compare (rv)) { \
32        return ret; \
33    } \
34} while (false)
35#endif
36
37#ifndef HDI_CHECK_VALUE_RET_GOTO
38#define HDI_CHECK_VALUE_RET_GOTO(lv, compare, rv, ret, value, table) do { \
39    if ((lv) compare (rv)) { \
40        ret = value; \
41        goto table; \
42    } \
43} while (false)
44#endif
45
46namespace OHOS {
47namespace HDI {
48namespace Display {
49namespace Buffer {
50namespace V1_1 {
51using namespace OHOS;
52using namespace OHOS::HDI;
53using namespace OHOS::HDI::Base;
54
55enum {
56    CMD_METADATA_GET_VERSION = 0,
57    CMD_METADATA_REGISTER_BUFFER = 1,
58    CMD_METADATA_SET_METADATA = 2,
59    CMD_METADATA_GET_METADATA = 3,
60    CMD_METADATA_LIST_METADATA_KEYS = 4,
61    CMD_METADATA_ERASE_METADATA_KEY = 5,
62};
63
64class IMetadata : public HdiBase {
65public:
66    DECLARE_HDI_DESCRIPTOR(u"ohos.hdi.display.buffer.v1_1.IMetadata");
67
68    virtual ~IMetadata() = default;
69
70    static sptr<OHOS::HDI::Display::Buffer::V1_1::IMetadata> Get(bool isStub = false);
71    static sptr<OHOS::HDI::Display::Buffer::V1_1::IMetadata> Get(const std::string &serviceName, bool isStub = false);
72
73    virtual int32_t RegisterBuffer(const sptr<NativeBuffer>& handle) = 0;
74
75    virtual int32_t SetMetadata(const sptr<NativeBuffer>& handle, uint32_t key, const std::vector<uint8_t>& value) = 0;
76
77    virtual int32_t GetMetadata(const sptr<NativeBuffer>& handle, uint32_t key, std::vector<uint8_t>& value) = 0;
78
79    virtual int32_t ListMetadataKeys(const sptr<NativeBuffer>& handle, std::vector<uint32_t>& keys) = 0;
80
81    virtual int32_t EraseMetadataKey(const sptr<NativeBuffer>& handle, uint32_t key) = 0;
82
83    virtual int32_t GetVersion(uint32_t& majorVer, uint32_t& minorVer)
84    {
85        majorVer = 1;
86        minorVer = 1;
87        return HDF_SUCCESS;
88    }
89
90    virtual bool IsProxy()
91    {
92        return false;
93    }
94
95    virtual const std::u16string GetDesc()
96    {
97        return metaDescriptor_;
98    }
99};
100} // V1_1
101} // Buffer
102} // Display
103} // HDI
104} // OHOS
105
106#endif // OHOS_HDI_DISPLAY_BUFFER_V1_1_IMETADATA_H
107
108