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