2 * Copyright © 2019 Samsung Electronics co., Ltd. All Rights Reserved.
4 * Permission is hereby granted, free of charge, to any person obtaining
5 * a copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sublicense, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial
14 * portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 #include "PUI_internal.h"
27 #include "PUI_backend.h"
30 #include <wayland-tbm-client.h>
31 #include <tbm_surface_internal.h>
35 #ifndef PUI_MODULE_DIR
36 #define PUI_MODULE_DIR "/usr/lib"
39 static int _pui_init_count = 0;
40 static pui_module_data *pui_module = NULL;
42 int PUI_EVENT_ANI_STARTED = 0;
43 int PUI_EVENT_ANI_STOPPED = 0;
44 int PUI_EVENT_ANI_PAUSED = 0;
45 int PUI_EVENT_ANI_READY_TO_START = 0;
46 int PUI_EVENT_ANI_READY_TO_RESUME = 0;
48 static int KEY_WL_BUFFER = 0xabcdbeaf;
49 static int KEY_CLIENT = 0xdcbabeaf;
52 _pui_magic_string_get(PUI_Magic m)
57 return "None (Freed Object)";
61 return "PUI MODULE (PUI_M)";
65 return "PUI HANDLE (PUI_H)";
69 return "PUI ANI HANDLE (ANI_H)";
73 return "PUI ANI RUNTIME HANDLE (ANI_T)";
82 _pui_magic_fail(const void *p, PUI_Magic m, PUI_Magic req_m, const char *fname)
84 pui_err(" ### PUI ERROR : PUI Magic Check Failed !!! in %s().\n", fname);
87 pui_err(" Given handle/pointer is NULL !\n");
88 else if (m == PUI_MAGIC_NONE)
89 pui_err(" Given handle/pointer has been freed !\n");
91 pui_err(" Given handle/pointer is wrong type\n"
92 " Expected: %08x - %s\n"
93 " Supplied: %08x - %s",
94 (unsigned int)req_m, _pui_magic_string_get(req_m),
95 (unsigned int)m, _pui_magic_string_get(m));
97 /* abort here as a failure of magic can be caused by a memory corruption */
98 pui_err("### PUI MAGIC FAILED ! Abort ! ###\n");
103 pui_error_to_string(pui_error e)
105 pui_error_string str = NULL;
110 str = "PUI_No_Error";
113 case PUI_ERROR_INVALID_ANI_HANDLE:
114 str = "PUI_Invalid_Animation_Handle";
117 case PUI_ERROR_INVALID_ANI_CMD:
118 str = "PUI_Invalid_Animation_Command";
121 case PUI_ERROR_INTERNAL:
122 str = "PUI_Internal_Error";
125 case PUI_ERROR_MANUAL_RENDER_ENABLED:
126 str = "PUI_Manual_Render_Enabled";
129 case PUI_ERROR_UNABLE_SET_MANUAL_RENDER:
130 str = "PUI_Unable_To_Set_Manual_Render";
134 str = "PUI_Unknown_Error";
141 _buffer_release(void *data, struct wl_buffer *buffer)
143 tbm_surface_h surface = (tbm_surface_h)data;
146 tbm_surface_internal_get_user_data(surface, (unsigned long)&KEY_CLIENT, (void **)&handle);
147 tbm_surface_queue_release(handle->tbm_queue, surface);
149 pui_info("[UPDATE] release wl_buffer:%p, surface:%p\n", buffer, surface);
152 static const struct wl_buffer_listener buffer_listener = {
156 pui_ani_control_buffer *
157 pui_display_get_buffer(pui_h handle)
159 tbm_surface_error_e ret;
160 tbm_surface_h surface;
161 pui_ani_control_buffer *buffer = NULL;
163 if (!PUI_MAGIC_CHECK(handle, PUI_MAGIC_PUI_H))
165 PUI_MAGIC_FAIL(handle, PUI_MAGIC_PUI_H, __FUNCTION__);
169 if (handle->current_surface)
171 pui_debug("[GET BUFFER] Current_surface is not used !\n");
174 if (!tbm_surface_queue_can_dequeue(handle->tbm_queue, 0))
176 pui_err("[GET BUFFER] Failed to dequeue a tbm_surface !\n");
180 ret = tbm_surface_queue_dequeue(handle->tbm_queue, &surface);
182 if (ret != TBM_SURFACE_ERROR_NONE)
184 pui_err("[GET BUFFER] Dequeue err:%d\n", ret);
188 tbm_surface_map(surface, TBM_SURF_OPTION_READ | TBM_SURF_OPTION_WRITE, &handle->current_sinfo);
190 handle->current_surface = surface;
191 buffer = (pui_ani_control_buffer *)&(handle->current_sinfo.planes[0]);
197 pui_display_set_buffer(pui_h handle, pui_ani_control_buffer *buffer)
199 if (!PUI_MAGIC_CHECK(handle, PUI_MAGIC_PUI_H))
201 PUI_MAGIC_FAIL(handle, PUI_MAGIC_PUI_H, __FUNCTION__);
202 return PUI_ERROR_INVALID_HANDLE;
205 if (!handle->current_surface)
207 pui_err("Current_surface is not valid !\n");
208 return PUI_ERROR_INVALID_SURFACE;
211 if (!buffer || !buffer->ptr || !buffer->size)
212 return PUI_ERROR_INVALID_BUFFER;
214 handle->is_buffer_set = 1;
216 return PUI_ERROR_NONE;
220 pui_display_update(pui_h handle)
222 tbm_surface_h surface;
223 tbm_surface_error_e ret;
224 struct wl_buffer *wl_buffer = NULL;
226 if (!PUI_MAGIC_CHECK(handle, PUI_MAGIC_PUI_H))
228 PUI_MAGIC_FAIL(handle, PUI_MAGIC_PUI_H, __FUNCTION__);
229 return PUI_ERROR_INVALID_HANDLE;
232 if (!handle->current_surface)
233 return PUI_ERROR_INVALID_SURFACE;
235 if (!handle->is_buffer_set)
237 pui_err("[UPDATE] Buffer is not set !\n");
238 return PUI_ERROR_INVALID_BUFFER;
241 surface = handle->current_surface;
242 handle->current_surface = NULL;
244 tbm_surface_unmap(surface);
246 ret = tbm_surface_queue_enqueue(handle->tbm_queue, surface);
248 if (ret != TBM_SURFACE_ERROR_NONE)
250 pui_err("[UPDATE] enqueue err:%d\n", ret);
251 return PUI_ERROR_INVALID_SURFACE;
254 ret = tbm_surface_queue_acquire(handle->tbm_queue, &surface);
256 if (ret != TBM_SURFACE_ERROR_NONE)
258 pui_err("[UPDATE] acquire err:%d\n", ret);
259 return PUI_ERROR_INVALID_SURFACE;
262 if (!tbm_surface_internal_get_user_data(surface, (unsigned long)&KEY_WL_BUFFER, (void **)&wl_buffer)) {
263 wl_buffer = wayland_tbm_client_create_buffer(handle->wl_tbm_client, surface);
267 pui_err("[UPDATE] failed to create wl_buffer tbm_surface:%p\n", surface);
268 return PUI_ERROR_INVALID_BUFFER;
271 wl_buffer_add_listener(wl_buffer, &buffer_listener, surface);
273 tbm_surface_internal_add_user_data(surface, (unsigned long)&KEY_WL_BUFFER, NULL);
274 tbm_surface_internal_set_user_data(surface, (unsigned long)&KEY_WL_BUFFER, wl_buffer);
275 tbm_surface_internal_add_user_data(surface, (unsigned long)&KEY_CLIENT, NULL);
276 tbm_surface_internal_set_user_data(surface, (unsigned long)&KEY_CLIENT, handle);
281 pui_err("[UPDATE] dequeue err:%d\n", ret);
282 return PUI_ERROR_INVALID_BUFFER;
285 ecore_wl2_window_buffer_attach(handle->win, wl_buffer, 0, 0, 0);
286 ecore_wl2_window_damage(handle->win, NULL, 0);
287 ecore_wl2_window_commit(handle->win, EINA_TRUE);
289 pui_info("[UPDATE] commit wl_buffer:%p, surface:%p\n", wl_buffer, surface);
291 handle->is_buffer_set = 0;
293 return PUI_ERROR_NONE;
297 pui_display_manual_render_set(pui_h handle, pui_bool set)
299 pui_ani_h ani_h = NULL;
301 if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
303 PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
304 return PUI_ERROR_INVALID_HANDLE;
307 ani_h = handle->current_ani_h;
311 if (pui_ani_status_get(ani_h->ani) == PUI_ANI_STATUS_RUNNING ||
312 pui_ani_status_get(ani_h->ani) == PUI_ANI_STATUS_PAUSED)
314 pui_err("Please stop the current animation.\n");
315 return PUI_ERROR_UNABLE_SET_MANUAL_RENDER;
319 handle->manual_render = !!set;
321 return PUI_ERROR_NONE;
325 pui_display_manual_render_get(pui_h handle)
327 if (!PUI_MAGIC_CHECK(handle, PUI_MAGIC_PUI_H))
329 PUI_MAGIC_FAIL(handle, PUI_MAGIC_PUI_H, __FUNCTION__);
333 return handle->manual_render;
337 pui_display_geometry_get(pui_h handle, int *width, int *height)
339 if (!width || !height)
346 if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
348 PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
352 if (!pui_module->backend_module_data) {
353 pui_err("pui module data is not loaded\n");
357 if (!pui_module->backend_module_data->geometry_get)
359 pui_err("Backend doesn't have geometry_get() !\n");
363 return pui_module->backend_module_data->geometry_get(width, height);
367 pui_create(Ecore_Wl2_Window *win)
370 Ecore_Wl2_Display *ewd = ecore_wl2_window_display_get(win);
371 struct wayland_tbm_client *wl_tbm_client = NULL;
375 pui_err("Invalid window or display !\n");
379 if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
381 PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
385 wl_tbm_client = wayland_tbm_client_init(ecore_wl2_display_get(ewd));
389 pui_err("Failed to init wayland_tbm_client !\n");
393 handle = (pui_h)calloc(1, sizeof(pui));
400 handle->visibility = 0;
401 handle->wl_tbm_client = wl_tbm_client;
402 handle->ani_handles = NULL;
403 handle->current_ani_h = NULL;
404 handle->manual_render = 0;
405 handle->backend_module_data = pui_module->backend_module_data;
407 handle->tbm_queue = wayland_tbm_client_create_surface_queue(handle->wl_tbm_client,
408 ecore_wl2_window_surface_get(handle->win),
409 3, 100, 100, TBM_FORMAT_ABGR8888);
411 if (!handle->tbm_queue)
413 pui_err("Failed to create a surface queue !");
417 PUI_MAGIC_SET(handle, PUI_MAGIC_PUI_H);
427 pui_destroy(pui_h handle)
429 pui_ani_h ani_h = NULL;
431 if (!PUI_MAGIC_CHECK(handle, PUI_MAGIC_PUI_H))
433 PUI_MAGIC_FAIL(handle, PUI_MAGIC_PUI_H, __FUNCTION__);
437 EINA_LIST_FREE(handle->ani_handles, ani_h)
439 pui_ani_destroy(ani_h);
442 if (handle->tbm_queue)
444 tbm_surface_queue_destroy(handle->tbm_queue);
447 if (handle->wl_tbm_client)
449 wayland_tbm_client_deinit(handle->wl_tbm_client);
450 handle->wl_tbm_client = NULL;
453 PUI_MAGIC_SET(handle, PUI_MAGIC_NONE);
457 #define PREFIX_LIB "libpui-"
458 #define SUFFIX_LIB ".so"
459 #define DEFAULT_LIB PREFIX_LIB"default-backend"SUFFIX_LIB
462 _pui_load_backend_module(void)
464 //char path[PATH_MAX] = {0, };
465 void *module_info = NULL;
466 pui_backend_module *backend_module_info = NULL;
467 int backend_module_major, backend_module_minor;
468 int pui_backend_major, pui_backend_minor;
470 pui_backend_module_data *backend_module_data = NULL;
472 if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
474 PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
478 module_info = dlopen(DEFAULT_LIB, RTLD_LAZY);
482 pui_err("Failed to dlopen(error:%s, path:%s) !\n", dlerror(), DEFAULT_LIB);
486 backend_module_info = dlsym(module_info, "pui_backend_module_info");
488 if (!backend_module_info) {
489 pui_err("Backend module(%s) doesn't have pui_backend_module_info !\n", DEFAULT_LIB);
493 pui_backend_major = PUI_BACKEND_GET_ABI_MAJOR(PUI_BACKEND_AB_VERSION_LAST);
494 pui_backend_minor = PUI_BACKEND_GET_ABI_MINOR(PUI_BACKEND_AB_VERSION_LAST);
496 backend_module_major = PUI_BACKEND_GET_ABI_MAJOR(backend_module_info->abi_version);
497 backend_module_minor = PUI_BACKEND_GET_ABI_MINOR(backend_module_info->abi_version);
499 if (backend_module_major > pui_backend_major) {
500 pui_err("PUI backend module ABI major ver(%d) is newer than the PUI's ver(%d)\n",
501 backend_module_major, pui_backend_major);
503 } else if (backend_module_minor > pui_backend_minor) {
504 pui_err("PUI backend module ABI minor ver(%d) is newer than the PUI's ver(%d)\n",
505 backend_module_minor, pui_backend_minor);
509 if (!backend_module_info->backend_init || !backend_module_info->backend_deinit)
511 pui_err("Backend module doesn't have backend_init/backend_deinit function !\n");
515 backend_module_data = backend_module_info->backend_init();
517 if (!backend_module_data)
519 pui_err("Failed to init module (%s) !\n", DEFAULT_LIB);
523 pui_module->module_info = module_info;
524 pui_module->backend_module_info = backend_module_info;
525 pui_module->backend_module_data = backend_module_data;
530 if (backend_module_info && backend_module_info->backend_deinit)
531 backend_module_info->backend_deinit(backend_module_data);
534 dlclose(module_info);
540 _pui_unload_backend_module(void)
542 if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
544 PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
548 if (pui_module->backend_module_info)
550 pui_module->backend_module_info->backend_deinit(pui_module->backend_module_data);
551 pui_module->backend_module_data = NULL;
552 pui_module->backend_module_info = NULL;
555 if (pui_module->module_info)
556 dlclose(pui_module->module_info);
560 _pui_load_backend_collect_animations(void)
564 if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
566 PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
570 if (!pui_module->backend_module_data) {
571 pui_err("pui module data is not loaded\n");
575 if (!pui_module->backend_module_data->create_ani_collection)
577 pui_err("Backend doesn't have create_ani_collection() !\n");
581 ret = pui_module->backend_module_data->create_ani_collection();
582 if (ret != PUI_INT_ERROR_NONE) {
583 pui_err("Failed to collect animations data (%s)\n",
584 pui_error_to_string(ret));
591 _pui_load_backend_module();
592 _pui_load_backend_collect_animations();
598 _pui_unload_backend_module();
602 _pui_event_init(void)
604 PUI_EVENT_ANI_STARTED = ecore_event_type_new();
605 PUI_EVENT_ANI_STOPPED = ecore_event_type_new();
606 PUI_EVENT_ANI_PAUSED = ecore_event_type_new();
607 PUI_EVENT_ANI_READY_TO_START = ecore_event_type_new();
608 PUI_EVENT_ANI_READY_TO_RESUME = ecore_event_type_new();
612 _pui_event_shutdown(void)
614 ecore_event_type_flush(PUI_EVENT_ANI_STARTED,
615 PUI_EVENT_ANI_STOPPED,
616 PUI_EVENT_ANI_PAUSED,
617 PUI_EVENT_ANI_READY_TO_START,
618 PUI_EVENT_ANI_READY_TO_RESUME);
620 PUI_EVENT_ANI_STARTED = -1;
621 PUI_EVENT_ANI_STOPPED = -1;
622 PUI_EVENT_ANI_PAUSED = -1;
623 PUI_EVENT_ANI_READY_TO_START = -1;
624 PUI_EVENT_ANI_READY_TO_RESUME = -1;
630 const char *cp = NULL;
632 if (++_pui_init_count != 1)
633 return _pui_init_count;
635 _pui_log_level = PUI_LOG_LEVEL_DEBUG;
637 cp = getenv("LIBPUI_LOG_LEVEL");
641 _pui_log_level = atoi(cp);
646 pui_err("Invalid calling of pui_init() !\n");
650 pui_module = (pui_module_data *)calloc(1, sizeof(pui_module_data));
654 pui_err("Failed to allocate memory for pui module data !\n");
658 PUI_MAGIC_SET(pui_module, PUI_MAGIC_PUI_M);
666 return _pui_init_count;
669 return --_pui_init_count;
675 if (_pui_init_count <= 0)
677 pui_err("Invalid pui init count : %d\n", _pui_init_count);
682 if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
684 PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
685 return _pui_init_count;
693 _pui_event_shutdown();
695 ecore_wl2_shutdown();
697 PUI_MAGIC_SET(pui_module, PUI_MAGIC_NONE);
700 return _pui_init_count;