2 * Copyright (c) 2017 TOYOTA MOTOR CORPORATION
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "wm_layer_control.hpp"
19 #include "wm_layer.hpp"
20 #include "wm_client.hpp"
21 #include "request.hpp"
22 #include "json_helper.hpp"
24 #define LC_AREA_PATH "/etc/areas.db"
25 #define LC_LAYER_SETTING_PATH "/etc/layers_setting.json"
26 #define LC_DEFAULT_AREA "fullscreen"
27 #define BACK_GROUND_LAYER "BackGroundLayer"
31 using std::shared_ptr;
35 LayerControl* g_lc_ctxt;
37 static void createCallback_static(ilmObjectType object,
42 static_cast<LayerControl*>(data)->dispatchCreateEvent(object, id, created);
45 static void surfaceCallback_static(t_ilm_surface surface,
46 struct ilmSurfaceProperties* surface_prop,
47 t_ilm_notification_mask mask)
49 g_lc_ctxt->dispatchPropertyChangeEvent(surface, surface_prop, mask);
52 static void layerCallback_static(t_ilm_layer layer,
53 struct ilmLayerProperties* layer_prop,
54 t_ilm_notification_mask mask)
56 g_lc_ctxt->dispatchPropertyChangeEvent(layer, layer_prop, mask);
59 LayerControl::LayerControl(const std::string& root)
61 string area_path = root + LC_AREA_PATH;
62 string layer_path= root + LC_LAYER_SETTING_PATH;
63 // load layers.setting.json
64 WMError ret = this->loadLayerSetting(layer_path);
65 assert(ret == WMError::SUCCESS);
67 ret = this->loadAreaDb(area_path);
68 assert(ret == WMError::SUCCESS);
71 WMError LayerControl::init(const LayerControlCallbacks& cb)
73 HMI_DEBUG("Initialize of ilm library and display");
77 ilmErrorTypes rc = ilm_init();
79 while (rc != ILM_SUCCESS)
84 HMI_ERROR("Could not connect to compositor");
87 HMI_ERROR("Wait to start weston ...");
91 if(rc != ILM_SUCCESS) goto lc_init_error;
93 // Get current screen setting
94 rc = ilm_getScreenIDs(&num, &ids);
96 if(rc != ILM_SUCCESS) goto lc_init_error;
98 for(unsigned i = 0; i < num; i++)
100 HMI_INFO("get screen: %d", ids[i]);
102 // Currently, 0 is only available
103 this->screenID = ids[0];
105 rc = ilm_getPropertiesOfScreen(this->screenID, &this->screen_prop);
107 if(rc != ILM_SUCCESS) goto lc_init_error;
109 // Register Callback from ILM
111 ilm_registerNotification(createCallback_static, this);
113 return WMError::SUCCESS;
116 HMI_ERROR("Failed to initialize. Terminate WM");
118 return WMError::FAIL;
121 void LayerControl::createNewLayer(unsigned id)
123 HMI_INFO("create new ID :%d", id);
124 struct rect rct = this->area2size[LC_DEFAULT_AREA];
125 ilm_layerCreateWithDimension(&id, rct.w, rct.h);
126 //ilm_layerSetSourceRectangle(id, rct.x, rct.y, rct.w, rct.h);
127 //ilm_layerSetDestinationRectangle(id, rct.x, rct.y, rct.w, rct.h);
128 ilm_layerSetOpacity(id, 1.0);
129 ilm_layerSetVisibility(id, ILM_FALSE);
131 auto wm_layer = getWMLayer(id);
132 wm_layer->addLayerToState(id);
133 this->renderLayers();
136 unsigned LayerControl::getNewLayerID(const string& role, string* layer_name)
139 for(const auto& l: this->wm_layers)
141 ret = l->getNewLayerID(role);
144 *layer_name = l->layerName();
145 unsigned uid = l->getUuid();
146 this->lid2wmlid[ret] = uid;
153 shared_ptr<WMLayer> LayerControl::getWMLayer(unsigned layer)
155 unsigned uuid = this->lid2wmlid[layer];
156 return this->wm_layers[uuid];
159 std::shared_ptr<WMLayer> LayerControl::getWMLayer(std::string layer_name)
161 for(auto &l : this->wm_layers)
163 if(l->layerName() == layer_name)
171 struct rect LayerControl::getAreaSize(const std::string& area)
173 return area2size[area];
176 void LayerControl::setupArea(const rectangle& base_rct, double scaling)
179 this->scaling = scaling;
181 rct = this->area2size["normal.full"];
182 this->area2size["normalfull"] = rct;
183 this->area2size["normal"] = rct;
185 for (auto &i : this->area2size)
187 i.second.x = base_rct.left() + static_cast<int>(scaling * i.second.x + 0.5);
188 i.second.y = base_rct.top() + static_cast<int>(scaling * i.second.y + 0.5);
189 i.second.w = static_cast<int>(scaling * i.second.w + 0.5);
190 i.second.h = static_cast<int>(scaling * i.second.h + 0.5);
192 HMI_DEBUG("area:%s size(after) : x:%d y:%d w:%d h:%d",
193 i.first.c_str(), i.second.x, i.second.y, i.second.w, i.second.h);
197 Screen LayerControl::getScreenInfo()
199 return Screen(this->screen_prop.screenWidth, this->screen_prop.screenHeight);
202 double LayerControl::scale()
204 return this->scaling;
207 WMError LayerControl::updateLayer(LayerState& layer_state)
209 return WMError::SUCCESS;
212 WMError LayerControl::renderLayers()
214 HMI_INFO("Commit change");
215 WMError rc = WMError::SUCCESS;
216 vector<unsigned> ivi_l_ids;
217 for(auto& l : this->wm_layers)
219 auto state = l->getLayerState();
220 HMI_DEBUG("layer %s", l->layerName().c_str());
221 for(const auto& id : state.getIviIdList())
223 HMI_DEBUG("Add %d", id);
224 ivi_l_ids.push_back(id);
227 t_ilm_layer* id_array = new t_ilm_layer[ivi_l_ids.size()];
228 if(id_array == nullptr)
230 HMI_WARNING("short memory");
232 return WMError::FAIL;
235 for(const auto& i : ivi_l_ids)
241 ilmErrorTypes ret = ilm_displaySetRenderOrder(this->screenID, id_array, ivi_l_ids.size());
242 if(ret != ILM_SUCCESS)
249 for(auto& l : this->wm_layers)
259 void LayerControl::undoUpdate() {}
261 WMError LayerControl::loadLayerSetting(const string &path)
263 HMI_DEBUG("loading WMLayer(Application Containers) Setting from %s", path);
265 json_object *json_obj, *json_cfg;
266 int ret = jh::inputJsonFilie(path.c_str(), &json_obj);
269 HMI_DEBUG("Could not open %s, so use default area information", path.c_str());
270 return WMError::FAIL;
272 HMI_INFO("json_obj dump:%s", json_object_get_string(json_obj));
274 if (!json_object_object_get_ex(json_obj, "mappings", &json_cfg))
276 HMI_ERROR("Parse Error!!");
277 return WMError::FAIL;
280 int len = json_object_array_length(json_cfg);
281 HMI_DEBUG("json_cfg len:%d", len);
283 for (int i = 0; i < len; i++)
285 json_object *json_tmp = json_object_array_get_idx(json_cfg, i);
286 HMI_DEBUG("> json_tmp dump:%s", json_object_get_string(json_tmp));
288 this->wm_layers.emplace_back(std::make_shared<WMLayer>(json_tmp, i));
290 json_object_put(json_obj);
292 return WMError::SUCCESS;
295 WMError LayerControl::loadAreaDb(const std::string& path)
298 json_object *json_obj;
299 int ret = jh::inputJsonFilie(path.c_str(), &json_obj);
302 HMI_DEBUG("Could not open %s, so use default area information", path.c_str());
303 return WMError::FAIL;
305 HMI_INFO("json_obj dump:%s", json_object_get_string(json_obj));
308 json_object *json_cfg;
309 if (!json_object_object_get_ex(json_obj, "areas", &json_cfg))
311 HMI_ERROR("Parse Error!!");
312 return WMError::FAIL;
315 int len = json_object_array_length(json_cfg);
316 HMI_DEBUG("json_cfg len:%d", len);
319 for (int i = 0; i < len; i++)
321 json_object *json_tmp = json_object_array_get_idx(json_cfg, i);
322 HMI_DEBUG("> json_tmp dump:%s", json_object_get_string(json_tmp));
324 area = jh::getStringFromJson(json_tmp, "name");
327 HMI_ERROR("Parse Error!!");
328 return WMError::FAIL;
330 HMI_DEBUG("> area:%s", area);
332 json_object *json_rect;
333 if (!json_object_object_get_ex(json_tmp, "rect", &json_rect))
335 HMI_ERROR("Parse Error!!");
336 return WMError::FAIL;
338 HMI_DEBUG("> json_rect dump:%s", json_object_get_string(json_rect));
340 struct rect area_size;
341 area_size.x = jh::getIntFromJson(json_rect, "x");
342 area_size.y = jh::getIntFromJson(json_rect, "y");
343 area_size.w = jh::getIntFromJson(json_rect, "w");
344 area_size.h = jh::getIntFromJson(json_rect, "h");
346 this->area2size[area] = area_size;
350 for (const auto& itr : this->area2size)
352 HMI_DEBUG("area:%s x:%d y:%d w:%d h:%d",
353 itr.first.c_str(), itr.second.x, itr.second.y,
354 itr.second.w, itr.second.h);
357 // Release json_object
358 json_object_put(json_obj);
360 return WMError::SUCCESS;
363 WMError LayerControl::layoutChange(const WMAction& action)
365 if (action.visible == TaskVisible::INVISIBLE)
367 // Visibility is not change -> no redraw is required
368 return WMError::SUCCESS;
370 if(action.client == nullptr)
372 HMI_SEQ_ERROR(action.req_num, "client may vanish");
373 return WMError::NOT_REGISTERED;
375 unsigned layer = action.client->layerID();
378 // WMError ret = this->setLayerSize(layer, action.area);
379 auto rect = this->getAreaSize(action.area);
380 HMI_DEBUG("Set layout %d, %d, %d, %d",rect.x, rect.y, rect.w, rect.h);
381 ilm_layerSetSourceRectangle(layer, 0, 0, rect.w, rect.h);
383 ilm_layerSetDestinationRectangle(layer, rect.x, rect.y, rect.w, rect.h);
385 for(auto &wm_layer: this->wm_layers)
387 if(wm_layer->hasLayerID(layer))
389 wm_layer->setAreaToState(action.client->appID(), action.area);
390 /* TODO: manipulate state directly
391 LayerState ls = wm_layer->getLayerState();
392 ls.setArea(action.client->appID(), action.area);
397 return WMError::SUCCESS;
400 WMError LayerControl::visibilityChange(const WMAction& action)
402 WMError ret = WMError::FAIL;
403 if(action.client == nullptr)
405 HMI_SEQ_ERROR(action.req_num, "client may vanish");
406 return WMError::NOT_REGISTERED;
409 if (action.visible == TaskVisible::VISIBLE)
411 ret = this->makeVisible(action.client);
413 else if (action.visible == TaskVisible::INVISIBLE)
415 ret = this->makeInvisible(action.client);
420 void LayerControl::dispatchCreateEvent(ilmObjectType object, unsigned id, bool created)
422 if (ILM_SURFACE == object)
426 ilmSurfaceProperties sp;
428 rc = ilm_getPropertiesOfSurface(id, &sp);
429 if(rc != ILM_SUCCESS)
431 this->cb.surfaceCreated(sp.creatorPid, id);
432 ilm_surfaceAddNotification(id, surfaceCallback_static);
433 ilm_surfaceSetVisibility(id, ILM_TRUE);
437 this->cb.surfaceDestroyed(id);
440 if (ILM_LAYER == object)
444 ilm_layerAddNotification(id, layerCallback_static);
445 // this->cb->layerCreated(id);
449 // this->cb->layerDestroyed(id); // Means Application is dead.
454 void LayerControl::dispatchPropertyChangeEvent(unsigned id,
455 struct ilmSurfaceProperties* sprop,
456 t_ilm_notification_mask mask)
458 pid_t pid = sprop->creatorPid;
459 HMI_DEBUG("pid : %d", pid);
461 if (ILM_NOTIFICATION_VISIBILITY & mask)
463 //this->cb->surfaceVisibilityChanged(id, sprop->visibility);
465 if (ILM_NOTIFICATION_OPACITY & mask)
468 if (ILM_NOTIFICATION_ORIENTATION & mask)
471 if (ILM_NOTIFICATION_SOURCE_RECT & mask)
473 // this->cb->surfaceSourceRectChanged(id, )
475 if (ILM_NOTIFICATION_DEST_RECT & mask)
477 // this->cb->surfaceSourceRectChanged(id, )
479 if (ILM_NOTIFICATION_CONTENT_AVAILABLE & mask)
482 if (ILM_NOTIFICATION_CONTENT_REMOVED & mask)
484 /* application being down */
485 // m_appLayers.remove(pid);
487 if (ILM_NOTIFICATION_CONFIGURED & mask)
489 HMI_DEBUG("surface %d available", id);
490 ilm_surfaceSetSourceRectangle(id, 0, 0, sprop->origSourceWidth, sprop->origSourceHeight);
491 ilm_surfaceSetDestinationRectangle(id, 0, 0, sprop->origSourceWidth, sprop->origSourceHeight);
492 /* qDebug("ILM_NOTIFICATION_CONFIGURED");
493 qDebug(" surfaceProperties %d", surface);
494 qDebug(" surfaceProperties.origSourceWidth: %d", surfaceProperties->origSourceWidth);
495 qDebug(" surfaceProperties.origSourceHeight: %d", surfaceProperties->origSourceHeight);
497 if (surface == WINDOWMANAGER_HOMESCREEN_MAIN_SURFACE_ID) {
498 addSurfaceToLayer(surface, WINDOWMANAGER_LAYER_HOMESCREEN);
499 configureHomeScreenMainSurface(surface, surfaceProperties->origSourceWidth, surfaceProperties->origSourceHeight);
501 ilmErrorTypes result;
502 t_ilm_layer layer = addSurfaceToAppLayer(pid, surface);
505 configureAppSurface(surface,
506 surfaceProperties->origSourceWidth,
507 surfaceProperties->origSourceHeight);
509 result = ilm_layerAddSurface(layer, surface);
510 if (result != ILM_SUCCESS) {
511 qDebug("ilm_layerAddSurface(%d,%d) failed.", layer, surface);
520 void LayerControl::dispatchPropertyChangeEvent(unsigned id,
521 struct ilmLayerProperties* lprop,
522 t_ilm_notification_mask mask)
524 if (ILM_NOTIFICATION_VISIBILITY & mask)
526 //this->cb->layerVisibilityChanged(id, sprop->visibility);
528 if (ILM_NOTIFICATION_OPACITY & mask)
531 if (ILM_NOTIFICATION_ORIENTATION & mask)
534 if (ILM_NOTIFICATION_SOURCE_RECT & mask)
536 // this->cb->surfaceSourceRectChanged(id, )
538 if (ILM_NOTIFICATION_DEST_RECT & mask)
540 // this->cb->surfaceSourceRectChanged(id, )
542 if (ILM_NOTIFICATION_CONTENT_AVAILABLE & mask)
545 if (ILM_NOTIFICATION_CONTENT_REMOVED & mask)
547 /* application being down */
548 // m_appLayers.remove(pid);
550 if (ILM_NOTIFICATION_CONFIGURED & mask)
552 /* qDebug("ILM_NOTIFICATION_CONFIGURED");
553 qDebug(" surfaceProperties %d", surface);
554 qDebug(" surfaceProperties.origSourceWidth: %d", surfaceProperties->origSourceWidth);
555 qDebug(" surfaceProperties.origSourceHeight: %d", surfaceProperties->origSourceHeight);
557 if (surface == WINDOWMANAGER_HOMESCREEN_MAIN_SURFACE_ID) {
558 addSurfaceToLayer(surface, WINDOWMANAGER_LAYER_HOMESCREEN);
559 configureHomeScreenMainSurface(surface, surfaceProperties->origSourceWidth, surfaceProperties->origSourceHeight);
561 ilmErrorTypes result;
562 t_ilm_layer layer = addSurfaceToAppLayer(pid, surface);
565 configureAppSurface(surface,
566 surfaceProperties->origSourceWidth,
567 surfaceProperties->origSourceHeight);
569 result = ilm_layerAddSurface(layer, surface);
570 if (result != ILM_SUCCESS) {
571 qDebug("ilm_layerAddSurface(%d,%d) failed.", layer, surface);
580 WMError LayerControl::makeVisible(const shared_ptr<WMClient> client)
582 WMError ret = WMError::SUCCESS;
583 // Don't check here the client is not nullptr
584 unsigned layer = client->layerID();
586 this->moveForeGround(client);
588 ilm_layerSetVisibility(layer, ILM_TRUE);
590 /* for(auto& wm_layer : this->wm_layers)
592 if(wm_layer->hasLayerID(layer))
594 LayerState ls = wm_layer->getLayerState();
599 // Move foreground from back ground layer
600 /* for(auto& wm_layer : this->wm_layers)
602 if(wm_layer->layerName() == "BackGroundLayer")
604 if(wm_layer->hasRole(client->role()))
606 LayerState ls = wm_layer->getLayerState();
607 ls.removeLayer(layer);
616 WMError LayerControl::makeInvisible(const shared_ptr<WMClient> client)
618 WMError ret = WMError::SUCCESS;
619 unsigned layer = client->layerID(); // Don't check here the client is not nullptr
621 bool mv_ok = this->moveBackGround(client);
625 HMI_INFO("make invisible client %s", client->appID().c_str());
626 ilm_layerSetVisibility(layer, ILM_FALSE);
629 //ilm_layerSetDestinationRectangle(layer, 0, 0, 0, 0);
631 /* for(auto& wm_layer : this->wm_layers)
633 if(wm_layer->hasLayerID(layer))
635 LayerState ls = wm_layer->getLayerState();
636 ls.removeLayer(layer);;
645 bool LayerControl::moveBackGround(const shared_ptr<WMClient> client)
649 // Move background from foreground layer
650 auto bg = this->getWMLayer(BACK_GROUND_LAYER);
653 HMI_DEBUG("client %s role %s", client->appID().c_str(), client->role().c_str());
654 unsigned layer = client->layerID();
655 if(bg->hasRole(client->role()))
657 HMI_INFO("%s go to background", client->appID().c_str());
658 bg->addLayerToState(layer);
659 auto wm_layer = this->getWMLayer(layer);
660 wm_layer->removeLayerFromState(layer);
661 /* TODO: manipulate state directly
662 LayerState bg_ls = bg->getLayerState();
663 bg_ls.addLayer(layer);
664 LayerState ls = wm_layer->getLayerState();
665 ls.removeLayer(layer); */
674 bool LayerControl::moveForeGround(const shared_ptr<WMClient> client)
678 // Move foreground from foreground layer
679 auto bg = this->getWMLayer(BACK_GROUND_LAYER);
682 if(bg->hasRole(client->role()))
684 unsigned layer = client->layerID();
685 HMI_INFO("%s go to foreground", client->appID().c_str());
686 bg->removeLayerFromState(layer);
687 auto wm_layer = this->getWMLayer(layer);
688 wm_layer->addLayerToState(layer);
689 /* TODO: manipulate state directly
690 LayerState bg_ls = bg->getLayerState();
691 bg_ls.removeLayer(layer);
692 LayerState ls = wm_layer->getLayerState();
693 ls.addLayer(layer); */