src/app.hpp

   1 /*
   2  * Copyright (c) 2017 TOYOTA MOTOR CORPORATION
   3  *
   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
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #ifndef TMCAGLWM_APP_HPP
  18 #define TMCAGLWM_APP_HPP
  19
  20 #include <json-c/json.h>
  21 #include <atomic>
  22 #include <memory>
  23 #include <unordered_map>
  24 #include <experimental/optional>
  25 #include "controller_hooks.hpp"
  26 #include "layers.hpp"
  27 #include "layout.hpp"
  28 #include "wayland_ivi_wm.hpp"
  29 #include "hmi-debug.h"
  30
  31 namespace wl
  32 {
  33 struct display;
  34 }
  35
  36 namespace compositor
  37 {
  38 struct controller;
  39 }
  40
  41 namespace wm
  42 {
  43
  44 using std::experimental::optional;
  45
  46 /* DrawingArea name used by "{layout}.{area}" */
  47 extern const char kNameLayoutNormal[];
  48 extern const char kNameLayoutSplit[];
  49 extern const char kNameAreaFull[];
  50 extern const char kNameAreaMain[];
  51 extern const char kNameAreaSub[];
  52
  53 /* Key for json obejct */
  54 extern const char kKeyDrawingName[];
  55 extern const char kKeyDrawingArea[];
  56 extern const char kKeyDrawingRect[];
  57 extern const char kKeyX[];
  58 extern const char kKeyY[];
  59 extern const char kKeyWidth[];
  60 extern const char kKeyHeigh[];
  61 extern const char kKeyWidthPixel[];
  62 extern const char kKeyHeightPixel[];
  63 extern const char kKeyWidthMm[];
  64 extern const char kKeyHeightMm[];
  65
  66 struct id_allocator
  67 {
  68     unsigned next = 1;
  69
  70     // Surfaces that where requested but not yet created
  71     std::unordered_map<unsigned, std::string> id2name;
  72     // std::unordered_set<unsigned> pending_surfaces;
  73     std::unordered_map<std::string, unsigned> name2id;
  74
  75     id_allocator(id_allocator const &) = delete;
  76     id_allocator(id_allocator &&) = delete;
  77     id_allocator &operator=(id_allocator const &);
  78     id_allocator &operator=(id_allocator &&) = delete;
  79
  80     // Insert and return a new ID
  81     unsigned generate_id(std::string const &name)
  82     {
  83         unsigned sid = this->next++;
  84         this->id2name[sid] = name;
  85         // this->pending_surfaces.insert({sid});
  86         this->name2id[name] = sid;
  87         HMI_DEBUG("wm", "allocated new id %u with name %s", sid, name.c_str());
  88         return sid;
  89     }
  90
  91     // Insert a new ID which defined outside
  92     void register_name_id(std::string const &name, unsigned sid)
  93     {
  94         this->id2name[sid] = name;
  95         this->name2id[name] = sid;
  96         HMI_DEBUG("wm", "register id %u with name %s", sid, name.c_str());
  97         return;
  98     }
  99
 100     // Lookup by ID or by name
 101     optional<unsigned> lookup(std::string const &name) const
 102     {
 103         auto i = this->name2id.find(name);
 104         return i == this->name2id.end() ? nullopt : optional<unsigned>(i->second);
 105     }
 106
 107     optional<std::string> lookup(unsigned id) const
 108     {
 109         auto i = this->id2name.find(id);
 110         return i == this->id2name.end() ? nullopt
 111                                         : optional<std::string>(i->second);
 112     }
 113
 114     // Remove a surface id and name
 115     void remove_id(std::string const &name)
 116     {
 117         auto i = this->name2id.find(name);
 118         if (i != this->name2id.end())
 119         {
 120             this->id2name.erase(i->second);
 121             this->name2id.erase(i);
 122         }
 123     }
 124
 125     void remove_id(unsigned id)
 126     {
 127         auto i = this->id2name.find(id);
 128         if (i != this->id2name.end())
 129         {
 130             this->name2id.erase(i->second);
 131             this->id2name.erase(i);
 132         }
 133     }
 134 };
 135
 136 struct App
 137 {
 138
 139     typedef std::unordered_map<uint32_t, struct compositor::rect> rect_map;
 140     typedef std::function<void(const char *err_msg)> reply_func;
 141
 142     enum EventType
 143     {
 144         Event_Val_Min = 0,
 145
 146         Event_Active = Event_Val_Min,
 147         Event_Inactive,
 148
 149         Event_Visible,
 150         Event_Invisible,
 151
 152         Event_SyncDraw,
 153         Event_FlushDraw,
 154
 155         Event_Val_Max = Event_FlushDraw,
 156     };
 157
 158     const std::vector<const char *> kListEventName{
 159         "active",
 160         "inactive",
 161         "visible",
 162         "invisible",
 163         "syncdraw",
 164         "flushdraw"};
 165
 166     struct controller_hooks chooks;
 167
 168     // This is the one thing, we do not own.
 169     struct wl::display *display;
 170
 171     std::unique_ptr<struct compositor::controller> controller;
 172     std::vector<std::unique_ptr<struct wl::output>> outputs;
 173
 174     // track current layouts separately
 175     layer_map layers;
 176
 177     // ID allocation and proxy methods for lookup
 178     struct id_allocator id_alloc;
 179
 180     // Set by AFB API when wayland events need to be dispatched
 181     std::atomic<bool> pending_events;
 182
 183     std::vector<int> pending_end_draw;
 184
 185     std::map<const char *, struct afb_event> map_afb_event;
 186
 187     // Surface are info (x, y, w, h)
 188     rect_map area_info;
 189
 190     // FOR CES DEMO
 191     std::vector<int> surface_bg;
 192
 193     explicit App(wl::display *d);
 194     ~App() = default;
 195
 196     App(App const &) = delete;
 197     App &operator=(App const &) = delete;
 198     App(App &&) = delete;
 199     App &operator=(App &&) = delete;
 200
 201     int init();
 202
 203     int dispatch_pending_events();
 204
 205     void set_pending_events();
 206
 207     result<int> api_request_surface(char const *drawing_name);
 208     char const *api_request_surface(char const *drawing_name, char const *ivi_id);
 209     void api_activate_surface(char const *drawing_name, char const *drawing_area, const reply_func &reply);
 210     void api_deactivate_surface(char const *drawing_name, const reply_func &reply);
 211     void api_enddraw(char const *drawing_name);
 212     result<json_object *> api_get_display_info();
 213     result<json_object *> api_get_area_info(char const *drawing_name);
 214     void api_ping();
 215     void send_event(char const *evname, char const *label);
 216     void send_event(char const *evname, char const *label, char const *area, int x, int y, int w, int h);
 217
 218     // Events from the compositor we are interested in
 219     void surface_created(uint32_t surface_id);
 220     void surface_removed(uint32_t surface_id);
 221
 222   private:
 223     optional<int> lookup_id(char const *name);
 224     optional<std::string> lookup_name(int id);
 225
 226     bool pop_pending_events();
 227
 228     void enqueue_flushdraw(int surface_id);
 229     void check_flushdraw(int surface_id);
 230
 231     int init_layers();
 232
 233     void surface_set_layout(int surface_id, optional<int> sub_surface_id = nullopt);
 234     void layout_commit();
 235
 236     // TMC WM Events to clients
 237     void emit_activated(char const *label);
 238     void emit_deactivated(char const *label);
 239     void emit_syncdraw(char const *label, char const *area, int x, int y, int w, int h);
 240     void emit_flushdraw(char const *label);
 241     void emit_visible(char const *label, bool is_visible);
 242     void emit_invisible(char const *label);
 243     void emit_visible(char const *label);
 244
 245     void activate(int id);
 246     void deactivate(int id);
 247
 248     bool can_split(struct LayoutState const &state, int new_id);
 249     void try_layout(struct LayoutState &state,
 250                     struct LayoutState const &new_layout,
 251                     std::function<void(LayoutState const &nl)> apply);
 252 };
 253
 254 } // namespace wm
 255
 256 #endif // TMCAGLWM_APP_HPP