1/*
2 * Copyright (c) 2021-2022 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 NDK_INCLUDE_NATIVE_WINDOW_H_
17#define NDK_INCLUDE_NATIVE_WINDOW_H_
18
19#include "external_window.h"
20#include "native_buffer.h"
21
22#ifdef __cplusplus
23extern "C" {
24#endif
25
26#define MKMAGIC(a, b, c, d) (((a) << 24) + ((b) << 16) + ((c) << 8) + ((d) << 0))
27
28enum NativeObjectMagic {
29    NATIVE_OBJECT_MAGIC_WINDOW = MKMAGIC('W', 'I', 'N', 'D'),
30    NATIVE_OBJECT_MAGIC_WINDOW_BUFFER = MKMAGIC('W', 'B', 'U', 'F'),
31};
32
33// pSurface type is OHOS::sptr<OHOS::Surface>*
34OHNativeWindow* CreateNativeWindowFromSurface(void* pSurface);
35void DestoryNativeWindow(OHNativeWindow* window);
36
37// pSurfaceBuffer type is OHOS::sptr<OHOS::SurfaceBuffer>*
38OHNativeWindowBuffer* CreateNativeWindowBufferFromSurfaceBuffer(void* pSurfaceBuffer);
39OHNativeWindowBuffer* CreateNativeWindowBufferFromNativeBuffer(OH_NativeBuffer* nativeBuffer);
40void DestroyNativeWindowBuffer(OHNativeWindowBuffer* buffer);
41
42int32_t NativeWindowRequestBuffer(OHNativeWindow *window, OHNativeWindowBuffer **buffer, int *fenceFd);
43int32_t NativeWindowFlushBuffer(OHNativeWindow *window, OHNativeWindowBuffer *buffer,
44    int fenceFd, Region region);
45int32_t GetLastFlushedBuffer(OHNativeWindow *window, OHNativeWindowBuffer **buffer,
46    int *fenceFd, float matrix[16]);
47int32_t NativeWindowCancelBuffer(OHNativeWindow *window, OHNativeWindowBuffer *buffer);
48
49// The meaning and quantity of parameters vary according to the code type.
50// For details, see the NativeWindowOperation comment.
51int32_t NativeWindowHandleOpt(OHNativeWindow *window, int code, ...);
52BufferHandle *GetBufferHandleFromNative(OHNativeWindowBuffer *buffer);
53
54// NativeObject: NativeWindow, NativeWindowBuffer
55int32_t NativeObjectReference(void *obj);
56int32_t NativeObjectUnreference(void *obj);
57int32_t GetNativeObjectMagic(void *obj);
58
59int32_t NativeWindowSetScalingMode(OHNativeWindow *window, uint32_t sequence, OHScalingMode scalingMode);
60int32_t NativeWindowSetMetaData(OHNativeWindow *window, uint32_t sequence, int32_t size,
61                                const OHHDRMetaData *metaData);
62int32_t NativeWindowSetMetaDataSet(OHNativeWindow *window, uint32_t sequence, OHHDRMetadataKey key,
63                                   int32_t size, const uint8_t *metaData);
64int32_t NativeWindowSetTunnelHandle(OHNativeWindow *window, const OHExtDataHandle *handle);
65int32_t GetSurfaceId(OHNativeWindow *window, uint64_t *surfaceId);
66int32_t CreateNativeWindowFromSurfaceId(uint64_t surfaceId, OHNativeWindow **window);
67int32_t NativeWindowAttachBuffer(OHNativeWindow *window, OHNativeWindowBuffer *buffer);
68int32_t NativeWindowDetachBuffer(OHNativeWindow *window, OHNativeWindowBuffer *buffer);
69int32_t NativeWindowGetTransformHint(OHNativeWindow *window, OH_NativeBuffer_TransformType *transform);
70int32_t NativeWindowSetTransformHint(OHNativeWindow *window, OH_NativeBuffer_TransformType transform);
71int32_t NativeWindowGetDefaultWidthAndHeight(OHNativeWindow *window, int32_t *width, int32_t *height);
72int32_t NativeWindowSetRequestWidthAndHeight(OHNativeWindow *window, int32_t width, int32_t height);
73void NativeWindowSetBufferHold(OHNativeWindow *window);
74int32_t NativeWindowWriteToParcel(OHNativeWindow *window, OHIPCParcel *parcel);
75int32_t NativeWindowReadFromParcel(OHIPCParcel *parcel, OHNativeWindow **window);
76int32_t GetLastFlushedBufferV2(OHNativeWindow *window, OHNativeWindowBuffer **buffer, int *fenceFd, float matrix[16]);
77int32_t NativeWindowSetScalingModeV2(OHNativeWindow *window, OHScalingModeV2 scalingMode);
78int32_t NativeWindowDisconnect(OHNativeWindow *window);
79int32_t OH_NativeWindow_SetColorSpace(OHNativeWindow *window, OH_NativeBuffer_ColorSpace colorSpace);
80int32_t OH_NativeWindow_GetColorSpace(OHNativeWindow *window, OH_NativeBuffer_ColorSpace *colorSpace);
81int32_t OH_NativeWindow_SetMetadataValue(OHNativeWindow *window, OH_NativeBuffer_MetadataKey metadataKey,
82    int32_t size, uint8_t *metadata);
83int32_t OH_NativeWindow_GetMetadataValue(OHNativeWindow *window, OH_NativeBuffer_MetadataKey metadataKey,
84    int32_t *size, uint8_t **metadata);
85
86#ifdef __cplusplus
87}
88#endif
89
90#endif