src/remote.h

   1 /*
   2  * Copyright © 2018 Renesas Electronics Corp.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining
   5  * a copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sublicense, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the
  13  * next paragraph) shall be included in all copies or substantial
  14  * portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  20  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  *
  25  * Authors: IGEL Co., Ltd.
  26  */
  27
  28 #ifndef REMOTING_PLUGIN_H
  29 #define REMOTING_PLUGIN_H
  30
  31 #include <libweston/libweston.h>
  32 #include <libweston/plugin-registry.h>
  33
  34 #define WESTON_REMOTING_API_NAME        "weston_remoting_api_v1"
  35
  36 struct weston_remoting_api {
  37         /** Create remoted outputs
  38          *
  39          * Returns 0 on success, -1 on failure.
  40          */
  41         struct weston_output *(*create_output)(struct weston_compositor *c,
  42                                                char *name);
  43
  44         /** Check if output is remoted */
  45         bool (*is_remoted_output)(struct weston_output *output);
  46
  47         /** Set mode */
  48         int (*set_mode)(struct weston_output *output, const char *modeline);
  49
  50         /** Set gbm format */
  51         void (*set_gbm_format)(struct weston_output *output,
  52                                const char *gbm_format);
  53
  54         /** Set seat */
  55         void (*set_seat)(struct weston_output *output, const char *seat);
  56
  57         /** Set the destination Host(IP Address) */
  58         void (*set_host)(struct weston_output *output, char *ip);
  59
  60         /** Set the port number */
  61         void (*set_port)(struct weston_output *output, int port);
  62
  63         /** Set the pipeline for gstreamer */
  64         void (*set_gst_pipeline)(struct weston_output *output,
  65                                  char *gst_pipeline);
  66 };
  67
  68 static inline const struct weston_remoting_api *
  69 weston_remoting_get_api(struct weston_compositor *compositor)
  70 {
  71         const void *api;
  72         api = weston_plugin_api_get(compositor, WESTON_REMOTING_API_NAME,
  73                                     sizeof(struct weston_remoting_api));
  74
  75         return (const struct weston_remoting_api *)api;
  76 }
  77
  78 #endif /* REMOTING_PLUGIN_H */