src/wayland.hpp

   1 /*
   2  * Copyright (C) 2017 Mentor Graphics Development (Deutschland) GmbH
   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-controller-client-protocol.h"
  22 #include "util.hpp"
  23
  24 #include <functional>
  25 #include <memory>
  26 #include <unordered_map>
  27 #include <vector>
  28
  29 //                      _                 _
  30 // __      ____ _ _   _| | __ _ _ __   __| |     _ __  _ __ _____  ___   _
  31 // \ \ /\ / / _` | | | | |/ _` | '_ \ / _` |    | '_ \| '__/ _ \ \/ / | | |
  32 //  \ V  V / (_| | |_| | | (_| | | | | (_| |    | |_) | | | (_) >  <| |_| |
  33 //   \_/\_/ \__,_|\__, |_|\__,_|_| |_|\__,_|____| .__/|_|  \___/_/\_\\__, |
  34 //                |___/                   |_____|_|                  |___/
  35 template <typename ProxyT>
  36 struct wayland_proxy {
  37    std::unique_ptr<ProxyT, std::function<void(ProxyT *)>> proxy;
  38    wayland_proxy(wayland_proxy const &) = delete;
  39    wayland_proxy &operator=(wayland_proxy const &) = delete;
  40    wayland_proxy(void *p)
  41       : wayland_proxy(p,
  42                       reinterpret_cast<void (*)(ProxyT *)>(wl_proxy_destroy)) {}
  43    wayland_proxy(void *p, std::function<void(ProxyT *)> &&p_del)
  44       : proxy(std::unique_ptr<ProxyT, std::function<void(ProxyT *)>>(
  45            static_cast<ProxyT *>(p), p_del)) {}
  46 };
  47
  48 //                                                                  _
  49 //  _ __   __ _ _ __ ___   ___  ___ _ __   __ _  ___ ___  __      _| |
  50 // | '_ \ / _` | '_ ` _ \ / _ \/ __| '_ \ / _` |/ __/ _ \ \ \ /\ / / |
  51 // | | | | (_| | | | | | |  __/\__ \ |_) | (_| | (_|  __/  \ V  V /| |
  52 // |_| |_|\__,_|_| |_| |_|\___||___/ .__/ \__,_|\___\___|   \_/\_/ |_|
  53 //                                 |_|
  54 namespace wl {
  55 //                 _     _
  56 //  _ __ ___  __ _(_)___| |_ _ __ _   _
  57 // | '__/ _ \/ _` | / __| __| '__| | | |
  58 // | | |  __/ (_| | \__ \ |_| |  | |_| |
  59 // |_|  \___|\__, |_|___/\__|_|   \__, |
  60 //           |___/                |___/
  61 struct registry : public wayland_proxy<struct wl_registry> {
  62    typedef std::function<void(struct wl_registry *, uint32_t, uint32_t)> binder;
  63    std::unordered_map<std::string, binder> bindings;
  64
  65    registry(registry const &) = delete;
  66    registry &operator=(registry const &) = delete;
  67    registry(struct wl_display *d);
  68
  69    void add_global_handler(char const *iface, binder bind);
  70
  71    // Events
  72    void global(uint32_t name, char const *iface, uint32_t v);
  73    void global_remove(uint32_t name);
  74 };
  75
  76 //      _ _           _
  77 //   __| (_)___ _ __ | | __ _ _   _
  78 //  / _` | / __| '_ \| |/ _` | | | |
  79 // | (_| | \__ \ |_) | | (_| | |_| |
  80 //  \__,_|_|___/ .__/|_|\__,_|\__, |
  81 //             |_|            |___/
  82 struct display {
  83    std::unique_ptr<struct wl_display, void (*)(struct wl_display *)> d;
  84    struct registry r;
  85
  86    display(display const &) = delete;
  87    display &operator=(display const &) = delete;
  88    display();
  89    bool ok() const;
  90    void roundtrip();
  91    int dispatch();
  92    void flush();
  93    int get_fd() const;
  94    int get_error();
  95
  96    // Lets just proxy this for the registry
  97    inline void add_global_handler(char const *iface, registry::binder bind) {
  98       this->r.add_global_handler(iface, bind);
  99    }
 100 };
 101
 102 //              _               _
 103 //   ___  _   _| |_ _ __  _   _| |_
 104 //  / _ \| | | | __| '_ \| | | | __|
 105 // | (_) | |_| | |_| |_) | |_| | |_
 106 //  \___/ \__,_|\__| .__/ \__,_|\__|
 107 //                 |_|
 108 struct output : wayland_proxy<struct wl_output> {
 109    int width{};
 110    int height{};
 111    int refresh{};
 112    int transform{};
 113
 114    output(output const &) = delete;
 115    output &operator=(output const &) = delete;
 116    output(struct wl_registry *r, uint32_t name, uint32_t v);
 117
 118    // Events
 119    void geometry(int32_t x, int32_t y, int32_t pw, int32_t ph, int32_t subpel,
 120                  char const *make, char const *model, int32_t tx);
 121    void mode(uint32_t flags, int32_t w, int32_t h, int32_t r);
 122    void done();
 123    void scale(int32_t factor);
 124 };
 125 }  // namespace wl
 126
 127 //  _ __   __ _ _ __ ___   ___  ___ _ __   __ _  ___ ___
 128 // | '_ \ / _` | '_ ` _ \ / _ \/ __| '_ \ / _` |/ __/ _ \
 129 // | | | | (_| | | | | | |  __/\__ \ |_) | (_| | (_|  __/
 130 // |_| |_|\__,_|_| |_| |_|\___||___/ .__/ \__,_|\___\___|
 131 //                                 |_|
 132 //                   _       _
 133 //   __ _  ___ _ __ (_)_   _(_)
 134 //  / _` |/ _ \ '_ \| \ \ / / |
 135 // | (_| |  __/ | | | |\ V /| |
 136 //  \__, |\___|_| |_|_| \_/ |_|
 137 //  |___/
 138 namespace genivi {
 139
 140 struct size {
 141    uint32_t w, h;
 142 };
 143
 144 struct rect {
 145    int32_t w, h;
 146    int32_t x, y;
 147 };
 148
 149 static const constexpr rect full_rect = rect{-1, -1, 0, 0};
 150
 151 inline bool operator==(struct rect a, struct rect b) {
 152    return a.w == b.w && a.h == b.h && a.x == b.x && a.y == b.y;
 153 }
 154
 155 struct controller;
 156
 157 struct controller_child {
 158    struct controller *parent;
 159    uint32_t id;
 160
 161    controller_child(controller_child const &) = delete;
 162    controller_child &operator=(controller_child const &) = delete;
 163    controller_child(struct controller *c, uint32_t i) : parent(c), id(i) {}
 164    virtual ~controller_child() {}
 165 };
 166
 167 struct surface_properties {
 168    uint32_t id;  // let's just save an ID here too
 169    struct rect dst_rect;
 170    struct rect src_rect;
 171    struct size size;
 172    int32_t orientation;
 173    int32_t visibility;
 174    float opacity;
 175 };
 176
 177 //                  __
 178 //  ___ _   _ _ __ / _| __ _  ___ ___
 179 // / __| | | | '__| |_ / _` |/ __/ _ \
 180 // \__ \ |_| | |  |  _| (_| | (_|  __/
 181 // |___/\__,_|_|  |_|  \__,_|\___\___|
 182 //
 183 struct surface : public wayland_proxy<struct ivi_controller_surface>,
 184                  controller_child {
 185    surface(surface const &) = delete;
 186    surface &operator=(surface const &) = delete;
 187    surface(uint32_t i, struct controller *c);
 188
 189    // Requests
 190    void set_visibility(uint32_t visibility);
 191    void set_opacity(wl_fixed_t opacity);
 192    void set_source_rectangle(int32_t x, int32_t y, int32_t width,
 193                              int32_t height);
 194    void set_destination_rectangle(int32_t x, int32_t y, int32_t width,
 195                                   int32_t height);
 196    void set_configuration(int32_t width, int32_t height);
 197    void set_orientation(int32_t orientation);
 198    void screenshot(const char *filename);
 199    void send_stats();
 200    void destroy(int32_t destroy_scene_object);
 201 };
 202
 203 //  _
 204 // | | __ _ _   _  ___ _ __
 205 // | |/ _` | | | |/ _ \ '__|
 206 // | | (_| | |_| |  __/ |
 207 // |_|\__,_|\__, |\___|_|
 208 //          |___/
 209 struct layer : public wayland_proxy<struct ivi_controller_layer>,
 210                controller_child {
 211    layer(layer const &) = delete;
 212    layer &operator=(layer const &) = delete;
 213    layer(uint32_t i, struct controller *c);
 214    layer(uint32_t i, int32_t w, int32_t h, struct controller *c);
 215
 216    // Requests
 217    void set_visibility(uint32_t visibility);
 218    void set_opacity(wl_fixed_t opacity);
 219    void set_source_rectangle(int32_t x, int32_t y, int32_t width,
 220                              int32_t height);
 221    void set_destination_rectangle(int32_t x, int32_t y, int32_t width,
 222                                   int32_t height);
 223    void set_configuration(int32_t width, int32_t height);
 224    void set_orientation(int32_t orientation);
 225    void screenshot(const char *filename);
 226    void clear_surfaces();
 227    void add_surface(struct surface *surface);
 228    void remove_surface(struct surface *surface);
 229    void set_render_order(std::vector<uint32_t> const &ro);
 230 };
 231
 232 //
 233 //  ___  ___ _ __ ___  ___ _ __
 234 // / __|/ __| '__/ _ \/ _ \ '_ \
 235 // \__ \ (__| | |  __/  __/ | | |
 236 // |___/\___|_|  \___|\___|_| |_|
 237 //
 238 struct screen : public wayland_proxy<struct ivi_controller_screen>,
 239                 controller_child {
 240    screen(screen const &) = delete;
 241    screen &operator=(screen const &) = delete;
 242    screen(uint32_t i, struct controller *c, struct ivi_controller_screen *p);
 243    void clear();
 244    void add_layer(layer *l);
 245    void set_render_order(std::vector<uint32_t> const &ro);
 246 };
 247
 248 //                  _             _ _
 249 //   ___ ___  _ __ | |_ _ __ ___ | | | ___ _ __
 250 //  / __/ _ \| '_ \| __| '__/ _ \| | |/ _ \ '__|
 251 // | (_| (_) | | | | |_| | | (_) | | |  __/ |
 252 //  \___\___/|_| |_|\__|_|  \___/|_|_|\___|_|
 253 //
 254 struct controller : public wayland_proxy<struct ivi_controller> {
 255    // This controller is still missing ivi-input
 256
 257    typedef std::unordered_map<uintptr_t, uint32_t> proxy_to_id_map_type;
 258    typedef std::unordered_map<uint32_t, std::unique_ptr<struct surface>>
 259       surface_map_type;
 260    typedef std::unordered_map<uint32_t, std::unique_ptr<struct layer>>
 261       layer_map_type;
 262    typedef std::unordered_map<uint32_t, std::unique_ptr<struct screen>>
 263       screen_map_type;
 264
 265    typedef std::unordered_map<uint32_t, struct surface_properties> props_map;
 266
 267    // HACK:
 268    // The order of these member is mandatory, as when objects are destroyed
 269    // they will call their parent (that's us right here!) and remove their
 270    // proxy-to-id mapping. I.e. the *_proxy_to_id members need to be valid
 271    // when the surfaces/layers/screens maps are destroyed. This sucks, but
 272    // I cannot see a better solution w/o globals or some other horrible
 273    // call-our-parent construct.
 274    proxy_to_id_map_type surface_proxy_to_id;
 275    proxy_to_id_map_type layer_proxy_to_id;
 276    proxy_to_id_map_type screen_proxy_to_id;
 277
 278    props_map sprops;
 279    props_map lprops;
 280
 281    surface_map_type surfaces;
 282    layer_map_type layers;
 283    screen_map_type screens;
 284
 285    size output_size;
 286
 287    wm::controller_hooks *chooks;
 288
 289    void add_proxy_to_id_mapping(struct ivi_controller_surface *p, uint32_t id);
 290    void remove_proxy_to_id_mapping(struct ivi_controller_surface *p);
 291    void add_proxy_to_id_mapping(struct ivi_controller_layer *p, uint32_t id);
 292    void remove_proxy_to_id_mapping(struct ivi_controller_layer *p);
 293    void add_proxy_to_id_mapping(struct wl_output *p, uint32_t id);
 294    void remove_proxy_to_id_mapping(struct wl_output *p);
 295
 296    bool surface_exists(uint32_t id) const {
 297       return this->surfaces.find(id) != this->surfaces.end();
 298    }
 299
 300    bool layer_exists(uint32_t id) const {
 301       return this->layers.find(id) != this->layers.end();
 302    }
 303
 304    controller(struct wl_registry *r, uint32_t name, uint32_t version);
 305
 306    // Requests
 307    void commit_changes() const {
 308       ivi_controller_commit_changes(this->proxy.get());
 309    }
 310    void layer_create(uint32_t id, int32_t w, int32_t h);
 311    void surface_create(uint32_t id);
 312
 313    // Events
 314    // controller
 315    void controller_screen(uint32_t id, struct ivi_controller_screen *screen);
 316    void controller_layer(uint32_t id);
 317    void controller_surface(uint32_t id);
 318    void controller_error(int32_t object_id, int32_t object_type,
 319                          int32_t error_code, char const *error_text);
 320
 321    // surface
 322    void surface_visibility(struct surface *s, int32_t visibility);
 323    void surface_opacity(struct surface *s, float opacity);
 324    void surface_source_rectangle(struct surface *s, int32_t x, int32_t y,
 325                                  int32_t width, int32_t height);
 326    void surface_destination_rectangle(struct surface *s, int32_t x, int32_t y,
 327                                       int32_t width, int32_t height);
 328    void surface_configuration(struct surface *s, int32_t width, int32_t height);
 329    void surface_orientation(struct surface *s, int32_t orientation);
 330    void surface_pixelformat(struct surface *s, int32_t pixelformat);
 331    void surface_layer(struct surface *s, struct ivi_controller_layer *layer);
 332    void surface_stats(struct surface *s, uint32_t redraw_count,
 333                       uint32_t frame_count, uint32_t update_count, uint32_t pid,
 334                       const char *process_name);
 335    void surface_destroyed(struct surface *s);
 336    void surface_content(struct surface *s, int32_t content_state);
 337
 338    // layer
 339    void layer_visibility(struct layer *l, int32_t visibility);
 340    void layer_opacity(struct layer *l, float opacity);
 341    void layer_source_rectangle(struct layer *l, int32_t x, int32_t y,
 342                                int32_t width, int32_t height);
 343    void layer_destination_rectangle(struct layer *l, int32_t x, int32_t y,
 344                                     int32_t width, int32_t height);
 345    void layer_configuration(struct layer *l, int32_t width, int32_t height);
 346    void layer_orientation(struct layer *l, int32_t orientation);
 347    void layer_screen(struct layer *l, struct wl_output *screen);
 348    void layer_destroyed(struct layer *l);
 349 };
 350 }  // namespace genivi
 351
 352 #endif  // !WM_WAYLAND_HPP