mainnika/weston
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename public backend headers

Browse Source 
The backend headers are renamed from compositor-foo.h to backend-foo.h to
better describe their purpose. These headers are public libweston API for each
specific backend.

The headers will also be used like

 #include <libweston/backend-drm.h>

instead of

 #include <compositor-drm.h>

to give them a more explicit namespace.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
This commit is contained in:
Pekka Paalanen
2019-03-29 16:39:12 +02:00
parent 3d5d9476e3
commit 7571027f17
16 changed files with 26 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libweston/compositor-drm.c
+1 -1
View File
@@ -51,7 +51,7 @@
#include <libudev.h>
#include <libweston/libweston.h>
#include "compositor-drm.h"
#include <libweston/backend-drm.h>
#include "weston-debug.h"
#include "shared/helpers.h"
#include "shared/timespec-util.h"
libweston/compositor-drm.h
-232
View File
@@ -1,232 +0,0 @@
/*
* Copyright © 2008-2011 Kristian Høgsberg
* Copyright © 2011 Intel Corporation
* Copyright © 2015 Giulio Camuffo
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef WESTON_COMPOSITOR_DRM_H
#define WESTON_COMPOSITOR_DRM_H
#include <libweston/libweston.h>
#include "plugin-registry.h"
#ifdef __cplusplus
extern "C" {
#endif
#define WESTON_DRM_BACKEND_CONFIG_VERSION 3
struct libinput_device;
enum weston_drm_backend_output_mode {
/** The output is disabled */
WESTON_DRM_BACKEND_OUTPUT_OFF,
/** The output will use the current active mode */
WESTON_DRM_BACKEND_OUTPUT_CURRENT,
/** The output will use the preferred mode. A modeline can be provided
* by setting weston_backend_output_config::modeline in the form of
* "WIDTHxHEIGHT" or in the form of an explicit modeline calculated
* using e.g. the cvt tool. If a valid modeline is supplied it will be
* used, if invalid or NULL the preferred available mode will be used. */
WESTON_DRM_BACKEND_OUTPUT_PREFERRED,
};
#define WESTON_DRM_OUTPUT_API_NAME "weston_drm_output_api_v1"
struct weston_drm_output_api {
/** The mode to be used by the output. Refer to the documentation
* of WESTON_DRM_BACKEND_OUTPUT_PREFERRED for details.
*
* Returns 0 on success, -1 on failure.
*/
int (*set_mode)(struct weston_output *output,
enum weston_drm_backend_output_mode mode,
const char *modeline);
/** The pixel format to be used by the output. Valid values are:
* - NULL - The format set at backend creation time will be used;
* - "xrgb8888";
* - "rgb565"
* - "xrgb2101010"
*/
void (*set_gbm_format)(struct weston_output *output,
const char *gbm_format);
/** The seat to be used by the output. Set to NULL to use the
* default seat.
*/
void (*set_seat)(struct weston_output *output,
const char *seat);
};
static inline const struct weston_drm_output_api *
weston_drm_output_get_api(struct weston_compositor *compositor)
{
const void *api;
api = weston_plugin_api_get(compositor, WESTON_DRM_OUTPUT_API_NAME,
sizeof(struct weston_drm_output_api));
return (const struct weston_drm_output_api *)api;
}
#define WESTON_DRM_VIRTUAL_OUTPUT_API_NAME "weston_drm_virtual_output_api_v1"
struct drm_fb;
typedef int (*submit_frame_cb)(struct weston_output *output, int fd,
int stride, struct drm_fb *buffer);
struct weston_drm_virtual_output_api {
/** Create virtual output.
* This is a low-level function, where the caller is expected to wrap
* the weston_output function pointers as necessary to make the virtual
* output useful. The caller must set up output make, model, serial,
* physical size, the mode list and current mode.
*
* Returns output on success, NULL on failure.
*/
struct weston_output* (*create_output)(struct weston_compositor *c,
char *name);
/** Set pixel format same as drm_output set_gbm_format().
*
* Returns the set format.
*/
uint32_t (*set_gbm_format)(struct weston_output *output,
const char *gbm_format);
/** Set a callback to be called when the DRM-backend has drawn a new
* frame and submits it for display.
* The callback will deliver a buffer to the virtual output's the
* owner and assumes the buffer is now reserved for the owner. The
* callback is called in virtual output repaint function.
* The caller must call buffer_released() and finish_frame().
*
* The callback parameters are output, FD and stride (bytes) of dmabuf,
* and buffer (drm_fb) pointer.
* The callback returns 0 on success, -1 on failure.
*
* The submit_frame_cb callback hook is responsible for closing the fd
* if it returns success. One needs to call the buffer release and
* finish frame functions if and only if this hook returns success.
*/
void (*set_submit_frame_cb)(struct weston_output *output,
submit_frame_cb cb);
/** Get fd for renderer fence.
* The returned fence signals when the renderer job has completed and
* the buffer is fully drawn.
*
* Returns fd on success, -1 on failure.
*/
int (*get_fence_sync_fd)(struct weston_output *output);
/** Notify that the caller has finished using buffer */
void (*buffer_released)(struct drm_fb *fb);
/** Notify finish frame
* This function allows the output repainting mechanism to advance to
* the next frame.
*/
void (*finish_frame)(struct weston_output *output,
struct timespec *stamp,
uint32_t presented_flags);
};
static inline const struct weston_drm_virtual_output_api *
weston_drm_virtual_output_get_api(struct weston_compositor *compositor)
{
const void *api;
api = weston_plugin_api_get(compositor,
WESTON_DRM_VIRTUAL_OUTPUT_API_NAME,
sizeof(struct weston_drm_virtual_output_api));
return (const struct weston_drm_virtual_output_api *)api;
}
/** The backend configuration struct.
*
* weston_drm_backend_config contains the configuration used by a DRM
* backend.
*/
struct weston_drm_backend_config {
struct weston_backend_config base;
/** The tty to be used. Set to 0 to use the current tty. */
int tty;
/** Whether to use the pixman renderer instead of the OpenGL ES renderer. */
bool use_pixman;
/** The seat to be used for input and output.
*
* If seat_id is NULL, the seat is taken from XDG_SEAT environment
* variable. If neither is set, "seat0" is used. The backend will
* take ownership of the seat_id pointer and will free it on
* backend destruction.
*/
char *seat_id;
/** The pixel format of the framebuffer to be used.
*
* Valid values are:
* - NULL - The default format ("xrgb8888") will be used;
* - "xrgb8888";
* - "rgb565"
* - "xrgb2101010"
* The backend will take ownership of the format pointer and will free
* it on backend destruction.
*/
char *gbm_format;
/** Callback used to configure input devices.
*
* This function will be called by the backend when a new input device
* needs to be configured.
* If NULL the device will use the default configuration.
*/
void (*configure_device)(struct weston_compositor *compositor,
struct libinput_device *device);
/** Maximum duration for a pageflip event to arrive, after which the
* compositor will consider the DRM driver crashed and will try to exit
* cleanly.
*
* It is exprimed in milliseconds, 0 means disabled. */
uint32_t pageflip_timeout;
/** Specific DRM device to open
*
* A DRM device name, like "card0", to open. If NULL, use heuristics
* based on seat names and boot_vga to find the right device.
*/
char *specific_device;
/** Use shadow buffer if using Pixman-renderer. */
bool use_pixman_shadow;
};
#ifdef __cplusplus
}
#endif
#endif /* WESTON_COMPOSITOR_DRM_H */
libweston/compositor-fbdev.c
+1 -1
View File
@@ -46,7 +46,7 @@
#include "shared/helpers.h"
#include <libweston/libweston.h>
#include "compositor-fbdev.h"
#include <libweston/backend-fbdev.h>
#include "launcher-util.h"
#include "pixman-renderer.h"
#include "libinput-seat.h"
libweston/compositor-fbdev.h
-70
View File
@@ -1,70 +0,0 @@
/*
* Copyright © 2016 Benoit Gschwind
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef WESTON_COMPOSITOR_FBDEV_H
#define WESTON_COMPOSITOR_FBDEV_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#include <libweston/libweston.h>
#define WESTON_FBDEV_BACKEND_CONFIG_VERSION 2
struct libinput_device;
struct weston_fbdev_backend_config {
struct weston_backend_config base;
int tty;
char *device;
/** Callback used to configure input devices.
*
* This function will be called by the backend when a new input device
* needs to be configured.
* If NULL the device will use the default configuration.
*/
void (*configure_device)(struct weston_compositor *compositor,
struct libinput_device *device);
/** The seat to be used for input and output.
*
* If seat_id is NULL, the seat is taken from XDG_SEAT environment
* variable. If neither is set, "seat0" is used. The backend will
* take ownership of the seat_id pointer and will free it on
* backend destruction.
*/
char *seat_id;
};
#ifdef __cplusplus
}
#endif
#endif /* WESTON_COMPOSITOR_FBDEV_H */
libweston/compositor-headless.c
+1 -1
View File
@@ -34,7 +34,7 @@
#include <stdbool.h>
#include <libweston/libweston.h>
#include "compositor-headless.h"
#include <libweston/backend-headless.h>
#include "shared/helpers.h"
#include "linux-explicit-synchronization.h"
#include "pixman-renderer.h"
libweston/compositor-headless.h
-50
View File
@@ -1,50 +0,0 @@
/*
* Copyright © 2016 Benoit Gschwind
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef WESTON_COMPOSITOR_HEADLESS_H
#define WESTON_COMPOSITOR_HEADLESS_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#include <libweston/libweston.h>
#define WESTON_HEADLESS_BACKEND_CONFIG_VERSION 2
struct weston_headless_backend_config {
struct weston_backend_config base;
/** Whether to use the pixman renderer instead of the OpenGL ES renderer. */
bool use_pixman;
};
#ifdef __cplusplus
}
#endif
#endif /* WESTON_COMPOSITOR_HEADLESS_H */
libweston/compositor-rdp.c
+1 -1
View File
@@ -99,7 +99,7 @@
#include "shared/helpers.h"
#include "shared/timespec-util.h"
#include <libweston/libweston.h>
#include "compositor-rdp.h"
#include <libweston/backend-rdp.h>
#include "pixman-renderer.h"
#define MAX_FREERDP_FDS 32
libweston/compositor-rdp.h
-74
View File
@@ -1,74 +0,0 @@
/*
* Copyright © 2016 Benoit Gschwind
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef WESTON_COMPOSITOR_RDP_H
#define WESTON_COMPOSITOR_RDP_H
#ifdef __cplusplus
extern "C" {
#endif
#include <libweston/libweston.h>
#include "plugin-registry.h"
#define WESTON_RDP_OUTPUT_API_NAME "weston_rdp_output_api_v1"
struct weston_rdp_output_api {
/** Initialize a RDP output with specified width and height.
*
* Returns 0 on success, -1 on failure.
*/
int (*output_set_size)(struct weston_output *output,
int width, int height);
};
static inline const struct weston_rdp_output_api *
weston_rdp_output_get_api(struct weston_compositor *compositor)
{
const void *api;
api = weston_plugin_api_get(compositor, WESTON_RDP_OUTPUT_API_NAME,
sizeof(struct weston_rdp_output_api));
return (const struct weston_rdp_output_api *)api;
}
#define WESTON_RDP_BACKEND_CONFIG_VERSION 2
struct weston_rdp_backend_config {
struct weston_backend_config base;
char *bind_address;
int port;
char *rdp_key;
char *server_cert;
char *server_key;
int env_socket;
int no_clients_resize;
};
#ifdef __cplusplus
}
#endif
#endif /* WESTON_COMPOSITOR_RDP_H */
libweston/compositor-wayland.c
+1 -1
View File
@@ -45,7 +45,7 @@
#endif
#include <libweston/libweston.h>
#include "compositor-wayland.h"
#include <libweston/backend-wayland.h>
#include "gl-renderer.h"
#include "weston-egl-ext.h"
#include "pixman-renderer.h"
libweston/compositor-wayland.h
-53
View File
@@ -1,53 +0,0 @@
/*
* Copyright © 2016 Benoit Gschwind
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef WESTON_COMPOSITOR_WAYLAND_H
#define WESTON_COMPOSITOR_WAYLAND_H
#include <libweston/libweston.h>
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#define WESTON_WAYLAND_BACKEND_CONFIG_VERSION 2
struct weston_wayland_backend_config {
struct weston_backend_config base;
bool use_pixman;
bool sprawl;
char *display_name;
bool fullscreen;
char *cursor_theme;
int cursor_size;
};
#ifdef __cplusplus
}
#endif
#endif /* WESTON_COMPOSITOR_WAYLAND_H */
libweston/compositor-x11.c
+1 -1
View File
@@ -51,7 +51,7 @@
#include <xkbcommon/xkbcommon.h>
#include <libweston/libweston.h>
#include "compositor-x11.h"
#include <libweston/backend-x11.h>
#include "shared/config-parser.h"
#include "shared/helpers.h"
#include "shared/image-loader.h"
libweston/compositor-x11.h
-53
View File
@@ -1,53 +0,0 @@
/*
* Copyright © 2016 Benoit Gschwind
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef WESTON_COMPOSITOR_X11_H
#define WESTON_COMPOSITOR_X11_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#include <libweston/libweston.h>
#define WESTON_X11_BACKEND_CONFIG_VERSION 2
struct weston_x11_backend_config {
struct weston_backend_config base;
bool fullscreen;
bool no_input;
/** Whether to use the pixman renderer instead of the OpenGL ES renderer. */
bool use_pixman;
};
#ifdef __cplusplus
}
#endif
#endif /* WESTON_COMPOSITOR_X11_H_ */
libweston/meson.build
+6 -6
View File
@@ -249,7 +249,7 @@ if get_option('backend-drm')
)
env_modmap += 'drm-backend.so=@0@;'.format(plugin_drm.full_path())
install_headers('compositor-drm.h', subdir: dir_include_libweston)
install_headers(backend_drm_h, subdir: dir_include_libweston_install)
endif
@@ -270,7 +270,7 @@ if get_option('backend-headless')
install_dir: dir_module_libweston,
)
env_modmap += 'headless-backend.so=@0@;'.format(plugin_headless.full_path())
install_headers('compositor-headless.h', subdir: dir_include_libweston)
install_headers(backend_headless_h, subdir: dir_include_libweston_install)
endif
@@ -308,7 +308,7 @@ if get_option('backend-rdp')
install_dir: dir_module_libweston
)
env_modmap += 'rdp-backend.so=@0@;'.format(plugin_rdp.full_path())
install_headers('compositor-rdp.h', subdir: dir_include_libweston)
install_headers(backend_rdp_h, subdir: dir_include_libweston_install)
endif
@@ -351,7 +351,7 @@ if get_option('backend-wayland')
install_dir: dir_module_libweston
)
env_modmap += 'wayland-backend.so=@0@;'.format(plugin_wlwl.full_path())
install_headers('compositor-wayland.h', subdir: dir_include_libweston)
install_headers(backend_wayland_h, subdir: dir_include_libweston_install)
endif
@@ -407,7 +407,7 @@ if get_option('backend-x11')
)
env_modmap += 'x11-backend.so=@0@;'.format(plugin_x11.full_path())
install_headers('compositor-x11.h', subdir: dir_include_libweston)
install_headers(backend_x11_h, subdir: dir_include_libweston_install)
endif
@@ -439,7 +439,7 @@ if get_option('backend-fbdev')
)
env_modmap += 'fbdev-backend.so=@0@;'.format(plugin_fbdev.full_path())
install_headers('compositor-fbdev.h', subdir: dir_include_libweston)
install_headers(backend_fbdev_h, subdir: dir_include_libweston_install)
endif