• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# NativeWindow开发指导 (C/C++)
2
3## 场景介绍
4
5NativeWindow是**本地平台化窗口**，表示图形队列的生产者端。开发者可以通过`NativeWindow`接口进行申请和提交`Buffer`，配置`Buffer`属性信息。
6针对NativeWindow，常见的开发场景如下：
7
8* 通过`NativeWindow`提供的Native API接口申请图形`Buffer`，并将生产图形内容写入图形`Buffer`，最终提交`Buffer`到图形队列。
9* 在适配EGL层的`eglswapbuffer`接口时，进行申请和提交`Buffer`。
10
11## 接口说明
12
13| 接口名 | 描述 |
14| -------- | -------- |
15| OH_NativeWindow_NativeWindowRequestBuffer (OHNativeWindow \*window, OHNativeWindowBuffer \*\*buffer, int \*fenceFd) | 通过OHNativeWindow对象申请一块OHNativeWindowBuffer，用以内容生产。 |
16| OH_NativeWindow_NativeWindowFlushBuffer (OHNativeWindow \*window, OHNativeWindowBuffer \*buffer, int fenceFd, Region region) | 通过OHNativeWindow将生产好内容的OHNativeWindowBuffer放回到Buffer队列中，用以内容消费。 |
17| OH_NativeWindow_NativeWindowHandleOpt (OHNativeWindow \*window, int code,...) | 设置/获取OHNativeWindow的属性，包括设置/获取宽高、内容格式等。 |
18
19详细的接口说明请参考[native_window](../reference/apis-arkgraphics2d/_native_window.md)。
20
21## 开发步骤
22
23以下步骤描述了如何使用`NativeWindow`提供的Native API接口，申请图形`Buffer`，并将生产图形内容写入图形`Buffer`后，最终提交`Buffer`到图形队列。
24
25**添加动态链接库**
26
27CMakeLists.txt中添加以下lib。
28```txt
29libace_ndk.z.so
30libnative_window.so
31```
32
33**头文件**
34```c++
35#include <sys/poll.h>
36#include <sys/mman.h>
37#include <unistd.h>
38#include <ace/xcomponent/native_interface_xcomponent.h>
39#include <native_window/external_window.h>
40```
41
421. 获取OHNativeWindow实例。
43
44    可在[`OH_NativeXComponent_Callback`](../reference/apis-arkui/_o_h___native_x_component___callback.md)提供的接口中获取OHNativeWindow，下面提供一份代码示例。XComponent模块的具体使用方法请参考[XComponent开发指导](../ui/napi-xcomponent-guidelines.md)。
45
46    1. 在xxx.ets中添加一个XComponent组件。
47
48        ```ts
49        XComponent({ id: 'xcomponentId', type: 'surface', libraryname: 'entry'})
50            .width(360)
51            .height(360)
52        ```
53
54    2. 在 native c++ 层获取 NativeXComponent。
55
56        ```c++
57        napi_value exportInstance = nullptr;
58        // 用来解析出被wrap了NativeXComponent指针的属性
59        napi_get_named_property(env, exports, OH_NATIVE_XCOMPONENT_OBJ, &exportInstance);
60        OH_NativeXComponent *nativeXComponent = nullptr;
61        // 通过napi_unwrap接口，解析出NativeXComponent的实例指针
62        napi_unwrap(env, exportInstance, reinterpret_cast<void**>(&nativeXComponent));
63        // 获取XComponentId
64        char idStr[OH_XCOMPONENT_ID_LEN_MAX + 1] = {};
65        uint64_t idSize = OH_XCOMPONENT_ID_LEN_MAX + 1;
66        OH_NativeXComponent_GetXComponentId(nativeXComponent, idStr, &idSize);
67        ```
68
69    3. 定义 OH_NativeXComponent_Callback。
70
71        ```c++
72        // 定义回调函数
73        void OnSurfaceCreatedCB(OH_NativeXComponent* component, void* window)
74        {
75            // 可获取 OHNativeWindow 实例
76            OHNativeWindow* nativeWindow = static_cast<OHNativeWindow*>(window);
77            // 此回调触发后，window默认引用计数会设置为1，若存在并发使用了window相关的接口和xcomponent析构的情况，
78            // 则需要通过OH_NativeWindow_NativeObjectReference和OH_NativeWindow_NativeObjectUnreference对window进行
79            // 手动引用计数加1和减1，防止xcomponent析构后，并发调用window相关接口触发野指针或空指针的崩溃。
80        }
81        void OnSurfaceChangedCB(OH_NativeXComponent* component, void* window)
82        {
83            // 可获取 OHNativeWindow 实例
84            OHNativeWindow* nativeWindow = static_cast<OHNativeWindow*>(window);
85            // ...
86        }
87        void OnSurfaceDestroyedCB(OH_NativeXComponent* component, void* window)
88        {
89            // 可获取 OHNativeWindow 实例
90            OHNativeWindow* nativeWindow = static_cast<OHNativeWindow*>(window);
91            // 此回调触发后，会将window进行引用计数减1的操作，当window的应用计数为0后，会触发window的析构，
92            // window析构后，不可再通过window进行接口调用，否则可能会触发野指针或空指针的崩溃。
93        }
94        void DispatchTouchEventCB(OH_NativeXComponent* component, void* window)
95        {
96            // 可获取 OHNativeWindow 实例
97            OHNativeWindow* nativeWindow = static_cast<OHNativeWindow*>(window);
98            // ...
99        }
100        ```
101
102        ```c++
103        // 初始化 OH_NativeXComponent_Callback
104        OH_NativeXComponent_Callback callback;
105        callback.OnSurfaceCreated = OnSurfaceCreatedCB;
106        callback.OnSurfaceChanged = OnSurfaceChangedCB;
107        callback.OnSurfaceDestroyed = OnSurfaceDestroyedCB;
108        callback.DispatchTouchEvent = DispatchTouchEventCB;
109        ```
110
111   4. 将 OH_NativeXComponent_Callback 注册给 NativeXComponent。
112
113        ```c++
114        // 注册回调函数
115        OH_NativeXComponent_RegisterCallback(nativeXComponent, &callback);
116        ```
117
1182. 设置OHNativeWindowBuffer的属性。使用`OH_NativeWindow_NativeWindowHandleOpt`设置`OHNativeWindowBuffer`的属性。
119
120    ```c++
121    // 设置 OHNativeWindowBuffer 的宽高
122    int32_t code = SET_BUFFER_GEOMETRY;
123    int32_t width = 0x100;
124    int32_t height = 0x100;
125    // 这里的nativeWindow是从上一步骤中的回调函数中获得的
126    int32_t ret = OH_NativeWindow_NativeWindowHandleOpt(nativeWindow, code, width, height);
127    ```
128
1293. 从图形队列申请OHNativeWindowBuffer。
130
131    ```c++
132    OHNativeWindowBuffer* buffer = nullptr;
133    int releaseFenceFd = -1;
134    // 通过 OH_NativeWindow_NativeWindowRequestBuffer 获取 OHNativeWindowBuffer 实例
135    ret = OH_NativeWindow_NativeWindowRequestBuffer(nativeWindow, &buffer, &releaseFenceFd);
136    if (ret != 0 || buffer == nullptr) {
137        return;
138    }
139    // 通过 OH_NativeWindow_GetBufferHandleFromNative 获取 buffer 的 handle
140    BufferHandle* bufferHandle = OH_NativeWindow_GetBufferHandleFromNative(buffer);
141    ```
142
1434. 内存映射mmap。
144
145    ```c++
146    #include <sys/mman.h>
147
148    // 使用内存映射函数mmap将bufferHandle对应的共享内存映射到用户空间，可以通过映射出来的虚拟地址向bufferHandle中写入图像数据
149    // bufferHandle->virAddr是bufferHandle在共享内存中的起始地址，bufferHandle->size是bufferHandle在共享内存中的内存占用大小
150    void* mappedAddr = mmap(bufferHandle->virAddr, bufferHandle->size, PROT_READ | PROT_WRITE, MAP_SHARED, bufferHandle->fd, 0);
151    if (mappedAddr == MAP_FAILED) {
152        // mmap failed
153    }
154    ```
155
1565. 将生产的内容写入OHNativeWindowBuffer，在这之前需要等待releaseFenceFd可用（注意releaseFenceFd不等于-1才需要调用poll）。如果没有等待releaseFenceFd事件的数据可用（POLLIN），则可能造成花屏、裂屏、HEBC（High Efficiency Bandwidth Compression，高效带宽压缩） fault等问题。releaseFenceFd是消费者进程创建的一个文件句柄，代表消费者消费buffer完毕，buffer可读，生产者可以开始填充buffer内容。
157
158    ```c++
159    int retCode = -1;
160    uint32_t timeout = 3000;
161    if (releaseFenceFd != -1) {
162        struct pollfd pollfds = {0};
163        pollfds.fd = releaseFenceFd;
164        pollfds.events = POLLIN;
165        do {
166            retCode = poll(&pollfds, 1, timeout);
167        } while (retCode == -1 && (errno == EINTR || errno == EAGAIN));
168        close(releaseFenceFd); // 防止fd泄漏
169    }
170
171    static uint32_t value = 0x00;
172    value++;
173    uint32_t *pixel = static_cast<uint32_t *>(mappedAddr); // 使用mmap获取到的地址来访问内存
174    for (uint32_t x = 0; x < width; x++) {
175        for (uint32_t y = 0;  y < height; y++) {
176            *pixel++ = value;
177        }
178    }
179    ```
180
1816. 提交OHNativeWindowBuffer到图形队列。请注意OH_NativeWindow_NativeWindowFlushBuffer接口的acquireFenceFd不可以和OH_NativeWindow_NativeWindowRequestBuffer接口获取的releaseFenceFd相同，acquireFenceFd可传入默认值-1。acquireFenceFd是生产者需要传入的文件句柄，消费者获取到buffer后可根据生产者传入的acquireFenceFd决定何时去渲染并上屏buffer内容。
182
183    ```c++
184    // 设置刷新区域，如果Region中的Rect为nullptr,或者rectNumber为0，则认为OHNativeWindowBuffer全部有内容更改。
185    Region region{nullptr, 0};
186    int acquireFenceFd = -1;
187    // 通过OH_NativeWindow_NativeWindowFlushBuffer 提交给消费者使用，例如：显示在屏幕上。
188    OH_NativeWindow_NativeWindowFlushBuffer(nativeWindow, buffer, acquireFenceFd, region);
189    ```
190
1917. 取消内存映射munmap。
192
193    ```c++
194    // 内存使用完记得去掉内存映射
195    int result = munmap(mappedAddr, bufferHandle->size);
196    if (result == -1) {
197        // munmap failed
198    }
199    ```
200
201## 相关实例
202
203针对NativeWindow的开发，有以下相关实例可供参考：
204
205- [NativeWindow（API11）](https://gitee.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/Native/NdkNativeWindow)