backend: add default clear animations
[platform/core/uifw/libpui.git] / src / PUI.c
index d6ebd31..e75b09a 100644 (file)
--- a/src/PUI.c
+++ b/src/PUI.c
@@ -45,6 +45,60 @@ int PUI_EVENT_ANI_PAUSED = 0;
 int PUI_EVENT_ANI_READY_TO_START = 0;
 int PUI_EVENT_ANI_READY_TO_RESUME = 0;
 
+static int KEY_WL_BUFFER = 0xabcdbeaf;
+static int KEY_CLIENT = 0xdcbabeaf;
+
+static const char *
+_pui_magic_string_get(PUI_Magic m)
+{
+       switch (m)
+       {
+               case PUI_MAGIC_NONE:
+                       return "None (Freed Object)";
+                       break;
+
+               case PUI_MAGIC_PUI_M:
+                       return "PUI MODULE (PUI_M)";
+                       break;
+
+               case PUI_MAGIC_PUI_H:
+                       return "PUI HANDLE (PUI_H)";
+                       break;
+
+               case PUI_MAGIC_ANI_H:
+                       return "PUI ANI HANDLE (ANI_H)";
+                       break;
+
+               case PUI_MAGIC_ANI_T:
+                       return "PUI ANI RUNTIME HANDLE (ANI_T)";
+                       break;
+
+               default:
+                       return "<Unknown>";
+       }
+}
+
+PUI_API void
+_pui_magic_fail(const void *p, PUI_Magic m, PUI_Magic req_m, const char *fname)
+{
+       pui_err(" ### PUI ERROR : PUI Magic Check Failed !!! in %s().\n", fname);
+
+       if (!p)
+               pui_err("   Given handle/pointer is NULL !\n");
+       else if (m == PUI_MAGIC_NONE)
+               pui_err("   Given handle/pointer has been freed !\n");
+       else if (m != req_m)
+               pui_err("   Given handle/pointer is wrong type\n"
+                               "      Expected: %08x - %s\n"
+                               "      Supplied: %08x - %s",
+                               (unsigned int)req_m, _pui_magic_string_get(req_m),
+                               (unsigned int)m, _pui_magic_string_get(m));
+
+       /* abort here as a failure of magic can be caused by a memory corruption */
+       pui_err("### PUI MAGIC FAILED ! Abort ! ###\n");
+       abort();
+}
+
 pui_error_string
 pui_error_to_string(pui_error e)
 {
@@ -68,6 +122,14 @@ pui_error_to_string(pui_error e)
                        str = "PUI_Internal_Error";
                        break;
 
+               case PUI_ERROR_MANUAL_RENDER_ENABLED:
+                       str = "PUI_Manual_Render_Enabled";
+                       break;
+
+               case PUI_ERROR_UNABLE_SET_MANUAL_RENDER:
+                       str = "PUI_Unable_To_Set_Manual_Render";
+                       break;
+
                default:
                        str = "PUI_Unknown_Error";
        }
@@ -75,6 +137,257 @@ pui_error_to_string(pui_error e)
        return str;
 }
 
+static void
+_buffer_release(void *data, struct wl_buffer *buffer)
+{
+       tbm_surface_h surface = (tbm_surface_h)data;
+       pui_h handle;
+
+       tbm_surface_internal_get_user_data(surface, (unsigned long)&KEY_CLIENT, (void **)&handle);
+       tbm_surface_queue_release(handle->tbm_queue, surface);
+
+       pui_info("[UPDATE] release wl_buffer:%p, surface:%p\n", buffer, surface);
+}
+
+static const struct wl_buffer_listener buffer_listener = {
+    _buffer_release
+};
+
+pui_ani_control_buffer *
+pui_display_get_last_buffer(pui_h handle)
+{
+       tbm_surface_error_e ret;
+       tbm_surface_h surface;
+       pui_ani_control_buffer *buffer = NULL;
+
+       if (!PUI_MAGIC_CHECK(handle, PUI_MAGIC_PUI_H))
+       {
+               PUI_MAGIC_FAIL(handle, PUI_MAGIC_PUI_H, __FUNCTION__);
+               return NULL;
+       }
+
+       if (handle->current_sinfo.size <= 0)
+       {
+               pui_err("Failed to get last buffer which is not set\n");
+               return buffer;
+       }
+
+       buffer = (pui_ani_control_buffer *)&(handle->current_sinfo.planes[0].ptr);
+
+       return buffer;
+}
+
+
+pui_ani_control_buffer *
+pui_display_get_buffer(pui_h handle)
+{
+       tbm_surface_error_e ret;
+       tbm_surface_h surface;
+       pui_ani_control_buffer *buffer = NULL;
+
+       if (!PUI_MAGIC_CHECK(handle, PUI_MAGIC_PUI_H))
+       {
+               PUI_MAGIC_FAIL(handle, PUI_MAGIC_PUI_H, __FUNCTION__);
+               return NULL;
+       }
+
+       if (handle->current_surface)
+       {
+               pui_debug("[GET BUFFER] Current_surface is not used !\n");
+       }
+
+       if (!tbm_surface_queue_can_dequeue(handle->tbm_queue, 0))
+       {
+               pui_err("[GET BUFFER] Failed to dequeue a tbm_surface !\n");
+               return NULL;
+       }
+
+       ret = tbm_surface_queue_dequeue(handle->tbm_queue, &surface);
+
+       if (ret != TBM_SURFACE_ERROR_NONE)
+       {
+               pui_err("[GET BUFFER] Dequeue err:%d\n", ret);
+               return NULL;
+       }
+
+       tbm_surface_map(surface, TBM_SURF_OPTION_READ | TBM_SURF_OPTION_WRITE, &handle->current_sinfo);
+
+       handle->current_surface = surface;
+       buffer = (pui_ani_control_buffer *)&(handle->current_sinfo.planes[0]);
+
+       return buffer;
+}
+
+pui_error
+pui_display_set_buffer(pui_h handle, pui_ani_control_buffer *buffer)
+{
+       if (!PUI_MAGIC_CHECK(handle, PUI_MAGIC_PUI_H))
+       {
+               PUI_MAGIC_FAIL(handle, PUI_MAGIC_PUI_H, __FUNCTION__);
+               return PUI_ERROR_INVALID_HANDLE;
+       }
+
+       if (!handle->current_surface)
+       {
+               pui_err("Current_surface is not valid !\n");
+               return PUI_ERROR_INVALID_SURFACE;
+       }
+
+       if (!buffer || !buffer->ptr || !buffer->size)
+               return PUI_ERROR_INVALID_BUFFER;
+
+       handle->is_buffer_set = 1;
+
+       return PUI_ERROR_NONE;
+}
+
+pui_error
+pui_display_update(pui_h handle)
+{
+       tbm_surface_h surface;
+       tbm_surface_error_e ret;
+       struct wl_buffer *wl_buffer = NULL;
+
+       if (!PUI_MAGIC_CHECK(handle, PUI_MAGIC_PUI_H))
+       {
+               PUI_MAGIC_FAIL(handle, PUI_MAGIC_PUI_H, __FUNCTION__);
+               return PUI_ERROR_INVALID_HANDLE;
+       }
+
+       if (!handle->current_surface)
+               return PUI_ERROR_INVALID_SURFACE;
+
+       if (!handle->is_buffer_set)
+       {
+               pui_err("[UPDATE] Buffer is not set !\n");
+               return PUI_ERROR_INVALID_BUFFER;
+       }
+
+       surface = handle->current_surface;
+       handle->current_surface = NULL;
+
+       tbm_surface_unmap(surface);
+
+       ret = tbm_surface_queue_enqueue(handle->tbm_queue, surface);
+
+       if (ret != TBM_SURFACE_ERROR_NONE)
+       {
+               pui_err("[UPDATE] enqueue err:%d\n", ret);
+               return PUI_ERROR_INVALID_SURFACE;
+       }
+
+       ret = tbm_surface_queue_acquire(handle->tbm_queue, &surface);
+
+       if (ret != TBM_SURFACE_ERROR_NONE)
+       {
+               pui_err("[UPDATE] acquire err:%d\n", ret);
+               return PUI_ERROR_INVALID_SURFACE;
+       }
+
+       if (!tbm_surface_internal_get_user_data(surface, (unsigned long)&KEY_WL_BUFFER, (void **)&wl_buffer)) {
+               wl_buffer = wayland_tbm_client_create_buffer(handle->wl_tbm_client, surface);
+
+               if (!wl_buffer)
+               {
+                       pui_err("[UPDATE] failed to create wl_buffer tbm_surface:%p\n", surface);
+                       return PUI_ERROR_INVALID_BUFFER;
+               }
+
+               wl_buffer_add_listener(wl_buffer, &buffer_listener, surface);
+
+               tbm_surface_internal_add_user_data(surface, (unsigned long)&KEY_WL_BUFFER, NULL);
+               tbm_surface_internal_set_user_data(surface, (unsigned long)&KEY_WL_BUFFER, wl_buffer);
+               tbm_surface_internal_add_user_data(surface, (unsigned long)&KEY_CLIENT, NULL);
+               tbm_surface_internal_set_user_data(surface, (unsigned long)&KEY_CLIENT, handle);
+       }
+
+       if (!wl_buffer)
+       {
+               pui_err("[UPDATE] dequeue err:%d\n", ret);
+               return PUI_ERROR_INVALID_BUFFER;
+       }
+
+       ecore_wl2_window_buffer_attach(handle->win, wl_buffer, 0, 0, 0);
+       ecore_wl2_window_damage(handle->win, NULL, 0);
+       ecore_wl2_window_commit(handle->win, EINA_TRUE);
+
+       pui_info("[UPDATE] commit wl_buffer:%p, surface:%p\n", wl_buffer, surface);
+
+       handle->is_buffer_set = 0;
+
+       return PUI_ERROR_NONE;
+}
+
+pui_error
+pui_display_manual_render_set(pui_h handle, pui_bool set)
+{
+       pui_ani_h ani_h = NULL;
+
+       if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
+       {
+               PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
+               return PUI_ERROR_INVALID_HANDLE;
+       }
+
+       ani_h = handle->current_ani_h;
+
+       if (ani_h)
+       {
+               if (pui_ani_status_get(ani_h->ani) == PUI_ANI_STATUS_RUNNING ||
+                       pui_ani_status_get(ani_h->ani) == PUI_ANI_STATUS_PAUSED)
+               {
+                       pui_err("Please stop the current animation.\n");
+                       return PUI_ERROR_UNABLE_SET_MANUAL_RENDER;
+               }
+       }
+
+       handle->manual_render = !!set;
+
+       return PUI_ERROR_NONE;
+}
+
+pui_bool
+pui_display_manual_render_get(pui_h handle)
+{
+       if (!PUI_MAGIC_CHECK(handle, PUI_MAGIC_PUI_H))
+       {
+               PUI_MAGIC_FAIL(handle, PUI_MAGIC_PUI_H, __FUNCTION__);
+               return 0;
+       }
+
+       return handle->manual_render;
+}
+
+pui_bool
+pui_display_geometry_get(pui_h handle, int *width, int *height)
+{
+       if (!width || !height)
+               return 0;
+
+       *width = 0;
+       *height = 0;
+       (void) handle;
+
+       if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
+       {
+               PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
+               return 0;
+       }
+
+       if (!pui_module->backend_module_data) {
+               pui_err("pui module data is not loaded\n");
+               return 0;
+       }
+
+       if (!pui_module->backend_module_data->geometry_get)
+       {
+               pui_err("Backend doesn't have geometry_get() !\n");
+               return 0;
+       }
+
+       return pui_module->backend_module_data->geometry_get(width, height);
+}
+
 pui_h
 pui_create(Ecore_Wl2_Window *win)
 {
@@ -88,6 +401,12 @@ pui_create(Ecore_Wl2_Window *win)
                return NULL;
        }
 
+       if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
+       {
+               PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
+               return NULL;
+       }
+
        wl_tbm_client = wayland_tbm_client_init(ecore_wl2_display_get(ewd));
 
        if (!wl_tbm_client)
@@ -107,11 +426,12 @@ pui_create(Ecore_Wl2_Window *win)
        handle->wl_tbm_client = wl_tbm_client;
        handle->ani_handles = NULL;
        handle->current_ani_h = NULL;
+       handle->manual_render = 0;
        handle->backend_module_data = pui_module->backend_module_data;
 
        handle->tbm_queue = wayland_tbm_client_create_surface_queue(handle->wl_tbm_client,
                                                                ecore_wl2_window_surface_get(handle->win),
-                                                               2, 100, 100, TBM_FORMAT_ABGR8888);
+                                                               3, 100, 100, TBM_FORMAT_ABGR8888);
 
        if (!handle->tbm_queue)
        {
@@ -119,6 +439,7 @@ pui_create(Ecore_Wl2_Window *win)
                goto err;
        }
 
+       PUI_MAGIC_SET(handle, PUI_MAGIC_PUI_H);
        return handle;
 
 err:
@@ -132,13 +453,15 @@ pui_destroy(pui_h handle)
 {
        pui_ani_h ani_h = NULL;
 
-       if (!handle)
+       if (!PUI_MAGIC_CHECK(handle, PUI_MAGIC_PUI_H))
+       {
+               PUI_MAGIC_FAIL(handle, PUI_MAGIC_PUI_H, __FUNCTION__);
                return;
+       }
 
        EINA_LIST_FREE(handle->ani_handles, ani_h)
        {
                pui_ani_destroy(ani_h);
-               free(ani_h);
        }
 
        if (handle->tbm_queue)
@@ -152,6 +475,7 @@ pui_destroy(pui_h handle)
                handle->wl_tbm_client = NULL;
        }
 
+       PUI_MAGIC_SET(handle, PUI_MAGIC_NONE);
        free(handle);
 }
 
@@ -170,6 +494,11 @@ _pui_load_backend_module(void)
 
        pui_backend_module_data *backend_module_data = NULL;
 
+       if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
+       {
+               PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
+               return;
+       }
 
        module_info = dlopen(DEFAULT_LIB, RTLD_LAZY);
 
@@ -223,7 +552,7 @@ _pui_load_backend_module(void)
        return;
 
 err:
-       if (backend_module_info && backend_module_info->backend_init)
+       if (backend_module_info && backend_module_info->backend_deinit)
                backend_module_info->backend_deinit(backend_module_data);
 
        if (module_info)
@@ -235,9 +564,9 @@ err:
 static void
 _pui_unload_backend_module(void)
 {
-       if (!pui_module)
+       if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
        {
-               pui_err("Invalid pui module !\n");
+               PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
                return;
        }
 
@@ -257,11 +586,23 @@ _pui_load_backend_collect_animations(void)
 {
        pui_int_error ret;
 
-       if (!pui_module || !pui_module->backend_module_data) {
+       if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
+       {
+               PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
+               return;
+       }
+
+       if (!pui_module->backend_module_data) {
                pui_err("pui module data is not loaded\n");
                return;
        }
 
+       if (!pui_module->backend_module_data->create_ani_collection)
+       {
+               pui_err("Backend doesn't have create_ani_collection() !\n");
+               return;
+       }
+
        ret = pui_module->backend_module_data->create_ani_collection();
        if (ret != PUI_INT_ERROR_NONE) {
                pui_err("Failed to collect animations data (%s)\n",
@@ -311,9 +652,20 @@ _pui_event_shutdown(void)
 int
 pui_init(void)
 {
+       const char *cp = NULL;
+
        if (++_pui_init_count != 1)
          return _pui_init_count;
 
+       _pui_log_level = PUI_LOG_LEVEL_DEBUG;
+
+       cp = getenv("LIBPUI_LOG_LEVEL");
+
+       if (cp)
+       {
+               _pui_log_level = atoi(cp);
+       }
+
        if (pui_module)
        {
                pui_err("Invalid calling of pui_init() !\n");
@@ -328,7 +680,8 @@ pui_init(void)
                goto error;
        }
 
-       //TODO
+       PUI_MAGIC_SET(pui_module, PUI_MAGIC_PUI_M);
+
        ecore_wl2_init();
 
        _pui_event_init();
@@ -351,9 +704,9 @@ pui_shutdown(void)
                return 0;
        }
 
-       if (!pui_module)
+       if (!PUI_MAGIC_CHECK(pui_module, PUI_MAGIC_PUI_M))
        {
-               pui_err("Invalid pui module data !\n");
+               PUI_MAGIC_FAIL(pui_module, PUI_MAGIC_PUI_M, __FUNCTION__);
                return _pui_init_count;
        }
 
@@ -366,6 +719,7 @@ pui_shutdown(void)
 
        ecore_wl2_shutdown();
 
+       PUI_MAGIC_SET(pui_module, PUI_MAGIC_NONE);
        free(pui_module);
 
        return _pui_init_count;