src/wayland_ivi_wm.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 WM_WAYLAND_HPP
  18 #define WM_WAYLAND_HPP
  19
  20 #include "controller_hooks.hpp"
  21 #include "ivi-wm-client-protocol.h"
  22 #include "util.hpp"
  23
  24 #include <functional>
  25 #include <memory>
  26 #include <unordered_map>
  27 #include <vector>
  28
  29 /**
  30  * @struct wayland_proxy
  31  */
  32 template <typename ProxyT>
  33 struct wayland_proxy {
  34    std::unique_ptr<ProxyT, std::function<void(ProxyT *)>> proxy;
  35    wayland_proxy(wayland_proxy const &) = delete;
  36    wayland_proxy &operator=(wayland_proxy const &) = delete;
  37    wayland_proxy(void *p)
  38       : wayland_proxy(p,
  39                       reinterpret_cast<void (*)(ProxyT *)>(wl_proxy_destroy)) {}
  40    wayland_proxy(void *p, std::function<void(ProxyT *)> &&p_del)
  41       : proxy(std::unique_ptr<ProxyT, std::function<void(ProxyT *)>>(
  42            static_cast<ProxyT *>(p), p_del)) {}
  43 };
  44
  45 /**
  46  * namespace wl
  47  */
  48 namespace wl {
  49
  50 /**
  51  * @struct registry
  52  */
  53 struct registry : public wayland_proxy<struct wl_registry> {
  54    typedef std::function<void(struct wl_registry *, uint32_t, uint32_t)> binder;
  55    std::unordered_map<std::string, binder> bindings;
  56
  57    registry(registry const &) = delete;
  58    registry &operator=(registry const &) = delete;
  59    registry(struct wl_display *d);
  60
  61    void add_global_handler(char const *iface, binder bind);
  62
  63    // Events
  64    void global_created(uint32_t name, char const *iface, uint32_t v);
  65    void global_removed(uint32_t name);
  66 };
  67
  68 /**
  69  * @struct display
  70  */
  71 struct display {
  72    std::unique_ptr<struct wl_display, void (*)(struct wl_display *)> d;
  73    struct registry r;
  74
  75    display(display const &) = delete;
  76    display &operator=(display const &) = delete;
  77    display();
  78    bool ok() const;
  79    void roundtrip();
  80    int dispatch();
  81    int dispatch_pending();
  82    int read_events();
  83    void flush();
  84    int get_fd() const;
  85    int get_error();
  86
  87    // Lets just proxy this for the registry
  88    inline void add_global_handler(char const *iface, registry::binder bind) {
  89       this->r.add_global_handler(iface, bind);
  90    }
  91 };
  92
  93 /**
  94  * @struct output
  95  */
  96 struct output : public wayland_proxy<struct wl_output> {
  97    int width{};
  98    int height{};
  99    int refresh{};
 100    int transform{};
 101
 102    output(output const &) = delete;
 103    output &operator=(output const &) = delete;
 104    output(struct wl_registry *r, uint32_t name, uint32_t v);
 105
 106    // Events
 107    void geometry(int32_t x, int32_t y, int32_t pw, int32_t ph, int32_t subpel,
 108                  char const *make, char const *model, int32_t tx);
 109    void mode(uint32_t flags, int32_t w, int32_t h, int32_t r);
 110    void done();
 111    void scale(int32_t factor);
 112 };
 113 }  // namespace wl
 114
 115 /**
 116  * namespace compositor
 117  */
 118 namespace compositor {
 119
 120 struct size {
 121    uint32_t w, h;
 122 };
 123
 124 struct rect {
 125    int32_t w, h;
 126    int32_t x, y;
 127 };
 128
 129 static const constexpr rect full_rect = rect{-1, -1, 0, 0};
 130
 131 inline bool operator==(struct rect a, struct rect b) {
 132    return a.w == b.w && a.h == b.h && a.x == b.x && a.y == b.y;
 133 }
 134
 135 struct controller;
 136
 137 struct controller_child {
 138    struct controller *parent;
 139    uint32_t id;
 140
 141    controller_child(controller_child const &) = delete;
 142    controller_child &operator=(controller_child const &) = delete;
 143    controller_child(struct controller *c, uint32_t i) : parent(c), id(i) {}
 144    virtual ~controller_child() {}
 145 };
 146
 147 struct surface_properties {
 148    uint32_t id;  // let's just save an ID here too
 149    struct rect dst_rect;
 150    struct rect src_rect;
 151    struct size size;
 152    int32_t orientation;
 153    int32_t visibility;
 154    float opacity;
 155 };
 156
 157 /**
 158  * @struct surface
 159  */
 160 struct surface : public controller_child {
 161    surface(surface const &) = delete;
 162    surface &operator=(surface const &) = delete;
 163    surface(uint32_t i, struct controller *c);
 164
 165    // Requests
 166    void set_visibility(uint32_t visibility);
 167    void set_source_rectangle(int32_t x, int32_t y,
 168                              int32_t width, int32_t height);
 169    void set_destination_rectangle(int32_t x, int32_t y,
 170                                   int32_t width, int32_t height);
 171 };
 172
 173 /**
 174  * @struct layer
 175  */
 176 struct layer : public controller_child {
 177    layer(layer const &) = delete;
 178    layer &operator=(layer const &) = delete;
 179    layer(uint32_t i, struct controller *c);
 180    layer(uint32_t i, int32_t w, int32_t h, struct controller *c);
 181
 182    // Requests
 183    void set_visibility(uint32_t visibility);
 184    void set_destination_rectangle(int32_t x, int32_t y,
 185                                   int32_t width, int32_t height);
 186    void add_surface(uint32_t surface_id);
 187    void remove_surface(uint32_t surface_id);
 188 };
 189
 190 /**
 191  * @struct screen
 192  */
 193 struct screen : public wayland_proxy<struct ivi_wm_screen>,
 194                 public controller_child {
 195    screen(screen const &) = delete;
 196    screen &operator=(screen const &) = delete;
 197    screen(uint32_t i, struct controller *c, struct wl_output *o);
 198
 199    void clear();
 200    void screen_created(struct screen *screen, uint32_t id);
 201    void set_render_order(std::vector<uint32_t> const &ro);
 202 };
 203
 204 /**
 205  * @struct controller
 206  */
 207 struct controller : public wayland_proxy<struct ivi_wm> {
 208    // This controller is still missing ivi-input
 209
 210    typedef std::unordered_map<uintptr_t, uint32_t> proxy_to_id_map_type;
 211    typedef std::unordered_map<uint32_t, std::unique_ptr<struct surface>>
 212       surface_map_type;
 213    typedef std::unordered_map<uint32_t, std::unique_ptr<struct layer>>
 214       layer_map_type;
 215    typedef std::unordered_map<uint32_t, struct screen *> screen_map_type;
 216    typedef std::unordered_map<uint32_t, struct surface_properties> props_map;
 217
 218    // HACK:
 219    // The order of these member is mandatory, as when objects are destroyed
 220    // they will call their parent (that's us right here!) and remove their
 221    // proxy-to-id mapping. I.e. the *_proxy_to_id members need to be valid
 222    // when the surfaces/layers/screens maps are destroyed. This sucks, but
 223    // I cannot see a better solution w/o globals or some other horrible
 224    // call-our-parent construct.
 225    proxy_to_id_map_type surface_proxy_to_id;
 226    proxy_to_id_map_type layer_proxy_to_id;
 227    proxy_to_id_map_type screen_proxy_to_id;
 228
 229    props_map sprops;
 230    props_map lprops;
 231
 232    surface_map_type surfaces;
 233    layer_map_type layers;
 234    screen_map_type screens;
 235
 236    std::unique_ptr<struct screen> screen;
 237
 238    size output_size;
 239
 240    wm::controller_hooks *chooks;
 241
 242    struct wl::display *display;
 243
 244    void add_proxy_to_sid_mapping(struct ivi_wm *p, uint32_t id);
 245    void remove_proxy_to_sid_mapping(struct ivi_wm *p);
 246
 247    void add_proxy_to_lid_mapping(struct ivi_wm *p, uint32_t id);
 248    void remove_proxy_to_lid_mapping(struct ivi_wm *p);
 249
 250    void add_proxy_to_id_mapping(struct wl_output *p, uint32_t id);
 251    void remove_proxy_to_id_mapping(struct wl_output *p);
 252
 253    bool surface_exists(uint32_t id) const {
 254       return this->surfaces.find(id) != this->surfaces.end();
 255    }
 256
 257    bool layer_exists(uint32_t id) const {
 258       return this->layers.find(id) != this->layers.end();
 259    }
 260
 261    controller(struct wl_registry *r, uint32_t name, uint32_t version);
 262
 263    // Requests
 264    void commit_changes() const {
 265       ivi_wm_commit_changes(this->proxy.get());
 266    }
 267    void layer_create(uint32_t id, int32_t w, int32_t h);
 268    void surface_create(uint32_t id);
 269    void create_screen(struct wl_output *output);
 270
 271    // Events
 272    void surface_visibility_changed(struct surface *s, int32_t visibility);
 273    void surface_opacity_changed(struct surface *s, float opacity);
 274    void surface_source_rectangle_changed(struct surface *s, int32_t x, int32_t y,
 275                                  int32_t width, int32_t height);
 276    void surface_destination_rectangle_changed(struct surface *s, int32_t x, int32_t y,
 277                                       int32_t width, int32_t height);
 278    void surface_created(uint32_t id);
 279    void surface_destroyed(struct surface *s, uint32_t surface_id);
 280    void surface_error_detected(uint32_t object_id,
 281                       uint32_t error_code, char const *error_text);
 282    void surface_size_changed(struct surface *s, int32_t width, int32_t height);
 283    void surface_stats_received(struct surface *s, uint32_t surface_id,
 284                       uint32_t frame_count, uint32_t pid);
 285    void surface_added_to_layer(struct surface *s, uint32_t layer_id, uint32_t surface_id);
 286
 287    void layer_visibility_changed(struct layer *l, uint32_t layer_id,int32_t visibility);
 288    void layer_opacity_changed(struct layer *l, uint32_t layer_id,float opacity);
 289    void layer_source_rectangle_changed(struct layer *l, uint32_t layer_id,int32_t x, int32_t y,
 290                                int32_t width, int32_t height);
 291    void layer_destination_rectangle_changed(struct layer *l, uint32_t layer_id,int32_t x, int32_t y,
 292                                     int32_t width, int32_t height);
 293    void layer_created(uint32_t id);
 294    void layer_destroyed(struct layer *l, uint32_t layer_id);
 295    void layer_error_detected(uint32_t object_id,
 296                     uint32_t error_code, char const *error_text);
 297    void layer_configuration(struct layer *l, int32_t width, int32_t height);
 298    void layer_orientation(struct layer *l, int32_t orientation);
 299    void layer_screen(struct layer *l, struct wl_output *screen);
 300
 301 };
 302 }  // namespace compositor
 303
 304 #endif  // !WM_WAYLAND_HPP