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)
238 HMI_DEBUG("check render order %d", i);
242 ilmErrorTypes ret = ilm_displaySetRenderOrder(this->screenID, id_array, ivi_l_ids.size());
243 if(ret != ILM_SUCCESS)
250 for(auto& l : this->wm_layers)
260 void LayerControl::undoUpdate() {}
262 WMError LayerControl::loadLayerSetting(const string &path)
264 HMI_DEBUG("loading WMLayer(Application Containers) Setting from %s", path);
266 json_object *json_obj, *json_cfg;
267 int ret = jh::inputJsonFilie(path.c_str(), &json_obj);
270 HMI_DEBUG("Could not open %s, so use default area information", path.c_str());
271 return WMError::FAIL;
273 HMI_INFO("json_obj dump:%s", json_object_get_string(json_obj));
275 if (!json_object_object_get_ex(json_obj, "mappings", &json_cfg))
277 HMI_ERROR("Parse Error!!");
278 return WMError::FAIL;
281 int len = json_object_array_length(json_cfg);
282 HMI_DEBUG("json_cfg len:%d", len);
284 for (int i = 0; i < len; i++)
286 json_object *json_tmp = json_object_array_get_idx(json_cfg, i);
287 HMI_DEBUG("> json_tmp dump:%s", json_object_get_string(json_tmp));
289 this->wm_layers.emplace_back(std::make_shared<WMLayer>(json_tmp, i));
291 json_object_put(json_obj);
293 return WMError::SUCCESS;
296 WMError LayerControl::loadAreaDb(const std::string& path)
299 json_object *json_obj;
300 int ret = jh::inputJsonFilie(path.c_str(), &json_obj);
303 HMI_DEBUG("Could not open %s, so use default area information", path.c_str());
304 return WMError::FAIL;
306 HMI_INFO("json_obj dump:%s", json_object_get_string(json_obj));
309 json_object *json_cfg;
310 if (!json_object_object_get_ex(json_obj, "areas", &json_cfg))
312 HMI_ERROR("Parse Error!!");
313 return WMError::FAIL;
316 int len = json_object_array_length(json_cfg);
317 HMI_DEBUG("json_cfg len:%d", len);
320 for (int i = 0; i < len; i++)
322 json_object *json_tmp = json_object_array_get_idx(json_cfg, i);
323 HMI_DEBUG("> json_tmp dump:%s", json_object_get_string(json_tmp));
325 area = jh::getStringFromJson(json_tmp, "name");
328 HMI_ERROR("Parse Error!!");
329 return WMError::FAIL;
331 HMI_DEBUG("> area:%s", area);
333 json_object *json_rect;
334 if (!json_object_object_get_ex(json_tmp, "rect", &json_rect))
336 HMI_ERROR("Parse Error!!");
337 return WMError::FAIL;
339 HMI_DEBUG("> json_rect dump:%s", json_object_get_string(json_rect));
341 struct rect area_size;
342 area_size.x = jh::getIntFromJson(json_rect, "x");
343 area_size.y = jh::getIntFromJson(json_rect, "y");
344 area_size.w = jh::getIntFromJson(json_rect, "w");
345 area_size.h = jh::getIntFromJson(json_rect, "h");
347 this->area2size[area] = area_size;
351 for (const auto& itr : this->area2size)
353 HMI_DEBUG("area:%s x:%d y:%d w:%d h:%d",
354 itr.first.c_str(), itr.second.x, itr.second.y,
355 itr.second.w, itr.second.h);
358 // Release json_object
359 json_object_put(json_obj);
361 return WMError::SUCCESS;
364 WMError LayerControl::layoutChange(const WMAction& action)
366 if (action.visible == TaskVisible::INVISIBLE)
368 // Visibility is not change -> no redraw is required
369 return WMError::SUCCESS;
371 if(action.client == nullptr)
373 HMI_SEQ_ERROR(action.req_num, "client may vanish");
374 return WMError::NOT_REGISTERED;
376 unsigned layer = action.client->layerID();
379 // WMError ret = this->setLayerSize(layer, action.area);
380 auto rect = this->getAreaSize(action.area);
381 HMI_DEBUG("Set layout %d, %d, %d, %d",rect.x, rect.y, rect.w, rect.h);
382 ilm_layerSetSourceRectangle(layer, 0, 0, rect.w, rect.h);
384 ilm_layerSetDestinationRectangle(layer, rect.x, rect.y, rect.w, rect.h);
386 for(auto &wm_layer: this->wm_layers)
388 if(wm_layer->hasLayerID(layer))
390 LayerState ls = wm_layer->getLayerState();
391 ls.setArea(action.client->appID(), action.area);
395 return WMError::SUCCESS;
398 WMError LayerControl::visibilityChange(const WMAction& action)
400 WMError ret = WMError::FAIL;
401 if(action.client == nullptr)
403 HMI_SEQ_ERROR(action.req_num, "client may vanish");
404 return WMError::NOT_REGISTERED;
407 if (action.visible == TaskVisible::VISIBLE)
409 ret = this->makeVisible(action.client);
411 else if (action.visible == TaskVisible::INVISIBLE)
413 ret = this->makeInvisible(action.client);
418 void LayerControl::dispatchCreateEvent(ilmObjectType object, unsigned id, bool created)
420 if (ILM_SURFACE == object)
424 ilmSurfaceProperties sp;
426 rc = ilm_getPropertiesOfSurface(id, &sp);
427 if(rc != ILM_SUCCESS)
429 this->cb.surfaceCreated(sp.creatorPid, id);
430 ilm_surfaceAddNotification(id, surfaceCallback_static);
431 ilm_surfaceSetVisibility(id, ILM_TRUE);
435 this->cb.surfaceDestroyed(id);
438 if (ILM_LAYER == object)
442 ilm_layerAddNotification(id, layerCallback_static);
443 // this->cb->layerCreated(id);
447 // this->cb->layerDestroyed(id); // Means Application is dead.
452 void LayerControl::dispatchPropertyChangeEvent(unsigned id,
453 struct ilmSurfaceProperties* sprop,
454 t_ilm_notification_mask mask)
456 pid_t pid = sprop->creatorPid;
457 HMI_DEBUG("pid : %d", pid);
459 if (ILM_NOTIFICATION_VISIBILITY & mask)
461 //this->cb->surfaceVisibilityChanged(id, sprop->visibility);
463 if (ILM_NOTIFICATION_OPACITY & mask)
466 if (ILM_NOTIFICATION_ORIENTATION & mask)
469 if (ILM_NOTIFICATION_SOURCE_RECT & mask)
471 // this->cb->surfaceSourceRectChanged(id, )
473 if (ILM_NOTIFICATION_DEST_RECT & mask)
475 // this->cb->surfaceSourceRectChanged(id, )
477 if (ILM_NOTIFICATION_CONTENT_AVAILABLE & mask)
480 if (ILM_NOTIFICATION_CONTENT_REMOVED & mask)
482 /* application being down */
483 // m_appLayers.remove(pid);
485 if (ILM_NOTIFICATION_CONFIGURED & mask)
487 HMI_DEBUG("surface %d available", id);
488 ilm_surfaceSetSourceRectangle(id, 0, 0, sprop->origSourceWidth, sprop->origSourceHeight);
489 ilm_surfaceSetDestinationRectangle(id, 0, 0, sprop->origSourceWidth, sprop->origSourceHeight);
490 /* qDebug("ILM_NOTIFICATION_CONFIGURED");
491 qDebug(" surfaceProperties %d", surface);
492 qDebug(" surfaceProperties.origSourceWidth: %d", surfaceProperties->origSourceWidth);
493 qDebug(" surfaceProperties.origSourceHeight: %d", surfaceProperties->origSourceHeight);
495 if (surface == WINDOWMANAGER_HOMESCREEN_MAIN_SURFACE_ID) {
496 addSurfaceToLayer(surface, WINDOWMANAGER_LAYER_HOMESCREEN);
497 configureHomeScreenMainSurface(surface, surfaceProperties->origSourceWidth, surfaceProperties->origSourceHeight);
499 ilmErrorTypes result;
500 t_ilm_layer layer = addSurfaceToAppLayer(pid, surface);
503 configureAppSurface(surface,
504 surfaceProperties->origSourceWidth,
505 surfaceProperties->origSourceHeight);
507 result = ilm_layerAddSurface(layer, surface);
508 if (result != ILM_SUCCESS) {
509 qDebug("ilm_layerAddSurface(%d,%d) failed.", layer, surface);
518 void LayerControl::dispatchPropertyChangeEvent(unsigned id,
519 struct ilmLayerProperties* lprop,
520 t_ilm_notification_mask mask)
522 if (ILM_NOTIFICATION_VISIBILITY & mask)
524 //this->cb->layerVisibilityChanged(id, sprop->visibility);
526 if (ILM_NOTIFICATION_OPACITY & mask)
529 if (ILM_NOTIFICATION_ORIENTATION & mask)
532 if (ILM_NOTIFICATION_SOURCE_RECT & mask)
534 // this->cb->surfaceSourceRectChanged(id, )
536 if (ILM_NOTIFICATION_DEST_RECT & mask)
538 // this->cb->surfaceSourceRectChanged(id, )
540 if (ILM_NOTIFICATION_CONTENT_AVAILABLE & mask)
543 if (ILM_NOTIFICATION_CONTENT_REMOVED & mask)
545 /* application being down */
546 // m_appLayers.remove(pid);
548 if (ILM_NOTIFICATION_CONFIGURED & mask)
550 /* qDebug("ILM_NOTIFICATION_CONFIGURED");
551 qDebug(" surfaceProperties %d", surface);
552 qDebug(" surfaceProperties.origSourceWidth: %d", surfaceProperties->origSourceWidth);
553 qDebug(" surfaceProperties.origSourceHeight: %d", surfaceProperties->origSourceHeight);
555 if (surface == WINDOWMANAGER_HOMESCREEN_MAIN_SURFACE_ID) {
556 addSurfaceToLayer(surface, WINDOWMANAGER_LAYER_HOMESCREEN);
557 configureHomeScreenMainSurface(surface, surfaceProperties->origSourceWidth, surfaceProperties->origSourceHeight);
559 ilmErrorTypes result;
560 t_ilm_layer layer = addSurfaceToAppLayer(pid, surface);
563 configureAppSurface(surface,
564 surfaceProperties->origSourceWidth,
565 surfaceProperties->origSourceHeight);
567 result = ilm_layerAddSurface(layer, surface);
568 if (result != ILM_SUCCESS) {
569 qDebug("ilm_layerAddSurface(%d,%d) failed.", layer, surface);
578 WMError LayerControl::makeVisible(const shared_ptr<WMClient> client)
580 WMError ret = WMError::SUCCESS;
581 // Don't check here the client is not nullptr
582 unsigned layer = client->layerID();
584 this->moveForeGround(client);
586 ilm_layerSetVisibility(layer, ILM_TRUE);
588 /* for(auto& wm_layer : this->wm_layers)
590 if(wm_layer->hasLayerID(layer))
592 LayerState ls = wm_layer->getLayerState();
597 // Move foreground from back ground layer
598 /* for(auto& wm_layer : this->wm_layers)
600 if(wm_layer->layerName() == "BackGroundLayer")
602 if(wm_layer->hasRole(client->role()))
604 LayerState ls = wm_layer->getLayerState();
605 ls.removeLayer(layer);
614 WMError LayerControl::makeInvisible(const shared_ptr<WMClient> client)
616 WMError ret = WMError::SUCCESS;
617 unsigned layer = client->layerID(); // Don't check here the client is not nullptr
619 bool mv_ok = this->moveBackGround(client);
623 HMI_INFO("make invisible client %s", client->appID().c_str());
624 ilm_layerSetVisibility(layer, ILM_FALSE);
627 //ilm_layerSetDestinationRectangle(layer, 0, 0, 0, 0);
629 /* for(auto& wm_layer : this->wm_layers)
631 if(wm_layer->hasLayerID(layer))
633 LayerState ls = wm_layer->getLayerState();
634 ls.removeLayer(layer);;
643 bool LayerControl::moveBackGround(const shared_ptr<WMClient> client)
647 // Move background from foreground layer
648 auto bg = this->getWMLayer(BACK_GROUND_LAYER);
651 HMI_DEBUG("client %s role %s", client->appID().c_str(), client->role().c_str());
652 unsigned layer = client->layerID();
653 if(bg->hasRole(client->role()))
655 HMI_INFO("%s go to background", client->appID().c_str());
656 bg->addLayerToState(layer);
657 auto wm_layer = this->getWMLayer(layer);
658 wm_layer->removeLayerFromState(layer);
659 /* TODO: manipulate state directly
660 LayerState bg_ls = bg->getLayerState();
661 bg_ls.addLayer(layer);
662 LayerState ls = wm_layer->getLayerState();
663 ls.removeLayer(layer); */
672 bool LayerControl::moveForeGround(const shared_ptr<WMClient> client)
676 // Move foreground from foreground layer
677 auto bg = this->getWMLayer(BACK_GROUND_LAYER);
680 if(bg->hasRole(client->role()))
682 unsigned layer = client->layerID();
683 HMI_INFO("%s go to foreground", client->appID().c_str());
684 bg->removeLayerFromState(layer);
685 auto wm_layer = this->getWMLayer(layer);
686 wm_layer->addLayerToState(layer);
687 /* TODO: manipulate state directly
688 LayerState bg_ls = bg->getLayerState();
689 bg_ls.removeLayer(layer);
690 LayerState ls = wm_layer->getLayerState();
691 ls.addLayer(layer); */