From e890bc6f1880c8b8a439692ea85c2f3992b99c15 Mon Sep 17 00:00:00 2001 From: Yuta Doi Date: Fri, 22 Dec 2017 21:00:10 +0900 Subject: Add APIs which can get information about the display and the surface area getDisplayInfo() can get the display information as follows: - width[pixel] - height[pixel] - width[mm] - height[mm] NOTE: It uses wl_output::geometry() for getting physical width[mm] and height[mm] of the display, but the value is different with measured value. value from wl_output::geometry(): width:320 height:520 measured value : width:193 height:343 getAreaInfo() can get the information of area drawn by the application as follows: - x-coordinate - y-coordinate - width - height The details are described in doc/ApplicationGuide.md. Bug-AGL: SPEC-1087 Change-Id: I9e6d64ff04e0845b83c69db374d06af17a6d6b66 Signed-off-by: Yuta Doi --- doc/ApplicationGuide.md | 59 ++++++++++++++++++++- src/app.cpp | 138 ++++++++++++++++++++++++++++++++++++++++++++---- src/app.hpp | 36 +++++++++---- src/main.cpp | 61 +++++++++++++++++++++ src/wayland_ivi_wm.cpp | 3 ++ src/wayland_ivi_wm.hpp | 5 +- 6 files changed, 280 insertions(+), 22 deletions(-) diff --git a/doc/ApplicationGuide.md b/doc/ApplicationGuide.md index 7888292..d66f20b 100644 --- a/doc/ApplicationGuide.md +++ b/doc/ApplicationGuide.md @@ -517,6 +517,10 @@ This is the public interface of the class `LibWindowmanager`. int activateSurface(json_object *object); int deactivateSurface(json_object *object); int endDraw(json_object *object); + int getDisplayInfo(json_object *object); + int getAreaInfo(json_object *in_obj, json_object *out_obj); + + int getAreaInfo(const char *label, json_object *out_obj); void set_event_handler(enum EventType et, handler_fun f); @@ -580,6 +584,56 @@ It is not crucial to make this call at every time a drawing is finished drawing in case of layout switch. The exact semantics are explained in the next [Events](#_events) Section. +### getDisplayInfo(json_object *object) + +**args: `{ }`** +This function gets the display information as follows: + - width[pixel] + - height[pixel] + - width[mm] + - height[mm] + +It outputs the display information for json_object in the argument as follows: + `{"width_pixel": int value of width[pixel], "height_pixel": int value of height[pixel], + "width_mm": int value of width[mm], "height_mm": int value of height[mm]}` + +It should be called after calling init(). +It should not be called in the event handler because it occurs hang-up. + +#### NOTE +It uses wl_output::geometry() for getting physical width[mm] and height[mm] of the display, +but the value is different with measured value. + + - value from wl_output::geometry(): width:320 height:520 + - measured value : width:193 height:343 + +### getAreaInfo(json_object *in_obj, json_object *out_obj) + +**args1: `{ 'kKeyDrawingName': 'application name' }`** +**args2: `{ }`** +This function gets the information of area drawn by the application as follows: + - x-coordinate + - y-coordinate + - width + - height + +It outputs the area information for json_object in the 2nd argument as follows: + `{"x": int value of x-coordinate, "y": int value of y-coordinate, + "width": int value of width, "height": int value of height}` + +It should be called after calling activateSurface(). +It should not be called in the event handler because it occurs hang-up. + +#### NOTE +The same information can given by SyncDraw event. + +### getAreaInfo(const char *label, json_object *out_obj) + +**args1: String of application name** +**args2: `{ }`** +This function is same with `getAreaInfo(json_object *in_obj, json_object *out_obj)`, +but only has difference of 1st argument. + ### set\_event\_handler(enum EventType et, handler_fun f) This method needs to be used to register event handlers for the WM @@ -705,11 +759,14 @@ contents - again, this is handled implicitly by the wayland protocol. that is *signal* the compositor that its surface contains new content. - `SyncDraw(json_object *object)` - args: { 'kKeyDrawingName': 'application name', 'kKeyDrawingArea': 'layout' } + args: { 'kKeyDrawingName': 'application name', 'kKeyDrawingArea': 'layout', + 'kKeyDrawingRect': { "x": int value of x-coordinate, "y": int value of y-coordinate, + "width": int value of width, "height": int value of height } } Signal applications, that the surface with name `kKeyDrawingArea` needs to redraw its content in the layout with name `kKeyDrawingArea` - this usually is sent when the surface geometry changed. + And the area position and size are included with name `kKeyDrawingRect`. - `FlushDraw(json_object *object)` args: { 'kKeyDrawingName': 'application name' } diff --git a/src/app.cpp b/src/app.cpp index f99b7db..b966172 100644 --- a/src/app.cpp +++ b/src/app.cpp @@ -38,6 +38,27 @@ namespace wm { +/* DrawingArea name used by "{layout}.{area}" */ +const char kNameLayoutNormal[] = "normal"; +const char kNameLayoutSplit[] = "split"; +const char kNameAreaFull[] = "full"; +const char kNameAreaMain[] = "main"; +const char kNameAreaSub[] = "sub"; + +/* Key for json obejct */ +const char kKeyDrawingName[] = "drawing_name"; +const char kKeyDrawingArea[] = "drawing_area"; +const char kKeyDrawingRect[] = "drawing_rect"; +const char kKeyX[] = "x"; +const char kKeyY[] = "y"; +const char kKeyWidth[] = "width"; +const char kKeyHeight[] = "height"; +const char kKeyWidthPixel[] = "width_pixel"; +const char kKeyHeightPixel[] = "height_pixel"; +const char kKeyWidthMm[] = "width_mm"; +const char kKeyHeightMm[] = "height_mm"; + + namespace { using nlohmann::json; @@ -197,6 +218,8 @@ int App::init_layers() { // Write output dimensions to ivi controller... c->output_size = compositor::size{uint32_t(o->width), uint32_t(o->height)}; + c->physical_size = compositor::size{uint32_t(o->physical_width), + uint32_t(o->physical_height)}; // Clear scene layers.clear(); @@ -283,6 +306,10 @@ void App::surface_set_layout(int surface_id, optional sub_surface_id) { // set destination to the display rectangle ss->set_destination_rectangle(x + x_off, y + y_off, w, h); + this->area_info[*sub_surface_id].x = x; + this->area_info[*sub_surface_id].y = y; + this->area_info[*sub_surface_id].w = w; + this->area_info[*sub_surface_id].h = h; } HMI_DEBUG("wm", "surface_set_layout for surface %u on layer %u", surface_id, @@ -291,6 +318,12 @@ void App::surface_set_layout(int surface_id, optional sub_surface_id) { // set destination to the display rectangle s->set_destination_rectangle(x, y, w, h); + // update area information + this->area_info[surface_id].x = x; + this->area_info[surface_id].y = y; + this->area_info[surface_id].w = w; + this->area_info[surface_id].h = h; + HMI_DEBUG("wm", "Surface %u now on layer %u with rect { %d, %d, %d, %d }", surface_id, layer_id, x, y, w, h); } @@ -364,7 +397,9 @@ char const *App::api_activate_surface(char const *drawing_name, char const *draw this->layout_commit(); std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull); - this->emit_syncdraw(drawing_name, str_area.c_str()); + compositor::rect area_rect = this->area_info[*surface_id]; + this->emit_syncdraw(drawing_name, str_area.c_str(), + area_rect.x, area_rect.y, area_rect.w, area_rect.h); this->enqueue_flushdraw(state.main); }); } else { @@ -373,7 +408,9 @@ char const *App::api_activate_surface(char const *drawing_name, char const *draw state, LayoutState{*surface_id}, [&] (LayoutState const &nl) { HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal); std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull); - this->emit_syncdraw(drawing_name, str_area.c_str()); + compositor::rect area_rect = this->area_info[*surface_id]; + this->emit_syncdraw(drawing_name, str_area.c_str(), + area_rect.x, area_rect.y, area_rect.w, area_rect.h); this->enqueue_flushdraw(state.main); }); } else { @@ -401,8 +438,14 @@ char const *App::api_activate_surface(char const *drawing_name, char const *draw std::string str_area_main = std::string(kNameLayoutSplit) + "." + std::string(kNameAreaMain); std::string str_area_sub = std::string(kNameLayoutSplit) + "." + std::string(kNameAreaSub); - this->emit_syncdraw(main.c_str(), str_area_main.c_str()); - this->emit_syncdraw(drawing_name, str_area_sub.c_str()); + compositor::rect area_rect_main = this->area_info[state.main]; + compositor::rect area_rect_sub = this->area_info[*surface_id]; + this->emit_syncdraw(main.c_str(), str_area_main.c_str(), + area_rect_main.x, area_rect_main.y, + area_rect_main.w, area_rect_main.h); + this->emit_syncdraw(drawing_name, str_area_sub.c_str(), + area_rect_sub.x, area_rect_sub.y, + area_rect_sub.w, area_rect_sub.h); this->enqueue_flushdraw(state.main); this->enqueue_flushdraw(state.sub); }); @@ -426,7 +469,9 @@ char const *App::api_activate_surface(char const *drawing_name, char const *draw this->layout_commit(); std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull); - this->emit_syncdraw(drawing_name, str_area.c_str()); + compositor::rect area_rect = this->area_info[*surface_id]; + this->emit_syncdraw(drawing_name, str_area.c_str(), + area_rect.x, area_rect.y, area_rect.w, area_rect.h); this->enqueue_flushdraw(state.main); }); } @@ -479,7 +524,9 @@ char const *App::api_deactivate_surface(char const *drawing_name) { this->layout_commit(); std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull); - this->emit_syncdraw(sub.c_str(), str_area.c_str()); + compositor::rect area_rect = this->area_info[state.sub]; + this->emit_syncdraw(sub.c_str(), str_area.c_str(), + area_rect.x, area_rect.y, area_rect.w, area_rect.h); this->enqueue_flushdraw(state.sub); }); } else { @@ -500,7 +547,9 @@ char const *App::api_deactivate_surface(char const *drawing_name) { this->layout_commit(); std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull); - this->emit_syncdraw(main.c_str(), str_area.c_str()); + compositor::rect area_rect = this->area_info[state.main]; + this->emit_syncdraw(main.c_str(), str_area.c_str(), + area_rect.x, area_rect.y, area_rect.w, area_rect.h); this->enqueue_flushdraw(state.main); }); } else { @@ -559,12 +608,21 @@ void App::send_event(char const *evname, char const *label){ } } -void App::send_event(char const *evname, char const *label, char const *area){ - HMI_DEBUG("wm", "%s: %s(%s, %s)", __func__, evname, label, area); +void App::send_event(char const *evname, char const *label, char const *area, + int x, int y, int w, int h) { + HMI_DEBUG("wm", "%s: %s(%s, %s) x:%d y:%d w:%d h:%d", + __func__, evname, label, area, x, y, w, h); + + json_object *j_rect = json_object_new_object(); + json_object_object_add(j_rect, kKeyX, json_object_new_int(x)); + json_object_object_add(j_rect, kKeyY, json_object_new_int(y)); + json_object_object_add(j_rect, kKeyWidth, json_object_new_int(w)); + json_object_object_add(j_rect, kKeyHeight, json_object_new_int(h)); json_object *j = json_object_new_object(); json_object_object_add(j, kKeyDrawingName, json_object_new_string(label)); json_object_object_add(j, kKeyDrawingArea, json_object_new_string(area)); + json_object_object_add(j, kKeyDrawingRect, j_rect); int ret = afb_event_push(this->map_afb_event[evname], j); if (ret != 0) { @@ -622,8 +680,8 @@ void App::emit_deactivated(char const *label) { this->send_event(kListEventName[Event_Inactive], label); } -void App::emit_syncdraw(char const *label, char const *area) { - this->send_event(kListEventName[Event_SyncDraw], label, area); +void App::emit_syncdraw(char const *label, char const *area, int x, int y, int w, int h) { + this->send_event(kListEventName[Event_SyncDraw], label, area, x, y, w, h); } void App::emit_flushdraw(char const *label) { @@ -697,6 +755,64 @@ char const *App::api_request_surface(char const *drawing_name, return nullptr; } +result App::api_get_display_info() { + // Check controller + if (!this->controller) { + return Err("ivi_controller global not available"); + } + + // Set display info + compositor::size o_size = this->controller->output_size; + compositor::size p_size = this->controller->physical_size; + + json_object *object = json_object_new_object(); + json_object_object_add(object, kKeyWidthPixel, json_object_new_int(o_size.w)); + json_object_object_add(object, kKeyHeightPixel, json_object_new_int(o_size.h)); + json_object_object_add(object, kKeyWidthMm, json_object_new_int(p_size.w)); + json_object_object_add(object, kKeyHeightMm, json_object_new_int(p_size.h)); + + return Ok(object); +} + +result App::api_get_area_info(char const *drawing_name) { + HMI_DEBUG("wm", "called"); + + // Check drawing name, surface/layer id + auto const &surface_id = this->lookup_id(drawing_name); + if (!surface_id) { + return Err("Surface does not exist"); + } + + if (!this->controller->surface_exists(*surface_id)) { + return Err("Surface does not exist in controller!"); + } + + auto layer_id = this->layers.get_layer_id(*surface_id); + if (!layer_id) { + return Err("Surface is not on any layer!"); + } + + auto o_state = *this->layers.get_layout_state(*surface_id); + if (o_state == nullptr) { + return Err("Could not find layer for surface"); + } + + struct LayoutState &state = *o_state; + if ((state.main != *surface_id) && (state.sub != *surface_id)) { + return Err("Surface is inactive"); + } + + // Set area rectangle + compositor::rect area_info = this->area_info[*surface_id]; + json_object *object = json_object_new_object(); + json_object_object_add(object, kKeyX, json_object_new_int(area_info.x)); + json_object_object_add(object, kKeyY, json_object_new_int(area_info.y)); + json_object_object_add(object, kKeyWidth, json_object_new_int(area_info.w)); + json_object_object_add(object, kKeyHeight, json_object_new_int(area_info.h)); + + return Ok(object); +} + void App::activate(int id) { auto ip = this->controller->sprops.find(id); if (ip != this->controller->sprops.end()) { diff --git a/src/app.hpp b/src/app.hpp index 7fccde3..07bd918 100644 --- a/src/app.hpp +++ b/src/app.hpp @@ -46,15 +46,25 @@ namespace wm { using std::experimental::optional; /* DrawingArea name used by "{layout}.{area}" */ -static const char *kNameLayoutNormal = "normal"; -static const char *kNameLayoutSplit = "split"; -static const char *kNameAreaFull = "full"; -static const char *kNameAreaMain = "main"; -static const char *kNameAreaSub = "sub"; +extern const char kNameLayoutNormal[]; +extern const char kNameLayoutSplit[]; +extern const char kNameAreaFull[]; +extern const char kNameAreaMain[]; +extern const char kNameAreaSub[]; /* Key for json obejct */ -static const char *kKeyDrawingName = "drawing_name"; -static const char *kKeyDrawingArea = "drawing_area"; +extern const char kKeyDrawingName[]; +extern const char kKeyDrawingArea[]; +extern const char kKeyDrawingRect[]; +extern const char kKeyX[]; +extern const char kKeyY[]; +extern const char kKeyWidth[]; +extern const char kKeyHeigh[]; +extern const char kKeyWidthPixel[]; +extern const char kKeyHeightPixel[]; +extern const char kKeyWidthMm[]; +extern const char kKeyHeightMm[]; + struct id_allocator { unsigned next = 1; @@ -118,6 +128,9 @@ struct id_allocator { }; struct App { + + typedef std::unordered_map rect_map; + enum EventType { Event_Val_Min = 0, @@ -167,6 +180,9 @@ struct App { std::map map_afb_event; + // Surface are info (x, y, w, h) + rect_map area_info; + // FOR CES DEMO std::vector surface_bg; @@ -189,10 +205,12 @@ struct App { char const *api_activate_surface(char const *drawing_name, char const *drawing_area); char const *api_deactivate_surface(char const *drawing_name); char const *api_enddraw(char const *drawing_name); + result api_get_display_info(); + result api_get_area_info(char const *drawing_name); char const *api_subscribe(afb_req *req, char const *event_name); void api_ping(); void send_event(char const *evname, char const *label); - void send_event(char const *evname, char const *label, char const *area); + void send_event(char const *evname, char const *label, char const *area, int x, int y, int w, int h); // Events from the compositor we are interested in void surface_created(uint32_t surface_id); @@ -215,7 +233,7 @@ private: // TMC WM Events to clients void emit_activated(char const *label); void emit_deactivated(char const *label); - void emit_syncdraw(char const *label, char const *area); + void emit_syncdraw(char const *label, char const *area, int x, int y, int w, int h); void emit_flushdraw(char const *label); void emit_visible(char const *label, bool is_visible); void emit_invisible(char const *label); diff --git a/src/main.cpp b/src/main.cpp index 8e252d4..fd96d33 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -373,6 +373,65 @@ void windowmanager_enddraw(afb_req req) noexcept { } +void windowmanager_getdisplayinfo_thunk(afb_req req) noexcept { + std::lock_guard guard(binding_m); + #ifdef ST + ST(); + #endif + if (g_afb_instance == nullptr) { + afb_req_fail(req, "failed", "Binding not initialized, did the compositor die?"); + return; + } + + try { + auto ret = g_afb_instance->app.api_get_display_info(); + if (ret.is_err()) { + afb_req_fail(req, "failed", ret.unwrap_err()); + return; + } + + afb_req_success(req, ret.unwrap(), "success"); + } catch (std::exception &e) { + afb_req_fail_f(req, "failed", "Uncaught exception while calling getdisplayinfo: %s", e.what()); + return; + } + +} + +void windowmanager_getareainfo_thunk(afb_req req) noexcept { + std::lock_guard guard(binding_m); + #ifdef ST + ST(); + #endif + if (g_afb_instance == nullptr) { + afb_req_fail(req, "failed", "Binding not initialized, did the compositor die?"); + return; + } + + try { + json_object *jreq = afb_req_json(req); + + json_object *j_drawing_name = nullptr; + if (! json_object_object_get_ex(jreq, "drawing_name", &j_drawing_name)) { + afb_req_fail(req, "failed", "Need char const* argument drawing_name"); + return; + } + char const* a_drawing_name = json_object_get_string(j_drawing_name); + + auto ret = g_afb_instance->app.api_get_area_info(a_drawing_name); + if (ret.is_err()) { + afb_req_fail(req, "failed", ret.unwrap_err()); + return; + } + + afb_req_success(req, ret.unwrap(), "success"); + } catch (std::exception &e) { + afb_req_fail_f(req, "failed", "Uncaught exception while calling getareainfo: %s", e.what()); + return; + } + +} + void windowmanager_wm_subscribe(afb_req req) noexcept { std::lock_guard guard(binding_m); #ifdef ST @@ -562,6 +621,8 @@ const struct afb_verb_v2 windowmanager_verbs[] = { { "activatesurface", windowmanager_activatesurface, nullptr, nullptr, AFB_SESSION_NONE }, { "deactivatesurface", windowmanager_deactivatesurface, nullptr, nullptr, AFB_SESSION_NONE }, { "enddraw", windowmanager_enddraw, nullptr, nullptr, AFB_SESSION_NONE }, + { "getdisplayinfo", windowmanager_getdisplayinfo_thunk, nullptr, nullptr, AFB_SESSION_NONE }, + { "getareainfo", windowmanager_getareainfo_thunk, nullptr, nullptr, AFB_SESSION_NONE }, { "wm_subscribe", windowmanager_wm_subscribe, nullptr, nullptr, AFB_SESSION_NONE }, { "list_drawing_names", windowmanager_list_drawing_names, nullptr, nullptr, AFB_SESSION_NONE }, { "ping", windowmanager_ping, nullptr, nullptr, AFB_SESSION_NONE }, diff --git a/src/wayland_ivi_wm.cpp b/src/wayland_ivi_wm.cpp index 2937487..f1a0c2b 100644 --- a/src/wayland_ivi_wm.cpp +++ b/src/wayland_ivi_wm.cpp @@ -148,6 +148,8 @@ void output::geometry(int32_t x, int32_t y, int32_t pw, int32_t ph, HMI_DEBUG("wm", "wl::output %s @ %p x %i y %i w %i h %i spel %x make %s model %s tx %i", __func__, this->proxy.get(), x, y, pw, ph, subpel, make, model, tx); + this->physical_width = pw; + this->physical_height = ph; this->transform = tx; } @@ -169,6 +171,7 @@ void output::done() { this->transform == WL_OUTPUT_TRANSFORM_FLIPPED_90 || this->transform == WL_OUTPUT_TRANSFORM_FLIPPED_270) { std::swap(this->width, this->height); + std::swap(this->physical_width, this->physical_height); } } diff --git a/src/wayland_ivi_wm.hpp b/src/wayland_ivi_wm.hpp index a51a1a0..872e287 100644 --- a/src/wayland_ivi_wm.hpp +++ b/src/wayland_ivi_wm.hpp @@ -96,6 +96,8 @@ struct display { struct output : public wayland_proxy { int width{}; int height{}; + int physical_width{}; + int physical_height{}; int refresh{}; int transform{}; @@ -235,7 +237,8 @@ struct controller : public wayland_proxy { std::unique_ptr screen; - size output_size; + size output_size; // Display size[pixel] + size physical_size; // Display size[mm] wm::controller_hooks *chooks; -- cgit 1.2.3-korg